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 (discomfitor/zmike) <michael.blumenkrantz@@gmail.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>
294 @author Bluezery <ohpowel@@gmail.com>
295 @author Nicolas Aguirre <aguirre.nicolas@@gmail.com>
296 @author Sanjeev BA <iamsanjeev@@gmail.com>
298 Please contact <enlightenment-devel@lists.sourceforge.net> to get in
299 contact with the developers and maintainers.
307 * @brief Elementary's API
312 @ELM_UNIX_DEF@ ELM_UNIX
313 @ELM_WIN32_DEF@ ELM_WIN32
314 @ELM_WINCE_DEF@ ELM_WINCE
315 @ELM_EDBUS_DEF@ ELM_EDBUS
316 @ELM_EFREET_DEF@ ELM_EFREET
317 @ELM_ETHUMB_DEF@ ELM_ETHUMB
318 @ELM_WEB_DEF@ ELM_WEB
319 @ELM_EMAP_DEF@ ELM_EMAP
320 @ELM_DEBUG_DEF@ ELM_DEBUG
321 @ELM_ALLOCA_H_DEF@ ELM_ALLOCA_H
322 @ELM_LIBINTL_H_DEF@ ELM_LIBINTL_H
323 @ELM_DIRENT_H_DEF@ ELM_DIRENT_H
325 /* Standard headers for standard system calls etc. */
330 #include <sys/types.h>
331 #include <sys/stat.h>
332 #include <sys/time.h>
333 #include <sys/param.h>
347 # ifdef ELM_LIBINTL_H
348 # include <libintl.h>
359 #if defined (ELM_WIN32) || defined (ELM_WINCE)
362 # define alloca _alloca
371 // disabled - evas 1.1 won't have this.
372 //#include <Evas_GL.h>
374 #include <Ecore_Evas.h>
375 #include <Ecore_File.h>
376 @ELEMENTARY_ECORE_IMF_INC@
377 @ELEMENTARY_ECORE_CON_INC@
386 # include <Efreet_Mime.h>
387 # include <Efreet_Trash.h>
391 # include <Ethumb_Client.h>
403 # ifdef ELEMENTARY_BUILD
405 # define EAPI __declspec(dllexport)
408 # endif /* ! DLL_EXPORT */
410 # define EAPI __declspec(dllimport)
411 # endif /* ! EFL_EVAS_BUILD */
415 # define EAPI __attribute__ ((visibility("default")))
422 #endif /* ! _WIN32 */
427 # define EAPI_MAIN EAPI
430 /* allow usage from c++ */
435 #define ELM_VERSION_MAJOR @VMAJ@
436 #define ELM_VERSION_MINOR @VMIN@
438 typedef struct _Elm_Version
446 EAPI extern Elm_Version *elm_version;
449 #define ELM_RECTS_INTERSECT(x, y, w, h, xx, yy, ww, hh) (((x) < ((xx) + (ww))) && ((y) < ((yy) + (hh))) && (((x) + (w)) > (xx)) && (((y) + (h)) > (yy)))
450 #define ELM_PI 3.14159265358979323846
453 * @defgroup General General
455 * @brief General Elementary API. Functions that don't relate to
456 * Elementary objects specifically.
458 * Here are documented functions which init/shutdown the library,
459 * that apply to generic Elementary objects, that deal with
460 * configuration, et cetera.
462 * @ref general_functions_example_page "This" example contemplates
463 * some of these functions.
467 * @addtogroup General
472 * Defines couple of standard Evas_Object layers to be used
473 * with evas_object_layer_set().
475 * @note whenever extending with new values, try to keep some padding
476 * to siblings so there is room for further extensions.
478 typedef enum _Elm_Object_Layer
480 ELM_OBJECT_LAYER_BACKGROUND = EVAS_LAYER_MIN + 64, /**< where to place backgrounds */
481 ELM_OBJECT_LAYER_DEFAULT = 0, /**< Evas_Object default layer (and thus for Elementary) */
482 ELM_OBJECT_LAYER_FOCUS = EVAS_LAYER_MAX - 128, /**< where focus object visualization is */
483 ELM_OBJECT_LAYER_TOOLTIP = EVAS_LAYER_MAX - 64, /**< where to show tooltips */
484 ELM_OBJECT_LAYER_CURSOR = EVAS_LAYER_MAX - 32, /**< where to show cursors */
485 ELM_OBJECT_LAYER_LAST /**< last layer known by Elementary */
488 /**************************************************************************/
489 EAPI extern int ELM_ECORE_EVENT_ETHUMB_CONNECT;
492 * Emitted when the application has reconfigured elementary settings due
493 * to an external configuration tool asking it to.
495 EAPI extern int ELM_EVENT_CONFIG_ALL_CHANGED;
498 * Emitted when any Elementary's policy value is changed.
500 EAPI extern int ELM_EVENT_POLICY_CHANGED;
503 * @typedef Elm_Event_Policy_Changed
505 * Data on the event when an Elementary policy has changed
507 typedef struct _Elm_Event_Policy_Changed Elm_Event_Policy_Changed;
510 * @struct _Elm_Event_Policy_Changed
512 * Data on the event when an Elementary policy has changed
514 struct _Elm_Event_Policy_Changed
516 unsigned int policy; /**< the policy identifier */
517 int new_value; /**< value the policy had before the change */
518 int old_value; /**< new value the policy got */
522 * Policy identifiers.
524 typedef enum _Elm_Policy
526 ELM_POLICY_QUIT, /**< under which circumstances the application
527 * should quit automatically. @see
531 } Elm_Policy; /**< Elementary policy identifiers/groups enumeration. @see elm_policy_set()
534 typedef enum _Elm_Policy_Quit
536 ELM_POLICY_QUIT_NONE = 0, /**< never quit the application
538 ELM_POLICY_QUIT_LAST_WINDOW_CLOSED /**< quit when the
540 * window is closed */
541 } Elm_Policy_Quit; /**< Possible values for the #ELM_POLICY_QUIT policy */
543 typedef enum _Elm_Focus_Direction
547 } Elm_Focus_Direction;
549 typedef enum _Elm_Text_Format
551 ELM_TEXT_FORMAT_PLAIN_UTF8,
552 ELM_TEXT_FORMAT_MARKUP_UTF8
556 * Line wrapping types.
558 typedef enum _Elm_Wrap_Type
560 ELM_WRAP_NONE = 0, /**< No wrap - value is zero */
561 ELM_WRAP_CHAR, /**< Char wrap - wrap between characters */
562 ELM_WRAP_WORD, /**< Word wrap - wrap in allowed wrapping points (as defined in the unicode standard) */
563 ELM_WRAP_MIXED, /**< Mixed wrap - Word wrap, and if that fails, char wrap. */
569 ELM_INPUT_PANEL_LAYOUT_NORMAL, /**< Default layout */
570 ELM_INPUT_PANEL_LAYOUT_NUMBER, /**< Number layout */
571 ELM_INPUT_PANEL_LAYOUT_EMAIL, /**< Email layout */
572 ELM_INPUT_PANEL_LAYOUT_URL, /**< URL layout */
573 ELM_INPUT_PANEL_LAYOUT_PHONENUMBER, /**< Phone Number layout */
574 ELM_INPUT_PANEL_LAYOUT_IP, /**< IP layout */
575 ELM_INPUT_PANEL_LAYOUT_MONTH, /**< Month layout */
576 ELM_INPUT_PANEL_LAYOUT_NUMBERONLY, /**< Number Only layout */
577 ELM_INPUT_PANEL_LAYOUT_INVALID
578 } Elm_Input_Panel_Layout;
582 ELM_AUTOCAPITAL_TYPE_NONE,
583 ELM_AUTOCAPITAL_TYPE_WORD,
584 ELM_AUTOCAPITAL_TYPE_SENTENCE,
585 ELM_AUTOCAPITAL_TYPE_ALLCHARACTER,
586 } Elm_Autocapital_Type;
589 * @typedef Elm_Object_Item
590 * An Elementary Object item handle.
593 typedef struct _Elm_Object_Item Elm_Object_Item;
597 * Called back when a widget's tooltip is activated and needs content.
598 * @param data user-data given to elm_object_tooltip_content_cb_set()
599 * @param obj owner widget.
600 * @param tooltip The tooltip object (affix content to this!)
602 typedef Evas_Object *(*Elm_Tooltip_Content_Cb) (void *data, Evas_Object *obj, Evas_Object *tooltip);
605 * Called back when a widget's item tooltip is activated and needs content.
606 * @param data user-data given to elm_object_tooltip_content_cb_set()
607 * @param obj owner widget.
608 * @param tooltip The tooltip object (affix content to this!)
609 * @param item context dependent item. As an example, if tooltip was
610 * set on Elm_List_Item, then it is of this type.
612 typedef Evas_Object *(*Elm_Tooltip_Item_Content_Cb) (void *data, Evas_Object *obj, Evas_Object *tooltip, void *item);
614 typedef Eina_Bool (*Elm_Event_Cb) (void *data, Evas_Object *obj, Evas_Object *src, Evas_Callback_Type type, void *event_info); /**< Function prototype definition for callbacks on input events happening on Elementary widgets. @a data will receive the user data pointer passed to elm_object_event_callback_add(). @a src will be a pointer to the widget on which the input event took place. @a type will get the type of this event and @a event_info, the struct with details on this event. */
616 #ifndef ELM_LIB_QUICKLAUNCH
617 #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 */
619 #define ELM_MAIN() int main(int argc, char **argv) {return elm_quicklaunch_fallback(argc, argv);} /**< macro to be used after the elm_main() function */
622 /**************************************************************************/
626 * Initialize Elementary
628 * @param[in] argc System's argument count value
629 * @param[in] argv System's pointer to array of argument strings
630 * @return The init counter value.
632 * This function initializes Elementary and increments a counter of
633 * the number of calls to it. It returns the new counter's value.
635 * @warning This call is exported only for use by the @c ELM_MAIN()
636 * macro. There is no need to use this if you use this macro (which
637 * is highly advisable). An elm_main() should contain the entry
638 * point code for your application, having the same prototype as
639 * elm_init(), and @b not being static (putting the @c EAPI symbol
640 * in front of its type declaration is advisable). The @c
641 * ELM_MAIN() call should be placed just after it.
644 * @dontinclude bg_example_01.c
648 * See the full @ref bg_example_01_c "example".
650 * @see elm_shutdown().
653 EAPI int elm_init(int argc, char **argv);
656 * Shut down Elementary
658 * @return The init counter value.
660 * This should be called at the end of your application, just
661 * before it ceases to do any more processing. This will clean up
662 * any permanent resources your application may have allocated via
663 * Elementary that would otherwise persist.
665 * @see elm_init() for an example
669 EAPI int elm_shutdown(void);
672 * Run Elementary's main loop
674 * This call should be issued just after all initialization is
675 * completed. This function will not return until elm_exit() is
676 * called. It will keep looping, running the main
677 * (event/processing) loop for Elementary.
679 * @see elm_init() for an example
683 EAPI void elm_run(void);
686 * Exit Elementary's main loop
688 * If this call is issued, it will flag the main loop to cease
689 * processing and return back to its parent function (usually your
690 * elm_main() function).
692 * @see elm_init() for an example. There, just after a request to
693 * close the window comes, the main loop will be left.
695 * @note By using the appropriate #ELM_POLICY_QUIT on your Elementary
696 * applications, you'll be able to get this function called automatically for you.
700 EAPI void elm_exit(void);
703 * Provide information in order to make Elementary determine the @b
704 * run time location of the software in question, so other data files
705 * such as images, sound files, executable utilities, libraries,
706 * modules and locale files can be found.
708 * @param mainfunc This is your application's main function name,
709 * whose binary's location is to be found. Providing @c NULL
710 * will make Elementary not to use it
711 * @param dom This will be used as the application's "domain", in the
712 * form of a prefix to any environment variables that may
713 * override prefix detection and the directory name, inside the
714 * standard share or data directories, where the software's
715 * data files will be looked for.
716 * @param checkfile This is an (optional) magic file's path to check
717 * for existence (and it must be located in the data directory,
718 * under the share directory provided above). Its presence will
719 * help determine the prefix found was correct. Pass @c NULL if
720 * the check is not to be done.
722 * This function allows one to re-locate the application somewhere
723 * else after compilation, if the developer wishes for easier
724 * distribution of pre-compiled binaries.
726 * The prefix system is designed to locate where the given software is
727 * installed (under a common path prefix) at run time and then report
728 * specific locations of this prefix and common directories inside
729 * this prefix like the binary, library, data and locale directories,
730 * through the @c elm_app_*_get() family of functions.
732 * Call elm_app_info_set() early on before you change working
733 * directory or anything about @c argv[0], so it gets accurate
736 * It will then try and trace back which file @p mainfunc comes from,
737 * if provided, to determine the application's prefix directory.
739 * The @p dom parameter provides a string prefix to prepend before
740 * environment variables, allowing a fallback to @b specific
741 * environment variables to locate the software. You would most
742 * probably provide a lowercase string there, because it will also
743 * serve as directory domain, explained next. For environment
744 * variables purposes, this string is made uppercase. For example if
745 * @c "myapp" is provided as the prefix, then the program would expect
746 * @c "MYAPP_PREFIX" as a master environment variable to specify the
747 * exact install prefix for the software, or more specific environment
748 * variables like @c "MYAPP_BIN_DIR", @c "MYAPP_LIB_DIR", @c
749 * "MYAPP_DATA_DIR" and @c "MYAPP_LOCALE_DIR", which could be set by
750 * the user or scripts before launching. If not provided (@c NULL),
751 * environment variables will not be used to override compiled-in
752 * defaults or auto detections.
754 * The @p dom string also provides a subdirectory inside the system
755 * shared data directory for data files. For example, if the system
756 * directory is @c /usr/local/share, then this directory name is
757 * appended, creating @c /usr/local/share/myapp, if it @p was @c
758 * "myapp". It is expected that the application installs data files in
761 * The @p checkfile is a file name or path of something inside the
762 * share or data directory to be used to test that the prefix
763 * detection worked. For example, your app will install a wallpaper
764 * image as @c /usr/local/share/myapp/images/wallpaper.jpg and so to
765 * check that this worked, provide @c "images/wallpaper.jpg" as the @p
768 * @see elm_app_compile_bin_dir_set()
769 * @see elm_app_compile_lib_dir_set()
770 * @see elm_app_compile_data_dir_set()
771 * @see elm_app_compile_locale_set()
772 * @see elm_app_prefix_dir_get()
773 * @see elm_app_bin_dir_get()
774 * @see elm_app_lib_dir_get()
775 * @see elm_app_data_dir_get()
776 * @see elm_app_locale_dir_get()
778 EAPI void elm_app_info_set(void *mainfunc, const char *dom, const char *checkfile);
781 * Provide information on the @b fallback application's binaries
782 * directory, in scenarios where they get overriden by
783 * elm_app_info_set().
785 * @param dir The path to the default binaries directory (compile time
788 * @note Elementary will as well use this path to determine actual
789 * names of binaries' directory paths, maybe changing it to be @c
790 * something/local/bin instead of @c something/bin, only, for
793 * @warning You should call this function @b before
794 * elm_app_info_set().
796 EAPI void elm_app_compile_bin_dir_set(const char *dir);
799 * Provide information on the @b fallback application's libraries
800 * directory, on scenarios where they get overriden by
801 * elm_app_info_set().
803 * @param dir The path to the default libraries directory (compile
806 * @note Elementary will as well use this path to determine actual
807 * names of libraries' directory paths, maybe changing it to be @c
808 * something/lib32 or @c something/lib64 instead of @c something/lib,
811 * @warning You should call this function @b before
812 * elm_app_info_set().
814 EAPI void elm_app_compile_lib_dir_set(const char *dir);
817 * Provide information on the @b fallback application's data
818 * directory, on scenarios where they get overriden by
819 * elm_app_info_set().
821 * @param dir The path to the default data directory (compile time
824 * @note Elementary will as well use this path to determine actual
825 * names of data directory paths, maybe changing it to be @c
826 * something/local/share instead of @c something/share, only, for
829 * @warning You should call this function @b before
830 * elm_app_info_set().
832 EAPI void elm_app_compile_data_dir_set(const char *dir);
835 * Provide information on the @b fallback application's locale
836 * directory, on scenarios where they get overriden by
837 * elm_app_info_set().
839 * @param dir The path to the default locale directory (compile time
842 * @warning You should call this function @b before
843 * elm_app_info_set().
845 EAPI void elm_app_compile_locale_set(const char *dir);
848 * Retrieve the application's run time prefix directory, as set by
849 * elm_app_info_set() and the way (environment) the application was
852 * @return The directory prefix the application is actually using.
854 EAPI const char *elm_app_prefix_dir_get(void);
857 * Retrieve the application's run time binaries prefix directory, as
858 * set by elm_app_info_set() and the way (environment) the application
861 * @return The binaries directory prefix the application is actually
864 EAPI const char *elm_app_bin_dir_get(void);
867 * Retrieve the application's run time libraries prefix directory, as
868 * set by elm_app_info_set() and the way (environment) the application
871 * @return The libraries directory prefix the application is actually
874 EAPI const char *elm_app_lib_dir_get(void);
877 * Retrieve the application's run time data prefix directory, as
878 * set by elm_app_info_set() and the way (environment) the application
881 * @return The data directory prefix the application is actually
884 EAPI const char *elm_app_data_dir_get(void);
887 * Retrieve the application's run time locale prefix directory, as
888 * set by elm_app_info_set() and the way (environment) the application
891 * @return The locale directory prefix the application is actually
894 EAPI const char *elm_app_locale_dir_get(void);
896 EAPI void elm_quicklaunch_mode_set(Eina_Bool ql_on);
897 EAPI Eina_Bool elm_quicklaunch_mode_get(void);
898 EAPI int elm_quicklaunch_init(int argc, char **argv);
899 EAPI int elm_quicklaunch_sub_init(int argc, char **argv);
900 EAPI int elm_quicklaunch_sub_shutdown(void);
901 EAPI int elm_quicklaunch_shutdown(void);
902 EAPI void elm_quicklaunch_seed(void);
903 EAPI Eina_Bool elm_quicklaunch_prepare(int argc, char **argv);
904 EAPI Eina_Bool elm_quicklaunch_fork(int argc, char **argv, char *cwd, void (postfork_func) (void *data), void *postfork_data);
905 EAPI void elm_quicklaunch_cleanup(void);
906 EAPI int elm_quicklaunch_fallback(int argc, char **argv);
907 EAPI char *elm_quicklaunch_exe_path_get(const char *exe);
909 EAPI Eina_Bool elm_need_efreet(void);
910 EAPI Eina_Bool elm_need_e_dbus(void);
913 * This must be called before any other function that deals with
914 * elm_thumb objects or ethumb_client instances.
918 EAPI Eina_Bool elm_need_ethumb(void);
921 * This must be called before any other function that deals with
922 * elm_web objects or ewk_view instances.
926 EAPI Eina_Bool elm_need_web(void);
929 * Set a new policy's value (for a given policy group/identifier).
931 * @param policy policy identifier, as in @ref Elm_Policy.
932 * @param value policy value, which depends on the identifier
934 * @return @c EINA_TRUE on success or @c EINA_FALSE, on error.
936 * Elementary policies define applications' behavior,
937 * somehow. These behaviors are divided in policy groups (see
938 * #Elm_Policy enumeration). This call will emit the Ecore event
939 * #ELM_EVENT_POLICY_CHANGED, which can be hooked at with
940 * handlers. An #Elm_Event_Policy_Changed struct will be passed,
943 * @note Currently, we have only one policy identifier/group
944 * (#ELM_POLICY_QUIT), which has two possible values.
948 EAPI Eina_Bool elm_policy_set(unsigned int policy, int value);
951 * Gets the policy value for given policy identifier.
953 * @param policy policy identifier, as in #Elm_Policy.
954 * @return The currently set policy value, for that
955 * identifier. Will be @c 0 if @p policy passed is invalid.
959 EAPI int elm_policy_get(unsigned int policy);
962 * Change the language of the current application
964 * The @p lang passed must be the full name of the locale to use, for
965 * example "en_US.utf8" or "es_ES@euro".
967 * Changing language with this function will make Elementary run through
968 * all its widgets, translating strings set with
969 * elm_object_domain_translatable_text_part_set(). This way, an entire
970 * UI can have its language changed without having to restart the program.
972 * For more complex cases, like having formatted strings that need
973 * translation, widgets will also emit a "language,changed" signal that
974 * the user can listen to to manually translate the text.
976 * @param lang Language to set, must be the full name of the locale
980 EAPI void elm_language_set(const char *lang);
983 * Set a label of an object
985 * @param obj The Elementary object
986 * @param part The text part name to set (NULL for the default label)
987 * @param label The new text of the label
989 * @note Elementary objects may have many labels (e.g. Action Slider)
990 * @deprecated Use elm_object_part_text_set() instead.
993 EINA_DEPRECATED EAPI void elm_object_text_part_set(Evas_Object *obj, const char *part, const char *label);
996 * Set a label of an object
998 * @param obj The Elementary object
999 * @param part The text part name to set (NULL for the default label)
1000 * @param label The new text of the label
1002 * @note Elementary objects may have many labels (e.g. Action Slider)
1006 EAPI void elm_object_part_text_set(Evas_Object *obj, const char *part, const char *label);
1008 #define elm_object_text_set(obj, label) elm_object_part_text_set((obj), NULL, (label))
1011 * Get a label of an object
1013 * @param obj The Elementary object
1014 * @param part The text part name to get (NULL for the default label)
1015 * @return text of the label or NULL for any error
1017 * @note Elementary objects may have many labels (e.g. Action Slider)
1018 * @deprecated Use elm_object_part_text_get() instead.
1021 EINA_DEPRECATED EAPI const char *elm_object_text_part_get(const Evas_Object *obj, const char *part);
1024 * Get a label of an object
1026 * @param obj The Elementary object
1027 * @param part The text part name to get (NULL for the default label)
1028 * @return text of the label or NULL for any error
1030 * @note Elementary objects may have many labels (e.g. Action Slider)
1034 EAPI const char *elm_object_part_text_get(const Evas_Object *obj, const char *part);
1036 #define elm_object_text_get(obj) elm_object_part_text_get((obj), NULL)
1039 * Set the text for an objects' part, marking it as translatable.
1041 * The string to set as @p text must be the original one. Do not pass the
1042 * return of @c gettext() here. Elementary will translate the string
1043 * internally and set it on the object using elm_object_part_text_set(),
1044 * also storing the original string so that it can be automatically
1045 * translated when the language is changed with elm_language_set().
1047 * The @p domain will be stored along to find the translation in the
1048 * correct catalog. It can be NULL, in which case it will use whatever
1049 * domain was set by the application with @c textdomain(). This is useful
1050 * in case you are building a library on top of Elementary that will have
1051 * its own translatable strings, that should not be mixed with those of
1052 * programs using the library.
1054 * @param obj The object containing the text part
1055 * @param part The name of the part to set
1056 * @param domain The translation domain to use
1057 * @param text The original, non-translated text to set
1061 EAPI void elm_object_domain_translatable_text_part_set(Evas_Object *obj, const char *part, const char *domain, const char *text);
1063 #define elm_object_domain_translatable_text_set(obj, domain, text) elm_object_domain_translatable_text_part_set((obj), NULL, (domain), (text))
1065 #define elm_object_translatable_text_set(obj, text) elm_object_domain_translatable_text_part_set((obj), NULL, NULL, (text))
1068 * Gets the original string set as translatable for an object
1070 * When setting translated strings, the function elm_object_part_text_get()
1071 * will return the translation returned by @c gettext(). To get the
1072 * original string use this function.
1074 * @param obj The object
1075 * @param part The name of the part that was set
1077 * @return The original, untranslated string
1081 EAPI const char *elm_object_translatable_text_part_get(const Evas_Object *obj, const char *part);
1083 #define elm_object_translatable_text_get(obj) elm_object_translatable_text_part_get((obj), NULL)
1086 * Set a content of an object
1088 * @param obj The Elementary object
1089 * @param part The content part name to set (NULL for the default content)
1090 * @param content The new content of the object
1092 * @note Elementary objects may have many contents
1093 * @deprecated Use elm_object_part_content_set instead.
1096 EINA_DEPRECATED EAPI void elm_object_content_part_set(Evas_Object *obj, const char *part, Evas_Object *content);
1099 * Set a content of an object
1101 * @param obj The Elementary object
1102 * @param part The content part name to set (NULL for the default content)
1103 * @param content The new content of the object
1105 * @note Elementary objects may have many contents
1109 EAPI void elm_object_part_content_set(Evas_Object *obj, const char *part, Evas_Object *content);
1111 #define elm_object_content_set(obj, content) elm_object_part_content_set((obj), NULL, (content))
1114 * Get a content of an object
1116 * @param obj The Elementary object
1117 * @param item The content part name to get (NULL for the default content)
1118 * @return content of the object or NULL for any error
1120 * @note Elementary objects may have many contents
1121 * @deprecated Use elm_object_part_content_get instead.
1124 EINA_DEPRECATED EAPI Evas_Object *elm_object_content_part_get(const Evas_Object *obj, const char *part);
1127 * Get a content of an object
1129 * @param obj The Elementary object
1130 * @param item The content part name to get (NULL for the default content)
1131 * @return content of the object or NULL for any error
1133 * @note Elementary objects may have many contents
1137 EAPI Evas_Object *elm_object_part_content_get(const Evas_Object *obj, const char *part);
1139 #define elm_object_content_get(obj) elm_object_part_content_get((obj), NULL)
1142 * Unset a content of an object
1144 * @param obj The Elementary object
1145 * @param item The content part name to unset (NULL for the default content)
1147 * @note Elementary objects may have many contents
1148 * @deprecated Use elm_object_part_content_unset instead.
1151 EINA_DEPRECATED EAPI Evas_Object *elm_object_content_part_unset(Evas_Object *obj, const char *part);
1154 * Unset a content of an object
1156 * @param obj The Elementary object
1157 * @param item The content part name to unset (NULL for the default content)
1159 * @note Elementary objects may have many contents
1163 EAPI Evas_Object *elm_object_part_content_unset(Evas_Object *obj, const char *part);
1165 #define elm_object_content_unset(obj) elm_object_part_content_unset((obj), NULL)
1168 * Set the text to read out when in accessibility mode
1170 * @param obj The object which is to be described
1171 * @param txt The text that describes the widget to people with poor or no vision
1175 EAPI void elm_object_access_info_set(Evas_Object *obj, const char *txt);
1178 * Get the widget object's handle which contains a given item
1180 * @param item The Elementary object item
1181 * @return The widget object
1183 * @note This returns the widget object itself that an item belongs to.
1187 EAPI Evas_Object *elm_object_item_object_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
1190 * Set a content of an object item
1192 * @param it The Elementary object item
1193 * @param part The content part name to set (NULL for the default content)
1194 * @param content The new content of the object item
1196 * @note Elementary object items may have many contents
1197 * @deprecated Use elm_object_item_part_content_set instead.
1200 EINA_DEPRECATED EAPI void elm_object_item_content_part_set(Elm_Object_Item *it, const char *part, Evas_Object *content);
1203 * Set a content of an object item
1205 * @param it The Elementary object item
1206 * @param part The content part name to set (NULL for the default content)
1207 * @param content The new content of the object item
1209 * @note Elementary object items may have many contents
1213 EAPI void elm_object_item_part_content_set(Elm_Object_Item *it, const char *part, Evas_Object *content);
1215 #define elm_object_item_content_set(it, content) elm_object_item_part_content_set((it), NULL, (content))
1218 * Get a content of an object item
1220 * @param it The Elementary object item
1221 * @param part The content part name to unset (NULL for the default content)
1222 * @return content of the object item or NULL for any error
1224 * @note Elementary object items may have many contents
1225 * @deprecated Use elm_object_item_part_content_get instead.
1228 EAPI Evas_Object *elm_object_item_content_part_get(const Elm_Object_Item *it, const char *part);
1231 * Get a content of an object item
1233 * @param it The Elementary object item
1234 * @param part The content part name to unset (NULL for the default content)
1235 * @return content of the object item or NULL for any error
1237 * @note Elementary object items may have many contents
1241 EAPI Evas_Object *elm_object_item_part_content_get(const Elm_Object_Item *it, const char *part);
1243 #define elm_object_item_content_get(it) elm_object_item_part_content_get((it), NULL)
1246 * Unset a content of an object item
1248 * @param it The Elementary object item
1249 * @param part The content part name to unset (NULL for the default content)
1251 * @note Elementary object items may have many contents
1252 * @deprecated Use elm_object_item_part_content_unset instead.
1255 EINA_DEPRECATED EAPI Evas_Object *elm_object_item_content_part_unset(Elm_Object_Item *it, const char *part);
1258 * Unset a content of an object item
1260 * @param it The Elementary object item
1261 * @param part The content part name to unset (NULL for the default content)
1263 * @note Elementary object items may have many contents
1267 EAPI Evas_Object *elm_object_item_part_content_unset(Elm_Object_Item *it, const char *part);
1269 #define elm_object_item_content_unset(it) elm_object_item_part_content_unset((it), NULL)
1272 * Set a label of an object item
1274 * @param it The Elementary object item
1275 * @param part The text part name to set (NULL for the default label)
1276 * @param label The new text of the label
1278 * @note Elementary object items may have many labels
1279 * @deprecated Use elm_object_item_part_text_set instead.
1282 EINA_DEPRECATED EAPI void elm_object_item_text_part_set(Elm_Object_Item *it, const char *part, const char *label);
1285 * Set a label of an object item
1287 * @param it The Elementary object item
1288 * @param part The text part name to set (NULL for the default label)
1289 * @param label The new text of the label
1291 * @note Elementary object items may have many labels
1295 EAPI void elm_object_item_part_text_set(Elm_Object_Item *it, const char *part, const char *label);
1297 #define elm_object_item_text_set(it, label) elm_object_item_part_text_set((it), NULL, (label))
1300 * Get a label of an object item
1302 * @param it The Elementary object item
1303 * @param part The text part name to get (NULL for the default label)
1304 * @return text of the label or NULL for any error
1306 * @note Elementary object items may have many labels
1307 * @deprecated Use elm_object_item_part_text_get instead.
1310 EINA_DEPRECATED EAPI const char *elm_object_item_text_part_get(const Elm_Object_Item *it, const char *part);
1312 * Get a label of an object item
1314 * @param it The Elementary object item
1315 * @param part The text part name to get (NULL for the default label)
1316 * @return text of the label or NULL for any error
1318 * @note Elementary object items may have many labels
1322 EAPI const char *elm_object_item_part_text_get(const Elm_Object_Item *it, const char *part);
1324 #define elm_object_item_text_get(it) elm_object_item_part_text_get((it), NULL)
1327 * Set the text to read out when in accessibility mode
1329 * @param it The object item which is to be described
1330 * @param txt The text that describes the widget to people with poor or no vision
1334 EAPI void elm_object_item_access_info_set(Elm_Object_Item *it, const char *txt);
1337 * Get the data associated with an object item
1338 * @param it The Elementary object item
1339 * @return The data associated with @p it
1343 EAPI void *elm_object_item_data_get(const Elm_Object_Item *it);
1346 * Set the data associated with an object item
1347 * @param it The Elementary object item
1348 * @param data The data to be associated with @p it
1352 EAPI void elm_object_item_data_set(Elm_Object_Item *it, void *data);
1355 * Send a signal to the edje object of the widget item.
1357 * This function sends a signal to the edje object of the obj item. An
1358 * edje program can respond to a signal by specifying matching
1359 * 'signal' and 'source' fields.
1361 * @param it The Elementary object item
1362 * @param emission The signal's name.
1363 * @param source The signal's source.
1366 EAPI void elm_object_item_signal_emit(Elm_Object_Item *it, const char *emission, const char *source) EINA_ARG_NONNULL(1);
1369 * Set the disabled state of an widget item.
1371 * @param obj The Elementary object item
1372 * @param disabled The state to put in in: @c EINA_TRUE for
1373 * disabled, @c EINA_FALSE for enabled
1375 * Elementary object item can be @b disabled, in which state they won't
1376 * receive input and, in general, will be themed differently from
1377 * their normal state, usually greyed out. Useful for contexts
1378 * where you don't want your users to interact with some of the
1379 * parts of you interface.
1381 * This sets the state for the widget item, either disabling it or
1386 EAPI void elm_object_item_disabled_set(Elm_Object_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1);
1389 * Get the disabled state of an widget item.
1391 * @param obj The Elementary object
1392 * @return @c EINA_TRUE, if the widget item is disabled, @c EINA_FALSE
1393 * if it's enabled (or on errors)
1395 * This gets the state of the widget, which might be enabled or disabled.
1399 EAPI Eina_Bool elm_object_item_disabled_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
1406 * @defgroup Caches Caches
1408 * These are functions which let one fine-tune some cache values for
1409 * Elementary applications, thus allowing for performance adjustments.
1415 * @brief Flush all caches.
1417 * Frees all data that was in cache and is not currently being used to reduce
1418 * memory usage. This frees Edje's, Evas' and Eet's cache. This is equivalent
1419 * to calling all of the following functions:
1420 * @li edje_file_cache_flush()
1421 * @li edje_collection_cache_flush()
1422 * @li eet_clearcache()
1423 * @li evas_image_cache_flush()
1424 * @li evas_font_cache_flush()
1425 * @li evas_render_dump()
1426 * @note Evas caches are flushed for every canvas associated with a window.
1430 EAPI void elm_all_flush(void);
1433 * Get the configured cache flush interval time
1435 * This gets the globally configured cache flush interval time, in
1438 * @return The cache flush interval time
1441 * @see elm_all_flush()
1443 EAPI int elm_cache_flush_interval_get(void);
1446 * Set the configured cache flush interval time
1448 * This sets the globally configured cache flush interval time, in ticks
1450 * @param size The cache flush interval time
1453 * @see elm_all_flush()
1455 EAPI void elm_cache_flush_interval_set(int size);
1458 * Set the configured cache flush interval time for all applications on the
1461 * This sets the globally configured cache flush interval time -- in ticks
1462 * -- for all applications on the display.
1464 * @param size The cache flush interval time
1467 EAPI void elm_cache_flush_interval_all_set(int size);
1470 * Get the configured cache flush enabled state
1472 * This gets the globally configured cache flush state - if it is enabled
1473 * or not. When cache flushing is enabled, elementary will regularly
1474 * (see elm_cache_flush_interval_get() ) flush caches and dump data out of
1475 * memory and allow usage to re-seed caches and data in memory where it
1476 * can do so. An idle application will thus minimise its memory usage as
1477 * data will be freed from memory and not be re-loaded as it is idle and
1478 * not rendering or doing anything graphically right now.
1480 * @return The cache flush state
1483 * @see elm_all_flush()
1485 EAPI Eina_Bool elm_cache_flush_enabled_get(void);
1488 * Set the configured cache flush enabled state
1490 * This sets the globally configured cache flush enabled state.
1492 * @param size The cache flush enabled state
1495 * @see elm_all_flush()
1497 EAPI void elm_cache_flush_enabled_set(Eina_Bool enabled);
1500 * Set the configured cache flush enabled state for all applications on the
1503 * This sets the globally configured cache flush enabled state for all
1504 * applications on the display.
1506 * @param size The cache flush enabled state
1509 EAPI void elm_cache_flush_enabled_all_set(Eina_Bool enabled);
1512 * Get the configured font cache size
1514 * This gets the globally configured font cache size, in bytes.
1516 * @return The font cache size
1519 EAPI int elm_font_cache_get(void);
1522 * Set the configured font cache size
1524 * This sets the globally configured font cache size, in bytes
1526 * @param size The font cache size
1529 EAPI void elm_font_cache_set(int size);
1532 * Set the configured font cache size for all applications on the
1535 * This sets the globally configured font cache size -- in bytes
1536 * -- for all applications on the display.
1538 * @param size The font cache size
1541 EAPI void elm_font_cache_all_set(int size);
1544 * Get the configured image cache size
1546 * This gets the globally configured image cache size, in bytes
1548 * @return The image cache size
1551 EAPI int elm_image_cache_get(void);
1554 * Set the configured image cache size
1556 * This sets the globally configured image cache size, in bytes
1558 * @param size The image cache size
1561 EAPI void elm_image_cache_set(int size);
1564 * Set the configured image cache size for all applications on the
1567 * This sets the globally configured image cache size -- in bytes
1568 * -- for all applications on the display.
1570 * @param size The image cache size
1573 EAPI void elm_image_cache_all_set(int size);
1576 * Get the configured edje file cache size.
1578 * This gets the globally configured edje file cache size, in number
1581 * @return The edje file cache size
1584 EAPI int elm_edje_file_cache_get(void);
1587 * Set the configured edje file cache size
1589 * This sets the globally configured edje file cache size, in number
1592 * @param size The edje file cache size
1595 EAPI void elm_edje_file_cache_set(int size);
1598 * Set the configured edje file cache size for all applications on the
1601 * This sets the globally configured edje file cache size -- in number
1602 * of files -- for all applications on the display.
1604 * @param size The edje file cache size
1607 EAPI void elm_edje_file_cache_all_set(int size);
1610 * Get the configured edje collections (groups) cache size.
1612 * This gets the globally configured edje collections cache size, in
1613 * number of collections.
1615 * @return The edje collections cache size
1618 EAPI int elm_edje_collection_cache_get(void);
1621 * Set the configured edje collections (groups) cache size
1623 * This sets the globally configured edje collections cache size, in
1624 * number of collections.
1626 * @param size The edje collections cache size
1629 EAPI void elm_edje_collection_cache_set(int size);
1632 * Set the configured edje collections (groups) cache size for all
1633 * applications on the display
1635 * This sets the globally configured edje collections cache size -- in
1636 * number of collections -- for all applications on the display.
1638 * @param size The edje collections cache size
1641 EAPI void elm_edje_collection_cache_all_set(int size);
1648 * @defgroup Scaling Widget Scaling
1650 * Different widgets can be scaled independently. These functions
1651 * allow you to manipulate this scaling on a per-widget basis. The
1652 * object and all its children get their scaling factors multiplied
1653 * by the scale factor set. This is multiplicative, in that if a
1654 * child also has a scale size set it is in turn multiplied by its
1655 * parent's scale size. @c 1.0 means ādon't scaleā, @c 2.0 is
1656 * double size, @c 0.5 is half, etc.
1658 * @ref general_functions_example_page "This" example contemplates
1659 * some of these functions.
1663 * Get the global scaling factor
1665 * This gets the globally configured scaling factor that is applied to all
1668 * @return The scaling factor
1671 EAPI double elm_scale_get(void);
1674 * Set the global scaling factor
1676 * This sets the globally configured scaling factor that is applied to all
1679 * @param scale The scaling factor to set
1682 EAPI void elm_scale_set(double scale);
1685 * Set the global scaling factor for all applications on the display
1687 * This sets the globally configured scaling factor that is applied to all
1688 * objects for all applications.
1689 * @param scale The scaling factor to set
1692 EAPI void elm_scale_all_set(double scale);
1695 * Set the scaling factor for a given Elementary object
1697 * @param obj The Elementary to operate on
1698 * @param scale Scale factor (from @c 0.0 up, with @c 1.0 meaning
1703 EAPI void elm_object_scale_set(Evas_Object *obj, double scale) EINA_ARG_NONNULL(1);
1706 * Get the scaling factor for a given Elementary object
1708 * @param obj The object
1709 * @return The scaling factor set by elm_object_scale_set()
1713 EAPI double elm_object_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1716 * @defgroup Password_last_show Password last input show
1718 * Last show feature of password mode enables user to view
1719 * the last input entered for few seconds before masking it.
1720 * These functions allow to set this feature in password mode
1721 * of entry widget and also allow to manipulate the duration
1722 * for which the input has to be visible.
1728 * Get show last setting of password mode.
1730 * This gets the show last input setting of password mode which might be
1731 * enabled or disabled.
1733 * @return @c EINA_TRUE, if the last input show setting is enabled, @c EINA_FALSE
1735 * @ingroup Password_last_show
1737 EAPI Eina_Bool elm_password_show_last_get(void);
1740 * Set show last setting in password mode.
1742 * This enables or disables show last setting of password mode.
1744 * @param password_show_last If EINA_TRUE enable's last input show in password mode.
1745 * @see elm_password_show_last_timeout_set()
1746 * @ingroup Password_last_show
1748 EAPI void elm_password_show_last_set(Eina_Bool password_show_last);
1751 * Get's the timeout value in last show password mode.
1753 * This gets the time out value for which the last input entered in password
1754 * mode will be visible.
1756 * @return The timeout value of last show password mode.
1757 * @ingroup Password_last_show
1759 EAPI double elm_password_show_last_timeout_get(void);
1762 * Set's the timeout value in last show password mode.
1764 * This sets the time out value for which the last input entered in password
1765 * mode will be visible.
1767 * @param password_show_last_timeout The timeout value.
1768 * @see elm_password_show_last_set()
1769 * @ingroup Password_last_show
1771 EAPI void elm_password_show_last_timeout_set(double password_show_last_timeout);
1778 * @defgroup UI-Mirroring Selective Widget mirroring
1780 * These functions allow you to set ui-mirroring on specific
1781 * widgets or the whole interface. Widgets can be in one of two
1782 * modes, automatic and manual. Automatic means they'll be changed
1783 * according to the system mirroring mode and manual means only
1784 * explicit changes will matter. You are not supposed to change
1785 * mirroring state of a widget set to automatic, will mostly work,
1786 * but the behavior is not really defined.
1791 EAPI Eina_Bool elm_mirrored_get(void);
1792 EAPI void elm_mirrored_set(Eina_Bool mirrored);
1795 * Get the system mirrored mode. This determines the default mirrored mode
1798 * @return EINA_TRUE if mirrored is set, EINA_FALSE otherwise
1800 EAPI Eina_Bool elm_object_mirrored_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1803 * Set the system mirrored mode. This determines the default mirrored mode
1806 * @param mirrored EINA_TRUE to set mirrored mode, EINA_FALSE to unset it.
1808 EAPI void elm_object_mirrored_set(Evas_Object *obj, Eina_Bool mirrored) EINA_ARG_NONNULL(1);
1811 * Returns the widget's mirrored mode setting.
1813 * @param obj The widget.
1814 * @return mirrored mode setting of the object.
1817 EAPI Eina_Bool elm_object_mirrored_automatic_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1820 * Sets the widget's mirrored mode setting.
1821 * When widget in automatic mode, it follows the system mirrored mode set by
1822 * elm_mirrored_set().
1823 * @param obj The widget.
1824 * @param automatic EINA_TRUE for auto mirrored mode. EINA_FALSE for manual.
1826 EAPI void elm_object_mirrored_automatic_set(Evas_Object *obj, Eina_Bool automatic) EINA_ARG_NONNULL(1);
1833 * Set the style to use by a widget
1835 * Sets the style name that will define the appearance of a widget. Styles
1836 * vary from widget to widget and may also be defined by other themes
1837 * by means of extensions and overlays.
1839 * @param obj The Elementary widget to style
1840 * @param style The style name to use
1842 * @see elm_theme_extension_add()
1843 * @see elm_theme_extension_del()
1844 * @see elm_theme_overlay_add()
1845 * @see elm_theme_overlay_del()
1849 EAPI void elm_object_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
1851 * Get the style used by the widget
1853 * This gets the style being used for that widget. Note that the string
1854 * pointer is only valid as longas the object is valid and the style doesn't
1857 * @param obj The Elementary widget to query for its style
1858 * @return The style name used
1860 * @see elm_object_style_set()
1864 EAPI const char *elm_object_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1867 * @defgroup Styles Styles
1869 * Widgets can have different styles of look. These generic API's
1870 * set styles of widgets, if they support them (and if the theme(s)
1873 * @ref general_functions_example_page "This" example contemplates
1874 * some of these functions.
1878 * Set the disabled state of an Elementary object.
1880 * @param obj The Elementary object to operate on
1881 * @param disabled The state to put in in: @c EINA_TRUE for
1882 * disabled, @c EINA_FALSE for enabled
1884 * Elementary objects can be @b disabled, in which state they won't
1885 * receive input and, in general, will be themed differently from
1886 * their normal state, usually greyed out. Useful for contexts
1887 * where you don't want your users to interact with some of the
1888 * parts of you interface.
1890 * This sets the state for the widget, either disabling it or
1895 EAPI void elm_object_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
1898 * Get the disabled state of an Elementary object.
1900 * @param obj The Elementary object to operate on
1901 * @return @c EINA_TRUE, if the widget is disabled, @c EINA_FALSE
1902 * if it's enabled (or on errors)
1904 * This gets the state of the widget, which might be enabled or disabled.
1908 EAPI Eina_Bool elm_object_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1911 * @defgroup WidgetNavigation Widget Tree Navigation.
1913 * How to check if an Evas Object is an Elementary widget? How to
1914 * get the first elementary widget that is parent of the given
1915 * object? These are all covered in widget tree navigation.
1917 * @ref general_functions_example_page "This" example contemplates
1918 * some of these functions.
1922 * Check if the given Evas Object is an Elementary widget.
1924 * @param obj the object to query.
1925 * @return @c EINA_TRUE if it is an elementary widget variant,
1926 * @c EINA_FALSE otherwise
1927 * @ingroup WidgetNavigation
1929 EAPI Eina_Bool elm_object_widget_check(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1932 * Get the first parent of the given object that is an Elementary
1935 * @param obj the Elementary object to query parent from.
1936 * @return the parent object that is an Elementary widget, or @c
1937 * NULL, if it was not found.
1939 * Use this to query for an object's parent widget.
1941 * @note Most of Elementary users wouldn't be mixing non-Elementary
1942 * smart objects in the objects tree of an application, as this is
1943 * an advanced usage of Elementary with Evas. So, except for the
1944 * application's window, which is the root of that tree, all other
1945 * objects would have valid Elementary widget parents.
1947 * @ingroup WidgetNavigation
1949 EAPI Evas_Object *elm_object_parent_widget_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1952 * Get the top level parent of an Elementary widget.
1954 * @param obj The object to query.
1955 * @return The top level Elementary widget, or @c NULL if parent cannot be
1957 * @ingroup WidgetNavigation
1959 EAPI Evas_Object *elm_object_top_widget_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1962 * Get the string that represents this Elementary widget.
1964 * @note Elementary is weird and exposes itself as a single
1965 * Evas_Object_Smart_Class of type "elm_widget", so
1966 * evas_object_type_get() always return that, making debug and
1967 * language bindings hard. This function tries to mitigate this
1968 * problem, but the solution is to change Elementary to use
1969 * proper inheritance.
1971 * @param obj the object to query.
1972 * @return Elementary widget name, or @c NULL if not a valid widget.
1973 * @ingroup WidgetNavigation
1975 EAPI const char *elm_object_widget_type_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1978 * @defgroup Config Elementary Config
1980 * Elementary configuration is formed by a set options bounded to a
1981 * given @ref Profile profile, like @ref Theme theme, @ref Fingers
1982 * "finger size", etc. These are functions with which one syncronizes
1983 * changes made to those values to the configuration storing files, de
1984 * facto. You most probably don't want to use the functions in this
1985 * group unlees you're writing an elementary configuration manager.
1991 * Save back Elementary's configuration, so that it will persist on
1994 * @return @c EINA_TRUE, when sucessful. @c EINA_FALSE, otherwise.
1997 * This function will take effect -- thus, do I/O -- immediately. Use
1998 * it when you want to apply all configuration changes at once. The
1999 * current configuration set will get saved onto the current profile
2000 * configuration file.
2003 EAPI Eina_Bool elm_config_save(void);
2006 * Reload Elementary's configuration, bounded to current selected
2009 * @return @c EINA_TRUE, when sucessful. @c EINA_FALSE, otherwise.
2012 * Useful when you want to force reloading of configuration values for
2013 * a profile. If one removes user custom configuration directories,
2014 * for example, it will force a reload with system values instead.
2017 EAPI void elm_config_reload(void);
2024 * @defgroup Profile Elementary Profile
2026 * Profiles are pre-set options that affect the whole look-and-feel of
2027 * Elementary-based applications. There are, for example, profiles
2028 * aimed at desktop computer applications and others aimed at mobile,
2029 * touchscreen-based ones. You most probably don't want to use the
2030 * functions in this group unlees you're writing an elementary
2031 * configuration manager.
2037 * Get Elementary's profile in use.
2039 * This gets the global profile that is applied to all Elementary
2042 * @return The profile's name
2045 EAPI const char *elm_profile_current_get(void);
2048 * Get an Elementary's profile directory path in the filesystem. One
2049 * may want to fetch a system profile's dir or an user one (fetched
2052 * @param profile The profile's name
2053 * @param is_user Whether to lookup for an user profile (@c EINA_TRUE)
2054 * or a system one (@c EINA_FALSE)
2055 * @return The profile's directory path.
2058 * @note You must free it with elm_profile_dir_free().
2060 EAPI const char *elm_profile_dir_get(const char *profile, Eina_Bool is_user);
2063 * Free an Elementary's profile directory path, as returned by
2064 * elm_profile_dir_get().
2066 * @param p_dir The profile's path
2070 EAPI void elm_profile_dir_free(const char *p_dir);
2073 * Get Elementary's list of available profiles.
2075 * @return The profiles list. List node data are the profile name
2079 * @note One must free this list, after usage, with the function
2080 * elm_profile_list_free().
2082 EAPI Eina_List *elm_profile_list_get(void);
2085 * Free Elementary's list of available profiles.
2087 * @param l The profiles list, as returned by elm_profile_list_get().
2091 EAPI void elm_profile_list_free(Eina_List *l);
2094 * Set Elementary's profile.
2096 * This sets the global profile that is applied to Elementary
2097 * applications. Just the process the call comes from will be
2100 * @param profile The profile's name
2104 EAPI void elm_profile_set(const char *profile);
2107 * Set Elementary's profile.
2109 * This sets the global profile that is applied to all Elementary
2110 * applications. All running Elementary windows will be affected.
2112 * @param profile The profile's name
2116 EAPI void elm_profile_all_set(const char *profile);
2123 * @defgroup Engine Elementary Engine
2125 * These are functions setting and querying which rendering engine
2126 * Elementary will use for drawing its windows' pixels.
2128 * The following are the available engines:
2129 * @li "software_x11"
2132 * @li "software_16_x11"
2133 * @li "software_8_x11"
2136 * @li "software_gdi"
2137 * @li "software_16_wince_gdi"
2139 * @li "software_16_sdl"
2143 * @li "opengl_cocoa"
2150 * @brief Get Elementary's rendering engine in use.
2152 * @return The rendering engine's name
2153 * @note there's no need to free the returned string, here.
2155 * This gets the global rendering engine that is applied to all Elementary
2158 * @see elm_engine_set()
2160 EAPI const char *elm_engine_current_get(void);
2163 * @brief Set Elementary's rendering engine for use.
2165 * @param engine The rendering engine's name
2167 * This sets global rendering engine that is applied to all Elementary
2168 * applications. Note that it will take effect only to Elementary windows
2169 * created after this is called.
2171 * @see elm_win_add()
2173 EAPI void elm_engine_set(const char *engine);
2180 * @defgroup Fonts Elementary Fonts
2182 * These are functions dealing with font rendering, selection and the
2183 * like for Elementary applications. One might fetch which system
2184 * fonts are there to use and set custom fonts for individual classes
2185 * of UI items containing text (text classes).
2190 typedef struct _Elm_Text_Class
2196 typedef struct _Elm_Font_Overlay
2198 const char *text_class;
2200 Evas_Font_Size size;
2203 typedef struct _Elm_Font_Properties
2207 } Elm_Font_Properties;
2210 * Get Elementary's list of supported text classes.
2212 * @return The text classes list, with @c Elm_Text_Class blobs as data.
2215 * Release the list with elm_text_classes_list_free().
2217 EAPI const Eina_List *elm_text_classes_list_get(void);
2220 * Free Elementary's list of supported text classes.
2224 * @see elm_text_classes_list_get().
2226 EAPI void elm_text_classes_list_free(const Eina_List *list);
2229 * Get Elementary's list of font overlays, set with
2230 * elm_font_overlay_set().
2232 * @return The font overlays list, with @c Elm_Font_Overlay blobs as
2237 * For each text class, one can set a <b>font overlay</b> for it,
2238 * overriding the default font properties for that class coming from
2239 * the theme in use. There is no need to free this list.
2241 * @see elm_font_overlay_set() and elm_font_overlay_unset().
2243 EAPI const Eina_List *elm_font_overlay_list_get(void);
2246 * Set a font overlay for a given Elementary text class.
2248 * @param text_class Text class name
2249 * @param font Font name and style string
2250 * @param size Font size
2254 * @p font has to be in the format returned by
2255 * elm_font_fontconfig_name_get(). @see elm_font_overlay_list_get()
2256 * and elm_font_overlay_unset().
2258 EAPI void elm_font_overlay_set(const char *text_class, const char *font, Evas_Font_Size size);
2261 * Unset a font overlay for a given Elementary text class.
2263 * @param text_class Text class name
2267 * This will bring back text elements belonging to text class
2268 * @p text_class back to their default font settings.
2270 EAPI void elm_font_overlay_unset(const char *text_class);
2273 * Apply the changes made with elm_font_overlay_set() and
2274 * elm_font_overlay_unset() on the current Elementary window.
2278 * This applies all font overlays set to all objects in the UI.
2280 EAPI void elm_font_overlay_apply(void);
2283 * Apply the changes made with elm_font_overlay_set() and
2284 * elm_font_overlay_unset() on all Elementary application windows.
2288 * This applies all font overlays set to all objects in the UI.
2290 EAPI void elm_font_overlay_all_apply(void);
2293 * Translate a font (family) name string in fontconfig's font names
2294 * syntax into an @c Elm_Font_Properties struct.
2296 * @param font The font name and styles string
2297 * @return the font properties struct
2301 * @note The reverse translation can be achived with
2302 * elm_font_fontconfig_name_get(), for one style only (single font
2303 * instance, not family).
2305 EAPI Elm_Font_Properties *elm_font_properties_get(const char *font) EINA_ARG_NONNULL(1);
2308 * Free font properties return by elm_font_properties_get().
2310 * @param efp the font properties struct
2314 EAPI void elm_font_properties_free(Elm_Font_Properties *efp) EINA_ARG_NONNULL(1);
2317 * Translate a font name, bound to a style, into fontconfig's font names
2320 * @param name The font (family) name
2321 * @param style The given style (may be @c NULL)
2323 * @return the font name and style string
2327 * @note The reverse translation can be achived with
2328 * elm_font_properties_get(), for one style only (single font
2329 * instance, not family).
2331 EAPI const char *elm_font_fontconfig_name_get(const char *name, const char *style) EINA_ARG_NONNULL(1);
2334 * Free the font string return by elm_font_fontconfig_name_get().
2336 * @param efp the font properties struct
2340 EAPI void elm_font_fontconfig_name_free(const char *name) EINA_ARG_NONNULL(1);
2343 * Create a font hash table of available system fonts.
2345 * One must call it with @p list being the return value of
2346 * evas_font_available_list(). The hash will be indexed by font
2347 * (family) names, being its values @c Elm_Font_Properties blobs.
2349 * @param list The list of available system fonts, as returned by
2350 * evas_font_available_list().
2351 * @return the font hash.
2355 * @note The user is supposed to get it populated at least with 3
2356 * default font families (Sans, Serif, Monospace), which should be
2357 * present on most systems.
2359 EAPI Eina_Hash *elm_font_available_hash_add(Eina_List *list);
2362 * Free the hash return by elm_font_available_hash_add().
2364 * @param hash the hash to be freed.
2368 EAPI void elm_font_available_hash_del(Eina_Hash *hash);
2375 * @defgroup Fingers Fingers
2377 * Elementary is designed to be finger-friendly for touchscreens,
2378 * and so in addition to scaling for display resolution, it can
2379 * also scale based on finger "resolution" (or size). You can then
2380 * customize the granularity of the areas meant to receive clicks
2383 * Different profiles may have pre-set values for finger sizes.
2385 * @ref general_functions_example_page "This" example contemplates
2386 * some of these functions.
2392 * Get the configured "finger size"
2394 * @return The finger size
2396 * This gets the globally configured finger size, <b>in pixels</b>
2400 EAPI Evas_Coord elm_finger_size_get(void);
2403 * Set the configured finger size
2405 * This sets the globally configured finger size in pixels
2407 * @param size The finger size
2410 EAPI void elm_finger_size_set(Evas_Coord size);
2413 * Set the configured finger size for all applications on the display
2415 * This sets the globally configured finger size in pixels for all
2416 * applications on the display
2418 * @param size The finger size
2421 EAPI void elm_finger_size_all_set(Evas_Coord size);
2428 * @defgroup Focus Focus
2430 * An Elementary application has, at all times, one (and only one)
2431 * @b focused object. This is what determines where the input
2432 * events go to within the application's window. Also, focused
2433 * objects can be decorated differently, in order to signal to the
2434 * user where the input is, at a given moment.
2436 * Elementary applications also have the concept of <b>focus
2437 * chain</b>: one can cycle through all the windows' focusable
2438 * objects by input (tab key) or programmatically. The default
2439 * focus chain for an application is the one define by the order in
2440 * which the widgets where added in code. One will cycle through
2441 * top level widgets, and, for each one containg sub-objects, cycle
2442 * through them all, before returning to the level
2443 * above. Elementary also allows one to set @b custom focus chains
2444 * for their applications.
2446 * Besides the focused decoration a widget may exhibit, when it
2447 * gets focus, Elementary has a @b global focus highlight object
2448 * that can be enabled for a window. If one chooses to do so, this
2449 * extra highlight effect will surround the current focused object,
2452 * @note Some Elementary widgets are @b unfocusable, after
2453 * creation, by their very nature: they are not meant to be
2454 * interacted with input events, but are there just for visual
2457 * @ref general_functions_example_page "This" example contemplates
2458 * some of these functions.
2462 * Get the enable status of the focus highlight
2464 * This gets whether the highlight on focused objects is enabled or not
2467 EAPI Eina_Bool elm_focus_highlight_enabled_get(void);
2470 * Set the enable status of the focus highlight
2472 * Set whether to show or not the highlight on focused objects
2473 * @param enable Enable highlight if EINA_TRUE, disable otherwise
2476 EAPI void elm_focus_highlight_enabled_set(Eina_Bool enable);
2479 * Get the enable status of the highlight animation
2481 * Get whether the focus highlight, if enabled, will animate its switch from
2482 * one object to the next
2485 EAPI Eina_Bool elm_focus_highlight_animate_get(void);
2488 * Set the enable status of the highlight animation
2490 * Set whether the focus highlight, if enabled, will animate its switch from
2491 * one object to the next
2492 * @param animate Enable animation if EINA_TRUE, disable otherwise
2495 EAPI void elm_focus_highlight_animate_set(Eina_Bool animate);
2498 * Get the whether an Elementary object has the focus or not.
2500 * @param obj The Elementary object to get the information from
2501 * @return @c EINA_TRUE, if the object is focused, @c EINA_FALSE if
2502 * not (and on errors).
2504 * @see elm_object_focus_set()
2508 EAPI Eina_Bool elm_object_focus_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2511 * Set/unset focus to a given Elementary object.
2513 * @param obj The Elementary object to operate on.
2514 * @param enable @c EINA_TRUE Set focus to a given object,
2515 * @c EINA_FALSE Unset focus to a given object.
2517 * @note When you set focus to this object, if it can handle focus, will
2518 * take the focus away from the one who had it previously and will, for
2519 * now on, be the one receiving input events. Unsetting focus will remove
2520 * the focus from @p obj, passing it back to the previous element in the
2523 * @see elm_object_focus_get(), elm_object_focus_custom_chain_get()
2527 EAPI void elm_object_focus_set(Evas_Object *obj, Eina_Bool focus) EINA_ARG_NONNULL(1);
2530 * Make a given Elementary object the focused one.
2532 * @param obj The Elementary object to make focused.
2534 * @note This object, if it can handle focus, will take the focus
2535 * away from the one who had it previously and will, for now on, be
2536 * the one receiving input events.
2538 * @see elm_object_focus_get()
2539 * @deprecated use elm_object_focus_set() instead.
2543 EINA_DEPRECATED EAPI void elm_object_focus(Evas_Object *obj) EINA_ARG_NONNULL(1);
2546 * Remove the focus from an Elementary object
2548 * @param obj The Elementary to take focus from
2550 * This removes the focus from @p obj, passing it back to the
2551 * previous element in the focus chain list.
2553 * @see elm_object_focus() and elm_object_focus_custom_chain_get()
2554 * @deprecated use elm_object_focus_set() instead.
2558 EINA_DEPRECATED EAPI void elm_object_unfocus(Evas_Object *obj) EINA_ARG_NONNULL(1);
2561 * Set the ability for an Element object to be focused
2563 * @param obj The Elementary object to operate on
2564 * @param enable @c EINA_TRUE if the object can be focused, @c
2565 * EINA_FALSE if not (and on errors)
2567 * This sets whether the object @p obj is able to take focus or
2568 * not. Unfocusable objects do nothing when programmatically
2569 * focused, being the nearest focusable parent object the one
2570 * really getting focus. Also, when they receive mouse input, they
2571 * will get the event, but not take away the focus from where it
2576 EAPI void elm_object_focus_allow_set(Evas_Object *obj, Eina_Bool enable) EINA_ARG_NONNULL(1);
2579 * Get whether an Elementary object is focusable or not
2581 * @param obj The Elementary object to operate on
2582 * @return @c EINA_TRUE if the object is allowed to be focused, @c
2583 * EINA_FALSE if not (and on errors)
2585 * @note Objects which are meant to be interacted with by input
2586 * events are created able to be focused, by default. All the
2591 EAPI Eina_Bool elm_object_focus_allow_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2594 * Set custom focus chain.
2596 * This function overwrites any previous custom focus chain within
2597 * the list of objects. The previous list will be deleted and this list
2598 * will be managed by elementary. After it is set, don't modify it.
2600 * @note On focus cycle, only will be evaluated children of this container.
2602 * @param obj The container object
2603 * @param objs Chain of objects to pass focus
2606 EAPI void elm_object_focus_custom_chain_set(Evas_Object *obj, Eina_List *objs) EINA_ARG_NONNULL(1);
2609 * Unset a custom focus chain on a given Elementary widget
2611 * @param obj The container object to remove focus chain from
2613 * Any focus chain previously set on @p obj (for its child objects)
2614 * is removed entirely after this call.
2618 EAPI void elm_object_focus_custom_chain_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
2621 * Get custom focus chain
2623 * @param obj The container object
2626 EAPI const Eina_List *elm_object_focus_custom_chain_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2629 * Append object to custom focus chain.
2631 * @note If relative_child equal to NULL or not in custom chain, the object
2632 * will be added in end.
2634 * @note On focus cycle, only will be evaluated children of this container.
2636 * @param obj The container object
2637 * @param child The child to be added in custom chain
2638 * @param relative_child The relative object to position the child
2641 EAPI void elm_object_focus_custom_chain_append(Evas_Object *obj, Evas_Object *child, Evas_Object *relative_child) EINA_ARG_NONNULL(1, 2);
2644 * Prepend object to custom focus chain.
2646 * @note If relative_child equal to NULL or not in custom chain, the object
2647 * will be added in begin.
2649 * @note On focus cycle, only will be evaluated children of this container.
2651 * @param obj The container object
2652 * @param child The child to be added in custom chain
2653 * @param relative_child The relative object to position the child
2656 EAPI void elm_object_focus_custom_chain_prepend(Evas_Object *obj, Evas_Object *child, Evas_Object *relative_child) EINA_ARG_NONNULL(1, 2);
2659 * Give focus to next object in object tree.
2661 * Give focus to next object in focus chain of one object sub-tree.
2662 * If the last object of chain already have focus, the focus will go to the
2663 * first object of chain.
2665 * @param obj The object root of sub-tree
2666 * @param dir Direction to cycle the focus
2670 EAPI void elm_object_focus_cycle(Evas_Object *obj, Elm_Focus_Direction dir) EINA_ARG_NONNULL(1);
2673 * Give focus to near object in one direction.
2675 * Give focus to near object in direction of one object.
2676 * If none focusable object in given direction, the focus will not change.
2678 * @param obj The reference object
2679 * @param x Horizontal component of direction to focus
2680 * @param y Vertical component of direction to focus
2684 EAPI void elm_object_focus_direction_go(Evas_Object *obj, int x, int y) EINA_ARG_NONNULL(1);
2687 * Make the elementary object and its children to be unfocusable
2690 * @param obj The Elementary object to operate on
2691 * @param tree_unfocusable @c EINA_TRUE for unfocusable,
2692 * @c EINA_FALSE for focusable.
2694 * This sets whether the object @p obj and its children objects
2695 * are able to take focus or not. If the tree is set as unfocusable,
2696 * newest focused object which is not in this tree will get focus.
2697 * This API can be helpful for an object to be deleted.
2698 * When an object will be deleted soon, it and its children may not
2699 * want to get focus (by focus reverting or by other focus controls).
2700 * Then, just use this API before deleting.
2702 * @see elm_object_tree_unfocusable_get()
2706 EAPI void elm_object_tree_unfocusable_set(Evas_Object *obj, Eina_Bool tree_unfocusable) EINA_ARG_NONNULL(1);
2709 * Get whether an Elementary object and its children are unfocusable or not.
2711 * @param obj The Elementary object to get the information from
2712 * @return @c EINA_TRUE, if the tree is unfocussable,
2713 * @c EINA_FALSE if not (and on errors).
2715 * @see elm_object_tree_unfocusable_set()
2719 EAPI Eina_Bool elm_object_tree_unfocusable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2722 * @defgroup Scrolling Scrolling
2724 * These are functions setting how scrollable views in Elementary
2725 * widgets should behave on user interaction.
2731 * Get whether scrollers should bounce when they reach their
2732 * viewport's edge during a scroll.
2734 * @return the thumb scroll bouncing state
2736 * This is the default behavior for touch screens, in general.
2737 * @ingroup Scrolling
2739 EAPI Eina_Bool elm_scroll_bounce_enabled_get(void);
2742 * Set whether scrollers should bounce when they reach their
2743 * viewport's edge during a scroll.
2745 * @param enabled the thumb scroll bouncing state
2747 * @see elm_thumbscroll_bounce_enabled_get()
2748 * @ingroup Scrolling
2750 EAPI void elm_scroll_bounce_enabled_set(Eina_Bool enabled);
2753 * Set whether scrollers should bounce when they reach their
2754 * viewport's edge during a scroll, for all Elementary application
2757 * @param enabled the thumb scroll bouncing state
2759 * @see elm_thumbscroll_bounce_enabled_get()
2760 * @ingroup Scrolling
2762 EAPI void elm_scroll_bounce_enabled_all_set(Eina_Bool enabled);
2765 * Get the amount of inertia a scroller will impose at bounce
2768 * @return the thumb scroll bounce friction
2770 * @ingroup Scrolling
2772 EAPI double elm_scroll_bounce_friction_get(void);
2775 * Set the amount of inertia a scroller will impose at bounce
2778 * @param friction the thumb scroll bounce friction
2780 * @see elm_thumbscroll_bounce_friction_get()
2781 * @ingroup Scrolling
2783 EAPI void elm_scroll_bounce_friction_set(double friction);
2786 * Set the amount of inertia a scroller will impose at bounce
2787 * animations, for all Elementary application windows.
2789 * @param friction the thumb scroll bounce friction
2791 * @see elm_thumbscroll_bounce_friction_get()
2792 * @ingroup Scrolling
2794 EAPI void elm_scroll_bounce_friction_all_set(double friction);
2797 * Get the amount of inertia a <b>paged</b> scroller will impose at
2798 * page fitting animations.
2800 * @return the page scroll friction
2802 * @ingroup Scrolling
2804 EAPI double elm_scroll_page_scroll_friction_get(void);
2807 * Set the amount of inertia a <b>paged</b> scroller will impose at
2808 * page fitting animations.
2810 * @param friction the page scroll friction
2812 * @see elm_thumbscroll_page_scroll_friction_get()
2813 * @ingroup Scrolling
2815 EAPI void elm_scroll_page_scroll_friction_set(double friction);
2818 * Set the amount of inertia a <b>paged</b> scroller will impose at
2819 * page fitting animations, for all Elementary application windows.
2821 * @param friction the page scroll friction
2823 * @see elm_thumbscroll_page_scroll_friction_get()
2824 * @ingroup Scrolling
2826 EAPI void elm_scroll_page_scroll_friction_all_set(double friction);
2829 * Get the amount of inertia a scroller will impose at region bring
2832 * @return the bring in scroll friction
2834 * @ingroup Scrolling
2836 EAPI double elm_scroll_bring_in_scroll_friction_get(void);
2839 * Set the amount of inertia a scroller will impose at region bring
2842 * @param friction the bring in scroll friction
2844 * @see elm_thumbscroll_bring_in_scroll_friction_get()
2845 * @ingroup Scrolling
2847 EAPI void elm_scroll_bring_in_scroll_friction_set(double friction);
2850 * Set the amount of inertia a scroller will impose at region bring
2851 * animations, for all Elementary application windows.
2853 * @param friction the bring in scroll friction
2855 * @see elm_thumbscroll_bring_in_scroll_friction_get()
2856 * @ingroup Scrolling
2858 EAPI void elm_scroll_bring_in_scroll_friction_all_set(double friction);
2861 * Get the amount of inertia scrollers will impose at animations
2862 * triggered by Elementary widgets' zooming API.
2864 * @return the zoom friction
2866 * @ingroup Scrolling
2868 EAPI double elm_scroll_zoom_friction_get(void);
2871 * Set the amount of inertia scrollers will impose at animations
2872 * triggered by Elementary widgets' zooming API.
2874 * @param friction the zoom friction
2876 * @see elm_thumbscroll_zoom_friction_get()
2877 * @ingroup Scrolling
2879 EAPI void elm_scroll_zoom_friction_set(double friction);
2882 * Set the amount of inertia scrollers will impose at animations
2883 * triggered by Elementary widgets' zooming API, for all Elementary
2884 * application windows.
2886 * @param friction the zoom friction
2888 * @see elm_thumbscroll_zoom_friction_get()
2889 * @ingroup Scrolling
2891 EAPI void elm_scroll_zoom_friction_all_set(double friction);
2894 * Get whether scrollers should be draggable from any point in their
2897 * @return the thumb scroll state
2899 * @note This is the default behavior for touch screens, in general.
2900 * @note All other functions namespaced with "thumbscroll" will only
2901 * have effect if this mode is enabled.
2903 * @ingroup Scrolling
2905 EAPI Eina_Bool elm_scroll_thumbscroll_enabled_get(void);
2908 * Set whether scrollers should be draggable from any point in their
2911 * @param enabled the thumb scroll state
2913 * @see elm_thumbscroll_enabled_get()
2914 * @ingroup Scrolling
2916 EAPI void elm_scroll_thumbscroll_enabled_set(Eina_Bool enabled);
2919 * Set whether scrollers should be draggable from any point in their
2920 * views, for all Elementary application windows.
2922 * @param enabled the thumb scroll state
2924 * @see elm_thumbscroll_enabled_get()
2925 * @ingroup Scrolling
2927 EAPI void elm_scroll_thumbscroll_enabled_all_set(Eina_Bool enabled);
2930 * Get the number of pixels one should travel while dragging a
2931 * scroller's view to actually trigger scrolling.
2933 * @return the thumb scroll threshould
2935 * One would use higher values for touch screens, in general, because
2936 * of their inherent imprecision.
2937 * @ingroup Scrolling
2939 EAPI unsigned int elm_scroll_thumbscroll_threshold_get(void);
2942 * Set the number of pixels one should travel while dragging a
2943 * scroller's view to actually trigger scrolling.
2945 * @param threshold the thumb scroll threshould
2947 * @see elm_thumbscroll_threshould_get()
2948 * @ingroup Scrolling
2950 EAPI void elm_scroll_thumbscroll_threshold_set(unsigned int threshold);
2953 * Set the number of pixels one should travel while dragging a
2954 * scroller's view to actually trigger scrolling, for all Elementary
2955 * application windows.
2957 * @param threshold the thumb scroll threshould
2959 * @see elm_thumbscroll_threshould_get()
2960 * @ingroup Scrolling
2962 EAPI void elm_scroll_thumbscroll_threshold_all_set(unsigned int threshold);
2965 * Get the minimum speed of mouse cursor movement which will trigger
2966 * list self scrolling animation after a mouse up event
2969 * @return the thumb scroll momentum threshould
2971 * @ingroup Scrolling
2973 EAPI double elm_scroll_thumbscroll_momentum_threshold_get(void);
2976 * Set the minimum speed of mouse cursor movement which will trigger
2977 * list self scrolling animation after a mouse up event
2980 * @param threshold the thumb scroll momentum threshould
2982 * @see elm_thumbscroll_momentum_threshould_get()
2983 * @ingroup Scrolling
2985 EAPI void elm_scroll_thumbscroll_momentum_threshold_set(double threshold);
2988 * Set the minimum speed of mouse cursor movement which will trigger
2989 * list self scrolling animation after a mouse up event
2990 * (pixels/second), for all Elementary application windows.
2992 * @param threshold the thumb scroll momentum threshould
2994 * @see elm_thumbscroll_momentum_threshould_get()
2995 * @ingroup Scrolling
2997 EAPI void elm_scroll_thumbscroll_momentum_threshold_all_set(double threshold);
3000 * Get the amount of inertia a scroller will impose at self scrolling
3003 * @return the thumb scroll friction
3005 * @ingroup Scrolling
3007 EAPI double elm_scroll_thumbscroll_friction_get(void);
3010 * Set the amount of inertia a scroller will impose at self scrolling
3013 * @param friction the thumb scroll friction
3015 * @see elm_thumbscroll_friction_get()
3016 * @ingroup Scrolling
3018 EAPI void elm_scroll_thumbscroll_friction_set(double friction);
3021 * Set the amount of inertia a scroller will impose at self scrolling
3022 * animations, for all Elementary application windows.
3024 * @param friction the thumb scroll friction
3026 * @see elm_thumbscroll_friction_get()
3027 * @ingroup Scrolling
3029 EAPI void elm_scroll_thumbscroll_friction_all_set(double friction);
3032 * Get the amount of lag between your actual mouse cursor dragging
3033 * movement and a scroller's view movement itself, while pushing it
3034 * into bounce state manually.
3036 * @return the thumb scroll border friction
3038 * @ingroup Scrolling
3040 EAPI double elm_scroll_thumbscroll_border_friction_get(void);
3043 * Set the amount of lag between your actual mouse cursor dragging
3044 * movement and a scroller's view movement itself, while pushing it
3045 * into bounce state manually.
3047 * @param friction the thumb scroll border friction. @c 0.0 for
3048 * perfect synchrony between two movements, @c 1.0 for maximum
3051 * @see elm_thumbscroll_border_friction_get()
3052 * @note parameter value will get bound to 0.0 - 1.0 interval, always
3054 * @ingroup Scrolling
3056 EAPI void elm_scroll_thumbscroll_border_friction_set(double friction);
3059 * Set the amount of lag between your actual mouse cursor dragging
3060 * movement and a scroller's view movement itself, while pushing it
3061 * into bounce state manually, for all Elementary application windows.
3063 * @param friction the thumb scroll border friction. @c 0.0 for
3064 * perfect synchrony between two movements, @c 1.0 for maximum
3067 * @see elm_thumbscroll_border_friction_get()
3068 * @note parameter value will get bound to 0.0 - 1.0 interval, always
3070 * @ingroup Scrolling
3072 EAPI void elm_scroll_thumbscroll_border_friction_all_set(double friction);
3075 * Get the sensitivity amount which is be multiplied by the length of
3078 * @return the thumb scroll sensitivity friction
3080 * @ingroup Scrolling
3082 EAPI double elm_scroll_thumbscroll_sensitivity_friction_get(void);
3085 * Set the sensitivity amount which is be multiplied by the length of
3088 * @param friction the thumb scroll sensitivity friction. @c 0.1 for
3089 * minimun sensitivity, @c 1.0 for maximum sensitivity. 0.25
3092 * @see elm_thumbscroll_sensitivity_friction_get()
3093 * @note parameter value will get bound to 0.1 - 1.0 interval, always
3095 * @ingroup Scrolling
3097 EAPI void elm_scroll_thumbscroll_sensitivity_friction_set(double friction);
3100 * Set the sensitivity amount which is be multiplied by the length of
3101 * mouse dragging, for all Elementary application windows.
3103 * @param friction the thumb scroll sensitivity friction. @c 0.1 for
3104 * minimun sensitivity, @c 1.0 for maximum sensitivity. 0.25
3107 * @see elm_thumbscroll_sensitivity_friction_get()
3108 * @note parameter value will get bound to 0.1 - 1.0 interval, always
3110 * @ingroup Scrolling
3112 EAPI void elm_scroll_thumbscroll_sensitivity_friction_all_set(double friction);
3119 * @defgroup Scrollhints Scrollhints
3121 * Objects when inside a scroller can scroll, but this may not always be
3122 * desirable in certain situations. This allows an object to hint to itself
3123 * and parents to "not scroll" in one of 2 ways. If any child object of a
3124 * scroller has pushed a scroll freeze or hold then it affects all parent
3125 * scrollers until all children have released them.
3127 * 1. To hold on scrolling. This means just flicking and dragging may no
3128 * longer scroll, but pressing/dragging near an edge of the scroller will
3129 * still scroll. This is automatically used by the entry object when
3132 * 2. To totally freeze scrolling. This means it stops. until
3139 * Push the scroll hold by 1
3141 * This increments the scroll hold count by one. If it is more than 0 it will
3142 * take effect on the parents of the indicated object.
3144 * @param obj The object
3145 * @ingroup Scrollhints
3147 EAPI void elm_object_scroll_hold_push(Evas_Object *obj) EINA_ARG_NONNULL(1);
3150 * Pop the scroll hold by 1
3152 * This decrements the scroll hold count by one. If it is more than 0 it will
3153 * take effect on the parents of the indicated object.
3155 * @param obj The object
3156 * @ingroup Scrollhints
3158 EAPI void elm_object_scroll_hold_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
3161 * Push the scroll freeze by 1
3163 * This increments the scroll freeze count by one. If it is more
3164 * than 0 it will take effect on the parents of the indicated
3167 * @param obj The object
3168 * @ingroup Scrollhints
3170 EAPI void elm_object_scroll_freeze_push(Evas_Object *obj) EINA_ARG_NONNULL(1);
3173 * Pop the scroll freeze by 1
3175 * This decrements the scroll freeze count by one. If it is more
3176 * than 0 it will take effect on the parents of the indicated
3179 * @param obj The object
3180 * @ingroup Scrollhints
3182 EAPI void elm_object_scroll_freeze_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
3185 * Lock the scrolling of the given widget (and thus all parents)
3187 * This locks the given object from scrolling in the X axis (and implicitly
3188 * also locks all parent scrollers too from doing the same).
3190 * @param obj The object
3191 * @param lock The lock state (1 == locked, 0 == unlocked)
3192 * @ingroup Scrollhints
3194 EAPI void elm_object_scroll_lock_x_set(Evas_Object *obj, Eina_Bool lock) EINA_ARG_NONNULL(1);
3197 * Lock the scrolling of the given widget (and thus all parents)
3199 * This locks the given object from scrolling in the Y axis (and implicitly
3200 * also locks all parent scrollers too from doing the same).
3202 * @param obj The object
3203 * @param lock The lock state (1 == locked, 0 == unlocked)
3204 * @ingroup Scrollhints
3206 EAPI void elm_object_scroll_lock_y_set(Evas_Object *obj, Eina_Bool lock) EINA_ARG_NONNULL(1);
3209 * Get the scrolling lock of the given widget
3211 * This gets the lock for X axis scrolling.
3213 * @param obj The object
3214 * @ingroup Scrollhints
3216 EAPI Eina_Bool elm_object_scroll_lock_x_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3219 * Get the scrolling lock of the given widget
3221 * This gets the lock for X axis scrolling.
3223 * @param obj The object
3224 * @ingroup Scrollhints
3226 EAPI Eina_Bool elm_object_scroll_lock_y_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3233 * Send a signal to the widget edje object.
3235 * This function sends a signal to the edje object of the obj. An
3236 * edje program can respond to a signal by specifying matching
3237 * 'signal' and 'source' fields.
3239 * @param obj The object
3240 * @param emission The signal's name.
3241 * @param source The signal's source.
3244 EAPI void elm_object_signal_emit(Evas_Object *obj, const char *emission, const char *source) EINA_ARG_NONNULL(1);
3247 * Add a callback for a signal emitted by widget edje object.
3249 * This function connects a callback function to a signal emitted by the
3250 * edje object of the obj.
3251 * Globs can occur in either the emission or source name.
3253 * @param obj The object
3254 * @param emission The signal's name.
3255 * @param source The signal's source.
3256 * @param func The callback function to be executed when the signal is
3258 * @param data A pointer to data to pass in to the callback function.
3261 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);
3264 * Remove a signal-triggered callback from a widget edje object.
3266 * This function removes a callback, previoulsy attached to a
3267 * signal emitted by the edje object of the obj. The parameters
3268 * emission, source and func must match exactly those passed to a
3269 * previous call to elm_object_signal_callback_add(). The data
3270 * pointer that was passed to this call will be returned.
3272 * @param obj The object
3273 * @param emission The signal's name.
3274 * @param source The signal's source.
3275 * @param func The callback function to be executed when the signal is
3277 * @return The data pointer
3280 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);
3283 * Add a callback for input events (key up, key down, mouse wheel)
3284 * on a given Elementary widget
3286 * @param obj The widget to add an event callback on
3287 * @param func The callback function to be executed when the event
3289 * @param data Data to pass in to @p func
3291 * Every widget in an Elementary interface set to receive focus,
3292 * with elm_object_focus_allow_set(), will propagate @b all of its
3293 * key up, key down and mouse wheel input events up to its parent
3294 * object, and so on. All of the focusable ones in this chain which
3295 * had an event callback set, with this call, will be able to treat
3296 * those events. There are two ways of making the propagation of
3297 * these event upwards in the tree of widgets to @b cease:
3298 * - Just return @c EINA_TRUE on @p func. @c EINA_FALSE will mean
3299 * the event was @b not processed, so the propagation will go on.
3300 * - The @c event_info pointer passed to @p func will contain the
3301 * event's structure and, if you OR its @c event_flags inner
3302 * value to @c EVAS_EVENT_FLAG_ON_HOLD, you're telling Elementary
3303 * one has already handled it, thus killing the event's
3306 * @note Your event callback will be issued on those events taking
3307 * place only if no other child widget of @obj has consumed the
3310 * @note Not to be confused with @c
3311 * evas_object_event_callback_add(), which will add event callbacks
3312 * per type on general Evas objects (no event propagation
3313 * infrastructure taken in account).
3315 * @note Not to be confused with @c
3316 * elm_object_signal_callback_add(), which will add callbacks to @b
3317 * signals coming from a widget's theme, not input events.
3319 * @note Not to be confused with @c
3320 * edje_object_signal_callback_add(), which does the same as
3321 * elm_object_signal_callback_add(), but directly on an Edje
3324 * @note Not to be confused with @c
3325 * evas_object_smart_callback_add(), which adds callbacks to smart
3326 * objects' <b>smart events</b>, and not input events.
3328 * @see elm_object_event_callback_del()
3332 EAPI void elm_object_event_callback_add(Evas_Object *obj, Elm_Event_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
3335 * Remove an event callback from a widget.
3337 * This function removes a callback, previoulsy attached to event emission
3339 * The parameters func and data must match exactly those passed to
3340 * a previous call to elm_object_event_callback_add(). The data pointer that
3341 * was passed to this call will be returned.
3343 * @param obj The object
3344 * @param func The callback function to be executed when the event is
3346 * @param data Data to pass in to the callback function.
3347 * @return The data pointer
3350 EAPI void *elm_object_event_callback_del(Evas_Object *obj, Elm_Event_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
3353 * Adjust size of an element for finger usage.
3355 * @param times_w How many fingers should fit horizontally
3356 * @param w Pointer to the width size to adjust
3357 * @param times_h How many fingers should fit vertically
3358 * @param h Pointer to the height size to adjust
3360 * This takes width and height sizes (in pixels) as input and a
3361 * size multiple (which is how many fingers you want to place
3362 * within the area, being "finger" the size set by
3363 * elm_finger_size_set()), and adjusts the size to be large enough
3364 * to accommodate the resulting size -- if it doesn't already
3365 * accommodate it. On return the @p w and @p h sizes pointed to by
3366 * these parameters will be modified, on those conditions.
3368 * @note This is kind of a low level Elementary call, most useful
3369 * on size evaluation times for widgets. An external user wouldn't
3370 * be calling, most of the time.
3374 EAPI void elm_coords_finger_size_adjust(int times_w, Evas_Coord *w, int times_h, Evas_Coord *h);
3377 * Get the duration for occuring long press event.
3379 * @return Timeout for long press event
3380 * @ingroup Longpress
3382 EAPI double elm_longpress_timeout_get(void);
3385 * Set the duration for occuring long press event.
3387 * @param lonpress_timeout Timeout for long press event
3388 * @ingroup Longpress
3390 EAPI void elm_longpress_timeout_set(double longpress_timeout);
3393 * @defgroup Debug Debug
3394 * don't use it unless you are sure
3400 * Print Tree object hierarchy in stdout
3402 * @param obj The root object
3405 EAPI void elm_object_tree_dump(const Evas_Object *top);
3408 * Print Elm Objects tree hierarchy in file as dot(graphviz) syntax.
3410 * @param obj The root object
3411 * @param file The path of output file
3414 EAPI void elm_object_tree_dot_dump(const Evas_Object *top, const char *file);
3421 * @defgroup Theme Theme
3423 * Elementary uses Edje to theme its widgets, naturally. But for the most
3424 * part this is hidden behind a simpler interface that lets the user set
3425 * extensions and choose the style of widgets in a much easier way.
3427 * Instead of thinking in terms of paths to Edje files and their groups
3428 * each time you want to change the appearance of a widget, Elementary
3429 * works so you can add any theme file with extensions or replace the
3430 * main theme at one point in the application, and then just set the style
3431 * of widgets with elm_object_style_set() and related functions. Elementary
3432 * will then look in its list of themes for a matching group and apply it,
3433 * and when the theme changes midway through the application, all widgets
3434 * will be updated accordingly.
3436 * There are three concepts you need to know to understand how Elementary
3437 * theming works: default theme, extensions and overlays.
3439 * Default theme, obviously enough, is the one that provides the default
3440 * look of all widgets. End users can change the theme used by Elementary
3441 * by setting the @c ELM_THEME environment variable before running an
3442 * application, or globally for all programs using the @c elementary_config
3443 * utility. Applications can change the default theme using elm_theme_set(),
3444 * but this can go against the user wishes, so it's not an adviced practice.
3446 * Ideally, applications should find everything they need in the already
3447 * provided theme, but there may be occasions when that's not enough and
3448 * custom styles are required to correctly express the idea. For this
3449 * cases, Elementary has extensions.
3451 * Extensions allow the application developer to write styles of its own
3452 * to apply to some widgets. This requires knowledge of how each widget
3453 * is themed, as extensions will always replace the entire group used by
3454 * the widget, so important signals and parts need to be there for the
3455 * object to behave properly (see documentation of Edje for details).
3456 * Once the theme for the extension is done, the application needs to add
3457 * it to the list of themes Elementary will look into, using
3458 * elm_theme_extension_add(), and set the style of the desired widgets as
3459 * he would normally with elm_object_style_set().
3461 * Overlays, on the other hand, can replace the look of all widgets by
3462 * overriding the default style. Like extensions, it's up to the application
3463 * developer to write the theme for the widgets it wants, the difference
3464 * being that when looking for the theme, Elementary will check first the
3465 * list of overlays, then the set theme and lastly the list of extensions,
3466 * so with overlays it's possible to replace the default view and every
3467 * widget will be affected. This is very much alike to setting the whole
3468 * theme for the application and will probably clash with the end user
3469 * options, not to mention the risk of ending up with not matching styles
3470 * across the program. Unless there's a very special reason to use them,
3471 * overlays should be avoided for the resons exposed before.
3473 * All these theme lists are handled by ::Elm_Theme instances. Elementary
3474 * keeps one default internally and every function that receives one of
3475 * these can be called with NULL to refer to this default (except for
3476 * elm_theme_free()). It's possible to create a new instance of a
3477 * ::Elm_Theme to set other theme for a specific widget (and all of its
3478 * children), but this is as discouraged, if not even more so, than using
3479 * overlays. Don't use this unless you really know what you are doing.
3481 * But to be less negative about things, you can look at the following
3483 * @li @ref theme_example_01 "Using extensions"
3484 * @li @ref theme_example_02 "Using overlays"
3489 * @typedef Elm_Theme
3491 * Opaque handler for the list of themes Elementary looks for when
3492 * rendering widgets.
3494 * Stay out of this unless you really know what you are doing. For most
3495 * cases, sticking to the default is all a developer needs.
3497 typedef struct _Elm_Theme Elm_Theme;
3500 * Create a new specific theme
3502 * This creates an empty specific theme that only uses the default theme. A
3503 * specific theme has its own private set of extensions and overlays too
3504 * (which are empty by default). Specific themes do not fall back to themes
3505 * of parent objects. They are not intended for this use. Use styles, overlays
3506 * and extensions when needed, but avoid specific themes unless there is no
3507 * other way (example: you want to have a preview of a new theme you are
3508 * selecting in a "theme selector" window. The preview is inside a scroller
3509 * and should display what the theme you selected will look like, but not
3510 * actually apply it yet. The child of the scroller will have a specific
3511 * theme set to show this preview before the user decides to apply it to all
3514 EAPI Elm_Theme *elm_theme_new(void);
3516 * Free a specific theme
3518 * @param th The theme to free
3520 * This frees a theme created with elm_theme_new().
3522 EAPI void elm_theme_free(Elm_Theme *th);
3524 * Copy the theme fom the source to the destination theme
3526 * @param th The source theme to copy from
3527 * @param thdst The destination theme to copy data to
3529 * This makes a one-time static copy of all the theme config, extensions
3530 * and overlays from @p th to @p thdst. If @p th references a theme, then
3531 * @p thdst is also set to reference it, with all the theme settings,
3532 * overlays and extensions that @p th had.
3534 EAPI void elm_theme_copy(Elm_Theme *th, Elm_Theme *thdst);
3536 * Tell the source theme to reference the ref theme
3538 * @param th The theme that will do the referencing
3539 * @param thref The theme that is the reference source
3541 * This clears @p th to be empty and then sets it to refer to @p thref
3542 * so @p th acts as an override to @p thref, but where its overrides
3543 * don't apply, it will fall through to @p thref for configuration.
3545 EAPI void elm_theme_ref_set(Elm_Theme *th, Elm_Theme *thref);
3547 * Return the theme referred to
3549 * @param th The theme to get the reference from
3550 * @return The referenced theme handle
3552 * This gets the theme set as the reference theme by elm_theme_ref_set().
3553 * If no theme is set as a reference, NULL is returned.
3555 EAPI Elm_Theme *elm_theme_ref_get(Elm_Theme *th);
3557 * Return the default theme
3559 * @return The default theme handle
3561 * This returns the internal default theme setup handle that all widgets
3562 * use implicitly unless a specific theme is set. This is also often use
3563 * as a shorthand of NULL.
3565 EAPI Elm_Theme *elm_theme_default_get(void);
3567 * Prepends a theme overlay to the list of overlays
3569 * @param th The theme to add to, or if NULL, the default theme
3570 * @param item The Edje file path to be used
3572 * Use this if your application needs to provide some custom overlay theme
3573 * (An Edje file that replaces some default styles of widgets) where adding
3574 * new styles, or changing system theme configuration is not possible. Do
3575 * NOT use this instead of a proper system theme configuration. Use proper
3576 * configuration files, profiles, environment variables etc. to set a theme
3577 * so that the theme can be altered by simple confiugration by a user. Using
3578 * this call to achieve that effect is abusing the API and will create lots
3581 * @see elm_theme_extension_add()
3583 EAPI void elm_theme_overlay_add(Elm_Theme *th, const char *item);
3585 * Delete a theme overlay from the list of overlays
3587 * @param th The theme to delete from, or if NULL, the default theme
3588 * @param item The name of the theme overlay
3590 * @see elm_theme_overlay_add()
3592 EAPI void elm_theme_overlay_del(Elm_Theme *th, const char *item);
3594 * Appends a theme extension to the list of extensions.
3596 * @param th The theme to add to, or if NULL, the default theme
3597 * @param item The Edje file path to be used
3599 * This is intended when an application needs more styles of widgets or new
3600 * widget themes that the default does not provide (or may not provide). The
3601 * application has "extended" usage by coming up with new custom style names
3602 * for widgets for specific uses, but as these are not "standard", they are
3603 * not guaranteed to be provided by a default theme. This means the
3604 * application is required to provide these extra elements itself in specific
3605 * Edje files. This call adds one of those Edje files to the theme search
3606 * path to be search after the default theme. The use of this call is
3607 * encouraged when default styles do not meet the needs of the application.
3608 * Use this call instead of elm_theme_overlay_add() for almost all cases.
3610 * @see elm_object_style_set()
3612 EAPI void elm_theme_extension_add(Elm_Theme *th, const char *item);
3614 * Deletes a theme extension from the list of extensions.
3616 * @param th The theme to delete from, or if NULL, the default theme
3617 * @param item The name of the theme extension
3619 * @see elm_theme_extension_add()
3621 EAPI void elm_theme_extension_del(Elm_Theme *th, const char *item);
3623 * Set the theme search order for the given theme
3625 * @param th The theme to set the search order, or if NULL, the default theme
3626 * @param theme Theme search string
3628 * This sets the search string for the theme in path-notation from first
3629 * theme to search, to last, delimited by the : character. Example:
3631 * "shiny:/path/to/file.edj:default"
3633 * See the ELM_THEME environment variable for more information.
3635 * @see elm_theme_get()
3636 * @see elm_theme_list_get()
3638 EAPI void elm_theme_set(Elm_Theme *th, const char *theme);
3640 * Return the theme search order
3642 * @param th The theme to get the search order, or if NULL, the default theme
3643 * @return The internal search order path
3645 * This function returns a colon separated string of theme elements as
3646 * returned by elm_theme_list_get().
3648 * @see elm_theme_set()
3649 * @see elm_theme_list_get()
3651 EAPI const char *elm_theme_get(Elm_Theme *th);
3653 * Return a list of theme elements to be used in a theme.
3655 * @param th Theme to get the list of theme elements from.
3656 * @return The internal list of theme elements
3658 * This returns the internal list of theme elements (will only be valid as
3659 * long as the theme is not modified by elm_theme_set() or theme is not
3660 * freed by elm_theme_free(). This is a list of strings which must not be
3661 * altered as they are also internal. If @p th is NULL, then the default
3662 * theme element list is returned.
3664 * A theme element can consist of a full or relative path to a .edj file,
3665 * or a name, without extension, for a theme to be searched in the known
3666 * theme paths for Elemementary.
3668 * @see elm_theme_set()
3669 * @see elm_theme_get()
3671 EAPI const Eina_List *elm_theme_list_get(const Elm_Theme *th);
3673 * Return the full patrh for a theme element
3675 * @param f The theme element name
3676 * @param in_search_path Pointer to a boolean to indicate if item is in the search path or not
3677 * @return The full path to the file found.
3679 * This returns a string you should free with free() on success, NULL on
3680 * failure. This will search for the given theme element, and if it is a
3681 * full or relative path element or a simple searchable name. The returned
3682 * path is the full path to the file, if searched, and the file exists, or it
3683 * is simply the full path given in the element or a resolved path if
3684 * relative to home. The @p in_search_path boolean pointed to is set to
3685 * EINA_TRUE if the file was a searchable file andis in the search path,
3686 * and EINA_FALSE otherwise.
3688 EAPI char *elm_theme_list_item_path_get(const char *f, Eina_Bool *in_search_path);
3690 * Flush the current theme.
3692 * @param th Theme to flush
3694 * This flushes caches that let elementary know where to find theme elements
3695 * in the given theme. If @p th is NULL, then the default theme is flushed.
3696 * Call this function if source theme data has changed in such a way as to
3697 * make any caches Elementary kept invalid.
3699 EAPI void elm_theme_flush(Elm_Theme *th);
3701 * This flushes all themes (default and specific ones).
3703 * This will flush all themes in the current application context, by calling
3704 * elm_theme_flush() on each of them.
3706 EAPI void elm_theme_full_flush(void);
3708 * Set the theme for all elementary using applications on the current display
3710 * @param theme The name of the theme to use. Format same as the ELM_THEME
3711 * environment variable.
3713 EAPI void elm_theme_all_set(const char *theme);
3715 * Return a list of theme elements in the theme search path
3717 * @return A list of strings that are the theme element names.
3719 * This lists all available theme files in the standard Elementary search path
3720 * for theme elements, and returns them in alphabetical order as theme
3721 * element names in a list of strings. Free this with
3722 * elm_theme_name_available_list_free() when you are done with the list.
3724 EAPI Eina_List *elm_theme_name_available_list_new(void);
3726 * Free the list returned by elm_theme_name_available_list_new()
3728 * This frees the list of themes returned by
3729 * elm_theme_name_available_list_new(). Once freed the list should no longer
3730 * be used. a new list mys be created.
3732 EAPI void elm_theme_name_available_list_free(Eina_List *list);
3734 * Set a specific theme to be used for this object and its children
3736 * @param obj The object to set the theme on
3737 * @param th The theme to set
3739 * This sets a specific theme that will be used for the given object and any
3740 * child objects it has. If @p th is NULL then the theme to be used is
3741 * cleared and the object will inherit its theme from its parent (which
3742 * ultimately will use the default theme if no specific themes are set).
3744 * Use special themes with great care as this will annoy users and make
3745 * configuration difficult. Avoid any custom themes at all if it can be
3748 EAPI void elm_object_theme_set(Evas_Object *obj, Elm_Theme *th) EINA_ARG_NONNULL(1);
3750 * Get the specific theme to be used
3752 * @param obj The object to get the specific theme from
3753 * @return The specifc theme set.
3755 * This will return a specific theme set, or NULL if no specific theme is
3756 * set on that object. It will not return inherited themes from parents, only
3757 * the specific theme set for that specific object. See elm_object_theme_set()
3758 * for more information.
3760 EAPI Elm_Theme *elm_object_theme_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3763 * Get a data item from a theme
3765 * @param th The theme, or NULL for default theme
3766 * @param key The data key to search with
3767 * @return The data value, or NULL on failure
3769 * This function is used to return data items from edc in @p th, an overlay, or an extension.
3770 * It works the same way as edje_file_data_get() except that the return is stringshared.
3772 EAPI const char *elm_theme_data_get(Elm_Theme *th, const char *key) EINA_ARG_NONNULL(2);
3778 /** @defgroup Win Win
3780 * @image html img/widget/win/preview-00.png
3781 * @image latex img/widget/win/preview-00.eps
3783 * The window class of Elementary. Contains functions to manipulate
3784 * windows. The Evas engine used to render the window contents is specified
3785 * in the system or user elementary config files (whichever is found last),
3786 * and can be overridden with the ELM_ENGINE environment variable for
3787 * testing. Engines that may be supported (depending on Evas and Ecore-Evas
3788 * compilation setup and modules actually installed at runtime) are (listed
3789 * in order of best supported and most likely to be complete and work to
3792 * @li "x11", "x", "software-x11", "software_x11" (Software rendering in X11)
3793 * @li "gl", "opengl", "opengl-x11", "opengl_x11" (OpenGL or OpenGL-ES2
3795 * @li "shot:..." (Virtual screenshot renderer - renders to output file and
3797 * @li "fb", "software-fb", "software_fb" (Linux framebuffer direct software
3799 * @li "sdl", "software-sdl", "software_sdl" (SDL software rendering to SDL
3801 * @li "gl-sdl", "gl_sdl", "opengl-sdl", "opengl_sdl" (OpenGL or OpenGL-ES2
3802 * rendering using SDL as the buffer)
3803 * @li "gdi", "software-gdi", "software_gdi" (Windows WIN32 rendering via
3804 * GDI with software)
3805 * @li "dfb", "directfb" (Rendering to a DirectFB window)
3806 * @li "x11-8", "x8", "software-8-x11", "software_8_x11" (Rendering in
3807 * grayscale using dedicated 8bit software engine in X11)
3808 * @li "x11-16", "x16", "software-16-x11", "software_16_x11" (Rendering in
3809 * X11 using 16bit software engine)
3810 * @li "wince-gdi", "software-16-wince-gdi", "software_16_wince_gdi"
3811 * (Windows CE rendering via GDI with 16bit software renderer)
3812 * @li "sdl-16", "software-16-sdl", "software_16_sdl" (Rendering to SDL
3813 * buffer with 16bit software renderer)
3814 * @li "ews" (rendering to EWS - Ecore + Evas Single Process Windowing System)
3815 * @li "gl-cocoa", "gl_cocoa", "opengl-cocoa", "opengl_cocoa" (OpenGL rendering in Cocoa)
3816 * @li "psl1ght" (PS3 rendering using PSL1GHT)
3818 * All engines use a simple string to select the engine to render, EXCEPT
3819 * the "shot" engine. This actually encodes the output of the virtual
3820 * screenshot and how long to delay in the engine string. The engine string
3821 * is encoded in the following way:
3823 * "shot:[delay=XX][:][repeat=DDD][:][file=XX]"
3825 * Where options are separated by a ":" char if more than one option is
3826 * given, with delay, if provided being the first option and file the last
3827 * (order is important). The delay specifies how long to wait after the
3828 * window is shown before doing the virtual "in memory" rendering and then
3829 * save the output to the file specified by the file option (and then exit).
3830 * If no delay is given, the default is 0.5 seconds. If no file is given the
3831 * default output file is "out.png". Repeat option is for continous
3832 * capturing screenshots. Repeat range is from 1 to 999 and filename is
3833 * fixed to "out001.png" Some examples of using the shot engine:
3835 * ELM_ENGINE="shot:delay=1.0:repeat=5:file=elm_test.png" elementary_test
3836 * ELM_ENGINE="shot:delay=1.0:file=elm_test.png" elementary_test
3837 * ELM_ENGINE="shot:file=elm_test2.png" elementary_test
3838 * ELM_ENGINE="shot:delay=2.0" elementary_test
3839 * ELM_ENGINE="shot:" elementary_test
3841 * Signals that you can add callbacks for are:
3843 * @li "delete,request": the user requested to close the window. See
3844 * elm_win_autodel_set().
3845 * @li "focus,in": window got focus
3846 * @li "focus,out": window lost focus
3847 * @li "moved": window that holds the canvas was moved
3850 * @li @ref win_example_01
3855 * Defines the types of window that can be created
3857 * These are hints set on the window so that a running Window Manager knows
3858 * how the window should be handled and/or what kind of decorations it
3861 * Currently, only the X11 backed engines use them.
3863 typedef enum _Elm_Win_Type
3865 ELM_WIN_BASIC, /**< A normal window. Indicates a normal, top-level
3866 window. Almost every window will be created with this
3868 ELM_WIN_DIALOG_BASIC, /**< Used for simple dialog windows/ */
3869 ELM_WIN_DESKTOP, /**< For special desktop windows, like a background
3870 window holding desktop icons. */
3871 ELM_WIN_DOCK, /**< The window is used as a dock or panel. Usually would
3872 be kept on top of any other window by the Window
3874 ELM_WIN_TOOLBAR, /**< The window is used to hold a floating toolbar, or
3876 ELM_WIN_MENU, /**< Similar to #ELM_WIN_TOOLBAR. */
3877 ELM_WIN_UTILITY, /**< A persistent utility window, like a toolbox or
3879 ELM_WIN_SPLASH, /**< Splash window for a starting up application. */
3880 ELM_WIN_DROPDOWN_MENU, /**< The window is a dropdown menu, as when an
3881 entry in a menubar is clicked. Typically used
3882 with elm_win_override_set(). This hint exists
3883 for completion only, as the EFL way of
3884 implementing a menu would not normally use a
3885 separate window for its contents. */
3886 ELM_WIN_POPUP_MENU, /**< Like #ELM_WIN_DROPDOWN_MENU, but for the menu
3887 triggered by right-clicking an object. */
3888 ELM_WIN_TOOLTIP, /**< The window is a tooltip. A short piece of
3889 explanatory text that typically appear after the
3890 mouse cursor hovers over an object for a while.
3891 Typically used with elm_win_override_set() and also
3892 not very commonly used in the EFL. */
3893 ELM_WIN_NOTIFICATION, /**< A notification window, like a warning about
3894 battery life or a new E-Mail received. */
3895 ELM_WIN_COMBO, /**< A window holding the contents of a combo box. Not
3896 usually used in the EFL. */
3897 ELM_WIN_DND, /**< Used to indicate the window is a representation of an
3898 object being dragged across different windows, or even
3899 applications. Typically used with
3900 elm_win_override_set(). */
3901 ELM_WIN_INLINED_IMAGE, /**< The window is rendered onto an image
3902 buffer. No actual window is created for this
3903 type, instead the window and all of its
3904 contents will be rendered to an image buffer.
3905 This allows to have children window inside a
3906 parent one just like any other object would
3907 be, and do other things like applying @c
3908 Evas_Map effects to it. This is the only type
3909 of window that requires the @c parent
3910 parameter of elm_win_add() to be a valid @c
3915 * The differents layouts that can be requested for the virtual keyboard.
3917 * When the application window is being managed by Illume, it may request
3918 * any of the following layouts for the virtual keyboard.
3920 typedef enum _Elm_Win_Keyboard_Mode
3922 ELM_WIN_KEYBOARD_UNKNOWN, /**< Unknown keyboard state */
3923 ELM_WIN_KEYBOARD_OFF, /**< Request to deactivate the keyboard */
3924 ELM_WIN_KEYBOARD_ON, /**< Enable keyboard with default layout */
3925 ELM_WIN_KEYBOARD_ALPHA, /**< Alpha (a-z) keyboard layout */
3926 ELM_WIN_KEYBOARD_NUMERIC, /**< Numeric keyboard layout */
3927 ELM_WIN_KEYBOARD_PIN, /**< PIN keyboard layout */
3928 ELM_WIN_KEYBOARD_PHONE_NUMBER, /**< Phone keyboard layout */
3929 ELM_WIN_KEYBOARD_HEX, /**< Hexadecimal numeric keyboard layout */
3930 ELM_WIN_KEYBOARD_TERMINAL, /**< Full (QUERTY) keyboard layout */
3931 ELM_WIN_KEYBOARD_PASSWORD, /**< Password keyboard layout */
3932 ELM_WIN_KEYBOARD_IP, /**< IP keyboard layout */
3933 ELM_WIN_KEYBOARD_HOST, /**< Host keyboard layout */
3934 ELM_WIN_KEYBOARD_FILE, /**< File keyboard layout */
3935 ELM_WIN_KEYBOARD_URL, /**< URL keyboard layout */
3936 ELM_WIN_KEYBOARD_KEYPAD, /**< Keypad layout */
3937 ELM_WIN_KEYBOARD_J2ME /**< J2ME keyboard layout */
3938 } Elm_Win_Keyboard_Mode;
3941 * Available commands that can be sent to the Illume manager.
3943 * When running under an Illume session, a window may send commands to the
3944 * Illume manager to perform different actions.
3946 typedef enum _Elm_Illume_Command
3948 ELM_ILLUME_COMMAND_FOCUS_BACK, /**< Reverts focus to the previous
3950 ELM_ILLUME_COMMAND_FOCUS_FORWARD, /**< Sends focus to the next window\
3952 ELM_ILLUME_COMMAND_FOCUS_HOME, /**< Hides all windows to show the Home
3954 ELM_ILLUME_COMMAND_CLOSE /**< Closes the currently active window */
3955 } Elm_Illume_Command;
3958 * Adds a window object. If this is the first window created, pass NULL as
3961 * @param parent Parent object to add the window to, or NULL
3962 * @param name The name of the window
3963 * @param type The window type, one of #Elm_Win_Type.
3965 * The @p parent paramter can be @c NULL for every window @p type except
3966 * #ELM_WIN_INLINED_IMAGE, which needs a parent to retrieve the canvas on
3967 * which the image object will be created.
3969 * @return The created object, or NULL on failure
3971 EAPI Evas_Object *elm_win_add(Evas_Object *parent, const char *name, Elm_Win_Type type);
3973 * Adds a window object with standard setup
3975 * @param name The name of the window
3976 * @param title The title for the window
3978 * This creates a window like elm_win_add() but also puts in a standard
3979 * background with elm_bg_add(), as well as setting the window title to
3980 * @p title. The window type created is of type ELM_WIN_BASIC, with NULL
3981 * as the parent widget.
3983 * @return The created object, or NULL on failure
3985 * @see elm_win_add()
3987 EAPI Evas_Object *elm_win_util_standard_add(const char *name, const char *title);
3989 * Add @p subobj as a resize object of window @p obj.
3992 * Setting an object as a resize object of the window means that the
3993 * @p subobj child's size and position will be controlled by the window
3994 * directly. That is, the object will be resized to match the window size
3995 * and should never be moved or resized manually by the developer.
3997 * In addition, resize objects of the window control what the minimum size
3998 * of it will be, as well as whether it can or not be resized by the user.
4000 * For the end user to be able to resize a window by dragging the handles
4001 * or borders provided by the Window Manager, or using any other similar
4002 * mechanism, all of the resize objects in the window should have their
4003 * evas_object_size_hint_weight_set() set to EVAS_HINT_EXPAND.
4005 * @param obj The window object
4006 * @param subobj The resize object to add
4008 EAPI void elm_win_resize_object_add(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
4010 * Delete @p subobj as a resize object of window @p obj.
4012 * This function removes the object @p subobj from the resize objects of
4013 * the window @p obj. It will not delete the object itself, which will be
4014 * left unmanaged and should be deleted by the developer, manually handled
4015 * or set as child of some other container.
4017 * @param obj The window object
4018 * @param subobj The resize object to add
4020 EAPI void elm_win_resize_object_del(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
4022 * Set the title of the window
4024 * @param obj The window object
4025 * @param title The title to set
4027 EAPI void elm_win_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
4029 * Get the title of the window
4031 * The returned string is an internal one and should not be freed or
4032 * modified. It will also be rendered invalid if a new title is set or if
4033 * the window is destroyed.
4035 * @param obj The window object
4038 EAPI const char *elm_win_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4040 * Set the window's autodel state.
4042 * When closing the window in any way outside of the program control, like
4043 * pressing the X button in the titlebar or using a command from the
4044 * Window Manager, a "delete,request" signal is emitted to indicate that
4045 * this event occurred and the developer can take any action, which may
4046 * include, or not, destroying the window object.
4048 * When the @p autodel parameter is set, the window will be automatically
4049 * destroyed when this event occurs, after the signal is emitted.
4050 * If @p autodel is @c EINA_FALSE, then the window will not be destroyed
4051 * and is up to the program to do so when it's required.
4053 * @param obj The window object
4054 * @param autodel If true, the window will automatically delete itself when
4057 EAPI void elm_win_autodel_set(Evas_Object *obj, Eina_Bool autodel) EINA_ARG_NONNULL(1);
4059 * Get the window's autodel state.
4061 * @param obj The window object
4062 * @return If the window will automatically delete itself when closed
4064 * @see elm_win_autodel_set()
4066 EAPI Eina_Bool elm_win_autodel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4068 * Activate a window object.
4070 * This function sends a request to the Window Manager to activate the
4071 * window pointed by @p obj. If honored by the WM, the window will receive
4072 * the keyboard focus.
4074 * @note This is just a request that a Window Manager may ignore, so calling
4075 * this function does not ensure in any way that the window will be the
4076 * active one after it.
4078 * @param obj The window object
4080 EAPI void elm_win_activate(Evas_Object *obj) EINA_ARG_NONNULL(1);
4082 * Lower a window object.
4084 * Places the window pointed by @p obj at the bottom of the stack, so that
4085 * no other window is covered by it.
4087 * If elm_win_override_set() is not set, the Window Manager may ignore this
4090 * @param obj The window object
4092 EAPI void elm_win_lower(Evas_Object *obj) EINA_ARG_NONNULL(1);
4094 * Raise a window object.
4096 * Places the window pointed by @p obj at the top of the stack, so that it's
4097 * not covered by any other window.
4099 * If elm_win_override_set() is not set, the Window Manager may ignore this
4102 * @param obj The window object
4104 EAPI void elm_win_raise(Evas_Object *obj) EINA_ARG_NONNULL(1);
4106 * Set the borderless state of a window.
4108 * This function requests the Window Manager to not draw any decoration
4109 * around the window.
4111 * @param obj The window object
4112 * @param borderless If true, the window is borderless
4114 EAPI void elm_win_borderless_set(Evas_Object *obj, Eina_Bool borderless) EINA_ARG_NONNULL(1);
4116 * Get the borderless state of a window.
4118 * @param obj The window object
4119 * @return If true, the window is borderless
4121 EAPI Eina_Bool elm_win_borderless_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4123 * Set the shaped state of a window.
4125 * Shaped windows, when supported, will render the parts of the window that
4126 * has no content, transparent.
4128 * If @p shaped is EINA_FALSE, then it is strongly adviced to have some
4129 * background object or cover the entire window in any other way, or the
4130 * parts of the canvas that have no data will show framebuffer artifacts.
4132 * @param obj The window object
4133 * @param shaped If true, the window is shaped
4135 * @see elm_win_alpha_set()
4137 EAPI void elm_win_shaped_set(Evas_Object *obj, Eina_Bool shaped) EINA_ARG_NONNULL(1);
4139 * Get the shaped state of a window.
4141 * @param obj The window object
4142 * @return If true, the window is shaped
4144 * @see elm_win_shaped_set()
4146 EAPI Eina_Bool elm_win_shaped_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4148 * Set the alpha channel state of a window.
4150 * If @p alpha is EINA_TRUE, the alpha channel of the canvas will be enabled
4151 * possibly making parts of the window completely or partially transparent.
4152 * This is also subject to the underlying system supporting it, like for
4153 * example, running under a compositing manager. If no compositing is
4154 * available, enabling this option will instead fallback to using shaped
4155 * windows, with elm_win_shaped_set().
4157 * @param obj The window object
4158 * @param alpha If true, the window has an alpha channel
4160 * @see elm_win_alpha_set()
4162 EAPI void elm_win_alpha_set(Evas_Object *obj, Eina_Bool alpha) EINA_ARG_NONNULL(1);
4164 * Get the transparency state of a window.
4166 * @param obj The window object
4167 * @return If true, the window is transparent
4169 * @see elm_win_transparent_set()
4171 EAPI Eina_Bool elm_win_transparent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4173 * Set the transparency state of a window.
4175 * Use elm_win_alpha_set() instead.
4177 * @param obj The window object
4178 * @param transparent If true, the window is transparent
4180 * @see elm_win_alpha_set()
4182 EAPI void elm_win_transparent_set(Evas_Object *obj, Eina_Bool transparent) EINA_ARG_NONNULL(1);
4184 * Get the alpha channel state of a window.
4186 * @param obj The window object
4187 * @return If true, the window has an alpha channel
4189 EAPI Eina_Bool elm_win_alpha_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4191 * Set the override state of a window.
4193 * A window with @p override set to EINA_TRUE will not be managed by the
4194 * Window Manager. This means that no decorations of any kind will be shown
4195 * for it, moving and resizing must be handled by the application, as well
4196 * as the window visibility.
4198 * This should not be used for normal windows, and even for not so normal
4199 * ones, it should only be used when there's a good reason and with a lot
4200 * of care. Mishandling override windows may result situations that
4201 * disrupt the normal workflow of the end user.
4203 * @param obj The window object
4204 * @param override If true, the window is overridden
4206 EAPI void elm_win_override_set(Evas_Object *obj, Eina_Bool override) EINA_ARG_NONNULL(1);
4208 * Get the override state of a window.
4210 * @param obj The window object
4211 * @return If true, the window is overridden
4213 * @see elm_win_override_set()
4215 EAPI Eina_Bool elm_win_override_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4217 * Set the fullscreen state of a window.
4219 * @param obj The window object
4220 * @param fullscreen If true, the window is fullscreen
4222 EAPI void elm_win_fullscreen_set(Evas_Object *obj, Eina_Bool fullscreen) EINA_ARG_NONNULL(1);
4224 * Get the fullscreen state of a window.
4226 * @param obj The window object
4227 * @return If true, the window is fullscreen
4229 EAPI Eina_Bool elm_win_fullscreen_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4231 * Set the maximized state of a window.
4233 * @param obj The window object
4234 * @param maximized If true, the window is maximized
4236 EAPI void elm_win_maximized_set(Evas_Object *obj, Eina_Bool maximized) EINA_ARG_NONNULL(1);
4238 * Get the maximized state of a window.
4240 * @param obj The window object
4241 * @return If true, the window is maximized
4243 EAPI Eina_Bool elm_win_maximized_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4245 * Set the iconified state of a window.
4247 * @param obj The window object
4248 * @param iconified If true, the window is iconified
4250 EAPI void elm_win_iconified_set(Evas_Object *obj, Eina_Bool iconified) EINA_ARG_NONNULL(1);
4252 * Get the iconified state of a window.
4254 * @param obj The window object
4255 * @return If true, the window is iconified
4257 EAPI Eina_Bool elm_win_iconified_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4259 * Set the layer of the window.
4261 * What this means exactly will depend on the underlying engine used.
4263 * In the case of X11 backed engines, the value in @p layer has the
4264 * following meanings:
4265 * @li < 3: The window will be placed below all others.
4266 * @li > 5: The window will be placed above all others.
4267 * @li other: The window will be placed in the default layer.
4269 * @param obj The window object
4270 * @param layer The layer of the window
4272 EAPI void elm_win_layer_set(Evas_Object *obj, int layer) EINA_ARG_NONNULL(1);
4274 * Get the layer of the window.
4276 * @param obj The window object
4277 * @return The layer of the window
4279 * @see elm_win_layer_set()
4281 EAPI int elm_win_layer_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4283 * Set the rotation of the window.
4285 * Most engines only work with multiples of 90.
4287 * This function is used to set the orientation of the window @p obj to
4288 * match that of the screen. The window itself will be resized to adjust
4289 * to the new geometry of its contents. If you want to keep the window size,
4290 * see elm_win_rotation_with_resize_set().
4292 * @param obj The window object
4293 * @param rotation The rotation of the window, in degrees (0-360),
4294 * counter-clockwise.
4296 EAPI void elm_win_rotation_set(Evas_Object *obj, int rotation) EINA_ARG_NONNULL(1);
4298 * Rotates the window and resizes it.
4300 * Like elm_win_rotation_set(), but it also resizes the window's contents so
4301 * that they fit inside the current window geometry.
4303 * @param obj The window object
4304 * @param layer The rotation of the window in degrees (0-360),
4305 * counter-clockwise.
4307 EAPI void elm_win_rotation_with_resize_set(Evas_Object *obj, int rotation) EINA_ARG_NONNULL(1);
4309 * Get the rotation of the window.
4311 * @param obj The window object
4312 * @return The rotation of the window in degrees (0-360)
4314 * @see elm_win_rotation_set()
4315 * @see elm_win_rotation_with_resize_set()
4317 EAPI int elm_win_rotation_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4319 * Set the sticky state of the window.
4321 * Hints the Window Manager that the window in @p obj should be left fixed
4322 * at its position even when the virtual desktop it's on moves or changes.
4324 * @param obj The window object
4325 * @param sticky If true, the window's sticky state is enabled
4327 EAPI void elm_win_sticky_set(Evas_Object *obj, Eina_Bool sticky) EINA_ARG_NONNULL(1);
4329 * Get the sticky state of the window.
4331 * @param obj The window object
4332 * @return If true, the window's sticky state is enabled
4334 * @see elm_win_sticky_set()
4336 EAPI Eina_Bool elm_win_sticky_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4338 * Set if this window is an illume conformant window
4340 * @param obj The window object
4341 * @param conformant The conformant flag (1 = conformant, 0 = non-conformant)
4343 EAPI void elm_win_conformant_set(Evas_Object *obj, Eina_Bool conformant) EINA_ARG_NONNULL(1);
4345 * Get if this window is an illume conformant window
4347 * @param obj The window object
4348 * @return A boolean if this window is illume conformant or not
4350 EAPI Eina_Bool elm_win_conformant_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4352 * Set a window to be an illume quickpanel window
4354 * By default window objects are not quickpanel windows.
4356 * @param obj The window object
4357 * @param quickpanel The quickpanel flag (1 = quickpanel, 0 = normal window)
4359 EAPI void elm_win_quickpanel_set(Evas_Object *obj, Eina_Bool quickpanel) EINA_ARG_NONNULL(1);
4361 * Get if this window is a quickpanel or not
4363 * @param obj The window object
4364 * @return A boolean if this window is a quickpanel or not
4366 EAPI Eina_Bool elm_win_quickpanel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4368 * Set the major priority of a quickpanel window
4370 * @param obj The window object
4371 * @param priority The major priority for this quickpanel
4373 EAPI void elm_win_quickpanel_priority_major_set(Evas_Object *obj, int priority) EINA_ARG_NONNULL(1);
4375 * Get the major priority of a quickpanel window
4377 * @param obj The window object
4378 * @return The major priority of this quickpanel
4380 EAPI int elm_win_quickpanel_priority_major_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4382 * Set the minor priority of a quickpanel window
4384 * @param obj The window object
4385 * @param priority The minor priority for this quickpanel
4387 EAPI void elm_win_quickpanel_priority_minor_set(Evas_Object *obj, int priority) EINA_ARG_NONNULL(1);
4389 * Get the minor priority of a quickpanel window
4391 * @param obj The window object
4392 * @return The minor priority of this quickpanel
4394 EAPI int elm_win_quickpanel_priority_minor_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4396 * Set which zone this quickpanel should appear in
4398 * @param obj The window object
4399 * @param zone The requested zone for this quickpanel
4401 EAPI void elm_win_quickpanel_zone_set(Evas_Object *obj, int zone) EINA_ARG_NONNULL(1);
4403 * Get which zone this quickpanel should appear in
4405 * @param obj The window object
4406 * @return The requested zone for this quickpanel
4408 EAPI int elm_win_quickpanel_zone_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4410 * Set the window to be skipped by keyboard focus
4412 * This sets the window to be skipped by normal keyboard input. This means
4413 * a window manager will be asked to not focus this window as well as omit
4414 * it from things like the taskbar, pager, "alt-tab" list etc. etc.
4416 * Call this and enable it on a window BEFORE you show it for the first time,
4417 * otherwise it may have no effect.
4419 * Use this for windows that have only output information or might only be
4420 * interacted with by the mouse or fingers, and never for typing input.
4421 * Be careful that this may have side-effects like making the window
4422 * non-accessible in some cases unless the window is specially handled. Use
4425 * @param obj The window object
4426 * @param skip The skip flag state (EINA_TRUE if it is to be skipped)
4428 EAPI void elm_win_prop_focus_skip_set(Evas_Object *obj, Eina_Bool skip) EINA_ARG_NONNULL(1);
4430 * Send a command to the windowing environment
4432 * This is intended to work in touchscreen or small screen device
4433 * environments where there is a more simplistic window management policy in
4434 * place. This uses the window object indicated to select which part of the
4435 * environment to control (the part that this window lives in), and provides
4436 * a command and an optional parameter structure (use NULL for this if not
4439 * @param obj The window object that lives in the environment to control
4440 * @param command The command to send
4441 * @param params Optional parameters for the command
4443 EAPI void elm_win_illume_command_send(Evas_Object *obj, Elm_Illume_Command command, void *params) EINA_ARG_NONNULL(1);
4445 * Get the inlined image object handle
4447 * When you create a window with elm_win_add() of type ELM_WIN_INLINED_IMAGE,
4448 * then the window is in fact an evas image object inlined in the parent
4449 * canvas. You can get this object (be careful to not manipulate it as it
4450 * is under control of elementary), and use it to do things like get pixel
4451 * data, save the image to a file, etc.
4453 * @param obj The window object to get the inlined image from
4454 * @return The inlined image object, or NULL if none exists
4456 EAPI Evas_Object *elm_win_inlined_image_object_get(Evas_Object *obj);
4458 * Determine whether a window has focus
4459 * @param obj The window to query
4460 * @return EINA_TRUE if the window exists and has focus, else EINA_FALSE
4462 EAPI Eina_Bool elm_win_focus_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4464 * Get screen geometry details for the screen that a window is on
4465 * @param obj The window to query
4466 * @param x where to return the horizontal offset value. May be NULL.
4467 * @param y where to return the vertical offset value. May be NULL.
4468 * @param w where to return the width value. May be NULL.
4469 * @param h where to return the height value. May be NULL.
4471 EAPI void elm_win_screen_size_get(const Evas_Object *obj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
4473 * Set the enabled status for the focus highlight in a window
4475 * This function will enable or disable the focus highlight only for the
4476 * given window, regardless of the global setting for it
4478 * @param obj The window where to enable the highlight
4479 * @param enabled The enabled value for the highlight
4481 EAPI void elm_win_focus_highlight_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
4483 * Get the enabled value of the focus highlight for this window
4485 * @param obj The window in which to check if the focus highlight is enabled
4487 * @return EINA_TRUE if enabled, EINA_FALSE otherwise
4489 EAPI Eina_Bool elm_win_focus_highlight_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4491 * Set the style for the focus highlight on this window
4493 * Sets the style to use for theming the highlight of focused objects on
4494 * the given window. If @p style is NULL, the default will be used.
4496 * @param obj The window where to set the style
4497 * @param style The style to set
4499 EAPI void elm_win_focus_highlight_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
4501 * Get the style set for the focus highlight object
4503 * Gets the style set for this windows highilght object, or NULL if none
4506 * @param obj The window to retrieve the highlights style from
4508 * @return The style set or NULL if none was. Default is used in that case.
4510 EAPI const char *elm_win_focus_highlight_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4512 * ecore_x_icccm_hints_set -> accepts_focus (add to ecore_evas)
4513 * ecore_x_icccm_hints_set -> window_group (add to ecore_evas)
4514 * ecore_x_icccm_size_pos_hints_set -> request_pos (add to ecore_evas)
4515 * ecore_x_icccm_client_leader_set -> l (add to ecore_evas)
4516 * ecore_x_icccm_window_role_set -> role (add to ecore_evas)
4517 * ecore_x_icccm_transient_for_set -> forwin (add to ecore_evas)
4518 * ecore_x_netwm_window_type_set -> type (add to ecore_evas)
4520 * (add to ecore_x) set netwm argb icon! (add to ecore_evas)
4521 * (blank mouse, private mouse obj, defaultmouse)
4525 * Sets the keyboard mode of the window.
4527 * @param obj The window object
4528 * @param mode The mode to set, one of #Elm_Win_Keyboard_Mode
4530 EAPI void elm_win_keyboard_mode_set(Evas_Object *obj, Elm_Win_Keyboard_Mode mode) EINA_ARG_NONNULL(1);
4532 * Gets the keyboard mode of the window.
4534 * @param obj The window object
4535 * @return The mode, one of #Elm_Win_Keyboard_Mode
4537 EAPI Elm_Win_Keyboard_Mode elm_win_keyboard_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4539 * Sets whether the window is a keyboard.
4541 * @param obj The window object
4542 * @param is_keyboard If true, the window is a virtual keyboard
4544 EAPI void elm_win_keyboard_win_set(Evas_Object *obj, Eina_Bool is_keyboard) EINA_ARG_NONNULL(1);
4546 * Gets whether the window is a keyboard.
4548 * @param obj The window object
4549 * @return If the window is a virtual keyboard
4551 EAPI Eina_Bool elm_win_keyboard_win_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4554 * Get the screen position of a window.
4556 * @param obj The window object
4557 * @param x The int to store the x coordinate to
4558 * @param y The int to store the y coordinate to
4560 EAPI void elm_win_screen_position_get(const Evas_Object *obj, int *x, int *y) EINA_ARG_NONNULL(1);
4566 * @defgroup Inwin Inwin
4568 * @image html img/widget/inwin/preview-00.png
4569 * @image latex img/widget/inwin/preview-00.eps
4570 * @image html img/widget/inwin/preview-01.png
4571 * @image latex img/widget/inwin/preview-01.eps
4572 * @image html img/widget/inwin/preview-02.png
4573 * @image latex img/widget/inwin/preview-02.eps
4575 * An inwin is a window inside a window that is useful for a quick popup.
4576 * It does not hover.
4578 * It works by creating an object that will occupy the entire window, so it
4579 * must be created using an @ref Win "elm_win" as parent only. The inwin
4580 * object can be hidden or restacked below every other object if it's
4581 * needed to show what's behind it without destroying it. If this is done,
4582 * the elm_win_inwin_activate() function can be used to bring it back to
4583 * full visibility again.
4585 * There are three styles available in the default theme. These are:
4586 * @li default: The inwin is sized to take over most of the window it's
4588 * @li minimal: The size of the inwin will be the minimum necessary to show
4590 * @li minimal_vertical: Horizontally, the inwin takes as much space as
4591 * possible, but it's sized vertically the most it needs to fit its\
4594 * Some examples of Inwin can be found in the following:
4595 * @li @ref inwin_example_01
4600 * Adds an inwin to the current window
4602 * The @p obj used as parent @b MUST be an @ref Win "Elementary Window".
4603 * Never call this function with anything other than the top-most window
4604 * as its parameter, unless you are fond of undefined behavior.
4606 * After creating the object, the widget will set itself as resize object
4607 * for the window with elm_win_resize_object_add(), so when shown it will
4608 * appear to cover almost the entire window (how much of it depends on its
4609 * content and the style used). It must not be added into other container
4610 * objects and it needs not be moved or resized manually.
4612 * @param parent The parent object
4613 * @return The new object or NULL if it cannot be created
4615 EAPI Evas_Object *elm_win_inwin_add(Evas_Object *obj) EINA_ARG_NONNULL(1);
4617 * Activates an inwin object, ensuring its visibility
4619 * This function will make sure that the inwin @p obj is completely visible
4620 * by calling evas_object_show() and evas_object_raise() on it, to bring it
4621 * to the front. It also sets the keyboard focus to it, which will be passed
4624 * The object's theme will also receive the signal "elm,action,show" with
4627 * @param obj The inwin to activate
4629 EAPI void elm_win_inwin_activate(Evas_Object *obj) EINA_ARG_NONNULL(1);
4631 * Set the content of an inwin object.
4633 * Once the content object is set, a previously set one will be deleted.
4634 * If you want to keep that old content object, use the
4635 * elm_win_inwin_content_unset() function.
4637 * @param obj The inwin object
4638 * @param content The object to set as content
4640 EAPI void elm_win_inwin_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
4642 * Get the content of an inwin object.
4644 * Return the content object which is set for this widget.
4646 * The returned object is valid as long as the inwin is still alive and no
4647 * other content is set on it. Deleting the object will notify the inwin
4648 * about it and this one will be left empty.
4650 * If you need to remove an inwin's content to be reused somewhere else,
4651 * see elm_win_inwin_content_unset().
4653 * @param obj The inwin object
4654 * @return The content that is being used
4656 EAPI Evas_Object *elm_win_inwin_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4658 * Unset the content of an inwin object.
4660 * Unparent and return the content object which was set for this widget.
4662 * @param obj The inwin object
4663 * @return The content that was being used
4665 EAPI Evas_Object *elm_win_inwin_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4669 /* X specific calls - won't work on non-x engines (return 0) */
4672 * Get the Ecore_X_Window of an Evas_Object
4674 * @param obj The object
4676 * @return The Ecore_X_Window of @p obj
4680 EAPI Ecore_X_Window elm_win_xwindow_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4682 /* smart callbacks called:
4683 * "delete,request" - the user requested to delete the window
4684 * "focus,in" - window got focus
4685 * "focus,out" - window lost focus
4686 * "moved" - window that holds the canvas was moved
4692 * @image html img/widget/bg/preview-00.png
4693 * @image latex img/widget/bg/preview-00.eps
4695 * @brief Background object, used for setting a solid color, image or Edje
4696 * group as background to a window or any container object.
4698 * The bg object is used for setting a solid background to a window or
4699 * packing into any container object. It works just like an image, but has
4700 * some properties useful to a background, like setting it to tiled,
4701 * centered, scaled or stretched.
4703 * Default contents parts of the bg widget that you can use for are:
4704 * @li "overlay" - overlay of the bg
4706 * Here is some sample code using it:
4707 * @li @ref bg_01_example_page
4708 * @li @ref bg_02_example_page
4709 * @li @ref bg_03_example_page
4713 typedef enum _Elm_Bg_Option
4715 ELM_BG_OPTION_CENTER, /**< center the background */
4716 ELM_BG_OPTION_SCALE, /**< scale the background retaining aspect ratio */
4717 ELM_BG_OPTION_STRETCH, /**< stretch the background to fill */
4718 ELM_BG_OPTION_TILE /**< tile background at its original size */
4722 * Add a new background to the parent
4724 * @param parent The parent object
4725 * @return The new object or NULL if it cannot be created
4729 EAPI Evas_Object *elm_bg_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4732 * Set the file (image or edje) used for the background
4734 * @param obj The bg object
4735 * @param file The file path
4736 * @param group Optional key (group in Edje) within the file
4738 * This sets the image file used in the background object. The image (or edje)
4739 * will be stretched (retaining aspect if its an image file) to completely fill
4740 * the bg object. This may mean some parts are not visible.
4742 * @note Once the image of @p obj is set, a previously set one will be deleted,
4743 * even if @p file is NULL.
4747 EAPI void elm_bg_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1);
4750 * Get the file (image or edje) used for the background
4752 * @param obj The bg object
4753 * @param file The file path
4754 * @param group Optional key (group in Edje) within the file
4758 EAPI void elm_bg_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
4761 * Set the option used for the background image
4763 * @param obj The bg object
4764 * @param option The desired background option (TILE, SCALE)
4766 * This sets the option used for manipulating the display of the background
4767 * image. The image can be tiled or scaled.
4771 EAPI void elm_bg_option_set(Evas_Object *obj, Elm_Bg_Option option) EINA_ARG_NONNULL(1);
4774 * Get the option used for the background image
4776 * @param obj The bg object
4777 * @return The desired background option (CENTER, SCALE, STRETCH or TILE)
4781 EAPI Elm_Bg_Option elm_bg_option_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4783 * Set the option used for the background color
4785 * @param obj The bg object
4790 * This sets the color used for the background rectangle. Its range goes
4795 EAPI void elm_bg_color_set(Evas_Object *obj, int r, int g, int b) EINA_ARG_NONNULL(1);
4797 * Get the option used for the background color
4799 * @param obj The bg object
4806 EAPI void elm_bg_color_get(const Evas_Object *obj, int *r, int *g, int *b) EINA_ARG_NONNULL(1);
4809 * Set the overlay object used for the background object.
4811 * @param obj The bg object
4812 * @param overlay The overlay object
4814 * This provides a way for elm_bg to have an 'overlay' that will be on top
4815 * of the bg. Once the over object is set, a previously set one will be
4816 * deleted, even if you set the new one to NULL. If you want to keep that
4817 * old content object, use the elm_bg_overlay_unset() function.
4819 * @deprecated use elm_object_part_content_set() instead
4824 EINA_DEPRECATED EAPI void elm_bg_overlay_set(Evas_Object *obj, Evas_Object *overlay) EINA_ARG_NONNULL(1);
4827 * Get the overlay object used for the background object.
4829 * @param obj The bg object
4830 * @return The content that is being used
4832 * Return the content object which is set for this widget
4834 * @deprecated use elm_object_part_content_get() instead
4838 EINA_DEPRECATED EAPI Evas_Object *elm_bg_overlay_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4841 * Get the overlay object used for the background object.
4843 * @param obj The bg object
4844 * @return The content that was being used
4846 * Unparent and return the overlay object which was set for this widget
4848 * @deprecated use elm_object_part_content_unset() instead
4852 EINA_DEPRECATED EAPI Evas_Object *elm_bg_overlay_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4855 * Set the size of the pixmap representation of the image.
4857 * This option just makes sense if an image is going to be set in the bg.
4859 * @param obj The bg object
4860 * @param w The new width of the image pixmap representation.
4861 * @param h The new height of the image pixmap representation.
4863 * This function sets a new size for pixmap representation of the given bg
4864 * image. It allows the image to be loaded already in the specified size,
4865 * reducing the memory usage and load time when loading a big image with load
4866 * size set to a smaller size.
4868 * NOTE: this is just a hint, the real size of the pixmap may differ
4869 * depending on the type of image being loaded, being bigger than requested.
4873 EAPI void elm_bg_load_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
4874 /* smart callbacks called:
4878 * @defgroup Icon Icon
4880 * @image html img/widget/icon/preview-00.png
4881 * @image latex img/widget/icon/preview-00.eps
4883 * An object that provides standard icon images (delete, edit, arrows, etc.)
4884 * or a custom file (PNG, JPG, EDJE, etc.) used for an icon.
4886 * The icon image requested can be in the elementary theme, or in the
4887 * freedesktop.org paths. It's possible to set the order of preference from
4888 * where the image will be used.
4890 * This API is very similar to @ref Image, but with ready to use images.
4892 * Default images provided by the theme are described below.
4894 * The first list contains icons that were first intended to be used in
4895 * toolbars, but can be used in many other places too:
4911 * Now some icons that were designed to be used in menus (but again, you can
4912 * use them anywhere else):
4917 * @li menu/arrow_down
4918 * @li menu/arrow_left
4919 * @li menu/arrow_right
4928 * And here we have some media player specific icons:
4929 * @li media_player/forward
4930 * @li media_player/info
4931 * @li media_player/next
4932 * @li media_player/pause
4933 * @li media_player/play
4934 * @li media_player/prev
4935 * @li media_player/rewind
4936 * @li media_player/stop
4938 * Signals that you can add callbacks for are:
4940 * "clicked" - This is called when a user has clicked the icon
4942 * An example of usage for this API follows:
4943 * @li @ref tutorial_icon
4951 typedef enum _Elm_Icon_Type
4958 * @enum _Elm_Icon_Lookup_Order
4959 * @typedef Elm_Icon_Lookup_Order
4961 * Lookup order used by elm_icon_standard_set(). Should look for icons in the
4962 * theme, FDO paths, or both?
4966 typedef enum _Elm_Icon_Lookup_Order
4968 ELM_ICON_LOOKUP_FDO_THEME, /**< icon look up order: freedesktop, theme */
4969 ELM_ICON_LOOKUP_THEME_FDO, /**< icon look up order: theme, freedesktop */
4970 ELM_ICON_LOOKUP_FDO, /**< icon look up order: freedesktop */
4971 ELM_ICON_LOOKUP_THEME /**< icon look up order: theme */
4972 } Elm_Icon_Lookup_Order;
4975 * Add a new icon object to the parent.
4977 * @param parent The parent object
4978 * @return The new object or NULL if it cannot be created
4980 * @see elm_icon_file_set()
4984 EAPI Evas_Object *elm_icon_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4986 * Set the file that will be used as icon.
4988 * @param obj The icon object
4989 * @param file The path to file that will be used as icon image
4990 * @param group The group that the icon belongs to an edje file
4992 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
4994 * @note The icon image set by this function can be changed by
4995 * elm_icon_standard_set().
4997 * @see elm_icon_file_get()
5001 EAPI Eina_Bool elm_icon_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
5003 * Set a location in memory to be used as an icon
5005 * @param obj The icon object
5006 * @param img The binary data that will be used as an image
5007 * @param size The size of binary data @p img
5008 * @param format Optional format of @p img to pass to the image loader
5009 * @param key Optional key of @p img to pass to the image loader (eg. if @p img is an edje file)
5011 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
5013 * @note The icon image set by this function can be changed by
5014 * elm_icon_standard_set().
5018 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);
5020 * Get the file that will be used as icon.
5022 * @param obj The icon object
5023 * @param file The path to file that will be used as the icon image
5024 * @param group The group that the icon belongs to, in edje file
5026 * @see elm_icon_file_set()
5030 EAPI void elm_icon_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
5031 EAPI void elm_icon_thumb_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
5033 * Set the icon by icon standards names.
5035 * @param obj The icon object
5036 * @param name The icon name
5038 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
5040 * For example, freedesktop.org defines standard icon names such as "home",
5041 * "network", etc. There can be different icon sets to match those icon
5042 * keys. The @p name given as parameter is one of these "keys", and will be
5043 * used to look in the freedesktop.org paths and elementary theme. One can
5044 * change the lookup order with elm_icon_order_lookup_set().
5046 * If name is not found in any of the expected locations and it is the
5047 * absolute path of an image file, this image will be used.
5049 * @note The icon image set by this function can be changed by
5050 * elm_icon_file_set().
5052 * @see elm_icon_standard_get()
5053 * @see elm_icon_file_set()
5057 EAPI Eina_Bool elm_icon_standard_set(Evas_Object *obj, const char *name) EINA_ARG_NONNULL(1);
5059 * Get the icon name set by icon standard names.
5061 * @param obj The icon object
5062 * @return The icon name
5064 * If the icon image was set using elm_icon_file_set() instead of
5065 * elm_icon_standard_set(), then this function will return @c NULL.
5067 * @see elm_icon_standard_set()
5071 EAPI const char *elm_icon_standard_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5073 * Set the smooth scaling for an icon object.
5075 * @param obj The icon object
5076 * @param smooth @c EINA_TRUE if smooth scaling should be used, @c EINA_FALSE
5077 * otherwise. Default is @c EINA_TRUE.
5079 * Set the scaling algorithm to be used when scaling the icon image. Smooth
5080 * scaling provides a better resulting image, but is slower.
5082 * The smooth scaling should be disabled when making animations that change
5083 * the icon size, since they will be faster. Animations that don't require
5084 * resizing of the icon can keep the smooth scaling enabled (even if the icon
5085 * is already scaled, since the scaled icon image will be cached).
5087 * @see elm_icon_smooth_get()
5091 EAPI void elm_icon_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
5093 * Get whether smooth scaling is enabled for an icon object.
5095 * @param obj The icon object
5096 * @return @c EINA_TRUE if smooth scaling is enabled, @c EINA_FALSE otherwise.
5098 * @see elm_icon_smooth_set()
5102 EAPI Eina_Bool elm_icon_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5104 * Disable scaling of this object.
5106 * @param obj The icon object.
5107 * @param no_scale @c EINA_TRUE if the object is not scalable, @c EINA_FALSE
5108 * otherwise. Default is @c EINA_FALSE.
5110 * This function disables scaling of the icon object through the function
5111 * elm_object_scale_set(). However, this does not affect the object
5112 * size/resize in any way. For that effect, take a look at
5113 * elm_icon_scale_set().
5115 * @see elm_icon_no_scale_get()
5116 * @see elm_icon_scale_set()
5117 * @see elm_object_scale_set()
5121 EAPI void elm_icon_no_scale_set(Evas_Object *obj, Eina_Bool no_scale) EINA_ARG_NONNULL(1);
5123 * Get whether scaling is disabled on the object.
5125 * @param obj The icon object
5126 * @return @c EINA_TRUE if scaling is disabled, @c EINA_FALSE otherwise
5128 * @see elm_icon_no_scale_set()
5132 EAPI Eina_Bool elm_icon_no_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5134 * Set if the object is (up/down) resizable.
5136 * @param obj The icon object
5137 * @param scale_up A bool to set if the object is resizable up. Default is
5139 * @param scale_down A bool to set if the object is resizable down. Default
5142 * This function limits the icon object resize ability. If @p scale_up is set to
5143 * @c EINA_FALSE, the object can't have its height or width resized to a value
5144 * higher than the original icon size. Same is valid for @p scale_down.
5146 * @see elm_icon_scale_get()
5150 EAPI void elm_icon_scale_set(Evas_Object *obj, Eina_Bool scale_up, Eina_Bool scale_down) EINA_ARG_NONNULL(1);
5152 * Get if the object is (up/down) resizable.
5154 * @param obj The icon object
5155 * @param scale_up A bool to set if the object is resizable up
5156 * @param scale_down A bool to set if the object is resizable down
5158 * @see elm_icon_scale_set()
5162 EAPI void elm_icon_scale_get(const Evas_Object *obj, Eina_Bool *scale_up, Eina_Bool *scale_down) EINA_ARG_NONNULL(1);
5164 * Get the object's image size
5166 * @param obj The icon object
5167 * @param w A pointer to store the width in
5168 * @param h A pointer to store the height in
5172 EAPI void elm_icon_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
5174 * Set if the icon fill the entire object area.
5176 * @param obj The icon object
5177 * @param fill_outside @c EINA_TRUE if the object is filled outside,
5178 * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
5180 * When the icon object is resized to a different aspect ratio from the
5181 * original icon image, the icon image will still keep its aspect. This flag
5182 * tells how the image should fill the object's area. They are: keep the
5183 * entire icon inside the limits of height and width of the object (@p
5184 * fill_outside is @c EINA_FALSE) or let the extra width or height go outside
5185 * of the object, and the icon will fill the entire object (@p fill_outside
5188 * @note Unlike @ref Image, there's no option in icon to set the aspect ratio
5189 * retain property to false. Thus, the icon image will always keep its
5190 * original aspect ratio.
5192 * @see elm_icon_fill_outside_get()
5193 * @see elm_image_fill_outside_set()
5197 EAPI void elm_icon_fill_outside_set(Evas_Object *obj, Eina_Bool fill_outside) EINA_ARG_NONNULL(1);
5199 * Get if the object is filled outside.
5201 * @param obj The icon object
5202 * @return @c EINA_TRUE if the object is filled outside, @c EINA_FALSE otherwise.
5204 * @see elm_icon_fill_outside_set()
5208 EAPI Eina_Bool elm_icon_fill_outside_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5210 * Set the prescale size for the icon.
5212 * @param obj The icon object
5213 * @param size The prescale size. This value is used for both width and
5216 * This function sets a new size for pixmap representation of the given
5217 * icon. It allows the icon to be loaded already in the specified size,
5218 * reducing the memory usage and load time when loading a big icon with load
5219 * size set to a smaller size.
5221 * It's equivalent to the elm_bg_load_size_set() function for bg.
5223 * @note this is just a hint, the real size of the pixmap may differ
5224 * depending on the type of icon being loaded, being bigger than requested.
5226 * @see elm_icon_prescale_get()
5227 * @see elm_bg_load_size_set()
5231 EAPI void elm_icon_prescale_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
5233 * Get the prescale size for the icon.
5235 * @param obj The icon object
5236 * @return The prescale size
5238 * @see elm_icon_prescale_set()
5242 EAPI int elm_icon_prescale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5244 * Gets the image object of the icon. DO NOT MODIFY THIS.
5246 * @param obj The icon object
5247 * @return The internal icon object
5251 EAPI Evas_Object *elm_icon_object_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
5253 * Sets the icon lookup order used by elm_icon_standard_set().
5255 * @param obj The icon object
5256 * @param order The icon lookup order (can be one of
5257 * ELM_ICON_LOOKUP_FDO_THEME, ELM_ICON_LOOKUP_THEME_FDO, ELM_ICON_LOOKUP_FDO
5258 * or ELM_ICON_LOOKUP_THEME)
5260 * @see elm_icon_order_lookup_get()
5261 * @see Elm_Icon_Lookup_Order
5265 EAPI void elm_icon_order_lookup_set(Evas_Object *obj, Elm_Icon_Lookup_Order order) EINA_ARG_NONNULL(1);
5267 * Gets the icon lookup order.
5269 * @param obj The icon object
5270 * @return The icon lookup order
5272 * @see elm_icon_order_lookup_set()
5273 * @see Elm_Icon_Lookup_Order
5277 EAPI Elm_Icon_Lookup_Order elm_icon_order_lookup_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5279 * Enable or disable preloading of the icon
5281 * @param obj The icon object
5282 * @param disable If EINA_TRUE, preloading will be disabled
5285 EAPI void elm_icon_preload_set(Evas_Object *obj, Eina_Bool disable) EINA_ARG_NONNULL(1);
5287 * Get if the icon supports animation or not.
5289 * @param obj The icon object
5290 * @return @c EINA_TRUE if the icon supports animation,
5291 * @c EINA_FALSE otherwise.
5293 * Return if this elm icon's image can be animated. Currently Evas only
5294 * supports gif animation. If the return value is EINA_FALSE, other
5295 * elm_icon_animated_XXX APIs won't work.
5298 EAPI Eina_Bool elm_icon_animated_available_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5300 * Set animation mode of the icon.
5302 * @param obj The icon object
5303 * @param anim @c EINA_TRUE if the object do animation job,
5304 * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
5306 * Since the default animation mode is set to EINA_FALSE,
5307 * the icon is shown without animation.
5308 * This might be desirable when the application developer wants to show
5309 * a snapshot of the animated icon.
5310 * Set it to EINA_TRUE when the icon needs to be animated.
5313 EAPI void elm_icon_animated_set(Evas_Object *obj, Eina_Bool animated) EINA_ARG_NONNULL(1);
5315 * Get animation mode of the icon.
5317 * @param obj The icon object
5318 * @return The animation mode of the icon object
5319 * @see elm_icon_animated_set
5322 EAPI Eina_Bool elm_icon_animated_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5324 * Set animation play mode of the icon.
5326 * @param obj The icon object
5327 * @param play @c EINA_TRUE the object play animation images,
5328 * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
5330 * To play elm icon's animation, set play to EINA_TURE.
5331 * For example, you make gif player using this set/get API and click event.
5333 * 1. Click event occurs
5334 * 2. Check play flag using elm_icon_animaged_play_get
5335 * 3. If elm icon was playing, set play to EINA_FALSE.
5336 * Then animation will be stopped and vice versa
5339 EAPI void elm_icon_animated_play_set(Evas_Object *obj, Eina_Bool play) EINA_ARG_NONNULL(1);
5341 * Get animation play mode of the icon.
5343 * @param obj The icon object
5344 * @return The play mode of the icon object
5346 * @see elm_icon_animated_play_get
5349 EAPI Eina_Bool elm_icon_animated_play_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5356 * @defgroup Image Image
5358 * @image html img/widget/image/preview-00.png
5359 * @image latex img/widget/image/preview-00.eps
5362 * An object that allows one to load an image file to it. It can be used
5363 * anywhere like any other elementary widget.
5365 * This widget provides most of the functionality provided from @ref Bg or @ref
5366 * Icon, but with a slightly different API (use the one that fits better your
5369 * The features not provided by those two other image widgets are:
5370 * @li allowing to get the basic @c Evas_Object with elm_image_object_get();
5371 * @li change the object orientation with elm_image_orient_set();
5372 * @li and turning the image editable with elm_image_editable_set().
5374 * Signals that you can add callbacks for are:
5376 * @li @c "clicked" - This is called when a user has clicked the image
5378 * An example of usage for this API follows:
5379 * @li @ref tutorial_image
5388 * @enum _Elm_Image_Orient
5389 * @typedef Elm_Image_Orient
5391 * Possible orientation options for elm_image_orient_set().
5393 * @image html elm_image_orient_set.png
5394 * @image latex elm_image_orient_set.eps width=\textwidth
5398 typedef enum _Elm_Image_Orient
5400 ELM_IMAGE_ORIENT_NONE, /**< no orientation change */
5401 ELM_IMAGE_ROTATE_90_CW, /**< rotate 90 degrees clockwise */
5402 ELM_IMAGE_ROTATE_180_CW, /**< rotate 180 degrees clockwise */
5403 ELM_IMAGE_ROTATE_90_CCW, /**< rotate 90 degrees counter-clockwise (i.e. 270 degrees clockwise) */
5404 ELM_IMAGE_FLIP_HORIZONTAL, /**< flip image horizontally */
5405 ELM_IMAGE_FLIP_VERTICAL, /**< flip image vertically */
5406 ELM_IMAGE_FLIP_TRANSPOSE, /**< flip the image along the y = (side - x) line*/
5407 ELM_IMAGE_FLIP_TRANSVERSE /**< flip the image along the y = x line */
5411 * Add a new image to the parent.
5413 * @param parent The parent object
5414 * @return The new object or NULL if it cannot be created
5416 * @see elm_image_file_set()
5420 EAPI Evas_Object *elm_image_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5422 * Set the file that will be used as image.
5424 * @param obj The image object
5425 * @param file The path to file that will be used as image
5426 * @param group The group that the image belongs in edje file (if it's an
5429 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
5431 * @see elm_image_file_get()
5435 EAPI Eina_Bool elm_image_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
5437 * Get the file that will be used as image.
5439 * @param obj The image object
5440 * @param file The path to file
5441 * @param group The group that the image belongs in edje file
5443 * @see elm_image_file_set()
5447 EAPI void elm_image_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
5449 * Set the smooth effect for an image.
5451 * @param obj The image object
5452 * @param smooth @c EINA_TRUE if smooth scaling should be used, @c EINA_FALSE
5453 * otherwise. Default is @c EINA_TRUE.
5455 * Set the scaling algorithm to be used when scaling the image. Smooth
5456 * scaling provides a better resulting image, but is slower.
5458 * The smooth scaling should be disabled when making animations that change
5459 * the image size, since it will be faster. Animations that don't require
5460 * resizing of the image can keep the smooth scaling enabled (even if the
5461 * image is already scaled, since the scaled image will be cached).
5463 * @see elm_image_smooth_get()
5467 EAPI void elm_image_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
5469 * Get the smooth effect for an image.
5471 * @param obj The image object
5472 * @return @c EINA_TRUE if smooth scaling is enabled, @c EINA_FALSE otherwise.
5474 * @see elm_image_smooth_get()
5478 EAPI Eina_Bool elm_image_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5481 * Gets the current size of the image.
5483 * @param obj The image object.
5484 * @param w Pointer to store width, or NULL.
5485 * @param h Pointer to store height, or NULL.
5487 * This is the real size of the image, not the size of the object.
5489 * On error, neither w or h will be written.
5493 EAPI void elm_image_object_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
5495 * Disable scaling of this object.
5497 * @param obj The image object.
5498 * @param no_scale @c EINA_TRUE if the object is not scalable, @c EINA_FALSE
5499 * otherwise. Default is @c EINA_FALSE.
5501 * This function disables scaling of the elm_image widget through the
5502 * function elm_object_scale_set(). However, this does not affect the widget
5503 * size/resize in any way. For that effect, take a look at
5504 * elm_image_scale_set().
5506 * @see elm_image_no_scale_get()
5507 * @see elm_image_scale_set()
5508 * @see elm_object_scale_set()
5512 EAPI void elm_image_no_scale_set(Evas_Object *obj, Eina_Bool no_scale) EINA_ARG_NONNULL(1);
5514 * Get whether scaling is disabled on the object.
5516 * @param obj The image object
5517 * @return @c EINA_TRUE if scaling is disabled, @c EINA_FALSE otherwise
5519 * @see elm_image_no_scale_set()
5523 EAPI Eina_Bool elm_image_no_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5525 * Set if the object is (up/down) resizable.
5527 * @param obj The image object
5528 * @param scale_up A bool to set if the object is resizable up. Default is
5530 * @param scale_down A bool to set if the object is resizable down. Default
5533 * This function limits the image resize ability. If @p scale_up is set to
5534 * @c EINA_FALSE, the object can't have its height or width resized to a value
5535 * higher than the original image size. Same is valid for @p scale_down.
5537 * @see elm_image_scale_get()
5541 EAPI void elm_image_scale_set(Evas_Object *obj, Eina_Bool scale_up, Eina_Bool scale_down) EINA_ARG_NONNULL(1);
5543 * Get if the object is (up/down) resizable.
5545 * @param obj The image object
5546 * @param scale_up A bool to set if the object is resizable up
5547 * @param scale_down A bool to set if the object is resizable down
5549 * @see elm_image_scale_set()
5553 EAPI void elm_image_scale_get(const Evas_Object *obj, Eina_Bool *scale_up, Eina_Bool *scale_down) EINA_ARG_NONNULL(1);
5555 * Set if the image fills the entire object area, when keeping the aspect ratio.
5557 * @param obj The image object
5558 * @param fill_outside @c EINA_TRUE if the object is filled outside,
5559 * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
5561 * When the image should keep its aspect ratio even if resized to another
5562 * aspect ratio, there are two possibilities to resize it: keep the entire
5563 * image inside the limits of height and width of the object (@p fill_outside
5564 * is @c EINA_FALSE) or let the extra width or height go outside of the object,
5565 * and the image will fill the entire object (@p fill_outside is @c EINA_TRUE).
5567 * @note This option will have no effect if
5568 * elm_image_aspect_ratio_retained_set() is set to @c EINA_FALSE.
5570 * @see elm_image_fill_outside_get()
5571 * @see elm_image_aspect_ratio_retained_set()
5575 EAPI void elm_image_fill_outside_set(Evas_Object *obj, Eina_Bool fill_outside) EINA_ARG_NONNULL(1);
5577 * Get if the object is filled outside
5579 * @param obj The image object
5580 * @return @c EINA_TRUE if the object is filled outside, @c EINA_FALSE otherwise.
5582 * @see elm_image_fill_outside_set()
5586 EAPI Eina_Bool elm_image_fill_outside_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5588 * Set the prescale size for the image
5590 * @param obj The image object
5591 * @param size The prescale size. This value is used for both width and
5594 * This function sets a new size for pixmap representation of the given
5595 * image. It allows the image to be loaded already in the specified size,
5596 * reducing the memory usage and load time when loading a big image with load
5597 * size set to a smaller size.
5599 * It's equivalent to the elm_bg_load_size_set() function for bg.
5601 * @note this is just a hint, the real size of the pixmap may differ
5602 * depending on the type of image being loaded, being bigger than requested.
5604 * @see elm_image_prescale_get()
5605 * @see elm_bg_load_size_set()
5609 EAPI void elm_image_prescale_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
5611 * Get the prescale size for the image
5613 * @param obj The image object
5614 * @return The prescale size
5616 * @see elm_image_prescale_set()
5620 EAPI int elm_image_prescale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5622 * Set the image orientation.
5624 * @param obj The image object
5625 * @param orient The image orientation @ref Elm_Image_Orient
5626 * Default is #ELM_IMAGE_ORIENT_NONE.
5628 * This function allows to rotate or flip the given image.
5630 * @see elm_image_orient_get()
5631 * @see @ref Elm_Image_Orient
5635 EAPI void elm_image_orient_set(Evas_Object *obj, Elm_Image_Orient orient) EINA_ARG_NONNULL(1);
5637 * Get the image orientation.
5639 * @param obj The image object
5640 * @return The image orientation @ref Elm_Image_Orient
5642 * @see elm_image_orient_set()
5643 * @see @ref Elm_Image_Orient
5647 EAPI Elm_Image_Orient elm_image_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5649 * Make the image 'editable'.
5651 * @param obj Image object.
5652 * @param set Turn on or off editability. Default is @c EINA_FALSE.
5654 * This means the image is a valid drag target for drag and drop, and can be
5655 * cut or pasted too.
5659 EAPI void elm_image_editable_set(Evas_Object *obj, Eina_Bool set) EINA_ARG_NONNULL(1);
5661 * Check if the image 'editable'.
5663 * @param obj Image object.
5664 * @return Editability.
5666 * A return value of EINA_TRUE means the image is a valid drag target
5667 * for drag and drop, and can be cut or pasted too.
5671 EAPI Eina_Bool elm_image_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5673 * Get the basic Evas_Image object from this object (widget).
5675 * @param obj The image object to get the inlined image from
5676 * @return The inlined image object, or NULL if none exists
5678 * This function allows one to get the underlying @c Evas_Object of type
5679 * Image from this elementary widget. It can be useful to do things like get
5680 * the pixel data, save the image to a file, etc.
5682 * @note Be careful to not manipulate it, as it is under control of
5687 EAPI Evas_Object *elm_image_object_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5689 * Set whether the original aspect ratio of the image should be kept on resize.
5691 * @param obj The image object.
5692 * @param retained @c EINA_TRUE if the image should retain the aspect,
5693 * @c EINA_FALSE otherwise.
5695 * The original aspect ratio (width / height) of the image is usually
5696 * distorted to match the object's size. Enabling this option will retain
5697 * this original aspect, and the way that the image is fit into the object's
5698 * area depends on the option set by elm_image_fill_outside_set().
5700 * @see elm_image_aspect_ratio_retained_get()
5701 * @see elm_image_fill_outside_set()
5705 EAPI void elm_image_aspect_ratio_retained_set(Evas_Object *obj, Eina_Bool retained) EINA_ARG_NONNULL(1);
5707 * Get if the object retains the original aspect ratio.
5709 * @param obj The image object.
5710 * @return @c EINA_TRUE if the object keeps the original aspect, @c EINA_FALSE
5715 EAPI Eina_Bool elm_image_aspect_ratio_retained_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5725 * @image html img/widget/box/preview-00.png
5726 * @image latex img/widget/box/preview-00.eps width=\textwidth
5728 * @image html img/box.png
5729 * @image latex img/box.eps width=\textwidth
5731 * A box arranges objects in a linear fashion, governed by a layout function
5732 * that defines the details of this arrangement.
5734 * By default, the box will use an internal function to set the layout to
5735 * a single row, either vertical or horizontal. This layout is affected
5736 * by a number of parameters, such as the homogeneous flag set by
5737 * elm_box_homogeneous_set(), the values given by elm_box_padding_set() and
5738 * elm_box_align_set() and the hints set to each object in the box.
5740 * For this default layout, it's possible to change the orientation with
5741 * elm_box_horizontal_set(). The box will start in the vertical orientation,
5742 * placing its elements ordered from top to bottom. When horizontal is set,
5743 * the order will go from left to right. If the box is set to be
5744 * homogeneous, every object in it will be assigned the same space, that
5745 * of the largest object. Padding can be used to set some spacing between
5746 * the cell given to each object. The alignment of the box, set with
5747 * elm_box_align_set(), determines how the bounding box of all the elements
5748 * will be placed within the space given to the box widget itself.
5750 * The size hints of each object also affect how they are placed and sized
5751 * within the box. evas_object_size_hint_min_set() will give the minimum
5752 * size the object can have, and the box will use it as the basis for all
5753 * latter calculations. Elementary widgets set their own minimum size as
5754 * needed, so there's rarely any need to use it manually.
5756 * evas_object_size_hint_weight_set(), when not in homogeneous mode, is
5757 * used to tell whether the object will be allocated the minimum size it
5758 * needs or if the space given to it should be expanded. It's important
5759 * to realize that expanding the size given to the object is not the same
5760 * thing as resizing the object. It could very well end being a small
5761 * widget floating in a much larger empty space. If not set, the weight
5762 * for objects will normally be 0.0 for both axis, meaning the widget will
5763 * not be expanded. To take as much space possible, set the weight to
5764 * EVAS_HINT_EXPAND (defined to 1.0) for the desired axis to expand.
5766 * Besides how much space each object is allocated, it's possible to control
5767 * how the widget will be placed within that space using
5768 * evas_object_size_hint_align_set(). By default, this value will be 0.5
5769 * for both axis, meaning the object will be centered, but any value from
5770 * 0.0 (left or top, for the @c x and @c y axis, respectively) to 1.0
5771 * (right or bottom) can be used. The special value EVAS_HINT_FILL, which
5772 * is -1.0, means the object will be resized to fill the entire space it
5775 * In addition, customized functions to define the layout can be set, which
5776 * allow the application developer to organize the objects within the box
5777 * in any number of ways.
5779 * The special elm_box_layout_transition() function can be used
5780 * to switch from one layout to another, animating the motion of the
5781 * children of the box.
5783 * @note Objects should not be added to box objects using _add() calls.
5785 * Some examples on how to use boxes follow:
5786 * @li @ref box_example_01
5787 * @li @ref box_example_02
5792 * @typedef Elm_Box_Transition
5794 * Opaque handler containing the parameters to perform an animated
5795 * transition of the layout the box uses.
5797 * @see elm_box_transition_new()
5798 * @see elm_box_layout_set()
5799 * @see elm_box_layout_transition()
5801 typedef struct _Elm_Box_Transition Elm_Box_Transition;
5804 * Add a new box to the parent
5806 * By default, the box will be in vertical mode and non-homogeneous.
5808 * @param parent The parent object
5809 * @return The new object or NULL if it cannot be created
5811 EAPI Evas_Object *elm_box_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5813 * Set the horizontal orientation
5815 * By default, box object arranges their contents vertically from top to
5817 * By calling this function with @p horizontal as EINA_TRUE, the box will
5818 * become horizontal, arranging contents from left to right.
5820 * @note This flag is ignored if a custom layout function is set.
5822 * @param obj The box object
5823 * @param horizontal The horizontal flag (EINA_TRUE = horizontal,
5824 * EINA_FALSE = vertical)
5826 EAPI void elm_box_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
5828 * Get the horizontal orientation
5830 * @param obj The box object
5831 * @return EINA_TRUE if the box is set to horizontal mode, EINA_FALSE otherwise
5833 EAPI Eina_Bool elm_box_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5835 * Set the box to arrange its children homogeneously
5837 * If enabled, homogeneous layout makes all items the same size, according
5838 * to the size of the largest of its children.
5840 * @note This flag is ignored if a custom layout function is set.
5842 * @param obj The box object
5843 * @param homogeneous The homogeneous flag
5845 EAPI void elm_box_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
5847 * Get whether the box is using homogeneous mode or not
5849 * @param obj The box object
5850 * @return EINA_TRUE if it's homogeneous, EINA_FALSE otherwise
5852 EAPI Eina_Bool elm_box_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5854 * Add an object to the beginning of the pack list
5856 * Pack @p subobj into the box @p obj, placing it first in the list of
5857 * children objects. The actual position the object will get on screen
5858 * depends on the layout used. If no custom layout is set, it will be at
5859 * the top or left, depending if the box is vertical or horizontal,
5862 * @param obj The box object
5863 * @param subobj The object to add to the box
5865 * @see elm_box_pack_end()
5866 * @see elm_box_pack_before()
5867 * @see elm_box_pack_after()
5868 * @see elm_box_unpack()
5869 * @see elm_box_unpack_all()
5870 * @see elm_box_clear()
5872 EAPI void elm_box_pack_start(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
5874 * Add an object at the end of the pack list
5876 * Pack @p subobj into the box @p obj, placing it last in the list of
5877 * children objects. The actual position the object will get on screen
5878 * depends on the layout used. If no custom layout is set, it will be at
5879 * the bottom or right, depending if the box is vertical or horizontal,
5882 * @param obj The box object
5883 * @param subobj The object to add to the box
5885 * @see elm_box_pack_start()
5886 * @see elm_box_pack_before()
5887 * @see elm_box_pack_after()
5888 * @see elm_box_unpack()
5889 * @see elm_box_unpack_all()
5890 * @see elm_box_clear()
5892 EAPI void elm_box_pack_end(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
5894 * Adds an object to the box before the indicated object
5896 * This will add the @p subobj to the box indicated before the object
5897 * indicated with @p before. If @p before is not already in the box, results
5898 * are undefined. Before means either to the left of the indicated object or
5899 * above it depending on orientation.
5901 * @param obj The box object
5902 * @param subobj The object to add to the box
5903 * @param before The object before which to add it
5905 * @see elm_box_pack_start()
5906 * @see elm_box_pack_end()
5907 * @see elm_box_pack_after()
5908 * @see elm_box_unpack()
5909 * @see elm_box_unpack_all()
5910 * @see elm_box_clear()
5912 EAPI void elm_box_pack_before(Evas_Object *obj, Evas_Object *subobj, Evas_Object *before) EINA_ARG_NONNULL(1);
5914 * Adds an object to the box after the indicated object
5916 * This will add the @p subobj to the box indicated after the object
5917 * indicated with @p after. If @p after is not already in the box, results
5918 * are undefined. After means either to the right of the indicated object or
5919 * below it depending on orientation.
5921 * @param obj The box object
5922 * @param subobj The object to add to the box
5923 * @param after The object after which to add it
5925 * @see elm_box_pack_start()
5926 * @see elm_box_pack_end()
5927 * @see elm_box_pack_before()
5928 * @see elm_box_unpack()
5929 * @see elm_box_unpack_all()
5930 * @see elm_box_clear()
5932 EAPI void elm_box_pack_after(Evas_Object *obj, Evas_Object *subobj, Evas_Object *after) EINA_ARG_NONNULL(1);
5934 * Clear the box of all children
5936 * Remove all the elements contained by the box, deleting the respective
5939 * @param obj The box object
5941 * @see elm_box_unpack()
5942 * @see elm_box_unpack_all()
5944 EAPI void elm_box_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
5948 * Remove the object given by @p subobj from the box @p obj without
5951 * @param obj The box object
5953 * @see elm_box_unpack_all()
5954 * @see elm_box_clear()
5956 EAPI void elm_box_unpack(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
5958 * Remove all items from the box, without deleting them
5960 * Clear the box from all children, but don't delete the respective objects.
5961 * If no other references of the box children exist, the objects will never
5962 * be deleted, and thus the application will leak the memory. Make sure
5963 * when using this function that you hold a reference to all the objects
5964 * in the box @p obj.
5966 * @param obj The box object
5968 * @see elm_box_clear()
5969 * @see elm_box_unpack()
5971 EAPI void elm_box_unpack_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
5973 * Retrieve a list of the objects packed into the box
5975 * Returns a new @c Eina_List with a pointer to @c Evas_Object in its nodes.
5976 * The order of the list corresponds to the packing order the box uses.
5978 * You must free this list with eina_list_free() once you are done with it.
5980 * @param obj The box object
5982 EAPI const Eina_List *elm_box_children_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5984 * Set the space (padding) between the box's elements.
5986 * Extra space in pixels that will be added between a box child and its
5987 * neighbors after its containing cell has been calculated. This padding
5988 * is set for all elements in the box, besides any possible padding that
5989 * individual elements may have through their size hints.
5991 * @param obj The box object
5992 * @param horizontal The horizontal space between elements
5993 * @param vertical The vertical space between elements
5995 EAPI void elm_box_padding_set(Evas_Object *obj, Evas_Coord horizontal, Evas_Coord vertical) EINA_ARG_NONNULL(1);
5997 * Get the space (padding) between the box's elements.
5999 * @param obj The box object
6000 * @param horizontal The horizontal space between elements
6001 * @param vertical The vertical space between elements
6003 * @see elm_box_padding_set()
6005 EAPI void elm_box_padding_get(const Evas_Object *obj, Evas_Coord *horizontal, Evas_Coord *vertical) EINA_ARG_NONNULL(1);
6007 * Set the alignment of the whole bouding box of contents.
6009 * Sets how the bounding box containing all the elements of the box, after
6010 * their sizes and position has been calculated, will be aligned within
6011 * the space given for the whole box widget.
6013 * @param obj The box object
6014 * @param horizontal The horizontal alignment of elements
6015 * @param vertical The vertical alignment of elements
6017 EAPI void elm_box_align_set(Evas_Object *obj, double horizontal, double vertical) EINA_ARG_NONNULL(1);
6019 * Get the alignment of the whole bouding box of contents.
6021 * @param obj The box object
6022 * @param horizontal The horizontal alignment of elements
6023 * @param vertical The vertical alignment of elements
6025 * @see elm_box_align_set()
6027 EAPI void elm_box_align_get(const Evas_Object *obj, double *horizontal, double *vertical) EINA_ARG_NONNULL(1);
6030 * Force the box to recalculate its children packing.
6032 * If any children was added or removed, box will not calculate the
6033 * values immediately rather leaving it to the next main loop
6034 * iteration. While this is great as it would save lots of
6035 * recalculation, whenever you need to get the position of a just
6036 * added item you must force recalculate before doing so.
6038 * @param obj The box object.
6040 EAPI void elm_box_recalculate(Evas_Object *obj);
6043 * Set the layout defining function to be used by the box
6045 * Whenever anything changes that requires the box in @p obj to recalculate
6046 * the size and position of its elements, the function @p cb will be called
6047 * to determine what the layout of the children will be.
6049 * Once a custom function is set, everything about the children layout
6050 * is defined by it. The flags set by elm_box_horizontal_set() and
6051 * elm_box_homogeneous_set() no longer have any meaning, and the values
6052 * given by elm_box_padding_set() and elm_box_align_set() are up to this
6053 * layout function to decide if they are used and how. These last two
6054 * will be found in the @c priv parameter, of type @c Evas_Object_Box_Data,
6055 * passed to @p cb. The @c Evas_Object the function receives is not the
6056 * Elementary widget, but the internal Evas Box it uses, so none of the
6057 * functions described here can be used on it.
6059 * Any of the layout functions in @c Evas can be used here, as well as the
6060 * special elm_box_layout_transition().
6062 * The final @p data argument received by @p cb is the same @p data passed
6063 * here, and the @p free_data function will be called to free it
6064 * whenever the box is destroyed or another layout function is set.
6066 * Setting @p cb to NULL will revert back to the default layout function.
6068 * @param obj The box object
6069 * @param cb The callback function used for layout
6070 * @param data Data that will be passed to layout function
6071 * @param free_data Function called to free @p data
6073 * @see elm_box_layout_transition()
6075 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);
6077 * Special layout function that animates the transition from one layout to another
6079 * Normally, when switching the layout function for a box, this will be
6080 * reflected immediately on screen on the next render, but it's also
6081 * possible to do this through an animated transition.
6083 * This is done by creating an ::Elm_Box_Transition and setting the box
6084 * layout to this function.
6088 * Elm_Box_Transition *t = elm_box_transition_new(1.0,
6089 * evas_object_box_layout_vertical, // start
6090 * NULL, // data for initial layout
6091 * NULL, // free function for initial data
6092 * evas_object_box_layout_horizontal, // end
6093 * NULL, // data for final layout
6094 * NULL, // free function for final data
6095 * anim_end, // will be called when animation ends
6096 * NULL); // data for anim_end function\
6097 * elm_box_layout_set(box, elm_box_layout_transition, t,
6098 * elm_box_transition_free);
6101 * @note This function can only be used with elm_box_layout_set(). Calling
6102 * it directly will not have the expected results.
6104 * @see elm_box_transition_new
6105 * @see elm_box_transition_free
6106 * @see elm_box_layout_set
6108 EAPI void elm_box_layout_transition(Evas_Object *obj, Evas_Object_Box_Data *priv, void *data);
6110 * Create a new ::Elm_Box_Transition to animate the switch of layouts
6112 * If you want to animate the change from one layout to another, you need
6113 * to set the layout function of the box to elm_box_layout_transition(),
6114 * passing as user data to it an instance of ::Elm_Box_Transition with the
6115 * necessary information to perform this animation. The free function to
6116 * set for the layout is elm_box_transition_free().
6118 * The parameters to create an ::Elm_Box_Transition sum up to how long
6119 * will it be, in seconds, a layout function to describe the initial point,
6120 * another for the final position of the children and one function to be
6121 * called when the whole animation ends. This last function is useful to
6122 * set the definitive layout for the box, usually the same as the end
6123 * layout for the animation, but could be used to start another transition.
6125 * @param start_layout The layout function that will be used to start the animation
6126 * @param start_layout_data The data to be passed the @p start_layout function
6127 * @param start_layout_free_data Function to free @p start_layout_data
6128 * @param end_layout The layout function that will be used to end the animation
6129 * @param end_layout_free_data The data to be passed the @p end_layout function
6130 * @param end_layout_free_data Function to free @p end_layout_data
6131 * @param transition_end_cb Callback function called when animation ends
6132 * @param transition_end_data Data to be passed to @p transition_end_cb
6133 * @return An instance of ::Elm_Box_Transition
6135 * @see elm_box_transition_new
6136 * @see elm_box_layout_transition
6138 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);
6140 * Free a Elm_Box_Transition instance created with elm_box_transition_new().
6142 * This function is mostly useful as the @c free_data parameter in
6143 * elm_box_layout_set() when elm_box_layout_transition().
6145 * @param data The Elm_Box_Transition instance to be freed.
6147 * @see elm_box_transition_new
6148 * @see elm_box_layout_transition
6150 EAPI void elm_box_transition_free(void *data);
6157 * @defgroup Button Button
6159 * @image html img/widget/button/preview-00.png
6160 * @image latex img/widget/button/preview-00.eps
6161 * @image html img/widget/button/preview-01.png
6162 * @image latex img/widget/button/preview-01.eps
6163 * @image html img/widget/button/preview-02.png
6164 * @image latex img/widget/button/preview-02.eps
6166 * This is a push-button. Press it and run some function. It can contain
6167 * a simple label and icon object and it also has an autorepeat feature.
6169 * This widgets emits the following signals:
6170 * @li "clicked": the user clicked the button (press/release).
6171 * @li "repeated": the user pressed the button without releasing it.
6172 * @li "pressed": button was pressed.
6173 * @li "unpressed": button was released after being pressed.
6174 * In all three cases, the @c event parameter of the callback will be
6177 * Also, defined in the default theme, the button has the following styles
6179 * @li default: a normal button.
6180 * @li anchor: Like default, but the button fades away when the mouse is not
6181 * over it, leaving only the text or icon.
6182 * @li hoversel_vertical: Internally used by @ref Hoversel to give a
6183 * continuous look across its options.
6184 * @li hoversel_vertical_entry: Another internal for @ref Hoversel.
6186 * Default contents parts of the button widget that you can use for are:
6187 * @li "icon" - A icon of the button
6189 * Default text parts of the button widget that you can use for are:
6190 * @li "default" - Label of the button
6192 * Follow through a complete example @ref button_example_01 "here".
6196 * Add a new button to the parent's canvas
6198 * @param parent The parent object
6199 * @return The new object or NULL if it cannot be created
6201 EAPI Evas_Object *elm_button_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6203 * Set the label used in the button
6205 * The passed @p label can be NULL to clean any existing text in it and
6206 * leave the button as an icon only object.
6208 * @param obj The button object
6209 * @param label The text will be written on the button
6210 * @deprecated use elm_object_text_set() instead.
6212 EINA_DEPRECATED EAPI void elm_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
6214 * Get the label set for the button
6216 * The string returned is an internal pointer and should not be freed or
6217 * altered. It will also become invalid when the button is destroyed.
6218 * The string returned, if not NULL, is a stringshare, so if you need to
6219 * keep it around even after the button is destroyed, you can use
6220 * eina_stringshare_ref().
6222 * @param obj The button object
6223 * @return The text set to the label, or NULL if nothing is set
6224 * @deprecated use elm_object_text_set() instead.
6226 EINA_DEPRECATED EAPI const char *elm_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6228 * Set the icon used for the button
6230 * Setting a new icon will delete any other that was previously set, making
6231 * any reference to them invalid. If you need to maintain the previous
6232 * object alive, unset it first with elm_button_icon_unset().
6234 * @param obj The button object
6235 * @param icon The icon object for the button
6236 * @deprecated use elm_object_part_content_set() instead.
6238 EINA_DEPRECATED EAPI void elm_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
6240 * Get the icon used for the button
6242 * Return the icon object which is set for this widget. If the button is
6243 * destroyed or another icon is set, the returned object will be deleted
6244 * and any reference to it will be invalid.
6246 * @param obj The button object
6247 * @return The icon object that is being used
6249 * @deprecated use elm_object_part_content_get() instead
6251 EINA_DEPRECATED EAPI Evas_Object *elm_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6253 * Remove the icon set without deleting it and return the object
6255 * This function drops the reference the button holds of the icon object
6256 * and returns this last object. It is used in case you want to remove any
6257 * icon, or set another one, without deleting the actual object. The button
6258 * will be left without an icon set.
6260 * @param obj The button object
6261 * @return The icon object that was being used
6262 * @deprecated use elm_object_part_content_unset() instead.
6264 EINA_DEPRECATED EAPI Evas_Object *elm_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6266 * Turn on/off the autorepeat event generated when the button is kept pressed
6268 * When off, no autorepeat is performed and buttons emit a normal @c clicked
6269 * signal when they are clicked.
6271 * When on, keeping a button pressed will continuously emit a @c repeated
6272 * signal until the button is released. The time it takes until it starts
6273 * emitting the signal is given by
6274 * elm_button_autorepeat_initial_timeout_set(), and the time between each
6275 * new emission by elm_button_autorepeat_gap_timeout_set().
6277 * @param obj The button object
6278 * @param on A bool to turn on/off the event
6280 EAPI void elm_button_autorepeat_set(Evas_Object *obj, Eina_Bool on) EINA_ARG_NONNULL(1);
6282 * Get whether the autorepeat feature is enabled
6284 * @param obj The button object
6285 * @return EINA_TRUE if autorepeat is on, EINA_FALSE otherwise
6287 * @see elm_button_autorepeat_set()
6289 EAPI Eina_Bool elm_button_autorepeat_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6291 * Set the initial timeout before the autorepeat event is generated
6293 * Sets the timeout, in seconds, since the button is pressed until the
6294 * first @c repeated signal is emitted. If @p t is 0.0 or less, there
6295 * won't be any delay and the even will be fired the moment the button is
6298 * @param obj The button object
6299 * @param t Timeout in seconds
6301 * @see elm_button_autorepeat_set()
6302 * @see elm_button_autorepeat_gap_timeout_set()
6304 EAPI void elm_button_autorepeat_initial_timeout_set(Evas_Object *obj, double t) EINA_ARG_NONNULL(1);
6306 * Get the initial timeout before the autorepeat event is generated
6308 * @param obj The button object
6309 * @return Timeout in seconds
6311 * @see elm_button_autorepeat_initial_timeout_set()
6313 EAPI double elm_button_autorepeat_initial_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6315 * Set the interval between each generated autorepeat event
6317 * After the first @c repeated event is fired, all subsequent ones will
6318 * follow after a delay of @p t seconds for each.
6320 * @param obj The button object
6321 * @param t Interval in seconds
6323 * @see elm_button_autorepeat_initial_timeout_set()
6325 EAPI void elm_button_autorepeat_gap_timeout_set(Evas_Object *obj, double t) EINA_ARG_NONNULL(1);
6327 * Get the interval between each generated autorepeat event
6329 * @param obj The button object
6330 * @return Interval in seconds
6332 EAPI double elm_button_autorepeat_gap_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6338 * @defgroup File_Selector_Button File Selector Button
6340 * @image html img/widget/fileselector_button/preview-00.png
6341 * @image latex img/widget/fileselector_button/preview-00.eps
6342 * @image html img/widget/fileselector_button/preview-01.png
6343 * @image latex img/widget/fileselector_button/preview-01.eps
6344 * @image html img/widget/fileselector_button/preview-02.png
6345 * @image latex img/widget/fileselector_button/preview-02.eps
6347 * This is a button that, when clicked, creates an Elementary
6348 * window (or inner window) <b> with a @ref Fileselector "file
6349 * selector widget" within</b>. When a file is chosen, the (inner)
6350 * window is closed and the button emits a signal having the
6351 * selected file as it's @c event_info.
6353 * This widget encapsulates operations on its internal file
6354 * selector on its own API. There is less control over its file
6355 * selector than that one would have instatiating one directly.
6357 * The following styles are available for this button:
6360 * @li @c "hoversel_vertical"
6361 * @li @c "hoversel_vertical_entry"
6363 * Smart callbacks one can register to:
6364 * - @c "file,chosen" - the user has selected a path, whose string
6365 * pointer comes as the @c event_info data (a stringshared
6368 * Here is an example on its usage:
6369 * @li @ref fileselector_button_example
6371 * @see @ref File_Selector_Entry for a similar widget.
6376 * Add a new file selector button widget to the given parent
6377 * Elementary (container) object
6379 * @param parent The parent object
6380 * @return a new file selector button widget handle or @c NULL, on
6383 EAPI Evas_Object *elm_fileselector_button_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6386 * Set the label for a given file selector button widget
6388 * @param obj The file selector button widget
6389 * @param label The text label to be displayed on @p obj
6391 * @deprecated use elm_object_text_set() instead.
6393 EINA_DEPRECATED EAPI void elm_fileselector_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
6396 * Get the label set for a given file selector button widget
6398 * @param obj The file selector button widget
6399 * @return The button label
6401 * @deprecated use elm_object_text_set() instead.
6403 EINA_DEPRECATED EAPI const char *elm_fileselector_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6406 * Set the icon on a given file selector button widget
6408 * @param obj The file selector button widget
6409 * @param icon The icon object for the button
6411 * Once the icon object is set, a previously set one will be
6412 * deleted. If you want to keep the latter, use the
6413 * elm_fileselector_button_icon_unset() function.
6415 * @see elm_fileselector_button_icon_get()
6417 EAPI void elm_fileselector_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
6420 * Get the icon set for a given file selector button widget
6422 * @param obj The file selector button widget
6423 * @return The icon object currently set on @p obj or @c NULL, if
6426 * @see elm_fileselector_button_icon_set()
6428 EAPI Evas_Object *elm_fileselector_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6431 * Unset the icon used in a given file selector button widget
6433 * @param obj The file selector button widget
6434 * @return The icon object that was being used on @p obj or @c
6437 * Unparent and return the icon object which was set for this
6440 * @see elm_fileselector_button_icon_set()
6442 EAPI Evas_Object *elm_fileselector_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6445 * Set the title for a given file selector button widget's window
6447 * @param obj The file selector button widget
6448 * @param title The title string
6450 * This will change the window's title, when the file selector pops
6451 * out after a click on the button. Those windows have the default
6452 * (unlocalized) value of @c "Select a file" as titles.
6454 * @note It will only take any effect if the file selector
6455 * button widget is @b not under "inwin mode".
6457 * @see elm_fileselector_button_window_title_get()
6459 EAPI void elm_fileselector_button_window_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
6462 * Get the title set for a given file selector button widget's
6465 * @param obj The file selector button widget
6466 * @return Title of the file selector button's window
6468 * @see elm_fileselector_button_window_title_get() for more details
6470 EAPI const char *elm_fileselector_button_window_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6473 * Set the size of a given file selector button widget's window,
6474 * holding the file selector itself.
6476 * @param obj The file selector button widget
6477 * @param width The window's width
6478 * @param height The window's height
6480 * @note it will only take any effect if the file selector button
6481 * widget is @b not under "inwin mode". The default size for the
6482 * window (when applicable) is 400x400 pixels.
6484 * @see elm_fileselector_button_window_size_get()
6486 EAPI void elm_fileselector_button_window_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
6489 * Get the size of a given file selector button widget's window,
6490 * holding the file selector itself.
6492 * @param obj The file selector button widget
6493 * @param width Pointer into which to store the width value
6494 * @param height Pointer into which to store the height value
6496 * @note Use @c NULL pointers on the size values you're not
6497 * interested in: they'll be ignored by the function.
6499 * @see elm_fileselector_button_window_size_set(), for more details
6501 EAPI void elm_fileselector_button_window_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
6504 * Set the initial file system path for a given file selector
6507 * @param obj The file selector button widget
6508 * @param path The path string
6510 * It must be a <b>directory</b> path, which will have the contents
6511 * displayed initially in the file selector's view, when invoked
6512 * from @p obj. The default initial path is the @c "HOME"
6513 * environment variable's value.
6515 * @see elm_fileselector_button_path_get()
6517 EAPI void elm_fileselector_button_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
6520 * Get the initial file system path set for a given file selector
6523 * @param obj The file selector button widget
6524 * @return path The path string
6526 * @see elm_fileselector_button_path_set() for more details
6528 EAPI const char *elm_fileselector_button_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6531 * Enable/disable a tree view in the given file selector button
6532 * widget's internal file selector
6534 * @param obj The file selector button widget
6535 * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
6538 * This has the same effect as elm_fileselector_expandable_set(),
6539 * but now applied to a file selector button's internal file
6542 * @note There's no way to put a file selector button's internal
6543 * file selector in "grid mode", as one may do with "pure" file
6546 * @see elm_fileselector_expandable_get()
6548 EAPI void elm_fileselector_button_expandable_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6551 * Get whether tree view is enabled for the given file selector
6552 * button widget's internal file selector
6554 * @param obj The file selector button widget
6555 * @return @c EINA_TRUE if @p obj widget's internal file selector
6556 * is in tree view, @c EINA_FALSE otherwise (and or errors)
6558 * @see elm_fileselector_expandable_set() for more details
6560 EAPI Eina_Bool elm_fileselector_button_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6563 * Set whether a given file selector button widget's internal file
6564 * selector is to display folders only or the directory contents,
6567 * @param obj The file selector button widget
6568 * @param only @c EINA_TRUE to make @p obj widget's internal file
6569 * selector only display directories, @c EINA_FALSE to make files
6570 * to be displayed in it too
6572 * This has the same effect as elm_fileselector_folder_only_set(),
6573 * but now applied to a file selector button's internal file
6576 * @see elm_fileselector_folder_only_get()
6578 EAPI void elm_fileselector_button_folder_only_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6581 * Get whether a given file selector button widget's internal file
6582 * selector is displaying folders only or the directory contents,
6585 * @param obj The file selector button widget
6586 * @return @c EINA_TRUE if @p obj widget's internal file
6587 * selector is only displaying directories, @c EINA_FALSE if files
6588 * are being displayed in it too (and on errors)
6590 * @see elm_fileselector_button_folder_only_set() for more details
6592 EAPI Eina_Bool elm_fileselector_button_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6595 * Enable/disable the file name entry box where the user can type
6596 * in a name for a file, in a given file selector button widget's
6597 * internal file selector.
6599 * @param obj The file selector button widget
6600 * @param is_save @c EINA_TRUE to make @p obj widget's internal
6601 * file selector a "saving dialog", @c EINA_FALSE otherwise
6603 * This has the same effect as elm_fileselector_is_save_set(),
6604 * but now applied to a file selector button's internal file
6607 * @see elm_fileselector_is_save_get()
6609 EAPI void elm_fileselector_button_is_save_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6612 * Get whether the given file selector button widget's internal
6613 * file selector is in "saving dialog" mode
6615 * @param obj The file selector button widget
6616 * @return @c EINA_TRUE, if @p obj widget's internal file selector
6617 * is in "saving dialog" mode, @c EINA_FALSE otherwise (and on
6620 * @see elm_fileselector_button_is_save_set() for more details
6622 EAPI Eina_Bool elm_fileselector_button_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6625 * Set whether a given file selector button widget's internal file
6626 * selector will raise an Elementary "inner window", instead of a
6627 * dedicated Elementary window. By default, it won't.
6629 * @param obj The file selector button widget
6630 * @param value @c EINA_TRUE to make it use an inner window, @c
6631 * EINA_TRUE to make it use a dedicated window
6633 * @see elm_win_inwin_add() for more information on inner windows
6634 * @see elm_fileselector_button_inwin_mode_get()
6636 EAPI void elm_fileselector_button_inwin_mode_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6639 * Get whether a given file selector button widget's internal file
6640 * selector will raise an Elementary "inner window", instead of a
6641 * dedicated Elementary window.
6643 * @param obj The file selector button widget
6644 * @return @c EINA_TRUE if will use an inner window, @c EINA_TRUE
6645 * if it will use a dedicated window
6647 * @see elm_fileselector_button_inwin_mode_set() for more details
6649 EAPI Eina_Bool elm_fileselector_button_inwin_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6656 * @defgroup File_Selector_Entry File Selector Entry
6658 * @image html img/widget/fileselector_entry/preview-00.png
6659 * @image latex img/widget/fileselector_entry/preview-00.eps
6661 * This is an entry made to be filled with or display a <b>file
6662 * system path string</b>. Besides the entry itself, the widget has
6663 * a @ref File_Selector_Button "file selector button" on its side,
6664 * which will raise an internal @ref Fileselector "file selector widget",
6665 * when clicked, for path selection aided by file system
6668 * This file selector may appear in an Elementary window or in an
6669 * inner window. When a file is chosen from it, the (inner) window
6670 * is closed and the selected file's path string is exposed both as
6671 * an smart event and as the new text on the entry.
6673 * This widget encapsulates operations on its internal file
6674 * selector on its own API. There is less control over its file
6675 * selector than that one would have instatiating one directly.
6677 * Smart callbacks one can register to:
6678 * - @c "changed" - The text within the entry was changed
6679 * - @c "activated" - The entry has had editing finished and
6680 * changes are to be "committed"
6681 * - @c "press" - The entry has been clicked
6682 * - @c "longpressed" - The entry has been clicked (and held) for a
6684 * - @c "clicked" - The entry has been clicked
6685 * - @c "clicked,double" - The entry has been double clicked
6686 * - @c "focused" - The entry has received focus
6687 * - @c "unfocused" - The entry has lost focus
6688 * - @c "selection,paste" - A paste action has occurred on the
6690 * - @c "selection,copy" - A copy action has occurred on the entry
6691 * - @c "selection,cut" - A cut action has occurred on the entry
6692 * - @c "unpressed" - The file selector entry's button was released
6693 * after being pressed.
6694 * - @c "file,chosen" - The user has selected a path via the file
6695 * selector entry's internal file selector, whose string pointer
6696 * comes as the @c event_info data (a stringshared string)
6698 * Here is an example on its usage:
6699 * @li @ref fileselector_entry_example
6701 * @see @ref File_Selector_Button for a similar widget.
6706 * Add a new file selector entry widget to the given parent
6707 * Elementary (container) object
6709 * @param parent The parent object
6710 * @return a new file selector entry widget handle or @c NULL, on
6713 EAPI Evas_Object *elm_fileselector_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6716 * Set the label for a given file selector entry widget's button
6718 * @param obj The file selector entry widget
6719 * @param label The text label to be displayed on @p obj widget's
6722 * @deprecated use elm_object_text_set() instead.
6724 EINA_DEPRECATED EAPI void elm_fileselector_entry_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
6727 * Get the label set for a given file selector entry widget's button
6729 * @param obj The file selector entry widget
6730 * @return The widget button's label
6732 * @deprecated use elm_object_text_set() instead.
6734 EINA_DEPRECATED EAPI const char *elm_fileselector_entry_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6737 * Set the icon on a given file selector entry widget's button
6739 * @param obj The file selector entry widget
6740 * @param icon The icon object for the entry's button
6742 * Once the icon object is set, a previously set one will be
6743 * deleted. If you want to keep the latter, use the
6744 * elm_fileselector_entry_button_icon_unset() function.
6746 * @see elm_fileselector_entry_button_icon_get()
6748 EAPI void elm_fileselector_entry_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
6751 * Get the icon set for a given file selector entry widget's button
6753 * @param obj The file selector entry widget
6754 * @return The icon object currently set on @p obj widget's button
6755 * or @c NULL, if none is
6757 * @see elm_fileselector_entry_button_icon_set()
6759 EAPI Evas_Object *elm_fileselector_entry_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6762 * Unset the icon used in a given file selector entry widget's
6765 * @param obj The file selector entry widget
6766 * @return The icon object that was being used on @p obj widget's
6767 * button or @c NULL, on errors
6769 * Unparent and return the icon object which was set for this
6772 * @see elm_fileselector_entry_button_icon_set()
6774 EAPI Evas_Object *elm_fileselector_entry_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6777 * Set the title for a given file selector entry widget's window
6779 * @param obj The file selector entry widget
6780 * @param title The title string
6782 * This will change the window's title, when the file selector pops
6783 * out after a click on the entry's button. Those windows have the
6784 * default (unlocalized) value of @c "Select a file" as titles.
6786 * @note It will only take any effect if the file selector
6787 * entry widget is @b not under "inwin mode".
6789 * @see elm_fileselector_entry_window_title_get()
6791 EAPI void elm_fileselector_entry_window_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
6794 * Get the title set for a given file selector entry widget's
6797 * @param obj The file selector entry widget
6798 * @return Title of the file selector entry's window
6800 * @see elm_fileselector_entry_window_title_get() for more details
6802 EAPI const char *elm_fileselector_entry_window_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6805 * Set the size of a given file selector entry widget's window,
6806 * holding the file selector itself.
6808 * @param obj The file selector entry widget
6809 * @param width The window's width
6810 * @param height The window's height
6812 * @note it will only take any effect if the file selector entry
6813 * widget is @b not under "inwin mode". The default size for the
6814 * window (when applicable) is 400x400 pixels.
6816 * @see elm_fileselector_entry_window_size_get()
6818 EAPI void elm_fileselector_entry_window_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
6821 * Get the size of a given file selector entry widget's window,
6822 * holding the file selector itself.
6824 * @param obj The file selector entry widget
6825 * @param width Pointer into which to store the width value
6826 * @param height Pointer into which to store the height value
6828 * @note Use @c NULL pointers on the size values you're not
6829 * interested in: they'll be ignored by the function.
6831 * @see elm_fileselector_entry_window_size_set(), for more details
6833 EAPI void elm_fileselector_entry_window_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
6836 * Set the initial file system path and the entry's path string for
6837 * a given file selector entry widget
6839 * @param obj The file selector entry widget
6840 * @param path The path string
6842 * It must be a <b>directory</b> path, which will have the contents
6843 * displayed initially in the file selector's view, when invoked
6844 * from @p obj. The default initial path is the @c "HOME"
6845 * environment variable's value.
6847 * @see elm_fileselector_entry_path_get()
6849 EAPI void elm_fileselector_entry_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
6852 * Get the entry's path string for a given file selector entry
6855 * @param obj The file selector entry widget
6856 * @return path The path string
6858 * @see elm_fileselector_entry_path_set() for more details
6860 EAPI const char *elm_fileselector_entry_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6863 * Enable/disable a tree view in the given file selector entry
6864 * widget's internal file selector
6866 * @param obj The file selector entry widget
6867 * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
6870 * This has the same effect as elm_fileselector_expandable_set(),
6871 * but now applied to a file selector entry's internal file
6874 * @note There's no way to put a file selector entry's internal
6875 * file selector in "grid mode", as one may do with "pure" file
6878 * @see elm_fileselector_expandable_get()
6880 EAPI void elm_fileselector_entry_expandable_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6883 * Get whether tree view is enabled for the given file selector
6884 * entry widget's internal file selector
6886 * @param obj The file selector entry widget
6887 * @return @c EINA_TRUE if @p obj widget's internal file selector
6888 * is in tree view, @c EINA_FALSE otherwise (and or errors)
6890 * @see elm_fileselector_expandable_set() for more details
6892 EAPI Eina_Bool elm_fileselector_entry_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6895 * Set whether a given file selector entry widget's internal file
6896 * selector is to display folders only or the directory contents,
6899 * @param obj The file selector entry widget
6900 * @param only @c EINA_TRUE to make @p obj widget's internal file
6901 * selector only display directories, @c EINA_FALSE to make files
6902 * to be displayed in it too
6904 * This has the same effect as elm_fileselector_folder_only_set(),
6905 * but now applied to a file selector entry's internal file
6908 * @see elm_fileselector_folder_only_get()
6910 EAPI void elm_fileselector_entry_folder_only_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6913 * Get whether a given file selector entry widget's internal file
6914 * selector is displaying folders only or the directory contents,
6917 * @param obj The file selector entry widget
6918 * @return @c EINA_TRUE if @p obj widget's internal file
6919 * selector is only displaying directories, @c EINA_FALSE if files
6920 * are being displayed in it too (and on errors)
6922 * @see elm_fileselector_entry_folder_only_set() for more details
6924 EAPI Eina_Bool elm_fileselector_entry_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6927 * Enable/disable the file name entry box where the user can type
6928 * in a name for a file, in a given file selector entry widget's
6929 * internal file selector.
6931 * @param obj The file selector entry widget
6932 * @param is_save @c EINA_TRUE to make @p obj widget's internal
6933 * file selector a "saving dialog", @c EINA_FALSE otherwise
6935 * This has the same effect as elm_fileselector_is_save_set(),
6936 * but now applied to a file selector entry's internal file
6939 * @see elm_fileselector_is_save_get()
6941 EAPI void elm_fileselector_entry_is_save_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6944 * Get whether the given file selector entry widget's internal
6945 * file selector is in "saving dialog" mode
6947 * @param obj The file selector entry widget
6948 * @return @c EINA_TRUE, if @p obj widget's internal file selector
6949 * is in "saving dialog" mode, @c EINA_FALSE otherwise (and on
6952 * @see elm_fileselector_entry_is_save_set() for more details
6954 EAPI Eina_Bool elm_fileselector_entry_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6957 * Set whether a given file selector entry widget's internal file
6958 * selector will raise an Elementary "inner window", instead of a
6959 * dedicated Elementary window. By default, it won't.
6961 * @param obj The file selector entry widget
6962 * @param value @c EINA_TRUE to make it use an inner window, @c
6963 * EINA_TRUE to make it use a dedicated window
6965 * @see elm_win_inwin_add() for more information on inner windows
6966 * @see elm_fileselector_entry_inwin_mode_get()
6968 EAPI void elm_fileselector_entry_inwin_mode_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6971 * Get whether a given file selector entry widget's internal file
6972 * selector will raise an Elementary "inner window", instead of a
6973 * dedicated Elementary window.
6975 * @param obj The file selector entry widget
6976 * @return @c EINA_TRUE if will use an inner window, @c EINA_TRUE
6977 * if it will use a dedicated window
6979 * @see elm_fileselector_entry_inwin_mode_set() for more details
6981 EAPI Eina_Bool elm_fileselector_entry_inwin_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6984 * Set the initial file system path for a given file selector entry
6987 * @param obj The file selector entry widget
6988 * @param path The path string
6990 * It must be a <b>directory</b> path, which will have the contents
6991 * displayed initially in the file selector's view, when invoked
6992 * from @p obj. The default initial path is the @c "HOME"
6993 * environment variable's value.
6995 * @see elm_fileselector_entry_path_get()
6997 EAPI void elm_fileselector_entry_selected_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
7000 * Get the parent directory's path to the latest file selection on
7001 * a given filer selector entry widget
7003 * @param obj The file selector object
7004 * @return The (full) path of the directory of the last selection
7005 * on @p obj widget, a @b stringshared string
7007 * @see elm_fileselector_entry_path_set()
7009 EAPI const char *elm_fileselector_entry_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7016 * @defgroup Scroller Scroller
7018 * A scroller holds a single object and "scrolls it around". This means that
7019 * it allows the user to use a scrollbar (or a finger) to drag the viewable
7020 * region around, allowing to move through a much larger object that is
7021 * contained in the scroller. The scroller will always have a small minimum
7022 * size by default as it won't be limited by the contents of the scroller.
7024 * Signals that you can add callbacks for are:
7025 * @li "edge,left" - the left edge of the content has been reached
7026 * @li "edge,right" - the right edge of the content has been reached
7027 * @li "edge,top" - the top edge of the content has been reached
7028 * @li "edge,bottom" - the bottom edge of the content has been reached
7029 * @li "scroll" - the content has been scrolled (moved)
7030 * @li "scroll,anim,start" - scrolling animation has started
7031 * @li "scroll,anim,stop" - scrolling animation has stopped
7032 * @li "scroll,drag,start" - dragging the contents around has started
7033 * @li "scroll,drag,stop" - dragging the contents around has stopped
7034 * @note The "scroll,anim,*" and "scroll,drag,*" signals are only emitted by
7037 * @note When Elemementary is in embedded mode the scrollbars will not be
7038 * dragable, they appear merely as indicators of how much has been scrolled.
7039 * @note When Elementary is in desktop mode the thumbscroll(a.k.a.
7040 * fingerscroll) won't work.
7042 * Default contents parts of the scroller widget that you can use for are:
7043 * @li "default" - A content of the scroller
7045 * In @ref tutorial_scroller you'll find an example of how to use most of
7050 * @brief Type that controls when scrollbars should appear.
7052 * @see elm_scroller_policy_set()
7054 typedef enum _Elm_Scroller_Policy
7056 ELM_SCROLLER_POLICY_AUTO = 0, /**< Show scrollbars as needed */
7057 ELM_SCROLLER_POLICY_ON, /**< Always show scrollbars */
7058 ELM_SCROLLER_POLICY_OFF, /**< Never show scrollbars */
7059 ELM_SCROLLER_POLICY_LAST
7060 } Elm_Scroller_Policy;
7062 * @brief Add a new scroller to the parent
7064 * @param parent The parent object
7065 * @return The new object or NULL if it cannot be created
7067 EAPI Evas_Object *elm_scroller_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7069 * @brief Set the content of the scroller widget (the object to be scrolled around).
7071 * @param obj The scroller object
7072 * @param content The new content object
7074 * Once the content object is set, a previously set one will be deleted.
7075 * If you want to keep that old content object, use the
7076 * elm_scroller_content_unset() function.
7077 * @deprecated use elm_object_content_set() instead
7079 EINA_DEPRECATED EAPI void elm_scroller_content_set(Evas_Object *obj, Evas_Object *child) EINA_ARG_NONNULL(1);
7081 * @brief Get the content of the scroller widget
7083 * @param obj The slider object
7084 * @return The content that is being used
7086 * Return the content object which is set for this widget
7088 * @see elm_scroller_content_set()
7089 * @deprecated use elm_object_content_get() instead.
7091 EINA_DEPRECATED EAPI Evas_Object *elm_scroller_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7093 * @brief Unset the content of the scroller widget
7095 * @param obj The slider object
7096 * @return The content that was being used
7098 * Unparent and return the content object which was set for this widget
7100 * @see elm_scroller_content_set()
7101 * @deprecated use elm_object_content_unset() instead.
7103 EINA_DEPRECATED EAPI Evas_Object *elm_scroller_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
7105 * @brief Set custom theme elements for the scroller
7107 * @param obj The scroller object
7108 * @param widget The widget name to use (default is "scroller")
7109 * @param base The base name to use (default is "base")
7111 EAPI void elm_scroller_custom_widget_base_theme_set(Evas_Object *obj, const char *widget, const char *base) EINA_ARG_NONNULL(1, 2, 3);
7113 * @brief Make the scroller minimum size limited to the minimum size of the content
7115 * @param obj The scroller object
7116 * @param w Enable limiting minimum size horizontally
7117 * @param h Enable limiting minimum size vertically
7119 * By default the scroller will be as small as its design allows,
7120 * irrespective of its content. This will make the scroller minimum size the
7121 * right size horizontally and/or vertically to perfectly fit its content in
7124 EAPI void elm_scroller_content_min_limit(Evas_Object *obj, Eina_Bool w, Eina_Bool h) EINA_ARG_NONNULL(1);
7126 * @brief Show a specific virtual region within the scroller content object
7128 * @param obj The scroller object
7129 * @param x X coordinate of the region
7130 * @param y Y coordinate of the region
7131 * @param w Width of the region
7132 * @param h Height of the region
7134 * This will ensure all (or part if it does not fit) of the designated
7135 * region in the virtual content object (0, 0 starting at the top-left of the
7136 * virtual content object) is shown within the scroller.
7138 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);
7140 * @brief Set the scrollbar visibility policy
7142 * @param obj The scroller object
7143 * @param policy_h Horizontal scrollbar policy
7144 * @param policy_v Vertical scrollbar policy
7146 * This sets the scrollbar visibility policy for the given scroller.
7147 * ELM_SCROLLER_POLICY_AUTO means the scrollbar is made visible if it is
7148 * needed, and otherwise kept hidden. ELM_SCROLLER_POLICY_ON turns it on all
7149 * the time, and ELM_SCROLLER_POLICY_OFF always keeps it off. This applies
7150 * respectively for the horizontal and vertical scrollbars.
7152 EAPI void elm_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
7154 * @brief Gets scrollbar visibility policy
7156 * @param obj The scroller object
7157 * @param policy_h Horizontal scrollbar policy
7158 * @param policy_v Vertical scrollbar policy
7160 * @see elm_scroller_policy_set()
7162 EAPI void elm_scroller_policy_get(const Evas_Object *obj, Elm_Scroller_Policy *policy_h, Elm_Scroller_Policy *policy_v) EINA_ARG_NONNULL(1);
7164 * @brief Get the currently visible content region
7166 * @param obj The scroller object
7167 * @param x X coordinate of the region
7168 * @param y Y coordinate of the region
7169 * @param w Width of the region
7170 * @param h Height of the region
7172 * This gets the current region in the content object that is visible through
7173 * the scroller. The region co-ordinates are returned in the @p x, @p y, @p
7174 * w, @p h values pointed to.
7176 * @note All coordinates are relative to the content.
7178 * @see elm_scroller_region_show()
7180 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);
7182 * @brief Get the size of the content object
7184 * @param obj The scroller object
7185 * @param w Width of the content object.
7186 * @param h Height of the content object.
7188 * This gets the size of the content object of the scroller.
7190 EAPI void elm_scroller_child_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
7192 * @brief Set bouncing behavior
7194 * @param obj The scroller object
7195 * @param h_bounce Allow bounce horizontally
7196 * @param v_bounce Allow bounce vertically
7198 * When scrolling, the scroller may "bounce" when reaching an edge of the
7199 * content object. This is a visual way to indicate the end has been reached.
7200 * This is enabled by default for both axis. This API will set if it is enabled
7201 * for the given axis with the boolean parameters for each axis.
7203 EAPI void elm_scroller_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
7205 * @brief Get the bounce behaviour
7207 * @param obj The Scroller object
7208 * @param h_bounce Will the scroller bounce horizontally or not
7209 * @param v_bounce Will the scroller bounce vertically or not
7211 * @see elm_scroller_bounce_set()
7213 EAPI void elm_scroller_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
7215 * @brief Set scroll page size relative to viewport size.
7217 * @param obj The scroller object
7218 * @param h_pagerel The horizontal page relative size
7219 * @param v_pagerel The vertical page relative size
7221 * The scroller is capable of limiting scrolling by the user to "pages". That
7222 * is to jump by and only show a "whole page" at a time as if the continuous
7223 * area of the scroller content is split into page sized pieces. This sets
7224 * the size of a page relative to the viewport of the scroller. 1.0 is "1
7225 * viewport" is size (horizontally or vertically). 0.0 turns it off in that
7226 * axis. This is mutually exclusive with page size
7227 * (see elm_scroller_page_size_set() for more information). Likewise 0.5
7228 * is "half a viewport". Sane usable values are normally between 0.0 and 1.0
7229 * including 1.0. If you only want 1 axis to be page "limited", use 0.0 for
7232 EAPI void elm_scroller_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel) EINA_ARG_NONNULL(1);
7234 * @brief Set scroll page size.
7236 * @param obj The scroller object
7237 * @param h_pagesize The horizontal page size
7238 * @param v_pagesize The vertical page size
7240 * This sets the page size to an absolute fixed value, with 0 turning it off
7243 * @see elm_scroller_page_relative_set()
7245 EAPI void elm_scroller_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize) EINA_ARG_NONNULL(1);
7247 * @brief Get scroll current page number.
7249 * @param obj The scroller object
7250 * @param h_pagenumber The horizontal page number
7251 * @param v_pagenumber The vertical page number
7253 * The page number starts from 0. 0 is the first page.
7254 * Current page means the page which meets the top-left of the viewport.
7255 * If there are two or more pages in the viewport, it returns the number of the page
7256 * which meets the top-left of the viewport.
7258 * @see elm_scroller_last_page_get()
7259 * @see elm_scroller_page_show()
7260 * @see elm_scroller_page_brint_in()
7262 EAPI void elm_scroller_current_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber) EINA_ARG_NONNULL(1);
7264 * @brief Get scroll last page number.
7266 * @param obj The scroller object
7267 * @param h_pagenumber The horizontal page number
7268 * @param v_pagenumber The vertical page number
7270 * The page number starts from 0. 0 is the first page.
7271 * This returns the last page number among the pages.
7273 * @see elm_scroller_current_page_get()
7274 * @see elm_scroller_page_show()
7275 * @see elm_scroller_page_brint_in()
7277 EAPI void elm_scroller_last_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber) EINA_ARG_NONNULL(1);
7279 * Show a specific virtual region within the scroller content object by page number.
7281 * @param obj The scroller object
7282 * @param h_pagenumber The horizontal page number
7283 * @param v_pagenumber The vertical page number
7285 * 0, 0 of the indicated page is located at the top-left of the viewport.
7286 * This will jump to the page directly without animation.
7291 * sc = elm_scroller_add(win);
7292 * elm_scroller_content_set(sc, content);
7293 * elm_scroller_page_relative_set(sc, 1, 0);
7294 * elm_scroller_current_page_get(sc, &h_page, &v_page);
7295 * elm_scroller_page_show(sc, h_page + 1, v_page);
7298 * @see elm_scroller_page_bring_in()
7300 EAPI void elm_scroller_page_show(Evas_Object *obj, int h_pagenumber, int v_pagenumber) EINA_ARG_NONNULL(1);
7302 * Show a specific virtual region within the scroller content object by page number.
7304 * @param obj The scroller object
7305 * @param h_pagenumber The horizontal page number
7306 * @param v_pagenumber The vertical page number
7308 * 0, 0 of the indicated page is located at the top-left of the viewport.
7309 * This will slide to the page with animation.
7314 * sc = elm_scroller_add(win);
7315 * elm_scroller_content_set(sc, content);
7316 * elm_scroller_page_relative_set(sc, 1, 0);
7317 * elm_scroller_last_page_get(sc, &h_page, &v_page);
7318 * elm_scroller_page_bring_in(sc, h_page, v_page);
7321 * @see elm_scroller_page_show()
7323 EAPI void elm_scroller_page_bring_in(Evas_Object *obj, int h_pagenumber, int v_pagenumber) EINA_ARG_NONNULL(1);
7325 * @brief Show a specific virtual region within the scroller content object.
7327 * @param obj The scroller object
7328 * @param x X coordinate of the region
7329 * @param y Y coordinate of the region
7330 * @param w Width of the region
7331 * @param h Height of the region
7333 * This will ensure all (or part if it does not fit) of the designated
7334 * region in the virtual content object (0, 0 starting at the top-left of the
7335 * virtual content object) is shown within the scroller. Unlike
7336 * elm_scroller_region_show(), this allow the scroller to "smoothly slide"
7337 * to this location (if configuration in general calls for transitions). It
7338 * may not jump immediately to the new location and make take a while and
7339 * show other content along the way.
7341 * @see elm_scroller_region_show()
7343 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);
7345 * @brief Set event propagation on a scroller
7347 * @param obj The scroller object
7348 * @param propagation If propagation is enabled or not
7350 * This enables or disabled event propagation from the scroller content to
7351 * the scroller and its parent. By default event propagation is disabled.
7353 EAPI void elm_scroller_propagate_events_set(Evas_Object *obj, Eina_Bool propagation) EINA_ARG_NONNULL(1);
7355 * @brief Get event propagation for a scroller
7357 * @param obj The scroller object
7358 * @return The propagation state
7360 * This gets the event propagation for a scroller.
7362 * @see elm_scroller_propagate_events_set()
7364 EAPI Eina_Bool elm_scroller_propagate_events_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7366 * @brief Set scrolling gravity on a scroller
7368 * @param obj The scroller object
7369 * @param x The scrolling horizontal gravity
7370 * @param y The scrolling vertical gravity
7372 * The gravity, defines how the scroller will adjust its view
7373 * when the size of the scroller contents increase.
7375 * The scroller will adjust the view to glue itself as follows.
7377 * x=0.0, for showing the left most region of the content.
7378 * x=1.0, for showing the right most region of the content.
7379 * y=0.0, for showing the bottom most region of the content.
7380 * y=1.0, for showing the top most region of the content.
7382 * Default values for x and y are 0.0
7384 EAPI void elm_scroller_gravity_set(Evas_Object *obj, double x, double y) EINA_ARG_NONNULL(1);
7386 * @brief Get scrolling gravity values for a scroller
7388 * @param obj The scroller object
7389 * @param x The scrolling horizontal gravity
7390 * @param y The scrolling vertical gravity
7392 * This gets gravity values for a scroller.
7394 * @see elm_scroller_gravity_set()
7397 EAPI void elm_scroller_gravity_get(const Evas_Object *obj, double *x, double *y) EINA_ARG_NONNULL(1);
7403 * @defgroup Label Label
7405 * @image html img/widget/label/preview-00.png
7406 * @image latex img/widget/label/preview-00.eps
7408 * @brief Widget to display text, with simple html-like markup.
7410 * The Label widget @b doesn't allow text to overflow its boundaries, if the
7411 * text doesn't fit the geometry of the label it will be ellipsized or be
7412 * cut. Elementary provides several styles for this widget:
7413 * @li default - No animation
7414 * @li marker - Centers the text in the label and make it bold by default
7415 * @li slide_long - The entire text appears from the right of the screen and
7416 * slides until it disappears in the left of the screen(reappering on the
7418 * @li slide_short - The text appears in the left of the label and slides to
7419 * the right to show the overflow. When all of the text has been shown the
7420 * position is reset.
7421 * @li slide_bounce - The text appears in the left of the label and slides to
7422 * the right to show the overflow. When all of the text has been shown the
7423 * animation reverses, moving the text to the left.
7425 * Custom themes can of course invent new markup tags and style them any way
7428 * The following signals may be emitted by the label widget:
7429 * @li "language,changed": The program's language changed.
7431 * See @ref tutorial_label for a demonstration of how to use a label widget.
7435 * @brief Add a new label to the parent
7437 * @param parent The parent object
7438 * @return The new object or NULL if it cannot be created
7440 EAPI Evas_Object *elm_label_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7442 * @brief Set the label on the label object
7444 * @param obj The label object
7445 * @param label The label will be used on the label object
7446 * @deprecated See elm_object_text_set()
7448 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 */
7450 * @brief Get the label used on the label object
7452 * @param obj The label object
7453 * @return The string inside the label
7454 * @deprecated See elm_object_text_get()
7456 EINA_DEPRECATED EAPI const char *elm_label_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1); /* deprecated, use elm_object_text_get instead */
7458 * @brief Set the wrapping behavior of the label
7460 * @param obj The label object
7461 * @param wrap To wrap text or not
7463 * By default no wrapping is done. Possible values for @p wrap are:
7464 * @li ELM_WRAP_NONE - No wrapping
7465 * @li ELM_WRAP_CHAR - wrap between characters
7466 * @li ELM_WRAP_WORD - wrap between words
7467 * @li ELM_WRAP_MIXED - Word wrap, and if that fails, char wrap
7469 EAPI void elm_label_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
7471 * @brief Get the wrapping behavior of the label
7473 * @param obj The label object
7476 * @see elm_label_line_wrap_set()
7478 EAPI Elm_Wrap_Type elm_label_line_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7480 * @brief Set wrap width of the label
7482 * @param obj The label object
7483 * @param w The wrap width in pixels at a minimum where words need to wrap
7485 * This function sets the maximum width size hint of the label.
7487 * @warning This is only relevant if the label is inside a container.
7489 EAPI void elm_label_wrap_width_set(Evas_Object *obj, Evas_Coord w) EINA_ARG_NONNULL(1);
7491 * @brief Get wrap width of the label
7493 * @param obj The label object
7494 * @return The wrap width in pixels at a minimum where words need to wrap
7496 * @see elm_label_wrap_width_set()
7498 EAPI Evas_Coord elm_label_wrap_width_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7500 * @brief Set wrap height of the label
7502 * @param obj The label object
7503 * @param h The wrap height in pixels at a minimum where words need to wrap
7505 * This function sets the maximum height size hint of the label.
7507 * @warning This is only relevant if the label is inside a container.
7509 EAPI void elm_label_wrap_height_set(Evas_Object *obj, Evas_Coord h) EINA_ARG_NONNULL(1);
7511 * @brief get wrap width of the label
7513 * @param obj The label object
7514 * @return The wrap height in pixels at a minimum where words need to wrap
7516 EAPI Evas_Coord elm_label_wrap_height_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7518 * @brief Set the font size on the label object.
7520 * @param obj The label object
7521 * @param size font size
7523 * @warning NEVER use this. It is for hyper-special cases only. use styles
7524 * instead. e.g. "default", "marker", "slide_long" etc.
7526 EAPI void elm_label_fontsize_set(Evas_Object *obj, int fontsize) EINA_ARG_NONNULL(1);
7528 * @brief Set the text color on the label object
7530 * @param obj The label object
7531 * @param r Red property background color of The label object
7532 * @param g Green property background color of The label object
7533 * @param b Blue property background color of The label object
7534 * @param a Alpha property background color of The label object
7536 * @warning NEVER use this. It is for hyper-special cases only. use styles
7537 * instead. e.g. "default", "marker", "slide_long" etc.
7539 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);
7541 * @brief Set the text align on the label object
7543 * @param obj The label object
7544 * @param align align mode ("left", "center", "right")
7546 * @warning NEVER use this. It is for hyper-special cases only. use styles
7547 * instead. e.g. "default", "marker", "slide_long" etc.
7549 EAPI void elm_label_text_align_set(Evas_Object *obj, const char *alignmode) EINA_ARG_NONNULL(1);
7551 * @brief Set background color of the label
7553 * @param obj The label object
7554 * @param r Red property background color of The label object
7555 * @param g Green property background color of The label object
7556 * @param b Blue property background color of The label object
7557 * @param a Alpha property background alpha of The label object
7559 * @warning NEVER use this. It is for hyper-special cases only. use styles
7560 * instead. e.g. "default", "marker", "slide_long" etc.
7562 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);
7564 * @brief Set the ellipsis behavior of the label
7566 * @param obj The label object
7567 * @param ellipsis To ellipsis text or not
7569 * If set to true and the text doesn't fit in the label an ellipsis("...")
7570 * will be shown at the end of the widget.
7572 * @warning This doesn't work with slide(elm_label_slide_set()) or if the
7573 * choosen wrap method was ELM_WRAP_WORD.
7575 EAPI void elm_label_ellipsis_set(Evas_Object *obj, Eina_Bool ellipsis) EINA_ARG_NONNULL(1);
7577 * @brief Set the text slide of the label
7579 * @param obj The label object
7580 * @param slide To start slide or stop
7582 * If set to true, the text of the label will slide/scroll through the length of
7585 * @warning This only works with the themes "slide_short", "slide_long" and
7588 EAPI void elm_label_slide_set(Evas_Object *obj, Eina_Bool slide) EINA_ARG_NONNULL(1);
7590 * @brief Get the text slide mode of the label
7592 * @param obj The label object
7593 * @return slide slide mode value
7595 * @see elm_label_slide_set()
7597 EAPI Eina_Bool elm_label_slide_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
7599 * @brief Set the slide duration(speed) of the label
7601 * @param obj The label object
7602 * @return The duration in seconds in moving text from slide begin position
7603 * to slide end position
7605 EAPI void elm_label_slide_duration_set(Evas_Object *obj, double duration) EINA_ARG_NONNULL(1);
7607 * @brief Get the slide duration(speed) of the label
7609 * @param obj The label object
7610 * @return The duration time in moving text from slide begin position to slide end position
7612 * @see elm_label_slide_duration_set()
7614 EAPI double elm_label_slide_duration_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
7620 * @defgroup Toggle Toggle
7622 * @image html img/widget/toggle/preview-00.png
7623 * @image latex img/widget/toggle/preview-00.eps
7625 * @brief A toggle is a slider which can be used to toggle between
7626 * two values. It has two states: on and off.
7628 * This widget is deprecated. Please use elm_check_add() instead using the
7629 * toggle style like:
7632 * obj = elm_check_add(parent);
7633 * elm_object_style_set(obj, "toggle");
7634 * elm_object_part_text_set(obj, "on", "ON");
7635 * elm_object_part_text_set(obj, "off", "OFF");
7638 * Signals that you can add callbacks for are:
7639 * @li "changed" - Whenever the toggle value has been changed. Is not called
7640 * until the toggle is released by the cursor (assuming it
7641 * has been triggered by the cursor in the first place).
7643 * Default contents parts of the toggle widget that you can use for are:
7644 * @li "icon" - A icon of the toggle
7646 * Default text parts of the toggle widget that you can use for are:
7647 * @li "elm.text" - Label of the toggle
7649 * @ref tutorial_toggle show how to use a toggle.
7653 * @brief Add a toggle to @p parent.
7655 * @param parent The parent object
7657 * @return The toggle object
7659 EINA_DEPRECATED EAPI Evas_Object *elm_toggle_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7661 * @brief Sets the label to be displayed with the toggle.
7663 * @param obj The toggle object
7664 * @param label The label to be displayed
7666 * @deprecated use elm_object_text_set() instead.
7668 EINA_DEPRECATED EAPI void elm_toggle_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
7670 * @brief Gets the label of the toggle
7672 * @param obj toggle object
7673 * @return The label of the toggle
7675 * @deprecated use elm_object_text_get() instead.
7677 EINA_DEPRECATED EAPI const char *elm_toggle_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7679 * @brief Set the icon used for the toggle
7681 * @param obj The toggle object
7682 * @param icon The icon object for the button
7684 * Once the icon object is set, a previously set one will be deleted
7685 * If you want to keep that old content object, use the
7686 * elm_toggle_icon_unset() function.
7688 * @deprecated use elm_object_part_content_set() instead.
7690 EINA_DEPRECATED EAPI void elm_toggle_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
7692 * @brief Get the icon used for the toggle
7694 * @param obj The toggle object
7695 * @return The icon object that is being used
7697 * Return the icon object which is set for this widget.
7699 * @see elm_toggle_icon_set()
7701 * @deprecated use elm_object_part_content_get() instead.
7703 EINA_DEPRECATED EAPI Evas_Object *elm_toggle_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7705 * @brief Unset the icon used for the toggle
7707 * @param obj The toggle object
7708 * @return The icon object that was being used
7710 * Unparent and return the icon object which was set for this widget.
7712 * @see elm_toggle_icon_set()
7714 * @deprecated use elm_object_part_content_unset() instead.
7716 EINA_DEPRECATED EAPI Evas_Object *elm_toggle_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
7718 * @brief Sets the labels to be associated with the on and off states of the toggle.
7720 * @param obj The toggle object
7721 * @param onlabel The label displayed when the toggle is in the "on" state
7722 * @param offlabel The label displayed when the toggle is in the "off" state
7724 * @deprecated use elm_object_part_text_set() for "on" and "off" parts
7727 EINA_DEPRECATED EAPI void elm_toggle_states_labels_set(Evas_Object *obj, const char *onlabel, const char *offlabel) EINA_ARG_NONNULL(1);
7729 * @brief Gets the labels associated with the on and off states of the
7732 * @param obj The toggle object
7733 * @param onlabel A char** to place the onlabel of @p obj into
7734 * @param offlabel A char** to place the offlabel of @p obj into
7736 * @deprecated use elm_object_part_text_get() for "on" and "off" parts
7739 EINA_DEPRECATED EAPI void elm_toggle_states_labels_get(const Evas_Object *obj, const char **onlabel, const char **offlabel) EINA_ARG_NONNULL(1);
7741 * @brief Sets the state of the toggle to @p state.
7743 * @param obj The toggle object
7744 * @param state The state of @p obj
7746 * @deprecated use elm_check_state_set() instead.
7748 EINA_DEPRECATED EAPI void elm_toggle_state_set(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
7750 * @brief Gets the state of the toggle to @p state.
7752 * @param obj The toggle object
7753 * @return The state of @p obj
7755 * @deprecated use elm_check_state_get() instead.
7757 EINA_DEPRECATED EAPI Eina_Bool elm_toggle_state_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7759 * @brief Sets the state pointer of the toggle to @p statep.
7761 * @param obj The toggle object
7762 * @param statep The state pointer of @p obj
7764 * @deprecated use elm_check_state_pointer_set() instead.
7766 EINA_DEPRECATED EAPI void elm_toggle_state_pointer_set(Evas_Object *obj, Eina_Bool *statep) EINA_ARG_NONNULL(1);
7772 * @defgroup Frame Frame
7774 * @image html img/widget/frame/preview-00.png
7775 * @image latex img/widget/frame/preview-00.eps
7777 * @brief Frame is a widget that holds some content and has a title.
7779 * The default look is a frame with a title, but Frame supports multple
7787 * @li outdent_bottom
7789 * Of all this styles only default shows the title. Frame emits no signals.
7791 * Default contents parts of the frame widget that you can use for are:
7792 * @li "default" - A content of the frame
7794 * Default text parts of the frame widget that you can use for are:
7795 * @li "elm.text" - Label of the frame
7797 * For a detailed example see the @ref tutorial_frame.
7802 * @brief Add a new frame to the parent
7804 * @param parent The parent object
7805 * @return The new object or NULL if it cannot be created
7807 EAPI Evas_Object *elm_frame_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7809 * @brief Set the frame label
7811 * @param obj The frame object
7812 * @param label The label of this frame object
7814 * @deprecated use elm_object_text_set() instead.
7816 EINA_DEPRECATED EAPI void elm_frame_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
7818 * @brief Get the frame label
7820 * @param obj The frame object
7822 * @return The label of this frame objet or NULL if unable to get frame
7824 * @deprecated use elm_object_text_get() instead.
7826 EINA_DEPRECATED EAPI const char *elm_frame_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7828 * @brief Set the content of the frame widget
7830 * Once the content object is set, a previously set one will be deleted.
7831 * If you want to keep that old content object, use the
7832 * elm_frame_content_unset() function.
7834 * @param obj The frame object
7835 * @param content The content will be filled in this frame object
7837 * @deprecated use elm_object_content_set() instead.
7839 EINA_DEPRECATED EAPI void elm_frame_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
7841 * @brief Get the content of the frame widget
7843 * Return the content object which is set for this widget
7845 * @param obj The frame object
7846 * @return The content that is being used
7848 * @deprecated use elm_object_content_get() instead.
7850 EINA_DEPRECATED EAPI Evas_Object *elm_frame_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7852 * @brief Unset the content of the frame widget
7854 * Unparent and return the content object which was set for this widget
7856 * @param obj The frame object
7857 * @return The content that was being used
7859 * @deprecated use elm_object_content_unset() instead.
7861 EINA_DEPRECATED EAPI Evas_Object *elm_frame_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
7867 * @defgroup Table Table
7869 * A container widget to arrange other widgets in a table where items can
7870 * also span multiple columns or rows - even overlap (and then be raised or
7871 * lowered accordingly to adjust stacking if they do overlap).
7873 * For a Table widget the row/column count is not fixed.
7874 * The table widget adjusts itself when subobjects are added to it dynamically.
7876 * The followin are examples of how to use a table:
7877 * @li @ref tutorial_table_01
7878 * @li @ref tutorial_table_02
7883 * @brief Add a new table to the parent
7885 * @param parent The parent object
7886 * @return The new object or NULL if it cannot be created
7888 EAPI Evas_Object *elm_table_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7890 * @brief Set the homogeneous layout in the table
7892 * @param obj The layout object
7893 * @param homogeneous A boolean to set if the layout is homogeneous in the
7894 * table (EINA_TRUE = homogeneous, EINA_FALSE = no homogeneous)
7896 EAPI void elm_table_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
7898 * @brief Get the current table homogeneous mode.
7900 * @param obj The table object
7901 * @return A boolean to indicating if the layout is homogeneous in the table
7902 * (EINA_TRUE = homogeneous, EINA_FALSE = no homogeneous)
7904 EAPI Eina_Bool elm_table_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7906 * @brief Set padding between cells.
7908 * @param obj The layout object.
7909 * @param horizontal set the horizontal padding.
7910 * @param vertical set the vertical padding.
7912 * Default value is 0.
7914 EAPI void elm_table_padding_set(Evas_Object *obj, Evas_Coord horizontal, Evas_Coord vertical) EINA_ARG_NONNULL(1);
7916 * @brief Get padding between cells.
7918 * @param obj The layout object.
7919 * @param horizontal set the horizontal padding.
7920 * @param vertical set the vertical padding.
7922 EAPI void elm_table_padding_get(const Evas_Object *obj, Evas_Coord *horizontal, Evas_Coord *vertical) EINA_ARG_NONNULL(1);
7924 * @brief Add a subobject on the table with the coordinates passed
7926 * @param obj The table object
7927 * @param subobj The subobject to be added to the table
7928 * @param x Row number
7929 * @param y Column number
7933 * @note All positioning inside the table is relative to rows and columns, so
7934 * a value of 0 for x and y, means the top left cell of the table, and a
7935 * value of 1 for w and h means @p subobj only takes that 1 cell.
7937 EAPI void elm_table_pack(Evas_Object *obj, Evas_Object *subobj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
7939 * @brief Remove child from table.
7941 * @param obj The table object
7942 * @param subobj The subobject
7944 EAPI void elm_table_unpack(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
7946 * @brief Faster way to remove all child objects from a table object.
7948 * @param obj The table object
7949 * @param clear If true, will delete children, else just remove from table.
7951 EAPI void elm_table_clear(Evas_Object *obj, Eina_Bool clear) EINA_ARG_NONNULL(1);
7953 * @brief Set the packing location of an existing child of the table
7955 * @param subobj The subobject to be modified in the table
7956 * @param x Row number
7957 * @param y Column number
7961 * Modifies the position of an object already in the table.
7963 * @note All positioning inside the table is relative to rows and columns, so
7964 * a value of 0 for x and y, means the top left cell of the table, and a
7965 * value of 1 for w and h means @p subobj only takes that 1 cell.
7967 EAPI void elm_table_pack_set(Evas_Object *subobj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
7969 * @brief Get the packing location of an existing child of the table
7971 * @param subobj The subobject to be modified in the table
7972 * @param x Row number
7973 * @param y Column number
7977 * @see elm_table_pack_set()
7979 EAPI void elm_table_pack_get(Evas_Object *subobj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
7984 /* TEMPORARY: DOCS WILL BE FILLED IN WITH CNP/SED */
7985 typedef struct Elm_Gen_Item Elm_Gen_Item;
7986 typedef struct _Elm_Gen_Item_Class Elm_Gen_Item_Class;
7987 typedef struct _Elm_Gen_Item_Class_Func Elm_Gen_Item_Class_Func; /**< Class functions for gen item classes. */
7988 typedef char *(*Elm_Gen_Item_Label_Get_Cb) (void *data, Evas_Object *obj, const char *part); /**< Label fetching class function for gen item classes. */
7989 typedef Evas_Object *(*Elm_Gen_Item_Content_Get_Cb) (void *data, Evas_Object *obj, const char *part); /**< Content(swallowed object) fetching class function for gen item classes. */
7990 typedef Eina_Bool (*Elm_Gen_Item_State_Get_Cb) (void *data, Evas_Object *obj, const char *part); /**< State fetching class function for gen item classes. */
7991 typedef void (*Elm_Gen_Item_Del_Cb) (void *data, Evas_Object *obj); /**< Deletion class function for gen item classes. */
7992 struct _Elm_Gen_Item_Class
7994 const char *item_style;
7995 struct _Elm_Gen_Item_Class_Func
7997 Elm_Gen_Item_Label_Get_Cb label_get;
7998 Elm_Gen_Item_Content_Get_Cb content_get;
7999 Elm_Gen_Item_State_Get_Cb state_get;
8000 Elm_Gen_Item_Del_Cb del;
8003 EINA_DEPRECATED EAPI void elm_gen_clear(Evas_Object *obj);
8004 EINA_DEPRECATED EAPI void elm_gen_item_selected_set(Elm_Gen_Item *it, Eina_Bool selected);
8005 EINA_DEPRECATED EAPI Eina_Bool elm_gen_item_selected_get(const Elm_Gen_Item *it);
8006 EINA_DEPRECATED EAPI void elm_gen_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select);
8007 EINA_DEPRECATED EAPI Eina_Bool elm_gen_always_select_mode_get(const Evas_Object *obj);
8008 EINA_DEPRECATED EAPI void elm_gen_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select);
8009 EINA_DEPRECATED EAPI Eina_Bool elm_gen_no_select_mode_get(const Evas_Object *obj);
8010 EINA_DEPRECATED EAPI void elm_gen_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce);
8011 EINA_DEPRECATED EAPI void elm_gen_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce);
8012 EINA_DEPRECATED EAPI void elm_gen_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel);
8013 EINA_DEPRECATED EAPI void elm_gen_page_relative_get(const Evas_Object *obj, double *h_pagerel, double *v_pagerel);
8015 EINA_DEPRECATED EAPI void elm_gen_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize);
8016 EINA_DEPRECATED EAPI void elm_gen_current_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber);
8017 EINA_DEPRECATED EAPI void elm_gen_last_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber);
8018 EINA_DEPRECATED EAPI void elm_gen_page_show(const Evas_Object *obj, int h_pagenumber, int v_pagenumber);
8019 EINA_DEPRECATED EAPI void elm_gen_page_bring_in(const Evas_Object *obj, int h_pagenumber, int v_pagenumber);
8020 EINA_DEPRECATED EAPI Elm_Gen_Item *elm_gen_first_item_get(const Evas_Object *obj);
8021 EINA_DEPRECATED EAPI Elm_Gen_Item *elm_gen_last_item_get(const Evas_Object *obj);
8022 EINA_DEPRECATED EAPI Elm_Gen_Item *elm_gen_item_next_get(const Elm_Gen_Item *it);
8023 EINA_DEPRECATED EAPI Elm_Gen_Item *elm_gen_item_prev_get(const Elm_Gen_Item *it);
8024 EINA_DEPRECATED EAPI Evas_Object *elm_gen_item_widget_get(const Elm_Gen_Item *it);
8027 * @defgroup Gengrid Gengrid (Generic grid)
8029 * This widget aims to position objects in a grid layout while
8030 * actually creating and rendering only the visible ones, using the
8031 * same idea as the @ref Genlist "genlist": the user defines a @b
8032 * class for each item, specifying functions that will be called at
8033 * object creation, deletion, etc. When those items are selected by
8034 * the user, a callback function is issued. Users may interact with
8035 * a gengrid via the mouse (by clicking on items to select them and
8036 * clicking on the grid's viewport and swiping to pan the whole
8037 * view) or via the keyboard, navigating through item with the
8040 * @section Gengrid_Layouts Gengrid layouts
8042 * Gengrid may layout its items in one of two possible layouts:
8046 * When in "horizontal mode", items will be placed in @b columns,
8047 * from top to bottom and, when the space for a column is filled,
8048 * another one is started on the right, thus expanding the grid
8049 * horizontally, making for horizontal scrolling. When in "vertical
8050 * mode" , though, items will be placed in @b rows, from left to
8051 * right and, when the space for a row is filled, another one is
8052 * started below, thus expanding the grid vertically (and making
8053 * for vertical scrolling).
8055 * @section Gengrid_Items Gengrid items
8057 * An item in a gengrid can have 0 or more text labels (they can be
8058 * regular text or textblock Evas objects - that's up to the style
8059 * to determine), 0 or more icons (which are simply objects
8060 * swallowed into the gengrid item's theming Edje object) and 0 or
8061 * more <b>boolean states</b>, which have the behavior left to the
8062 * user to define. The Edje part names for each of these properties
8063 * will be looked up, in the theme file for the gengrid, under the
8064 * Edje (string) data items named @c "labels", @c "icons" and @c
8065 * "states", respectively. For each of those properties, if more
8066 * than one part is provided, they must have names listed separated
8067 * by spaces in the data fields. For the default gengrid item
8068 * theme, we have @b one label part (@c "elm.text"), @b two icon
8069 * parts (@c "elm.swalllow.icon" and @c "elm.swallow.end") and @b
8072 * A gengrid item may be at one of several styles. Elementary
8073 * provides one by default - "default", but this can be extended by
8074 * system or application custom themes/overlays/extensions (see
8075 * @ref Theme "themes" for more details).
8077 * @section Gengrid_Item_Class Gengrid item classes
8079 * In order to have the ability to add and delete items on the fly,
8080 * gengrid implements a class (callback) system where the
8081 * application provides a structure with information about that
8082 * type of item (gengrid may contain multiple different items with
8083 * different classes, states and styles). Gengrid will call the
8084 * functions in this struct (methods) when an item is "realized"
8085 * (i.e., created dynamically, while the user is scrolling the
8086 * grid). All objects will simply be deleted when no longer needed
8087 * with evas_object_del(). The #Elm_GenGrid_Item_Class structure
8088 * contains the following members:
8089 * - @c item_style - This is a constant string and simply defines
8090 * the name of the item style. It @b must be specified and the
8091 * default should be @c "default".
8092 * - @c func.label_get - This function is called when an item
8093 * object is actually created. The @c data parameter will point to
8094 * the same data passed to elm_gengrid_item_append() and related
8095 * item creation functions. The @c obj parameter is the gengrid
8096 * object itself, while the @c part one is the name string of one
8097 * of the existing text parts in the Edje group implementing the
8098 * item's theme. This function @b must return a strdup'()ed string,
8099 * as the caller will free() it when done. See
8100 * #Elm_Gengrid_Item_Label_Get_Cb.
8101 * - @c func.content_get - This function is called when an item object
8102 * is actually created. The @c data parameter will point to the
8103 * same data passed to elm_gengrid_item_append() and related item
8104 * creation functions. The @c obj parameter is the gengrid object
8105 * itself, while the @c part one is the name string of one of the
8106 * existing (content) swallow parts in the Edje group implementing the
8107 * item's theme. It must return @c NULL, when no content is desired,
8108 * or a valid object handle, otherwise. The object will be deleted
8109 * by the gengrid on its deletion or when the item is "unrealized".
8110 * See #Elm_Gengrid_Item_Content_Get_Cb.
8111 * - @c func.state_get - This function is called when an item
8112 * object is actually created. The @c data parameter will point to
8113 * the same data passed to elm_gengrid_item_append() and related
8114 * item creation functions. The @c obj parameter is the gengrid
8115 * object itself, while the @c part one is the name string of one
8116 * of the state parts in the Edje group implementing the item's
8117 * theme. Return @c EINA_FALSE for false/off or @c EINA_TRUE for
8118 * true/on. Gengrids will emit a signal to its theming Edje object
8119 * with @c "elm,state,XXX,active" and @c "elm" as "emission" and
8120 * "source" arguments, respectively, when the state is true (the
8121 * default is false), where @c XXX is the name of the (state) part.
8122 * See #Elm_Gengrid_Item_State_Get_Cb.
8123 * - @c func.del - This is called when elm_gengrid_item_del() is
8124 * called on an item or elm_gengrid_clear() is called on the
8125 * gengrid. This is intended for use when gengrid items are
8126 * deleted, so any data attached to the item (e.g. its data
8127 * parameter on creation) can be deleted. See #Elm_Gengrid_Item_Del_Cb.
8129 * @section Gengrid_Usage_Hints Usage hints
8131 * If the user wants to have multiple items selected at the same
8132 * time, elm_gengrid_multi_select_set() will permit it. If the
8133 * gengrid is single-selection only (the default), then
8134 * elm_gengrid_select_item_get() will return the selected item or
8135 * @c NULL, if none is selected. If the gengrid is under
8136 * multi-selection, then elm_gengrid_selected_items_get() will
8137 * return a list (that is only valid as long as no items are
8138 * modified (added, deleted, selected or unselected) of child items
8141 * If an item changes (internal (boolean) state, label or content
8142 * changes), then use elm_gengrid_item_update() to have gengrid
8143 * update the item with the new state. A gengrid will re-"realize"
8144 * the item, thus calling the functions in the
8145 * #Elm_Gengrid_Item_Class set for that item.
8147 * To programmatically (un)select an item, use
8148 * elm_gengrid_item_selected_set(). To get its selected state use
8149 * elm_gengrid_item_selected_get(). To make an item disabled
8150 * (unable to be selected and appear differently) use
8151 * elm_gengrid_item_disabled_set() to set this and
8152 * elm_gengrid_item_disabled_get() to get the disabled state.
8154 * Grid cells will only have their selection smart callbacks called
8155 * when firstly getting selected. Any further clicks will do
8156 * nothing, unless you enable the "always select mode", with
8157 * elm_gengrid_always_select_mode_set(), thus making every click to
8158 * issue selection callbacks. elm_gengrid_no_select_mode_set() will
8159 * turn off the ability to select items entirely in the widget and
8160 * they will neither appear selected nor call the selection smart
8163 * Remember that you can create new styles and add your own theme
8164 * augmentation per application with elm_theme_extension_add(). If
8165 * you absolutely must have a specific style that overrides any
8166 * theme the user or system sets up you can use
8167 * elm_theme_overlay_add() to add such a file.
8169 * @section Gengrid_Smart_Events Gengrid smart events
8171 * Smart events that you can add callbacks for are:
8172 * - @c "activated" - The user has double-clicked or pressed
8173 * (enter|return|spacebar) on an item. The @c event_info parameter
8174 * is the gengrid item that was activated.
8175 * - @c "clicked,double" - The user has double-clicked an item.
8176 * The @c event_info parameter is the gengrid item that was double-clicked.
8177 * - @c "longpressed" - This is called when the item is pressed for a certain
8178 * amount of time. By default it's 1 second.
8179 * - @c "selected" - The user has made an item selected. The
8180 * @c event_info parameter is the gengrid item that was selected.
8181 * - @c "unselected" - The user has made an item unselected. The
8182 * @c event_info parameter is the gengrid item that was unselected.
8183 * - @c "realized" - This is called when the item in the gengrid
8184 * has its implementing Evas object instantiated, de facto. @c
8185 * event_info is the gengrid item that was created. The object
8186 * may be deleted at any time, so it is highly advised to the
8187 * caller @b not to use the object pointer returned from
8188 * elm_gengrid_item_object_get(), because it may point to freed
8190 * - @c "unrealized" - This is called when the implementing Evas
8191 * object for this item is deleted. @c event_info is the gengrid
8192 * item that was deleted.
8193 * - @c "changed" - Called when an item is added, removed, resized
8194 * or moved and when the gengrid is resized or gets "horizontal"
8196 * - @c "scroll,anim,start" - This is called when scrolling animation has
8198 * - @c "scroll,anim,stop" - This is called when scrolling animation has
8200 * - @c "drag,start,up" - Called when the item in the gengrid has
8201 * been dragged (not scrolled) up.
8202 * - @c "drag,start,down" - Called when the item in the gengrid has
8203 * been dragged (not scrolled) down.
8204 * - @c "drag,start,left" - Called when the item in the gengrid has
8205 * been dragged (not scrolled) left.
8206 * - @c "drag,start,right" - Called when the item in the gengrid has
8207 * been dragged (not scrolled) right.
8208 * - @c "drag,stop" - Called when the item in the gengrid has
8209 * stopped being dragged.
8210 * - @c "drag" - Called when the item in the gengrid is being
8212 * - @c "scroll" - called when the content has been scrolled
8214 * - @c "scroll,drag,start" - called when dragging the content has
8216 * - @c "scroll,drag,stop" - called when dragging the content has
8218 * - @c "edge,top" - This is called when the gengrid is scrolled until
8220 * - @c "edge,bottom" - This is called when the gengrid is scrolled
8221 * until the bottom edge.
8222 * - @c "edge,left" - This is called when the gengrid is scrolled
8223 * until the left edge.
8224 * - @c "edge,right" - This is called when the gengrid is scrolled
8225 * until the right edge.
8227 * List of gengrid examples:
8228 * @li @ref gengrid_example
8232 * @addtogroup Gengrid
8236 typedef struct _Elm_Gengrid_Item_Class Elm_Gengrid_Item_Class; /**< Gengrid item class definition structs */
8237 #define Elm_Gengrid_Item_Class Elm_Gen_Item_Class
8238 typedef struct _Elm_Gengrid_Item Elm_Gengrid_Item; /**< Gengrid item handles */
8239 #define Elm_Gengrid_Item Elm_Gen_Item /**< Item of Elm_Genlist. Sub-type of Elm_Widget_Item */
8240 typedef struct _Elm_Gengrid_Item_Class_Func Elm_Gengrid_Item_Class_Func; /**< Class functions for gengrid item classes. */
8242 * Label fetching class function for Elm_Gen_Item_Class.
8243 * @param data The data passed in the item creation function
8244 * @param obj The base widget object
8245 * @param part The part name of the swallow
8246 * @return The allocated (NOT stringshared) string to set as the label
8248 typedef char *(*Elm_Gengrid_Item_Label_Get_Cb) (void *data, Evas_Object *obj, const char *part);
8250 * Content (swallowed object) fetching class function for Elm_Gen_Item_Class.
8251 * @param data The data passed in the item creation function
8252 * @param obj The base widget object
8253 * @param part The part name of the swallow
8254 * @return The content object to swallow
8256 typedef Evas_Object *(*Elm_Gengrid_Item_Content_Get_Cb) (void *data, Evas_Object *obj, const char *part);
8258 * State fetching class function for Elm_Gen_Item_Class.
8259 * @param data The data passed in the item creation function
8260 * @param obj The base widget object
8261 * @param part The part name of the swallow
8262 * @return The hell if I know
8264 typedef Eina_Bool (*Elm_Gengrid_Item_State_Get_Cb) (void *data, Evas_Object *obj, const char *part);
8266 * Deletion class function for Elm_Gen_Item_Class.
8267 * @param data The data passed in the item creation function
8268 * @param obj The base widget object
8270 typedef void (*Elm_Gengrid_Item_Del_Cb) (void *data, Evas_Object *obj);
8273 * @struct _Elm_Gengrid_Item_Class
8275 * Gengrid item class definition. See @ref Gengrid_Item_Class for
8278 struct _Elm_Gengrid_Item_Class
8280 const char *item_style;
8281 struct _Elm_Gengrid_Item_Class_Func
8283 Elm_Gengrid_Item_Label_Get_Cb label_get;
8284 Elm_Gengrid_Item_Content_Get_Cb content_get;
8285 Elm_Gengrid_Item_State_Get_Cb state_get;
8286 Elm_Gengrid_Item_Del_Cb del;
8288 }; /**< #Elm_Gengrid_Item_Class member definitions */
8289 #define Elm_Gengrid_Item_Class_Func Elm_Gen_Item_Class_Func
8291 * Add a new gengrid widget to the given parent Elementary
8292 * (container) object
8294 * @param parent The parent object
8295 * @return a new gengrid widget handle or @c NULL, on errors
8297 * This function inserts a new gengrid widget on the canvas.
8299 * @see elm_gengrid_item_size_set()
8300 * @see elm_gengrid_group_item_size_set()
8301 * @see elm_gengrid_horizontal_set()
8302 * @see elm_gengrid_item_append()
8303 * @see elm_gengrid_item_del()
8304 * @see elm_gengrid_clear()
8308 EAPI Evas_Object *elm_gengrid_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
8311 * Set the size for the items of a given gengrid widget
8313 * @param obj The gengrid object.
8314 * @param w The items' width.
8315 * @param h The items' height;
8317 * A gengrid, after creation, has still no information on the size
8318 * to give to each of its cells. So, you most probably will end up
8319 * with squares one @ref Fingers "finger" wide, the default
8320 * size. Use this function to force a custom size for you items,
8321 * making them as big as you wish.
8323 * @see elm_gengrid_item_size_get()
8327 EAPI void elm_gengrid_item_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
8330 * Get the size set for the items of a given gengrid widget
8332 * @param obj The gengrid object.
8333 * @param w Pointer to a variable where to store the items' width.
8334 * @param h Pointer to a variable where to store the items' height.
8336 * @note Use @c NULL pointers on the size values you're not
8337 * interested in: they'll be ignored by the function.
8339 * @see elm_gengrid_item_size_get() for more details
8343 EAPI void elm_gengrid_item_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
8346 * Set the size for the group items of a given gengrid widget
8348 * @param obj The gengrid object.
8349 * @param w The group items' width.
8350 * @param h The group items' height;
8352 * A gengrid, after creation, has still no information on the size
8353 * to give to each of its cells. So, you most probably will end up
8354 * with squares one @ref Fingers "finger" wide, the default
8355 * size. Use this function to force a custom size for you group items,
8356 * making them as big as you wish.
8358 * @see elm_gengrid_group_item_size_get()
8362 EAPI void elm_gengrid_group_item_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
8365 * Get the size set for the group items of a given gengrid widget
8367 * @param obj The gengrid object.
8368 * @param w Pointer to a variable where to store the group items' width.
8369 * @param h Pointer to a variable where to store the group items' height.
8371 * @note Use @c NULL pointers on the size values you're not
8372 * interested in: they'll be ignored by the function.
8374 * @see elm_gengrid_group_item_size_get() for more details
8378 EAPI void elm_gengrid_group_item_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
8381 * Set the items grid's alignment within a given gengrid widget
8383 * @param obj The gengrid object.
8384 * @param align_x Alignment in the horizontal axis (0 <= align_x <= 1).
8385 * @param align_y Alignment in the vertical axis (0 <= align_y <= 1).
8387 * This sets the alignment of the whole grid of items of a gengrid
8388 * within its given viewport. By default, those values are both
8389 * 0.5, meaning that the gengrid will have its items grid placed
8390 * exactly in the middle of its viewport.
8392 * @note If given alignment values are out of the cited ranges,
8393 * they'll be changed to the nearest boundary values on the valid
8396 * @see elm_gengrid_align_get()
8400 EAPI void elm_gengrid_align_set(Evas_Object *obj, double align_x, double align_y) EINA_ARG_NONNULL(1);
8403 * Get the items grid's alignment values within a given gengrid
8406 * @param obj The gengrid object.
8407 * @param align_x Pointer to a variable where to store the
8408 * horizontal alignment.
8409 * @param align_y Pointer to a variable where to store the vertical
8412 * @note Use @c NULL pointers on the alignment values you're not
8413 * interested in: they'll be ignored by the function.
8415 * @see elm_gengrid_align_set() for more details
8419 EAPI void elm_gengrid_align_get(const Evas_Object *obj, double *align_x, double *align_y) EINA_ARG_NONNULL(1);
8422 * Set whether a given gengrid widget is or not able have items
8425 * @param obj The gengrid object
8426 * @param reorder_mode Use @c EINA_TRUE to turn reoderding on,
8427 * @c EINA_FALSE to turn it off
8429 * If a gengrid is set to allow reordering, a click held for more
8430 * than 0.5 over a given item will highlight it specially,
8431 * signalling the gengrid has entered the reordering state. From
8432 * that time on, the user will be able to, while still holding the
8433 * mouse button down, move the item freely in the gengrid's
8434 * viewport, replacing to said item to the locations it goes to.
8435 * The replacements will be animated and, whenever the user
8436 * releases the mouse button, the item being replaced gets a new
8437 * definitive place in the grid.
8439 * @see elm_gengrid_reorder_mode_get()
8443 EAPI void elm_gengrid_reorder_mode_set(Evas_Object *obj, Eina_Bool reorder_mode) EINA_ARG_NONNULL(1);
8446 * Get whether a given gengrid widget is or not able have items
8449 * @param obj The gengrid object
8450 * @return @c EINA_TRUE, if reoderding is on, @c EINA_FALSE if it's
8453 * @see elm_gengrid_reorder_mode_set() for more details
8457 EAPI Eina_Bool elm_gengrid_reorder_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8460 * Append a new item in a given gengrid widget.
8462 * @param obj The gengrid object.
8463 * @param gic The item class for the item.
8464 * @param data The item data.
8465 * @param func Convenience function called when the item is
8467 * @param func_data Data to be passed to @p func.
8468 * @return A handle to the item added or @c NULL, on errors.
8470 * This adds an item to the beginning of the gengrid.
8472 * @see elm_gengrid_item_prepend()
8473 * @see elm_gengrid_item_insert_before()
8474 * @see elm_gengrid_item_insert_after()
8475 * @see elm_gengrid_item_del()
8479 EAPI Elm_Gengrid_Item *elm_gengrid_item_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);
8482 * Prepend a new item in a given gengrid widget.
8484 * @param obj The gengrid object.
8485 * @param gic The item class for the item.
8486 * @param data The item data.
8487 * @param func Convenience function called when the item is
8489 * @param func_data Data to be passed to @p func.
8490 * @return A handle to the item added or @c NULL, on errors.
8492 * This adds an item to the end of the gengrid.
8494 * @see elm_gengrid_item_append()
8495 * @see elm_gengrid_item_insert_before()
8496 * @see elm_gengrid_item_insert_after()
8497 * @see elm_gengrid_item_del()
8501 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);
8504 * Insert an item before another in a gengrid widget
8506 * @param obj The gengrid object.
8507 * @param gic The item class for the item.
8508 * @param data The item data.
8509 * @param relative The item to place this new one before.
8510 * @param func Convenience function called when the item is
8512 * @param func_data Data to be passed to @p func.
8513 * @return A handle to the item added or @c NULL, on errors.
8515 * This inserts an item before another in the gengrid.
8517 * @see elm_gengrid_item_append()
8518 * @see elm_gengrid_item_prepend()
8519 * @see elm_gengrid_item_insert_after()
8520 * @see elm_gengrid_item_del()
8524 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);
8527 * Insert an item after another in a gengrid widget
8529 * @param obj The gengrid object.
8530 * @param gic The item class for the item.
8531 * @param data The item data.
8532 * @param relative The item to place this new one after.
8533 * @param func Convenience function called when the item is
8535 * @param func_data Data to be passed to @p func.
8536 * @return A handle to the item added or @c NULL, on errors.
8538 * This inserts an item after another in the gengrid.
8540 * @see elm_gengrid_item_append()
8541 * @see elm_gengrid_item_prepend()
8542 * @see elm_gengrid_item_insert_after()
8543 * @see elm_gengrid_item_del()
8547 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);
8550 * Insert an item in a gengrid widget using a user-defined sort function.
8552 * @param obj The gengrid object.
8553 * @param gic The item class for the item.
8554 * @param data The item data.
8555 * @param comp User defined comparison function that defines the sort order based on
8556 * Elm_Gen_Item and its data param.
8557 * @param func Convenience function called when the item is selected.
8558 * @param func_data Data to be passed to @p func.
8559 * @return A handle to the item added or @c NULL, on errors.
8561 * This inserts an item in the gengrid based on user defined comparison function.
8563 * @see elm_gengrid_item_append()
8564 * @see elm_gengrid_item_prepend()
8565 * @see elm_gengrid_item_insert_after()
8566 * @see elm_gengrid_item_del()
8567 * @see elm_gengrid_item_direct_sorted_insert()
8571 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);
8574 * Insert an item in a gengrid widget using a user-defined sort function.
8576 * @param obj The gengrid object.
8577 * @param gic The item class for the item.
8578 * @param data The item data.
8579 * @param comp User defined comparison function that defines the sort order based on
8581 * @param func Convenience function called when the item is selected.
8582 * @param func_data Data to be passed to @p func.
8583 * @return A handle to the item added or @c NULL, on errors.
8585 * This inserts an item in the gengrid based on user defined comparison function.
8587 * @see elm_gengrid_item_append()
8588 * @see elm_gengrid_item_prepend()
8589 * @see elm_gengrid_item_insert_after()
8590 * @see elm_gengrid_item_del()
8591 * @see elm_gengrid_item_sorted_insert()
8595 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);
8598 * Set whether items on a given gengrid widget are to get their
8599 * selection callbacks issued for @b every subsequent selection
8600 * click on them or just for the first click.
8602 * @param obj The gengrid object
8603 * @param always_select @c EINA_TRUE to make items "always
8604 * selected", @c EINA_FALSE, otherwise
8606 * By default, grid items will only call their selection callback
8607 * function when firstly getting selected, any subsequent further
8608 * clicks will do nothing. With this call, you make those
8609 * subsequent clicks also to issue the selection callbacks.
8611 * @note <b>Double clicks</b> will @b always be reported on items.
8613 * @see elm_gengrid_always_select_mode_get()
8617 EAPI void elm_gengrid_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
8620 * Get whether items on a given gengrid widget have their selection
8621 * callbacks issued for @b every subsequent selection click on them
8622 * or just for the first click.
8624 * @param obj The gengrid object.
8625 * @return @c EINA_TRUE if the gengrid items are "always selected",
8626 * @c EINA_FALSE, otherwise
8628 * @see elm_gengrid_always_select_mode_set() for more details
8632 EAPI Eina_Bool elm_gengrid_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8635 * Set whether items on a given gengrid widget can be selected or not.
8637 * @param obj The gengrid object
8638 * @param no_select @c EINA_TRUE to make items selectable,
8639 * @c EINA_FALSE otherwise
8641 * This will make items in @p obj selectable or not. In the latter
8642 * case, any user interaction on the gengrid items will neither make
8643 * them appear selected nor them call their selection callback
8646 * @see elm_gengrid_no_select_mode_get()
8650 EAPI void elm_gengrid_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
8653 * Get whether items on a given gengrid widget can be selected or
8656 * @param obj The gengrid object
8657 * @return @c EINA_TRUE, if items are selectable, @c EINA_FALSE
8660 * @see elm_gengrid_no_select_mode_set() for more details
8664 EAPI Eina_Bool elm_gengrid_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8667 * Enable or disable multi-selection in a given gengrid widget
8669 * @param obj The gengrid object.
8670 * @param multi @c EINA_TRUE, to enable multi-selection,
8671 * @c EINA_FALSE to disable it.
8673 * Multi-selection is the ability to have @b more than one
8674 * item selected, on a given gengrid, simultaneously. When it is
8675 * enabled, a sequence of clicks on different items will make them
8676 * all selected, progressively. A click on an already selected item
8677 * will unselect it. If interacting via the keyboard,
8678 * multi-selection is enabled while holding the "Shift" key.
8680 * @note By default, multi-selection is @b disabled on gengrids
8682 * @see elm_gengrid_multi_select_get()
8686 EAPI void elm_gengrid_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
8689 * Get whether multi-selection is enabled or disabled for a given
8692 * @param obj The gengrid object.
8693 * @return @c EINA_TRUE, if multi-selection is enabled, @c
8694 * EINA_FALSE otherwise
8696 * @see elm_gengrid_multi_select_set() for more details
8700 EAPI Eina_Bool elm_gengrid_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8703 * Enable or disable bouncing effect for a given gengrid widget
8705 * @param obj The gengrid object
8706 * @param h_bounce @c EINA_TRUE, to enable @b horizontal bouncing,
8707 * @c EINA_FALSE to disable it
8708 * @param v_bounce @c EINA_TRUE, to enable @b vertical bouncing,
8709 * @c EINA_FALSE to disable it
8711 * The bouncing effect occurs whenever one reaches the gengrid's
8712 * edge's while panning it -- it will scroll past its limits a
8713 * little bit and return to the edge again, in a animated for,
8716 * @note By default, gengrids have bouncing enabled on both axis
8718 * @see elm_gengrid_bounce_get()
8722 EAPI void elm_gengrid_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
8725 * Get whether bouncing effects are enabled or disabled, for a
8726 * given gengrid widget, on each axis
8728 * @param obj The gengrid object
8729 * @param h_bounce Pointer to a variable where to store the
8730 * horizontal bouncing flag.
8731 * @param v_bounce Pointer to a variable where to store the
8732 * vertical bouncing flag.
8734 * @see elm_gengrid_bounce_set() for more details
8738 EAPI void elm_gengrid_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
8741 * Set a given gengrid widget's scrolling page size, relative to
8742 * its viewport size.
8744 * @param obj The gengrid object
8745 * @param h_pagerel The horizontal page (relative) size
8746 * @param v_pagerel The vertical page (relative) size
8748 * The gengrid's scroller is capable of binding scrolling by the
8749 * user to "pages". It means that, while scrolling and, specially
8750 * after releasing the mouse button, the grid will @b snap to the
8751 * nearest displaying page's area. When page sizes are set, the
8752 * grid's continuous content area is split into (equal) page sized
8755 * This function sets the size of a page <b>relatively to the
8756 * viewport dimensions</b> of the gengrid, for each axis. A value
8757 * @c 1.0 means "the exact viewport's size", in that axis, while @c
8758 * 0.0 turns paging off in that axis. Likewise, @c 0.5 means "half
8759 * a viewport". Sane usable values are, than, between @c 0.0 and @c
8760 * 1.0. Values beyond those will make it behave behave
8761 * inconsistently. If you only want one axis to snap to pages, use
8762 * the value @c 0.0 for the other one.
8764 * There is a function setting page size values in @b absolute
8765 * values, too -- elm_gengrid_page_size_set(). Naturally, its use
8766 * is mutually exclusive to this one.
8768 * @see elm_gengrid_page_relative_get()
8772 EAPI void elm_gengrid_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel) EINA_ARG_NONNULL(1);
8775 * Get a given gengrid widget's scrolling page size, relative to
8776 * its viewport size.
8778 * @param obj The gengrid object
8779 * @param h_pagerel Pointer to a variable where to store the
8780 * horizontal page (relative) size
8781 * @param v_pagerel Pointer to a variable where to store the
8782 * vertical page (relative) size
8784 * @see elm_gengrid_page_relative_set() for more details
8788 EAPI void elm_gengrid_page_relative_get(const Evas_Object *obj, double *h_pagerel, double *v_pagerel) EINA_ARG_NONNULL(1);
8791 * Set a given gengrid widget's scrolling page size
8793 * @param obj The gengrid object
8794 * @param h_pagerel The horizontal page size, in pixels
8795 * @param v_pagerel The vertical page size, in pixels
8797 * The gengrid's scroller is capable of binding scrolling by the
8798 * user to "pages". It means that, while scrolling and, specially
8799 * after releasing the mouse button, the grid will @b snap to the
8800 * nearest displaying page's area. When page sizes are set, the
8801 * grid's continuous content area is split into (equal) page sized
8804 * This function sets the size of a page of the gengrid, in pixels,
8805 * for each axis. Sane usable values are, between @c 0 and the
8806 * dimensions of @p obj, for each axis. Values beyond those will
8807 * make it behave behave inconsistently. If you only want one axis
8808 * to snap to pages, use the value @c 0 for the other one.
8810 * There is a function setting page size values in @b relative
8811 * values, too -- elm_gengrid_page_relative_set(). Naturally, its
8812 * use is mutually exclusive to this one.
8816 EAPI void elm_gengrid_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize) EINA_ARG_NONNULL(1);
8819 * @brief Get gengrid current page number.
8821 * @param obj The gengrid object
8822 * @param h_pagenumber The horizontal page number
8823 * @param v_pagenumber The vertical page number
8825 * The page number starts from 0. 0 is the first page.
8826 * Current page means the page which meet the top-left of the viewport.
8827 * If there are two or more pages in the viewport, it returns the number of page
8828 * which meet the top-left of the viewport.
8830 * @see elm_gengrid_last_page_get()
8831 * @see elm_gengrid_page_show()
8832 * @see elm_gengrid_page_brint_in()
8834 EAPI void elm_gengrid_current_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber) EINA_ARG_NONNULL(1);
8837 * @brief Get scroll last page number.
8839 * @param obj The gengrid object
8840 * @param h_pagenumber The horizontal page number
8841 * @param v_pagenumber The vertical page number
8843 * The page number starts from 0. 0 is the first page.
8844 * This returns the last page number among the pages.
8846 * @see elm_gengrid_current_page_get()
8847 * @see elm_gengrid_page_show()
8848 * @see elm_gengrid_page_brint_in()
8850 EAPI void elm_gengrid_last_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber) EINA_ARG_NONNULL(1);
8853 * Show a specific virtual region within the gengrid content object by page number.
8855 * @param obj The gengrid object
8856 * @param h_pagenumber The horizontal page number
8857 * @param v_pagenumber The vertical page number
8859 * 0, 0 of the indicated page is located at the top-left of the viewport.
8860 * This will jump to the page directly without animation.
8865 * sc = elm_gengrid_add(win);
8866 * elm_gengrid_content_set(sc, content);
8867 * elm_gengrid_page_relative_set(sc, 1, 0);
8868 * elm_gengrid_current_page_get(sc, &h_page, &v_page);
8869 * elm_gengrid_page_show(sc, h_page + 1, v_page);
8872 * @see elm_gengrid_page_bring_in()
8874 EAPI void elm_gengrid_page_show(const Evas_Object *obj, int h_pagenumber, int v_pagenumber) EINA_ARG_NONNULL(1);
8877 * Show a specific virtual region within the gengrid content object by page number.
8879 * @param obj The gengrid object
8880 * @param h_pagenumber The horizontal page number
8881 * @param v_pagenumber The vertical page number
8883 * 0, 0 of the indicated page is located at the top-left of the viewport.
8884 * This will slide to the page with animation.
8889 * sc = elm_gengrid_add(win);
8890 * elm_gengrid_content_set(sc, content);
8891 * elm_gengrid_page_relative_set(sc, 1, 0);
8892 * elm_gengrid_last_page_get(sc, &h_page, &v_page);
8893 * elm_gengrid_page_bring_in(sc, h_page, v_page);
8896 * @see elm_gengrid_page_show()
8898 EAPI void elm_gengrid_page_bring_in(const Evas_Object *obj, int h_pagenumber, int v_pagenumber) EINA_ARG_NONNULL(1);
8901 * Set the direction in which a given gengrid widget will expand while
8902 * placing its items.
8904 * @param obj The gengrid object.
8905 * @param setting @c EINA_TRUE to make the gengrid expand
8906 * horizontally, @c EINA_FALSE to expand vertically.
8908 * When in "horizontal mode" (@c EINA_TRUE), items will be placed
8909 * in @b columns, from top to bottom and, when the space for a
8910 * column is filled, another one is started on the right, thus
8911 * expanding the grid horizontally. When in "vertical mode"
8912 * (@c EINA_FALSE), though, items will be placed in @b rows, from left
8913 * to right and, when the space for a row is filled, another one is
8914 * started below, thus expanding the grid vertically.
8916 * @see elm_gengrid_horizontal_get()
8920 EAPI void elm_gengrid_horizontal_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
8923 * Get for what direction a given gengrid widget will expand while
8924 * placing its items.
8926 * @param obj The gengrid object.
8927 * @return @c EINA_TRUE, if @p obj is set to expand horizontally,
8928 * @c EINA_FALSE if it's set to expand vertically.
8930 * @see elm_gengrid_horizontal_set() for more detais
8934 EAPI Eina_Bool elm_gengrid_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8937 * Get the first item in a given gengrid widget
8939 * @param obj The gengrid object
8940 * @return The first item's handle or @c NULL, if there are no
8941 * items in @p obj (and on errors)
8943 * This returns the first item in the @p obj's internal list of
8946 * @see elm_gengrid_last_item_get()
8950 EAPI Elm_Gengrid_Item *elm_gengrid_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8953 * Get the last item in a given gengrid widget
8955 * @param obj The gengrid object
8956 * @return The last item's handle or @c NULL, if there are no
8957 * items in @p obj (and on errors)
8959 * This returns the last item in the @p obj's internal list of
8962 * @see elm_gengrid_first_item_get()
8966 EAPI Elm_Gengrid_Item *elm_gengrid_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8969 * Get the @b next item in a gengrid widget's internal list of items,
8970 * given a handle to one of those items.
8972 * @param item The gengrid item to fetch next from
8973 * @return The item after @p item, or @c NULL if there's none (and
8976 * This returns the item placed after the @p item, on the container
8979 * @see elm_gengrid_item_prev_get()
8983 EAPI Elm_Gengrid_Item *elm_gengrid_item_next_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8986 * Get the @b previous item in a gengrid widget's internal list of items,
8987 * given a handle to one of those items.
8989 * @param item The gengrid item to fetch previous from
8990 * @return The item before @p item, or @c NULL if there's none (and
8993 * This returns the item placed before the @p item, on the container
8996 * @see elm_gengrid_item_next_get()
9000 EAPI Elm_Gengrid_Item *elm_gengrid_item_prev_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9003 * Get the gengrid object's handle which contains a given gengrid
9006 * @param item The item to fetch the container from
9007 * @return The gengrid (parent) object
9009 * This returns the gengrid object itself that an item belongs to.
9013 EAPI Evas_Object *elm_gengrid_item_gengrid_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9016 * Remove a gengrid item from its parent, deleting it.
9018 * @param item The item to be removed.
9019 * @return @c EINA_TRUE on success or @c EINA_FALSE, otherwise.
9021 * @see elm_gengrid_clear(), to remove all items in a gengrid at
9026 EAPI void elm_gengrid_item_del(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9029 * Update the contents of a given gengrid item
9031 * @param item The gengrid item
9033 * This updates an item by calling all the item class functions
9034 * again to get the contents, labels and states. Use this when the
9035 * original item data has changed and you want the changes to be
9040 EAPI void elm_gengrid_item_update(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9043 * Get the Gengrid Item class for the given Gengrid Item.
9045 * @param item The gengrid item
9047 * This returns the Gengrid_Item_Class for the given item. It can be used to examine
9048 * the function pointers and item_style.
9052 EAPI const Elm_Gengrid_Item_Class *elm_gengrid_item_item_class_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9055 * Get the Gengrid Item class for the given Gengrid Item.
9057 * This sets the Gengrid_Item_Class for the given item. It can be used to examine
9058 * the function pointers and item_style.
9060 * @param item The gengrid item
9061 * @param gic The gengrid item class describing the function pointers and the item style.
9065 EAPI void elm_gengrid_item_item_class_set(Elm_Gengrid_Item *item, const Elm_Gengrid_Item_Class *gic) EINA_ARG_NONNULL(1, 2);
9068 * Return the data associated to a given gengrid item
9070 * @param item The gengrid item.
9071 * @return the data associated with this item.
9073 * This returns the @c data value passed on the
9074 * elm_gengrid_item_append() and related item addition calls.
9076 * @see elm_gengrid_item_append()
9077 * @see elm_gengrid_item_data_set()
9081 EAPI void *elm_gengrid_item_data_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9084 * Set the data associated with a given gengrid item
9086 * @param item The gengrid item
9087 * @param data The data pointer to set on it
9089 * This @b overrides the @c data value passed on the
9090 * elm_gengrid_item_append() and related item addition calls. This
9091 * function @b won't call elm_gengrid_item_update() automatically,
9092 * so you'd issue it afterwards if you want to have the item
9093 * updated to reflect the new data.
9095 * @see elm_gengrid_item_data_get()
9096 * @see elm_gengrid_item_update()
9100 EAPI void elm_gengrid_item_data_set(Elm_Gengrid_Item *item, const void *data) EINA_ARG_NONNULL(1);
9103 * Get a given gengrid item's position, relative to the whole
9104 * gengrid's grid area.
9106 * @param item The Gengrid item.
9107 * @param x Pointer to variable to store the item's <b>row number</b>.
9108 * @param y Pointer to variable to store the item's <b>column number</b>.
9110 * This returns the "logical" position of the item within the
9111 * gengrid. For example, @c (0, 1) would stand for first row,
9116 EAPI void elm_gengrid_item_pos_get(const Elm_Gengrid_Item *item, unsigned int *x, unsigned int *y) EINA_ARG_NONNULL(1);
9119 * Set whether a given gengrid item is selected or not
9121 * @param item The gengrid item
9122 * @param selected Use @c EINA_TRUE, to make it selected, @c
9123 * EINA_FALSE to make it unselected
9125 * This sets the selected state of an item. If multi-selection is
9126 * not enabled on the containing gengrid and @p selected is @c
9127 * EINA_TRUE, any other previously selected items will get
9128 * unselected in favor of this new one.
9130 * @see elm_gengrid_item_selected_get()
9134 EAPI void elm_gengrid_item_selected_set(Elm_Gengrid_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
9137 * Get whether a given gengrid item is selected or not
9139 * @param item The gengrid item
9140 * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
9142 * This API returns EINA_TRUE for all the items selected in multi-select mode as well.
9144 * @see elm_gengrid_item_selected_set() for more details
9148 EAPI Eina_Bool elm_gengrid_item_selected_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9151 * Get the real Evas object created to implement the view of a
9152 * given gengrid item
9154 * @param item The gengrid item.
9155 * @return the Evas object implementing this item's view.
9157 * This returns the actual Evas object used to implement the
9158 * specified gengrid item's view. This may be @c NULL, as it may
9159 * not have been created or may have been deleted, at any time, by
9160 * the gengrid. <b>Do not modify this object</b> (move, resize,
9161 * show, hide, etc.), as the gengrid is controlling it. This
9162 * function is for querying, emitting custom signals or hooking
9163 * lower level callbacks for events on that object. Do not delete
9164 * this object under any circumstances.
9166 * @see elm_gengrid_item_data_get()
9170 EAPI const Evas_Object *elm_gengrid_item_object_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9173 * Show the portion of a gengrid's internal grid containing a given
9174 * item, @b immediately.
9176 * @param item The item to display
9178 * This causes gengrid to @b redraw its viewport's contents to the
9179 * region contining the given @p item item, if it is not fully
9182 * @see elm_gengrid_item_bring_in()
9186 EAPI void elm_gengrid_item_show(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9189 * Animatedly bring in, to the visible area of a gengrid, a given
9192 * @param item The gengrid item to display
9194 * This causes gengrid to jump to the given @p item and show
9195 * it (by scrolling), if it is not fully visible. This will use
9196 * animation to do so and take a period of time to complete.
9198 * @see elm_gengrid_item_show()
9202 EAPI void elm_gengrid_item_bring_in(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9205 * Set whether a given gengrid item is disabled or not.
9207 * @param item The gengrid item
9208 * @param disabled Use @c EINA_TRUE, true disable it, @c EINA_FALSE
9209 * to enable it back.
9211 * A disabled item cannot be selected or unselected. It will also
9212 * change its appearance, to signal the user it's disabled.
9214 * @see elm_gengrid_item_disabled_get()
9218 EAPI void elm_gengrid_item_disabled_set(Elm_Gengrid_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
9221 * Get whether a given gengrid item is disabled or not.
9223 * @param item The gengrid item
9224 * @return @c EINA_TRUE, if it's disabled, @c EINA_FALSE otherwise
9227 * @see elm_gengrid_item_disabled_set() for more details
9231 EAPI Eina_Bool elm_gengrid_item_disabled_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9234 * Set the text to be shown in a given gengrid item's tooltips.
9236 * @param item The gengrid item
9237 * @param text The text to set in the content
9239 * This call will setup the text to be used as tooltip to that item
9240 * (analogous to elm_object_tooltip_text_set(), but being item
9241 * tooltips with higher precedence than object tooltips). It can
9242 * have only one tooltip at a time, so any previous tooltip data
9247 EAPI void elm_gengrid_item_tooltip_text_set(Elm_Gengrid_Item *item, const char *text) EINA_ARG_NONNULL(1);
9250 * Set the content to be shown in a given gengrid item's tooltip
9252 * @param item The gengrid item.
9253 * @param func The function returning the tooltip contents.
9254 * @param data What to provide to @a func as callback data/context.
9255 * @param del_cb Called when data is not needed anymore, either when
9256 * another callback replaces @p func, the tooltip is unset with
9257 * elm_gengrid_item_tooltip_unset() or the owner @p item
9258 * dies. This callback receives as its first parameter the
9259 * given @p data, being @c event_info the item handle.
9261 * This call will setup the tooltip's contents to @p item
9262 * (analogous to elm_object_tooltip_content_cb_set(), but being
9263 * item tooltips with higher precedence than object tooltips). It
9264 * can have only one tooltip at a time, so any previous tooltip
9265 * content will get removed. @p func (with @p data) will be called
9266 * every time Elementary needs to show the tooltip and it should
9267 * return a valid Evas object, which will be fully managed by the
9268 * tooltip system, getting deleted when the tooltip is gone.
9272 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);
9275 * Unset a tooltip from a given gengrid item
9277 * @param item gengrid item to remove a previously set tooltip from.
9279 * This call removes any tooltip set on @p item. The callback
9280 * provided as @c del_cb to
9281 * elm_gengrid_item_tooltip_content_cb_set() will be called to
9282 * notify it is not used anymore (and have resources cleaned, if
9285 * @see elm_gengrid_item_tooltip_content_cb_set()
9289 EAPI void elm_gengrid_item_tooltip_unset(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9292 * Set a different @b style for a given gengrid item's tooltip.
9294 * @param item gengrid item with tooltip set
9295 * @param style the <b>theme style</b> to use on tooltips (e.g. @c
9296 * "default", @c "transparent", etc)
9298 * Tooltips can have <b>alternate styles</b> to be displayed on,
9299 * which are defined by the theme set on Elementary. This function
9300 * works analogously as elm_object_tooltip_style_set(), but here
9301 * applied only to gengrid item objects. The default style for
9302 * tooltips is @c "default".
9304 * @note before you set a style you should define a tooltip with
9305 * elm_gengrid_item_tooltip_content_cb_set() or
9306 * elm_gengrid_item_tooltip_text_set()
9308 * @see elm_gengrid_item_tooltip_style_get()
9312 EAPI void elm_gengrid_item_tooltip_style_set(Elm_Gengrid_Item *item, const char *style) EINA_ARG_NONNULL(1);
9315 * Get the style set a given gengrid item's tooltip.
9317 * @param item gengrid item with tooltip already set on.
9318 * @return style the theme style in use, which defaults to
9319 * "default". If the object does not have a tooltip set,
9320 * then @c NULL is returned.
9322 * @see elm_gengrid_item_tooltip_style_set() for more details
9326 EAPI const char *elm_gengrid_item_tooltip_style_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9328 * @brief Disable size restrictions on an object's tooltip
9329 * @param item The tooltip's anchor object
9330 * @param disable If EINA_TRUE, size restrictions are disabled
9331 * @return EINA_FALSE on failure, EINA_TRUE on success
9333 * This function allows a tooltip to expand beyond its parant window's canvas.
9334 * It will instead be limited only by the size of the display.
9336 EAPI Eina_Bool elm_gengrid_item_tooltip_size_restrict_disable(Elm_Gengrid_Item *item, Eina_Bool disable);
9338 * @brief Retrieve size restriction state of an object's tooltip
9339 * @param item The tooltip's anchor object
9340 * @return If EINA_TRUE, size restrictions are disabled
9342 * This function returns whether a tooltip is allowed to expand beyond
9343 * its parant window's canvas.
9344 * It will instead be limited only by the size of the display.
9346 EAPI Eina_Bool elm_gengrid_item_tooltip_size_restrict_disabled_get(const Elm_Gengrid_Item *item);
9348 * Set the type of mouse pointer/cursor decoration to be shown,
9349 * when the mouse pointer is over the given gengrid widget item
9351 * @param item gengrid item to customize cursor on
9352 * @param cursor the cursor type's name
9354 * This function works analogously as elm_object_cursor_set(), but
9355 * here the cursor's changing area is restricted to the item's
9356 * area, and not the whole widget's. Note that that item cursors
9357 * have precedence over widget cursors, so that a mouse over @p
9358 * item will always show cursor @p type.
9360 * If this function is called twice for an object, a previously set
9361 * cursor will be unset on the second call.
9363 * @see elm_object_cursor_set()
9364 * @see elm_gengrid_item_cursor_get()
9365 * @see elm_gengrid_item_cursor_unset()
9369 EAPI void elm_gengrid_item_cursor_set(Elm_Gengrid_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
9372 * Get the type of mouse pointer/cursor decoration set to be shown,
9373 * when the mouse pointer is over the given gengrid widget item
9375 * @param item gengrid item with custom cursor set
9376 * @return the cursor type's name or @c NULL, if no custom cursors
9377 * were set to @p item (and on errors)
9379 * @see elm_object_cursor_get()
9380 * @see elm_gengrid_item_cursor_set() for more details
9381 * @see elm_gengrid_item_cursor_unset()
9385 EAPI const char *elm_gengrid_item_cursor_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9388 * Unset any custom mouse pointer/cursor decoration set to be
9389 * shown, when the mouse pointer is over the given gengrid widget
9390 * item, thus making it show the @b default cursor again.
9392 * @param item a gengrid item
9394 * Use this call to undo any custom settings on this item's cursor
9395 * decoration, bringing it back to defaults (no custom style set).
9397 * @see elm_object_cursor_unset()
9398 * @see elm_gengrid_item_cursor_set() for more details
9402 EAPI void elm_gengrid_item_cursor_unset(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9405 * Set a different @b style for a given custom cursor set for a
9408 * @param item gengrid item with custom cursor set
9409 * @param style the <b>theme style</b> to use (e.g. @c "default",
9410 * @c "transparent", etc)
9412 * This function only makes sense when one is using custom mouse
9413 * cursor decorations <b>defined in a theme file</b> , which can
9414 * have, given a cursor name/type, <b>alternate styles</b> on
9415 * it. It works analogously as elm_object_cursor_style_set(), but
9416 * here applied only to gengrid item objects.
9418 * @warning Before you set a cursor style you should have defined a
9419 * custom cursor previously on the item, with
9420 * elm_gengrid_item_cursor_set()
9422 * @see elm_gengrid_item_cursor_engine_only_set()
9423 * @see elm_gengrid_item_cursor_style_get()
9427 EAPI void elm_gengrid_item_cursor_style_set(Elm_Gengrid_Item *item, const char *style) EINA_ARG_NONNULL(1);
9430 * Get the current @b style set for a given gengrid item's custom
9433 * @param item gengrid item with custom cursor set.
9434 * @return style the cursor style in use. If the object does not
9435 * have a cursor set, then @c NULL is returned.
9437 * @see elm_gengrid_item_cursor_style_set() for more details
9441 EAPI const char *elm_gengrid_item_cursor_style_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9444 * Set if the (custom) cursor for a given gengrid item should be
9445 * searched in its theme, also, or should only rely on the
9448 * @param item item with custom (custom) cursor already set on
9449 * @param engine_only Use @c EINA_TRUE to have cursors looked for
9450 * only on those provided by the rendering engine, @c EINA_FALSE to
9451 * have them searched on the widget's theme, as well.
9453 * @note This call is of use only if you've set a custom cursor
9454 * for gengrid items, with elm_gengrid_item_cursor_set().
9456 * @note By default, cursors will only be looked for between those
9457 * provided by the rendering engine.
9461 EAPI void elm_gengrid_item_cursor_engine_only_set(Elm_Gengrid_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
9464 * Get if the (custom) cursor for a given gengrid item is being
9465 * searched in its theme, also, or is only relying on the rendering
9468 * @param item a gengrid item
9469 * @return @c EINA_TRUE, if cursors are being looked for only on
9470 * those provided by the rendering engine, @c EINA_FALSE if they
9471 * are being searched on the widget's theme, as well.
9473 * @see elm_gengrid_item_cursor_engine_only_set(), for more details
9477 EAPI Eina_Bool elm_gengrid_item_cursor_engine_only_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9480 * Remove all items from a given gengrid widget
9482 * @param obj The gengrid object.
9484 * This removes (and deletes) all items in @p obj, leaving it
9487 * @see elm_gengrid_item_del(), to remove just one item.
9491 EAPI void elm_gengrid_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
9494 * Get the selected item in a given gengrid widget
9496 * @param obj The gengrid object.
9497 * @return The selected item's handleor @c NULL, if none is
9498 * selected at the moment (and on errors)
9500 * This returns the selected item in @p obj. If multi selection is
9501 * enabled on @p obj (@see elm_gengrid_multi_select_set()), only
9502 * the first item in the list is selected, which might not be very
9503 * useful. For that case, see elm_gengrid_selected_items_get().
9507 EAPI Elm_Gengrid_Item *elm_gengrid_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9510 * Get <b>a list</b> of selected items in a given gengrid
9512 * @param obj The gengrid object.
9513 * @return The list of selected items or @c NULL, if none is
9514 * selected at the moment (and on errors)
9516 * This returns a list of the selected items, in the order that
9517 * they appear in the grid. This list is only valid as long as no
9518 * more items are selected or unselected (or unselected implictly
9519 * by deletion). The list contains #Elm_Gengrid_Item pointers as
9522 * @see elm_gengrid_selected_item_get()
9526 EAPI const Eina_List *elm_gengrid_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9533 * @defgroup Clock Clock
9535 * @image html img/widget/clock/preview-00.png
9536 * @image latex img/widget/clock/preview-00.eps
9538 * This is a @b digital clock widget. In its default theme, it has a
9539 * vintage "flipping numbers clock" appearance, which will animate
9540 * sheets of individual algarisms individually as time goes by.
9542 * A newly created clock will fetch system's time (already
9543 * considering local time adjustments) to start with, and will tick
9544 * accondingly. It may or may not show seconds.
9546 * Clocks have an @b edition mode. When in it, the sheets will
9547 * display extra arrow indications on the top and bottom and the
9548 * user may click on them to raise or lower the time values. After
9549 * it's told to exit edition mode, it will keep ticking with that
9550 * new time set (it keeps the difference from local time).
9552 * Also, when under edition mode, user clicks on the cited arrows
9553 * which are @b held for some time will make the clock to flip the
9554 * sheet, thus editing the time, continuosly and automatically for
9555 * the user. The interval between sheet flips will keep growing in
9556 * time, so that it helps the user to reach a time which is distant
9559 * The time display is, by default, in military mode (24h), but an
9560 * am/pm indicator may be optionally shown, too, when it will
9563 * Smart callbacks one can register to:
9564 * - "changed" - the clock's user changed the time
9566 * Here is an example on its usage:
9567 * @li @ref clock_example
9576 * Identifiers for which clock digits should be editable, when a
9577 * clock widget is in edition mode. Values may be ORed together to
9578 * make a mask, naturally.
9580 * @see elm_clock_edit_set()
9581 * @see elm_clock_digit_edit_set()
9583 typedef enum _Elm_Clock_Digedit
9585 ELM_CLOCK_NONE = 0, /**< Default value. Means that all digits are editable, when in edition mode. */
9586 ELM_CLOCK_HOUR_DECIMAL = 1 << 0, /**< Decimal algarism of hours value should be editable */
9587 ELM_CLOCK_HOUR_UNIT = 1 << 1, /**< Unit algarism of hours value should be editable */
9588 ELM_CLOCK_MIN_DECIMAL = 1 << 2, /**< Decimal algarism of minutes value should be editable */
9589 ELM_CLOCK_MIN_UNIT = 1 << 3, /**< Unit algarism of minutes value should be editable */
9590 ELM_CLOCK_SEC_DECIMAL = 1 << 4, /**< Decimal algarism of seconds value should be editable */
9591 ELM_CLOCK_SEC_UNIT = 1 << 5, /**< Unit algarism of seconds value should be editable */
9592 ELM_CLOCK_ALL = (1 << 6) - 1 /**< All digits should be editable */
9593 } Elm_Clock_Digedit;
9596 * Add a new clock widget to the given parent Elementary
9597 * (container) object
9599 * @param parent The parent object
9600 * @return a new clock widget handle or @c NULL, on errors
9602 * This function inserts a new clock widget on the canvas.
9606 EAPI Evas_Object *elm_clock_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
9609 * Set a clock widget's time, programmatically
9611 * @param obj The clock widget object
9612 * @param hrs The hours to set
9613 * @param min The minutes to set
9614 * @param sec The secondes to set
9616 * This function updates the time that is showed by the clock
9619 * Values @b must be set within the following ranges:
9620 * - 0 - 23, for hours
9621 * - 0 - 59, for minutes
9622 * - 0 - 59, for seconds,
9624 * even if the clock is not in "military" mode.
9626 * @warning The behavior for values set out of those ranges is @b
9631 EAPI void elm_clock_time_set(Evas_Object *obj, int hrs, int min, int sec) EINA_ARG_NONNULL(1);
9634 * Get a clock widget's time values
9636 * @param obj The clock object
9637 * @param[out] hrs Pointer to the variable to get the hours value
9638 * @param[out] min Pointer to the variable to get the minutes value
9639 * @param[out] sec Pointer to the variable to get the seconds value
9641 * This function gets the time set for @p obj, returning
9642 * it on the variables passed as the arguments to function
9644 * @note Use @c NULL pointers on the time values you're not
9645 * interested in: they'll be ignored by the function.
9649 EAPI void elm_clock_time_get(const Evas_Object *obj, int *hrs, int *min, int *sec) EINA_ARG_NONNULL(1);
9652 * Set whether a given clock widget is under <b>edition mode</b> or
9653 * under (default) displaying-only mode.
9655 * @param obj The clock object
9656 * @param edit @c EINA_TRUE to put it in edition, @c EINA_FALSE to
9657 * put it back to "displaying only" mode
9659 * This function makes a clock's time to be editable or not <b>by
9660 * user interaction</b>. When in edition mode, clocks @b stop
9661 * ticking, until one brings them back to canonical mode. The
9662 * elm_clock_digit_edit_set() function will influence which digits
9663 * of the clock will be editable. By default, all of them will be
9664 * (#ELM_CLOCK_NONE).
9666 * @note am/pm sheets, if being shown, will @b always be editable
9667 * under edition mode.
9669 * @see elm_clock_edit_get()
9673 EAPI void elm_clock_edit_set(Evas_Object *obj, Eina_Bool edit) EINA_ARG_NONNULL(1);
9676 * Retrieve whether a given clock widget is under <b>edition
9677 * mode</b> or under (default) displaying-only mode.
9679 * @param obj The clock object
9680 * @param edit @c EINA_TRUE, if it's in edition mode, @c EINA_FALSE
9683 * This function retrieves whether the clock's time can be edited
9684 * or not by user interaction.
9686 * @see elm_clock_edit_set() for more details
9690 EAPI Eina_Bool elm_clock_edit_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9693 * Set what digits of the given clock widget should be editable
9694 * when in edition mode.
9696 * @param obj The clock object
9697 * @param digedit Bit mask indicating the digits to be editable
9698 * (values in #Elm_Clock_Digedit).
9700 * If the @p digedit param is #ELM_CLOCK_NONE, editing will be
9701 * disabled on @p obj (same effect as elm_clock_edit_set(), with @c
9704 * @see elm_clock_digit_edit_get()
9708 EAPI void elm_clock_digit_edit_set(Evas_Object *obj, Elm_Clock_Digedit digedit) EINA_ARG_NONNULL(1);
9711 * Retrieve what digits of the given clock widget should be
9712 * editable when in edition mode.
9714 * @param obj The clock object
9715 * @return Bit mask indicating the digits to be editable
9716 * (values in #Elm_Clock_Digedit).
9718 * @see elm_clock_digit_edit_set() for more details
9722 EAPI Elm_Clock_Digedit elm_clock_digit_edit_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9725 * Set if the given clock widget must show hours in military or
9728 * @param obj The clock object
9729 * @param am_pm @c EINA_TRUE to put it in am/pm mode, @c EINA_FALSE
9732 * This function sets if the clock must show hours in military or
9733 * am/pm mode. In some countries like Brazil the military mode
9734 * (00-24h-format) is used, in opposition to the USA, where the
9735 * am/pm mode is more commonly used.
9737 * @see elm_clock_show_am_pm_get()
9741 EAPI void elm_clock_show_am_pm_set(Evas_Object *obj, Eina_Bool am_pm) EINA_ARG_NONNULL(1);
9744 * Get if the given clock widget shows hours in military or am/pm
9747 * @param obj The clock object
9748 * @return @c EINA_TRUE, if in am/pm mode, @c EINA_FALSE if in
9751 * This function gets if the clock shows hours in military or am/pm
9754 * @see elm_clock_show_am_pm_set() for more details
9758 EAPI Eina_Bool elm_clock_show_am_pm_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9761 * Set if the given clock widget must show time with seconds or not
9763 * @param obj The clock object
9764 * @param seconds @c EINA_TRUE to show seconds, @c EINA_FALSE otherwise
9766 * This function sets if the given clock must show or not elapsed
9767 * seconds. By default, they are @b not shown.
9769 * @see elm_clock_show_seconds_get()
9773 EAPI void elm_clock_show_seconds_set(Evas_Object *obj, Eina_Bool seconds) EINA_ARG_NONNULL(1);
9776 * Get whether the given clock widget is showing time with seconds
9779 * @param obj The clock object
9780 * @return @c EINA_TRUE if it's showing seconds, @c EINA_FALSE otherwise
9782 * This function gets whether @p obj is showing or not the elapsed
9785 * @see elm_clock_show_seconds_set()
9789 EAPI Eina_Bool elm_clock_show_seconds_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9792 * Set the interval on time updates for an user mouse button hold
9793 * on clock widgets' time edition.
9795 * @param obj The clock object
9796 * @param interval The (first) interval value in seconds
9798 * This interval value is @b decreased while the user holds the
9799 * mouse pointer either incrementing or decrementing a given the
9800 * clock digit's value.
9802 * This helps the user to get to a given time distant from the
9803 * current one easier/faster, as it will start to flip quicker and
9804 * quicker on mouse button holds.
9806 * The calculation for the next flip interval value, starting from
9807 * the one set with this call, is the previous interval divided by
9808 * 1.05, so it decreases a little bit.
9810 * The default starting interval value for automatic flips is
9813 * @see elm_clock_interval_get()
9817 EAPI void elm_clock_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
9820 * Get the interval on time updates for an user mouse button hold
9821 * on clock widgets' time edition.
9823 * @param obj The clock object
9824 * @return The (first) interval value, in seconds, set on it
9826 * @see elm_clock_interval_set() for more details
9830 EAPI double elm_clock_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9837 * @defgroup Layout Layout
9839 * @image html img/widget/layout/preview-00.png
9840 * @image latex img/widget/layout/preview-00.eps width=\textwidth
9842 * @image html img/layout-predefined.png
9843 * @image latex img/layout-predefined.eps width=\textwidth
9845 * This is a container widget that takes a standard Edje design file and
9846 * wraps it very thinly in a widget.
9848 * An Edje design (theme) file has a very wide range of possibilities to
9849 * describe the behavior of elements added to the Layout. Check out the Edje
9850 * documentation and the EDC reference to get more information about what can
9851 * be done with Edje.
9853 * Just like @ref List, @ref Box, and other container widgets, any
9854 * object added to the Layout will become its child, meaning that it will be
9855 * deleted if the Layout is deleted, move if the Layout is moved, and so on.
9857 * The Layout widget can contain as many Contents, Boxes or Tables as
9858 * described in its theme file. For instance, objects can be added to
9859 * different Tables by specifying the respective Table part names. The same
9860 * is valid for Content and Box.
9862 * The objects added as child of the Layout will behave as described in the
9863 * part description where they were added. There are 3 possible types of
9864 * parts where a child can be added:
9866 * @section secContent Content (SWALLOW part)
9868 * Only one object can be added to the @c SWALLOW part (but you still can
9869 * have many @c SWALLOW parts and one object on each of them). Use the @c
9870 * elm_object_content_set/get/unset functions to set, retrieve and unset
9871 * objects as content of the @c SWALLOW. After being set to this part, the
9872 * object size, position, visibility, clipping and other description
9873 * properties will be totally controlled by the description of the given part
9874 * (inside the Edje theme file).
9876 * One can use @c evas_object_size_hint_* functions on the child to have some
9877 * kind of control over its behavior, but the resulting behavior will still
9878 * depend heavily on the @c SWALLOW part description.
9880 * The Edje theme also can change the part description, based on signals or
9881 * scripts running inside the theme. This change can also be animated. All of
9882 * this will affect the child object set as content accordingly. The object
9883 * size will be changed if the part size is changed, it will animate move if
9884 * the part is moving, and so on.
9886 * The following picture demonstrates a Layout widget with a child object
9887 * added to its @c SWALLOW:
9889 * @image html layout_swallow.png
9890 * @image latex layout_swallow.eps width=\textwidth
9892 * @section secBox Box (BOX part)
9894 * An Edje @c BOX part is very similar to the Elementary @ref Box widget. It
9895 * allows one to add objects to the box and have them distributed along its
9896 * area, accordingly to the specified @a layout property (now by @a layout we
9897 * mean the chosen layouting design of the Box, not the Layout widget
9900 * A similar effect for having a box with its position, size and other things
9901 * controlled by the Layout theme would be to create an Elementary @ref Box
9902 * widget and add it as a Content in the @c SWALLOW part.
9904 * The main difference of using the Layout Box is that its behavior, the box
9905 * properties like layouting format, padding, align, etc. will be all
9906 * controlled by the theme. This means, for example, that a signal could be
9907 * sent to the Layout theme (with elm_object_signal_emit()) and the theme
9908 * handled the signal by changing the box padding, or align, or both. Using
9909 * the Elementary @ref Box widget is not necessarily harder or easier, it
9910 * just depends on the circunstances and requirements.
9912 * The Layout Box can be used through the @c elm_layout_box_* set of
9915 * The following picture demonstrates a Layout widget with many child objects
9916 * added to its @c BOX part:
9918 * @image html layout_box.png
9919 * @image latex layout_box.eps width=\textwidth
9921 * @section secTable Table (TABLE part)
9923 * Just like the @ref secBox, the Layout Table is very similar to the
9924 * Elementary @ref Table widget. It allows one to add objects to the Table
9925 * specifying the row and column where the object should be added, and any
9926 * column or row span if necessary.
9928 * Again, we could have this design by adding a @ref Table widget to the @c
9929 * SWALLOW part using elm_object_part_content_set(). The same difference happens
9930 * here when choosing to use the Layout Table (a @c TABLE part) instead of
9931 * the @ref Table plus @c SWALLOW part. It's just a matter of convenience.
9933 * The Layout Table can be used through the @c elm_layout_table_* set of
9936 * The following picture demonstrates a Layout widget with many child objects
9937 * added to its @c TABLE part:
9939 * @image html layout_table.png
9940 * @image latex layout_table.eps width=\textwidth
9942 * @section secPredef Predefined Layouts
9944 * Another interesting thing about the Layout widget is that it offers some
9945 * predefined themes that come with the default Elementary theme. These
9946 * themes can be set by the call elm_layout_theme_set(), and provide some
9947 * basic functionality depending on the theme used.
9949 * Most of them already send some signals, some already provide a toolbar or
9950 * back and next buttons.
9952 * These are available predefined theme layouts. All of them have class = @c
9953 * layout, group = @c application, and style = one of the following options:
9955 * @li @c toolbar-content - application with toolbar and main content area
9956 * @li @c toolbar-content-back - application with toolbar and main content
9957 * area with a back button and title area
9958 * @li @c toolbar-content-back-next - application with toolbar and main
9959 * content area with a back and next buttons and title area
9960 * @li @c content-back - application with a main content area with a back
9961 * button and title area
9962 * @li @c content-back-next - application with a main content area with a
9963 * back and next buttons and title area
9964 * @li @c toolbar-vbox - application with toolbar and main content area as a
9966 * @li @c toolbar-table - application with toolbar and main content area as a
9969 * @section secExamples Examples
9971 * Some examples of the Layout widget can be found here:
9972 * @li @ref layout_example_01
9973 * @li @ref layout_example_02
9974 * @li @ref layout_example_03
9975 * @li @ref layout_example_edc
9980 * Add a new layout to the parent
9982 * @param parent The parent object
9983 * @return The new object or NULL if it cannot be created
9985 * @see elm_layout_file_set()
9986 * @see elm_layout_theme_set()
9990 EAPI Evas_Object *elm_layout_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
9992 * Set the file that will be used as layout
9994 * @param obj The layout object
9995 * @param file The path to file (edj) that will be used as layout
9996 * @param group The group that the layout belongs in edje file
9998 * @return (1 = success, 0 = error)
10002 EAPI Eina_Bool elm_layout_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1);
10004 * Set the edje group from the elementary theme that will be used as layout
10006 * @param obj The layout object
10007 * @param clas the clas of the group
10008 * @param group the group
10009 * @param style the style to used
10011 * @return (1 = success, 0 = error)
10015 EAPI Eina_Bool elm_layout_theme_set(Evas_Object *obj, const char *clas, const char *group, const char *style) EINA_ARG_NONNULL(1);
10017 * Set the layout content.
10019 * @param obj The layout object
10020 * @param swallow The swallow part name in the edje file
10021 * @param content The child that will be added in this layout object
10023 * Once the content object is set, a previously set one will be deleted.
10024 * If you want to keep that old content object, use the
10025 * elm_object_part_content_unset() function.
10027 * @note In an Edje theme, the part used as a content container is called @c
10028 * SWALLOW. This is why the parameter name is called @p swallow, but it is
10029 * expected to be a part name just like the second parameter of
10030 * elm_layout_box_append().
10032 * @see elm_layout_box_append()
10033 * @see elm_object_part_content_get()
10034 * @see elm_object_part_content_unset()
10036 * @deprecated use elm_object_part_content_set() instead
10040 EINA_DEPRECATED EAPI void elm_layout_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content) EINA_ARG_NONNULL(1);
10042 * Get the child object in the given content part.
10044 * @param obj The layout object
10045 * @param swallow The SWALLOW part to get its content
10047 * @return The swallowed object or NULL if none or an error occurred
10049 * @deprecated use elm_object_part_content_get() instead
10053 EINA_DEPRECATED EAPI Evas_Object *elm_layout_content_get(const Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
10055 * Unset the layout content.
10057 * @param obj The layout object
10058 * @param swallow The swallow part name in the edje file
10059 * @return The content that was being used
10061 * Unparent and return the content object which was set for this part.
10063 * @deprecated use elm_object_part_content_unset() instead
10067 EINA_DEPRECATED EAPI Evas_Object *elm_layout_content_unset(Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
10069 * Set the text of the given part
10071 * @param obj The layout object
10072 * @param part The TEXT part where to set the text
10073 * @param text The text to set
10076 * @deprecated use elm_object_part_text_set() instead.
10078 EINA_DEPRECATED EAPI void elm_layout_text_set(Evas_Object *obj, const char *part, const char *text) EINA_ARG_NONNULL(1);
10080 * Get the text set in the given part
10082 * @param obj The layout object
10083 * @param part The TEXT part to retrieve the text off
10085 * @return The text set in @p part
10088 * @deprecated use elm_object_part_text_get() instead.
10090 EINA_DEPRECATED EAPI const char *elm_layout_text_get(const Evas_Object *obj, const char *part) EINA_ARG_NONNULL(1);
10092 * Append child to layout box part.
10094 * @param obj the layout object
10095 * @param part the box part to which the object will be appended.
10096 * @param child the child object to append to box.
10098 * Once the object is appended, it will become child of the layout. Its
10099 * lifetime will be bound to the layout, whenever the layout dies the child
10100 * will be deleted automatically. One should use elm_layout_box_remove() to
10101 * make this layout forget about the object.
10103 * @see elm_layout_box_prepend()
10104 * @see elm_layout_box_insert_before()
10105 * @see elm_layout_box_insert_at()
10106 * @see elm_layout_box_remove()
10110 EAPI void elm_layout_box_append(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1);
10112 * Prepend child to layout box part.
10114 * @param obj the layout object
10115 * @param part the box part to prepend.
10116 * @param child the child object to prepend to box.
10118 * Once the object is prepended, it will become child of the layout. Its
10119 * lifetime will be bound to the layout, whenever the layout dies the child
10120 * will be deleted automatically. One should use elm_layout_box_remove() to
10121 * make this layout forget about the object.
10123 * @see elm_layout_box_append()
10124 * @see elm_layout_box_insert_before()
10125 * @see elm_layout_box_insert_at()
10126 * @see elm_layout_box_remove()
10130 EAPI void elm_layout_box_prepend(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1);
10132 * Insert child to layout box part before a reference object.
10134 * @param obj the layout object
10135 * @param part the box part to insert.
10136 * @param child the child object to insert into box.
10137 * @param reference another reference object to insert before in box.
10139 * Once the object is inserted, it will become child of the layout. Its
10140 * lifetime will be bound to the layout, whenever the layout dies the child
10141 * will be deleted automatically. One should use elm_layout_box_remove() to
10142 * make this layout forget about the object.
10144 * @see elm_layout_box_append()
10145 * @see elm_layout_box_prepend()
10146 * @see elm_layout_box_insert_before()
10147 * @see elm_layout_box_remove()
10151 EAPI void elm_layout_box_insert_before(Evas_Object *obj, const char *part, Evas_Object *child, const Evas_Object *reference) EINA_ARG_NONNULL(1);
10153 * Insert child to layout box part at a given position.
10155 * @param obj the layout object
10156 * @param part the box part to insert.
10157 * @param child the child object to insert into box.
10158 * @param pos the numeric position >=0 to insert the child.
10160 * Once the object is inserted, it will become child of the layout. Its
10161 * lifetime will be bound to the layout, whenever the layout dies the child
10162 * will be deleted automatically. One should use elm_layout_box_remove() to
10163 * make this layout forget about the object.
10165 * @see elm_layout_box_append()
10166 * @see elm_layout_box_prepend()
10167 * @see elm_layout_box_insert_before()
10168 * @see elm_layout_box_remove()
10172 EAPI void elm_layout_box_insert_at(Evas_Object *obj, const char *part, Evas_Object *child, unsigned int pos) EINA_ARG_NONNULL(1);
10174 * Remove a child of the given part box.
10176 * @param obj The layout object
10177 * @param part The box part name to remove child.
10178 * @param child The object to remove from box.
10179 * @return The object that was being used, or NULL if not found.
10181 * The object will be removed from the box part and its lifetime will
10182 * not be handled by the layout anymore. This is equivalent to
10183 * elm_object_part_content_unset() for box.
10185 * @see elm_layout_box_append()
10186 * @see elm_layout_box_remove_all()
10190 EAPI Evas_Object *elm_layout_box_remove(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1, 2, 3);
10192 * Remove all children of the given part box.
10194 * @param obj The layout object
10195 * @param part The box part name to remove child.
10196 * @param clear If EINA_TRUE, then all objects will be deleted as
10197 * well, otherwise they will just be removed and will be
10198 * dangling on the canvas.
10200 * The objects will be removed from the box part and their lifetime will
10201 * not be handled by the layout anymore. This is equivalent to
10202 * elm_layout_box_remove() for all box children.
10204 * @see elm_layout_box_append()
10205 * @see elm_layout_box_remove()
10209 EAPI void elm_layout_box_remove_all(Evas_Object *obj, const char *part, Eina_Bool clear) EINA_ARG_NONNULL(1, 2);
10211 * Insert child to layout table part.
10213 * @param obj the layout object
10214 * @param part the box part to pack child.
10215 * @param child_obj the child object to pack into table.
10216 * @param col the column to which the child should be added. (>= 0)
10217 * @param row the row to which the child should be added. (>= 0)
10218 * @param colspan how many columns should be used to store this object. (>=
10220 * @param rowspan how many rows should be used to store this object. (>= 1)
10222 * Once the object is inserted, it will become child of the table. Its
10223 * lifetime will be bound to the layout, and whenever the layout dies the
10224 * child will be deleted automatically. One should use
10225 * elm_layout_table_remove() to make this layout forget about the object.
10227 * If @p colspan or @p rowspan are bigger than 1, that object will occupy
10228 * more space than a single cell. For instance, the following code:
10230 * elm_layout_table_pack(layout, "table_part", child, 0, 1, 3, 1);
10233 * Would result in an object being added like the following picture:
10235 * @image html layout_colspan.png
10236 * @image latex layout_colspan.eps width=\textwidth
10238 * @see elm_layout_table_unpack()
10239 * @see elm_layout_table_clear()
10243 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);
10245 * Unpack (remove) a child of the given part table.
10247 * @param obj The layout object
10248 * @param part The table part name to remove child.
10249 * @param child_obj The object to remove from table.
10250 * @return The object that was being used, or NULL if not found.
10252 * The object will be unpacked from the table part and its lifetime
10253 * will not be handled by the layout anymore. This is equivalent to
10254 * elm_object_part_content_unset() for table.
10256 * @see elm_layout_table_pack()
10257 * @see elm_layout_table_clear()
10261 EAPI Evas_Object *elm_layout_table_unpack(Evas_Object *obj, const char *part, Evas_Object *child_obj) EINA_ARG_NONNULL(1, 2, 3);
10263 * Remove all the child objects of the given part table.
10265 * @param obj The layout object
10266 * @param part The table part name to remove child.
10267 * @param clear If EINA_TRUE, then all objects will be deleted as
10268 * well, otherwise they will just be removed and will be
10269 * dangling on the canvas.
10271 * The objects will be removed from the table part and their lifetime will
10272 * not be handled by the layout anymore. This is equivalent to
10273 * elm_layout_table_unpack() for all table children.
10275 * @see elm_layout_table_pack()
10276 * @see elm_layout_table_unpack()
10280 EAPI void elm_layout_table_clear(Evas_Object *obj, const char *part, Eina_Bool clear) EINA_ARG_NONNULL(1, 2);
10282 * Get the edje layout
10284 * @param obj The layout object
10286 * @return A Evas_Object with the edje layout settings loaded
10287 * with function elm_layout_file_set
10289 * This returns the edje object. It is not expected to be used to then
10290 * swallow objects via edje_object_part_swallow() for example. Use
10291 * elm_object_part_content_set() instead so child object handling and sizing is
10294 * @note This function should only be used if you really need to call some
10295 * low level Edje function on this edje object. All the common stuff (setting
10296 * text, emitting signals, hooking callbacks to signals, etc.) can be done
10297 * with proper elementary functions.
10299 * @see elm_object_signal_callback_add()
10300 * @see elm_object_signal_emit()
10301 * @see elm_object_part_text_set()
10302 * @see elm_object_part_content_set()
10303 * @see elm_layout_box_append()
10304 * @see elm_layout_table_pack()
10305 * @see elm_layout_data_get()
10309 EAPI Evas_Object *elm_layout_edje_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10311 * Get the edje data from the given layout
10313 * @param obj The layout object
10314 * @param key The data key
10316 * @return The edje data string
10318 * This function fetches data specified inside the edje theme of this layout.
10319 * This function return NULL if data is not found.
10321 * In EDC this comes from a data block within the group block that @p
10322 * obj was loaded from. E.g.
10329 * item: "key1" "value1";
10330 * item: "key2" "value2";
10338 EAPI const char *elm_layout_data_get(const Evas_Object *obj, const char *key) EINA_ARG_NONNULL(1, 2);
10342 * @param obj The layout object
10344 * Manually forces a sizing re-evaluation. This is useful when the minimum
10345 * size required by the edje theme of this layout has changed. The change on
10346 * the minimum size required by the edje theme is not immediately reported to
10347 * the elementary layout, so one needs to call this function in order to tell
10348 * the widget (layout) that it needs to reevaluate its own size.
10350 * The minimum size of the theme is calculated based on minimum size of
10351 * parts, the size of elements inside containers like box and table, etc. All
10352 * of this can change due to state changes, and that's when this function
10353 * should be called.
10355 * Also note that a standard signal of "size,eval" "elm" emitted from the
10356 * edje object will cause this to happen too.
10360 EAPI void elm_layout_sizing_eval(Evas_Object *obj) EINA_ARG_NONNULL(1);
10363 * Sets a specific cursor for an edje part.
10365 * @param obj The layout object.
10366 * @param part_name a part from loaded edje group.
10367 * @param cursor cursor name to use, see Elementary_Cursor.h
10369 * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
10370 * part not exists or it has "mouse_events: 0".
10374 EAPI Eina_Bool elm_layout_part_cursor_set(Evas_Object *obj, const char *part_name, const char *cursor) EINA_ARG_NONNULL(1, 2);
10377 * Get the cursor to be shown when mouse is over an edje part
10379 * @param obj The layout object.
10380 * @param part_name a part from loaded edje group.
10381 * @return the cursor name.
10385 EAPI const char *elm_layout_part_cursor_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
10388 * Unsets a cursor previously set with elm_layout_part_cursor_set().
10390 * @param obj The layout object.
10391 * @param part_name a part from loaded edje group, that had a cursor set
10392 * with elm_layout_part_cursor_set().
10396 EAPI void elm_layout_part_cursor_unset(Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
10399 * Sets a specific cursor style for an edje part.
10401 * @param obj The layout object.
10402 * @param part_name a part from loaded edje group.
10403 * @param style the theme style to use (default, transparent, ...)
10405 * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
10406 * part not exists or it did not had a cursor set.
10410 EAPI Eina_Bool elm_layout_part_cursor_style_set(Evas_Object *obj, const char *part_name, const char *style) EINA_ARG_NONNULL(1, 2);
10413 * Gets a specific cursor style for an edje part.
10415 * @param obj The layout object.
10416 * @param part_name a part from loaded edje group.
10418 * @return the theme style in use, defaults to "default". If the
10419 * object does not have a cursor set, then NULL is returned.
10423 EAPI const char *elm_layout_part_cursor_style_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
10426 * Sets if the cursor set should be searched on the theme or should use
10427 * the provided by the engine, only.
10429 * @note before you set if should look on theme you should define a
10430 * cursor with elm_layout_part_cursor_set(). By default it will only
10431 * look for cursors provided by the engine.
10433 * @param obj The layout object.
10434 * @param part_name a part from loaded edje group.
10435 * @param engine_only if cursors should be just provided by the engine (EINA_TRUE)
10436 * or should also search on widget's theme as well (EINA_FALSE)
10438 * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
10439 * part not exists or it did not had a cursor set.
10443 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);
10446 * Gets a specific cursor engine_only for an edje part.
10448 * @param obj The layout object.
10449 * @param part_name a part from loaded edje group.
10451 * @return whenever the cursor is just provided by engine or also from theme.
10455 EAPI Eina_Bool elm_layout_part_cursor_engine_only_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
10458 * @def elm_layout_icon_set
10459 * Convenience macro to set the icon object in a layout that follows the
10460 * Elementary naming convention for its parts.
10464 #define elm_layout_icon_set(_ly, _obj) \
10467 elm_object_part_content_set((_ly), "elm.swallow.icon", (_obj)); \
10468 if ((_obj)) sig = "elm,state,icon,visible"; \
10469 else sig = "elm,state,icon,hidden"; \
10470 elm_object_signal_emit((_ly), sig, "elm"); \
10474 * @def elm_layout_icon_get
10475 * Convienience macro to get the icon object from a layout that follows the
10476 * Elementary naming convention for its parts.
10480 #define elm_layout_icon_get(_ly) \
10481 elm_object_part_content_get((_ly), "elm.swallow.icon")
10484 * @def elm_layout_end_set
10485 * Convienience macro to set the end object in a layout that follows the
10486 * Elementary naming convention for its parts.
10490 #define elm_layout_end_set(_ly, _obj) \
10493 elm_object_part_content_set((_ly), "elm.swallow.end", (_obj)); \
10494 if ((_obj)) sig = "elm,state,end,visible"; \
10495 else sig = "elm,state,end,hidden"; \
10496 elm_object_signal_emit((_ly), sig, "elm"); \
10500 * @def elm_layout_end_get
10501 * Convienience macro to get the end object in a layout that follows the
10502 * Elementary naming convention for its parts.
10506 #define elm_layout_end_get(_ly) \
10507 elm_object_part_content_get((_ly), "elm.swallow.end")
10510 * @def elm_layout_label_set
10511 * Convienience macro to set the label in a layout that follows the
10512 * Elementary naming convention for its parts.
10515 * @deprecated use elm_object_text_set() instead.
10517 #define elm_layout_label_set(_ly, _txt) \
10518 elm_layout_text_set((_ly), "elm.text", (_txt))
10521 * @def elm_layout_label_get
10522 * Convenience macro to get the label in a layout that follows the
10523 * Elementary naming convention for its parts.
10526 * @deprecated use elm_object_text_set() instead.
10528 #define elm_layout_label_get(_ly) \
10529 elm_layout_text_get((_ly), "elm.text")
10531 /* smart callbacks called:
10532 * "theme,changed" - when elm theme is changed.
10536 * @defgroup Notify Notify
10538 * @image html img/widget/notify/preview-00.png
10539 * @image latex img/widget/notify/preview-00.eps
10541 * Display a container in a particular region of the parent(top, bottom,
10542 * etc). A timeout can be set to automatically hide the notify. This is so
10543 * that, after an evas_object_show() on a notify object, if a timeout was set
10544 * on it, it will @b automatically get hidden after that time.
10546 * Signals that you can add callbacks for are:
10547 * @li "timeout" - when timeout happens on notify and it's hidden
10548 * @li "block,clicked" - when a click outside of the notify happens
10550 * Default contents parts of the notify widget that you can use for are:
10551 * @li "default" - A content of the notify
10553 * @ref tutorial_notify show usage of the API.
10558 * @brief Possible orient values for notify.
10560 * This values should be used in conjunction to elm_notify_orient_set() to
10561 * set the position in which the notify should appear(relative to its parent)
10562 * and in conjunction with elm_notify_orient_get() to know where the notify
10565 typedef enum _Elm_Notify_Orient
10567 ELM_NOTIFY_ORIENT_TOP, /**< Notify should appear in the top of parent, default */
10568 ELM_NOTIFY_ORIENT_CENTER, /**< Notify should appear in the center of parent */
10569 ELM_NOTIFY_ORIENT_BOTTOM, /**< Notify should appear in the bottom of parent */
10570 ELM_NOTIFY_ORIENT_LEFT, /**< Notify should appear in the left of parent */
10571 ELM_NOTIFY_ORIENT_RIGHT, /**< Notify should appear in the right of parent */
10572 ELM_NOTIFY_ORIENT_TOP_LEFT, /**< Notify should appear in the top left of parent */
10573 ELM_NOTIFY_ORIENT_TOP_RIGHT, /**< Notify should appear in the top right of parent */
10574 ELM_NOTIFY_ORIENT_BOTTOM_LEFT, /**< Notify should appear in the bottom left of parent */
10575 ELM_NOTIFY_ORIENT_BOTTOM_RIGHT, /**< Notify should appear in the bottom right of parent */
10576 ELM_NOTIFY_ORIENT_LAST /**< Sentinel value, @b don't use */
10577 } Elm_Notify_Orient;
10579 * @brief Add a new notify to the parent
10581 * @param parent The parent object
10582 * @return The new object or NULL if it cannot be created
10584 EAPI Evas_Object *elm_notify_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10586 * @brief Set the content of the notify widget
10588 * @param obj The notify object
10589 * @param content The content will be filled in this notify object
10591 * Once the content object is set, a previously set one will be deleted. If
10592 * you want to keep that old content object, use the
10593 * elm_notify_content_unset() function.
10595 * @deprecated use elm_object_content_set() instead
10598 EINA_DEPRECATED EAPI void elm_notify_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
10600 * @brief Unset the content of the notify widget
10602 * @param obj The notify object
10603 * @return The content that was being used
10605 * Unparent and return the content object which was set for this widget
10607 * @see elm_notify_content_set()
10608 * @deprecated use elm_object_content_unset() instead
10611 EINA_DEPRECATED EAPI Evas_Object *elm_notify_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
10613 * @brief Return the content of the notify widget
10615 * @param obj The notify object
10616 * @return The content that is being used
10618 * @see elm_notify_content_set()
10619 * @deprecated use elm_object_content_get() instead
10622 EINA_DEPRECATED EAPI Evas_Object *elm_notify_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10624 * @brief Set the notify parent
10626 * @param obj The notify object
10627 * @param content The new parent
10629 * Once the parent object is set, a previously set one will be disconnected
10632 EAPI void elm_notify_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
10634 * @brief Get the notify parent
10636 * @param obj The notify object
10637 * @return The parent
10639 * @see elm_notify_parent_set()
10641 EAPI Evas_Object *elm_notify_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10643 * @brief Set the orientation
10645 * @param obj The notify object
10646 * @param orient The new orientation
10648 * Sets the position in which the notify will appear in its parent.
10650 * @see @ref Elm_Notify_Orient for possible values.
10652 EAPI void elm_notify_orient_set(Evas_Object *obj, Elm_Notify_Orient orient) EINA_ARG_NONNULL(1);
10654 * @brief Return the orientation
10655 * @param obj The notify object
10656 * @return The orientation of the notification
10658 * @see elm_notify_orient_set()
10659 * @see Elm_Notify_Orient
10661 EAPI Elm_Notify_Orient elm_notify_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10663 * @brief Set the time interval after which the notify window is going to be
10666 * @param obj The notify object
10667 * @param time The timeout in seconds
10669 * This function sets a timeout and starts the timer controlling when the
10670 * notify is hidden. Since calling evas_object_show() on a notify restarts
10671 * the timer controlling when the notify is hidden, setting this before the
10672 * notify is shown will in effect mean starting the timer when the notify is
10675 * @note Set a value <= 0.0 to disable a running timer.
10677 * @note If the value > 0.0 and the notify is previously visible, the
10678 * timer will be started with this value, canceling any running timer.
10680 EAPI void elm_notify_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
10682 * @brief Return the timeout value (in seconds)
10683 * @param obj the notify object
10685 * @see elm_notify_timeout_set()
10687 EAPI double elm_notify_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10689 * @brief Sets whether events should be passed to by a click outside
10692 * @param obj The notify object
10693 * @param repeats EINA_TRUE Events are repeats, else no
10695 * When true if the user clicks outside the window the events will be caught
10696 * by the others widgets, else the events are blocked.
10698 * @note The default value is EINA_TRUE.
10700 EAPI void elm_notify_repeat_events_set(Evas_Object *obj, Eina_Bool repeat) EINA_ARG_NONNULL(1);
10702 * @brief Return true if events are repeat below the notify object
10703 * @param obj the notify object
10705 * @see elm_notify_repeat_events_set()
10707 EAPI Eina_Bool elm_notify_repeat_events_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10713 * @defgroup Hover Hover
10715 * @image html img/widget/hover/preview-00.png
10716 * @image latex img/widget/hover/preview-00.eps
10718 * A Hover object will hover over its @p parent object at the @p target
10719 * location. Anything in the background will be given a darker coloring to
10720 * indicate that the hover object is on top (at the default theme). When the
10721 * hover is clicked it is dismissed(hidden), if the contents of the hover are
10722 * clicked that @b doesn't cause the hover to be dismissed.
10724 * A Hover object has two parents. One parent that owns it during creation
10725 * and the other parent being the one over which the hover object spans.
10728 * @note The hover object will take up the entire space of @p target
10731 * Elementary has the following styles for the hover widget:
10735 * @li hoversel_vertical
10737 * The following are the available position for content:
10749 * Signals that you can add callbacks for are:
10750 * @li "clicked" - the user clicked the empty space in the hover to dismiss
10751 * @li "smart,changed" - a content object placed under the "smart"
10752 * policy was replaced to a new slot direction.
10754 * See @ref tutorial_hover for more information.
10758 typedef enum _Elm_Hover_Axis
10760 ELM_HOVER_AXIS_NONE, /**< ELM_HOVER_AXIS_NONE -- no prefered orientation */
10761 ELM_HOVER_AXIS_HORIZONTAL, /**< ELM_HOVER_AXIS_HORIZONTAL -- horizontal */
10762 ELM_HOVER_AXIS_VERTICAL, /**< ELM_HOVER_AXIS_VERTICAL -- vertical */
10763 ELM_HOVER_AXIS_BOTH /**< ELM_HOVER_AXIS_BOTH -- both */
10766 * @brief Adds a hover object to @p parent
10768 * @param parent The parent object
10769 * @return The hover object or NULL if one could not be created
10771 EAPI Evas_Object *elm_hover_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10773 * @brief Sets the target object for the hover.
10775 * @param obj The hover object
10776 * @param target The object to center the hover onto.
10778 * This function will cause the hover to be centered on the target object.
10780 EAPI void elm_hover_target_set(Evas_Object *obj, Evas_Object *target) EINA_ARG_NONNULL(1);
10782 * @brief Gets the target object for the hover.
10784 * @param obj The hover object
10785 * @return The target object for the hover.
10787 * @see elm_hover_target_set()
10789 EAPI Evas_Object *elm_hover_target_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10791 * @brief Sets the parent object for the hover.
10793 * @param obj The hover object
10794 * @param parent The object to locate the hover over.
10796 * This function will cause the hover to take up the entire space that the
10797 * parent object fills.
10799 EAPI void elm_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
10801 * @brief Gets the parent object for the hover.
10803 * @param obj The hover object
10804 * @return The parent object to locate the hover over.
10806 * @see elm_hover_parent_set()
10808 EAPI Evas_Object *elm_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10810 * @brief Sets the content of the hover object and the direction in which it
10813 * @param obj The hover object
10814 * @param swallow The direction that the object will be displayed
10815 * at. Accepted values are "left", "top-left", "top", "top-right",
10816 * "right", "bottom-right", "bottom", "bottom-left", "middle" and
10818 * @param content The content to place at @p swallow
10820 * Once the content object is set for a given direction, a previously
10821 * set one (on the same direction) will be deleted. If you want to
10822 * keep that old content object, use the elm_hover_content_unset()
10825 * All directions may have contents at the same time, except for
10826 * "smart". This is a special placement hint and its use case
10827 * independs of the calculations coming from
10828 * elm_hover_best_content_location_get(). Its use is for cases when
10829 * one desires only one hover content, but with a dynamic special
10830 * placement within the hover area. The content's geometry, whenever
10831 * it changes, will be used to decide on a best location, not
10832 * extrapolating the hover's parent object view to show it in (still
10833 * being the hover's target determinant of its medium part -- move and
10834 * resize it to simulate finger sizes, for example). If one of the
10835 * directions other than "smart" are used, a previously content set
10836 * using it will be deleted, and vice-versa.
10838 EAPI void elm_hover_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content) EINA_ARG_NONNULL(1);
10840 * @brief Get the content of the hover object, in a given direction.
10842 * Return the content object which was set for this widget in the
10843 * @p swallow direction.
10845 * @param obj The hover object
10846 * @param swallow The direction that the object was display at.
10847 * @return The content that was being used
10849 * @see elm_hover_content_set()
10851 EAPI Evas_Object *elm_hover_content_get(const Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
10853 * @brief Unset the content of the hover object, in a given direction.
10855 * Unparent and return the content object set at @p swallow direction.
10857 * @param obj The hover object
10858 * @param swallow The direction that the object was display at.
10859 * @return The content that was being used.
10861 * @see elm_hover_content_set()
10863 EAPI Evas_Object *elm_hover_content_unset(Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
10865 * @brief Returns the best swallow location for content in the hover.
10867 * @param obj The hover object
10868 * @param pref_axis The preferred orientation axis for the hover object to use
10869 * @return The edje location to place content into the hover or @c
10872 * Best is defined here as the location at which there is the most available
10875 * @p pref_axis may be one of
10876 * - @c ELM_HOVER_AXIS_NONE -- no prefered orientation
10877 * - @c ELM_HOVER_AXIS_HORIZONTAL -- horizontal
10878 * - @c ELM_HOVER_AXIS_VERTICAL -- vertical
10879 * - @c ELM_HOVER_AXIS_BOTH -- both
10881 * If ELM_HOVER_AXIS_HORIZONTAL is choosen the returned position will
10882 * nescessarily be along the horizontal axis("left" or "right"). If
10883 * ELM_HOVER_AXIS_VERTICAL is choosen the returned position will nescessarily
10884 * be along the vertical axis("top" or "bottom"). Chossing
10885 * ELM_HOVER_AXIS_BOTH or ELM_HOVER_AXIS_NONE has the same effect and the
10886 * returned position may be in either axis.
10888 * @see elm_hover_content_set()
10890 EAPI const char *elm_hover_best_content_location_get(const Evas_Object *obj, Elm_Hover_Axis pref_axis) EINA_ARG_NONNULL(1);
10897 * @defgroup Entry Entry
10899 * @image html img/widget/entry/preview-00.png
10900 * @image latex img/widget/entry/preview-00.eps width=\textwidth
10901 * @image html img/widget/entry/preview-01.png
10902 * @image latex img/widget/entry/preview-01.eps width=\textwidth
10903 * @image html img/widget/entry/preview-02.png
10904 * @image latex img/widget/entry/preview-02.eps width=\textwidth
10905 * @image html img/widget/entry/preview-03.png
10906 * @image latex img/widget/entry/preview-03.eps width=\textwidth
10908 * An entry is a convenience widget which shows a box that the user can
10909 * enter text into. Entries by default don't scroll, so they grow to
10910 * accomodate the entire text, resizing the parent window as needed. This
10911 * can be changed with the elm_entry_scrollable_set() function.
10913 * They can also be single line or multi line (the default) and when set
10914 * to multi line mode they support text wrapping in any of the modes
10915 * indicated by #Elm_Wrap_Type.
10917 * Other features include password mode, filtering of inserted text with
10918 * elm_entry_text_filter_append() and related functions, inline "items" and
10919 * formatted markup text.
10921 * @section entry-markup Formatted text
10923 * The markup tags supported by the Entry are defined by the theme, but
10924 * even when writing new themes or extensions it's a good idea to stick to
10925 * a sane default, to maintain coherency and avoid application breakages.
10926 * Currently defined by the default theme are the following tags:
10927 * @li \<br\>: Inserts a line break.
10928 * @li \<ps\>: Inserts a paragraph separator. This is preferred over line
10930 * @li \<tab\>: Inserts a tab.
10931 * @li \<em\>...\</em\>: Emphasis. Sets the @em oblique style for the
10933 * @li \<b\>...\</b\>: Sets the @b bold style for the enclosed text.
10934 * @li \<link\>...\</link\>: Underlines the enclosed text.
10935 * @li \<hilight\>...\</hilight\>: Hilights the enclosed text.
10937 * @section entry-special Special markups
10939 * Besides those used to format text, entries support two special markup
10940 * tags used to insert clickable portions of text or items inlined within
10943 * @subsection entry-anchors Anchors
10945 * Anchors are similar to HTML anchors. Text can be surrounded by \<a\> and
10946 * \</a\> tags and an event will be generated when this text is clicked,
10950 * This text is outside <a href=anc-01>but this one is an anchor</a>
10953 * The @c href attribute in the opening tag gives the name that will be
10954 * used to identify the anchor and it can be any valid utf8 string.
10956 * When an anchor is clicked, an @c "anchor,clicked" signal is emitted with
10957 * an #Elm_Entry_Anchor_Info in the @c event_info parameter for the
10958 * callback function. The same applies for "anchor,in" (mouse in), "anchor,out"
10959 * (mouse out), "anchor,down" (mouse down), and "anchor,up" (mouse up) events on
10962 * @subsection entry-items Items
10964 * Inlined in the text, any other @c Evas_Object can be inserted by using
10965 * \<item\> tags this way:
10968 * <item size=16x16 vsize=full href=emoticon/haha></item>
10971 * Just like with anchors, the @c href identifies each item, but these need,
10972 * in addition, to indicate their size, which is done using any one of
10973 * @c size, @c absize or @c relsize attributes. These attributes take their
10974 * value in the WxH format, where W is the width and H the height of the
10977 * @li absize: Absolute pixel size for the item. Whatever value is set will
10978 * be the item's size regardless of any scale value the object may have
10979 * been set to. The final line height will be adjusted to fit larger items.
10980 * @li size: Similar to @c absize, but it's adjusted to the scale value set
10982 * @li relsize: Size is adjusted for the item to fit within the current
10985 * Besides their size, items are specificed a @c vsize value that affects
10986 * how their final size and position are calculated. The possible values
10988 * @li ascent: Item will be placed within the line's baseline and its
10989 * ascent. That is, the height between the line where all characters are
10990 * positioned and the highest point in the line. For @c size and @c absize
10991 * items, the descent value will be added to the total line height to make
10992 * them fit. @c relsize items will be adjusted to fit within this space.
10993 * @li full: Items will be placed between the descent and ascent, or the
10994 * lowest point in the line and its highest.
10996 * The next image shows different configurations of items and how
10997 * the previously mentioned options affect their sizes. In all cases,
10998 * the green line indicates the ascent, blue for the baseline and red for
11001 * @image html entry_item.png
11002 * @image latex entry_item.eps width=\textwidth
11004 * And another one to show how size differs from absize. In the first one,
11005 * the scale value is set to 1.0, while the second one is using one of 2.0.
11007 * @image html entry_item_scale.png
11008 * @image latex entry_item_scale.eps width=\textwidth
11010 * After the size for an item is calculated, the entry will request an
11011 * object to place in its space. For this, the functions set with
11012 * elm_entry_item_provider_append() and related functions will be called
11013 * in order until one of them returns a @c non-NULL value. If no providers
11014 * are available, or all of them return @c NULL, then the entry falls back
11015 * to one of the internal defaults, provided the name matches with one of
11018 * All of the following are currently supported:
11021 * - emoticon/angry-shout
11022 * - emoticon/crazy-laugh
11023 * - emoticon/evil-laugh
11025 * - emoticon/goggle-smile
11026 * - emoticon/grumpy
11027 * - emoticon/grumpy-smile
11028 * - emoticon/guilty
11029 * - emoticon/guilty-smile
11031 * - emoticon/half-smile
11032 * - emoticon/happy-panting
11034 * - emoticon/indifferent
11036 * - emoticon/knowing-grin
11038 * - emoticon/little-bit-sorry
11039 * - emoticon/love-lots
11041 * - emoticon/minimal-smile
11042 * - emoticon/not-happy
11043 * - emoticon/not-impressed
11045 * - emoticon/opensmile
11048 * - emoticon/squint-laugh
11049 * - emoticon/surprised
11050 * - emoticon/suspicious
11051 * - emoticon/tongue-dangling
11052 * - emoticon/tongue-poke
11054 * - emoticon/unhappy
11055 * - emoticon/very-sorry
11058 * - emoticon/worried
11061 * Alternatively, an item may reference an image by its path, using
11062 * the URI form @c file:///path/to/an/image.png and the entry will then
11063 * use that image for the item.
11065 * @section entry-files Loading and saving files
11067 * Entries have convinience functions to load text from a file and save
11068 * changes back to it after a short delay. The automatic saving is enabled
11069 * by default, but can be disabled with elm_entry_autosave_set() and files
11070 * can be loaded directly as plain text or have any markup in them
11071 * recognized. See elm_entry_file_set() for more details.
11073 * @section entry-signals Emitted signals
11075 * This widget emits the following signals:
11077 * @li "changed": The text within the entry was changed.
11078 * @li "changed,user": The text within the entry was changed because of user interaction.
11079 * @li "activated": The enter key was pressed on a single line entry.
11080 * @li "press": A mouse button has been pressed on the entry.
11081 * @li "longpressed": A mouse button has been pressed and held for a couple
11083 * @li "clicked": The entry has been clicked (mouse press and release).
11084 * @li "clicked,double": The entry has been double clicked.
11085 * @li "clicked,triple": The entry has been triple clicked.
11086 * @li "focused": The entry has received focus.
11087 * @li "unfocused": The entry has lost focus.
11088 * @li "selection,paste": A paste of the clipboard contents was requested.
11089 * @li "selection,copy": A copy of the selected text into the clipboard was
11091 * @li "selection,cut": A cut of the selected text into the clipboard was
11093 * @li "selection,start": A selection has begun and no previous selection
11095 * @li "selection,changed": The current selection has changed.
11096 * @li "selection,cleared": The current selection has been cleared.
11097 * @li "cursor,changed": The cursor has changed position.
11098 * @li "anchor,clicked": An anchor has been clicked. The event_info
11099 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
11100 * @li "anchor,in": Mouse cursor has moved into an anchor. The event_info
11101 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
11102 * @li "anchor,out": Mouse cursor has moved out of an anchor. The event_info
11103 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
11104 * @li "anchor,up": Mouse button has been unpressed on an anchor. The event_info
11105 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
11106 * @li "anchor,down": Mouse button has been pressed on an anchor. The event_info
11107 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
11108 * @li "preedit,changed": The preedit string has changed.
11109 * @li "language,changed": Program language changed.
11111 * @section entry-examples
11113 * An overview of the Entry API can be seen in @ref entry_example_01
11118 * @typedef Elm_Entry_Anchor_Info
11120 * The info sent in the callback for the "anchor,clicked" signals emitted
11123 typedef struct _Elm_Entry_Anchor_Info Elm_Entry_Anchor_Info;
11125 * @struct _Elm_Entry_Anchor_Info
11127 * The info sent in the callback for the "anchor,clicked" signals emitted
11130 struct _Elm_Entry_Anchor_Info
11132 const char *name; /**< The name of the anchor, as stated in its href */
11133 int button; /**< The mouse button used to click on it */
11134 Evas_Coord x, /**< Anchor geometry, relative to canvas */
11135 y, /**< Anchor geometry, relative to canvas */
11136 w, /**< Anchor geometry, relative to canvas */
11137 h; /**< Anchor geometry, relative to canvas */
11140 * @typedef Elm_Entry_Filter_Cb
11141 * This callback type is used by entry filters to modify text.
11142 * @param data The data specified as the last param when adding the filter
11143 * @param entry The entry object
11144 * @param text A pointer to the location of the text being filtered. This data can be modified,
11145 * but any additional allocations must be managed by the user.
11146 * @see elm_entry_text_filter_append
11147 * @see elm_entry_text_filter_prepend
11149 typedef void (*Elm_Entry_Filter_Cb)(void *data, Evas_Object *entry, char **text);
11152 * @typedef Elm_Entry_Change_Info
11153 * This corresponds to Edje_Entry_Change_Info. Includes information about
11154 * a change in the entry.
11156 typedef Edje_Entry_Change_Info Elm_Entry_Change_Info;
11160 * This adds an entry to @p parent object.
11162 * By default, entries are:
11166 * @li autosave is enabled
11168 * @param parent The parent object
11169 * @return The new object or NULL if it cannot be created
11171 EAPI Evas_Object *elm_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
11173 * Sets the entry to single line mode.
11175 * In single line mode, entries don't ever wrap when the text reaches the
11176 * edge, and instead they keep growing horizontally. Pressing the @c Enter
11177 * key will generate an @c "activate" event instead of adding a new line.
11179 * When @p single_line is @c EINA_FALSE, line wrapping takes effect again
11180 * and pressing enter will break the text into a different line
11181 * without generating any events.
11183 * @param obj The entry object
11184 * @param single_line If true, the text in the entry
11185 * will be on a single line.
11187 EAPI void elm_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line) EINA_ARG_NONNULL(1);
11189 * Gets whether the entry is set to be single line.
11191 * @param obj The entry object
11192 * @return single_line If true, the text in the entry is set to display
11193 * on a single line.
11195 * @see elm_entry_single_line_set()
11197 EAPI Eina_Bool elm_entry_single_line_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11199 * Sets the entry to password mode.
11201 * In password mode, entries are implicitly single line and the display of
11202 * any text in them is replaced with asterisks (*).
11204 * @param obj The entry object
11205 * @param password If true, password mode is enabled.
11207 EAPI void elm_entry_password_set(Evas_Object *obj, Eina_Bool password) EINA_ARG_NONNULL(1);
11209 * Gets whether the entry is set to password mode.
11211 * @param obj The entry object
11212 * @return If true, the entry is set to display all characters
11213 * as asterisks (*).
11215 * @see elm_entry_password_set()
11217 EAPI Eina_Bool elm_entry_password_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11219 * This sets the text displayed within the entry to @p entry.
11221 * @param obj The entry object
11222 * @param entry The text to be displayed
11224 * @deprecated Use elm_object_text_set() instead.
11225 * @note Using this function bypasses text filters
11227 EAPI void elm_entry_entry_set(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
11229 * This returns the text currently shown in object @p entry.
11230 * See also elm_entry_entry_set().
11232 * @param obj The entry object
11233 * @return The currently displayed text or NULL on failure
11235 * @deprecated Use elm_object_text_get() instead.
11237 EAPI const char *elm_entry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11239 * Appends @p entry to the text of the entry.
11241 * Adds the text in @p entry to the end of any text already present in the
11244 * The appended text is subject to any filters set for the widget.
11246 * @param obj The entry object
11247 * @param entry The text to be displayed
11249 * @see elm_entry_text_filter_append()
11251 EAPI void elm_entry_entry_append(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
11253 * Gets whether the entry is empty.
11255 * Empty means no text at all. If there are any markup tags, like an item
11256 * tag for which no provider finds anything, and no text is displayed, this
11257 * function still returns EINA_FALSE.
11259 * @param obj The entry object
11260 * @return EINA_TRUE if the entry is empty, EINA_FALSE otherwise.
11262 EAPI Eina_Bool elm_entry_is_empty(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11264 * Gets any selected text within the entry.
11266 * If there's any selected text in the entry, this function returns it as
11267 * a string in markup format. NULL is returned if no selection exists or
11268 * if an error occurred.
11270 * The returned value points to an internal string and should not be freed
11271 * or modified in any way. If the @p entry object is deleted or its
11272 * contents are changed, the returned pointer should be considered invalid.
11274 * @param obj The entry object
11275 * @return The selected text within the entry or NULL on failure
11277 EAPI const char *elm_entry_selection_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11279 * Returns the actual textblock object of the entry.
11281 * This function exposes the internal textblock object that actually
11282 * contains and draws the text. This should be used for low-level
11283 * manipulations that are otherwise not possible.
11285 * Changing the textblock directly from here will not notify edje/elm to
11286 * recalculate the textblock size automatically, so any modifications
11287 * done to the textblock returned by this function should be followed by
11288 * a call to elm_entry_calc_force().
11290 * The return value is marked as const as an additional warning.
11291 * One should not use the returned object with any of the generic evas
11292 * functions (geometry_get/resize/move and etc), but only with the textblock
11293 * functions; The former will either not work at all, or break the correct
11296 * IMPORTANT: Many functions may change (i.e delete and create a new one)
11297 * the internal textblock object. Do NOT cache the returned object, and try
11298 * not to mix calls on this object with regular elm_entry calls (which may
11299 * change the internal textblock object). This applies to all cursors
11300 * returned from textblock calls, and all the other derivative values.
11302 * @param obj The entry object
11303 * @return The textblock object.
11305 EAPI const Evas_Object *elm_entry_textblock_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11307 * Forces calculation of the entry size and text layouting.
11309 * This should be used after modifying the textblock object directly. See
11310 * elm_entry_textblock_get() for more information.
11312 * @param obj The entry object
11314 * @see elm_entry_textblock_get()
11316 EAPI void elm_entry_calc_force(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11318 * Inserts the given text into the entry at the current cursor position.
11320 * This inserts text at the cursor position as if it was typed
11321 * by the user (note that this also allows markup which a user
11322 * can't just "type" as it would be converted to escaped text, so this
11323 * call can be used to insert things like emoticon items or bold push/pop
11324 * tags, other font and color change tags etc.)
11326 * If any selection exists, it will be replaced by the inserted text.
11328 * The inserted text is subject to any filters set for the widget.
11330 * @param obj The entry object
11331 * @param entry The text to insert
11333 * @see elm_entry_text_filter_append()
11335 EAPI void elm_entry_entry_insert(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
11337 * Set the line wrap type to use on multi-line entries.
11339 * Sets the wrap type used by the entry to any of the specified in
11340 * #Elm_Wrap_Type. This tells how the text will be implicitly cut into a new
11341 * line (without inserting a line break or paragraph separator) when it
11342 * reaches the far edge of the widget.
11344 * Note that this only makes sense for multi-line entries. A widget set
11345 * to be single line will never wrap.
11347 * @param obj The entry object
11348 * @param wrap The wrap mode to use. See #Elm_Wrap_Type for details on them
11350 EAPI void elm_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
11352 * Gets the wrap mode the entry was set to use.
11354 * @param obj The entry object
11355 * @return Wrap type
11357 * @see also elm_entry_line_wrap_set()
11359 EAPI Elm_Wrap_Type elm_entry_line_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11361 * Sets if the entry is to be editable or not.
11363 * By default, entries are editable and when focused, any text input by the
11364 * user will be inserted at the current cursor position. But calling this
11365 * function with @p editable as EINA_FALSE will prevent the user from
11366 * inputting text into the entry.
11368 * The only way to change the text of a non-editable entry is to use
11369 * elm_object_text_set(), elm_entry_entry_insert() and other related
11372 * @param obj The entry object
11373 * @param editable If EINA_TRUE, user input will be inserted in the entry,
11374 * if not, the entry is read-only and no user input is allowed.
11376 EAPI void elm_entry_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
11378 * Gets whether the entry is editable or not.
11380 * @param obj The entry object
11381 * @return If true, the entry is editable by the user.
11382 * If false, it is not editable by the user
11384 * @see elm_entry_editable_set()
11386 EAPI Eina_Bool elm_entry_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11388 * This drops any existing text selection within the entry.
11390 * @param obj The entry object
11392 EAPI void elm_entry_select_none(Evas_Object *obj) EINA_ARG_NONNULL(1);
11394 * This selects all text within the entry.
11396 * @param obj The entry object
11398 EAPI void elm_entry_select_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
11400 * This moves the cursor one place to the right within the entry.
11402 * @param obj The entry object
11403 * @return EINA_TRUE upon success, EINA_FALSE upon failure
11405 EAPI Eina_Bool elm_entry_cursor_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
11407 * This moves the cursor one place to the left within the entry.
11409 * @param obj The entry object
11410 * @return EINA_TRUE upon success, EINA_FALSE upon failure
11412 EAPI Eina_Bool elm_entry_cursor_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
11414 * This moves the cursor one line up within the entry.
11416 * @param obj The entry object
11417 * @return EINA_TRUE upon success, EINA_FALSE upon failure
11419 EAPI Eina_Bool elm_entry_cursor_up(Evas_Object *obj) EINA_ARG_NONNULL(1);
11421 * This moves the cursor one line down within the entry.
11423 * @param obj The entry object
11424 * @return EINA_TRUE upon success, EINA_FALSE upon failure
11426 EAPI Eina_Bool elm_entry_cursor_down(Evas_Object *obj) EINA_ARG_NONNULL(1);
11428 * This moves the cursor to the beginning of the entry.
11430 * @param obj The entry object
11432 EAPI void elm_entry_cursor_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
11434 * This moves the cursor to the end of the entry.
11436 * @param obj The entry object
11438 EAPI void elm_entry_cursor_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
11440 * This moves the cursor to the beginning of the current line.
11442 * @param obj The entry object
11444 EAPI void elm_entry_cursor_line_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
11446 * This moves the cursor to the end of the current line.
11448 * @param obj The entry object
11450 EAPI void elm_entry_cursor_line_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
11452 * This begins a selection within the entry as though
11453 * the user were holding down the mouse button to make a selection.
11455 * @param obj The entry object
11457 EAPI void elm_entry_cursor_selection_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
11459 * This ends a selection within the entry as though
11460 * the user had just released the mouse button while making a selection.
11462 * @param obj The entry object
11464 EAPI void elm_entry_cursor_selection_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
11466 * Gets whether a format node exists at the current cursor position.
11468 * A format node is anything that defines how the text is rendered. It can
11469 * be a visible format node, such as a line break or a paragraph separator,
11470 * or an invisible one, such as bold begin or end tag.
11471 * This function returns whether any format node exists at the current
11474 * @param obj The entry object
11475 * @return EINA_TRUE if the current cursor position contains a format node,
11476 * EINA_FALSE otherwise.
11478 * @see elm_entry_cursor_is_visible_format_get()
11480 EAPI Eina_Bool elm_entry_cursor_is_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11482 * Gets if the current cursor position holds a visible format node.
11484 * @param obj The entry object
11485 * @return EINA_TRUE if the current cursor is a visible format, EINA_FALSE
11486 * if it's an invisible one or no format exists.
11488 * @see elm_entry_cursor_is_format_get()
11490 EAPI Eina_Bool elm_entry_cursor_is_visible_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11492 * Gets the character pointed by the cursor at its current position.
11494 * This function returns a string with the utf8 character stored at the
11495 * current cursor position.
11496 * Only the text is returned, any format that may exist will not be part
11497 * of the return value.
11499 * @param obj The entry object
11500 * @return The text pointed by the cursors.
11502 EAPI const char *elm_entry_cursor_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11504 * This function returns the geometry of the cursor.
11506 * It's useful if you want to draw something on the cursor (or where it is),
11507 * or for example in the case of scrolled entry where you want to show the
11510 * @param obj The entry object
11511 * @param x returned geometry
11512 * @param y returned geometry
11513 * @param w returned geometry
11514 * @param h returned geometry
11515 * @return EINA_TRUE upon success, EINA_FALSE upon failure
11517 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);
11519 * Sets the cursor position in the entry to the given value
11521 * The value in @p pos is the index of the character position within the
11522 * contents of the string as returned by elm_entry_cursor_pos_get().
11524 * @param obj The entry object
11525 * @param pos The position of the cursor
11527 EAPI void elm_entry_cursor_pos_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
11529 * Retrieves the current position of the cursor in the entry
11531 * @param obj The entry object
11532 * @return The cursor position
11534 EAPI int elm_entry_cursor_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11536 * This executes a "cut" action on the selected text in the entry.
11538 * @param obj The entry object
11540 EAPI void elm_entry_selection_cut(Evas_Object *obj) EINA_ARG_NONNULL(1);
11542 * This executes a "copy" action on the selected text in the entry.
11544 * @param obj The entry object
11546 EAPI void elm_entry_selection_copy(Evas_Object *obj) EINA_ARG_NONNULL(1);
11548 * This executes a "paste" action in the entry.
11550 * @param obj The entry object
11552 EAPI void elm_entry_selection_paste(Evas_Object *obj) EINA_ARG_NONNULL(1);
11554 * This clears and frees the items in a entry's contextual (longpress)
11557 * @param obj The entry object
11559 * @see elm_entry_context_menu_item_add()
11561 EAPI void elm_entry_context_menu_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
11563 * This adds an item to the entry's contextual menu.
11565 * A longpress on an entry will make the contextual menu show up, if this
11566 * hasn't been disabled with elm_entry_context_menu_disabled_set().
11567 * By default, this menu provides a few options like enabling selection mode,
11568 * which is useful on embedded devices that need to be explicit about it,
11569 * and when a selection exists it also shows the copy and cut actions.
11571 * With this function, developers can add other options to this menu to
11572 * perform any action they deem necessary.
11574 * @param obj The entry object
11575 * @param label The item's text label
11576 * @param icon_file The item's icon file
11577 * @param icon_type The item's icon type
11578 * @param func The callback to execute when the item is clicked
11579 * @param data The data to associate with the item for related functions
11581 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);
11583 * This disables the entry's contextual (longpress) menu.
11585 * @param obj The entry object
11586 * @param disabled If true, the menu is disabled
11588 EAPI void elm_entry_context_menu_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
11590 * This returns whether the entry's contextual (longpress) menu is
11593 * @param obj The entry object
11594 * @return If true, the menu is disabled
11596 EAPI Eina_Bool elm_entry_context_menu_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11598 * This appends a custom item provider to the list for that entry
11600 * This appends the given callback. The list is walked from beginning to end
11601 * with each function called given the item href string in the text. If the
11602 * function returns an object handle other than NULL (it should create an
11603 * object to do this), then this object is used to replace that item. If
11604 * not the next provider is called until one provides an item object, or the
11605 * default provider in entry does.
11607 * @param obj The entry object
11608 * @param func The function called to provide the item object
11609 * @param data The data passed to @p func
11611 * @see @ref entry-items
11613 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);
11615 * This prepends a custom item provider to the list for that entry
11617 * This prepends the given callback. See elm_entry_item_provider_append() for
11620 * @param obj The entry object
11621 * @param func The function called to provide the item object
11622 * @param data The data passed to @p func
11624 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);
11626 * This removes a custom item provider to the list for that entry
11628 * This removes the given callback. See elm_entry_item_provider_append() for
11631 * @param obj The entry object
11632 * @param func The function called to provide the item object
11633 * @param data The data passed to @p func
11635 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);
11637 * Append a filter function for text inserted in the entry
11639 * Append the given callback to the list. This functions will be called
11640 * whenever any text is inserted into the entry, with the text to be inserted
11641 * as a parameter. The callback function is free to alter the text in any way
11642 * it wants, but it must remember to free the given pointer and update it.
11643 * If the new text is to be discarded, the function can free it and set its
11644 * text parameter to NULL. This will also prevent any following filters from
11647 * @param obj The entry object
11648 * @param func The function to use as text filter
11649 * @param data User data to pass to @p func
11651 EAPI void elm_entry_text_filter_append(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
11653 * Prepend a filter function for text insdrted in the entry
11655 * Prepend the given callback to the list. See elm_entry_text_filter_append()
11656 * for more information
11658 * @param obj The entry object
11659 * @param func The function to use as text filter
11660 * @param data User data to pass to @p func
11662 EAPI void elm_entry_text_filter_prepend(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
11664 * Remove a filter from the list
11666 * Removes the given callback from the filter list. See
11667 * elm_entry_text_filter_append() for more information.
11669 * @param obj The entry object
11670 * @param func The filter function to remove
11671 * @param data The user data passed when adding the function
11673 EAPI void elm_entry_text_filter_remove(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
11675 * This converts a markup (HTML-like) string into UTF-8.
11677 * The returned string is a malloc'ed buffer and it should be freed when
11678 * not needed anymore.
11680 * @param s The string (in markup) to be converted
11681 * @return The converted string (in UTF-8). It should be freed.
11683 EAPI char *elm_entry_markup_to_utf8(const char *s) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
11685 * This converts a UTF-8 string into markup (HTML-like).
11687 * The returned string is a malloc'ed buffer and it should be freed when
11688 * not needed anymore.
11690 * @param s The string (in UTF-8) to be converted
11691 * @return The converted string (in markup). It should be freed.
11693 EAPI char *elm_entry_utf8_to_markup(const char *s) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
11695 * This sets the file (and implicitly loads it) for the text to display and
11696 * then edit. All changes are written back to the file after a short delay if
11697 * the entry object is set to autosave (which is the default).
11699 * If the entry had any other file set previously, any changes made to it
11700 * will be saved if the autosave feature is enabled, otherwise, the file
11701 * will be silently discarded and any non-saved changes will be lost.
11703 * @param obj The entry object
11704 * @param file The path to the file to load and save
11705 * @param format The file format
11707 EAPI void elm_entry_file_set(Evas_Object *obj, const char *file, Elm_Text_Format format) EINA_ARG_NONNULL(1);
11709 * Gets the file being edited by the entry.
11711 * This function can be used to retrieve any file set on the entry for
11712 * edition, along with the format used to load and save it.
11714 * @param obj The entry object
11715 * @param file The path to the file to load and save
11716 * @param format The file format
11718 EAPI void elm_entry_file_get(const Evas_Object *obj, const char **file, Elm_Text_Format *format) EINA_ARG_NONNULL(1);
11720 * This function writes any changes made to the file set with
11721 * elm_entry_file_set()
11723 * @param obj The entry object
11725 EAPI void elm_entry_file_save(Evas_Object *obj) EINA_ARG_NONNULL(1);
11727 * This sets the entry object to 'autosave' the loaded text file or not.
11729 * @param obj The entry object
11730 * @param autosave Autosave the loaded file or not
11732 * @see elm_entry_file_set()
11734 EAPI void elm_entry_autosave_set(Evas_Object *obj, Eina_Bool autosave) EINA_ARG_NONNULL(1);
11736 * This gets the entry object's 'autosave' status.
11738 * @param obj The entry object
11739 * @return Autosave the loaded file or not
11741 * @see elm_entry_file_set()
11743 EAPI Eina_Bool elm_entry_autosave_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11745 * Control pasting of text and images for the widget.
11747 * Normally the entry allows both text and images to be pasted. By setting
11748 * textonly to be true, this prevents images from being pasted.
11750 * Note this only changes the behaviour of text.
11752 * @param obj The entry object
11753 * @param textonly paste mode - EINA_TRUE is text only, EINA_FALSE is
11754 * text+image+other.
11756 EAPI void elm_entry_cnp_textonly_set(Evas_Object *obj, Eina_Bool textonly) EINA_ARG_NONNULL(1);
11758 * Getting elm_entry text paste/drop mode.
11760 * In textonly mode, only text may be pasted or dropped into the widget.
11762 * @param obj The entry object
11763 * @return If the widget only accepts text from pastes.
11765 EAPI Eina_Bool elm_entry_cnp_textonly_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11767 * Enable or disable scrolling in entry
11769 * Normally the entry is not scrollable unless you enable it with this call.
11771 * @param obj The entry object
11772 * @param scroll EINA_TRUE if it is to be scrollable, EINA_FALSE otherwise
11774 EAPI void elm_entry_scrollable_set(Evas_Object *obj, Eina_Bool scroll);
11776 * Get the scrollable state of the entry
11778 * Normally the entry is not scrollable. This gets the scrollable state
11779 * of the entry. See elm_entry_scrollable_set() for more information.
11781 * @param obj The entry object
11782 * @return The scrollable state
11784 EAPI Eina_Bool elm_entry_scrollable_get(const Evas_Object *obj);
11786 * This sets a widget to be displayed to the left of a scrolled entry.
11788 * @param obj The scrolled entry object
11789 * @param icon The widget to display on the left side of the scrolled
11792 * @note A previously set widget will be destroyed.
11793 * @note If the object being set does not have minimum size hints set,
11794 * it won't get properly displayed.
11796 * @see elm_entry_end_set()
11798 EAPI void elm_entry_icon_set(Evas_Object *obj, Evas_Object *icon);
11800 * Gets the leftmost widget of the scrolled entry. This object is
11801 * owned by the scrolled entry and should not be modified.
11803 * @param obj The scrolled entry object
11804 * @return the left widget inside the scroller
11806 EAPI Evas_Object *elm_entry_icon_get(const Evas_Object *obj);
11808 * Unset the leftmost widget of the scrolled entry, unparenting and
11811 * @param obj The scrolled entry object
11812 * @return the previously set icon sub-object of this entry, on
11815 * @see elm_entry_icon_set()
11817 EAPI Evas_Object *elm_entry_icon_unset(Evas_Object *obj);
11819 * Sets the visibility of the left-side widget of the scrolled entry,
11820 * set by elm_entry_icon_set().
11822 * @param obj The scrolled entry object
11823 * @param setting EINA_TRUE if the object should be displayed,
11824 * EINA_FALSE if not.
11826 EAPI void elm_entry_icon_visible_set(Evas_Object *obj, Eina_Bool setting);
11828 * This sets a widget to be displayed to the end of a scrolled entry.
11830 * @param obj The scrolled entry object
11831 * @param end The widget to display on the right side of the scrolled
11834 * @note A previously set widget will be destroyed.
11835 * @note If the object being set does not have minimum size hints set,
11836 * it won't get properly displayed.
11838 * @see elm_entry_icon_set
11840 EAPI void elm_entry_end_set(Evas_Object *obj, Evas_Object *end);
11842 * Gets the endmost widget of the scrolled entry. This object is owned
11843 * by the scrolled entry and should not be modified.
11845 * @param obj The scrolled entry object
11846 * @return the right widget inside the scroller
11848 EAPI Evas_Object *elm_entry_end_get(const Evas_Object *obj);
11850 * Unset the endmost widget of the scrolled entry, unparenting and
11853 * @param obj The scrolled entry object
11854 * @return the previously set icon sub-object of this entry, on
11857 * @see elm_entry_icon_set()
11859 EAPI Evas_Object *elm_entry_end_unset(Evas_Object *obj);
11861 * Sets the visibility of the end widget of the scrolled entry, set by
11862 * elm_entry_end_set().
11864 * @param obj The scrolled entry object
11865 * @param setting EINA_TRUE if the object should be displayed,
11866 * EINA_FALSE if not.
11868 EAPI void elm_entry_end_visible_set(Evas_Object *obj, Eina_Bool setting);
11870 * This sets the scrolled entry's scrollbar policy (ie. enabling/disabling
11873 * Setting an entry to single-line mode with elm_entry_single_line_set()
11874 * will automatically disable the display of scrollbars when the entry
11875 * moves inside its scroller.
11877 * @param obj The scrolled entry object
11878 * @param h The horizontal scrollbar policy to apply
11879 * @param v The vertical scrollbar policy to apply
11881 EAPI void elm_entry_scrollbar_policy_set(Evas_Object *obj, Elm_Scroller_Policy h, Elm_Scroller_Policy v);
11883 * This enables/disables bouncing within the entry.
11885 * This function sets whether the entry will bounce when scrolling reaches
11886 * the end of the contained entry.
11888 * @param obj The scrolled entry object
11889 * @param h The horizontal bounce state
11890 * @param v The vertical bounce state
11892 EAPI void elm_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce);
11894 * Get the bounce mode
11896 * @param obj The Entry object
11897 * @param h_bounce Allow bounce horizontally
11898 * @param v_bounce Allow bounce vertically
11900 EAPI void elm_entry_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce);
11902 /* pre-made filters for entries */
11904 * @typedef Elm_Entry_Filter_Limit_Size
11906 * Data for the elm_entry_filter_limit_size() entry filter.
11908 typedef struct _Elm_Entry_Filter_Limit_Size Elm_Entry_Filter_Limit_Size;
11910 * @struct _Elm_Entry_Filter_Limit_Size
11912 * Data for the elm_entry_filter_limit_size() entry filter.
11914 struct _Elm_Entry_Filter_Limit_Size
11916 int max_char_count; /**< The maximum number of characters allowed. */
11917 int max_byte_count; /**< The maximum number of bytes allowed*/
11920 * Filter inserted text based on user defined character and byte limits
11922 * Add this filter to an entry to limit the characters that it will accept
11923 * based the the contents of the provided #Elm_Entry_Filter_Limit_Size.
11924 * The funtion works on the UTF-8 representation of the string, converting
11925 * it from the set markup, thus not accounting for any format in it.
11927 * The user must create an #Elm_Entry_Filter_Limit_Size structure and pass
11928 * it as data when setting the filter. In it, it's possible to set limits
11929 * by character count or bytes (any of them is disabled if 0), and both can
11930 * be set at the same time. In that case, it first checks for characters,
11933 * The function will cut the inserted text in order to allow only the first
11934 * number of characters that are still allowed. The cut is made in
11935 * characters, even when limiting by bytes, in order to always contain
11936 * valid ones and avoid half unicode characters making it in.
11938 * This filter, like any others, does not apply when setting the entry text
11939 * directly with elm_object_text_set() (or the deprecated
11940 * elm_entry_entry_set()).
11942 EAPI void elm_entry_filter_limit_size(void *data, Evas_Object *entry, char **text) EINA_ARG_NONNULL(1, 2, 3);
11944 * @typedef Elm_Entry_Filter_Accept_Set
11946 * Data for the elm_entry_filter_accept_set() entry filter.
11948 typedef struct _Elm_Entry_Filter_Accept_Set Elm_Entry_Filter_Accept_Set;
11950 * @struct _Elm_Entry_Filter_Accept_Set
11952 * Data for the elm_entry_filter_accept_set() entry filter.
11954 struct _Elm_Entry_Filter_Accept_Set
11956 const char *accepted; /**< Set of characters accepted in the entry. */
11957 const char *rejected; /**< Set of characters rejected from the entry. */
11960 * Filter inserted text based on accepted or rejected sets of characters
11962 * Add this filter to an entry to restrict the set of accepted characters
11963 * based on the sets in the provided #Elm_Entry_Filter_Accept_Set.
11964 * This structure contains both accepted and rejected sets, but they are
11965 * mutually exclusive.
11967 * The @c accepted set takes preference, so if it is set, the filter will
11968 * only work based on the accepted characters, ignoring anything in the
11969 * @c rejected value. If @c accepted is @c NULL, then @c rejected is used.
11971 * In both cases, the function filters by matching utf8 characters to the
11972 * raw markup text, so it can be used to remove formatting tags.
11974 * This filter, like any others, does not apply when setting the entry text
11975 * directly with elm_object_text_set() (or the deprecated
11976 * elm_entry_entry_set()).
11978 EAPI void elm_entry_filter_accept_set(void *data, Evas_Object *entry, char **text) EINA_ARG_NONNULL(1, 3);
11980 * Set the input panel layout of the entry
11982 * @param obj The entry object
11983 * @param layout layout type
11985 EAPI void elm_entry_input_panel_layout_set(Evas_Object *obj, Elm_Input_Panel_Layout layout) EINA_ARG_NONNULL(1);
11987 * Get the input panel layout of the entry
11989 * @param obj The entry object
11990 * @return layout type
11992 * @see elm_entry_input_panel_layout_set
11994 EAPI Elm_Input_Panel_Layout elm_entry_input_panel_layout_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
11996 * Set the autocapitalization type on the immodule.
11998 * @param obj The entry object
11999 * @param autocapital_type The type of autocapitalization
12001 EAPI void elm_entry_autocapital_type_set(Evas_Object *obj, Elm_Autocapital_Type autocapital_type) EINA_ARG_NONNULL(1);
12003 * Retrieve the autocapitalization type on the immodule.
12005 * @param obj The entry object
12006 * @return autocapitalization type
12008 EAPI Elm_Autocapital_Type elm_entry_autocapital_type_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
12010 * Sets the attribute to show the input panel automatically.
12012 * @param obj The entry object
12013 * @param enabled If true, the input panel is appeared when entry is clicked or has a focus
12015 EAPI void elm_entry_input_panel_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
12017 * Retrieve the attribute to show the input panel automatically.
12019 * @param obj The entry object
12020 * @return EINA_TRUE if input panel will be appeared when the entry is clicked or has a focus, EINA_FALSE otherwise
12022 EAPI Eina_Bool elm_entry_input_panel_enabled_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
12028 /* composite widgets - these basically put together basic widgets above
12029 * in convenient packages that do more than basic stuff */
12033 * @defgroup Anchorview Anchorview
12035 * @image html img/widget/anchorview/preview-00.png
12036 * @image latex img/widget/anchorview/preview-00.eps
12038 * Anchorview is for displaying text that contains markup with anchors
12039 * like <c>\<a href=1234\>something\</\></c> in it.
12041 * Besides being styled differently, the anchorview widget provides the
12042 * necessary functionality so that clicking on these anchors brings up a
12043 * popup with user defined content such as "call", "add to contacts" or
12044 * "open web page". This popup is provided using the @ref Hover widget.
12046 * This widget is very similar to @ref Anchorblock, so refer to that
12047 * widget for an example. The only difference Anchorview has is that the
12048 * widget is already provided with scrolling functionality, so if the
12049 * text set to it is too large to fit in the given space, it will scroll,
12050 * whereas the @ref Anchorblock widget will keep growing to ensure all the
12051 * text can be displayed.
12053 * This widget emits the following signals:
12054 * @li "anchor,clicked": will be called when an anchor is clicked. The
12055 * @p event_info parameter on the callback will be a pointer of type
12056 * ::Elm_Entry_Anchorview_Info.
12058 * See @ref Anchorblock for an example on how to use both of them.
12067 * @typedef Elm_Entry_Anchorview_Info
12069 * The info sent in the callback for "anchor,clicked" signals emitted by
12070 * the Anchorview widget.
12072 typedef struct _Elm_Entry_Anchorview_Info Elm_Entry_Anchorview_Info;
12074 * @struct _Elm_Entry_Anchorview_Info
12076 * The info sent in the callback for "anchor,clicked" signals emitted by
12077 * the Anchorview widget.
12079 struct _Elm_Entry_Anchorview_Info
12081 const char *name; /**< Name of the anchor, as indicated in its href
12083 int button; /**< The mouse button used to click on it */
12084 Evas_Object *hover; /**< The hover object to use for the popup */
12086 Evas_Coord x, y, w, h;
12087 } anchor, /**< Geometry selection of text used as anchor */
12088 hover_parent; /**< Geometry of the object used as parent by the
12090 Eina_Bool hover_left : 1; /**< Hint indicating if there's space
12091 for content on the left side of
12092 the hover. Before calling the
12093 callback, the widget will make the
12094 necessary calculations to check
12095 which sides are fit to be set with
12096 content, based on the position the
12097 hover is activated and its distance
12098 to the edges of its parent object
12100 Eina_Bool hover_right : 1; /**< Hint indicating content fits on
12101 the right side of the hover.
12102 See @ref hover_left */
12103 Eina_Bool hover_top : 1; /**< Hint indicating content fits on top
12104 of the hover. See @ref hover_left */
12105 Eina_Bool hover_bottom : 1; /**< Hint indicating content fits
12106 below the hover. See @ref
12110 * Add a new Anchorview object
12112 * @param parent The parent object
12113 * @return The new object or NULL if it cannot be created
12115 EAPI Evas_Object *elm_anchorview_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12117 * Set the text to show in the anchorview
12119 * Sets the text of the anchorview to @p text. This text can include markup
12120 * format tags, including <c>\<a href=anchorname\></c> to begin a segment of
12121 * text that will be specially styled and react to click events, ended with
12122 * either of \</a\> or \</\>. When clicked, the anchor will emit an
12123 * "anchor,clicked" signal that you can attach a callback to with
12124 * evas_object_smart_callback_add(). The name of the anchor given in the
12125 * event info struct will be the one set in the href attribute, in this
12126 * case, anchorname.
12128 * Other markup can be used to style the text in different ways, but it's
12129 * up to the style defined in the theme which tags do what.
12130 * @deprecated use elm_object_text_set() instead.
12132 EINA_DEPRECATED EAPI void elm_anchorview_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1);
12134 * Get the markup text set for the anchorview
12136 * Retrieves the text set on the anchorview, with markup tags included.
12138 * @param obj The anchorview object
12139 * @return The markup text set or @c NULL if nothing was set or an error
12141 * @deprecated use elm_object_text_set() instead.
12143 EINA_DEPRECATED EAPI const char *elm_anchorview_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12145 * Set the parent of the hover popup
12147 * Sets the parent object to use by the hover created by the anchorview
12148 * when an anchor is clicked. See @ref Hover for more details on this.
12149 * If no parent is set, the same anchorview object will be used.
12151 * @param obj The anchorview object
12152 * @param parent The object to use as parent for the hover
12154 EAPI void elm_anchorview_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
12156 * Get the parent of the hover popup
12158 * Get the object used as parent for the hover created by the anchorview
12159 * widget. See @ref Hover for more details on this.
12161 * @param obj The anchorview object
12162 * @return The object used as parent for the hover, NULL if none is set.
12164 EAPI Evas_Object *elm_anchorview_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12166 * Set the style that the hover should use
12168 * When creating the popup hover, anchorview will request that it's
12169 * themed according to @p style.
12171 * @param obj The anchorview object
12172 * @param style The style to use for the underlying hover
12174 * @see elm_object_style_set()
12176 EAPI void elm_anchorview_hover_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
12178 * Get the style that the hover should use
12180 * Get the style the hover created by anchorview will use.
12182 * @param obj The anchorview object
12183 * @return The style to use by the hover. NULL means the default is used.
12185 * @see elm_object_style_set()
12187 EAPI const char *elm_anchorview_hover_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12189 * Ends the hover popup in the anchorview
12191 * When an anchor is clicked, the anchorview widget will create a hover
12192 * object to use as a popup with user provided content. This function
12193 * terminates this popup, returning the anchorview to its normal state.
12195 * @param obj The anchorview object
12197 EAPI void elm_anchorview_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
12199 * Set bouncing behaviour when the scrolled content reaches an edge
12201 * Tell the internal scroller object whether it should bounce or not
12202 * when it reaches the respective edges for each axis.
12204 * @param obj The anchorview object
12205 * @param h_bounce Whether to bounce or not in the horizontal axis
12206 * @param v_bounce Whether to bounce or not in the vertical axis
12208 * @see elm_scroller_bounce_set()
12210 EAPI void elm_anchorview_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
12212 * Get the set bouncing behaviour of the internal scroller
12214 * Get whether the internal scroller should bounce when the edge of each
12215 * axis is reached scrolling.
12217 * @param obj The anchorview object
12218 * @param h_bounce Pointer where to store the bounce state of the horizontal
12220 * @param v_bounce Pointer where to store the bounce state of the vertical
12223 * @see elm_scroller_bounce_get()
12225 EAPI void elm_anchorview_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
12227 * Appends a custom item provider to the given anchorview
12229 * Appends the given function to the list of items providers. This list is
12230 * called, one function at a time, with the given @p data pointer, the
12231 * anchorview object and, in the @p item parameter, the item name as
12232 * referenced in its href string. Following functions in the list will be
12233 * called in order until one of them returns something different to NULL,
12234 * which should be an Evas_Object which will be used in place of the item
12237 * Items in the markup text take the form \<item relsize=16x16 vsize=full
12238 * href=item/name\>\</item\>
12240 * @param obj The anchorview object
12241 * @param func The function to add to the list of providers
12242 * @param data User data that will be passed to the callback function
12244 * @see elm_entry_item_provider_append()
12246 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);
12248 * Prepend a custom item provider to the given anchorview
12250 * Like elm_anchorview_item_provider_append(), but it adds the function
12251 * @p func to the beginning of the list, instead of the end.
12253 * @param obj The anchorview object
12254 * @param func The function to add to the list of providers
12255 * @param data User data that will be passed to the callback function
12257 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);
12259 * Remove a custom item provider from the list of the given anchorview
12261 * Removes the function and data pairing that matches @p func and @p data.
12262 * That is, unless the same function and same user data are given, the
12263 * function will not be removed from the list. This allows us to add the
12264 * same callback several times, with different @p data pointers and be
12265 * able to remove them later without conflicts.
12267 * @param obj The anchorview object
12268 * @param func The function to remove from the list
12269 * @param data The data matching the function to remove from the list
12271 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);
12278 * @defgroup Anchorblock Anchorblock
12280 * @image html img/widget/anchorblock/preview-00.png
12281 * @image latex img/widget/anchorblock/preview-00.eps
12283 * Anchorblock is for displaying text that contains markup with anchors
12284 * like <c>\<a href=1234\>something\</\></c> in it.
12286 * Besides being styled differently, the anchorblock widget provides the
12287 * necessary functionality so that clicking on these anchors brings up a
12288 * popup with user defined content such as "call", "add to contacts" or
12289 * "open web page". This popup is provided using the @ref Hover widget.
12291 * This widget emits the following signals:
12292 * @li "anchor,clicked": will be called when an anchor is clicked. The
12293 * @p event_info parameter on the callback will be a pointer of type
12294 * ::Elm_Entry_Anchorblock_Info.
12300 * Since examples are usually better than plain words, we might as well
12301 * try @ref tutorial_anchorblock_example "one".
12304 * @addtogroup Anchorblock
12308 * @typedef Elm_Entry_Anchorblock_Info
12310 * The info sent in the callback for "anchor,clicked" signals emitted by
12311 * the Anchorblock widget.
12313 typedef struct _Elm_Entry_Anchorblock_Info Elm_Entry_Anchorblock_Info;
12315 * @struct _Elm_Entry_Anchorblock_Info
12317 * The info sent in the callback for "anchor,clicked" signals emitted by
12318 * the Anchorblock widget.
12320 struct _Elm_Entry_Anchorblock_Info
12322 const char *name; /**< Name of the anchor, as indicated in its href
12324 int button; /**< The mouse button used to click on it */
12325 Evas_Object *hover; /**< The hover object to use for the popup */
12327 Evas_Coord x, y, w, h;
12328 } anchor, /**< Geometry selection of text used as anchor */
12329 hover_parent; /**< Geometry of the object used as parent by the
12331 Eina_Bool hover_left : 1; /**< Hint indicating if there's space
12332 for content on the left side of
12333 the hover. Before calling the
12334 callback, the widget will make the
12335 necessary calculations to check
12336 which sides are fit to be set with
12337 content, based on the position the
12338 hover is activated and its distance
12339 to the edges of its parent object
12341 Eina_Bool hover_right : 1; /**< Hint indicating content fits on
12342 the right side of the hover.
12343 See @ref hover_left */
12344 Eina_Bool hover_top : 1; /**< Hint indicating content fits on top
12345 of the hover. See @ref hover_left */
12346 Eina_Bool hover_bottom : 1; /**< Hint indicating content fits
12347 below the hover. See @ref
12351 * Add a new Anchorblock object
12353 * @param parent The parent object
12354 * @return The new object or NULL if it cannot be created
12356 EAPI Evas_Object *elm_anchorblock_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12358 * Set the text to show in the anchorblock
12360 * Sets the text of the anchorblock to @p text. This text can include markup
12361 * format tags, including <c>\<a href=anchorname\></a></c> to begin a segment
12362 * of text that will be specially styled and react to click events, ended
12363 * with either of \</a\> or \</\>. When clicked, the anchor will emit an
12364 * "anchor,clicked" signal that you can attach a callback to with
12365 * evas_object_smart_callback_add(). The name of the anchor given in the
12366 * event info struct will be the one set in the href attribute, in this
12367 * case, anchorname.
12369 * Other markup can be used to style the text in different ways, but it's
12370 * up to the style defined in the theme which tags do what.
12371 * @deprecated use elm_object_text_set() instead.
12373 EINA_DEPRECATED EAPI void elm_anchorblock_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1);
12375 * Get the markup text set for the anchorblock
12377 * Retrieves the text set on the anchorblock, with markup tags included.
12379 * @param obj The anchorblock object
12380 * @return The markup text set or @c NULL if nothing was set or an error
12382 * @deprecated use elm_object_text_set() instead.
12384 EINA_DEPRECATED EAPI const char *elm_anchorblock_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12386 * Set the parent of the hover popup
12388 * Sets the parent object to use by the hover created by the anchorblock
12389 * when an anchor is clicked. See @ref Hover for more details on this.
12391 * @param obj The anchorblock object
12392 * @param parent The object to use as parent for the hover
12394 EAPI void elm_anchorblock_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
12396 * Get the parent of the hover popup
12398 * Get the object used as parent for the hover created by the anchorblock
12399 * widget. See @ref Hover for more details on this.
12400 * If no parent is set, the same anchorblock object will be used.
12402 * @param obj The anchorblock object
12403 * @return The object used as parent for the hover, NULL if none is set.
12405 EAPI Evas_Object *elm_anchorblock_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12407 * Set the style that the hover should use
12409 * When creating the popup hover, anchorblock will request that it's
12410 * themed according to @p style.
12412 * @param obj The anchorblock object
12413 * @param style The style to use for the underlying hover
12415 * @see elm_object_style_set()
12417 EAPI void elm_anchorblock_hover_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
12419 * Get the style that the hover should use
12421 * Get the style, the hover created by anchorblock will use.
12423 * @param obj The anchorblock object
12424 * @return The style to use by the hover. NULL means the default is used.
12426 * @see elm_object_style_set()
12428 EAPI const char *elm_anchorblock_hover_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12430 * Ends the hover popup in the anchorblock
12432 * When an anchor is clicked, the anchorblock widget will create a hover
12433 * object to use as a popup with user provided content. This function
12434 * terminates this popup, returning the anchorblock to its normal state.
12436 * @param obj The anchorblock object
12438 EAPI void elm_anchorblock_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
12440 * Appends a custom item provider to the given anchorblock
12442 * Appends the given function to the list of items providers. This list is
12443 * called, one function at a time, with the given @p data pointer, the
12444 * anchorblock object and, in the @p item parameter, the item name as
12445 * referenced in its href string. Following functions in the list will be
12446 * called in order until one of them returns something different to NULL,
12447 * which should be an Evas_Object which will be used in place of the item
12450 * Items in the markup text take the form \<item relsize=16x16 vsize=full
12451 * href=item/name\>\</item\>
12453 * @param obj The anchorblock object
12454 * @param func The function to add to the list of providers
12455 * @param data User data that will be passed to the callback function
12457 * @see elm_entry_item_provider_append()
12459 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);
12461 * Prepend a custom item provider to the given anchorblock
12463 * Like elm_anchorblock_item_provider_append(), but it adds the function
12464 * @p func to the beginning of the list, instead of the end.
12466 * @param obj The anchorblock object
12467 * @param func The function to add to the list of providers
12468 * @param data User data that will be passed to the callback function
12470 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);
12472 * Remove a custom item provider from the list of the given anchorblock
12474 * Removes the function and data pairing that matches @p func and @p data.
12475 * That is, unless the same function and same user data are given, the
12476 * function will not be removed from the list. This allows us to add the
12477 * same callback several times, with different @p data pointers and be
12478 * able to remove them later without conflicts.
12480 * @param obj The anchorblock object
12481 * @param func The function to remove from the list
12482 * @param data The data matching the function to remove from the list
12484 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);
12490 * @defgroup Bubble Bubble
12492 * @image html img/widget/bubble/preview-00.png
12493 * @image latex img/widget/bubble/preview-00.eps
12494 * @image html img/widget/bubble/preview-01.png
12495 * @image latex img/widget/bubble/preview-01.eps
12496 * @image html img/widget/bubble/preview-02.png
12497 * @image latex img/widget/bubble/preview-02.eps
12499 * @brief The Bubble is a widget to show text similar to how speech is
12500 * represented in comics.
12502 * The bubble widget contains 5 important visual elements:
12503 * @li The frame is a rectangle with rounded edjes and an "arrow".
12504 * @li The @p icon is an image to which the frame's arrow points to.
12505 * @li The @p label is a text which appears to the right of the icon if the
12506 * corner is "top_left" or "bottom_left" and is right aligned to the frame
12508 * @li The @p info is a text which appears to the right of the label. Info's
12509 * font is of a ligther color than label.
12510 * @li The @p content is an evas object that is shown inside the frame.
12512 * The position of the arrow, icon, label and info depends on which corner is
12513 * selected. The four available corners are:
12514 * @li "top_left" - Default
12516 * @li "bottom_left"
12517 * @li "bottom_right"
12519 * Signals that you can add callbacks for are:
12520 * @li "clicked" - This is called when a user has clicked the bubble.
12522 * Default contents parts of the bubble that you can use for are:
12523 * @li "default" - A content of the bubble
12524 * @li "icon" - An icon of the bubble
12526 * Default text parts of the button widget that you can use for are:
12527 * @li NULL - Label of the bubble
12529 * For an example of using a buble see @ref bubble_01_example_page "this".
12535 * Add a new bubble to the parent
12537 * @param parent The parent object
12538 * @return The new object or NULL if it cannot be created
12540 * This function adds a text bubble to the given parent evas object.
12542 EAPI Evas_Object *elm_bubble_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12544 * Set the label of the bubble
12546 * @param obj The bubble object
12547 * @param label The string to set in the label
12549 * This function sets the title of the bubble. Where this appears depends on
12550 * the selected corner.
12551 * @deprecated use elm_object_text_set() instead.
12553 EINA_DEPRECATED EAPI void elm_bubble_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
12555 * Get the label of the bubble
12557 * @param obj The bubble object
12558 * @return The string of set in the label
12560 * This function gets the title of the bubble.
12561 * @deprecated use elm_object_text_get() instead.
12563 EINA_DEPRECATED EAPI const char *elm_bubble_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12565 * Set the info of the bubble
12567 * @param obj The bubble object
12568 * @param info The given info about the bubble
12570 * This function sets the info of the bubble. Where this appears depends on
12571 * the selected corner.
12572 * @deprecated use elm_object_part_text_set() instead. (with "info" as the parameter).
12574 EINA_DEPRECATED EAPI void elm_bubble_info_set(Evas_Object *obj, const char *info) EINA_ARG_NONNULL(1);
12576 * Get the info of the bubble
12578 * @param obj The bubble object
12580 * @return The "info" string of the bubble
12582 * This function gets the info text.
12583 * @deprecated use elm_object_part_text_get() instead. (with "info" as the parameter).
12585 EINA_DEPRECATED EAPI const char *elm_bubble_info_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12587 * Set the content to be shown in the bubble
12589 * Once the content object is set, a previously set one will be deleted.
12590 * If you want to keep the old content object, use the
12591 * elm_bubble_content_unset() function.
12593 * @param obj The bubble object
12594 * @param content The given content of the bubble
12596 * This function sets the content shown on the middle of the bubble.
12598 * @deprecated use elm_object_content_set() instead
12601 EINA_DEPRECATED EAPI void elm_bubble_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
12603 * Get the content shown in the bubble
12605 * Return the content object which is set for this widget.
12607 * @param obj The bubble object
12608 * @return The content that is being used
12610 * @deprecated use elm_object_content_get() instead
12613 EINA_DEPRECATED EAPI Evas_Object *elm_bubble_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12615 * Unset the content shown in the bubble
12617 * Unparent and return the content object which was set for this widget.
12619 * @param obj The bubble object
12620 * @return The content that was being used
12622 * @deprecated use elm_object_content_unset() instead
12625 EINA_DEPRECATED EAPI Evas_Object *elm_bubble_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
12627 * Set the icon of the bubble
12629 * Once the icon object is set, a previously set one will be deleted.
12630 * If you want to keep the old content object, use the
12631 * elm_icon_content_unset() function.
12633 * @param obj The bubble object
12634 * @param icon The given icon for the bubble
12636 * @deprecated use elm_object_part_content_set() instead
12639 EINA_DEPRECATED EAPI void elm_bubble_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
12641 * Get the icon of the bubble
12643 * @param obj The bubble object
12644 * @return The icon for the bubble
12646 * This function gets the icon shown on the top left of bubble.
12648 * @deprecated use elm_object_part_content_get() instead
12651 EINA_DEPRECATED EAPI Evas_Object *elm_bubble_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12653 * Unset the icon of the bubble
12655 * Unparent and return the icon object which was set for this widget.
12657 * @param obj The bubble object
12658 * @return The icon that was being used
12660 * @deprecated use elm_object_part_content_unset() instead
12663 EINA_DEPRECATED EAPI Evas_Object *elm_bubble_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
12665 * Set the corner of the bubble
12667 * @param obj The bubble object.
12668 * @param corner The given corner for the bubble.
12670 * This function sets the corner of the bubble. The corner will be used to
12671 * determine where the arrow in the frame points to and where label, icon and
12674 * Possible values for corner are:
12675 * @li "top_left" - Default
12677 * @li "bottom_left"
12678 * @li "bottom_right"
12680 EAPI void elm_bubble_corner_set(Evas_Object *obj, const char *corner) EINA_ARG_NONNULL(1, 2);
12682 * Get the corner of the bubble
12684 * @param obj The bubble object.
12685 * @return The given corner for the bubble.
12687 * This function gets the selected corner of the bubble.
12689 EAPI const char *elm_bubble_corner_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12695 * @defgroup Photo Photo
12697 * For displaying the photo of a person (contact). Simple, yet
12698 * with a very specific purpose.
12700 * Signals that you can add callbacks for are:
12702 * "clicked" - This is called when a user has clicked the photo
12703 * "drag,start" - Someone started dragging the image out of the object
12704 * "drag,end" - Dragged item was dropped (somewhere)
12710 * Add a new photo to the parent
12712 * @param parent The parent object
12713 * @return The new object or NULL if it cannot be created
12717 EAPI Evas_Object *elm_photo_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12720 * Set the file that will be used as photo
12722 * @param obj The photo object
12723 * @param file The path to file that will be used as photo
12725 * @return (1 = success, 0 = error)
12729 EAPI Eina_Bool elm_photo_file_set(Evas_Object *obj, const char *file) EINA_ARG_NONNULL(1);
12732 * Set the file that will be used as thumbnail in the photo.
12734 * @param obj The photo object.
12735 * @param file The path to file that will be used as thumb.
12736 * @param group The key used in case of an EET file.
12740 EAPI void elm_photo_thumb_set(const Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
12743 * Set the size that will be used on the photo
12745 * @param obj The photo object
12746 * @param size The size that the photo will be
12750 EAPI void elm_photo_size_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
12753 * Set if the photo should be completely visible or not.
12755 * @param obj The photo object
12756 * @param fill if true the photo will be completely visible
12760 EAPI void elm_photo_fill_inside_set(Evas_Object *obj, Eina_Bool fill) EINA_ARG_NONNULL(1);
12763 * Set editability of the photo.
12765 * An editable photo can be dragged to or from, and can be cut or
12766 * pasted too. Note that pasting an image or dropping an item on
12767 * the image will delete the existing content.
12769 * @param obj The photo object.
12770 * @param set To set of clear editablity.
12772 EAPI void elm_photo_editable_set(Evas_Object *obj, Eina_Bool set) EINA_ARG_NONNULL(1);
12778 /* gesture layer */
12780 * @defgroup Elm_Gesture_Layer Gesture Layer
12781 * Gesture Layer Usage:
12783 * Use Gesture Layer to detect gestures.
12784 * The advantage is that you don't have to implement
12785 * gesture detection, just set callbacks of gesture state.
12786 * By using gesture layer we make standard interface.
12788 * In order to use Gesture Layer you start with @ref elm_gesture_layer_add
12789 * with a parent object parameter.
12790 * Next 'activate' gesture layer with a @ref elm_gesture_layer_attach
12791 * call. Usually with same object as target (2nd parameter).
12793 * Now you need to tell gesture layer what gestures you follow.
12794 * This is done with @ref elm_gesture_layer_cb_set call.
12795 * By setting the callback you actually saying to gesture layer:
12796 * I would like to know when the gesture @ref Elm_Gesture_Types
12797 * switches to state @ref Elm_Gesture_State.
12799 * Next, you need to implement the actual action that follows the input
12800 * in your callback.
12802 * Note that if you like to stop being reported about a gesture, just set
12803 * all callbacks referring this gesture to NULL.
12804 * (again with @ref elm_gesture_layer_cb_set)
12806 * The information reported by gesture layer to your callback is depending
12807 * on @ref Elm_Gesture_Types:
12808 * @ref Elm_Gesture_Taps_Info is the info reported for tap gestures:
12809 * @ref ELM_GESTURE_N_TAPS, @ref ELM_GESTURE_N_LONG_TAPS,
12810 * @ref ELM_GESTURE_N_DOUBLE_TAPS, @ref ELM_GESTURE_N_TRIPLE_TAPS.
12812 * @ref Elm_Gesture_Momentum_Info is info reported for momentum gestures:
12813 * @ref ELM_GESTURE_MOMENTUM.
12815 * @ref Elm_Gesture_Line_Info is the info reported for line gestures:
12816 * (this also contains @ref Elm_Gesture_Momentum_Info internal structure)
12817 * @ref ELM_GESTURE_N_LINES, @ref ELM_GESTURE_N_FLICKS.
12818 * Note that we consider a flick as a line-gesture that should be completed
12819 * in flick-time-limit as defined in @ref Config.
12821 * @ref Elm_Gesture_Zoom_Info is the info reported for @ref ELM_GESTURE_ZOOM gesture.
12823 * @ref Elm_Gesture_Rotate_Info is the info reported for @ref ELM_GESTURE_ROTATE gesture.
12826 * Gesture Layer Tweaks:
12828 * Note that line, flick, gestures can start without the need to remove fingers from surface.
12829 * When user fingers rests on same-spot gesture is ended and starts again when fingers moved.
12831 * Setting glayer_continues_enable to false in @ref Config will change this behavior
12832 * so gesture starts when user touches (a *DOWN event) touch-surface
12833 * and ends when no fingers touches surface (a *UP event).
12837 * @enum _Elm_Gesture_Types
12838 * Enum of supported gesture types.
12839 * @ingroup Elm_Gesture_Layer
12841 enum _Elm_Gesture_Types
12843 ELM_GESTURE_FIRST = 0,
12845 ELM_GESTURE_N_TAPS, /**< N fingers single taps */
12846 ELM_GESTURE_N_LONG_TAPS, /**< N fingers single long-taps */
12847 ELM_GESTURE_N_DOUBLE_TAPS, /**< N fingers double-single taps */
12848 ELM_GESTURE_N_TRIPLE_TAPS, /**< N fingers triple-single taps */
12850 ELM_GESTURE_MOMENTUM, /**< Reports momentum in the dircetion of move */
12852 ELM_GESTURE_N_LINES, /**< N fingers line gesture */
12853 ELM_GESTURE_N_FLICKS, /**< N fingers flick gesture */
12855 ELM_GESTURE_ZOOM, /**< Zoom */
12856 ELM_GESTURE_ROTATE, /**< Rotate */
12862 * @typedef Elm_Gesture_Types
12863 * gesture types enum
12864 * @ingroup Elm_Gesture_Layer
12866 typedef enum _Elm_Gesture_Types Elm_Gesture_Types;
12869 * @enum _Elm_Gesture_State
12870 * Enum of gesture states.
12871 * @ingroup Elm_Gesture_Layer
12873 enum _Elm_Gesture_State
12875 ELM_GESTURE_STATE_UNDEFINED = -1, /**< Gesture not STARTed */
12876 ELM_GESTURE_STATE_START, /**< Gesture STARTed */
12877 ELM_GESTURE_STATE_MOVE, /**< Gesture is ongoing */
12878 ELM_GESTURE_STATE_END, /**< Gesture completed */
12879 ELM_GESTURE_STATE_ABORT /**< Onging gesture was ABORTed */
12883 * @typedef Elm_Gesture_State
12884 * gesture states enum
12885 * @ingroup Elm_Gesture_Layer
12887 typedef enum _Elm_Gesture_State Elm_Gesture_State;
12890 * @struct _Elm_Gesture_Taps_Info
12891 * Struct holds taps info for user
12892 * @ingroup Elm_Gesture_Layer
12894 struct _Elm_Gesture_Taps_Info
12896 Evas_Coord x, y; /**< Holds center point between fingers */
12897 unsigned int n; /**< Number of fingers tapped */
12898 unsigned int timestamp; /**< event timestamp */
12902 * @typedef Elm_Gesture_Taps_Info
12903 * holds taps info for user
12904 * @ingroup Elm_Gesture_Layer
12906 typedef struct _Elm_Gesture_Taps_Info Elm_Gesture_Taps_Info;
12909 * @struct _Elm_Gesture_Momentum_Info
12910 * Struct holds momentum info for user
12911 * x1 and y1 are not necessarily in sync
12912 * x1 holds x value of x direction starting point
12913 * and same holds for y1.
12914 * This is noticeable when doing V-shape movement
12915 * @ingroup Elm_Gesture_Layer
12917 struct _Elm_Gesture_Momentum_Info
12918 { /* Report line ends, timestamps, and momentum computed */
12919 Evas_Coord x1; /**< Final-swipe direction starting point on X */
12920 Evas_Coord y1; /**< Final-swipe direction starting point on Y */
12921 Evas_Coord x2; /**< Final-swipe direction ending point on X */
12922 Evas_Coord y2; /**< Final-swipe direction ending point on Y */
12924 unsigned int tx; /**< Timestamp of start of final x-swipe */
12925 unsigned int ty; /**< Timestamp of start of final y-swipe */
12927 Evas_Coord mx; /**< Momentum on X */
12928 Evas_Coord my; /**< Momentum on Y */
12930 unsigned int n; /**< Number of fingers */
12934 * @typedef Elm_Gesture_Momentum_Info
12935 * holds momentum info for user
12936 * @ingroup Elm_Gesture_Layer
12938 typedef struct _Elm_Gesture_Momentum_Info Elm_Gesture_Momentum_Info;
12941 * @struct _Elm_Gesture_Line_Info
12942 * Struct holds line info for user
12943 * @ingroup Elm_Gesture_Layer
12945 struct _Elm_Gesture_Line_Info
12946 { /* Report line ends, timestamps, and momentum computed */
12947 Elm_Gesture_Momentum_Info momentum; /**< Line momentum info */
12948 double angle; /**< Angle (direction) of lines */
12952 * @typedef Elm_Gesture_Line_Info
12953 * Holds line info for user
12954 * @ingroup Elm_Gesture_Layer
12956 typedef struct _Elm_Gesture_Line_Info Elm_Gesture_Line_Info;
12959 * @struct _Elm_Gesture_Zoom_Info
12960 * Struct holds zoom info for user
12961 * @ingroup Elm_Gesture_Layer
12963 struct _Elm_Gesture_Zoom_Info
12965 Evas_Coord x, y; /**< Holds zoom center point reported to user */
12966 Evas_Coord radius; /**< Holds radius between fingers reported to user */
12967 double zoom; /**< Zoom value: 1.0 means no zoom */
12968 double momentum; /**< Zoom momentum: zoom growth per second (NOT YET SUPPORTED) */
12972 * @typedef Elm_Gesture_Zoom_Info
12973 * Holds zoom info for user
12974 * @ingroup Elm_Gesture_Layer
12976 typedef struct _Elm_Gesture_Zoom_Info Elm_Gesture_Zoom_Info;
12979 * @struct _Elm_Gesture_Rotate_Info
12980 * Struct holds rotation info for user
12981 * @ingroup Elm_Gesture_Layer
12983 struct _Elm_Gesture_Rotate_Info
12985 Evas_Coord x, y; /**< Holds zoom center point reported to user */
12986 Evas_Coord radius; /**< Holds radius between fingers reported to user */
12987 double base_angle; /**< Holds start-angle */
12988 double angle; /**< Rotation value: 0.0 means no rotation */
12989 double momentum; /**< Rotation momentum: rotation done per second (NOT YET SUPPORTED) */
12993 * @typedef Elm_Gesture_Rotate_Info
12994 * Holds rotation info for user
12995 * @ingroup Elm_Gesture_Layer
12997 typedef struct _Elm_Gesture_Rotate_Info Elm_Gesture_Rotate_Info;
13000 * @typedef Elm_Gesture_Event_Cb
13001 * User callback used to stream gesture info from gesture layer
13002 * @param data user data
13003 * @param event_info gesture report info
13004 * Returns a flag field to be applied on the causing event.
13005 * You should probably return EVAS_EVENT_FLAG_ON_HOLD if your widget acted
13006 * upon the event, in an irreversible way.
13008 * @ingroup Elm_Gesture_Layer
13010 typedef Evas_Event_Flags (*Elm_Gesture_Event_Cb) (void *data, void *event_info);
13013 * Use function to set callbacks to be notified about
13014 * change of state of gesture.
13015 * When a user registers a callback with this function
13016 * this means this gesture has to be tested.
13018 * When ALL callbacks for a gesture are set to NULL
13019 * it means user isn't interested in gesture-state
13020 * and it will not be tested.
13022 * @param obj Pointer to gesture-layer.
13023 * @param idx The gesture you would like to track its state.
13024 * @param cb callback function pointer.
13025 * @param cb_type what event this callback tracks: START, MOVE, END, ABORT.
13026 * @param data user info to be sent to callback (usually, Smart Data)
13028 * @ingroup Elm_Gesture_Layer
13030 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);
13033 * Call this function to get repeat-events settings.
13035 * @param obj Pointer to gesture-layer.
13037 * @return repeat events settings.
13038 * @see elm_gesture_layer_hold_events_set()
13039 * @ingroup Elm_Gesture_Layer
13041 EAPI Eina_Bool elm_gesture_layer_hold_events_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
13044 * This function called in order to make gesture-layer repeat events.
13045 * Set this of you like to get the raw events only if gestures were not detected.
13046 * Clear this if you like gesture layer to fwd events as testing gestures.
13048 * @param obj Pointer to gesture-layer.
13049 * @param r Repeat: TRUE/FALSE
13051 * @ingroup Elm_Gesture_Layer
13053 EAPI void elm_gesture_layer_hold_events_set(Evas_Object *obj, Eina_Bool r) EINA_ARG_NONNULL(1);
13056 * This function sets step-value for zoom action.
13057 * Set step to any positive value.
13058 * Cancel step setting by setting to 0.0
13060 * @param obj Pointer to gesture-layer.
13061 * @param s new zoom step value.
13063 * @ingroup Elm_Gesture_Layer
13065 EAPI void elm_gesture_layer_zoom_step_set(Evas_Object *obj, double s) EINA_ARG_NONNULL(1);
13068 * This function sets step-value for rotate action.
13069 * Set step to any positive value.
13070 * Cancel step setting by setting to 0.0
13072 * @param obj Pointer to gesture-layer.
13073 * @param s new roatate step value.
13075 * @ingroup Elm_Gesture_Layer
13077 EAPI void elm_gesture_layer_rotate_step_set(Evas_Object *obj, double s) EINA_ARG_NONNULL(1);
13080 * This function called to attach gesture-layer to an Evas_Object.
13081 * @param obj Pointer to gesture-layer.
13082 * @param t Pointer to underlying object (AKA Target)
13084 * @return TRUE, FALSE on success, failure.
13086 * @ingroup Elm_Gesture_Layer
13088 EAPI Eina_Bool elm_gesture_layer_attach(Evas_Object *obj, Evas_Object *t) EINA_ARG_NONNULL(1, 2);
13091 * Call this function to construct a new gesture-layer object.
13092 * This does not activate the gesture layer. You have to
13093 * call elm_gesture_layer_attach in order to 'activate' gesture-layer.
13095 * @param parent the parent object.
13097 * @return Pointer to new gesture-layer object.
13099 * @ingroup Elm_Gesture_Layer
13101 EAPI Evas_Object *elm_gesture_layer_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
13104 * @defgroup Thumb Thumb
13106 * @image html img/widget/thumb/preview-00.png
13107 * @image latex img/widget/thumb/preview-00.eps
13109 * A thumb object is used for displaying the thumbnail of an image or video.
13110 * You must have compiled Elementary with Ethumb_Client support and the DBus
13111 * service must be present and auto-activated in order to have thumbnails to
13114 * Once the thumbnail object becomes visible, it will check if there is a
13115 * previously generated thumbnail image for the file set on it. If not, it
13116 * will start generating this thumbnail.
13118 * Different config settings will cause different thumbnails to be generated
13119 * even on the same file.
13121 * Generated thumbnails are stored under @c $HOME/.thumbnails/. Check the
13122 * Ethumb documentation to change this path, and to see other configuration
13125 * Signals that you can add callbacks for are:
13127 * - "clicked" - This is called when a user has clicked the thumb without dragging
13129 * - "clicked,double" - This is called when a user has double-clicked the thumb.
13130 * - "press" - This is called when a user has pressed down the thumb.
13131 * - "generate,start" - The thumbnail generation started.
13132 * - "generate,stop" - The generation process stopped.
13133 * - "generate,error" - The generation failed.
13134 * - "load,error" - The thumbnail image loading failed.
13136 * available styles:
13140 * An example of use of thumbnail:
13142 * - @ref thumb_example_01
13146 * @addtogroup Thumb
13151 * @enum _Elm_Thumb_Animation_Setting
13152 * @typedef Elm_Thumb_Animation_Setting
13154 * Used to set if a video thumbnail is animating or not.
13158 typedef enum _Elm_Thumb_Animation_Setting
13160 ELM_THUMB_ANIMATION_START = 0, /**< Play animation once */
13161 ELM_THUMB_ANIMATION_LOOP, /**< Keep playing animation until stop is requested */
13162 ELM_THUMB_ANIMATION_STOP, /**< Stop playing the animation */
13163 ELM_THUMB_ANIMATION_LAST
13164 } Elm_Thumb_Animation_Setting;
13167 * Add a new thumb object to the parent.
13169 * @param parent The parent object.
13170 * @return The new object or NULL if it cannot be created.
13172 * @see elm_thumb_file_set()
13173 * @see elm_thumb_ethumb_client_get()
13177 EAPI Evas_Object *elm_thumb_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
13179 * Reload thumbnail if it was generated before.
13181 * @param obj The thumb object to reload
13183 * This is useful if the ethumb client configuration changed, like its
13184 * size, aspect or any other property one set in the handle returned
13185 * by elm_thumb_ethumb_client_get().
13187 * If the options didn't change, the thumbnail won't be generated again, but
13188 * the old one will still be used.
13190 * @see elm_thumb_file_set()
13194 EAPI void elm_thumb_reload(Evas_Object *obj) EINA_ARG_NONNULL(1);
13196 * Set the file that will be used as thumbnail.
13198 * @param obj The thumb object.
13199 * @param file The path to file that will be used as thumb.
13200 * @param key The key used in case of an EET file.
13202 * The file can be an image or a video (in that case, acceptable extensions are:
13203 * avi, mp4, ogv, mov, mpg and wmv). To start the video animation, use the
13204 * function elm_thumb_animate().
13206 * @see elm_thumb_file_get()
13207 * @see elm_thumb_reload()
13208 * @see elm_thumb_animate()
13212 EAPI void elm_thumb_file_set(Evas_Object *obj, const char *file, const char *key) EINA_ARG_NONNULL(1);
13214 * Get the image or video path and key used to generate the thumbnail.
13216 * @param obj The thumb object.
13217 * @param file Pointer to filename.
13218 * @param key Pointer to key.
13220 * @see elm_thumb_file_set()
13221 * @see elm_thumb_path_get()
13225 EAPI void elm_thumb_file_get(const Evas_Object *obj, const char **file, const char **key) EINA_ARG_NONNULL(1);
13227 * Get the path and key to the image or video generated by ethumb.
13229 * One just need to make sure that the thumbnail was generated before getting
13230 * its path; otherwise, the path will be NULL. One way to do that is by asking
13231 * for the path when/after the "generate,stop" smart callback is called.
13233 * @param obj The thumb object.
13234 * @param file Pointer to thumb path.
13235 * @param key Pointer to thumb key.
13237 * @see elm_thumb_file_get()
13241 EAPI void elm_thumb_path_get(const Evas_Object *obj, const char **file, const char **key) EINA_ARG_NONNULL(1);
13243 * Set the animation state for the thumb object. If its content is an animated
13244 * video, you may start/stop the animation or tell it to play continuously and
13247 * @param obj The thumb object.
13248 * @param setting The animation setting.
13250 * @see elm_thumb_file_set()
13254 EAPI void elm_thumb_animate_set(Evas_Object *obj, Elm_Thumb_Animation_Setting s) EINA_ARG_NONNULL(1);
13256 * Get the animation state for the thumb object.
13258 * @param obj The thumb object.
13259 * @return getting The animation setting or @c ELM_THUMB_ANIMATION_LAST,
13262 * @see elm_thumb_animate_set()
13266 EAPI Elm_Thumb_Animation_Setting elm_thumb_animate_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13268 * Get the ethumb_client handle so custom configuration can be made.
13270 * @return Ethumb_Client instance or NULL.
13272 * This must be called before the objects are created to be sure no object is
13273 * visible and no generation started.
13275 * Example of usage:
13278 * #include <Elementary.h>
13279 * #ifndef ELM_LIB_QUICKLAUNCH
13281 * elm_main(int argc, char **argv)
13283 * Ethumb_Client *client;
13285 * elm_need_ethumb();
13289 * client = elm_thumb_ethumb_client_get();
13292 * ERR("could not get ethumb_client");
13295 * ethumb_client_size_set(client, 100, 100);
13296 * ethumb_client_crop_align_set(client, 0.5, 0.5);
13299 * // Create elm_thumb objects here
13309 * @note There's only one client handle for Ethumb, so once a configuration
13310 * change is done to it, any other request for thumbnails (for any thumbnail
13311 * object) will use that configuration. Thus, this configuration is global.
13315 EAPI void *elm_thumb_ethumb_client_get(void);
13317 * Get the ethumb_client connection state.
13319 * @return EINA_TRUE if the client is connected to the server or EINA_FALSE
13322 EAPI Eina_Bool elm_thumb_ethumb_client_connected(void);
13324 * Make the thumbnail 'editable'.
13326 * @param obj Thumb object.
13327 * @param set Turn on or off editability. Default is @c EINA_FALSE.
13329 * This means the thumbnail is a valid drag target for drag and drop, and can be
13330 * cut or pasted too.
13332 * @see elm_thumb_editable_get()
13336 EAPI Eina_Bool elm_thumb_editable_set(Evas_Object *obj, Eina_Bool edit) EINA_ARG_NONNULL(1);
13338 * Make the thumbnail 'editable'.
13340 * @param obj Thumb object.
13341 * @return Editability.
13343 * This means the thumbnail is a valid drag target for drag and drop, and can be
13344 * cut or pasted too.
13346 * @see elm_thumb_editable_set()
13350 EAPI Eina_Bool elm_thumb_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13357 * @defgroup Web Web
13359 * @image html img/widget/web/preview-00.png
13360 * @image latex img/widget/web/preview-00.eps
13362 * A web object is used for displaying web pages (HTML/CSS/JS)
13363 * using WebKit-EFL. You must have compiled Elementary with
13366 * Signals that you can add callbacks for are:
13367 * @li "download,request": A file download has been requested. Event info is
13368 * a pointer to a Elm_Web_Download
13369 * @li "editorclient,contents,changed": Editor client's contents changed
13370 * @li "editorclient,selection,changed": Editor client's selection changed
13371 * @li "frame,created": A new frame was created. Event info is an
13372 * Evas_Object which can be handled with WebKit's ewk_frame API
13373 * @li "icon,received": An icon was received by the main frame
13374 * @li "inputmethod,changed": Input method changed. Event info is an
13375 * Eina_Bool indicating whether it's enabled or not
13376 * @li "js,windowobject,clear": JS window object has been cleared
13377 * @li "link,hover,in": Mouse cursor is hovering over a link. Event info
13378 * is a char *link[2], where the first string contains the URL the link
13379 * points to, and the second one the title of the link
13380 * @li "link,hover,out": Mouse cursor left the link
13381 * @li "load,document,finished": Loading of a document finished. Event info
13382 * is the frame that finished loading
13383 * @li "load,error": Load failed. Event info is a pointer to
13384 * Elm_Web_Frame_Load_Error
13385 * @li "load,finished": Load finished. Event info is NULL on success, on
13386 * error it's a pointer to Elm_Web_Frame_Load_Error
13387 * @li "load,newwindow,show": A new window was created and is ready to be
13389 * @li "load,progress": Overall load progress. Event info is a pointer to
13390 * a double containing a value between 0.0 and 1.0
13391 * @li "load,provisional": Started provisional load
13392 * @li "load,started": Loading of a document started
13393 * @li "menubar,visible,get": Queries if the menubar is visible. Event info
13394 * is a pointer to Eina_Bool where the callback should set EINA_TRUE if
13395 * the menubar is visible, or EINA_FALSE in case it's not
13396 * @li "menubar,visible,set": Informs menubar visibility. Event info is
13397 * an Eina_Bool indicating the visibility
13398 * @li "popup,created": A dropdown widget was activated, requesting its
13399 * popup menu to be created. Event info is a pointer to Elm_Web_Menu
13400 * @li "popup,willdelete": The web object is ready to destroy the popup
13401 * object created. Event info is a pointer to Elm_Web_Menu
13402 * @li "ready": Page is fully loaded
13403 * @li "scrollbars,visible,get": Queries visibility of scrollbars. Event
13404 * info is a pointer to Eina_Bool where the visibility state should be set
13405 * @li "scrollbars,visible,set": Informs scrollbars visibility. Event info
13406 * is an Eina_Bool with the visibility state set
13407 * @li "statusbar,text,set": Text of the statusbar changed. Even info is
13408 * a string with the new text
13409 * @li "statusbar,visible,get": Queries visibility of the status bar.
13410 * Event info is a pointer to Eina_Bool where the visibility state should be
13412 * @li "statusbar,visible,set": Informs statusbar visibility. Event info is
13413 * an Eina_Bool with the visibility value
13414 * @li "title,changed": Title of the main frame changed. Event info is a
13415 * string with the new title
13416 * @li "toolbars,visible,get": Queries visibility of toolbars. Event info
13417 * is a pointer to Eina_Bool where the visibility state should be set
13418 * @li "toolbars,visible,set": Informs the visibility of toolbars. Event
13419 * info is an Eina_Bool with the visibility state
13420 * @li "tooltip,text,set": Show and set text of a tooltip. Event info is
13421 * a string with the text to show
13422 * @li "uri,changed": URI of the main frame changed. Event info is a string
13424 * @li "view,resized": The web object internal's view changed sized
13425 * @li "windows,close,request": A JavaScript request to close the current
13426 * window was requested
13427 * @li "zoom,animated,end": Animated zoom finished
13429 * available styles:
13432 * An example of use of web:
13434 * - @ref web_example_01 TBD
13443 * Structure used to report load errors.
13445 * Load errors are reported as signal by elm_web. All the strings are
13446 * temporary references and should @b not be used after the signal
13447 * callback returns. If it's required, make copies with strdup() or
13448 * eina_stringshare_add() (they are not even guaranteed to be
13449 * stringshared, so must use eina_stringshare_add() and not
13450 * eina_stringshare_ref()).
13452 typedef struct _Elm_Web_Frame_Load_Error Elm_Web_Frame_Load_Error;
13454 * Structure used to report load errors.
13456 * Load errors are reported as signal by elm_web. All the strings are
13457 * temporary references and should @b not be used after the signal
13458 * callback returns. If it's required, make copies with strdup() or
13459 * eina_stringshare_add() (they are not even guaranteed to be
13460 * stringshared, so must use eina_stringshare_add() and not
13461 * eina_stringshare_ref()).
13463 struct _Elm_Web_Frame_Load_Error
13465 int code; /**< Numeric error code */
13466 Eina_Bool is_cancellation; /**< Error produced by cancelling a request */
13467 const char *domain; /**< Error domain name */
13468 const char *description; /**< Error description (already localized) */
13469 const char *failing_url; /**< The URL that failed to load */
13470 Evas_Object *frame; /**< Frame object that produced the error */
13474 * The possibles types that the items in a menu can be
13476 typedef enum _Elm_Web_Menu_Item_Type
13478 ELM_WEB_MENU_SEPARATOR,
13479 ELM_WEB_MENU_GROUP,
13480 ELM_WEB_MENU_OPTION
13481 } Elm_Web_Menu_Item_Type;
13484 * Structure describing the items in a menu
13486 typedef struct _Elm_Web_Menu_Item Elm_Web_Menu_Item;
13488 * Structure describing the items in a menu
13490 struct _Elm_Web_Menu_Item
13492 const char *text; /**< The text for the item */
13493 Elm_Web_Menu_Item_Type type; /**< The type of the item */
13497 * Structure describing the menu of a popup
13499 * This structure will be passed as the @c event_info for the "popup,create"
13500 * signal, which is emitted when a dropdown menu is opened. Users wanting
13501 * to handle these popups by themselves should listen to this signal and
13502 * set the @c handled property of the struct to @c EINA_TRUE. Leaving this
13503 * property as @c EINA_FALSE means that the user will not handle the popup
13504 * and the default implementation will be used.
13506 * When the popup is ready to be dismissed, a "popup,willdelete" signal
13507 * will be emitted to notify the user that it can destroy any objects and
13508 * free all data related to it.
13510 * @see elm_web_popup_selected_set()
13511 * @see elm_web_popup_destroy()
13513 typedef struct _Elm_Web_Menu Elm_Web_Menu;
13515 * Structure describing the menu of a popup
13517 * This structure will be passed as the @c event_info for the "popup,create"
13518 * signal, which is emitted when a dropdown menu is opened. Users wanting
13519 * to handle these popups by themselves should listen to this signal and
13520 * set the @c handled property of the struct to @c EINA_TRUE. Leaving this
13521 * property as @c EINA_FALSE means that the user will not handle the popup
13522 * and the default implementation will be used.
13524 * When the popup is ready to be dismissed, a "popup,willdelete" signal
13525 * will be emitted to notify the user that it can destroy any objects and
13526 * free all data related to it.
13528 * @see elm_web_popup_selected_set()
13529 * @see elm_web_popup_destroy()
13531 struct _Elm_Web_Menu
13533 Eina_List *items; /**< List of #Elm_Web_Menu_Item */
13534 int x; /**< The X position of the popup, relative to the elm_web object */
13535 int y; /**< The Y position of the popup, relative to the elm_web object */
13536 int width; /**< Width of the popup menu */
13537 int height; /**< Height of the popup menu */
13539 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. */
13542 typedef struct _Elm_Web_Download Elm_Web_Download;
13543 struct _Elm_Web_Download
13549 * Types of zoom available.
13551 typedef enum _Elm_Web_Zoom_Mode
13553 ELM_WEB_ZOOM_MODE_MANUAL = 0, /**< Zoom controlled normally by elm_web_zoom_set */
13554 ELM_WEB_ZOOM_MODE_AUTO_FIT, /**< Zoom until content fits in web object */
13555 ELM_WEB_ZOOM_MODE_AUTO_FILL, /**< Zoom until content fills web object */
13556 ELM_WEB_ZOOM_MODE_LAST
13557 } Elm_Web_Zoom_Mode;
13559 * Opaque handler containing the features (such as statusbar, menubar, etc)
13560 * that are to be set on a newly requested window.
13562 typedef struct _Elm_Web_Window_Features Elm_Web_Window_Features;
13564 * Callback type for the create_window hook.
13566 * The function parameters are:
13567 * @li @p data User data pointer set when setting the hook function
13568 * @li @p obj The elm_web object requesting the new window
13569 * @li @p js Set to @c EINA_TRUE if the request was originated from
13570 * JavaScript. @c EINA_FALSE otherwise.
13571 * @li @p window_features A pointer of #Elm_Web_Window_Features indicating
13572 * the features requested for the new window.
13574 * The returned value of the function should be the @c elm_web widget where
13575 * the request will be loaded. That is, if a new window or tab is created,
13576 * the elm_web widget in it should be returned, and @b NOT the window
13578 * Returning @c NULL should cancel the request.
13580 * @see elm_web_window_create_hook_set()
13582 typedef Evas_Object *(*Elm_Web_Window_Open)(void *data, Evas_Object *obj, Eina_Bool js, const Elm_Web_Window_Features *window_features);
13584 * Callback type for the JS alert hook.
13586 * The function parameters are:
13587 * @li @p data User data pointer set when setting the hook function
13588 * @li @p obj The elm_web object requesting the new window
13589 * @li @p message The message to show in the alert dialog
13591 * The function should return the object representing the alert dialog.
13592 * Elm_Web will run a second main loop to handle the dialog and normal
13593 * flow of the application will be restored when the object is deleted, so
13594 * the user should handle the popup properly in order to delete the object
13595 * when the action is finished.
13596 * If the function returns @c NULL the popup will be ignored.
13598 * @see elm_web_dialog_alert_hook_set()
13600 typedef Evas_Object *(*Elm_Web_Dialog_Alert)(void *data, Evas_Object *obj, const char *message);
13602 * Callback type for the JS confirm hook.
13604 * The function parameters are:
13605 * @li @p data User data pointer set when setting the hook function
13606 * @li @p obj The elm_web object requesting the new window
13607 * @li @p message The message to show in the confirm dialog
13608 * @li @p ret Pointer where to store the user selection. @c EINA_TRUE if
13609 * the user selected @c Ok, @c EINA_FALSE otherwise.
13611 * The function should return the object representing the confirm dialog.
13612 * Elm_Web will run a second main loop to handle the dialog and normal
13613 * flow of the application will be restored when the object is deleted, so
13614 * the user should handle the popup properly in order to delete the object
13615 * when the action is finished.
13616 * If the function returns @c NULL the popup will be ignored.
13618 * @see elm_web_dialog_confirm_hook_set()
13620 typedef Evas_Object *(*Elm_Web_Dialog_Confirm)(void *data, Evas_Object *obj, const char *message, Eina_Bool *ret);
13622 * Callback type for the JS prompt hook.
13624 * The function parameters are:
13625 * @li @p data User data pointer set when setting the hook function
13626 * @li @p obj The elm_web object requesting the new window
13627 * @li @p message The message to show in the prompt dialog
13628 * @li @p def_value The default value to present the user in the entry
13629 * @li @p value Pointer where to store the value given by the user. Must
13630 * be a malloc'ed string or @c NULL if the user cancelled the popup.
13631 * @li @p ret Pointer where to store the user selection. @c EINA_TRUE if
13632 * the user selected @c Ok, @c EINA_FALSE otherwise.
13634 * The function should return the object representing the prompt dialog.
13635 * Elm_Web will run a second main loop to handle the dialog and normal
13636 * flow of the application will be restored when the object is deleted, so
13637 * the user should handle the popup properly in order to delete the object
13638 * when the action is finished.
13639 * If the function returns @c NULL the popup will be ignored.
13641 * @see elm_web_dialog_prompt_hook_set()
13643 typedef Evas_Object *(*Elm_Web_Dialog_Prompt)(void *data, Evas_Object *obj, const char *message, const char *def_value, char **value, Eina_Bool *ret);
13645 * Callback type for the JS file selector hook.
13647 * The function parameters are:
13648 * @li @p data User data pointer set when setting the hook function
13649 * @li @p obj The elm_web object requesting the new window
13650 * @li @p allows_multiple @c EINA_TRUE if multiple files can be selected.
13651 * @li @p accept_types Mime types accepted
13652 * @li @p selected Pointer where to store the list of malloc'ed strings
13653 * containing the path to each file selected. Must be @c NULL if the file
13654 * dialog is cancelled
13655 * @li @p ret Pointer where to store the user selection. @c EINA_TRUE if
13656 * the user selected @c Ok, @c EINA_FALSE otherwise.
13658 * The function should return the object representing the file selector
13660 * Elm_Web will run a second main loop to handle the dialog and normal
13661 * flow of the application will be restored when the object is deleted, so
13662 * the user should handle the popup properly in order to delete the object
13663 * when the action is finished.
13664 * If the function returns @c NULL the popup will be ignored.
13666 * @see elm_web_dialog_file selector_hook_set()
13668 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);
13670 * Callback type for the JS console message hook.
13672 * When a console message is added from JavaScript, any set function to the
13673 * console message hook will be called for the user to handle. There is no
13674 * default implementation of this hook.
13676 * The function parameters are:
13677 * @li @p data User data pointer set when setting the hook function
13678 * @li @p obj The elm_web object that originated the message
13679 * @li @p message The message sent
13680 * @li @p line_number The line number
13681 * @li @p source_id Source id
13683 * @see elm_web_console_message_hook_set()
13685 typedef void (*Elm_Web_Console_Message)(void *data, Evas_Object *obj, const char *message, unsigned int line_number, const char *source_id);
13687 * Add a new web object to the parent.
13689 * @param parent The parent object.
13690 * @return The new object or NULL if it cannot be created.
13692 * @see elm_web_uri_set()
13693 * @see elm_web_webkit_view_get()
13695 EAPI Evas_Object *elm_web_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
13698 * Get internal ewk_view object from web object.
13700 * Elementary may not provide some low level features of EWebKit,
13701 * instead of cluttering the API with proxy methods we opted to
13702 * return the internal reference. Be careful using it as it may
13703 * interfere with elm_web behavior.
13705 * @param obj The web object.
13706 * @return The internal ewk_view object or NULL if it does not
13707 * exist. (Failure to create or Elementary compiled without
13710 * @see elm_web_add()
13712 EAPI Evas_Object *elm_web_webkit_view_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13715 * Sets the function to call when a new window is requested
13717 * This hook will be called when a request to create a new window is
13718 * issued from the web page loaded.
13719 * There is no default implementation for this feature, so leaving this
13720 * unset or passing @c NULL in @p func will prevent new windows from
13723 * @param obj The web object where to set the hook function
13724 * @param func The hook function to be called when a window is requested
13725 * @param data User data
13727 EAPI void elm_web_window_create_hook_set(Evas_Object *obj, Elm_Web_Window_Open func, void *data);
13729 * Sets the function to call when an alert dialog
13731 * This hook will be called when a JavaScript alert dialog is requested.
13732 * If no function is set or @c NULL is passed in @p func, the default
13733 * implementation will take place.
13735 * @param obj The web object where to set the hook function
13736 * @param func The callback function to be used
13737 * @param data User data
13739 * @see elm_web_inwin_mode_set()
13741 EAPI void elm_web_dialog_alert_hook_set(Evas_Object *obj, Elm_Web_Dialog_Alert func, void *data);
13743 * Sets the function to call when an confirm dialog
13745 * This hook will be called when a JavaScript confirm dialog is requested.
13746 * If no function is set or @c NULL is passed in @p func, the default
13747 * implementation will take place.
13749 * @param obj The web object where to set the hook function
13750 * @param func The callback function to be used
13751 * @param data User data
13753 * @see elm_web_inwin_mode_set()
13755 EAPI void elm_web_dialog_confirm_hook_set(Evas_Object *obj, Elm_Web_Dialog_Confirm func, void *data);
13757 * Sets the function to call when an prompt dialog
13759 * This hook will be called when a JavaScript prompt dialog is requested.
13760 * If no function is set or @c NULL is passed in @p func, the default
13761 * implementation will take place.
13763 * @param obj The web object where to set the hook function
13764 * @param func The callback function to be used
13765 * @param data User data
13767 * @see elm_web_inwin_mode_set()
13769 EAPI void elm_web_dialog_prompt_hook_set(Evas_Object *obj, Elm_Web_Dialog_Prompt func, void *data);
13771 * Sets the function to call when an file selector dialog
13773 * This hook will be called when a JavaScript file selector dialog is
13775 * If no function is set or @c NULL is passed in @p func, the default
13776 * implementation will take place.
13778 * @param obj The web object where to set the hook function
13779 * @param func The callback function to be used
13780 * @param data User data
13782 * @see elm_web_inwin_mode_set()
13784 EAPI void elm_web_dialog_file_selector_hook_set(Evas_Object *obj, Elm_Web_Dialog_File_Selector func, void *data);
13786 * Sets the function to call when a console message is emitted from JS
13788 * This hook will be called when a console message is emitted from
13789 * JavaScript. There is no default implementation for this feature.
13791 * @param obj The web object where to set the hook function
13792 * @param func The callback function to be used
13793 * @param data User data
13795 EAPI void elm_web_console_message_hook_set(Evas_Object *obj, Elm_Web_Console_Message func, void *data);
13797 * Gets the status of the tab propagation
13799 * @param obj The web object to query
13800 * @return EINA_TRUE if tab propagation is enabled, EINA_FALSE otherwise
13802 * @see elm_web_tab_propagate_set()
13804 EAPI Eina_Bool elm_web_tab_propagate_get(const Evas_Object *obj);
13806 * Sets whether to use tab propagation
13808 * If tab propagation is enabled, whenever the user presses the Tab key,
13809 * Elementary will handle it and switch focus to the next widget.
13810 * The default value is disabled, where WebKit will handle the Tab key to
13811 * cycle focus though its internal objects, jumping to the next widget
13812 * only when that cycle ends.
13814 * @param obj The web object
13815 * @param propagate Whether to propagate Tab keys to Elementary or not
13817 EAPI void elm_web_tab_propagate_set(Evas_Object *obj, Eina_Bool propagate);
13819 * Sets the URI for the web object
13821 * It must be a full URI, with resource included, in the form
13822 * http://www.enlightenment.org or file:///tmp/something.html
13824 * @param obj The web object
13825 * @param uri The URI to set
13826 * @return EINA_TRUE if the URI could be, EINA_FALSE if an error occurred
13828 EAPI Eina_Bool elm_web_uri_set(Evas_Object *obj, const char *uri);
13830 * Gets the current URI for the object
13832 * The returned string must not be freed and is guaranteed to be
13835 * @param obj The web object
13836 * @return A stringshared internal string with the current URI, or NULL on
13839 EAPI const char *elm_web_uri_get(const Evas_Object *obj);
13841 * Gets the current title
13843 * The returned string must not be freed and is guaranteed to be
13846 * @param obj The web object
13847 * @return A stringshared internal string with the current title, or NULL on
13850 EAPI const char *elm_web_title_get(const Evas_Object *obj);
13852 * Sets the background color to be used by the web object
13854 * This is the color that will be used by default when the loaded page
13855 * does not set it's own. Color values are pre-multiplied.
13857 * @param obj The web object
13858 * @param r Red component
13859 * @param g Green component
13860 * @param b Blue component
13861 * @param a Alpha component
13863 EAPI void elm_web_bg_color_set(Evas_Object *obj, int r, int g, int b, int a);
13865 * Gets the background color to be used by the web object
13867 * This is the color that will be used by default when the loaded page
13868 * does not set it's own. Color values are pre-multiplied.
13870 * @param obj The web object
13871 * @param r Red component
13872 * @param g Green component
13873 * @param b Blue component
13874 * @param a Alpha component
13876 EAPI void elm_web_bg_color_get(const Evas_Object *obj, int *r, int *g, int *b, int *a);
13878 * Gets a copy of the currently selected text
13880 * The string returned must be freed by the user when it's done with it.
13882 * @param obj The web object
13883 * @return A newly allocated string, or NULL if nothing is selected or an
13886 EAPI char *elm_view_selection_get(const Evas_Object *obj);
13888 * Tells the web object which index in the currently open popup was selected
13890 * When the user handles the popup creation from the "popup,created" signal,
13891 * it needs to tell the web object which item was selected by calling this
13892 * function with the index corresponding to the item.
13894 * @param obj The web object
13895 * @param index The index selected
13897 * @see elm_web_popup_destroy()
13899 EAPI void elm_web_popup_selected_set(Evas_Object *obj, int index);
13901 * Dismisses an open dropdown popup
13903 * When the popup from a dropdown widget is to be dismissed, either after
13904 * selecting an option or to cancel it, this function must be called, which
13905 * will later emit an "popup,willdelete" signal to notify the user that
13906 * any memory and objects related to this popup can be freed.
13908 * @param obj The web object
13909 * @return EINA_TRUE if the menu was successfully destroyed, or EINA_FALSE
13910 * if there was no menu to destroy
13912 EAPI Eina_Bool elm_web_popup_destroy(Evas_Object *obj);
13914 * Searches the given string in a document.
13916 * @param obj The web object where to search the text
13917 * @param string String to search
13918 * @param case_sensitive If search should be case sensitive or not
13919 * @param forward If search is from cursor and on or backwards
13920 * @param wrap If search should wrap at the end
13922 * @return @c EINA_TRUE if the given string was found, @c EINA_FALSE if not
13925 EAPI Eina_Bool elm_web_text_search(const Evas_Object *obj, const char *string, Eina_Bool case_sensitive, Eina_Bool forward, Eina_Bool wrap);
13927 * Marks matches of the given string in a document.
13929 * @param obj The web object where to search text
13930 * @param string String to match
13931 * @param case_sensitive If match should be case sensitive or not
13932 * @param highlight If matches should be highlighted
13933 * @param limit Maximum amount of matches, or zero to unlimited
13935 * @return number of matched @a string
13937 EAPI unsigned int elm_web_text_matches_mark(Evas_Object *obj, const char *string, Eina_Bool case_sensitive, Eina_Bool highlight, unsigned int limit);
13939 * Clears all marked matches in the document
13941 * @param obj The web object
13943 * @return EINA_TRUE on success, EINA_FALSE otherwise
13945 EAPI Eina_Bool elm_web_text_matches_unmark_all(Evas_Object *obj);
13947 * Sets whether to highlight the matched marks
13949 * If enabled, marks set with elm_web_text_matches_mark() will be
13952 * @param obj The web object
13953 * @param highlight Whether to highlight the marks or not
13955 * @return EINA_TRUE on success, EINA_FALSE otherwise
13957 EAPI Eina_Bool elm_web_text_matches_highlight_set(Evas_Object *obj, Eina_Bool highlight);
13959 * Gets whether highlighting marks is enabled
13961 * @param The web object
13963 * @return EINA_TRUE is marks are set to be highlighted, EINA_FALSE
13966 EAPI Eina_Bool elm_web_text_matches_highlight_get(const Evas_Object *obj);
13968 * Gets the overall loading progress of the page
13970 * Returns the estimated loading progress of the page, with a value between
13971 * 0.0 and 1.0. This is an estimated progress accounting for all the frames
13972 * included in the page.
13974 * @param The web object
13976 * @return A value between 0.0 and 1.0 indicating the progress, or -1.0 on
13979 EAPI double elm_web_load_progress_get(const Evas_Object *obj);
13981 * Stops loading the current page
13983 * Cancels the loading of the current page in the web object. This will
13984 * cause a "load,error" signal to be emitted, with the is_cancellation
13985 * flag set to EINA_TRUE.
13987 * @param obj The web object
13989 * @return EINA_TRUE if the cancel was successful, EINA_FALSE otherwise
13991 EAPI Eina_Bool elm_web_stop(Evas_Object *obj);
13993 * Requests a reload of the current document in the object
13995 * @param obj The web object
13997 * @return EINA_TRUE on success, EINA_FALSE otherwise
13999 EAPI Eina_Bool elm_web_reload(Evas_Object *obj);
14001 * Requests a reload of the current document, avoiding any existing caches
14003 * @param obj The web object
14005 * @return EINA_TRUE on success, EINA_FALSE otherwise
14007 EAPI Eina_Bool elm_web_reload_full(Evas_Object *obj);
14009 * Goes back one step in the browsing history
14011 * This is equivalent to calling elm_web_object_navigate(obj, -1);
14013 * @param obj The web object
14015 * @return EINA_TRUE on success, EINA_FALSE otherwise
14017 * @see elm_web_history_enable_set()
14018 * @see elm_web_back_possible()
14019 * @see elm_web_forward()
14020 * @see elm_web_navigate()
14022 EAPI Eina_Bool elm_web_back(Evas_Object *obj);
14024 * Goes forward one step in the browsing history
14026 * This is equivalent to calling elm_web_object_navigate(obj, 1);
14028 * @param obj The web object
14030 * @return EINA_TRUE on success, EINA_FALSE otherwise
14032 * @see elm_web_history_enable_set()
14033 * @see elm_web_forward_possible()
14034 * @see elm_web_back()
14035 * @see elm_web_navigate()
14037 EAPI Eina_Bool elm_web_forward(Evas_Object *obj);
14039 * Jumps the given number of steps in the browsing history
14041 * The @p steps value can be a negative integer to back in history, or a
14042 * positive to move forward.
14044 * @param obj The web object
14045 * @param steps The number of steps to jump
14047 * @return EINA_TRUE on success, EINA_FALSE on error or if not enough
14048 * history exists to jump the given number of steps
14050 * @see elm_web_history_enable_set()
14051 * @see elm_web_navigate_possible()
14052 * @see elm_web_back()
14053 * @see elm_web_forward()
14055 EAPI Eina_Bool elm_web_navigate(Evas_Object *obj, int steps);
14057 * Queries whether it's possible to go back in history
14059 * @param obj The web object
14061 * @return EINA_TRUE if it's possible to back in history, EINA_FALSE
14064 EAPI Eina_Bool elm_web_back_possible(Evas_Object *obj);
14066 * Queries whether it's possible to go forward in history
14068 * @param obj The web object
14070 * @return EINA_TRUE if it's possible to forward in history, EINA_FALSE
14073 EAPI Eina_Bool elm_web_forward_possible(Evas_Object *obj);
14075 * Queries whether it's possible to jump the given number of steps
14077 * The @p steps value can be a negative integer to back in history, or a
14078 * positive to move forward.
14080 * @param obj The web object
14081 * @param steps The number of steps to check for
14083 * @return EINA_TRUE if enough history exists to perform the given jump,
14084 * EINA_FALSE otherwise
14086 EAPI Eina_Bool elm_web_navigate_possible(Evas_Object *obj, int steps);
14088 * Gets whether browsing history is enabled for the given object
14090 * @param obj The web object
14092 * @return EINA_TRUE if history is enabled, EINA_FALSE otherwise
14094 EAPI Eina_Bool elm_web_history_enable_get(const Evas_Object *obj);
14096 * Enables or disables the browsing history
14098 * @param obj The web object
14099 * @param enable Whether to enable or disable the browsing history
14101 EAPI void elm_web_history_enable_set(Evas_Object *obj, Eina_Bool enable);
14103 * Sets the zoom level of the web object
14105 * Zoom level matches the Webkit API, so 1.0 means normal zoom, with higher
14106 * values meaning zoom in and lower meaning zoom out. This function will
14107 * only affect the zoom level if the mode set with elm_web_zoom_mode_set()
14108 * is ::ELM_WEB_ZOOM_MODE_MANUAL.
14110 * @param obj The web object
14111 * @param zoom The zoom level to set
14113 EAPI void elm_web_zoom_set(Evas_Object *obj, double zoom);
14115 * Gets the current zoom level set on the web object
14117 * Note that this is the zoom level set on the web object and not that
14118 * of the underlying Webkit one. In the ::ELM_WEB_ZOOM_MODE_MANUAL mode,
14119 * the two zoom levels should match, but for the other two modes the
14120 * Webkit zoom is calculated internally to match the chosen mode without
14121 * changing the zoom level set for the web object.
14123 * @param obj The web object
14125 * @return The zoom level set on the object
14127 EAPI double elm_web_zoom_get(const Evas_Object *obj);
14129 * Sets the zoom mode to use
14131 * The modes can be any of those defined in ::Elm_Web_Zoom_Mode, except
14132 * ::ELM_WEB_ZOOM_MODE_LAST. The default is ::ELM_WEB_ZOOM_MODE_MANUAL.
14134 * ::ELM_WEB_ZOOM_MODE_MANUAL means the zoom level will be controlled
14135 * with the elm_web_zoom_set() function.
14136 * ::ELM_WEB_ZOOM_MODE_AUTO_FIT will calculate the needed zoom level to
14137 * make sure the entirety of the web object's contents are shown.
14138 * ::ELM_WEB_ZOOM_MODE_AUTO_FILL will calculate the needed zoom level to
14139 * fit the contents in the web object's size, without leaving any space
14142 * @param obj The web object
14143 * @param mode The mode to set
14145 EAPI void elm_web_zoom_mode_set(Evas_Object *obj, Elm_Web_Zoom_Mode mode);
14147 * Gets the currently set zoom mode
14149 * @param obj The web object
14151 * @return The current zoom mode set for the object, or
14152 * ::ELM_WEB_ZOOM_MODE_LAST on error
14154 EAPI Elm_Web_Zoom_Mode elm_web_zoom_mode_get(const Evas_Object *obj);
14156 * Shows the given region in the web object
14158 * @param obj The web object
14159 * @param x The x coordinate of the region to show
14160 * @param y The y coordinate of the region to show
14161 * @param w The width of the region to show
14162 * @param h The height of the region to show
14164 EAPI void elm_web_region_show(Evas_Object *obj, int x, int y, int w, int h);
14166 * Brings in the region to the visible area
14168 * Like elm_web_region_show(), but it animates the scrolling of the object
14171 * @param obj The web object
14172 * @param x The x coordinate of the region to show
14173 * @param y The y coordinate of the region to show
14174 * @param w The width of the region to show
14175 * @param h The height of the region to show
14177 EAPI void elm_web_region_bring_in(Evas_Object *obj, int x, int y, int w, int h);
14179 * Sets the default dialogs to use an Inwin instead of a normal window
14181 * If set, then the default implementation for the JavaScript dialogs and
14182 * file selector will be opened in an Inwin. Otherwise they will use a
14183 * normal separated window.
14185 * @param obj The web object
14186 * @param value EINA_TRUE to use Inwin, EINA_FALSE to use a normal window
14188 EAPI void elm_web_inwin_mode_set(Evas_Object *obj, Eina_Bool value);
14190 * Gets whether Inwin mode is set for the current object
14192 * @param obj The web object
14194 * @return EINA_TRUE if Inwin mode is set, EINA_FALSE otherwise
14196 EAPI Eina_Bool elm_web_inwin_mode_get(const Evas_Object *obj);
14198 EAPI void elm_web_window_features_ref(Elm_Web_Window_Features *wf);
14199 EAPI void elm_web_window_features_unref(Elm_Web_Window_Features *wf);
14200 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);
14201 EAPI void elm_web_window_features_int_property_get(const Elm_Web_Window_Features *wf, int *x, int *y, int *w, int *h);
14208 * @defgroup Hoversel Hoversel
14210 * @image html img/widget/hoversel/preview-00.png
14211 * @image latex img/widget/hoversel/preview-00.eps
14213 * A hoversel is a button that pops up a list of items (automatically
14214 * choosing the direction to display) that have a label and, optionally, an
14215 * icon to select from. It is a convenience widget to avoid the need to do
14216 * all the piecing together yourself. It is intended for a small number of
14217 * items in the hoversel menu (no more than 8), though is capable of many
14220 * Signals that you can add callbacks for are:
14221 * "clicked" - the user clicked the hoversel button and popped up the sel
14222 * "selected" - an item in the hoversel list is selected. event_info is the item
14223 * "dismissed" - the hover is dismissed
14225 * See @ref tutorial_hoversel for an example.
14228 typedef struct _Elm_Hoversel_Item Elm_Hoversel_Item; /**< Item of Elm_Hoversel. Sub-type of Elm_Widget_Item */
14230 * @brief Add a new Hoversel object
14232 * @param parent The parent object
14233 * @return The new object or NULL if it cannot be created
14235 EAPI Evas_Object *elm_hoversel_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
14237 * @brief This sets the hoversel to expand horizontally.
14239 * @param obj The hoversel object
14240 * @param horizontal If true, the hover will expand horizontally to the
14243 * @note The initial button will display horizontally regardless of this
14246 EAPI void elm_hoversel_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
14248 * @brief This returns whether the hoversel is set to expand horizontally.
14250 * @param obj The hoversel object
14251 * @return If true, the hover will expand horizontally to the right.
14253 * @see elm_hoversel_horizontal_set()
14255 EAPI Eina_Bool elm_hoversel_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14257 * @brief Set the Hover parent
14259 * @param obj The hoversel object
14260 * @param parent The parent to use
14262 * Sets the hover parent object, the area that will be darkened when the
14263 * hoversel is clicked. Should probably be the window that the hoversel is
14264 * in. See @ref Hover objects for more information.
14266 EAPI void elm_hoversel_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
14268 * @brief Get the Hover parent
14270 * @param obj The hoversel object
14271 * @return The used parent
14273 * Gets the hover parent object.
14275 * @see elm_hoversel_hover_parent_set()
14277 EAPI Evas_Object *elm_hoversel_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14279 * @brief Set the hoversel button label
14281 * @param obj The hoversel object
14282 * @param label The label text.
14284 * This sets the label of the button that is always visible (before it is
14285 * clicked and expanded).
14287 * @deprecated elm_object_text_set()
14289 EINA_DEPRECATED EAPI void elm_hoversel_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
14291 * @brief Get the hoversel button label
14293 * @param obj The hoversel object
14294 * @return The label text.
14296 * @deprecated elm_object_text_get()
14298 EINA_DEPRECATED EAPI const char *elm_hoversel_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14300 * @brief Set the icon of the hoversel button
14302 * @param obj The hoversel object
14303 * @param icon The icon object
14305 * Sets the icon of the button that is always visible (before it is clicked
14306 * and expanded). Once the icon object is set, a previously set one will be
14307 * deleted, if you want to keep that old content object, use the
14308 * elm_hoversel_icon_unset() function.
14310 * @see elm_object_content_set() for the button widget
14312 EAPI void elm_hoversel_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
14314 * @brief Get the icon of the hoversel button
14316 * @param obj The hoversel object
14317 * @return The icon object
14319 * Get the icon of the button that is always visible (before it is clicked
14320 * and expanded). Also see elm_object_content_get() for the button widget.
14322 * @see elm_hoversel_icon_set()
14324 EAPI Evas_Object *elm_hoversel_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14326 * @brief Get and unparent the icon of the hoversel button
14328 * @param obj The hoversel object
14329 * @return The icon object that was being used
14331 * Unparent and return the icon of the button that is always visible
14332 * (before it is clicked and expanded).
14334 * @see elm_hoversel_icon_set()
14335 * @see elm_object_content_unset() for the button widget
14337 EAPI Evas_Object *elm_hoversel_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
14339 * @brief This triggers the hoversel popup from code, the same as if the user
14340 * had clicked the button.
14342 * @param obj The hoversel object
14344 EAPI void elm_hoversel_hover_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
14346 * @brief This dismisses the hoversel popup as if the user had clicked
14347 * outside the hover.
14349 * @param obj The hoversel object
14351 EAPI void elm_hoversel_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
14353 * @brief Returns whether the hoversel is expanded.
14355 * @param obj The hoversel object
14356 * @return This will return EINA_TRUE if the hoversel is expanded or
14357 * EINA_FALSE if it is not expanded.
14359 EAPI Eina_Bool elm_hoversel_expanded_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14361 * @brief This will remove all the children items from the hoversel.
14363 * @param obj The hoversel object
14365 * @warning Should @b not be called while the hoversel is active; use
14366 * elm_hoversel_expanded_get() to check first.
14368 * @see elm_hoversel_item_del_cb_set()
14369 * @see elm_hoversel_item_del()
14371 EAPI void elm_hoversel_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
14373 * @brief Get the list of items within the given hoversel.
14375 * @param obj The hoversel object
14376 * @return Returns a list of Elm_Hoversel_Item*
14378 * @see elm_hoversel_item_add()
14380 EAPI const Eina_List *elm_hoversel_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14382 * @brief Add an item to the hoversel button
14384 * @param obj The hoversel object
14385 * @param label The text label to use for the item (NULL if not desired)
14386 * @param icon_file An image file path on disk to use for the icon or standard
14387 * icon name (NULL if not desired)
14388 * @param icon_type The icon type if relevant
14389 * @param func Convenience function to call when this item is selected
14390 * @param data Data to pass to item-related functions
14391 * @return A handle to the item added.
14393 * This adds an item to the hoversel to show when it is clicked. Note: if you
14394 * need to use an icon from an edje file then use
14395 * elm_hoversel_item_icon_set() right after the this function, and set
14396 * icon_file to NULL here.
14398 * For more information on what @p icon_file and @p icon_type are see the
14399 * @ref Icon "icon documentation".
14401 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);
14403 * @brief Delete an item from the hoversel
14405 * @param item The item to delete
14407 * This deletes the item from the hoversel (should not be called while the
14408 * hoversel is active; use elm_hoversel_expanded_get() to check first).
14410 * @see elm_hoversel_item_add()
14411 * @see elm_hoversel_item_del_cb_set()
14413 EAPI void elm_hoversel_item_del(Elm_Hoversel_Item *item) EINA_ARG_NONNULL(1);
14415 * @brief Set the function to be called when an item from the hoversel is
14418 * @param item The item to set the callback on
14419 * @param func The function called
14421 * That function will receive these parameters:
14422 * @li void *item_data
14423 * @li Evas_Object *the_item_object
14424 * @li Elm_Hoversel_Item *the_object_struct
14426 * @see elm_hoversel_item_add()
14428 EAPI void elm_hoversel_item_del_cb_set(Elm_Hoversel_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
14430 * @brief This returns the data pointer supplied with elm_hoversel_item_add()
14431 * that will be passed to associated function callbacks.
14433 * @param item The item to get the data from
14434 * @return The data pointer set with elm_hoversel_item_add()
14436 * @see elm_hoversel_item_add()
14438 EAPI void *elm_hoversel_item_data_get(const Elm_Hoversel_Item *it) EINA_ARG_NONNULL(1);
14440 * @brief This returns the label text of the given hoversel item.
14442 * @param item The item to get the label
14443 * @return The label text of the hoversel item
14445 * @see elm_hoversel_item_add()
14447 EAPI const char *elm_hoversel_item_label_get(const Elm_Hoversel_Item *it) EINA_ARG_NONNULL(1);
14449 * @brief This sets the icon for the given hoversel item.
14451 * @param item The item to set the icon
14452 * @param icon_file An image file path on disk to use for the icon or standard
14454 * @param icon_group The edje group to use if @p icon_file is an edje file. Set this
14455 * to NULL if the icon is not an edje file
14456 * @param icon_type The icon type
14458 * The icon can be loaded from the standard set, from an image file, or from
14461 * @see elm_hoversel_item_add()
14463 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);
14465 * @brief Get the icon object of the hoversel item
14467 * @param item The item to get the icon from
14468 * @param icon_file The image file path on disk used for the icon or standard
14470 * @param icon_group The edje group used if @p icon_file is an edje file. NULL
14471 * if the icon is not an edje file
14472 * @param icon_type The icon type
14474 * @see elm_hoversel_item_icon_set()
14475 * @see elm_hoversel_item_add()
14477 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);
14483 * @defgroup Toolbar Toolbar
14484 * @ingroup Elementary
14486 * @image html img/widget/toolbar/preview-00.png
14487 * @image latex img/widget/toolbar/preview-00.eps width=\textwidth
14489 * @image html img/toolbar.png
14490 * @image latex img/toolbar.eps width=\textwidth
14492 * A toolbar is a widget that displays a list of items inside
14493 * a box. It can be scrollable, show a menu with items that don't fit
14494 * to toolbar size or even crop them.
14496 * Only one item can be selected at a time.
14498 * Items can have multiple states, or show menus when selected by the user.
14500 * Smart callbacks one can listen to:
14501 * - "clicked" - when the user clicks on a toolbar item and becomes selected.
14502 * - "language,changed" - when the program language changes
14504 * Available styles for it:
14506 * - @c "transparent" - no background or shadow, just show the content
14508 * List of examples:
14509 * @li @ref toolbar_example_01
14510 * @li @ref toolbar_example_02
14511 * @li @ref toolbar_example_03
14515 * @addtogroup Toolbar
14520 * @enum _Elm_Toolbar_Shrink_Mode
14521 * @typedef Elm_Toolbar_Shrink_Mode
14523 * Set toolbar's items display behavior, it can be scrollabel,
14524 * show a menu with exceeding items, or simply hide them.
14526 * @note Default value is #ELM_TOOLBAR_SHRINK_MENU. It reads value
14529 * Values <b> don't </b> work as bitmask, only one can be choosen.
14531 * @see elm_toolbar_mode_shrink_set()
14532 * @see elm_toolbar_mode_shrink_get()
14536 typedef enum _Elm_Toolbar_Shrink_Mode
14538 ELM_TOOLBAR_SHRINK_NONE, /**< Set toolbar minimun size to fit all the items. */
14539 ELM_TOOLBAR_SHRINK_HIDE, /**< Hide exceeding items. */
14540 ELM_TOOLBAR_SHRINK_SCROLL, /**< Allow accessing exceeding items through a scroller. */
14541 ELM_TOOLBAR_SHRINK_MENU, /**< Inserts a button to pop up a menu with exceeding items. */
14542 ELM_TOOLBAR_SHRINK_LAST /**< Indicates error if returned by elm_toolbar_shrink_mode_get() */
14543 } Elm_Toolbar_Shrink_Mode;
14545 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(). */
14548 * Add a new toolbar widget to the given parent Elementary
14549 * (container) object.
14551 * @param parent The parent object.
14552 * @return a new toolbar widget handle or @c NULL, on errors.
14554 * This function inserts a new toolbar widget on the canvas.
14558 EAPI Evas_Object *elm_toolbar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
14560 * Set the icon size, in pixels, to be used by toolbar items.
14562 * @param obj The toolbar object
14563 * @param icon_size The icon size in pixels
14565 * @note Default value is @c 32. It reads value from elm config.
14567 * @see elm_toolbar_icon_size_get()
14571 EAPI void elm_toolbar_icon_size_set(Evas_Object *obj, int icon_size) EINA_ARG_NONNULL(1);
14573 * Get the icon size, in pixels, to be used by toolbar items.
14575 * @param obj The toolbar object.
14576 * @return The icon size in pixels.
14578 * @see elm_toolbar_icon_size_set() for details.
14582 EAPI int elm_toolbar_icon_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14584 * Sets icon lookup order, for toolbar items' icons.
14586 * @param obj The toolbar object.
14587 * @param order The icon lookup order.
14589 * Icons added before calling this function will not be affected.
14590 * The default lookup order is #ELM_ICON_LOOKUP_THEME_FDO.
14592 * @see elm_toolbar_icon_order_lookup_get()
14596 EAPI void elm_toolbar_icon_order_lookup_set(Evas_Object *obj, Elm_Icon_Lookup_Order order) EINA_ARG_NONNULL(1);
14598 * Gets the icon lookup order.
14600 * @param obj The toolbar object.
14601 * @return The icon lookup order.
14603 * @see elm_toolbar_icon_order_lookup_set() for details.
14607 EAPI Elm_Icon_Lookup_Order elm_toolbar_icon_order_lookup_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14609 * Set whether the toolbar should always have an item selected.
14611 * @param obj The toolbar object.
14612 * @param wrap @c EINA_TRUE to enable always-select mode or @c EINA_FALSE to
14615 * This will cause the toolbar to always have an item selected, and clicking
14616 * the selected item will not cause a selected event to be emitted. Enabling this mode
14617 * will immediately select the first toolbar item.
14619 * Always-selected is disabled by default.
14621 * @see elm_toolbar_always_select_mode_get().
14625 EAPI void elm_toolbar_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
14627 * Get whether the toolbar should always have an item selected.
14629 * @param obj The toolbar object.
14630 * @return @c EINA_TRUE means an item will always be selected, @c EINA_FALSE indicates
14631 * that it is possible to have no items selected. If @p obj is @c NULL, @c EINA_FALSE is returned.
14633 * @see elm_toolbar_always_select_mode_set() for details.
14637 EAPI Eina_Bool elm_toolbar_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14639 * Set whether the toolbar items' should be selected by the user or not.
14641 * @param obj The toolbar object.
14642 * @param wrap @c EINA_TRUE to disable selection or @c EINA_FALSE to
14645 * This will turn off the ability to select items entirely and they will
14646 * neither appear selected nor emit selected signals. The clicked
14647 * callback function will still be called.
14649 * Selection is enabled by default.
14651 * @see elm_toolbar_no_select_mode_get().
14655 EAPI void elm_toolbar_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
14658 * Set whether the toolbar items' should be selected by the user or not.
14660 * @param obj The toolbar object.
14661 * @return @c EINA_TRUE means items can be selected. @c EINA_FALSE indicates
14662 * they can't. If @p obj is @c NULL, @c EINA_FALSE is returned.
14664 * @see elm_toolbar_no_select_mode_set() for details.
14668 EAPI Eina_Bool elm_toolbar_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14670 * Append item to the toolbar.
14672 * @param obj The toolbar object.
14673 * @param icon A string with icon name or the absolute path of an image file.
14674 * @param label The label of the item.
14675 * @param func The function to call when the item is clicked.
14676 * @param data The data to associate with the item for related callbacks.
14677 * @return The created item or @c NULL upon failure.
14679 * A new item will be created and appended to the toolbar, i.e., will
14680 * be set as @b last item.
14682 * Items created with this method can be deleted with
14683 * elm_toolbar_item_del().
14685 * Associated @p data can be properly freed when item is deleted if a
14686 * callback function is set with elm_toolbar_item_del_cb_set().
14688 * If a function is passed as argument, it will be called everytime this item
14689 * is selected, i.e., the user clicks over an unselected item.
14690 * If such function isn't needed, just passing
14691 * @c NULL as @p func is enough. The same should be done for @p data.
14693 * Toolbar will load icon image from fdo or current theme.
14694 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
14695 * If an absolute path is provided it will load it direct from a file.
14697 * @see elm_toolbar_item_icon_set()
14698 * @see elm_toolbar_item_del()
14699 * @see elm_toolbar_item_del_cb_set()
14703 EAPI Elm_Object_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);
14705 * Prepend item to the toolbar.
14707 * @param obj The toolbar object.
14708 * @param icon A string with icon name or the absolute path of an image file.
14709 * @param label The label of the item.
14710 * @param func The function to call when the item is clicked.
14711 * @param data The data to associate with the item for related callbacks.
14712 * @return The created item or @c NULL upon failure.
14714 * A new item will be created and prepended to the toolbar, i.e., will
14715 * be set as @b first item.
14717 * Items created with this method can be deleted with
14718 * elm_toolbar_item_del().
14720 * Associated @p data can be properly freed when item is deleted if a
14721 * callback function is set with elm_toolbar_item_del_cb_set().
14723 * If a function is passed as argument, it will be called everytime this item
14724 * is selected, i.e., the user clicks over an unselected item.
14725 * If such function isn't needed, just passing
14726 * @c NULL as @p func is enough. The same should be done for @p data.
14728 * Toolbar will load icon image from fdo or current theme.
14729 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
14730 * If an absolute path is provided it will load it direct from a file.
14732 * @see elm_toolbar_item_icon_set()
14733 * @see elm_toolbar_item_del()
14734 * @see elm_toolbar_item_del_cb_set()
14738 EAPI Elm_Object_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);
14740 * Insert a new item into the toolbar object before item @p before.
14742 * @param obj The toolbar object.
14743 * @param before The toolbar item to insert before.
14744 * @param icon A string with icon name or the absolute path of an image file.
14745 * @param label The label of the item.
14746 * @param func The function to call when the item is clicked.
14747 * @param data The data to associate with the item for related callbacks.
14748 * @return The created item or @c NULL upon failure.
14750 * A new item will be created and added to the toolbar. Its position in
14751 * this toolbar will be just before item @p before.
14753 * Items created with this method can be deleted with
14754 * elm_toolbar_item_del().
14756 * Associated @p data can be properly freed when item is deleted if a
14757 * callback function is set with elm_toolbar_item_del_cb_set().
14759 * If a function is passed as argument, it will be called everytime this item
14760 * is selected, i.e., the user clicks over an unselected item.
14761 * If such function isn't needed, just passing
14762 * @c NULL as @p func is enough. The same should be done for @p data.
14764 * Toolbar will load icon image from fdo or current theme.
14765 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
14766 * If an absolute path is provided it will load it direct from a file.
14768 * @see elm_toolbar_item_icon_set()
14769 * @see elm_toolbar_item_del()
14770 * @see elm_toolbar_item_del_cb_set()
14774 EAPI Elm_Object_Item *elm_toolbar_item_insert_before(Evas_Object *obj, Elm_Object_Item *before, const char *icon, const char *label, Evas_Smart_Cb func, const void *data) EINA_ARG_NONNULL(1);
14777 * Insert a new item into the toolbar object after item @p after.
14779 * @param obj The toolbar object.
14780 * @param after The toolbar item to insert after.
14781 * @param icon A string with icon name or the absolute path of an image file.
14782 * @param label The label of the item.
14783 * @param func The function to call when the item is clicked.
14784 * @param data The data to associate with the item for related callbacks.
14785 * @return The created item or @c NULL upon failure.
14787 * A new item will be created and added to the toolbar. Its position in
14788 * this toolbar will be just after item @p after.
14790 * Items created with this method can be deleted with
14791 * elm_toolbar_item_del().
14793 * Associated @p data can be properly freed when item is deleted if a
14794 * callback function is set with elm_toolbar_item_del_cb_set().
14796 * If a function is passed as argument, it will be called everytime this item
14797 * is selected, i.e., the user clicks over an unselected item.
14798 * If such function isn't needed, just passing
14799 * @c NULL as @p func is enough. The same should be done for @p data.
14801 * Toolbar will load icon image from fdo or current theme.
14802 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
14803 * If an absolute path is provided it will load it direct from a file.
14805 * @see elm_toolbar_item_icon_set()
14806 * @see elm_toolbar_item_del()
14807 * @see elm_toolbar_item_del_cb_set()
14811 EAPI Elm_Object_Item *elm_toolbar_item_insert_after(Evas_Object *obj, Elm_Object_Item *after, const char *icon, const char *label, Evas_Smart_Cb func, const void *data) EINA_ARG_NONNULL(1);
14813 * Get the first item in the given toolbar widget's list of
14816 * @param obj The toolbar object
14817 * @return The first item or @c NULL, if it has no items (and on
14820 * @see elm_toolbar_item_append()
14821 * @see elm_toolbar_last_item_get()
14825 EAPI Elm_Object_Item *elm_toolbar_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14827 * Get the last item in the given toolbar widget's list of
14830 * @param obj The toolbar object
14831 * @return The last item or @c NULL, if it has no items (and on
14834 * @see elm_toolbar_item_prepend()
14835 * @see elm_toolbar_first_item_get()
14839 EAPI Elm_Object_Item *elm_toolbar_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14841 * Get the item after @p item in toolbar.
14843 * @param it The toolbar item.
14844 * @return The item after @p item, or @c NULL if none or on failure.
14846 * @note If it is the last item, @c NULL will be returned.
14848 * @see elm_toolbar_item_append()
14852 EAPI Elm_Object_Item *elm_toolbar_item_next_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
14854 * Get the item before @p item in toolbar.
14856 * @param item The toolbar item.
14857 * @return The item before @p item, or @c NULL if none or on failure.
14859 * @note If it is the first item, @c NULL will be returned.
14861 * @see elm_toolbar_item_prepend()
14865 EAPI Elm_Object_Item *elm_toolbar_item_prev_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
14867 * Get the toolbar object from an item.
14869 * @param it The item.
14870 * @return The toolbar object.
14872 * This returns the toolbar object itself that an item belongs to.
14876 EAPI Evas_Object *elm_toolbar_item_toolbar_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
14878 * Set the priority of a toolbar item.
14880 * @param it The toolbar item.
14881 * @param priority The item priority. The default is zero.
14883 * This is used only when the toolbar shrink mode is set to
14884 * #ELM_TOOLBAR_SHRINK_MENU or #ELM_TOOLBAR_SHRINK_HIDE.
14885 * When space is less than required, items with low priority
14886 * will be removed from the toolbar and added to a dynamically-created menu,
14887 * while items with higher priority will remain on the toolbar,
14888 * with the same order they were added.
14890 * @see elm_toolbar_item_priority_get()
14894 EAPI void elm_toolbar_item_priority_set(Elm_Object_Item *it, int priority) EINA_ARG_NONNULL(1);
14896 * Get the priority of a toolbar item.
14898 * @param it The toolbar item.
14899 * @return The @p item priority, or @c 0 on failure.
14901 * @see elm_toolbar_item_priority_set() for details.
14905 EAPI int elm_toolbar_item_priority_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
14907 * Get the label of item.
14909 * @param it The item of toolbar.
14910 * @return The label of item.
14912 * The return value is a pointer to the label associated to @p item when
14913 * it was created, with function elm_toolbar_item_append() or similar,
14915 * with function elm_toolbar_item_label_set. If no label
14916 * was passed as argument, it will return @c NULL.
14918 * @see elm_toolbar_item_label_set() for more details.
14919 * @see elm_toolbar_item_append()
14923 EAPI const char *elm_toolbar_item_label_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
14925 * Set the label of item.
14927 * @param it The item of toolbar.
14928 * @param text The label of item.
14930 * The label to be displayed by the item.
14931 * Label will be placed at icons bottom (if set).
14933 * If a label was passed as argument on item creation, with function
14934 * elm_toolbar_item_append() or similar, it will be already
14935 * displayed by the item.
14937 * @see elm_toolbar_item_label_get()
14938 * @see elm_toolbar_item_append()
14942 EAPI void elm_toolbar_item_label_set(Elm_Object_Item *it, const char *label) EINA_ARG_NONNULL(1);
14944 * Return the data associated with a given toolbar widget item.
14946 * @param it The toolbar widget item handle.
14947 * @return The data associated with @p item.
14949 * @see elm_toolbar_item_data_set()
14953 EAPI void *elm_toolbar_item_data_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
14955 * Set the data associated with a given toolbar widget item.
14957 * @param it The toolbar widget item handle
14958 * @param data The new data pointer to set to @p item.
14960 * This sets new item data on @p item.
14962 * @warning The old data pointer won't be touched by this function, so
14963 * the user had better to free that old data himself/herself.
14967 EAPI void elm_toolbar_item_data_set(Elm_Object_Item *it, const void *data) EINA_ARG_NONNULL(1);
14969 * Returns a pointer to a toolbar item by its label.
14971 * @param obj The toolbar object.
14972 * @param label The label of the item to find.
14974 * @return The pointer to the toolbar item matching @p label or @c NULL
14979 EAPI Elm_Object_Item *elm_toolbar_item_find_by_label(const Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
14981 * Get whether the @p item is selected or not.
14983 * @param it The toolbar item.
14984 * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
14985 * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
14987 * @see elm_toolbar_selected_item_set() for details.
14988 * @see elm_toolbar_item_selected_get()
14992 EAPI Eina_Bool elm_toolbar_item_selected_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
14994 * Set the selected state of an item.
14996 * @param it The toolbar item
14997 * @param selected The selected state
14999 * This sets the selected state of the given item @p it.
15000 * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
15002 * If a new item is selected the previosly selected will be unselected.
15003 * Previoulsy selected item can be get with function
15004 * elm_toolbar_selected_item_get().
15006 * Selected items will be highlighted.
15008 * @see elm_toolbar_item_selected_get()
15009 * @see elm_toolbar_selected_item_get()
15013 EAPI void elm_toolbar_item_selected_set(Elm_Object_Item *it, Eina_Bool selected) EINA_ARG_NONNULL(1);
15015 * Get the selected item.
15017 * @param obj The toolbar object.
15018 * @return The selected toolbar item.
15020 * The selected item can be unselected with function
15021 * elm_toolbar_item_selected_set().
15023 * The selected item always will be highlighted on toolbar.
15025 * @see elm_toolbar_selected_items_get()
15029 EAPI Elm_Object_Item *elm_toolbar_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15031 * Set the icon associated with @p item.
15033 * @param obj The parent of this item.
15034 * @param it The toolbar item.
15035 * @param icon A string with icon name or the absolute path of an image file.
15037 * Toolbar will load icon image from fdo or current theme.
15038 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
15039 * If an absolute path is provided it will load it direct from a file.
15041 * @see elm_toolbar_icon_order_lookup_set()
15042 * @see elm_toolbar_icon_order_lookup_get()
15046 EAPI void elm_toolbar_item_icon_set(Elm_Object_Item *it, const char *icon) EINA_ARG_NONNULL(1);
15048 * Get the string used to set the icon of @p item.
15050 * @param it The toolbar item.
15051 * @return The string associated with the icon object.
15053 * @see elm_toolbar_item_icon_set() for details.
15057 EAPI const char *elm_toolbar_item_icon_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
15059 * Get the object of @p item.
15061 * @param it The toolbar item.
15062 * @return The object
15066 EAPI Evas_Object *elm_toolbar_item_object_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
15068 * Get the icon object of @p item.
15070 * @param it The toolbar item.
15071 * @return The icon object
15073 * @see elm_toolbar_item_icon_set() or elm_toolbar_item_icon_memfile_set() for details.
15077 EAPI Evas_Object *elm_toolbar_item_icon_object_get(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
15079 * Set the icon associated with @p item to an image in a binary buffer.
15081 * @param it The toolbar item.
15082 * @param img The binary data that will be used as an image
15083 * @param size The size of binary data @p img
15084 * @param format Optional format of @p img to pass to the image loader
15085 * @param key Optional key of @p img to pass to the image loader (eg. if @p img is an edje file)
15087 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
15089 * @note The icon image set by this function can be changed by
15090 * elm_toolbar_item_icon_set().
15094 EAPI Eina_Bool elm_toolbar_item_icon_memfile_set(Elm_Object_Item *it, const void *img, size_t size, const char *format, const char *key) EINA_ARG_NONNULL(1);
15096 * Delete them item from the toolbar.
15098 * @param it The item of toolbar to be deleted.
15100 * @see elm_toolbar_item_append()
15101 * @see elm_toolbar_item_del_cb_set()
15105 EAPI void elm_toolbar_item_del(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
15108 * Set the function called when a toolbar item is freed.
15110 * @param it The item to set the callback on.
15111 * @param func The function called.
15113 * If there is a @p func, then it will be called prior item's memory release.
15114 * That will be called with the following arguments:
15116 * @li item's Evas object;
15119 * This way, a data associated to a toolbar item could be properly freed.
15123 EAPI void elm_toolbar_item_del_cb_set(Elm_Object_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
15126 * Get a value whether toolbar item is disabled or not.
15128 * @param it The item.
15129 * @return The disabled state.
15131 * @see elm_toolbar_item_disabled_set() for more details.
15135 EAPI Eina_Bool elm_toolbar_item_disabled_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
15138 * Sets the disabled/enabled state of a toolbar item.
15140 * @param it The item.
15141 * @param disabled The disabled state.
15143 * A disabled item cannot be selected or unselected. It will also
15144 * change its appearance (generally greyed out). This sets the
15145 * disabled state (@c EINA_TRUE for disabled, @c EINA_FALSE for
15150 EAPI void elm_toolbar_item_disabled_set(Elm_Object_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1);
15153 * Set or unset item as a separator.
15155 * @param it The toolbar item.
15156 * @param setting @c EINA_TRUE to set item @p item as separator or
15157 * @c EINA_FALSE to unset, i.e., item will be used as a regular item.
15159 * Items aren't set as separator by default.
15161 * If set as separator it will display separator theme, so won't display
15164 * @see elm_toolbar_item_separator_get()
15168 EAPI void elm_toolbar_item_separator_set(Elm_Object_Item *it, Eina_Bool separator) EINA_ARG_NONNULL(1);
15171 * Get a value whether item is a separator or not.
15173 * @param it The toolbar item.
15174 * @return @c EINA_TRUE means item @p it is a separator. @c EINA_FALSE
15175 * indicates it's not. If @p it is @c NULL, @c EINA_FALSE is returned.
15177 * @see elm_toolbar_item_separator_set() for details.
15181 EAPI Eina_Bool elm_toolbar_item_separator_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
15184 * Set the shrink state of toolbar @p obj.
15186 * @param obj The toolbar object.
15187 * @param shrink_mode Toolbar's items display behavior.
15189 * The toolbar won't scroll if #ELM_TOOLBAR_SHRINK_NONE,
15190 * but will enforce a minimun size so all the items will fit, won't scroll
15191 * and won't show the items that don't fit if #ELM_TOOLBAR_SHRINK_HIDE,
15192 * will scroll if #ELM_TOOLBAR_SHRINK_SCROLL, and will create a button to
15193 * pop up excess elements with #ELM_TOOLBAR_SHRINK_MENU.
15197 EAPI void elm_toolbar_mode_shrink_set(Evas_Object *obj, Elm_Toolbar_Shrink_Mode shrink_mode) EINA_ARG_NONNULL(1);
15200 * Get the shrink mode of toolbar @p obj.
15202 * @param obj The toolbar object.
15203 * @return Toolbar's items display behavior.
15205 * @see elm_toolbar_mode_shrink_set() for details.
15209 EAPI Elm_Toolbar_Shrink_Mode elm_toolbar_mode_shrink_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15212 * Enable/disable homogeneous mode.
15214 * @param obj The toolbar object
15215 * @param homogeneous Assume the items within the toolbar are of the
15216 * same size (EINA_TRUE = on, EINA_FALSE = off). Default is @c EINA_FALSE.
15218 * This will enable the homogeneous mode where items are of the same size.
15219 * @see elm_toolbar_homogeneous_get()
15223 EAPI void elm_toolbar_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
15226 * Get whether the homogeneous mode is enabled.
15228 * @param obj The toolbar object.
15229 * @return Assume the items within the toolbar are of the same height
15230 * and width (EINA_TRUE = on, EINA_FALSE = off).
15232 * @see elm_toolbar_homogeneous_set()
15236 EAPI Eina_Bool elm_toolbar_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15238 * Set the parent object of the toolbar items' menus.
15240 * @param obj The toolbar object.
15241 * @param parent The parent of the menu objects.
15243 * Each item can be set as item menu, with elm_toolbar_item_menu_set().
15245 * For more details about setting the parent for toolbar menus, see
15246 * elm_menu_parent_set().
15248 * @see elm_menu_parent_set() for details.
15249 * @see elm_toolbar_item_menu_set() for details.
15253 EAPI void elm_toolbar_menu_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
15255 * Get the parent object of the toolbar items' menus.
15257 * @param obj The toolbar object.
15258 * @return The parent of the menu objects.
15260 * @see elm_toolbar_menu_parent_set() for details.
15264 EAPI Evas_Object *elm_toolbar_menu_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15266 * Set the alignment of the items.
15268 * @param obj The toolbar object.
15269 * @param align The new alignment, a float between <tt> 0.0 </tt>
15270 * and <tt> 1.0 </tt>.
15272 * Alignment of toolbar items, from <tt> 0.0 </tt> to indicates to align
15273 * left, to <tt> 1.0 </tt>, to align to right. <tt> 0.5 </tt> centralize
15276 * Centered items by default.
15278 * @see elm_toolbar_align_get()
15282 EAPI void elm_toolbar_align_set(Evas_Object *obj, double align) EINA_ARG_NONNULL(1);
15284 * Get the alignment of the items.
15286 * @param obj The toolbar object.
15287 * @return toolbar items alignment, a float between <tt> 0.0 </tt> and
15290 * @see elm_toolbar_align_set() for details.
15294 EAPI double elm_toolbar_align_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15296 * Set whether the toolbar item opens a menu.
15298 * @param it The toolbar item.
15299 * @param menu If @c EINA_TRUE, @p item will opens a menu when selected.
15301 * A toolbar item can be set to be a menu, using this function.
15303 * Once it is set to be a menu, it can be manipulated through the
15304 * menu-like function elm_toolbar_menu_parent_set() and the other
15305 * elm_menu functions, using the Evas_Object @c menu returned by
15306 * elm_toolbar_item_menu_get().
15308 * So, items to be displayed in this item's menu should be added with
15309 * elm_menu_item_add().
15311 * The following code exemplifies the most basic usage:
15313 * tb = elm_toolbar_add(win)
15314 * item = elm_toolbar_item_append(tb, "refresh", "Menu", NULL, NULL);
15315 * elm_toolbar_item_menu_set(item, EINA_TRUE);
15316 * elm_toolbar_menu_parent_set(tb, win);
15317 * menu = elm_toolbar_item_menu_get(item);
15318 * elm_menu_item_add(menu, NULL, "edit-cut", "Cut", NULL, NULL);
15319 * menu_item = elm_menu_item_add(menu, NULL, "edit-copy", "Copy", NULL,
15323 * @see elm_toolbar_item_menu_get()
15327 EAPI void elm_toolbar_item_menu_set(Elm_Object_Item *it, Eina_Bool menu) EINA_ARG_NONNULL(1);
15329 * Get toolbar item's menu.
15331 * @param it The toolbar item.
15332 * @return Item's menu object or @c NULL on failure.
15334 * If @p item wasn't set as menu item with elm_toolbar_item_menu_set(),
15335 * this function will set it.
15337 * @see elm_toolbar_item_menu_set() for details.
15341 EAPI Evas_Object *elm_toolbar_item_menu_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
15343 * Add a new state to @p item.
15345 * @param it The toolbar item.
15346 * @param icon A string with icon name or the absolute path of an image file.
15347 * @param label The label of the new state.
15348 * @param func The function to call when the item is clicked when this
15349 * state is selected.
15350 * @param data The data to associate with the state.
15351 * @return The toolbar item state, or @c NULL upon failure.
15353 * Toolbar will load icon image from fdo or current theme.
15354 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
15355 * If an absolute path is provided it will load it direct from a file.
15357 * States created with this function can be removed with
15358 * elm_toolbar_item_state_del().
15360 * @see elm_toolbar_item_state_del()
15361 * @see elm_toolbar_item_state_sel()
15362 * @see elm_toolbar_item_state_get()
15366 EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_add(Elm_Object_Item *it, const char *icon, const char *label, Evas_Smart_Cb func, const void *data) EINA_ARG_NONNULL(1);
15368 * Delete a previoulsy added state to @p item.
15370 * @param it The toolbar item.
15371 * @param state The state to be deleted.
15372 * @return @c EINA_TRUE on success or @c EINA_FALSE on failure.
15374 * @see elm_toolbar_item_state_add()
15376 EAPI Eina_Bool elm_toolbar_item_state_del(Elm_Object_Item *it, Elm_Toolbar_Item_State *state) EINA_ARG_NONNULL(1);
15378 * Set @p state as the current state of @p it.
15380 * @param it The toolbar item.
15381 * @param state The state to use.
15382 * @return @c EINA_TRUE on success or @c EINA_FALSE on failure.
15384 * If @p state is @c NULL, it won't select any state and the default item's
15385 * icon and label will be used. It's the same behaviour than
15386 * elm_toolbar_item_state_unser().
15388 * @see elm_toolbar_item_state_unset()
15392 EAPI Eina_Bool elm_toolbar_item_state_set(Elm_Object_Item *it, Elm_Toolbar_Item_State *state) EINA_ARG_NONNULL(1);
15394 * Unset the state of @p it.
15396 * @param it The toolbar item.
15398 * The default icon and label from this item will be displayed.
15400 * @see elm_toolbar_item_state_set() for more details.
15404 EAPI void elm_toolbar_item_state_unset(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
15406 * Get the current state of @p it.
15408 * @param it The toolbar item.
15409 * @return The selected state or @c NULL if none is selected or on failure.
15411 * @see elm_toolbar_item_state_set() for details.
15412 * @see elm_toolbar_item_state_unset()
15413 * @see elm_toolbar_item_state_add()
15417 EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
15419 * Get the state after selected state in toolbar's @p item.
15421 * @param it The toolbar item to change state.
15422 * @return The state after current state, or @c NULL on failure.
15424 * If last state is selected, this function will return first state.
15426 * @see elm_toolbar_item_state_set()
15427 * @see elm_toolbar_item_state_add()
15431 EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_next(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
15433 * Get the state before selected state in toolbar's @p item.
15435 * @param it The toolbar item to change state.
15436 * @return The state before current state, or @c NULL on failure.
15438 * If first state is selected, this function will return last state.
15440 * @see elm_toolbar_item_state_set()
15441 * @see elm_toolbar_item_state_add()
15445 EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_prev(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
15447 * Set the text to be shown in a given toolbar item's tooltips.
15449 * @param it toolbar item.
15450 * @param text The text to set in the content.
15452 * Setup the text as tooltip to object. The item can have only one tooltip,
15453 * so any previous tooltip data - set with this function or
15454 * elm_toolbar_item_tooltip_content_cb_set() - is removed.
15456 * @see elm_object_tooltip_text_set() for more details.
15460 EAPI void elm_toolbar_item_tooltip_text_set(Elm_Object_Item *it, const char *text) EINA_ARG_NONNULL(1);
15462 * Set the content to be shown in the tooltip item.
15464 * Setup the tooltip to item. The item can have only one tooltip,
15465 * so any previous tooltip data is removed. @p func(with @p data) will
15466 * be called every time that need show the tooltip and it should
15467 * return a valid Evas_Object. This object is then managed fully by
15468 * tooltip system and is deleted when the tooltip is gone.
15470 * @param it the toolbar item being attached a tooltip.
15471 * @param func the function used to create the tooltip contents.
15472 * @param data what to provide to @a func as callback data/context.
15473 * @param del_cb called when data is not needed anymore, either when
15474 * another callback replaces @a func, the tooltip is unset with
15475 * elm_toolbar_item_tooltip_unset() or the owner @a item
15476 * dies. This callback receives as the first parameter the
15477 * given @a data, and @c event_info is the item.
15479 * @see elm_object_tooltip_content_cb_set() for more details.
15483 EAPI void elm_toolbar_item_tooltip_content_cb_set(Elm_Object_Item *it, Elm_Tooltip_Item_Content_Cb func, const void *data, Evas_Smart_Cb del_cb) EINA_ARG_NONNULL(1);
15485 * Unset tooltip from item.
15487 * @param it toolbar item to remove previously set tooltip.
15489 * Remove tooltip from item. The callback provided as del_cb to
15490 * elm_toolbar_item_tooltip_content_cb_set() will be called to notify
15491 * it is not used anymore.
15493 * @see elm_object_tooltip_unset() for more details.
15494 * @see elm_toolbar_item_tooltip_content_cb_set()
15498 EAPI void elm_toolbar_item_tooltip_unset(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
15500 * Sets a different style for this item tooltip.
15502 * @note before you set a style you should define a tooltip with
15503 * elm_toolbar_item_tooltip_content_cb_set() or
15504 * elm_toolbar_item_tooltip_text_set()
15506 * @param it toolbar item with tooltip already set.
15507 * @param style the theme style to use (default, transparent, ...)
15509 * @see elm_object_tooltip_style_set() for more details.
15513 EAPI void elm_toolbar_item_tooltip_style_set(Elm_Object_Item *it, const char *style) EINA_ARG_NONNULL(1);
15515 * Get the style for this item tooltip.
15517 * @param it toolbar item with tooltip already set.
15518 * @return style the theme style in use, defaults to "default". If the
15519 * object does not have a tooltip set, then NULL is returned.
15521 * @see elm_object_tooltip_style_get() for more details.
15522 * @see elm_toolbar_item_tooltip_style_set()
15526 EAPI const char *elm_toolbar_item_tooltip_style_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
15528 * Set the type of mouse pointer/cursor decoration to be shown,
15529 * when the mouse pointer is over the given toolbar widget item
15531 * @param it toolbar item to customize cursor on
15532 * @param cursor the cursor type's name
15534 * This function works analogously as elm_object_cursor_set(), but
15535 * here the cursor's changing area is restricted to the item's
15536 * area, and not the whole widget's. Note that that item cursors
15537 * have precedence over widget cursors, so that a mouse over an
15538 * item with custom cursor set will always show @b that cursor.
15540 * If this function is called twice for an object, a previously set
15541 * cursor will be unset on the second call.
15543 * @see elm_object_cursor_set()
15544 * @see elm_toolbar_item_cursor_get()
15545 * @see elm_toolbar_item_cursor_unset()
15549 EAPI void elm_toolbar_item_cursor_set(Elm_Object_Item *it, const char *cursor) EINA_ARG_NONNULL(1);
15552 * Get the type of mouse pointer/cursor decoration set to be shown,
15553 * when the mouse pointer is over the given toolbar widget item
15555 * @param it toolbar item with custom cursor set
15556 * @return the cursor type's name or @c NULL, if no custom cursors
15557 * were set to @p item (and on errors)
15559 * @see elm_object_cursor_get()
15560 * @see elm_toolbar_item_cursor_set()
15561 * @see elm_toolbar_item_cursor_unset()
15565 EAPI const char *elm_toolbar_item_cursor_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
15568 * Unset any custom mouse pointer/cursor decoration set to be
15569 * shown, when the mouse pointer is over the given toolbar widget
15570 * item, thus making it show the @b default cursor again.
15572 * @param it a toolbar item
15574 * Use this call to undo any custom settings on this item's cursor
15575 * decoration, bringing it back to defaults (no custom style set).
15577 * @see elm_object_cursor_unset()
15578 * @see elm_toolbar_item_cursor_set()
15582 EAPI void elm_toolbar_item_cursor_unset(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
15585 * Set a different @b style for a given custom cursor set for a
15588 * @param it toolbar item with custom cursor set
15589 * @param style the <b>theme style</b> to use (e.g. @c "default",
15590 * @c "transparent", etc)
15592 * This function only makes sense when one is using custom mouse
15593 * cursor decorations <b>defined in a theme file</b>, which can have,
15594 * given a cursor name/type, <b>alternate styles</b> on it. It
15595 * works analogously as elm_object_cursor_style_set(), but here
15596 * applyed only to toolbar item objects.
15598 * @warning Before you set a cursor style you should have definen a
15599 * custom cursor previously on the item, with
15600 * elm_toolbar_item_cursor_set()
15602 * @see elm_toolbar_item_cursor_engine_only_set()
15603 * @see elm_toolbar_item_cursor_style_get()
15607 EAPI void elm_toolbar_item_cursor_style_set(Elm_Object_Item *it, const char *style) EINA_ARG_NONNULL(1);
15610 * Get the current @b style set for a given toolbar item's custom
15613 * @param it toolbar item with custom cursor set.
15614 * @return style the cursor style in use. If the object does not
15615 * have a cursor set, then @c NULL is returned.
15617 * @see elm_toolbar_item_cursor_style_set() for more details
15621 EAPI const char *elm_toolbar_item_cursor_style_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
15624 * Set if the (custom)cursor for a given toolbar item should be
15625 * searched in its theme, also, or should only rely on the
15626 * rendering engine.
15628 * @param it item with custom (custom) cursor already set on
15629 * @param engine_only Use @c EINA_TRUE to have cursors looked for
15630 * only on those provided by the rendering engine, @c EINA_FALSE to
15631 * have them searched on the widget's theme, as well.
15633 * @note This call is of use only if you've set a custom cursor
15634 * for toolbar items, with elm_toolbar_item_cursor_set().
15636 * @note By default, cursors will only be looked for between those
15637 * provided by the rendering engine.
15641 EAPI void elm_toolbar_item_cursor_engine_only_set(Elm_Object_Item *it, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
15644 * Get if the (custom) cursor for a given toolbar item is being
15645 * searched in its theme, also, or is only relying on the rendering
15648 * @param it a toolbar item
15649 * @return @c EINA_TRUE, if cursors are being looked for only on
15650 * those provided by the rendering engine, @c EINA_FALSE if they
15651 * are being searched on the widget's theme, as well.
15653 * @see elm_toolbar_item_cursor_engine_only_set(), for more details
15657 EAPI Eina_Bool elm_toolbar_item_cursor_engine_only_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
15660 * Change a toolbar's orientation
15661 * @param obj The toolbar object
15662 * @param vertical If @c EINA_TRUE, the toolbar is vertical
15663 * By default, a toolbar will be horizontal. Use this function to create a vertical toolbar.
15665 * @deprecated use elm_toolbar_horizontal_set() instead.
15667 EINA_DEPRECATED EAPI void elm_toolbar_orientation_set(Evas_Object *obj, Eina_Bool vertical) EINA_ARG_NONNULL(1);
15670 * Change a toolbar's orientation
15671 * @param obj The toolbar object
15672 * @param horizontal If @c EINA_TRUE, the toolbar is horizontal
15673 * By default, a toolbar will be horizontal. Use this function to create a vertical toolbar.
15676 EAPI void elm_toolbar_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
15679 * Get a toolbar's orientation
15680 * @param obj The toolbar object
15681 * @return If @c EINA_TRUE, the toolbar is vertical
15682 * By default, a toolbar will be horizontal. Use this function to determine whether a toolbar is vertical.
15684 * @deprecated use elm_toolbar_horizontal_get() instead.
15686 EINA_DEPRECATED EAPI Eina_Bool elm_toolbar_orientation_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15689 * Get a toolbar's orientation
15690 * @param obj The toolbar object
15691 * @return If @c EINA_TRUE, the toolbar is horizontal
15692 * By default, a toolbar will be horizontal. Use this function to determine whether a toolbar is vertical.
15695 EAPI Eina_Bool elm_toolbar_horizontal_get(const Evas_Object *obj);
15701 * @defgroup Tooltips Tooltips
15703 * The Tooltip is an (internal, for now) smart object used to show a
15704 * content in a frame on mouse hover of objects(or widgets), with
15705 * tips/information about them.
15710 EAPI double elm_tooltip_delay_get(void);
15711 EAPI Eina_Bool elm_tooltip_delay_set(double delay);
15712 EAPI void elm_object_tooltip_show(Evas_Object *obj) EINA_ARG_NONNULL(1);
15713 EAPI void elm_object_tooltip_hide(Evas_Object *obj) EINA_ARG_NONNULL(1);
15714 EAPI void elm_object_tooltip_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1, 2);
15715 EAPI void elm_object_tooltip_domain_translatable_text_set(Evas_Object *obj, const char *domain, const char *text) EINA_ARG_NONNULL(1, 3);
15716 #define elm_object_tooltip_translatable_text_set(obj, text) elm_object_tooltip_domain_translatable_text_set((obj), NULL, (text))
15717 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);
15718 EAPI void elm_object_tooltip_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
15719 EAPI void elm_object_tooltip_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
15720 EAPI const char *elm_object_tooltip_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15721 EAPI Eina_Bool elm_tooltip_size_restrict_disable(Evas_Object *obj, Eina_Bool disable) EINA_ARG_NONNULL(1);
15722 EAPI Eina_Bool elm_tooltip_size_restrict_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15729 * @defgroup Cursors Cursors
15731 * The Elementary cursor is an internal smart object used to
15732 * customize the mouse cursor displayed over objects (or
15733 * widgets). In the most common scenario, the cursor decoration
15734 * comes from the graphical @b engine Elementary is running
15735 * on. Those engines may provide different decorations for cursors,
15736 * and Elementary provides functions to choose them (think of X11
15737 * cursors, as an example).
15739 * There's also the possibility of, besides using engine provided
15740 * cursors, also use ones coming from Edje theming files. Both
15741 * globally and per widget, Elementary makes it possible for one to
15742 * make the cursors lookup to be held on engines only or on
15743 * Elementary's theme file, too. To set cursor's hot spot,
15744 * two data items should be added to cursor's theme: "hot_x" and
15745 * "hot_y", that are the offset from upper-left corner of the cursor
15746 * (coordinates 0,0).
15752 * Set the cursor to be shown when mouse is over the object
15754 * Set the cursor that will be displayed when mouse is over the
15755 * object. The object can have only one cursor set to it, so if
15756 * this function is called twice for an object, the previous set
15758 * If using X cursors, a definition of all the valid cursor names
15759 * is listed on Elementary_Cursors.h. If an invalid name is set
15760 * the default cursor will be used.
15762 * @param obj the object being set a cursor.
15763 * @param cursor the cursor name to be used.
15767 EAPI void elm_object_cursor_set(Evas_Object *obj, const char *cursor) EINA_ARG_NONNULL(1);
15770 * Get the cursor to be shown when mouse is over the object
15772 * @param obj an object with cursor already set.
15773 * @return the cursor name.
15777 EAPI const char *elm_object_cursor_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15780 * Unset cursor for object
15782 * Unset cursor for object, and set the cursor to default if the mouse
15783 * was over this object.
15785 * @param obj Target object
15786 * @see elm_object_cursor_set()
15790 EAPI void elm_object_cursor_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
15793 * Sets a different style for this object cursor.
15795 * @note before you set a style you should define a cursor with
15796 * elm_object_cursor_set()
15798 * @param obj an object with cursor already set.
15799 * @param style the theme style to use (default, transparent, ...)
15803 EAPI void elm_object_cursor_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
15806 * Get the style for this object cursor.
15808 * @param obj an object with cursor already set.
15809 * @return style the theme style in use, defaults to "default". If the
15810 * object does not have a cursor set, then NULL is returned.
15814 EAPI const char *elm_object_cursor_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15817 * Set if the cursor set should be searched on the theme or should use
15818 * the provided by the engine, only.
15820 * @note before you set if should look on theme you should define a cursor
15821 * with elm_object_cursor_set(). By default it will only look for cursors
15822 * provided by the engine.
15824 * @param obj an object with cursor already set.
15825 * @param engine_only boolean to define it cursors should be looked only
15826 * between the provided by the engine or searched on widget's theme as well.
15830 EAPI void elm_object_cursor_engine_only_set(Evas_Object *obj, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
15833 * Get the cursor engine only usage for this object cursor.
15835 * @param obj an object with cursor already set.
15836 * @return engine_only boolean to define it cursors should be
15837 * looked only between the provided by the engine or searched on
15838 * widget's theme as well. If the object does not have a cursor
15839 * set, then EINA_FALSE is returned.
15843 EAPI Eina_Bool elm_object_cursor_engine_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15846 * Get the configured cursor engine only usage
15848 * This gets the globally configured exclusive usage of engine cursors.
15850 * @return 1 if only engine cursors should be used
15853 EAPI int elm_cursor_engine_only_get(void);
15856 * Set the configured cursor engine only usage
15858 * This sets the globally configured exclusive usage of engine cursors.
15859 * It won't affect cursors set before changing this value.
15861 * @param engine_only If 1 only engine cursors will be enabled, if 0 will
15862 * look for them on theme before.
15863 * @return EINA_TRUE if value is valid and setted (0 or 1)
15866 EAPI Eina_Bool elm_cursor_engine_only_set(int engine_only);
15873 * @defgroup Menu Menu
15875 * @image html img/widget/menu/preview-00.png
15876 * @image latex img/widget/menu/preview-00.eps
15878 * A menu is a list of items displayed above its parent. When the menu is
15879 * showing its parent is darkened. Each item can have a sub-menu. The menu
15880 * object can be used to display a menu on a right click event, in a toolbar,
15883 * Signals that you can add callbacks for are:
15884 * @li "clicked" - the user clicked the empty space in the menu to dismiss.
15886 * Default contents parts of the menu items that you can use for are:
15887 * @li "default" - A main content of the menu item
15889 * Default text parts of the menu items that you can use for are:
15890 * @li "default" - label in the menu item
15892 * @see @ref tutorial_menu
15897 * @brief Add a new menu to the parent
15899 * @param parent The parent object.
15900 * @return The new object or NULL if it cannot be created.
15902 EAPI Evas_Object *elm_menu_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
15904 * @brief Set the parent for the given menu widget
15906 * @param obj The menu object.
15907 * @param parent The new parent.
15909 EAPI void elm_menu_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
15911 * @brief Get the parent for the given menu widget
15913 * @param obj The menu object.
15914 * @return The parent.
15916 * @see elm_menu_parent_set()
15918 EAPI Evas_Object *elm_menu_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15920 * @brief Move the menu to a new position
15922 * @param obj The menu object.
15923 * @param x The new position.
15924 * @param y The new position.
15926 * Sets the top-left position of the menu to (@p x,@p y).
15928 * @note @p x and @p y coordinates are relative to parent.
15930 EAPI void elm_menu_move(Evas_Object *obj, Evas_Coord x, Evas_Coord y) EINA_ARG_NONNULL(1);
15932 * @brief Close a opened menu
15934 * @param obj the menu object
15937 * Hides the menu and all it's sub-menus.
15939 EAPI void elm_menu_close(Evas_Object *obj) EINA_ARG_NONNULL(1);
15941 * @brief Returns a list of @p item's items.
15943 * @param obj The menu object
15944 * @return An Eina_List* of @p item's items
15946 EAPI const Eina_List *elm_menu_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15948 * @brief Get the Evas_Object of an Elm_Object_Item
15950 * @param it The menu item object.
15951 * @return The edje object containing the swallowed content
15953 * @warning Don't manipulate this object!
15956 EAPI Evas_Object *elm_menu_item_object_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
15958 * @brief Add an item at the end of the given menu widget
15960 * @param obj The menu object.
15961 * @param parent The parent menu item (optional)
15962 * @param icon A icon display on the item. The icon will be destryed by the menu.
15963 * @param label The label of the item.
15964 * @param func Function called when the user select the item.
15965 * @param data Data sent by the callback.
15966 * @return Returns the new item.
15968 EAPI Elm_Object_Item *elm_menu_item_add(Evas_Object *obj, Elm_Object_Item *parent, const char *icon, const char *label, Evas_Smart_Cb func, const void *data) EINA_ARG_NONNULL(1);
15970 * @brief Add an object swallowed in an item at the end of the given menu
15973 * @param obj The menu object.
15974 * @param parent The parent menu item (optional)
15975 * @param subobj The object to swallow
15976 * @param func Function called when the user select the item.
15977 * @param data Data sent by the callback.
15978 * @return Returns the new item.
15980 * Add an evas object as an item to the menu.
15982 EAPI Elm_Object_Item *elm_menu_item_add_object(Evas_Object *obj, Elm_Object_Item *parent, Evas_Object *subobj, Evas_Smart_Cb func, const void *data) EINA_ARG_NONNULL(1);
15984 * @brief Set the label of a menu item
15986 * @param it The menu item object.
15987 * @param label The label to set for @p item
15989 * @warning Don't use this funcion on items created with
15990 * elm_menu_item_add_object() or elm_menu_item_separator_add().
15992 * @deprecated Use elm_object_item_text_set() instead
15994 EINA_DEPRECATED EAPI void elm_menu_item_label_set(Elm_Object_Item *it, const char *label) EINA_ARG_NONNULL(1);
15996 * @brief Get the label of a menu item
15998 * @param it The menu item object.
15999 * @return The label of @p item
16000 * @deprecated Use elm_object_item_text_get() instead
16002 EINA_DEPRECATED EAPI const char *elm_menu_item_label_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
16004 * @brief Set the icon of a menu item to the standard icon with name @p icon
16006 * @param it The menu item object.
16007 * @param icon The icon object to set for the content of @p item
16009 * Once this icon is set, any previously set icon will be deleted.
16011 EAPI void elm_menu_item_object_icon_name_set(Elm_Object_Item *it, const char *icon) EINA_ARG_NONNULL(1, 2);
16013 * @brief Get the string representation from the icon of a menu item
16015 * @param it The menu item object.
16016 * @return The string representation of @p item's icon or NULL
16018 * @see elm_menu_item_object_icon_name_set()
16020 EAPI const char *elm_menu_item_object_icon_name_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
16022 * @brief Set the content object of a menu item
16024 * @param it The menu item object
16025 * @param The content object or NULL
16026 * @return EINA_TRUE on success, else EINA_FALSE
16028 * Use this function to change the object swallowed by a menu item, deleting
16029 * any previously swallowed object.
16031 * @deprecated Use elm_object_item_content_set() instead
16033 EINA_DEPRECATED EAPI Eina_Bool elm_menu_item_object_content_set(Elm_Object_Item *it, Evas_Object *obj) EINA_ARG_NONNULL(1);
16035 * @brief Get the content object of a menu item
16037 * @param it The menu item object
16038 * @return The content object or NULL
16039 * @note If @p item was added with elm_menu_item_add_object, this
16040 * function will return the object passed, else it will return the
16043 * @see elm_menu_item_object_content_set()
16045 * @deprecated Use elm_object_item_content_get() instead
16047 EINA_DEPRECATED EAPI Evas_Object *elm_menu_item_object_content_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
16049 * @brief Set the selected state of @p item.
16051 * @param it The menu item object.
16052 * @param selected The selected/unselected state of the item
16054 EAPI void elm_menu_item_selected_set(Elm_Object_Item *it, Eina_Bool selected) EINA_ARG_NONNULL(1);
16056 * @brief Get the selected state of @p item.
16058 * @param it The menu item object.
16059 * @return The selected/unselected state of the item
16061 * @see elm_menu_item_selected_set()
16063 EAPI Eina_Bool elm_menu_item_selected_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
16065 * @brief Set the disabled state of @p item.
16067 * @param it The menu item object.
16068 * @param disabled The enabled/disabled state of the item
16069 * @deprecated Use elm_object_item_disabled_set() instead
16071 EINA_DEPRECATED EAPI void elm_menu_item_disabled_set(Elm_Object_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1);
16073 * @brief Get the disabled state of @p item.
16075 * @param it The menu item object.
16076 * @return The enabled/disabled state of the item
16078 * @see elm_menu_item_disabled_set()
16079 * @deprecated Use elm_object_item_disabled_get() instead
16081 EINA_DEPRECATED EAPI Eina_Bool elm_menu_item_disabled_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
16083 * @brief Add a separator item to menu @p obj under @p parent.
16085 * @param obj The menu object
16086 * @param parent The item to add the separator under
16087 * @return The created item or NULL on failure
16089 * This is item is a @ref Separator.
16091 EAPI Elm_Object_Item *elm_menu_item_separator_add(Evas_Object *obj, Elm_Object_Item *parent) EINA_ARG_NONNULL(1);
16093 * @brief Returns whether @p item is a separator.
16095 * @param it The item to check
16096 * @return If true, @p item is a separator
16098 * @see elm_menu_item_separator_add()
16100 EAPI Eina_Bool elm_menu_item_is_separator(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
16102 * @brief Deletes an item from the menu.
16104 * @param it The item to delete.
16106 * @see elm_menu_item_add()
16108 EAPI void elm_menu_item_del(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
16110 * @brief Set the function called when a menu item is deleted.
16112 * @param it The item to set the callback on
16113 * @param func The function called
16115 * @see elm_menu_item_add()
16116 * @see elm_menu_item_del()
16118 EAPI void elm_menu_item_del_cb_set(Elm_Object_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
16120 * @brief Returns the data associated with menu item @p item.
16122 * @param it The item
16123 * @return The data associated with @p item or NULL if none was set.
16125 * This is the data set with elm_menu_add() or elm_menu_item_data_set().
16127 * @deprecated Use elm_object_item_data_get() instead
16129 EINA_DEPRECATED EAPI void *elm_menu_item_data_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
16131 * @brief Sets the data to be associated with menu item @p item.
16133 * @param it The item
16134 * @param data The data to be associated with @p item
16136 * @deprecated Use elm_object_item_data_set() instead
16138 EINA_DEPRECATED EAPI void elm_menu_item_data_set(Elm_Object_Item *it, const void *data) EINA_ARG_NONNULL(1);
16141 * @brief Returns a list of @p item's subitems.
16143 * @param it The item
16144 * @return An Eina_List* of @p item's subitems
16146 * @see elm_menu_add()
16148 EAPI const Eina_List *elm_menu_item_subitems_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
16150 * @brief Get the position of a menu item
16152 * @param it The menu item
16153 * @return The item's index
16155 * This function returns the index position of a menu item in a menu.
16156 * For a sub-menu, this number is relative to the first item in the sub-menu.
16158 * @note Index values begin with 0
16160 EAPI unsigned int elm_menu_item_index_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1) EINA_PURE;
16162 * @brief @brief Return a menu item's owner menu
16164 * @param it The menu item
16165 * @return The menu object owning @p item, or NULL on failure
16167 * Use this function to get the menu object owning an item.
16169 EAPI Evas_Object *elm_menu_item_menu_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1) EINA_PURE;
16171 * @brief Get the selected item in the menu
16173 * @param obj The menu object
16174 * @return The selected item, or NULL if none
16176 * @see elm_menu_item_selected_get()
16177 * @see elm_menu_item_selected_set()
16179 EAPI Elm_Object_Item *elm_menu_selected_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
16181 * @brief Get the last item in the menu
16183 * @param obj The menu object
16184 * @return The last item, or NULL if none
16186 EAPI Elm_Object_Item *elm_menu_last_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
16188 * @brief Get the first item in the menu
16190 * @param obj The menu object
16191 * @return The first item, or NULL if none
16193 EAPI Elm_Object_Item *elm_menu_first_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
16195 * @brief Get the next item in the menu.
16197 * @param it The menu item object.
16198 * @return The item after it, or NULL if none
16200 EAPI Elm_Object_Item *elm_menu_item_next_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
16202 * @brief Get the previous item in the menu.
16204 * @param it The menu item object.
16205 * @return The item before it, or NULL if none
16207 EAPI Elm_Object_Item *elm_menu_item_prev_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
16213 * @defgroup List List
16214 * @ingroup Elementary
16216 * @image html img/widget/list/preview-00.png
16217 * @image latex img/widget/list/preview-00.eps width=\textwidth
16219 * @image html img/list.png
16220 * @image latex img/list.eps width=\textwidth
16222 * A list widget is a container whose children are displayed vertically or
16223 * horizontally, in order, and can be selected.
16224 * The list can accept only one or multiple items selection. Also has many
16225 * modes of items displaying.
16227 * A list is a very simple type of list widget. For more robust
16228 * lists, @ref Genlist should probably be used.
16230 * Smart callbacks one can listen to:
16231 * - @c "activated" - The user has double-clicked or pressed
16232 * (enter|return|spacebar) on an item. The @c event_info parameter
16233 * is the item that was activated.
16234 * - @c "clicked,double" - The user has double-clicked an item.
16235 * The @c event_info parameter is the item that was double-clicked.
16236 * - "selected" - when the user selected an item
16237 * - "unselected" - when the user unselected an item
16238 * - "longpressed" - an item in the list is long-pressed
16239 * - "edge,top" - the list is scrolled until the top edge
16240 * - "edge,bottom" - the list is scrolled until the bottom edge
16241 * - "edge,left" - the list is scrolled until the left edge
16242 * - "edge,right" - the list is scrolled until the right edge
16243 * - "language,changed" - the program's language changed
16245 * Available styles for it:
16248 * List of examples:
16249 * @li @ref list_example_01
16250 * @li @ref list_example_02
16251 * @li @ref list_example_03
16260 * @enum _Elm_List_Mode
16261 * @typedef Elm_List_Mode
16263 * Set list's resize behavior, transverse axis scroll and
16264 * items cropping. See each mode's description for more details.
16266 * @note Default value is #ELM_LIST_SCROLL.
16268 * Values <b> don't </b> work as bitmask, only one can be choosen.
16270 * @see elm_list_mode_set()
16271 * @see elm_list_mode_get()
16275 typedef enum _Elm_List_Mode
16277 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. */
16278 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). */
16279 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. */
16280 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. */
16281 ELM_LIST_LAST /**< Indicates error if returned by elm_list_mode_get() */
16284 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(). */
16287 * Add a new list widget to the given parent Elementary
16288 * (container) object.
16290 * @param parent The parent object.
16291 * @return a new list widget handle or @c NULL, on errors.
16293 * This function inserts a new list widget on the canvas.
16297 EAPI Evas_Object *elm_list_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
16302 * @param obj The list object
16304 * @note Call before running show() on the list object.
16305 * @warning If not called, it won't display the list properly.
16308 * li = elm_list_add(win);
16309 * elm_list_item_append(li, "First", NULL, NULL, NULL, NULL);
16310 * elm_list_item_append(li, "Second", NULL, NULL, NULL, NULL);
16312 * evas_object_show(li);
16317 EAPI void elm_list_go(Evas_Object *obj) EINA_ARG_NONNULL(1);
16320 * Enable or disable multiple items selection on the list object.
16322 * @param obj The list object
16323 * @param multi @c EINA_TRUE to enable multi selection or @c EINA_FALSE to
16326 * Disabled by default. If disabled, the user can select a single item of
16327 * the list each time. Selected items are highlighted on list.
16328 * If enabled, many items can be selected.
16330 * If a selected item is selected again, it will be unselected.
16332 * @see elm_list_multi_select_get()
16336 EAPI void elm_list_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
16339 * Get a value whether multiple items selection is enabled or not.
16341 * @see elm_list_multi_select_set() for details.
16343 * @param obj The list object.
16344 * @return @c EINA_TRUE means multiple items selection is enabled.
16345 * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
16346 * @c EINA_FALSE is returned.
16350 EAPI Eina_Bool elm_list_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16353 * Set which mode to use for the list object.
16355 * @param obj The list object
16356 * @param mode One of #Elm_List_Mode: #ELM_LIST_COMPRESS, #ELM_LIST_SCROLL,
16357 * #ELM_LIST_LIMIT or #ELM_LIST_EXPAND.
16359 * Set list's resize behavior, transverse axis scroll and
16360 * items cropping. See each mode's description for more details.
16362 * @note Default value is #ELM_LIST_SCROLL.
16364 * Only one can be set, if a previous one was set, it will be changed
16365 * by the new mode set. Bitmask won't work as well.
16367 * @see elm_list_mode_get()
16371 EAPI void elm_list_mode_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
16374 * Get the mode the list is at.
16376 * @param obj The list object
16377 * @return One of #Elm_List_Mode: #ELM_LIST_COMPRESS, #ELM_LIST_SCROLL,
16378 * #ELM_LIST_LIMIT, #ELM_LIST_EXPAND or #ELM_LIST_LAST on errors.
16380 * @note see elm_list_mode_set() for more information.
16384 EAPI Elm_List_Mode elm_list_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16387 * Enable or disable horizontal mode on the list object.
16389 * @param obj The list object.
16390 * @param horizontal @c EINA_TRUE to enable horizontal or @c EINA_FALSE to
16391 * disable it, i.e., to enable vertical mode.
16393 * @note Vertical mode is set by default.
16395 * On horizontal mode items are displayed on list from left to right,
16396 * instead of from top to bottom. Also, the list will scroll horizontally.
16397 * Each item will presents left icon on top and right icon, or end, at
16400 * @see elm_list_horizontal_get()
16404 EAPI void elm_list_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
16407 * Get a value whether horizontal mode is enabled or not.
16409 * @param obj The list object.
16410 * @return @c EINA_TRUE means horizontal mode selection is enabled.
16411 * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
16412 * @c EINA_FALSE is returned.
16414 * @see elm_list_horizontal_set() for details.
16418 EAPI Eina_Bool elm_list_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16421 * Enable or disable always select mode on the list object.
16423 * @param obj The list object
16424 * @param always_select @c EINA_TRUE to enable always select mode or
16425 * @c EINA_FALSE to disable it.
16427 * @note Always select mode is disabled by default.
16429 * Default behavior of list items is to only call its callback function
16430 * the first time it's pressed, i.e., when it is selected. If a selected
16431 * item is pressed again, and multi-select is disabled, it won't call
16432 * this function (if multi-select is enabled it will unselect the item).
16434 * If always select is enabled, it will call the callback function
16435 * everytime a item is pressed, so it will call when the item is selected,
16436 * and again when a selected item is pressed.
16438 * @see elm_list_always_select_mode_get()
16439 * @see elm_list_multi_select_set()
16443 EAPI void elm_list_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
16446 * Get a value whether always select mode is enabled or not, meaning that
16447 * an item will always call its callback function, even if already selected.
16449 * @param obj The list object
16450 * @return @c EINA_TRUE means horizontal mode selection is enabled.
16451 * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
16452 * @c EINA_FALSE is returned.
16454 * @see elm_list_always_select_mode_set() for details.
16458 EAPI Eina_Bool elm_list_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16461 * Set bouncing behaviour when the scrolled content reaches an edge.
16463 * Tell the internal scroller object whether it should bounce or not
16464 * when it reaches the respective edges for each axis.
16466 * @param obj The list object
16467 * @param h_bounce Whether to bounce or not in the horizontal axis.
16468 * @param v_bounce Whether to bounce or not in the vertical axis.
16470 * @see elm_scroller_bounce_set()
16474 EAPI void elm_list_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
16477 * Get the bouncing behaviour of the internal scroller.
16479 * Get whether the internal scroller should bounce when the edge of each
16480 * axis is reached scrolling.
16482 * @param obj The list object.
16483 * @param h_bounce Pointer where to store the bounce state of the horizontal
16485 * @param v_bounce Pointer where to store the bounce state of the vertical
16488 * @see elm_scroller_bounce_get()
16489 * @see elm_list_bounce_set()
16493 EAPI void elm_list_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
16496 * Set the scrollbar policy.
16498 * @param obj The list object
16499 * @param policy_h Horizontal scrollbar policy.
16500 * @param policy_v Vertical scrollbar policy.
16502 * This sets the scrollbar visibility policy for the given scroller.
16503 * #ELM_SCROLLER_POLICY_AUTO means the scrollbar is made visible if it
16504 * is needed, and otherwise kept hidden. #ELM_SCROLLER_POLICY_ON turns
16505 * it on all the time, and #ELM_SCROLLER_POLICY_OFF always keeps it off.
16506 * This applies respectively for the horizontal and vertical scrollbars.
16508 * The both are disabled by default, i.e., are set to
16509 * #ELM_SCROLLER_POLICY_OFF.
16513 EAPI void elm_list_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
16516 * Get the scrollbar policy.
16518 * @see elm_list_scroller_policy_get() for details.
16520 * @param obj The list object.
16521 * @param policy_h Pointer where to store horizontal scrollbar policy.
16522 * @param policy_v Pointer where to store vertical scrollbar policy.
16526 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);
16529 * Append a new item to the list object.
16531 * @param obj The list object.
16532 * @param label The label of the list item.
16533 * @param icon The icon object to use for the left side of the item. An
16534 * icon can be any Evas object, but usually it is an icon created
16535 * with elm_icon_add().
16536 * @param end The icon object to use for the right side of the item. An
16537 * icon can be any Evas object.
16538 * @param func The function to call when the item is clicked.
16539 * @param data The data to associate with the item for related callbacks.
16541 * @return The created item or @c NULL upon failure.
16543 * A new item will be created and appended to the list, i.e., will
16544 * be set as @b last item.
16546 * Items created with this method can be deleted with
16547 * elm_list_item_del().
16549 * Associated @p data can be properly freed when item is deleted if a
16550 * callback function is set with elm_list_item_del_cb_set().
16552 * If a function is passed as argument, it will be called everytime this item
16553 * is selected, i.e., the user clicks over an unselected item.
16554 * If always select is enabled it will call this function every time
16555 * user clicks over an item (already selected or not).
16556 * If such function isn't needed, just passing
16557 * @c NULL as @p func is enough. The same should be done for @p data.
16559 * Simple example (with no function callback or data associated):
16561 * li = elm_list_add(win);
16562 * ic = elm_icon_add(win);
16563 * elm_icon_file_set(ic, "path/to/image", NULL);
16564 * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
16565 * elm_list_item_append(li, "label", ic, NULL, NULL, NULL);
16567 * evas_object_show(li);
16570 * @see elm_list_always_select_mode_set()
16571 * @see elm_list_item_del()
16572 * @see elm_list_item_del_cb_set()
16573 * @see elm_list_clear()
16574 * @see elm_icon_add()
16578 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);
16581 * Prepend a new item to the list object.
16583 * @param obj The list object.
16584 * @param label The label of the list item.
16585 * @param icon The icon object to use for the left side of the item. An
16586 * icon can be any Evas object, but usually it is an icon created
16587 * with elm_icon_add().
16588 * @param end The icon object to use for the right side of the item. An
16589 * icon can be any Evas object.
16590 * @param func The function to call when the item is clicked.
16591 * @param data The data to associate with the item for related callbacks.
16593 * @return The created item or @c NULL upon failure.
16595 * A new item will be created and prepended to the list, i.e., will
16596 * be set as @b first item.
16598 * Items created with this method can be deleted with
16599 * elm_list_item_del().
16601 * Associated @p data can be properly freed when item is deleted if a
16602 * callback function is set with elm_list_item_del_cb_set().
16604 * If a function is passed as argument, it will be called everytime this item
16605 * is selected, i.e., the user clicks over an unselected item.
16606 * If always select is enabled it will call this function every time
16607 * user clicks over an item (already selected or not).
16608 * If such function isn't needed, just passing
16609 * @c NULL as @p func is enough. The same should be done for @p data.
16611 * @see elm_list_item_append() for a simple code example.
16612 * @see elm_list_always_select_mode_set()
16613 * @see elm_list_item_del()
16614 * @see elm_list_item_del_cb_set()
16615 * @see elm_list_clear()
16616 * @see elm_icon_add()
16620 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);
16623 * Insert a new item into the list object before item @p before.
16625 * @param obj The list object.
16626 * @param before The list item to insert before.
16627 * @param label The label of the list item.
16628 * @param icon The icon object to use for the left side of the item. An
16629 * icon can be any Evas object, but usually it is an icon created
16630 * with elm_icon_add().
16631 * @param end The icon object to use for the right side of the item. An
16632 * icon can be any Evas object.
16633 * @param func The function to call when the item is clicked.
16634 * @param data The data to associate with the item for related callbacks.
16636 * @return The created item or @c NULL upon failure.
16638 * A new item will be created and added to the list. Its position in
16639 * this list will be just before item @p before.
16641 * Items created with this method can be deleted with
16642 * elm_list_item_del().
16644 * Associated @p data can be properly freed when item is deleted if a
16645 * callback function is set with elm_list_item_del_cb_set().
16647 * If a function is passed as argument, it will be called everytime this item
16648 * is selected, i.e., the user clicks over an unselected item.
16649 * If always select is enabled it will call this function every time
16650 * user clicks over an item (already selected or not).
16651 * If such function isn't needed, just passing
16652 * @c NULL as @p func is enough. The same should be done for @p data.
16654 * @see elm_list_item_append() for a simple code example.
16655 * @see elm_list_always_select_mode_set()
16656 * @see elm_list_item_del()
16657 * @see elm_list_item_del_cb_set()
16658 * @see elm_list_clear()
16659 * @see elm_icon_add()
16663 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);
16666 * Insert a new item into the list object after item @p after.
16668 * @param obj The list object.
16669 * @param after The list item to insert after.
16670 * @param label The label of the list item.
16671 * @param icon The icon object to use for the left side of the item. An
16672 * icon can be any Evas object, but usually it is an icon created
16673 * with elm_icon_add().
16674 * @param end The icon object to use for the right side of the item. An
16675 * icon can be any Evas object.
16676 * @param func The function to call when the item is clicked.
16677 * @param data The data to associate with the item for related callbacks.
16679 * @return The created item or @c NULL upon failure.
16681 * A new item will be created and added to the list. Its position in
16682 * this list will be just after item @p after.
16684 * Items created with this method can be deleted with
16685 * elm_list_item_del().
16687 * Associated @p data can be properly freed when item is deleted if a
16688 * callback function is set with elm_list_item_del_cb_set().
16690 * If a function is passed as argument, it will be called everytime this item
16691 * is selected, i.e., the user clicks over an unselected item.
16692 * If always select is enabled it will call this function every time
16693 * user clicks over an item (already selected or not).
16694 * If such function isn't needed, just passing
16695 * @c NULL as @p func is enough. The same should be done for @p data.
16697 * @see elm_list_item_append() for a simple code example.
16698 * @see elm_list_always_select_mode_set()
16699 * @see elm_list_item_del()
16700 * @see elm_list_item_del_cb_set()
16701 * @see elm_list_clear()
16702 * @see elm_icon_add()
16706 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);
16709 * Insert a new item into the sorted list object.
16711 * @param obj The list object.
16712 * @param label The label of the list item.
16713 * @param icon The icon object to use for the left side of the item. An
16714 * icon can be any Evas object, but usually it is an icon created
16715 * with elm_icon_add().
16716 * @param end The icon object to use for the right side of the item. An
16717 * icon can be any Evas object.
16718 * @param func The function to call when the item is clicked.
16719 * @param data The data to associate with the item for related callbacks.
16720 * @param cmp_func The comparing function to be used to sort list
16721 * items <b>by #Elm_List_Item item handles</b>. This function will
16722 * receive two items and compare them, returning a non-negative integer
16723 * if the second item should be place after the first, or negative value
16724 * if should be placed before.
16726 * @return The created item or @c NULL upon failure.
16728 * @note This function inserts values into a list object assuming it was
16729 * sorted and the result will be sorted.
16731 * A new item will be created and added to the list. Its position in
16732 * this list will be found comparing the new item with previously inserted
16733 * items using function @p cmp_func.
16735 * Items created with this method can be deleted with
16736 * elm_list_item_del().
16738 * Associated @p data can be properly freed when item is deleted if a
16739 * callback function is set with elm_list_item_del_cb_set().
16741 * If a function is passed as argument, it will be called everytime this item
16742 * is selected, i.e., the user clicks over an unselected item.
16743 * If always select is enabled it will call this function every time
16744 * user clicks over an item (already selected or not).
16745 * If such function isn't needed, just passing
16746 * @c NULL as @p func is enough. The same should be done for @p data.
16748 * @see elm_list_item_append() for a simple code example.
16749 * @see elm_list_always_select_mode_set()
16750 * @see elm_list_item_del()
16751 * @see elm_list_item_del_cb_set()
16752 * @see elm_list_clear()
16753 * @see elm_icon_add()
16757 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);
16760 * Remove all list's items.
16762 * @param obj The list object
16764 * @see elm_list_item_del()
16765 * @see elm_list_item_append()
16769 EAPI void elm_list_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
16772 * Get a list of all the list items.
16774 * @param obj The list object
16775 * @return An @c Eina_List of list items, #Elm_List_Item,
16776 * or @c NULL on failure.
16778 * @see elm_list_item_append()
16779 * @see elm_list_item_del()
16780 * @see elm_list_clear()
16784 EAPI const Eina_List *elm_list_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16787 * Get the selected item.
16789 * @param obj The list object.
16790 * @return The selected list item.
16792 * The selected item can be unselected with function
16793 * elm_list_item_selected_set().
16795 * The selected item always will be highlighted on list.
16797 * @see elm_list_selected_items_get()
16801 EAPI Elm_List_Item *elm_list_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16804 * Return a list of the currently selected list items.
16806 * @param obj The list object.
16807 * @return An @c Eina_List of list items, #Elm_List_Item,
16808 * or @c NULL on failure.
16810 * Multiple items can be selected if multi select is enabled. It can be
16811 * done with elm_list_multi_select_set().
16813 * @see elm_list_selected_item_get()
16814 * @see elm_list_multi_select_set()
16818 EAPI const Eina_List *elm_list_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16821 * Set the selected state of an item.
16823 * @param item The list item
16824 * @param selected The selected state
16826 * This sets the selected state of the given item @p it.
16827 * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
16829 * If a new item is selected the previosly selected will be unselected,
16830 * unless multiple selection is enabled with elm_list_multi_select_set().
16831 * Previoulsy selected item can be get with function
16832 * elm_list_selected_item_get().
16834 * Selected items will be highlighted.
16836 * @see elm_list_item_selected_get()
16837 * @see elm_list_selected_item_get()
16838 * @see elm_list_multi_select_set()
16842 EAPI void elm_list_item_selected_set(Elm_List_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
16845 * Get whether the @p item is selected or not.
16847 * @param item The list item.
16848 * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
16849 * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
16851 * @see elm_list_selected_item_set() for details.
16852 * @see elm_list_item_selected_get()
16856 EAPI Eina_Bool elm_list_item_selected_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16859 * Set or unset item as a separator.
16861 * @param it The list item.
16862 * @param setting @c EINA_TRUE to set item @p it as separator or
16863 * @c EINA_FALSE to unset, i.e., item will be used as a regular item.
16865 * Items aren't set as separator by default.
16867 * If set as separator it will display separator theme, so won't display
16870 * @see elm_list_item_separator_get()
16874 EAPI void elm_list_item_separator_set(Elm_List_Item *it, Eina_Bool setting) EINA_ARG_NONNULL(1);
16877 * Get a value whether item is a separator or not.
16879 * @see elm_list_item_separator_set() for details.
16881 * @param it The list item.
16882 * @return @c EINA_TRUE means item @p it is a separator. @c EINA_FALSE
16883 * indicates it's not. If @p it is @c NULL, @c EINA_FALSE is returned.
16887 EAPI Eina_Bool elm_list_item_separator_get(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
16890 * Show @p item in the list view.
16892 * @param item The list item to be shown.
16894 * It won't animate list until item is visible. If such behavior is wanted,
16895 * use elm_list_bring_in() intead.
16899 EAPI void elm_list_item_show(Elm_List_Item *item) EINA_ARG_NONNULL(1);
16902 * Bring in the given item to list view.
16904 * @param item The item.
16906 * This causes list to jump to the given item @p item and show it
16907 * (by scrolling), if it is not fully visible.
16909 * This may use animation to do so and take a period of time.
16911 * If animation isn't wanted, elm_list_item_show() can be used.
16915 EAPI void elm_list_item_bring_in(Elm_List_Item *item) EINA_ARG_NONNULL(1);
16918 * Delete them item from the list.
16920 * @param item The item of list to be deleted.
16922 * If deleting all list items is required, elm_list_clear()
16923 * should be used instead of getting items list and deleting each one.
16925 * @see elm_list_clear()
16926 * @see elm_list_item_append()
16927 * @see elm_list_item_del_cb_set()
16931 EAPI void elm_list_item_del(Elm_List_Item *item) EINA_ARG_NONNULL(1);
16934 * Set the function called when a list item is freed.
16936 * @param item The item to set the callback on
16937 * @param func The function called
16939 * If there is a @p func, then it will be called prior item's memory release.
16940 * That will be called with the following arguments:
16942 * @li item's Evas object;
16945 * This way, a data associated to a list item could be properly freed.
16949 EAPI void elm_list_item_del_cb_set(Elm_List_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
16952 * Get the data associated to the item.
16954 * @param item The list item
16955 * @return The data associated to @p item
16957 * The return value is a pointer to data associated to @p item when it was
16958 * created, with function elm_list_item_append() or similar. If no data
16959 * was passed as argument, it will return @c NULL.
16961 * @see elm_list_item_append()
16965 EAPI void *elm_list_item_data_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16968 * Get the left side icon associated to the item.
16970 * @param item The list item
16971 * @return The left side icon associated to @p item
16973 * The return value is a pointer to the icon associated to @p item when
16975 * created, with function elm_list_item_append() or similar, or later
16976 * with function elm_list_item_icon_set(). If no icon
16977 * was passed as argument, it will return @c NULL.
16979 * @see elm_list_item_append()
16980 * @see elm_list_item_icon_set()
16984 EAPI Evas_Object *elm_list_item_icon_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16987 * Set the left side icon associated to the item.
16989 * @param item The list item
16990 * @param icon The left side icon object to associate with @p item
16992 * The icon object to use at left side of the item. An
16993 * icon can be any Evas object, but usually it is an icon created
16994 * with elm_icon_add().
16996 * Once the icon object is set, a previously set one will be deleted.
16997 * @warning Setting the same icon for two items will cause the icon to
16998 * dissapear from the first item.
17000 * If an icon was passed as argument on item creation, with function
17001 * elm_list_item_append() or similar, it will be already
17002 * associated to the item.
17004 * @see elm_list_item_append()
17005 * @see elm_list_item_icon_get()
17009 EAPI void elm_list_item_icon_set(Elm_List_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
17012 * Get the right side icon associated to the item.
17014 * @param item The list item
17015 * @return The right side icon associated to @p item
17017 * The return value is a pointer to the icon associated to @p item when
17019 * created, with function elm_list_item_append() or similar, or later
17020 * with function elm_list_item_icon_set(). If no icon
17021 * was passed as argument, it will return @c NULL.
17023 * @see elm_list_item_append()
17024 * @see elm_list_item_icon_set()
17028 EAPI Evas_Object *elm_list_item_end_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17031 * Set the right side icon associated to the item.
17033 * @param item The list item
17034 * @param end The right side icon object to associate with @p item
17036 * The icon object to use at right side of the item. An
17037 * icon can be any Evas object, but usually it is an icon created
17038 * with elm_icon_add().
17040 * Once the icon object is set, a previously set one will be deleted.
17041 * @warning Setting the same icon for two items will cause the icon to
17042 * dissapear from the first item.
17044 * If an icon was passed as argument on item creation, with function
17045 * elm_list_item_append() or similar, it will be already
17046 * associated to the item.
17048 * @see elm_list_item_append()
17049 * @see elm_list_item_end_get()
17053 EAPI void elm_list_item_end_set(Elm_List_Item *item, Evas_Object *end) EINA_ARG_NONNULL(1);
17056 * Gets the base object of the item.
17058 * @param item The list item
17059 * @return The base object associated with @p item
17061 * Base object is the @c Evas_Object that represents that item.
17065 EAPI Evas_Object *elm_list_item_object_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17066 EINA_DEPRECATED EAPI Evas_Object *elm_list_item_base_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17069 * Get the label of item.
17071 * @param item The item of list.
17072 * @return The label of item.
17074 * The return value is a pointer to the label associated to @p item when
17075 * it was created, with function elm_list_item_append(), or later
17076 * with function elm_list_item_label_set. If no label
17077 * was passed as argument, it will return @c NULL.
17079 * @see elm_list_item_label_set() for more details.
17080 * @see elm_list_item_append()
17084 EAPI const char *elm_list_item_label_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17087 * Set the label of item.
17089 * @param item The item of list.
17090 * @param text The label of item.
17092 * The label to be displayed by the item.
17093 * Label will be placed between left and right side icons (if set).
17095 * If a label was passed as argument on item creation, with function
17096 * elm_list_item_append() or similar, it will be already
17097 * displayed by the item.
17099 * @see elm_list_item_label_get()
17100 * @see elm_list_item_append()
17104 EAPI void elm_list_item_label_set(Elm_List_Item *item, const char *text) EINA_ARG_NONNULL(1);
17108 * Get the item before @p it in list.
17110 * @param it The list item.
17111 * @return The item before @p it, or @c NULL if none or on failure.
17113 * @note If it is the first item, @c NULL will be returned.
17115 * @see elm_list_item_append()
17116 * @see elm_list_items_get()
17120 EAPI Elm_List_Item *elm_list_item_prev(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
17123 * Get the item after @p it in list.
17125 * @param it The list item.
17126 * @return The item after @p it, or @c NULL if none or on failure.
17128 * @note If it is the last item, @c NULL will be returned.
17130 * @see elm_list_item_append()
17131 * @see elm_list_items_get()
17135 EAPI Elm_List_Item *elm_list_item_next(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
17138 * Sets the disabled/enabled state of a list item.
17140 * @param it The item.
17141 * @param disabled The disabled state.
17143 * A disabled item cannot be selected or unselected. It will also
17144 * change its appearance (generally greyed out). This sets the
17145 * disabled state (@c EINA_TRUE for disabled, @c EINA_FALSE for
17150 EAPI void elm_list_item_disabled_set(Elm_List_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1);
17153 * Get a value whether list item is disabled or not.
17155 * @param it The item.
17156 * @return The disabled state.
17158 * @see elm_list_item_disabled_set() for more details.
17162 EAPI Eina_Bool elm_list_item_disabled_get(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
17165 * Set the text to be shown in a given list item's tooltips.
17167 * @param item Target item.
17168 * @param text The text to set in the content.
17170 * Setup the text as tooltip to object. The item can have only one tooltip,
17171 * so any previous tooltip data - set with this function or
17172 * elm_list_item_tooltip_content_cb_set() - is removed.
17174 * @see elm_object_tooltip_text_set() for more details.
17178 EAPI void elm_list_item_tooltip_text_set(Elm_List_Item *item, const char *text) EINA_ARG_NONNULL(1);
17182 * @brief Disable size restrictions on an object's tooltip
17183 * @param item The tooltip's anchor object
17184 * @param disable If EINA_TRUE, size restrictions are disabled
17185 * @return EINA_FALSE on failure, EINA_TRUE on success
17187 * This function allows a tooltip to expand beyond its parant window's canvas.
17188 * It will instead be limited only by the size of the display.
17190 EAPI Eina_Bool elm_list_item_tooltip_size_restrict_disable(Elm_List_Item *item, Eina_Bool disable) EINA_ARG_NONNULL(1);
17192 * @brief Retrieve size restriction state of an object's tooltip
17193 * @param obj The tooltip's anchor object
17194 * @return If EINA_TRUE, size restrictions are disabled
17196 * This function returns whether a tooltip is allowed to expand beyond
17197 * its parant window's canvas.
17198 * It will instead be limited only by the size of the display.
17200 EAPI Eina_Bool elm_list_item_tooltip_size_restrict_disabled_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17203 * Set the content to be shown in the tooltip item.
17205 * Setup the tooltip to item. The item can have only one tooltip,
17206 * so any previous tooltip data is removed. @p func(with @p data) will
17207 * be called every time that need show the tooltip and it should
17208 * return a valid Evas_Object. This object is then managed fully by
17209 * tooltip system and is deleted when the tooltip is gone.
17211 * @param item the list item being attached a tooltip.
17212 * @param func the function used to create the tooltip contents.
17213 * @param data what to provide to @a func as callback data/context.
17214 * @param del_cb called when data is not needed anymore, either when
17215 * another callback replaces @a func, the tooltip is unset with
17216 * elm_list_item_tooltip_unset() or the owner @a item
17217 * dies. This callback receives as the first parameter the
17218 * given @a data, and @c event_info is the item.
17220 * @see elm_object_tooltip_content_cb_set() for more details.
17224 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);
17227 * Unset tooltip from item.
17229 * @param item list item to remove previously set tooltip.
17231 * Remove tooltip from item. The callback provided as del_cb to
17232 * elm_list_item_tooltip_content_cb_set() will be called to notify
17233 * it is not used anymore.
17235 * @see elm_object_tooltip_unset() for more details.
17236 * @see elm_list_item_tooltip_content_cb_set()
17240 EAPI void elm_list_item_tooltip_unset(Elm_List_Item *item) EINA_ARG_NONNULL(1);
17243 * Sets a different style for this item tooltip.
17245 * @note before you set a style you should define a tooltip with
17246 * elm_list_item_tooltip_content_cb_set() or
17247 * elm_list_item_tooltip_text_set()
17249 * @param item list item with tooltip already set.
17250 * @param style the theme style to use (default, transparent, ...)
17252 * @see elm_object_tooltip_style_set() for more details.
17256 EAPI void elm_list_item_tooltip_style_set(Elm_List_Item *item, const char *style) EINA_ARG_NONNULL(1);
17259 * Get the style for this item tooltip.
17261 * @param item list item with tooltip already set.
17262 * @return style the theme style in use, defaults to "default". If the
17263 * object does not have a tooltip set, then NULL is returned.
17265 * @see elm_object_tooltip_style_get() for more details.
17266 * @see elm_list_item_tooltip_style_set()
17270 EAPI const char *elm_list_item_tooltip_style_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17273 * Set the type of mouse pointer/cursor decoration to be shown,
17274 * when the mouse pointer is over the given list widget item
17276 * @param item list item to customize cursor on
17277 * @param cursor the cursor type's name
17279 * This function works analogously as elm_object_cursor_set(), but
17280 * here the cursor's changing area is restricted to the item's
17281 * area, and not the whole widget's. Note that that item cursors
17282 * have precedence over widget cursors, so that a mouse over an
17283 * item with custom cursor set will always show @b that cursor.
17285 * If this function is called twice for an object, a previously set
17286 * cursor will be unset on the second call.
17288 * @see elm_object_cursor_set()
17289 * @see elm_list_item_cursor_get()
17290 * @see elm_list_item_cursor_unset()
17294 EAPI void elm_list_item_cursor_set(Elm_List_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
17297 * Get the type of mouse pointer/cursor decoration set to be shown,
17298 * when the mouse pointer is over the given list widget item
17300 * @param item list item with custom cursor set
17301 * @return the cursor type's name or @c NULL, if no custom cursors
17302 * were set to @p item (and on errors)
17304 * @see elm_object_cursor_get()
17305 * @see elm_list_item_cursor_set()
17306 * @see elm_list_item_cursor_unset()
17310 EAPI const char *elm_list_item_cursor_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17313 * Unset any custom mouse pointer/cursor decoration set to be
17314 * shown, when the mouse pointer is over the given list widget
17315 * item, thus making it show the @b default cursor again.
17317 * @param item a list item
17319 * Use this call to undo any custom settings on this item's cursor
17320 * decoration, bringing it back to defaults (no custom style set).
17322 * @see elm_object_cursor_unset()
17323 * @see elm_list_item_cursor_set()
17327 EAPI void elm_list_item_cursor_unset(Elm_List_Item *item) EINA_ARG_NONNULL(1);
17330 * Set a different @b style for a given custom cursor set for a
17333 * @param item list item with custom cursor set
17334 * @param style the <b>theme style</b> to use (e.g. @c "default",
17335 * @c "transparent", etc)
17337 * This function only makes sense when one is using custom mouse
17338 * cursor decorations <b>defined in a theme file</b>, which can have,
17339 * given a cursor name/type, <b>alternate styles</b> on it. It
17340 * works analogously as elm_object_cursor_style_set(), but here
17341 * applyed only to list item objects.
17343 * @warning Before you set a cursor style you should have definen a
17344 * custom cursor previously on the item, with
17345 * elm_list_item_cursor_set()
17347 * @see elm_list_item_cursor_engine_only_set()
17348 * @see elm_list_item_cursor_style_get()
17352 EAPI void elm_list_item_cursor_style_set(Elm_List_Item *item, const char *style) EINA_ARG_NONNULL(1);
17355 * Get the current @b style set for a given list item's custom
17358 * @param item list item with custom cursor set.
17359 * @return style the cursor style in use. If the object does not
17360 * have a cursor set, then @c NULL is returned.
17362 * @see elm_list_item_cursor_style_set() for more details
17366 EAPI const char *elm_list_item_cursor_style_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17369 * Set if the (custom)cursor for a given list item should be
17370 * searched in its theme, also, or should only rely on the
17371 * rendering engine.
17373 * @param item item with custom (custom) cursor already set on
17374 * @param engine_only Use @c EINA_TRUE to have cursors looked for
17375 * only on those provided by the rendering engine, @c EINA_FALSE to
17376 * have them searched on the widget's theme, as well.
17378 * @note This call is of use only if you've set a custom cursor
17379 * for list items, with elm_list_item_cursor_set().
17381 * @note By default, cursors will only be looked for between those
17382 * provided by the rendering engine.
17386 EAPI void elm_list_item_cursor_engine_only_set(Elm_List_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
17389 * Get if the (custom) cursor for a given list item is being
17390 * searched in its theme, also, or is only relying on the rendering
17393 * @param item a list item
17394 * @return @c EINA_TRUE, if cursors are being looked for only on
17395 * those provided by the rendering engine, @c EINA_FALSE if they
17396 * are being searched on the widget's theme, as well.
17398 * @see elm_list_item_cursor_engine_only_set(), for more details
17402 EAPI Eina_Bool elm_list_item_cursor_engine_only_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17409 * @defgroup Slider Slider
17410 * @ingroup Elementary
17412 * @image html img/widget/slider/preview-00.png
17413 * @image latex img/widget/slider/preview-00.eps width=\textwidth
17415 * The slider adds a dragable āsliderā widget for selecting the value of
17416 * something within a range.
17418 * A slider can be horizontal or vertical. It can contain an Icon and has a
17419 * primary label as well as a units label (that is formatted with floating
17420 * point values and thus accepts a printf-style format string, like
17421 * ā%1.2f unitsā. There is also an indicator string that may be somewhere
17422 * else (like on the slider itself) that also accepts a format string like
17423 * units. Label, Icon Unit and Indicator strings/objects are optional.
17425 * A slider may be inverted which means values invert, with high vales being
17426 * on the left or top and low values on the right or bottom (as opposed to
17427 * normally being low on the left or top and high on the bottom and right).
17429 * The slider should have its minimum and maximum values set by the
17430 * application with elm_slider_min_max_set() and value should also be set by
17431 * the application before use with elm_slider_value_set(). The span of the
17432 * slider is its length (horizontally or vertically). This will be scaled by
17433 * the object or applications scaling factor. At any point code can query the
17434 * slider for its value with elm_slider_value_get().
17436 * Smart callbacks one can listen to:
17437 * - "changed" - Whenever the slider value is changed by the user.
17438 * - "slider,drag,start" - dragging the slider indicator around has started.
17439 * - "slider,drag,stop" - dragging the slider indicator around has stopped.
17440 * - "delay,changed" - A short time after the value is changed by the user.
17441 * This will be called only when the user stops dragging for
17442 * a very short period or when they release their
17443 * finger/mouse, so it avoids possibly expensive reactions to
17444 * the value change.
17446 * Available styles for it:
17449 * Default contents parts of the slider widget that you can use for are:
17450 * @li "icon" - A icon of the slider
17451 * @li "end" - A end part content of the slider
17453 * Default text parts of the silder widget that you can use for are:
17454 * @li "default" - Label of the silder
17455 * Here is an example on its usage:
17456 * @li @ref slider_example
17460 * @addtogroup Slider
17465 * Add a new slider widget to the given parent Elementary
17466 * (container) object.
17468 * @param parent The parent object.
17469 * @return a new slider widget handle or @c NULL, on errors.
17471 * This function inserts a new slider widget on the canvas.
17475 EAPI Evas_Object *elm_slider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
17478 * Set the label of a given slider widget
17480 * @param obj The progress bar object
17481 * @param label The text label string, in UTF-8
17484 * @deprecated use elm_object_text_set() instead.
17486 EINA_DEPRECATED EAPI void elm_slider_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
17489 * Get the label of a given slider widget
17491 * @param obj The progressbar object
17492 * @return The text label string, in UTF-8
17495 * @deprecated use elm_object_text_get() instead.
17497 EINA_DEPRECATED EAPI const char *elm_slider_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17500 * Set the icon object of the slider object.
17502 * @param obj The slider object.
17503 * @param icon The icon object.
17505 * On horizontal mode, icon is placed at left, and on vertical mode,
17508 * @note Once the icon object is set, a previously set one will be deleted.
17509 * If you want to keep that old content object, use the
17510 * elm_slider_icon_unset() function.
17512 * @warning If the object being set does not have minimum size hints set,
17513 * it won't get properly displayed.
17516 * @deprecated use elm_object_part_content_set() instead.
17518 EINA_DEPRECATED EAPI void elm_slider_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
17521 * Unset an icon set on a given slider widget.
17523 * @param obj The slider object.
17524 * @return The icon object that was being used, if any was set, or
17525 * @c NULL, otherwise (and on errors).
17527 * On horizontal mode, icon is placed at left, and on vertical mode,
17530 * This call will unparent and return the icon object which was set
17531 * for this widget, previously, on success.
17533 * @see elm_slider_icon_set() for more details
17534 * @see elm_slider_icon_get()
17535 * @deprecated use elm_object_part_content_unset() instead.
17539 EINA_DEPRECATED EAPI Evas_Object *elm_slider_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
17542 * Retrieve the icon object set for a given slider widget.
17544 * @param obj The slider object.
17545 * @return The icon object's handle, if @p obj had one set, or @c NULL,
17546 * otherwise (and on errors).
17548 * On horizontal mode, icon is placed at left, and on vertical mode,
17551 * @see elm_slider_icon_set() for more details
17552 * @see elm_slider_icon_unset()
17554 * @deprecated use elm_object_part_content_get() instead.
17558 EINA_DEPRECATED EAPI Evas_Object *elm_slider_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17561 * Set the end object of the slider object.
17563 * @param obj The slider object.
17564 * @param end The end object.
17566 * On horizontal mode, end is placed at left, and on vertical mode,
17567 * placed at bottom.
17569 * @note Once the icon object is set, a previously set one will be deleted.
17570 * If you want to keep that old content object, use the
17571 * elm_slider_end_unset() function.
17573 * @warning If the object being set does not have minimum size hints set,
17574 * it won't get properly displayed.
17576 * @deprecated use elm_object_part_content_set() instead.
17580 EINA_DEPRECATED EAPI void elm_slider_end_set(Evas_Object *obj, Evas_Object *end) EINA_ARG_NONNULL(1);
17583 * Unset an end object set on a given slider widget.
17585 * @param obj The slider object.
17586 * @return The end object that was being used, if any was set, or
17587 * @c NULL, otherwise (and on errors).
17589 * On horizontal mode, end is placed at left, and on vertical mode,
17590 * placed at bottom.
17592 * This call will unparent and return the icon object which was set
17593 * for this widget, previously, on success.
17595 * @see elm_slider_end_set() for more details.
17596 * @see elm_slider_end_get()
17598 * @deprecated use elm_object_part_content_unset() instead
17603 EINA_DEPRECATED EAPI Evas_Object *elm_slider_end_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
17606 * Retrieve the end object set for a given slider widget.
17608 * @param obj The slider object.
17609 * @return The end object's handle, if @p obj had one set, or @c NULL,
17610 * otherwise (and on errors).
17612 * On horizontal mode, icon is placed at right, and on vertical mode,
17613 * placed at bottom.
17615 * @see elm_slider_end_set() for more details.
17616 * @see elm_slider_end_unset()
17619 * @deprecated use elm_object_part_content_get() instead
17624 EINA_DEPRECATED EAPI Evas_Object *elm_slider_end_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17627 * Set the (exact) length of the bar region of a given slider widget.
17629 * @param obj The slider object.
17630 * @param size The length of the slider's bar region.
17632 * This sets the minimum width (when in horizontal mode) or height
17633 * (when in vertical mode) of the actual bar area of the slider
17634 * @p obj. This in turn affects the object's minimum size. Use
17635 * this when you're not setting other size hints expanding on the
17636 * given direction (like weight and alignment hints) and you would
17637 * like it to have a specific size.
17639 * @note Icon, end, label, indicator and unit text around @p obj
17640 * will require their
17641 * own space, which will make @p obj to require more the @p size,
17644 * @see elm_slider_span_size_get()
17648 EAPI void elm_slider_span_size_set(Evas_Object *obj, Evas_Coord size) EINA_ARG_NONNULL(1);
17651 * Get the length set for the bar region of a given slider widget
17653 * @param obj The slider object.
17654 * @return The length of the slider's bar region.
17656 * If that size was not set previously, with
17657 * elm_slider_span_size_set(), this call will return @c 0.
17661 EAPI Evas_Coord elm_slider_span_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17664 * Set the format string for the unit label.
17666 * @param obj The slider object.
17667 * @param format The format string for the unit display.
17669 * Unit label is displayed all the time, if set, after slider's bar.
17670 * In horizontal mode, at right and in vertical mode, at bottom.
17672 * If @c NULL, unit label won't be visible. If not it sets the format
17673 * string for the label text. To the label text is provided a floating point
17674 * value, so the label text can display up to 1 floating point value.
17675 * Note that this is optional.
17677 * Use a format string such as "%1.2f meters" for example, and it will
17678 * display values like: "3.14 meters" for a value equal to 3.14159.
17680 * Default is unit label disabled.
17682 * @see elm_slider_indicator_format_get()
17686 EAPI void elm_slider_unit_format_set(Evas_Object *obj, const char *format) EINA_ARG_NONNULL(1);
17689 * Get the unit label format of the slider.
17691 * @param obj The slider object.
17692 * @return The unit label format string in UTF-8.
17694 * Unit label is displayed all the time, if set, after slider's bar.
17695 * In horizontal mode, at right and in vertical mode, at bottom.
17697 * @see elm_slider_unit_format_set() for more
17698 * information on how this works.
17702 EAPI const char *elm_slider_unit_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17705 * Set the format string for the indicator label.
17707 * @param obj The slider object.
17708 * @param indicator The format string for the indicator display.
17710 * The slider may display its value somewhere else then unit label,
17711 * for example, above the slider knob that is dragged around. This function
17712 * sets the format string used for this.
17714 * If @c NULL, indicator label won't be visible. If not it sets the format
17715 * string for the label text. To the label text is provided a floating point
17716 * value, so the label text can display up to 1 floating point value.
17717 * Note that this is optional.
17719 * Use a format string such as "%1.2f meters" for example, and it will
17720 * display values like: "3.14 meters" for a value equal to 3.14159.
17722 * Default is indicator label disabled.
17724 * @see elm_slider_indicator_format_get()
17728 EAPI void elm_slider_indicator_format_set(Evas_Object *obj, const char *indicator) EINA_ARG_NONNULL(1);
17731 * Get the indicator label format of the slider.
17733 * @param obj The slider object.
17734 * @return The indicator label format string in UTF-8.
17736 * The slider may display its value somewhere else then unit label,
17737 * for example, above the slider knob that is dragged around. This function
17738 * gets the format string used for this.
17740 * @see elm_slider_indicator_format_set() for more
17741 * information on how this works.
17745 EAPI const char *elm_slider_indicator_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17748 * Set the format function pointer for the indicator label
17750 * @param obj The slider object.
17751 * @param func The indicator format function.
17752 * @param free_func The freeing function for the format string.
17754 * Set the callback function to format the indicator string.
17756 * @see elm_slider_indicator_format_set() for more info on how this works.
17760 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);
17763 * Set the format function pointer for the units label
17765 * @param obj The slider object.
17766 * @param func The units format function.
17767 * @param free_func The freeing function for the format string.
17769 * Set the callback function to format the indicator string.
17771 * @see elm_slider_units_format_set() for more info on how this works.
17775 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);
17778 * Set the orientation of a given slider widget.
17780 * @param obj The slider object.
17781 * @param horizontal Use @c EINA_TRUE to make @p obj to be
17782 * @b horizontal, @c EINA_FALSE to make it @b vertical.
17784 * Use this function to change how your slider is to be
17785 * disposed: vertically or horizontally.
17787 * By default it's displayed horizontally.
17789 * @see elm_slider_horizontal_get()
17793 EAPI void elm_slider_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
17796 * Retrieve the orientation of a given slider widget
17798 * @param obj The slider object.
17799 * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
17800 * @c EINA_FALSE if it's @b vertical (and on errors).
17802 * @see elm_slider_horizontal_set() for more details.
17806 EAPI Eina_Bool elm_slider_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17809 * Set the minimum and maximum values for the slider.
17811 * @param obj The slider object.
17812 * @param min The minimum value.
17813 * @param max The maximum value.
17815 * Define the allowed range of values to be selected by the user.
17817 * If actual value is less than @p min, it will be updated to @p min. If it
17818 * is bigger then @p max, will be updated to @p max. Actual value can be
17819 * get with elm_slider_value_get().
17821 * By default, min is equal to 0.0, and max is equal to 1.0.
17823 * @warning Maximum must be greater than minimum, otherwise behavior
17826 * @see elm_slider_min_max_get()
17830 EAPI void elm_slider_min_max_set(Evas_Object *obj, double min, double max) EINA_ARG_NONNULL(1);
17833 * Get the minimum and maximum values of the slider.
17835 * @param obj The slider object.
17836 * @param min Pointer where to store the minimum value.
17837 * @param max Pointer where to store the maximum value.
17839 * @note If only one value is needed, the other pointer can be passed
17842 * @see elm_slider_min_max_set() for details.
17846 EAPI void elm_slider_min_max_get(const Evas_Object *obj, double *min, double *max) EINA_ARG_NONNULL(1);
17849 * Set the value the slider displays.
17851 * @param obj The slider object.
17852 * @param val The value to be displayed.
17854 * Value will be presented on the unit label following format specified with
17855 * elm_slider_unit_format_set() and on indicator with
17856 * elm_slider_indicator_format_set().
17858 * @warning The value must to be between min and max values. This values
17859 * are set by elm_slider_min_max_set().
17861 * @see elm_slider_value_get()
17862 * @see elm_slider_unit_format_set()
17863 * @see elm_slider_indicator_format_set()
17864 * @see elm_slider_min_max_set()
17868 EAPI void elm_slider_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
17871 * Get the value displayed by the spinner.
17873 * @param obj The spinner object.
17874 * @return The value displayed.
17876 * @see elm_spinner_value_set() for details.
17880 EAPI double elm_slider_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17883 * Invert a given slider widget's displaying values order
17885 * @param obj The slider object.
17886 * @param inverted Use @c EINA_TRUE to make @p obj inverted,
17887 * @c EINA_FALSE to bring it back to default, non-inverted values.
17889 * A slider may be @b inverted, in which state it gets its
17890 * values inverted, with high vales being on the left or top and
17891 * low values on the right or bottom, as opposed to normally have
17892 * the low values on the former and high values on the latter,
17893 * respectively, for horizontal and vertical modes.
17895 * @see elm_slider_inverted_get()
17899 EAPI void elm_slider_inverted_set(Evas_Object *obj, Eina_Bool inverted) EINA_ARG_NONNULL(1);
17902 * Get whether a given slider widget's displaying values are
17905 * @param obj The slider object.
17906 * @return @c EINA_TRUE, if @p obj has inverted values,
17907 * @c EINA_FALSE otherwise (and on errors).
17909 * @see elm_slider_inverted_set() for more details.
17913 EAPI Eina_Bool elm_slider_inverted_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17916 * Set whether to enlarge slider indicator (augmented knob) or not.
17918 * @param obj The slider object.
17919 * @param show @c EINA_TRUE will make it enlarge, @c EINA_FALSE will
17920 * let the knob always at default size.
17922 * By default, indicator will be bigger while dragged by the user.
17924 * @warning It won't display values set with
17925 * elm_slider_indicator_format_set() if you disable indicator.
17929 EAPI void elm_slider_indicator_show_set(Evas_Object *obj, Eina_Bool show) EINA_ARG_NONNULL(1);
17932 * Get whether a given slider widget's enlarging indicator or not.
17934 * @param obj The slider object.
17935 * @return @c EINA_TRUE, if @p obj is enlarging indicator, or
17936 * @c EINA_FALSE otherwise (and on errors).
17938 * @see elm_slider_indicator_show_set() for details.
17942 EAPI Eina_Bool elm_slider_indicator_show_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17949 * @addtogroup Actionslider Actionslider
17951 * @image html img/widget/actionslider/preview-00.png
17952 * @image latex img/widget/actionslider/preview-00.eps
17954 * An actionslider is a switcher for 2 or 3 labels with customizable magnet
17955 * properties. The user drags and releases the indicator, to choose a label.
17957 * Labels occupy the following positions.
17962 * Positions can be enabled or disabled.
17964 * Magnets can be set on the above positions.
17966 * When the indicator is released, it will move to its nearest "enabled and magnetized" position.
17968 * @note By default all positions are set as enabled.
17970 * Signals that you can add callbacks for are:
17972 * "selected" - when user selects an enabled position (the label is passed
17975 * "pos_changed" - when the indicator reaches any of the positions("left",
17976 * "right" or "center").
17978 * See an example of actionslider usage @ref actionslider_example_page "here"
17981 typedef enum _Elm_Actionslider_Pos
17983 ELM_ACTIONSLIDER_NONE = 0,
17984 ELM_ACTIONSLIDER_LEFT = 1 << 0,
17985 ELM_ACTIONSLIDER_CENTER = 1 << 1,
17986 ELM_ACTIONSLIDER_RIGHT = 1 << 2,
17987 ELM_ACTIONSLIDER_ALL = (1 << 3) -1
17988 } Elm_Actionslider_Pos;
17991 * Add a new actionslider to the parent.
17993 * @param parent The parent object
17994 * @return The new actionslider object or NULL if it cannot be created
17996 EAPI Evas_Object *elm_actionslider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
17998 * Set actionslider labels.
18000 * @param obj The actionslider object
18001 * @param left_label The label to be set on the left.
18002 * @param center_label The label to be set on the center.
18003 * @param right_label The label to be set on the right.
18004 * @deprecated use elm_object_text_set() instead.
18006 EINA_DEPRECATED EAPI void elm_actionslider_labels_set(Evas_Object *obj, const char *left_label, const char *center_label, const char *right_label) EINA_ARG_NONNULL(1);
18008 * Get actionslider labels.
18010 * @param obj The actionslider object
18011 * @param left_label A char** to place the left_label of @p obj into.
18012 * @param center_label A char** to place the center_label of @p obj into.
18013 * @param right_label A char** to place the right_label of @p obj into.
18014 * @deprecated use elm_object_text_set() instead.
18016 EINA_DEPRECATED 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);
18018 * Get actionslider selected label.
18020 * @param obj The actionslider object
18021 * @return The selected label
18023 EAPI const char *elm_actionslider_selected_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18025 * Set actionslider indicator position.
18027 * @param obj The actionslider object.
18028 * @param pos The position of the indicator.
18030 EAPI void elm_actionslider_indicator_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
18032 * Get actionslider indicator position.
18034 * @param obj The actionslider object.
18035 * @return The position of the indicator.
18037 EAPI Elm_Actionslider_Pos elm_actionslider_indicator_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18039 * Set actionslider magnet position. To make multiple positions magnets @c or
18040 * them together(e.g.: ELM_ACTIONSLIDER_LEFT | ELM_ACTIONSLIDER_RIGHT)
18042 * @param obj The actionslider object.
18043 * @param pos Bit mask indicating the magnet positions.
18045 EAPI void elm_actionslider_magnet_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
18047 * Get actionslider magnet position.
18049 * @param obj The actionslider object.
18050 * @return The positions with magnet property.
18052 EAPI Elm_Actionslider_Pos elm_actionslider_magnet_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18054 * Set actionslider enabled position. To set multiple positions as enabled @c or
18055 * them together(e.g.: ELM_ACTIONSLIDER_LEFT | ELM_ACTIONSLIDER_RIGHT).
18057 * @note All the positions are enabled by default.
18059 * @param obj The actionslider object.
18060 * @param pos Bit mask indicating the enabled positions.
18062 EAPI void elm_actionslider_enabled_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
18064 * Get actionslider enabled position.
18066 * @param obj The actionslider object.
18067 * @return The enabled positions.
18069 EAPI Elm_Actionslider_Pos elm_actionslider_enabled_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18071 * Set the label used on the indicator.
18073 * @param obj The actionslider object
18074 * @param label The label to be set on the indicator.
18075 * @deprecated use elm_object_text_set() instead.
18077 EINA_DEPRECATED EAPI void elm_actionslider_indicator_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
18079 * Get the label used on the indicator object.
18081 * @param obj The actionslider object
18082 * @return The indicator label
18083 * @deprecated use elm_object_text_get() instead.
18085 EINA_DEPRECATED EAPI const char *elm_actionslider_indicator_label_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
18091 * @defgroup Genlist Genlist
18093 * @image html img/widget/genlist/preview-00.png
18094 * @image latex img/widget/genlist/preview-00.eps
18095 * @image html img/genlist.png
18096 * @image latex img/genlist.eps
18098 * This widget aims to have more expansive list than the simple list in
18099 * Elementary that could have more flexible items and allow many more entries
18100 * while still being fast and low on memory usage. At the same time it was
18101 * also made to be able to do tree structures. But the price to pay is more
18102 * complexity when it comes to usage. If all you want is a simple list with
18103 * icons and a single label, use the normal @ref List object.
18105 * Genlist has a fairly large API, mostly because it's relatively complex,
18106 * trying to be both expansive, powerful and efficient. First we will begin
18107 * an overview on the theory behind genlist.
18109 * @section Genlist_Item_Class Genlist item classes - creating items
18111 * In order to have the ability to add and delete items on the fly, genlist
18112 * implements a class (callback) system where the application provides a
18113 * structure with information about that type of item (genlist may contain
18114 * multiple different items with different classes, states and styles).
18115 * Genlist will call the functions in this struct (methods) when an item is
18116 * "realized" (i.e., created dynamically, while the user is scrolling the
18117 * grid). All objects will simply be deleted when no longer needed with
18118 * evas_object_del(). The #Elm_Genlist_Item_Class structure contains the
18119 * following members:
18120 * - @c item_style - This is a constant string and simply defines the name
18121 * of the item style. It @b must be specified and the default should be @c
18124 * - @c func - A struct with pointers to functions that will be called when
18125 * an item is going to be actually created. All of them receive a @c data
18126 * parameter that will point to the same data passed to
18127 * elm_genlist_item_append() and related item creation functions, and a @c
18128 * obj parameter that points to the genlist object itself.
18130 * The function pointers inside @c func are @c label_get, @c icon_get, @c
18131 * state_get and @c del. The 3 first functions also receive a @c part
18132 * parameter described below. A brief description of these functions follows:
18134 * - @c label_get - The @c part parameter is the name string of one of the
18135 * existing text parts in the Edje group implementing the item's theme.
18136 * This function @b must return a strdup'()ed string, as the caller will
18137 * free() it when done. See #Elm_Genlist_Item_Label_Get_Cb.
18138 * - @c content_get - The @c part parameter is the name string of one of the
18139 * existing (content) swallow parts in the Edje group implementing the item's
18140 * theme. It must return @c NULL, when no content is desired, or a valid
18141 * object handle, otherwise. The object will be deleted by the genlist on
18142 * its deletion or when the item is "unrealized". See
18143 * #Elm_Genlist_Item_Content_Get_Cb.
18144 * - @c func.state_get - The @c part parameter is the name string of one of
18145 * the state parts in the Edje group implementing the item's theme. Return
18146 * @c EINA_FALSE for false/off or @c EINA_TRUE for true/on. Genlists will
18147 * emit a signal to its theming Edje object with @c "elm,state,XXX,active"
18148 * and @c "elm" as "emission" and "source" arguments, respectively, when
18149 * the state is true (the default is false), where @c XXX is the name of
18150 * the (state) part. See #Elm_Genlist_Item_State_Get_Cb.
18151 * - @c func.del - This is intended for use when genlist items are deleted,
18152 * so any data attached to the item (e.g. its data parameter on creation)
18153 * can be deleted. See #Elm_Genlist_Item_Del_Cb.
18155 * available item styles:
18157 * - default_style - The text part is a textblock
18159 * @image html img/widget/genlist/preview-04.png
18160 * @image latex img/widget/genlist/preview-04.eps
18164 * @image html img/widget/genlist/preview-01.png
18165 * @image latex img/widget/genlist/preview-01.eps
18167 * - icon_top_text_bottom
18169 * @image html img/widget/genlist/preview-02.png
18170 * @image latex img/widget/genlist/preview-02.eps
18174 * @image html img/widget/genlist/preview-03.png
18175 * @image latex img/widget/genlist/preview-03.eps
18177 * @section Genlist_Items Structure of items
18179 * An item in a genlist can have 0 or more text labels (they can be regular
18180 * text or textblock Evas objects - that's up to the style to determine), 0
18181 * or more contents (which are simply objects swallowed into the genlist item's
18182 * theming Edje object) and 0 or more <b>boolean states</b>, which have the
18183 * behavior left to the user to define. The Edje part names for each of
18184 * these properties will be looked up, in the theme file for the genlist,
18185 * under the Edje (string) data items named @c "labels", @c "contents" and @c
18186 * "states", respectively. For each of those properties, if more than one
18187 * part is provided, they must have names listed separated by spaces in the
18188 * data fields. For the default genlist item theme, we have @b one label
18189 * part (@c "elm.text"), @b two content parts (@c "elm.swalllow.icon" and @c
18190 * "elm.swallow.end") and @b no state parts.
18192 * A genlist item may be at one of several styles. Elementary provides one
18193 * by default - "default", but this can be extended by system or application
18194 * custom themes/overlays/extensions (see @ref Theme "themes" for more
18197 * @section Genlist_Manipulation Editing and Navigating
18199 * Items can be added by several calls. All of them return a @ref
18200 * Elm_Genlist_Item handle that is an internal member inside the genlist.
18201 * They all take a data parameter that is meant to be used for a handle to
18202 * the applications internal data (eg the struct with the original item
18203 * data). The parent parameter is the parent genlist item this belongs to if
18204 * it is a tree or an indexed group, and NULL if there is no parent. The
18205 * flags can be a bitmask of #ELM_GENLIST_ITEM_NONE,
18206 * #ELM_GENLIST_ITEM_SUBITEMS and #ELM_GENLIST_ITEM_GROUP. If
18207 * #ELM_GENLIST_ITEM_SUBITEMS is set then this item is displayed as an item
18208 * that is able to expand and have child items. If ELM_GENLIST_ITEM_GROUP
18209 * is set then this item is group index item that is displayed at the top
18210 * until the next group comes. The func parameter is a convenience callback
18211 * that is called when the item is selected and the data parameter will be
18212 * the func_data parameter, obj be the genlist object and event_info will be
18213 * the genlist item.
18215 * elm_genlist_item_append() adds an item to the end of the list, or if
18216 * there is a parent, to the end of all the child items of the parent.
18217 * elm_genlist_item_prepend() is the same but adds to the beginning of
18218 * the list or children list. elm_genlist_item_insert_before() inserts at
18219 * item before another item and elm_genlist_item_insert_after() inserts after
18220 * the indicated item.
18222 * The application can clear the list with elm_genlist_clear() which deletes
18223 * all the items in the list and elm_genlist_item_del() will delete a specific
18224 * item. elm_genlist_item_subitems_clear() will clear all items that are
18225 * children of the indicated parent item.
18227 * To help inspect list items you can jump to the item at the top of the list
18228 * with elm_genlist_first_item_get() which will return the item pointer, and
18229 * similarly elm_genlist_last_item_get() gets the item at the end of the list.
18230 * elm_genlist_item_next_get() and elm_genlist_item_prev_get() get the next
18231 * and previous items respectively relative to the indicated item. Using
18232 * these calls you can walk the entire item list/tree. Note that as a tree
18233 * the items are flattened in the list, so elm_genlist_item_parent_get() will
18234 * let you know which item is the parent (and thus know how to skip them if
18237 * @section Genlist_Muti_Selection Multi-selection
18239 * If the application wants multiple items to be able to be selected,
18240 * elm_genlist_multi_select_set() can enable this. If the list is
18241 * single-selection only (the default), then elm_genlist_selected_item_get()
18242 * will return the selected item, if any, or NULL if none is selected. If the
18243 * list is multi-select then elm_genlist_selected_items_get() will return a
18244 * list (that is only valid as long as no items are modified (added, deleted,
18245 * selected or unselected)).
18247 * @section Genlist_Usage_Hints Usage hints
18249 * There are also convenience functions. elm_gen_item_genlist_get() will
18250 * return the genlist object the item belongs to. elm_genlist_item_show()
18251 * will make the scroller scroll to show that specific item so its visible.
18252 * elm_genlist_item_data_get() returns the data pointer set by the item
18253 * creation functions.
18255 * If an item changes (state of boolean changes, label or contents change),
18256 * then use elm_genlist_item_update() to have genlist update the item with
18257 * the new state. Genlist will re-realize the item thus call the functions
18258 * in the _Elm_Genlist_Item_Class for that item.
18260 * To programmatically (un)select an item use elm_genlist_item_selected_set().
18261 * To get its selected state use elm_genlist_item_selected_get(). Similarly
18262 * to expand/contract an item and get its expanded state, use
18263 * elm_genlist_item_expanded_set() and elm_genlist_item_expanded_get(). And
18264 * again to make an item disabled (unable to be selected and appear
18265 * differently) use elm_genlist_item_disabled_set() to set this and
18266 * elm_genlist_item_disabled_get() to get the disabled state.
18268 * In general to indicate how the genlist should expand items horizontally to
18269 * fill the list area, use elm_genlist_horizontal_set(). Valid modes are
18270 * ELM_LIST_LIMIT and ELM_LIST_SCROLL. The default is ELM_LIST_SCROLL. This
18271 * mode means that if items are too wide to fit, the scroller will scroll
18272 * horizontally. Otherwise items are expanded to fill the width of the
18273 * viewport of the scroller. If it is ELM_LIST_LIMIT, items will be expanded
18274 * to the viewport width and limited to that size. This can be combined with
18275 * a different style that uses edjes' ellipsis feature (cutting text off like
18278 * Items will only call their selection func and callback when first becoming
18279 * selected. Any further clicks will do nothing, unless you enable always
18280 * select with elm_genlist_always_select_mode_set(). This means even if
18281 * selected, every click will make the selected callbacks be called.
18282 * elm_genlist_no_select_mode_set() will turn off the ability to select
18283 * items entirely and they will neither appear selected nor call selected
18284 * callback functions.
18286 * Remember that you can create new styles and add your own theme augmentation
18287 * per application with elm_theme_extension_add(). If you absolutely must
18288 * have a specific style that overrides any theme the user or system sets up
18289 * you can use elm_theme_overlay_add() to add such a file.
18291 * @section Genlist_Implementation Implementation
18293 * Evas tracks every object you create. Every time it processes an event
18294 * (mouse move, down, up etc.) it needs to walk through objects and find out
18295 * what event that affects. Even worse every time it renders display updates,
18296 * in order to just calculate what to re-draw, it needs to walk through many
18297 * many many objects. Thus, the more objects you keep active, the more
18298 * overhead Evas has in just doing its work. It is advisable to keep your
18299 * active objects to the minimum working set you need. Also remember that
18300 * object creation and deletion carries an overhead, so there is a
18301 * middle-ground, which is not easily determined. But don't keep massive lists
18302 * of objects you can't see or use. Genlist does this with list objects. It
18303 * creates and destroys them dynamically as you scroll around. It groups them
18304 * into blocks so it can determine the visibility etc. of a whole block at
18305 * once as opposed to having to walk the whole list. This 2-level list allows
18306 * for very large numbers of items to be in the list (tests have used up to
18307 * 2,000,000 items). Also genlist employs a queue for adding items. As items
18308 * may be different sizes, every item added needs to be calculated as to its
18309 * size and thus this presents a lot of overhead on populating the list, this
18310 * genlist employs a queue. Any item added is queued and spooled off over
18311 * time, actually appearing some time later, so if your list has many members
18312 * you may find it takes a while for them to all appear, with your process
18313 * consuming a lot of CPU while it is busy spooling.
18315 * Genlist also implements a tree structure, but it does so with callbacks to
18316 * the application, with the application filling in tree structures when
18317 * requested (allowing for efficient building of a very deep tree that could
18318 * even be used for file-management). See the above smart signal callbacks for
18321 * @section Genlist_Smart_Events Genlist smart events
18323 * Signals that you can add callbacks for are:
18324 * - @c "activated" - The user has double-clicked or pressed
18325 * (enter|return|spacebar) on an item. The @c event_info parameter is the
18326 * item that was activated.
18327 * - @c "clicked,double" - The user has double-clicked an item. The @c
18328 * event_info parameter is the item that was double-clicked.
18329 * - @c "selected" - This is called when a user has made an item selected.
18330 * The event_info parameter is the genlist item that was selected.
18331 * - @c "unselected" - This is called when a user has made an item
18332 * unselected. The event_info parameter is the genlist item that was
18334 * - @c "expanded" - This is called when elm_genlist_item_expanded_set() is
18335 * called and the item is now meant to be expanded. The event_info
18336 * parameter is the genlist item that was indicated to expand. It is the
18337 * job of this callback to then fill in the child items.
18338 * - @c "contracted" - This is called when elm_genlist_item_expanded_set() is
18339 * called and the item is now meant to be contracted. The event_info
18340 * parameter is the genlist item that was indicated to contract. It is the
18341 * job of this callback to then delete the child items.
18342 * - @c "expand,request" - This is called when a user has indicated they want
18343 * to expand a tree branch item. The callback should decide if the item can
18344 * expand (has any children) and then call elm_genlist_item_expanded_set()
18345 * appropriately to set the state. The event_info parameter is the genlist
18346 * item that was indicated to expand.
18347 * - @c "contract,request" - This is called when a user has indicated they
18348 * want to contract a tree branch item. The callback should decide if the
18349 * item can contract (has any children) and then call
18350 * elm_genlist_item_expanded_set() appropriately to set the state. The
18351 * event_info parameter is the genlist item that was indicated to contract.
18352 * - @c "realized" - This is called when the item in the list is created as a
18353 * real evas object. event_info parameter is the genlist item that was
18354 * created. The object may be deleted at any time, so it is up to the
18355 * caller to not use the object pointer from elm_genlist_item_object_get()
18356 * in a way where it may point to freed objects.
18357 * - @c "unrealized" - This is called just before an item is unrealized.
18358 * After this call content objects provided will be deleted and the item
18359 * object itself delete or be put into a floating cache.
18360 * - @c "drag,start,up" - This is called when the item in the list has been
18361 * dragged (not scrolled) up.
18362 * - @c "drag,start,down" - This is called when the item in the list has been
18363 * dragged (not scrolled) down.
18364 * - @c "drag,start,left" - This is called when the item in the list has been
18365 * dragged (not scrolled) left.
18366 * - @c "drag,start,right" - This is called when the item in the list has
18367 * been dragged (not scrolled) right.
18368 * - @c "drag,stop" - This is called when the item in the list has stopped
18370 * - @c "drag" - This is called when the item in the list is being dragged.
18371 * - @c "longpressed" - This is called when the item is pressed for a certain
18372 * amount of time. By default it's 1 second.
18373 * - @c "scroll,anim,start" - This is called when scrolling animation has
18375 * - @c "scroll,anim,stop" - This is called when scrolling animation has
18377 * - @c "scroll,drag,start" - This is called when dragging the content has
18379 * - @c "scroll,drag,stop" - This is called when dragging the content has
18381 * - @c "edge,top" - This is called when the genlist is scrolled until
18383 * - @c "edge,bottom" - This is called when the genlist is scrolled
18384 * until the bottom edge.
18385 * - @c "edge,left" - This is called when the genlist is scrolled
18386 * until the left edge.
18387 * - @c "edge,right" - This is called when the genlist is scrolled
18388 * until the right edge.
18389 * - @c "multi,swipe,left" - This is called when the genlist is multi-touch
18391 * - @c "multi,swipe,right" - This is called when the genlist is multi-touch
18393 * - @c "multi,swipe,up" - This is called when the genlist is multi-touch
18395 * - @c "multi,swipe,down" - This is called when the genlist is multi-touch
18397 * - @c "multi,pinch,out" - This is called when the genlist is multi-touch
18398 * pinched out. "- @c multi,pinch,in" - This is called when the genlist is
18399 * multi-touch pinched in.
18400 * - @c "swipe" - This is called when the genlist is swiped.
18401 * - @c "moved" - This is called when a genlist item is moved.
18402 * - @c "language,changed" - This is called when the program's language is
18405 * @section Genlist_Examples Examples
18407 * Here is a list of examples that use the genlist, trying to show some of
18408 * its capabilities:
18409 * - @ref genlist_example_01
18410 * - @ref genlist_example_02
18411 * - @ref genlist_example_03
18412 * - @ref genlist_example_04
18413 * - @ref genlist_example_05
18417 * @addtogroup Genlist
18422 * @enum _Elm_Genlist_Item_Flags
18423 * @typedef Elm_Genlist_Item_Flags
18425 * Defines if the item is of any special type (has subitems or it's the
18426 * index of a group), or is just a simple item.
18430 typedef enum _Elm_Genlist_Item_Flags
18432 ELM_GENLIST_ITEM_NONE = 0, /**< simple item */
18433 ELM_GENLIST_ITEM_SUBITEMS = (1 << 0), /**< may expand and have child items */
18434 ELM_GENLIST_ITEM_GROUP = (1 << 1) /**< index of a group of items */
18435 } Elm_Genlist_Item_Flags;
18436 typedef enum _Elm_Genlist_Item_Field_Flags
18438 ELM_GENLIST_ITEM_FIELD_ALL = 0,
18439 ELM_GENLIST_ITEM_FIELD_LABEL = (1 << 0),
18440 ELM_GENLIST_ITEM_FIELD_CONTENT = (1 << 1),
18441 ELM_GENLIST_ITEM_FIELD_STATE = (1 << 2)
18442 } Elm_Genlist_Item_Field_Flags;
18443 typedef struct _Elm_Genlist_Item_Class Elm_Genlist_Item_Class; /**< Genlist item class definition structs */
18444 #define Elm_Genlist_Item_Class Elm_Gen_Item_Class
18445 typedef struct _Elm_Genlist_Item Elm_Genlist_Item; /**< Item of Elm_Genlist. Sub-type of Elm_Widget_Item */
18446 #define Elm_Genlist_Item Elm_Gen_Item /**< Item of Elm_Genlist. Sub-type of Elm_Widget_Item */
18447 typedef struct _Elm_Genlist_Item_Class_Func Elm_Genlist_Item_Class_Func; /**< Class functions for genlist item class */
18449 * Label fetching class function for Elm_Gen_Item_Class.
18450 * @param data The data passed in the item creation function
18451 * @param obj The base widget object
18452 * @param part The part name of the swallow
18453 * @return The allocated (NOT stringshared) string to set as the label
18455 typedef char *(*Elm_Genlist_Item_Label_Get_Cb) (void *data, Evas_Object *obj, const char *part);
18457 * Content (swallowed object) fetching class function for Elm_Gen_Item_Class.
18458 * @param data The data passed in the item creation function
18459 * @param obj The base widget object
18460 * @param part The part name of the swallow
18461 * @return The content object to swallow
18463 typedef Evas_Object *(*Elm_Genlist_Item_Content_Get_Cb) (void *data, Evas_Object *obj, const char *part);
18465 * State fetching class function for Elm_Gen_Item_Class.
18466 * @param data The data passed in the item creation function
18467 * @param obj The base widget object
18468 * @param part The part name of the swallow
18469 * @return The hell if I know
18471 typedef Eina_Bool (*Elm_Genlist_Item_State_Get_Cb) (void *data, Evas_Object *obj, const char *part);
18473 * Deletion class function for Elm_Gen_Item_Class.
18474 * @param data The data passed in the item creation function
18475 * @param obj The base widget object
18477 typedef void (*Elm_Genlist_Item_Del_Cb) (void *data, Evas_Object *obj);
18480 * @struct _Elm_Genlist_Item_Class
18482 * Genlist item class definition structs.
18484 * This struct contains the style and fetching functions that will define the
18485 * contents of each item.
18487 * @see @ref Genlist_Item_Class
18489 struct _Elm_Genlist_Item_Class
18491 const char *item_style; /**< style of this class. */
18492 struct Elm_Genlist_Item_Class_Func
18494 Elm_Genlist_Item_Label_Get_Cb label_get; /**< Label fetching class function for genlist item classes.*/
18495 Elm_Genlist_Item_Content_Get_Cb content_get; /**< Content fetching class function for genlist item classes. */
18496 Elm_Genlist_Item_State_Get_Cb state_get; /**< State fetching class function for genlist item classes. */
18497 Elm_Genlist_Item_Del_Cb del; /**< Deletion class function for genlist item classes. */
18500 #define Elm_Genlist_Item_Class_Func Elm_Gen_Item_Class_Func
18502 * Add a new genlist widget to the given parent Elementary
18503 * (container) object
18505 * @param parent The parent object
18506 * @return a new genlist widget handle or @c NULL, on errors
18508 * This function inserts a new genlist widget on the canvas.
18510 * @see elm_genlist_item_append()
18511 * @see elm_genlist_item_del()
18512 * @see elm_genlist_clear()
18516 EAPI Evas_Object *elm_genlist_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
18518 * Remove all items from a given genlist widget.
18520 * @param obj The genlist object
18522 * This removes (and deletes) all items in @p obj, leaving it empty.
18524 * @see elm_genlist_item_del(), to remove just one item.
18528 EAPI void elm_genlist_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
18530 * Enable or disable multi-selection in the genlist
18532 * @param obj The genlist object
18533 * @param multi Multi-select enable/disable. Default is disabled.
18535 * This enables (@c EINA_TRUE) or disables (@c EINA_FALSE) multi-selection in
18536 * the list. This allows more than 1 item to be selected. To retrieve the list
18537 * of selected items, use elm_genlist_selected_items_get().
18539 * @see elm_genlist_selected_items_get()
18540 * @see elm_genlist_multi_select_get()
18544 EAPI void elm_genlist_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
18546 * Gets if multi-selection in genlist is enabled or disabled.
18548 * @param obj The genlist object
18549 * @return Multi-select enabled/disabled
18550 * (@c EINA_TRUE = enabled/@c EINA_FALSE = disabled). Default is @c EINA_FALSE.
18552 * @see elm_genlist_multi_select_set()
18556 EAPI Eina_Bool elm_genlist_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18558 * This sets the horizontal stretching mode.
18560 * @param obj The genlist object
18561 * @param mode The mode to use (one of #ELM_LIST_SCROLL or #ELM_LIST_LIMIT).
18563 * This sets the mode used for sizing items horizontally. Valid modes
18564 * are #ELM_LIST_LIMIT and #ELM_LIST_SCROLL. The default is
18565 * ELM_LIST_SCROLL. This mode means that if items are too wide to fit,
18566 * the scroller will scroll horizontally. Otherwise items are expanded
18567 * to fill the width of the viewport of the scroller. If it is
18568 * ELM_LIST_LIMIT, items will be expanded to the viewport width and
18569 * limited to that size.
18571 * @see elm_genlist_horizontal_get()
18575 EAPI void elm_genlist_horizontal_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
18576 EINA_DEPRECATED EAPI void elm_genlist_horizontal_mode_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
18578 * Gets the horizontal stretching mode.
18580 * @param obj The genlist object
18581 * @return The mode to use
18582 * (#ELM_LIST_LIMIT, #ELM_LIST_SCROLL)
18584 * @see elm_genlist_horizontal_set()
18588 EAPI Elm_List_Mode elm_genlist_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18589 EINA_DEPRECATED EAPI Elm_List_Mode elm_genlist_horizontal_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18591 * Set the always select mode.
18593 * @param obj The genlist object
18594 * @param always_select The always select mode (@c EINA_TRUE = on, @c
18595 * EINA_FALSE = off). Default is @c EINA_FALSE.
18597 * Items will only call their selection func and callback when first
18598 * becoming selected. Any further clicks will do nothing, unless you
18599 * enable always select with elm_genlist_always_select_mode_set().
18600 * This means that, even if selected, every click will make the selected
18601 * callbacks be called.
18603 * @see elm_genlist_always_select_mode_get()
18607 EAPI void elm_genlist_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
18609 * Get the always select mode.
18611 * @param obj The genlist object
18612 * @return The always select mode
18613 * (@c EINA_TRUE = on, @c EINA_FALSE = off)
18615 * @see elm_genlist_always_select_mode_set()
18619 EAPI Eina_Bool elm_genlist_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18621 * Enable/disable the no select mode.
18623 * @param obj The genlist object
18624 * @param no_select The no select mode
18625 * (EINA_TRUE = on, EINA_FALSE = off)
18627 * This will turn off the ability to select items entirely and they
18628 * will neither appear selected nor call selected callback functions.
18630 * @see elm_genlist_no_select_mode_get()
18634 EAPI void elm_genlist_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
18636 * Gets whether the no select mode is enabled.
18638 * @param obj The genlist object
18639 * @return The no select mode
18640 * (@c EINA_TRUE = on, @c EINA_FALSE = off)
18642 * @see elm_genlist_no_select_mode_set()
18646 EAPI Eina_Bool elm_genlist_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18648 * Enable/disable compress mode.
18650 * @param obj The genlist object
18651 * @param compress The compress mode
18652 * (@c EINA_TRUE = on, @c EINA_FALSE = off). Default is @c EINA_FALSE.
18654 * This will enable the compress mode where items are "compressed"
18655 * horizontally to fit the genlist scrollable viewport width. This is
18656 * special for genlist. Do not rely on
18657 * elm_genlist_horizontal_set() being set to @c ELM_LIST_COMPRESS to
18658 * work as genlist needs to handle it specially.
18660 * @see elm_genlist_compress_mode_get()
18664 EAPI void elm_genlist_compress_mode_set(Evas_Object *obj, Eina_Bool compress) EINA_ARG_NONNULL(1);
18666 * Get whether the compress mode is enabled.
18668 * @param obj The genlist object
18669 * @return The compress mode
18670 * (@c EINA_TRUE = on, @c EINA_FALSE = off)
18672 * @see elm_genlist_compress_mode_set()
18676 EAPI Eina_Bool elm_genlist_compress_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18678 * Enable/disable height-for-width mode.
18680 * @param obj The genlist object
18681 * @param setting The height-for-width mode (@c EINA_TRUE = on,
18682 * @c EINA_FALSE = off). Default is @c EINA_FALSE.
18684 * With height-for-width mode the item width will be fixed (restricted
18685 * to a minimum of) to the list width when calculating its size in
18686 * order to allow the height to be calculated based on it. This allows,
18687 * for instance, text block to wrap lines if the Edje part is
18688 * configured with "text.min: 0 1".
18690 * @note This mode will make list resize slower as it will have to
18691 * recalculate every item height again whenever the list width
18694 * @note When height-for-width mode is enabled, it also enables
18695 * compress mode (see elm_genlist_compress_mode_set()) and
18696 * disables homogeneous (see elm_genlist_homogeneous_set()).
18700 EAPI void elm_genlist_height_for_width_mode_set(Evas_Object *obj, Eina_Bool height_for_width) EINA_ARG_NONNULL(1);
18702 * Get whether the height-for-width mode is enabled.
18704 * @param obj The genlist object
18705 * @return The height-for-width mode (@c EINA_TRUE = on, @c EINA_FALSE =
18710 EAPI Eina_Bool elm_genlist_height_for_width_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18712 * Enable/disable horizontal and vertical bouncing effect.
18714 * @param obj The genlist object
18715 * @param h_bounce Allow bounce horizontally (@c EINA_TRUE = on, @c
18716 * EINA_FALSE = off). Default is @c EINA_FALSE.
18717 * @param v_bounce Allow bounce vertically (@c EINA_TRUE = on, @c
18718 * EINA_FALSE = off). Default is @c EINA_TRUE.
18720 * This will enable or disable the scroller bouncing effect for the
18721 * genlist. See elm_scroller_bounce_set() for details.
18723 * @see elm_scroller_bounce_set()
18724 * @see elm_genlist_bounce_get()
18728 EAPI void elm_genlist_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
18730 * Get whether the horizontal and vertical bouncing effect is enabled.
18732 * @param obj The genlist object
18733 * @param h_bounce Pointer to a bool to receive if the bounce horizontally
18735 * @param v_bounce Pointer to a bool to receive if the bounce vertically
18738 * @see elm_genlist_bounce_set()
18742 EAPI void elm_genlist_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
18744 * Enable/disable homogeneous mode.
18746 * @param obj The genlist object
18747 * @param homogeneous Assume the items within the genlist are of the
18748 * same height and width (EINA_TRUE = on, EINA_FALSE = off). Default is @c
18751 * This will enable the homogeneous mode where items are of the same
18752 * height and width so that genlist may do the lazy-loading at its
18753 * maximum (which increases the performance for scrolling the list). This
18754 * implies 'compressed' mode.
18756 * @see elm_genlist_compress_mode_set()
18757 * @see elm_genlist_homogeneous_get()
18761 EAPI void elm_genlist_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
18763 * Get whether the homogeneous mode is enabled.
18765 * @param obj The genlist object
18766 * @return Assume the items within the genlist are of the same height
18767 * and width (EINA_TRUE = on, EINA_FALSE = off)
18769 * @see elm_genlist_homogeneous_set()
18773 EAPI Eina_Bool elm_genlist_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18775 * Set the maximum number of items within an item block
18777 * @param obj The genlist object
18778 * @param n Maximum number of items within an item block. Default is 32.
18780 * This will configure the block count to tune to the target with
18781 * particular performance matrix.
18783 * A block of objects will be used to reduce the number of operations due to
18784 * many objects in the screen. It can determine the visibility, or if the
18785 * object has changed, it theme needs to be updated, etc. doing this kind of
18786 * calculation to the entire block, instead of per object.
18788 * The default value for the block count is enough for most lists, so unless
18789 * you know you will have a lot of objects visible in the screen at the same
18790 * time, don't try to change this.
18792 * @see elm_genlist_block_count_get()
18793 * @see @ref Genlist_Implementation
18797 EAPI void elm_genlist_block_count_set(Evas_Object *obj, int n) EINA_ARG_NONNULL(1);
18799 * Get the maximum number of items within an item block
18801 * @param obj The genlist object
18802 * @return Maximum number of items within an item block
18804 * @see elm_genlist_block_count_set()
18808 EAPI int elm_genlist_block_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18810 * Set the timeout in seconds for the longpress event.
18812 * @param obj The genlist object
18813 * @param timeout timeout in seconds. Default is 1.
18815 * This option will change how long it takes to send an event "longpressed"
18816 * after the mouse down signal is sent to the list. If this event occurs, no
18817 * "clicked" event will be sent.
18819 * @see elm_genlist_longpress_timeout_set()
18823 EAPI void elm_genlist_longpress_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
18825 * Get the timeout in seconds for the longpress event.
18827 * @param obj The genlist object
18828 * @return timeout in seconds
18830 * @see elm_genlist_longpress_timeout_get()
18834 EAPI double elm_genlist_longpress_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18836 * Append a new item in a given genlist widget.
18838 * @param obj The genlist object
18839 * @param itc The item class for the item
18840 * @param data The item data
18841 * @param parent The parent item, or NULL if none
18842 * @param flags Item flags
18843 * @param func Convenience function called when the item is selected
18844 * @param func_data Data passed to @p func above.
18845 * @return A handle to the item added or @c NULL if not possible
18847 * This adds the given item to the end of the list or the end of
18848 * the children list if the @p parent is given.
18850 * @see elm_genlist_item_prepend()
18851 * @see elm_genlist_item_insert_before()
18852 * @see elm_genlist_item_insert_after()
18853 * @see elm_genlist_item_del()
18857 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);
18859 * Prepend a new item in a given genlist widget.
18861 * @param obj The genlist object
18862 * @param itc The item class for the item
18863 * @param data The item data
18864 * @param parent The parent item, or NULL if none
18865 * @param flags Item flags
18866 * @param func Convenience function called when the item is selected
18867 * @param func_data Data passed to @p func above.
18868 * @return A handle to the item added or NULL if not possible
18870 * This adds an item to the beginning of the list or beginning of the
18871 * children of the parent if given.
18873 * @see elm_genlist_item_append()
18874 * @see elm_genlist_item_insert_before()
18875 * @see elm_genlist_item_insert_after()
18876 * @see elm_genlist_item_del()
18880 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);
18882 * Insert an item before another in a genlist widget
18884 * @param obj The genlist object
18885 * @param itc The item class for the item
18886 * @param data The item data
18887 * @param before The item to place this new one before.
18888 * @param flags Item flags
18889 * @param func Convenience function called when the item is selected
18890 * @param func_data Data passed to @p func above.
18891 * @return A handle to the item added or @c NULL if not possible
18893 * This inserts an item before another in the list. It will be in the
18894 * same tree level or group as the item it is inserted before.
18896 * @see elm_genlist_item_append()
18897 * @see elm_genlist_item_prepend()
18898 * @see elm_genlist_item_insert_after()
18899 * @see elm_genlist_item_del()
18903 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);
18905 * Insert an item after another in a genlist widget
18907 * @param obj The genlist object
18908 * @param itc The item class for the item
18909 * @param data The item data
18910 * @param after The item to place this new one after.
18911 * @param flags Item flags
18912 * @param func Convenience function called when the item is selected
18913 * @param func_data Data passed to @p func above.
18914 * @return A handle to the item added or @c NULL if not possible
18916 * This inserts an item after another in the list. It will be in the
18917 * same tree level or group as the item it is inserted after.
18919 * @see elm_genlist_item_append()
18920 * @see elm_genlist_item_prepend()
18921 * @see elm_genlist_item_insert_before()
18922 * @see elm_genlist_item_del()
18926 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);
18928 * Insert a new item into the sorted genlist object
18930 * @param obj The genlist object
18931 * @param itc The item class for the item
18932 * @param data The item data
18933 * @param parent The parent item, or NULL if none
18934 * @param flags Item flags
18935 * @param comp The function called for the sort
18936 * @param func Convenience function called when item selected
18937 * @param func_data Data passed to @p func above.
18938 * @return A handle to the item added or NULL if not possible
18942 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);
18943 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);
18944 /* operations to retrieve existing items */
18946 * Get the selectd item in the genlist.
18948 * @param obj The genlist object
18949 * @return The selected item, or NULL if none is selected.
18951 * This gets the selected item in the list (if multi-selection is enabled, only
18952 * the item that was first selected in the list is returned - which is not very
18953 * useful, so see elm_genlist_selected_items_get() for when multi-selection is
18956 * If no item is selected, NULL is returned.
18958 * @see elm_genlist_selected_items_get()
18962 EAPI Elm_Genlist_Item *elm_genlist_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18964 * Get a list of selected items in the genlist.
18966 * @param obj The genlist object
18967 * @return The list of selected items, or NULL if none are selected.
18969 * It returns a list of the selected items. This list pointer is only valid so
18970 * long as the selection doesn't change (no items are selected or unselected, or
18971 * unselected implicitly by deletion). The list contains Elm_Genlist_Item
18972 * pointers. The order of the items in this list is the order which they were
18973 * selected, i.e. the first item in this list is the first item that was
18974 * selected, and so on.
18976 * @note If not in multi-select mode, consider using function
18977 * elm_genlist_selected_item_get() instead.
18979 * @see elm_genlist_multi_select_set()
18980 * @see elm_genlist_selected_item_get()
18984 EAPI const Eina_List *elm_genlist_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18986 * Get the mode item style of items in the genlist
18987 * @param obj The genlist object
18988 * @return The mode item style string, or NULL if none is specified
18990 * This is a constant string and simply defines the name of the
18991 * style that will be used for mode animations. It can be
18992 * @c NULL if you don't plan to use Genlist mode. See
18993 * elm_genlist_item_mode_set() for more info.
18997 EAPI const char *elm_genlist_mode_item_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18999 * Set the mode item style of items in the genlist
19000 * @param obj The genlist object
19001 * @param style The mode item style string, or NULL if none is desired
19003 * This is a constant string and simply defines the name of the
19004 * style that will be used for mode animations. It can be
19005 * @c NULL if you don't plan to use Genlist mode. See
19006 * elm_genlist_item_mode_set() for more info.
19010 EAPI void elm_genlist_mode_item_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
19012 * Get a list of realized items in genlist
19014 * @param obj The genlist object
19015 * @return The list of realized items, nor NULL if none are realized.
19017 * This returns a list of the realized items in the genlist. The list
19018 * contains Elm_Genlist_Item pointers. The list must be freed by the
19019 * caller when done with eina_list_free(). The item pointers in the
19020 * list are only valid so long as those items are not deleted or the
19021 * genlist is not deleted.
19023 * @see elm_genlist_realized_items_update()
19027 EAPI Eina_List *elm_genlist_realized_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19029 * Get the item that is at the x, y canvas coords.
19031 * @param obj The gelinst object.
19032 * @param x The input x coordinate
19033 * @param y The input y coordinate
19034 * @param posret The position relative to the item returned here
19035 * @return The item at the coordinates or NULL if none
19037 * This returns the item at the given coordinates (which are canvas
19038 * relative, not object-relative). If an item is at that coordinate,
19039 * that item handle is returned, and if @p posret is not NULL, the
19040 * integer pointed to is set to a value of -1, 0 or 1, depending if
19041 * the coordinate is on the upper portion of that item (-1), on the
19042 * middle section (0) or on the lower part (1). If NULL is returned as
19043 * an item (no item found there), then posret may indicate -1 or 1
19044 * based if the coordinate is above or below all items respectively in
19049 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);
19051 * Get the first item in the genlist
19053 * This returns the first item in the list.
19055 * @param obj The genlist object
19056 * @return The first item, or NULL if none
19060 EAPI Elm_Genlist_Item *elm_genlist_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19062 * Get the last item in the genlist
19064 * This returns the last item in the list.
19066 * @return The last item, or NULL if none
19070 EAPI Elm_Genlist_Item *elm_genlist_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19072 * Set the scrollbar policy
19074 * @param obj The genlist object
19075 * @param policy_h Horizontal scrollbar policy.
19076 * @param policy_v Vertical scrollbar policy.
19078 * This sets the scrollbar visibility policy for the given genlist
19079 * scroller. #ELM_SMART_SCROLLER_POLICY_AUTO means the scrollbar is
19080 * made visible if it is needed, and otherwise kept hidden.
19081 * #ELM_SMART_SCROLLER_POLICY_ON turns it on all the time, and
19082 * #ELM_SMART_SCROLLER_POLICY_OFF always keeps it off. This applies
19083 * respectively for the horizontal and vertical scrollbars. Default is
19084 * #ELM_SMART_SCROLLER_POLICY_AUTO
19086 * @see elm_genlist_scroller_policy_get()
19090 EAPI void elm_genlist_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
19092 * Get the scrollbar policy
19094 * @param obj The genlist object
19095 * @param policy_h Pointer to store the horizontal scrollbar policy.
19096 * @param policy_v Pointer to store the vertical scrollbar policy.
19098 * @see elm_genlist_scroller_policy_set()
19102 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);
19104 * Get the @b next item in a genlist widget's internal list of items,
19105 * given a handle to one of those items.
19107 * @param item The genlist item to fetch next from
19108 * @return The item after @p item, or @c NULL if there's none (and
19111 * This returns the item placed after the @p item, on the container
19114 * @see elm_genlist_item_prev_get()
19118 EAPI Elm_Genlist_Item *elm_genlist_item_next_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19120 * Get the @b previous item in a genlist widget's internal list of items,
19121 * given a handle to one of those items.
19123 * @param item The genlist item to fetch previous from
19124 * @return The item before @p item, or @c NULL if there's none (and
19127 * This returns the item placed before the @p item, on the container
19130 * @see elm_genlist_item_next_get()
19134 EAPI Elm_Genlist_Item *elm_genlist_item_prev_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19136 * Get the genlist object's handle which contains a given genlist
19139 * @param item The item to fetch the container from
19140 * @return The genlist (parent) object
19142 * This returns the genlist object itself that an item belongs to.
19146 EAPI Evas_Object *elm_genlist_item_genlist_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19148 * Get the parent item of the given item
19150 * @param it The item
19151 * @return The parent of the item or @c NULL if it has no parent.
19153 * This returns the item that was specified as parent of the item @p it on
19154 * elm_genlist_item_append() and insertion related functions.
19158 EAPI Elm_Genlist_Item *elm_genlist_item_parent_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19160 * Remove all sub-items (children) of the given item
19162 * @param it The item
19164 * This removes all items that are children (and their descendants) of the
19165 * given item @p it.
19167 * @see elm_genlist_clear()
19168 * @see elm_genlist_item_del()
19172 EAPI void elm_genlist_item_subitems_clear(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19174 * Set whether a given genlist item is selected or not
19176 * @param it The item
19177 * @param selected Use @c EINA_TRUE, to make it selected, @c
19178 * EINA_FALSE to make it unselected
19180 * This sets the selected state of an item. If multi selection is
19181 * not enabled on the containing genlist and @p selected is @c
19182 * EINA_TRUE, any other previously selected items will get
19183 * unselected in favor of this new one.
19185 * @see elm_genlist_item_selected_get()
19189 EAPI void elm_genlist_item_selected_set(Elm_Genlist_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
19191 * Get whether a given genlist item is selected or not
19193 * @param it The item
19194 * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
19196 * @see elm_genlist_item_selected_set() for more details
19200 EAPI Eina_Bool elm_genlist_item_selected_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19202 * Sets the expanded state of an item.
19204 * @param it The item
19205 * @param expanded The expanded state (@c EINA_TRUE expanded, @c EINA_FALSE not expanded).
19207 * This function flags the item of type #ELM_GENLIST_ITEM_SUBITEMS as
19210 * The theme will respond to this change visually, and a signal "expanded" or
19211 * "contracted" will be sent from the genlist with a pointer to the item that
19212 * has been expanded/contracted.
19214 * Calling this function won't show or hide any child of this item (if it is
19215 * a parent). You must manually delete and create them on the callbacks fo
19216 * the "expanded" or "contracted" signals.
19218 * @see elm_genlist_item_expanded_get()
19222 EAPI void elm_genlist_item_expanded_set(Elm_Genlist_Item *item, Eina_Bool expanded) EINA_ARG_NONNULL(1);
19224 * Get the expanded state of an item
19226 * @param it The item
19227 * @return The expanded state
19229 * This gets the expanded state of an item.
19231 * @see elm_genlist_item_expanded_set()
19235 EAPI Eina_Bool elm_genlist_item_expanded_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19237 * Get the depth of expanded item
19239 * @param it The genlist item object
19240 * @return The depth of expanded item
19244 EAPI int elm_genlist_item_expanded_depth_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19246 * Set whether a given genlist item is disabled or not.
19248 * @param it The item
19249 * @param disabled Use @c EINA_TRUE, true disable it, @c EINA_FALSE
19250 * to enable it back.
19252 * A disabled item cannot be selected or unselected. It will also
19253 * change its appearance, to signal the user it's disabled.
19255 * @see elm_genlist_item_disabled_get()
19259 EAPI void elm_genlist_item_disabled_set(Elm_Genlist_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
19261 * Get whether a given genlist item is disabled or not.
19263 * @param it The item
19264 * @return @c EINA_TRUE, if it's disabled, @c EINA_FALSE otherwise
19267 * @see elm_genlist_item_disabled_set() for more details
19271 EAPI Eina_Bool elm_genlist_item_disabled_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19273 * Sets the display only state of an item.
19275 * @param it The item
19276 * @param display_only @c EINA_TRUE if the item is display only, @c
19277 * EINA_FALSE otherwise.
19279 * A display only item cannot be selected or unselected. It is for
19280 * display only and not selecting or otherwise clicking, dragging
19281 * etc. by the user, thus finger size rules will not be applied to
19284 * It's good to set group index items to display only state.
19286 * @see elm_genlist_item_display_only_get()
19290 EAPI void elm_genlist_item_display_only_set(Elm_Genlist_Item *it, Eina_Bool display_only) EINA_ARG_NONNULL(1);
19292 * Get the display only state of an item
19294 * @param it The item
19295 * @return @c EINA_TRUE if the item is display only, @c
19296 * EINA_FALSE otherwise.
19298 * @see elm_genlist_item_display_only_set()
19302 EAPI Eina_Bool elm_genlist_item_display_only_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19304 * Show the portion of a genlist's internal list containing a given
19305 * item, immediately.
19307 * @param it The item to display
19309 * This causes genlist to jump to the given item @p it and show it (by
19310 * immediately scrolling to that position), if it is not fully visible.
19312 * @see elm_genlist_item_bring_in()
19313 * @see elm_genlist_item_top_show()
19314 * @see elm_genlist_item_middle_show()
19318 EAPI void elm_genlist_item_show(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19320 * Animatedly bring in, to the visible are of a genlist, a given
19323 * @param it The item to display
19325 * This causes genlist to jump to the given item @p it and show it (by
19326 * animatedly scrolling), if it is not fully visible. This may use animation
19327 * to do so and take a period of time
19329 * @see elm_genlist_item_show()
19330 * @see elm_genlist_item_top_bring_in()
19331 * @see elm_genlist_item_middle_bring_in()
19335 EAPI void elm_genlist_item_bring_in(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19337 * Show the portion of a genlist's internal list containing a given
19338 * item, immediately.
19340 * @param it The item to display
19342 * This causes genlist to jump to the given item @p it and show it (by
19343 * immediately scrolling to that position), if it is not fully visible.
19345 * The item will be positioned at the top of the genlist viewport.
19347 * @see elm_genlist_item_show()
19348 * @see elm_genlist_item_top_bring_in()
19352 EAPI void elm_genlist_item_top_show(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19354 * Animatedly bring in, to the visible are of a genlist, a given
19357 * @param it The item
19359 * This causes genlist to jump to the given item @p it and show it (by
19360 * animatedly scrolling), if it is not fully visible. This may use animation
19361 * to do so and take a period of time
19363 * The item will be positioned at the top of the genlist viewport.
19365 * @see elm_genlist_item_bring_in()
19366 * @see elm_genlist_item_top_show()
19370 EAPI void elm_genlist_item_top_bring_in(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19372 * Show the portion of a genlist's internal list containing a given
19373 * item, immediately.
19375 * @param it The item to display
19377 * This causes genlist to jump to the given item @p it and show it (by
19378 * immediately scrolling to that position), if it is not fully visible.
19380 * The item will be positioned at the middle of the genlist viewport.
19382 * @see elm_genlist_item_show()
19383 * @see elm_genlist_item_middle_bring_in()
19387 EAPI void elm_genlist_item_middle_show(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19389 * Animatedly bring in, to the visible are of a genlist, a given
19392 * @param it The item
19394 * This causes genlist to jump to the given item @p it and show it (by
19395 * animatedly scrolling), if it is not fully visible. This may use animation
19396 * to do so and take a period of time
19398 * The item will be positioned at the middle of the genlist viewport.
19400 * @see elm_genlist_item_bring_in()
19401 * @see elm_genlist_item_middle_show()
19405 EAPI void elm_genlist_item_middle_bring_in(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19407 * Remove a genlist item from the its parent, deleting it.
19409 * @param item The item to be removed.
19410 * @return @c EINA_TRUE on success or @c EINA_FALSE, otherwise.
19412 * @see elm_genlist_clear(), to remove all items in a genlist at
19417 EAPI void elm_genlist_item_del(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19419 * Return the data associated to a given genlist item
19421 * @param item The genlist item.
19422 * @return the data associated to this item.
19424 * This returns the @c data value passed on the
19425 * elm_genlist_item_append() and related item addition calls.
19427 * @see elm_genlist_item_append()
19428 * @see elm_genlist_item_data_set()
19432 EAPI void *elm_genlist_item_data_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19434 * Set the data associated to a given genlist item
19436 * @param item The genlist item
19437 * @param data The new data pointer to set on it
19439 * This @b overrides the @c data value passed on the
19440 * elm_genlist_item_append() and related item addition calls. This
19441 * function @b won't call elm_genlist_item_update() automatically,
19442 * so you'd issue it afterwards if you want to hove the item
19443 * updated to reflect the that new data.
19445 * @see elm_genlist_item_data_get()
19449 EAPI void elm_genlist_item_data_set(Elm_Genlist_Item *it, const void *data) EINA_ARG_NONNULL(1);
19451 * Tells genlist to "orphan" icons fetchs by the item class
19453 * @param it The item
19455 * This instructs genlist to release references to icons in the item,
19456 * meaning that they will no longer be managed by genlist and are
19457 * floating "orphans" that can be re-used elsewhere if the user wants
19462 EAPI void elm_genlist_item_contents_orphan(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19463 EINA_DEPRECATED EAPI void elm_genlist_item_icons_orphan(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19465 * Get the real Evas object created to implement the view of a
19466 * given genlist item
19468 * @param item The genlist item.
19469 * @return the Evas object implementing this item's view.
19471 * This returns the actual Evas object used to implement the
19472 * specified genlist item's view. This may be @c NULL, as it may
19473 * not have been created or may have been deleted, at any time, by
19474 * the genlist. <b>Do not modify this object</b> (move, resize,
19475 * show, hide, etc.), as the genlist is controlling it. This
19476 * function is for querying, emitting custom signals or hooking
19477 * lower level callbacks for events on that object. Do not delete
19478 * this object under any circumstances.
19480 * @see elm_genlist_item_data_get()
19484 EAPI const Evas_Object *elm_genlist_item_object_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19486 * Update the contents of an item
19488 * @param it The item
19490 * This updates an item by calling all the item class functions again
19491 * to get the icons, labels and states. Use this when the original
19492 * item data has changed and the changes are desired to be reflected.
19494 * Use elm_genlist_realized_items_update() to update all already realized
19497 * @see elm_genlist_realized_items_update()
19501 EAPI void elm_genlist_item_update(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19503 * Promote an item to the top of the list
19505 * @param it The item
19509 EAPI void elm_genlist_item_promote(Elm_Gen_Item *it) EINA_ARG_NONNULL(1);
19511 * Demote an item to the end of the list
19513 * @param it The item
19517 EAPI void elm_genlist_item_demote(Elm_Gen_Item *it) EINA_ARG_NONNULL(1);
19519 * Update the part of an item
19521 * @param it The item
19522 * @param parts The name of item's part
19523 * @param itf The flags of item's part type
19525 * This updates an item's part by calling item's fetching functions again
19526 * to get the icons, labels and states. Use this when the original
19527 * item data has changed and the changes are desired to be reflected.
19528 * Second parts argument is used for globbing to match '*', '?', and '.'
19529 * It can be used at updating multi fields.
19531 * Use elm_genlist_realized_items_update() to update an item's all
19534 * @see elm_genlist_item_update()
19538 EAPI void elm_genlist_item_fields_update(Elm_Genlist_Item *it, const char *parts, Elm_Genlist_Item_Field_Flags itf) EINA_ARG_NONNULL(1);
19540 * Update the item class of an item
19542 * @param it The item
19543 * @param itc The item class for the item
19545 * This sets another class fo the item, changing the way that it is
19546 * displayed. After changing the item class, elm_genlist_item_update() is
19547 * called on the item @p it.
19551 EAPI void elm_genlist_item_item_class_update(Elm_Genlist_Item *it, const Elm_Genlist_Item_Class *itc) EINA_ARG_NONNULL(1, 2);
19552 EAPI const Elm_Genlist_Item_Class *elm_genlist_item_item_class_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19554 * Set the text to be shown in a given genlist item's tooltips.
19556 * @param item The genlist item
19557 * @param text The text to set in the content
19559 * This call will setup the text to be used as tooltip to that item
19560 * (analogous to elm_object_tooltip_text_set(), but being item
19561 * tooltips with higher precedence than object tooltips). It can
19562 * have only one tooltip at a time, so any previous tooltip data
19563 * will get removed.
19565 * In order to set an icon or something else as a tooltip, look at
19566 * elm_genlist_item_tooltip_content_cb_set().
19570 EAPI void elm_genlist_item_tooltip_text_set(Elm_Genlist_Item *item, const char *text) EINA_ARG_NONNULL(1);
19572 * Set the content to be shown in a given genlist item's tooltips
19574 * @param item The genlist item.
19575 * @param func The function returning the tooltip contents.
19576 * @param data What to provide to @a func as callback data/context.
19577 * @param del_cb Called when data is not needed anymore, either when
19578 * another callback replaces @p func, the tooltip is unset with
19579 * elm_genlist_item_tooltip_unset() or the owner @p item
19580 * dies. This callback receives as its first parameter the
19581 * given @p data, being @c event_info the item handle.
19583 * This call will setup the tooltip's contents to @p item
19584 * (analogous to elm_object_tooltip_content_cb_set(), but being
19585 * item tooltips with higher precedence than object tooltips). It
19586 * can have only one tooltip at a time, so any previous tooltip
19587 * content will get removed. @p func (with @p data) will be called
19588 * every time Elementary needs to show the tooltip and it should
19589 * return a valid Evas object, which will be fully managed by the
19590 * tooltip system, getting deleted when the tooltip is gone.
19592 * In order to set just a text as a tooltip, look at
19593 * elm_genlist_item_tooltip_text_set().
19597 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);
19599 * Unset a tooltip from a given genlist item
19601 * @param item genlist item to remove a previously set tooltip from.
19603 * This call removes any tooltip set on @p item. The callback
19604 * provided as @c del_cb to
19605 * elm_genlist_item_tooltip_content_cb_set() will be called to
19606 * notify it is not used anymore (and have resources cleaned, if
19609 * @see elm_genlist_item_tooltip_content_cb_set()
19613 EAPI void elm_genlist_item_tooltip_unset(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19615 * Set a different @b style for a given genlist item's tooltip.
19617 * @param item genlist item with tooltip set
19618 * @param style the <b>theme style</b> to use on tooltips (e.g. @c
19619 * "default", @c "transparent", etc)
19621 * Tooltips can have <b>alternate styles</b> to be displayed on,
19622 * which are defined by the theme set on Elementary. This function
19623 * works analogously as elm_object_tooltip_style_set(), but here
19624 * applied only to genlist item objects. The default style for
19625 * tooltips is @c "default".
19627 * @note before you set a style you should define a tooltip with
19628 * elm_genlist_item_tooltip_content_cb_set() or
19629 * elm_genlist_item_tooltip_text_set()
19631 * @see elm_genlist_item_tooltip_style_get()
19635 EAPI void elm_genlist_item_tooltip_style_set(Elm_Genlist_Item *item, const char *style) EINA_ARG_NONNULL(1);
19637 * Get the style set a given genlist item's tooltip.
19639 * @param item genlist item with tooltip already set on.
19640 * @return style the theme style in use, which defaults to
19641 * "default". If the object does not have a tooltip set,
19642 * then @c NULL is returned.
19644 * @see elm_genlist_item_tooltip_style_set() for more details
19648 EAPI const char *elm_genlist_item_tooltip_style_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19650 * @brief Disable size restrictions on an object's tooltip
19651 * @param item The tooltip's anchor object
19652 * @param disable If EINA_TRUE, size restrictions are disabled
19653 * @return EINA_FALSE on failure, EINA_TRUE on success
19655 * This function allows a tooltip to expand beyond its parant window's canvas.
19656 * It will instead be limited only by the size of the display.
19658 EAPI Eina_Bool elm_genlist_item_tooltip_size_restrict_disable(Elm_Genlist_Item *item, Eina_Bool disable);
19660 * @brief Retrieve size restriction state of an object's tooltip
19661 * @param item The tooltip's anchor object
19662 * @return If EINA_TRUE, size restrictions are disabled
19664 * This function returns whether a tooltip is allowed to expand beyond
19665 * its parant window's canvas.
19666 * It will instead be limited only by the size of the display.
19668 EAPI Eina_Bool elm_genlist_item_tooltip_size_restrict_disabled_get(const Elm_Genlist_Item *item);
19670 * Set the type of mouse pointer/cursor decoration to be shown,
19671 * when the mouse pointer is over the given genlist widget item
19673 * @param item genlist item to customize cursor on
19674 * @param cursor the cursor type's name
19676 * This function works analogously as elm_object_cursor_set(), but
19677 * here the cursor's changing area is restricted to the item's
19678 * area, and not the whole widget's. Note that that item cursors
19679 * have precedence over widget cursors, so that a mouse over @p
19680 * item will always show cursor @p type.
19682 * If this function is called twice for an object, a previously set
19683 * cursor will be unset on the second call.
19685 * @see elm_object_cursor_set()
19686 * @see elm_genlist_item_cursor_get()
19687 * @see elm_genlist_item_cursor_unset()
19691 EAPI void elm_genlist_item_cursor_set(Elm_Genlist_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
19693 * Get the type of mouse pointer/cursor decoration set to be shown,
19694 * when the mouse pointer is over the given genlist widget item
19696 * @param item genlist item with custom cursor set
19697 * @return the cursor type's name or @c NULL, if no custom cursors
19698 * were set to @p item (and on errors)
19700 * @see elm_object_cursor_get()
19701 * @see elm_genlist_item_cursor_set() for more details
19702 * @see elm_genlist_item_cursor_unset()
19706 EAPI const char *elm_genlist_item_cursor_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19708 * Unset any custom mouse pointer/cursor decoration set to be
19709 * shown, when the mouse pointer is over the given genlist widget
19710 * item, thus making it show the @b default cursor again.
19712 * @param item a genlist item
19714 * Use this call to undo any custom settings on this item's cursor
19715 * decoration, bringing it back to defaults (no custom style set).
19717 * @see elm_object_cursor_unset()
19718 * @see elm_genlist_item_cursor_set() for more details
19722 EAPI void elm_genlist_item_cursor_unset(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19724 * Set a different @b style for a given custom cursor set for a
19727 * @param item genlist item with custom cursor set
19728 * @param style the <b>theme style</b> to use (e.g. @c "default",
19729 * @c "transparent", etc)
19731 * This function only makes sense when one is using custom mouse
19732 * cursor decorations <b>defined in a theme file</b> , which can
19733 * have, given a cursor name/type, <b>alternate styles</b> on
19734 * it. It works analogously as elm_object_cursor_style_set(), but
19735 * here applied only to genlist item objects.
19737 * @warning Before you set a cursor style you should have defined a
19738 * custom cursor previously on the item, with
19739 * elm_genlist_item_cursor_set()
19741 * @see elm_genlist_item_cursor_engine_only_set()
19742 * @see elm_genlist_item_cursor_style_get()
19746 EAPI void elm_genlist_item_cursor_style_set(Elm_Genlist_Item *item, const char *style) EINA_ARG_NONNULL(1);
19748 * Get the current @b style set for a given genlist item's custom
19751 * @param item genlist item with custom cursor set.
19752 * @return style the cursor style in use. If the object does not
19753 * have a cursor set, then @c NULL is returned.
19755 * @see elm_genlist_item_cursor_style_set() for more details
19759 EAPI const char *elm_genlist_item_cursor_style_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19761 * Set if the (custom) cursor for a given genlist item should be
19762 * searched in its theme, also, or should only rely on the
19763 * rendering engine.
19765 * @param item item with custom (custom) cursor already set on
19766 * @param engine_only Use @c EINA_TRUE to have cursors looked for
19767 * only on those provided by the rendering engine, @c EINA_FALSE to
19768 * have them searched on the widget's theme, as well.
19770 * @note This call is of use only if you've set a custom cursor
19771 * for genlist items, with elm_genlist_item_cursor_set().
19773 * @note By default, cursors will only be looked for between those
19774 * provided by the rendering engine.
19778 EAPI void elm_genlist_item_cursor_engine_only_set(Elm_Genlist_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
19780 * Get if the (custom) cursor for a given genlist item is being
19781 * searched in its theme, also, or is only relying on the rendering
19784 * @param item a genlist item
19785 * @return @c EINA_TRUE, if cursors are being looked for only on
19786 * those provided by the rendering engine, @c EINA_FALSE if they
19787 * are being searched on the widget's theme, as well.
19789 * @see elm_genlist_item_cursor_engine_only_set(), for more details
19793 EAPI Eina_Bool elm_genlist_item_cursor_engine_only_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19795 * Update the contents of all realized items.
19797 * @param obj The genlist object.
19799 * This updates all realized items by calling all the item class functions again
19800 * to get the icons, labels and states. Use this when the original
19801 * item data has changed and the changes are desired to be reflected.
19803 * To update just one item, use elm_genlist_item_update().
19805 * @see elm_genlist_realized_items_get()
19806 * @see elm_genlist_item_update()
19810 EAPI void elm_genlist_realized_items_update(Evas_Object *obj) EINA_ARG_NONNULL(1);
19812 * Activate a genlist mode on an item
19814 * @param item The genlist item
19815 * @param mode Mode name
19816 * @param mode_set Boolean to define set or unset mode.
19818 * A genlist mode is a different way of selecting an item. Once a mode is
19819 * activated on an item, any other selected item is immediately unselected.
19820 * This feature provides an easy way of implementing a new kind of animation
19821 * for selecting an item, without having to entirely rewrite the item style
19822 * theme. However, the elm_genlist_selected_* API can't be used to get what
19823 * item is activate for a mode.
19825 * The current item style will still be used, but applying a genlist mode to
19826 * an item will select it using a different kind of animation.
19828 * The current active item for a mode can be found by
19829 * elm_genlist_mode_item_get().
19831 * The characteristics of genlist mode are:
19832 * - Only one mode can be active at any time, and for only one item.
19833 * - Genlist handles deactivating other items when one item is activated.
19834 * - A mode is defined in the genlist theme (edc), and more modes can easily
19836 * - A mode style and the genlist item style are different things. They
19837 * can be combined to provide a default style to the item, with some kind
19838 * of animation for that item when the mode is activated.
19840 * When a mode is activated on an item, a new view for that item is created.
19841 * The theme of this mode defines the animation that will be used to transit
19842 * the item from the old view to the new view. This second (new) view will be
19843 * active for that item while the mode is active on the item, and will be
19844 * destroyed after the mode is totally deactivated from that item.
19846 * @see elm_genlist_mode_get()
19847 * @see elm_genlist_mode_item_get()
19851 EAPI void elm_genlist_item_mode_set(Elm_Genlist_Item *it, const char *mode_type, Eina_Bool mode_set) EINA_ARG_NONNULL(1, 2);
19853 * Get the last (or current) genlist mode used.
19855 * @param obj The genlist object
19857 * This function just returns the name of the last used genlist mode. It will
19858 * be the current mode if it's still active.
19860 * @see elm_genlist_item_mode_set()
19861 * @see elm_genlist_mode_item_get()
19865 EAPI const char *elm_genlist_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19867 * Get active genlist mode item
19869 * @param obj The genlist object
19870 * @return The active item for that current mode. Or @c NULL if no item is
19871 * activated with any mode.
19873 * This function returns the item that was activated with a mode, by the
19874 * function elm_genlist_item_mode_set().
19876 * @see elm_genlist_item_mode_set()
19877 * @see elm_genlist_mode_get()
19881 EAPI const Elm_Genlist_Item *elm_genlist_mode_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19886 * @param obj The genlist object
19887 * @param reorder_mode The reorder mode
19888 * (EINA_TRUE = on, EINA_FALSE = off)
19892 EAPI void elm_genlist_reorder_mode_set(Evas_Object *obj, Eina_Bool reorder_mode) EINA_ARG_NONNULL(1);
19895 * Get the reorder mode
19897 * @param obj The genlist object
19898 * @return The reorder mode
19899 * (EINA_TRUE = on, EINA_FALSE = off)
19903 EAPI Eina_Bool elm_genlist_reorder_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19910 * @defgroup Check Check
19912 * @image html img/widget/check/preview-00.png
19913 * @image latex img/widget/check/preview-00.eps
19914 * @image html img/widget/check/preview-01.png
19915 * @image latex img/widget/check/preview-01.eps
19916 * @image html img/widget/check/preview-02.png
19917 * @image latex img/widget/check/preview-02.eps
19919 * @brief The check widget allows for toggling a value between true and
19922 * Check objects are a lot like radio objects in layout and functionality
19923 * except they do not work as a group, but independently and only toggle the
19924 * value of a boolean from false to true (0 or 1). elm_check_state_set() sets
19925 * the boolean state (1 for true, 0 for false), and elm_check_state_get()
19926 * returns the current state. For convenience, like the radio objects, you
19927 * can set a pointer to a boolean directly with elm_check_state_pointer_set()
19928 * for it to modify.
19930 * Signals that you can add callbacks for are:
19931 * "changed" - This is called whenever the user changes the state of one of
19932 * the check object(event_info is NULL).
19934 * Default contents parts of the check widget that you can use for are:
19935 * @li "icon" - A icon of the check
19937 * Default text parts of the check widget that you can use for are:
19938 * @li "elm.text" - Label of the check
19940 * @ref tutorial_check should give you a firm grasp of how to use this widget
19945 * @brief Add a new Check object
19947 * @param parent The parent object
19948 * @return The new object or NULL if it cannot be created
19950 EAPI Evas_Object *elm_check_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
19952 * @brief Set the text label of the check object
19954 * @param obj The check object
19955 * @param label The text label string in UTF-8
19957 * @deprecated use elm_object_text_set() instead.
19959 EINA_DEPRECATED EAPI void elm_check_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
19961 * @brief Get the text label of the check object
19963 * @param obj The check object
19964 * @return The text label string in UTF-8
19966 * @deprecated use elm_object_text_get() instead.
19968 EINA_DEPRECATED EAPI const char *elm_check_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19970 * @brief Set the icon object of the check object
19972 * @param obj The check object
19973 * @param icon The icon object
19975 * Once the icon object is set, a previously set one will be deleted.
19976 * If you want to keep that old content object, use the
19977 * elm_object_content_unset() function.
19979 * @deprecated use elm_object_part_content_set() instead.
19982 EINA_DEPRECATED EAPI void elm_check_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
19984 * @brief Get the icon object of the check object
19986 * @param obj The check object
19987 * @return The icon object
19989 * @deprecated use elm_object_part_content_get() instead.
19992 EINA_DEPRECATED EAPI Evas_Object *elm_check_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19994 * @brief Unset the icon used for the check object
19996 * @param obj The check object
19997 * @return The icon object that was being used
19999 * Unparent and return the icon object which was set for this widget.
20001 * @deprecated use elm_object_part_content_unset() instead.
20004 EINA_DEPRECATED EAPI Evas_Object *elm_check_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
20006 * @brief Set the on/off state of the check object
20008 * @param obj The check object
20009 * @param state The state to use (1 == on, 0 == off)
20011 * This sets the state of the check. If set
20012 * with elm_check_state_pointer_set() the state of that variable is also
20013 * changed. Calling this @b doesn't cause the "changed" signal to be emited.
20015 EAPI void elm_check_state_set(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
20017 * @brief Get the state of the check object
20019 * @param obj The check object
20020 * @return The boolean state
20022 EAPI Eina_Bool elm_check_state_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20024 * @brief Set a convenience pointer to a boolean to change
20026 * @param obj The check object
20027 * @param statep Pointer to the boolean to modify
20029 * This sets a pointer to a boolean, that, in addition to the check objects
20030 * state will also be modified directly. To stop setting the object pointed
20031 * to simply use NULL as the @p statep parameter. If @p statep is not NULL,
20032 * then when this is called, the check objects state will also be modified to
20033 * reflect the value of the boolean @p statep points to, just like calling
20034 * elm_check_state_set().
20036 EAPI void elm_check_state_pointer_set(Evas_Object *obj, Eina_Bool *statep) EINA_ARG_NONNULL(1);
20037 EINA_DEPRECATED EAPI void elm_check_states_labels_set(Evas_Object *obj, const char *ontext, const char *offtext) EINA_ARG_NONNULL(1,2,3);
20038 EINA_DEPRECATED EAPI void elm_check_states_labels_get(const Evas_Object *obj, const char **ontext, const char **offtext) EINA_ARG_NONNULL(1,2,3);
20045 * @defgroup Radio Radio
20047 * @image html img/widget/radio/preview-00.png
20048 * @image latex img/widget/radio/preview-00.eps
20050 * @brief Radio is a widget that allows for 1 or more options to be displayed
20051 * and have the user choose only 1 of them.
20053 * A radio object contains an indicator, an optional Label and an optional
20054 * icon object. While it's possible to have a group of only one radio they,
20055 * are normally used in groups of 2 or more. To add a radio to a group use
20056 * elm_radio_group_add(). The radio object(s) will select from one of a set
20057 * of integer values, so any value they are configuring needs to be mapped to
20058 * a set of integers. To configure what value that radio object represents,
20059 * use elm_radio_state_value_set() to set the integer it represents. To set
20060 * the value the whole group(which one is currently selected) is to indicate
20061 * use elm_radio_value_set() on any group member, and to get the groups value
20062 * use elm_radio_value_get(). For convenience the radio objects are also able
20063 * to directly set an integer(int) to the value that is selected. To specify
20064 * the pointer to this integer to modify, use elm_radio_value_pointer_set().
20065 * The radio objects will modify this directly. That implies the pointer must
20066 * point to valid memory for as long as the radio objects exist.
20068 * Signals that you can add callbacks for are:
20069 * @li changed - This is called whenever the user changes the state of one of
20070 * the radio objects within the group of radio objects that work together.
20072 * Default contents parts of the radio widget that you can use for are:
20073 * @li "icon" - A icon of the radio
20075 * @ref tutorial_radio show most of this API in action.
20079 * @brief Add a new radio to the parent
20081 * @param parent The parent object
20082 * @return The new object or NULL if it cannot be created
20084 EAPI Evas_Object *elm_radio_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20086 * @brief Set the text label of the radio object
20088 * @param obj The radio object
20089 * @param label The text label string in UTF-8
20091 * @deprecated use elm_object_text_set() instead.
20093 EINA_DEPRECATED EAPI void elm_radio_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
20095 * @brief Get the text label of the radio object
20097 * @param obj The radio object
20098 * @return The text label string in UTF-8
20100 * @deprecated use elm_object_text_set() instead.
20102 EINA_DEPRECATED EAPI const char *elm_radio_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20104 * @brief Set the icon object of the radio object
20106 * @param obj The radio object
20107 * @param icon The icon object
20109 * Once the icon object is set, a previously set one will be deleted. If you
20110 * want to keep that old content object, use the elm_radio_icon_unset()
20113 * @deprecated use elm_object_part_content_set() instead.
20116 EINA_DEPRECATED EAPI void elm_radio_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
20118 * @brief Get the icon object of the radio object
20120 * @param obj The radio object
20121 * @return The icon object
20123 * @see elm_radio_icon_set()
20125 * @deprecated use elm_object_part_content_get() instead.
20128 EINA_DEPRECATED EAPI Evas_Object *elm_radio_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20130 * @brief Unset the icon used for the radio object
20132 * @param obj The radio object
20133 * @return The icon object that was being used
20135 * Unparent and return the icon object which was set for this widget.
20137 * @see elm_radio_icon_set()
20138 * @deprecated use elm_object_part_content_unset() instead.
20141 EINA_DEPRECATED EAPI Evas_Object *elm_radio_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
20143 * @brief Add this radio to a group of other radio objects
20145 * @param obj The radio object
20146 * @param group Any object whose group the @p obj is to join.
20148 * Radio objects work in groups. Each member should have a different integer
20149 * value assigned. In order to have them work as a group, they need to know
20150 * about each other. This adds the given radio object to the group of which
20151 * the group object indicated is a member.
20153 EAPI void elm_radio_group_add(Evas_Object *obj, Evas_Object *group) EINA_ARG_NONNULL(1);
20155 * @brief Set the integer value that this radio object represents
20157 * @param obj The radio object
20158 * @param value The value to use if this radio object is selected
20160 * This sets the value of the radio.
20162 EAPI void elm_radio_state_value_set(Evas_Object *obj, int value) EINA_ARG_NONNULL(1);
20164 * @brief Get the integer value that this radio object represents
20166 * @param obj The radio object
20167 * @return The value used if this radio object is selected
20169 * This gets the value of the radio.
20171 * @see elm_radio_value_set()
20173 EAPI int elm_radio_state_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20175 * @brief Set the value of the radio.
20177 * @param obj The radio object
20178 * @param value The value to use for the group
20180 * This sets the value of the radio group and will also set the value if
20181 * pointed to, to the value supplied, but will not call any callbacks.
20183 EAPI void elm_radio_value_set(Evas_Object *obj, int value) EINA_ARG_NONNULL(1);
20185 * @brief Get the state of the radio object
20187 * @param obj The radio object
20188 * @return The integer state
20190 EAPI int elm_radio_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20192 * @brief Set a convenience pointer to a integer to change
20194 * @param obj The radio object
20195 * @param valuep Pointer to the integer to modify
20197 * This sets a pointer to a integer, that, in addition to the radio objects
20198 * state will also be modified directly. To stop setting the object pointed
20199 * to simply use NULL as the @p valuep argument. If valuep is not NULL, then
20200 * when this is called, the radio objects state will also be modified to
20201 * reflect the value of the integer valuep points to, just like calling
20202 * elm_radio_value_set().
20204 EAPI void elm_radio_value_pointer_set(Evas_Object *obj, int *valuep) EINA_ARG_NONNULL(1);
20210 * @defgroup Pager Pager
20212 * @image html img/widget/pager/preview-00.png
20213 * @image latex img/widget/pager/preview-00.eps
20215 * @brief Widget that allows flipping between one or more āpagesā
20218 * The flipping between pages of objects is animated. All content
20219 * in the pager is kept in a stack, being the last content added
20220 * (visible one) on the top of that stack.
20222 * Objects can be pushed or popped from the stack or deleted as
20223 * well. Pushes and pops will animate the widget accordingly to its
20224 * style (a pop will also delete the child object once the
20225 * animation is finished). Any object already in the pager can be
20226 * promoted to the top (from its current stacking position) through
20227 * the use of elm_pager_content_promote(). New objects are pushed
20228 * to the top with elm_pager_content_push(). When the top item is
20229 * no longer wanted, simply pop it with elm_pager_content_pop() and
20230 * it will also be deleted. If an object is no longer needed and is
20231 * not the top item, just delete it as normal. You can query which
20232 * objects are the top and bottom with
20233 * elm_pager_content_bottom_get() and elm_pager_content_top_get().
20235 * Signals that you can add callbacks for are:
20236 * - @c "show,finished" - when a new page is actually shown on the top
20237 * - @c "hide,finished" - when a previous page is hidden
20239 * Only after the first of that signals the child object is
20240 * guaranteed to be visible, as in @c evas_object_visible_get().
20242 * This widget has the following styles available:
20245 * - @c "fade_translucide"
20246 * - @c "fade_invisible"
20248 * @note These styles affect only the flipping animations on the
20249 * default theme; the appearance when not animating is unaffected
20252 * @ref tutorial_pager gives a good overview of the usage of the API.
20257 * Add a new pager to the parent
20259 * @param parent The parent object
20260 * @return The new object or NULL if it cannot be created
20264 EAPI Evas_Object *elm_pager_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20267 * @brief Push an object to the top of the pager stack (and show it).
20269 * @param obj The pager object
20270 * @param content The object to push
20272 * The object pushed becomes a child of the pager, it will be controlled and
20273 * deleted when the pager is deleted.
20275 * @note If the content is already in the stack use
20276 * elm_pager_content_promote().
20277 * @warning Using this function on @p content already in the stack results in
20278 * undefined behavior.
20280 EAPI void elm_pager_content_push(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
20283 * @brief Pop the object that is on top of the stack
20285 * @param obj The pager object
20287 * This pops the object that is on the top(visible) of the pager, makes it
20288 * disappear, then deletes the object. The object that was underneath it on
20289 * the stack will become visible.
20291 EAPI void elm_pager_content_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
20294 * @brief Moves an object already in the pager stack to the top of the stack.
20296 * @param obj The pager object
20297 * @param content The object to promote
20299 * This will take the @p content and move it to the top of the stack as
20300 * if it had been pushed there.
20302 * @note If the content isn't already in the stack use
20303 * elm_pager_content_push().
20304 * @warning Using this function on @p content not already in the stack
20305 * results in undefined behavior.
20307 EAPI void elm_pager_content_promote(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
20310 * @brief Return the object at the bottom of the pager stack
20312 * @param obj The pager object
20313 * @return The bottom object or NULL if none
20315 EAPI Evas_Object *elm_pager_content_bottom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20318 * @brief Return the object at the top of the pager stack
20320 * @param obj The pager object
20321 * @return The top object or NULL if none
20323 EAPI Evas_Object *elm_pager_content_top_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20330 * @defgroup Slideshow Slideshow
20332 * @image html img/widget/slideshow/preview-00.png
20333 * @image latex img/widget/slideshow/preview-00.eps
20335 * This widget, as the name indicates, is a pre-made image
20336 * slideshow panel, with API functions acting on (child) image
20337 * items presentation. Between those actions, are:
20338 * - advance to next/previous image
20339 * - select the style of image transition animation
20340 * - set the exhibition time for each image
20341 * - start/stop the slideshow
20343 * The transition animations are defined in the widget's theme,
20344 * consequently new animations can be added without having to
20345 * update the widget's code.
20347 * @section Slideshow_Items Slideshow items
20349 * For slideshow items, just like for @ref Genlist "genlist" ones,
20350 * the user defines a @b classes, specifying functions that will be
20351 * called on the item's creation and deletion times.
20353 * The #Elm_Slideshow_Item_Class structure contains the following
20356 * - @c func.get - When an item is displayed, this function is
20357 * called, and it's where one should create the item object, de
20358 * facto. For example, the object can be a pure Evas image object
20359 * or an Elementary @ref Photocam "photocam" widget. See
20360 * #SlideshowItemGetFunc.
20361 * - @c func.del - When an item is no more displayed, this function
20362 * is called, where the user must delete any data associated to
20363 * the item. See #SlideshowItemDelFunc.
20365 * @section Slideshow_Caching Slideshow caching
20367 * The slideshow provides facilities to have items adjacent to the
20368 * one being displayed <b>already "realized"</b> (i.e. loaded) for
20369 * you, so that the system does not have to decode image data
20370 * anymore at the time it has to actually switch images on its
20371 * viewport. The user is able to set the numbers of items to be
20372 * cached @b before and @b after the current item, in the widget's
20375 * Smart events one can add callbacks for are:
20377 * - @c "changed" - when the slideshow switches its view to a new
20380 * List of examples for the slideshow widget:
20381 * @li @ref slideshow_example
20385 * @addtogroup Slideshow
20389 typedef struct _Elm_Slideshow_Item_Class Elm_Slideshow_Item_Class; /**< Slideshow item class definition struct */
20390 typedef struct _Elm_Slideshow_Item_Class_Func Elm_Slideshow_Item_Class_Func; /**< Class functions for slideshow item classes. */
20391 typedef struct _Elm_Slideshow_Item Elm_Slideshow_Item; /**< Slideshow item handle */
20392 typedef Evas_Object *(*SlideshowItemGetFunc) (void *data, Evas_Object *obj); /**< Image fetching class function for slideshow item classes. */
20393 typedef void (*SlideshowItemDelFunc) (void *data, Evas_Object *obj); /**< Deletion class function for slideshow item classes. */
20396 * @struct _Elm_Slideshow_Item_Class
20398 * Slideshow item class definition. See @ref Slideshow_Items for
20401 struct _Elm_Slideshow_Item_Class
20403 struct _Elm_Slideshow_Item_Class_Func
20405 SlideshowItemGetFunc get;
20406 SlideshowItemDelFunc del;
20408 }; /**< #Elm_Slideshow_Item_Class member definitions */
20411 * Add a new slideshow widget to the given parent Elementary
20412 * (container) object
20414 * @param parent The parent object
20415 * @return A new slideshow widget handle or @c NULL, on errors
20417 * This function inserts a new slideshow widget on the canvas.
20419 * @ingroup Slideshow
20421 EAPI Evas_Object *elm_slideshow_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20424 * Add (append) a new item in a given slideshow widget.
20426 * @param obj The slideshow object
20427 * @param itc The item class for the item
20428 * @param data The item's data
20429 * @return A handle to the item added or @c NULL, on errors
20431 * Add a new item to @p obj's internal list of items, appending it.
20432 * The item's class must contain the function really fetching the
20433 * image object to show for this item, which could be an Evas image
20434 * object or an Elementary photo, for example. The @p data
20435 * parameter is going to be passed to both class functions of the
20438 * @see #Elm_Slideshow_Item_Class
20439 * @see elm_slideshow_item_sorted_insert()
20441 * @ingroup Slideshow
20443 EAPI Elm_Slideshow_Item *elm_slideshow_item_add(Evas_Object *obj, const Elm_Slideshow_Item_Class *itc, const void *data) EINA_ARG_NONNULL(1);
20446 * Insert a new item into the given slideshow widget, using the @p func
20447 * function to sort items (by item handles).
20449 * @param obj The slideshow object
20450 * @param itc The item class for the item
20451 * @param data The item's data
20452 * @param func The comparing function to be used to sort slideshow
20453 * items <b>by #Elm_Slideshow_Item item handles</b>
20454 * @return Returns The slideshow item handle, on success, or
20455 * @c NULL, on errors
20457 * Add a new item to @p obj's internal list of items, in a position
20458 * determined by the @p func comparing function. The item's class
20459 * must contain the function really fetching the image object to
20460 * show for this item, which could be an Evas image object or an
20461 * Elementary photo, for example. The @p data parameter is going to
20462 * be passed to both class functions of the item.
20464 * @see #Elm_Slideshow_Item_Class
20465 * @see elm_slideshow_item_add()
20467 * @ingroup Slideshow
20469 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);
20472 * Display a given slideshow widget's item, programmatically.
20474 * @param obj The slideshow object
20475 * @param item The item to display on @p obj's viewport
20477 * The change between the current item and @p item will use the
20478 * transition @p obj is set to use (@see
20479 * elm_slideshow_transition_set()).
20481 * @ingroup Slideshow
20483 EAPI void elm_slideshow_show(Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
20486 * Slide to the @b next item, in a given slideshow widget
20488 * @param obj The slideshow object
20490 * The sliding animation @p obj is set to use will be the
20491 * transition effect used, after this call is issued.
20493 * @note If the end of the slideshow's internal list of items is
20494 * reached, it'll wrap around to the list's beginning, again.
20496 * @ingroup Slideshow
20498 EAPI void elm_slideshow_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
20501 * Slide to the @b previous item, in a given slideshow widget
20503 * @param obj The slideshow object
20505 * The sliding animation @p obj is set to use will be the
20506 * transition effect used, after this call is issued.
20508 * @note If the beginning of the slideshow's internal list of items
20509 * is reached, it'll wrap around to the list's end, again.
20511 * @ingroup Slideshow
20513 EAPI void elm_slideshow_previous(Evas_Object *obj) EINA_ARG_NONNULL(1);
20516 * Returns the list of sliding transition/effect names available, for a
20517 * given slideshow widget.
20519 * @param obj The slideshow object
20520 * @return The list of transitions (list of @b stringshared strings
20523 * The transitions, which come from @p obj's theme, must be an EDC
20524 * data item named @c "transitions" on the theme file, with (prefix)
20525 * names of EDC programs actually implementing them.
20527 * The available transitions for slideshows on the default theme are:
20528 * - @c "fade" - the current item fades out, while the new one
20529 * fades in to the slideshow's viewport.
20530 * - @c "black_fade" - the current item fades to black, and just
20531 * then, the new item will fade in.
20532 * - @c "horizontal" - the current item slides horizontally, until
20533 * it gets out of the slideshow's viewport, while the new item
20534 * comes from the left to take its place.
20535 * - @c "vertical" - the current item slides vertically, until it
20536 * gets out of the slideshow's viewport, while the new item comes
20537 * from the bottom to take its place.
20538 * - @c "square" - the new item starts to appear from the middle of
20539 * the current one, but with a tiny size, growing until its
20540 * target (full) size and covering the old one.
20542 * @warning The stringshared strings get no new references
20543 * exclusive to the user grabbing the list, here, so if you'd like
20544 * to use them out of this call's context, you'd better @c
20545 * eina_stringshare_ref() them.
20547 * @see elm_slideshow_transition_set()
20549 * @ingroup Slideshow
20551 EAPI const Eina_List *elm_slideshow_transitions_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20554 * Set the current slide transition/effect in use for a given
20557 * @param obj The slideshow object
20558 * @param transition The new transition's name string
20560 * If @p transition is implemented in @p obj's theme (i.e., is
20561 * contained in the list returned by
20562 * elm_slideshow_transitions_get()), this new sliding effect will
20563 * be used on the widget.
20565 * @see elm_slideshow_transitions_get() for more details
20567 * @ingroup Slideshow
20569 EAPI void elm_slideshow_transition_set(Evas_Object *obj, const char *transition) EINA_ARG_NONNULL(1);
20572 * Get the current slide transition/effect in use for a given
20575 * @param obj The slideshow object
20576 * @return The current transition's name
20578 * @see elm_slideshow_transition_set() for more details
20580 * @ingroup Slideshow
20582 EAPI const char *elm_slideshow_transition_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20585 * Set the interval between each image transition on a given
20586 * slideshow widget, <b>and start the slideshow, itself</b>
20588 * @param obj The slideshow object
20589 * @param timeout The new displaying timeout for images
20591 * After this call, the slideshow widget will start cycling its
20592 * view, sequentially and automatically, with the images of the
20593 * items it has. The time between each new image displayed is going
20594 * to be @p timeout, in @b seconds. If a different timeout was set
20595 * previously and an slideshow was in progress, it will continue
20596 * with the new time between transitions, after this call.
20598 * @note A value less than or equal to 0 on @p timeout will disable
20599 * the widget's internal timer, thus halting any slideshow which
20600 * could be happening on @p obj.
20602 * @see elm_slideshow_timeout_get()
20604 * @ingroup Slideshow
20606 EAPI void elm_slideshow_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
20609 * Get the interval set for image transitions on a given slideshow
20612 * @param obj The slideshow object
20613 * @return Returns the timeout set on it
20615 * @see elm_slideshow_timeout_set() for more details
20617 * @ingroup Slideshow
20619 EAPI double elm_slideshow_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20622 * Set if, after a slideshow is started, for a given slideshow
20623 * widget, its items should be displayed cyclically or not.
20625 * @param obj The slideshow object
20626 * @param loop Use @c EINA_TRUE to make it cycle through items or
20627 * @c EINA_FALSE for it to stop at the end of @p obj's internal
20630 * @note elm_slideshow_next() and elm_slideshow_previous() will @b
20631 * ignore what is set by this functions, i.e., they'll @b always
20632 * cycle through items. This affects only the "automatic"
20633 * slideshow, as set by elm_slideshow_timeout_set().
20635 * @see elm_slideshow_loop_get()
20637 * @ingroup Slideshow
20639 EAPI void elm_slideshow_loop_set(Evas_Object *obj, Eina_Bool loop) EINA_ARG_NONNULL(1);
20642 * Get if, after a slideshow is started, for a given slideshow
20643 * widget, its items are to be displayed cyclically or not.
20645 * @param obj The slideshow object
20646 * @return @c EINA_TRUE, if the items in @p obj will be cycled
20647 * through or @c EINA_FALSE, otherwise
20649 * @see elm_slideshow_loop_set() for more details
20651 * @ingroup Slideshow
20653 EAPI Eina_Bool elm_slideshow_loop_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20656 * Remove all items from a given slideshow widget
20658 * @param obj The slideshow object
20660 * This removes (and deletes) all items in @p obj, leaving it
20663 * @see elm_slideshow_item_del(), to remove just one item.
20665 * @ingroup Slideshow
20667 EAPI void elm_slideshow_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
20670 * Get the internal list of items in a given slideshow widget.
20672 * @param obj The slideshow object
20673 * @return The list of items (#Elm_Slideshow_Item as data) or
20674 * @c NULL on errors.
20676 * This list is @b not to be modified in any way and must not be
20677 * freed. Use the list members with functions like
20678 * elm_slideshow_item_del(), elm_slideshow_item_data_get().
20680 * @warning This list is only valid until @p obj object's internal
20681 * items list is changed. It should be fetched again with another
20682 * call to this function when changes happen.
20684 * @ingroup Slideshow
20686 EAPI const Eina_List *elm_slideshow_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20689 * Delete a given item from a slideshow widget.
20691 * @param item The slideshow item
20693 * @ingroup Slideshow
20695 EAPI void elm_slideshow_item_del(Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
20698 * Return the data associated with a given slideshow item
20700 * @param item The slideshow item
20701 * @return Returns the data associated to this item
20703 * @ingroup Slideshow
20705 EAPI void *elm_slideshow_item_data_get(const Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
20708 * Returns the currently displayed item, in a given slideshow widget
20710 * @param obj The slideshow object
20711 * @return A handle to the item being displayed in @p obj or
20712 * @c NULL, if none is (and on errors)
20714 * @ingroup Slideshow
20716 EAPI Elm_Slideshow_Item *elm_slideshow_item_current_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20719 * Get the real Evas object created to implement the view of a
20720 * given slideshow item
20722 * @param item The slideshow item.
20723 * @return the Evas object implementing this item's view.
20725 * This returns the actual Evas object used to implement the
20726 * specified slideshow item's view. This may be @c NULL, as it may
20727 * not have been created or may have been deleted, at any time, by
20728 * the slideshow. <b>Do not modify this object</b> (move, resize,
20729 * show, hide, etc.), as the slideshow is controlling it. This
20730 * function is for querying, emitting custom signals or hooking
20731 * lower level callbacks for events on that object. Do not delete
20732 * this object under any circumstances.
20734 * @see elm_slideshow_item_data_get()
20736 * @ingroup Slideshow
20738 EAPI Evas_Object* elm_slideshow_item_object_get(const Elm_Slideshow_Item* item) EINA_ARG_NONNULL(1);
20741 * Get the the item, in a given slideshow widget, placed at
20742 * position @p nth, in its internal items list
20744 * @param obj The slideshow object
20745 * @param nth The number of the item to grab a handle to (0 being
20747 * @return The item stored in @p obj at position @p nth or @c NULL,
20748 * if there's no item with that index (and on errors)
20750 * @ingroup Slideshow
20752 EAPI Elm_Slideshow_Item *elm_slideshow_item_nth_get(const Evas_Object *obj, unsigned int nth) EINA_ARG_NONNULL(1);
20755 * Set the current slide layout in use for a given slideshow widget
20757 * @param obj The slideshow object
20758 * @param layout The new layout's name string
20760 * If @p layout is implemented in @p obj's theme (i.e., is contained
20761 * in the list returned by elm_slideshow_layouts_get()), this new
20762 * images layout will be used on the widget.
20764 * @see elm_slideshow_layouts_get() for more details
20766 * @ingroup Slideshow
20768 EAPI void elm_slideshow_layout_set(Evas_Object *obj, const char *layout) EINA_ARG_NONNULL(1);
20771 * Get the current slide layout in use for a given slideshow widget
20773 * @param obj The slideshow object
20774 * @return The current layout's name
20776 * @see elm_slideshow_layout_set() for more details
20778 * @ingroup Slideshow
20780 EAPI const char *elm_slideshow_layout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20783 * Returns the list of @b layout names available, for a given
20784 * slideshow widget.
20786 * @param obj The slideshow object
20787 * @return The list of layouts (list of @b stringshared strings
20790 * Slideshow layouts will change how the widget is to dispose each
20791 * image item in its viewport, with regard to cropping, scaling,
20794 * The layouts, which come from @p obj's theme, must be an EDC
20795 * data item name @c "layouts" on the theme file, with (prefix)
20796 * names of EDC programs actually implementing them.
20798 * The available layouts for slideshows on the default theme are:
20799 * - @c "fullscreen" - item images with original aspect, scaled to
20800 * touch top and down slideshow borders or, if the image's heigh
20801 * is not enough, left and right slideshow borders.
20802 * - @c "not_fullscreen" - the same behavior as the @c "fullscreen"
20803 * one, but always leaving 10% of the slideshow's dimensions of
20804 * distance between the item image's borders and the slideshow
20805 * borders, for each axis.
20807 * @warning The stringshared strings get no new references
20808 * exclusive to the user grabbing the list, here, so if you'd like
20809 * to use them out of this call's context, you'd better @c
20810 * eina_stringshare_ref() them.
20812 * @see elm_slideshow_layout_set()
20814 * @ingroup Slideshow
20816 EAPI const Eina_List *elm_slideshow_layouts_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20819 * Set the number of items to cache, on a given slideshow widget,
20820 * <b>before the current item</b>
20822 * @param obj The slideshow object
20823 * @param count Number of items to cache before the current one
20825 * The default value for this property is @c 2. See
20826 * @ref Slideshow_Caching "slideshow caching" for more details.
20828 * @see elm_slideshow_cache_before_get()
20830 * @ingroup Slideshow
20832 EAPI void elm_slideshow_cache_before_set(Evas_Object *obj, int count) EINA_ARG_NONNULL(1);
20835 * Retrieve the number of items to cache, on a given slideshow widget,
20836 * <b>before the current item</b>
20838 * @param obj The slideshow object
20839 * @return The number of items set to be cached before the current one
20841 * @see elm_slideshow_cache_before_set() for more details
20843 * @ingroup Slideshow
20845 EAPI int elm_slideshow_cache_before_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20848 * Set the number of items to cache, on a given slideshow widget,
20849 * <b>after the current item</b>
20851 * @param obj The slideshow object
20852 * @param count Number of items to cache after the current one
20854 * The default value for this property is @c 2. See
20855 * @ref Slideshow_Caching "slideshow caching" for more details.
20857 * @see elm_slideshow_cache_after_get()
20859 * @ingroup Slideshow
20861 EAPI void elm_slideshow_cache_after_set(Evas_Object *obj, int count) EINA_ARG_NONNULL(1);
20864 * Retrieve the number of items to cache, on a given slideshow widget,
20865 * <b>after the current item</b>
20867 * @param obj The slideshow object
20868 * @return The number of items set to be cached after the current one
20870 * @see elm_slideshow_cache_after_set() for more details
20872 * @ingroup Slideshow
20874 EAPI int elm_slideshow_cache_after_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20877 * Get the number of items stored in a given slideshow widget
20879 * @param obj The slideshow object
20880 * @return The number of items on @p obj, at the moment of this call
20882 * @ingroup Slideshow
20884 EAPI unsigned int elm_slideshow_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20891 * @defgroup Fileselector File Selector
20893 * @image html img/widget/fileselector/preview-00.png
20894 * @image latex img/widget/fileselector/preview-00.eps
20896 * A file selector is a widget that allows a user to navigate
20897 * through a file system, reporting file selections back via its
20900 * It contains shortcut buttons for home directory (@c ~) and to
20901 * jump one directory upwards (..), as well as cancel/ok buttons to
20902 * confirm/cancel a given selection. After either one of those two
20903 * former actions, the file selector will issue its @c "done" smart
20906 * There's a text entry on it, too, showing the name of the current
20907 * selection. There's the possibility of making it editable, so it
20908 * is useful on file saving dialogs on applications, where one
20909 * gives a file name to save contents to, in a given directory in
20910 * the system. This custom file name will be reported on the @c
20911 * "done" smart callback (explained in sequence).
20913 * Finally, it has a view to display file system items into in two
20918 * If Elementary is built with support of the Ethumb thumbnailing
20919 * library, the second form of view will display preview thumbnails
20920 * of files which it supports.
20922 * Smart callbacks one can register to:
20924 * - @c "selected" - the user has clicked on a file (when not in
20925 * folders-only mode) or directory (when in folders-only mode)
20926 * - @c "directory,open" - the list has been populated with new
20927 * content (@c event_info is a pointer to the directory's
20928 * path, a @b stringshared string)
20929 * - @c "done" - the user has clicked on the "ok" or "cancel"
20930 * buttons (@c event_info is a pointer to the selection's
20931 * path, a @b stringshared string)
20933 * Here is an example on its usage:
20934 * @li @ref fileselector_example
20938 * @addtogroup Fileselector
20943 * Defines how a file selector widget is to layout its contents
20944 * (file system entries).
20946 typedef enum _Elm_Fileselector_Mode
20948 ELM_FILESELECTOR_LIST = 0, /**< layout as a list */
20949 ELM_FILESELECTOR_GRID, /**< layout as a grid */
20950 ELM_FILESELECTOR_LAST /**< sentinel (helper) value, not used */
20951 } Elm_Fileselector_Mode;
20954 * Add a new file selector widget to the given parent Elementary
20955 * (container) object
20957 * @param parent The parent object
20958 * @return a new file selector widget handle or @c NULL, on errors
20960 * This function inserts a new file selector widget on the canvas.
20962 * @ingroup Fileselector
20964 EAPI Evas_Object *elm_fileselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20967 * Enable/disable the file name entry box where the user can type
20968 * in a name for a file, in a given file selector widget
20970 * @param obj The file selector object
20971 * @param is_save @c EINA_TRUE to make the file selector a "saving
20972 * dialog", @c EINA_FALSE otherwise
20974 * Having the entry editable is useful on file saving dialogs on
20975 * applications, where one gives a file name to save contents to,
20976 * in a given directory in the system. This custom file name will
20977 * be reported on the @c "done" smart callback.
20979 * @see elm_fileselector_is_save_get()
20981 * @ingroup Fileselector
20983 EAPI void elm_fileselector_is_save_set(Evas_Object *obj, Eina_Bool is_save) EINA_ARG_NONNULL(1);
20986 * Get whether the given file selector is in "saving dialog" mode
20988 * @param obj The file selector object
20989 * @return @c EINA_TRUE, if the file selector is in "saving dialog"
20990 * mode, @c EINA_FALSE otherwise (and on errors)
20992 * @see elm_fileselector_is_save_set() for more details
20994 * @ingroup Fileselector
20996 EAPI Eina_Bool elm_fileselector_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20999 * Enable/disable folder-only view for a given file selector widget
21001 * @param obj The file selector object
21002 * @param only @c EINA_TRUE to make @p obj only display
21003 * directories, @c EINA_FALSE to make files to be displayed in it
21006 * If enabled, the widget's view will only display folder items,
21009 * @see elm_fileselector_folder_only_get()
21011 * @ingroup Fileselector
21013 EAPI void elm_fileselector_folder_only_set(Evas_Object *obj, Eina_Bool only) EINA_ARG_NONNULL(1);
21016 * Get whether folder-only view is set for a given file selector
21019 * @param obj The file selector object
21020 * @return only @c EINA_TRUE if @p obj is only displaying
21021 * directories, @c EINA_FALSE if files are being displayed in it
21022 * too (and on errors)
21024 * @see elm_fileselector_folder_only_get()
21026 * @ingroup Fileselector
21028 EAPI Eina_Bool elm_fileselector_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21031 * Enable/disable the "ok" and "cancel" buttons on a given file
21034 * @param obj The file selector object
21035 * @param only @c EINA_TRUE to show them, @c EINA_FALSE to hide.
21037 * @note A file selector without those buttons will never emit the
21038 * @c "done" smart event, and is only usable if one is just hooking
21039 * to the other two events.
21041 * @see elm_fileselector_buttons_ok_cancel_get()
21043 * @ingroup Fileselector
21045 EAPI void elm_fileselector_buttons_ok_cancel_set(Evas_Object *obj, Eina_Bool buttons) EINA_ARG_NONNULL(1);
21048 * Get whether the "ok" and "cancel" buttons on a given file
21049 * selector widget are being shown.
21051 * @param obj The file selector object
21052 * @return @c EINA_TRUE if they are being shown, @c EINA_FALSE
21053 * otherwise (and on errors)
21055 * @see elm_fileselector_buttons_ok_cancel_set() for more details
21057 * @ingroup Fileselector
21059 EAPI Eina_Bool elm_fileselector_buttons_ok_cancel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21062 * Enable/disable a tree view in the given file selector widget,
21063 * <b>if it's in @c #ELM_FILESELECTOR_LIST mode</b>
21065 * @param obj The file selector object
21066 * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
21069 * In a tree view, arrows are created on the sides of directories,
21070 * allowing them to expand in place.
21072 * @note If it's in other mode, the changes made by this function
21073 * will only be visible when one switches back to "list" mode.
21075 * @see elm_fileselector_expandable_get()
21077 * @ingroup Fileselector
21079 EAPI void elm_fileselector_expandable_set(Evas_Object *obj, Eina_Bool expand) EINA_ARG_NONNULL(1);
21082 * Get whether tree view is enabled for the given file selector
21085 * @param obj The file selector object
21086 * @return @c EINA_TRUE if @p obj is in tree view, @c EINA_FALSE
21087 * otherwise (and or errors)
21089 * @see elm_fileselector_expandable_set() for more details
21091 * @ingroup Fileselector
21093 EAPI Eina_Bool elm_fileselector_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21096 * Set, programmatically, the @b directory that a given file
21097 * selector widget will display contents from
21099 * @param obj The file selector object
21100 * @param path The path to display in @p obj
21102 * This will change the @b directory that @p obj is displaying. It
21103 * will also clear the text entry area on the @p obj object, which
21104 * displays select files' names.
21106 * @see elm_fileselector_path_get()
21108 * @ingroup Fileselector
21110 EAPI void elm_fileselector_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
21113 * Get the parent directory's path that a given file selector
21114 * widget is displaying
21116 * @param obj The file selector object
21117 * @return The (full) path of the directory the file selector is
21118 * displaying, a @b stringshared string
21120 * @see elm_fileselector_path_set()
21122 * @ingroup Fileselector
21124 EAPI const char *elm_fileselector_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21127 * Set, programmatically, the currently selected file/directory in
21128 * the given file selector widget
21130 * @param obj The file selector object
21131 * @param path The (full) path to a file or directory
21132 * @return @c EINA_TRUE on success, @c EINA_FALSE on failure. The
21133 * latter case occurs if the directory or file pointed to do not
21136 * @see elm_fileselector_selected_get()
21138 * @ingroup Fileselector
21140 EAPI Eina_Bool elm_fileselector_selected_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
21143 * Get the currently selected item's (full) path, in the given file
21146 * @param obj The file selector object
21147 * @return The absolute path of the selected item, a @b
21148 * stringshared string
21150 * @note Custom editions on @p obj object's text entry, if made,
21151 * will appear on the return string of this function, naturally.
21153 * @see elm_fileselector_selected_set() for more details
21155 * @ingroup Fileselector
21157 EAPI const char *elm_fileselector_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21160 * Set the mode in which a given file selector widget will display
21161 * (layout) file system entries in its view
21163 * @param obj The file selector object
21164 * @param mode The mode of the fileselector, being it one of
21165 * #ELM_FILESELECTOR_LIST (default) or #ELM_FILESELECTOR_GRID. The
21166 * first one, naturally, will display the files in a list. The
21167 * latter will make the widget to display its entries in a grid
21170 * @note By using elm_fileselector_expandable_set(), the user may
21171 * trigger a tree view for that list.
21173 * @note If Elementary is built with support of the Ethumb
21174 * thumbnailing library, the second form of view will display
21175 * preview thumbnails of files which it supports. You must have
21176 * elm_need_ethumb() called in your Elementary for thumbnailing to
21179 * @see elm_fileselector_expandable_set().
21180 * @see elm_fileselector_mode_get().
21182 * @ingroup Fileselector
21184 EAPI void elm_fileselector_mode_set(Evas_Object *obj, Elm_Fileselector_Mode mode) EINA_ARG_NONNULL(1);
21187 * Get the mode in which a given file selector widget is displaying
21188 * (layouting) file system entries in its view
21190 * @param obj The fileselector object
21191 * @return The mode in which the fileselector is at
21193 * @see elm_fileselector_mode_set() for more details
21195 * @ingroup Fileselector
21197 EAPI Elm_Fileselector_Mode elm_fileselector_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21204 * @defgroup Progressbar Progress bar
21206 * The progress bar is a widget for visually representing the
21207 * progress status of a given job/task.
21209 * A progress bar may be horizontal or vertical. It may display an
21210 * icon besides it, as well as primary and @b units labels. The
21211 * former is meant to label the widget as a whole, while the
21212 * latter, which is formatted with floating point values (and thus
21213 * accepts a <c>printf</c>-style format string, like <c>"%1.2f
21214 * units"</c>), is meant to label the widget's <b>progress
21215 * value</b>. Label, icon and unit strings/objects are @b optional
21216 * for progress bars.
21218 * A progress bar may be @b inverted, in which state it gets its
21219 * values inverted, with high values being on the left or top and
21220 * low values on the right or bottom, as opposed to normally have
21221 * the low values on the former and high values on the latter,
21222 * respectively, for horizontal and vertical modes.
21224 * The @b span of the progress, as set by
21225 * elm_progressbar_span_size_set(), is its length (horizontally or
21226 * vertically), unless one puts size hints on the widget to expand
21227 * on desired directions, by any container. That length will be
21228 * scaled by the object or applications scaling factor. At any
21229 * point code can query the progress bar for its value with
21230 * elm_progressbar_value_get().
21232 * Available widget styles for progress bars:
21234 * - @c "wheel" (simple style, no text, no progression, only
21235 * "pulse" effect is available)
21237 * Default contents parts of the progressbar widget that you can use for are:
21238 * @li "icon" - A icon of the progressbar
21240 * Here is an example on its usage:
21241 * @li @ref progressbar_example
21245 * Add a new progress bar widget to the given parent Elementary
21246 * (container) object
21248 * @param parent The parent object
21249 * @return a new progress bar widget handle or @c NULL, on errors
21251 * This function inserts a new progress bar widget on the canvas.
21253 * @ingroup Progressbar
21255 EAPI Evas_Object *elm_progressbar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21258 * Set whether a given progress bar widget is at "pulsing mode" or
21261 * @param obj The progress bar object
21262 * @param pulse @c EINA_TRUE to put @p obj in pulsing mode,
21263 * @c EINA_FALSE to put it back to its default one
21265 * By default, progress bars will display values from the low to
21266 * high value boundaries. There are, though, contexts in which the
21267 * state of progression of a given task is @b unknown. For those,
21268 * one can set a progress bar widget to a "pulsing state", to give
21269 * the user an idea that some computation is being held, but
21270 * without exact progress values. In the default theme it will
21271 * animate its bar with the contents filling in constantly and back
21272 * to non-filled, in a loop. To start and stop this pulsing
21273 * animation, one has to explicitly call elm_progressbar_pulse().
21275 * @see elm_progressbar_pulse_get()
21276 * @see elm_progressbar_pulse()
21278 * @ingroup Progressbar
21280 EAPI void elm_progressbar_pulse_set(Evas_Object *obj, Eina_Bool pulse) EINA_ARG_NONNULL(1);
21283 * Get whether a given progress bar widget is at "pulsing mode" or
21286 * @param obj The progress bar object
21287 * @return @c EINA_TRUE, if @p obj is in pulsing mode, @c EINA_FALSE
21288 * if it's in the default one (and on errors)
21290 * @ingroup Progressbar
21292 EAPI Eina_Bool elm_progressbar_pulse_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21295 * Start/stop a given progress bar "pulsing" animation, if its
21298 * @param obj The progress bar object
21299 * @param state @c EINA_TRUE, to @b start the pulsing animation,
21300 * @c EINA_FALSE to @b stop it
21302 * @note This call won't do anything if @p obj is not under "pulsing mode".
21304 * @see elm_progressbar_pulse_set() for more details.
21306 * @ingroup Progressbar
21308 EAPI void elm_progressbar_pulse(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
21311 * Set the progress value (in percentage) on a given progress bar
21314 * @param obj The progress bar object
21315 * @param val The progress value (@b must be between @c 0.0 and @c
21318 * Use this call to set progress bar levels.
21320 * @note If you passes a value out of the specified range for @p
21321 * val, it will be interpreted as the @b closest of the @b boundary
21322 * values in the range.
21324 * @ingroup Progressbar
21326 EAPI void elm_progressbar_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
21329 * Get the progress value (in percentage) on a given progress bar
21332 * @param obj The progress bar object
21333 * @return The value of the progressbar
21335 * @see elm_progressbar_value_set() for more details
21337 * @ingroup Progressbar
21339 EAPI double elm_progressbar_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21342 * Set the label of a given progress bar widget
21344 * @param obj The progress bar object
21345 * @param label The text label string, in UTF-8
21347 * @ingroup Progressbar
21348 * @deprecated use elm_object_text_set() instead.
21350 EINA_DEPRECATED EAPI void elm_progressbar_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
21353 * Get the label of a given progress bar widget
21355 * @param obj The progressbar object
21356 * @return The text label string, in UTF-8
21358 * @ingroup Progressbar
21359 * @deprecated use elm_object_text_set() instead.
21361 EINA_DEPRECATED EAPI const char *elm_progressbar_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21364 * Set the icon object of a given progress bar widget
21366 * @param obj The progress bar object
21367 * @param icon The icon object
21369 * Use this call to decorate @p obj with an icon next to it.
21371 * @note Once the icon object is set, a previously set one will be
21372 * deleted. If you want to keep that old content object, use the
21373 * elm_progressbar_icon_unset() function.
21375 * @see elm_progressbar_icon_get()
21376 * @deprecated use elm_object_part_content_set() instead.
21378 * @ingroup Progressbar
21380 EINA_DEPRECATED EAPI void elm_progressbar_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
21383 * Retrieve the icon object set for a given progress bar widget
21385 * @param obj The progress bar object
21386 * @return The icon object's handle, if @p obj had one set, or @c NULL,
21387 * otherwise (and on errors)
21389 * @see elm_progressbar_icon_set() for more details
21390 * @deprecated use elm_object_part_content_get() instead.
21392 * @ingroup Progressbar
21394 EINA_DEPRECATED EAPI Evas_Object *elm_progressbar_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21397 * Unset an icon set on a given progress bar widget
21399 * @param obj The progress bar object
21400 * @return The icon object that was being used, if any was set, or
21401 * @c NULL, otherwise (and on errors)
21403 * This call will unparent and return the icon object which was set
21404 * for this widget, previously, on success.
21406 * @see elm_progressbar_icon_set() for more details
21407 * @deprecated use elm_object_part_content_unset() instead.
21409 * @ingroup Progressbar
21411 EINA_DEPRECATED EAPI Evas_Object *elm_progressbar_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
21414 * Set the (exact) length of the bar region of a given progress bar
21417 * @param obj The progress bar object
21418 * @param size The length of the progress bar's bar region
21420 * This sets the minimum width (when in horizontal mode) or height
21421 * (when in vertical mode) of the actual bar area of the progress
21422 * bar @p obj. This in turn affects the object's minimum size. Use
21423 * this when you're not setting other size hints expanding on the
21424 * given direction (like weight and alignment hints) and you would
21425 * like it to have a specific size.
21427 * @note Icon, label and unit text around @p obj will require their
21428 * own space, which will make @p obj to require more the @p size,
21431 * @see elm_progressbar_span_size_get()
21433 * @ingroup Progressbar
21435 EAPI void elm_progressbar_span_size_set(Evas_Object *obj, Evas_Coord size) EINA_ARG_NONNULL(1);
21438 * Get the length set for the bar region of a given progress bar
21441 * @param obj The progress bar object
21442 * @return The length of the progress bar's bar region
21444 * If that size was not set previously, with
21445 * elm_progressbar_span_size_set(), this call will return @c 0.
21447 * @ingroup Progressbar
21449 EAPI Evas_Coord elm_progressbar_span_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21452 * Set the format string for a given progress bar widget's units
21455 * @param obj The progress bar object
21456 * @param format The format string for @p obj's units label
21458 * If @c NULL is passed on @p format, it will make @p obj's units
21459 * area to be hidden completely. If not, it'll set the <b>format
21460 * string</b> for the units label's @b text. The units label is
21461 * provided a floating point value, so the units text is up display
21462 * at most one floating point falue. Note that the units label is
21463 * optional. Use a format string such as "%1.2f meters" for
21466 * @note The default format string for a progress bar is an integer
21467 * percentage, as in @c "%.0f %%".
21469 * @see elm_progressbar_unit_format_get()
21471 * @ingroup Progressbar
21473 EAPI void elm_progressbar_unit_format_set(Evas_Object *obj, const char *format) EINA_ARG_NONNULL(1);
21476 * Retrieve the format string set for a given progress bar widget's
21479 * @param obj The progress bar object
21480 * @return The format set string for @p obj's units label or
21481 * @c NULL, if none was set (and on errors)
21483 * @see elm_progressbar_unit_format_set() for more details
21485 * @ingroup Progressbar
21487 EAPI const char *elm_progressbar_unit_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21490 * Set the orientation of a given progress bar widget
21492 * @param obj The progress bar object
21493 * @param horizontal Use @c EINA_TRUE to make @p obj to be
21494 * @b horizontal, @c EINA_FALSE to make it @b vertical
21496 * Use this function to change how your progress bar is to be
21497 * disposed: vertically or horizontally.
21499 * @see elm_progressbar_horizontal_get()
21501 * @ingroup Progressbar
21503 EAPI void elm_progressbar_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
21506 * Retrieve the orientation of a given progress bar widget
21508 * @param obj The progress bar object
21509 * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
21510 * @c EINA_FALSE if it's @b vertical (and on errors)
21512 * @see elm_progressbar_horizontal_set() for more details
21514 * @ingroup Progressbar
21516 EAPI Eina_Bool elm_progressbar_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21519 * Invert a given progress bar widget's displaying values order
21521 * @param obj The progress bar object
21522 * @param inverted Use @c EINA_TRUE to make @p obj inverted,
21523 * @c EINA_FALSE to bring it back to default, non-inverted values.
21525 * A progress bar may be @b inverted, in which state it gets its
21526 * values inverted, with high values being on the left or top and
21527 * low values on the right or bottom, as opposed to normally have
21528 * the low values on the former and high values on the latter,
21529 * respectively, for horizontal and vertical modes.
21531 * @see elm_progressbar_inverted_get()
21533 * @ingroup Progressbar
21535 EAPI void elm_progressbar_inverted_set(Evas_Object *obj, Eina_Bool inverted) EINA_ARG_NONNULL(1);
21538 * Get whether a given progress bar widget's displaying values are
21541 * @param obj The progress bar object
21542 * @return @c EINA_TRUE, if @p obj has inverted values,
21543 * @c EINA_FALSE otherwise (and on errors)
21545 * @see elm_progressbar_inverted_set() for more details
21547 * @ingroup Progressbar
21549 EAPI Eina_Bool elm_progressbar_inverted_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21552 * @defgroup Separator Separator
21554 * @brief Separator is a very thin object used to separate other objects.
21556 * A separator can be vertical or horizontal.
21558 * @ref tutorial_separator is a good example of how to use a separator.
21562 * @brief Add a separator object to @p parent
21564 * @param parent The parent object
21566 * @return The separator object, or NULL upon failure
21568 EAPI Evas_Object *elm_separator_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21570 * @brief Set the horizontal mode of a separator object
21572 * @param obj The separator object
21573 * @param horizontal If true, the separator is horizontal
21575 EAPI void elm_separator_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
21577 * @brief Get the horizontal mode of a separator object
21579 * @param obj The separator object
21580 * @return If true, the separator is horizontal
21582 * @see elm_separator_horizontal_set()
21584 EAPI Eina_Bool elm_separator_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21590 * @defgroup Spinner Spinner
21591 * @ingroup Elementary
21593 * @image html img/widget/spinner/preview-00.png
21594 * @image latex img/widget/spinner/preview-00.eps
21596 * A spinner is a widget which allows the user to increase or decrease
21597 * numeric values using arrow buttons, or edit values directly, clicking
21598 * over it and typing the new value.
21600 * By default the spinner will not wrap and has a label
21601 * of "%.0f" (just showing the integer value of the double).
21603 * A spinner has a label that is formatted with floating
21604 * point values and thus accepts a printf-style format string, like
21605 * ā%1.2f unitsā.
21607 * It also allows specific values to be replaced by pre-defined labels.
21609 * Smart callbacks one can register to:
21611 * - "changed" - Whenever the spinner value is changed.
21612 * - "delay,changed" - A short time after the value is changed by the user.
21613 * This will be called only when the user stops dragging for a very short
21614 * period or when they release their finger/mouse, so it avoids possibly
21615 * expensive reactions to the value change.
21617 * Available styles for it:
21619 * - @c "vertical": up/down buttons at the right side and text left aligned.
21621 * Here is an example on its usage:
21622 * @ref spinner_example
21626 * @addtogroup Spinner
21631 * Add a new spinner widget to the given parent Elementary
21632 * (container) object.
21634 * @param parent The parent object.
21635 * @return a new spinner widget handle or @c NULL, on errors.
21637 * This function inserts a new spinner widget on the canvas.
21642 EAPI Evas_Object *elm_spinner_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21645 * Set the format string of the displayed label.
21647 * @param obj The spinner object.
21648 * @param fmt The format string for the label display.
21650 * If @c NULL, this sets the format to "%.0f". If not it sets the format
21651 * string for the label text. The label text is provided a floating point
21652 * value, so the label text can display up to 1 floating point value.
21653 * Note that this is optional.
21655 * Use a format string such as "%1.2f meters" for example, and it will
21656 * display values like: "3.14 meters" for a value equal to 3.14159.
21658 * Default is "%0.f".
21660 * @see elm_spinner_label_format_get()
21664 EAPI void elm_spinner_label_format_set(Evas_Object *obj, const char *fmt) EINA_ARG_NONNULL(1);
21667 * Get the label format of the spinner.
21669 * @param obj The spinner object.
21670 * @return The text label format string in UTF-8.
21672 * @see elm_spinner_label_format_set() for details.
21676 EAPI const char *elm_spinner_label_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21679 * Set the minimum and maximum values for the spinner.
21681 * @param obj The spinner object.
21682 * @param min The minimum value.
21683 * @param max The maximum value.
21685 * Define the allowed range of values to be selected by the user.
21687 * If actual value is less than @p min, it will be updated to @p min. If it
21688 * is bigger then @p max, will be updated to @p max. Actual value can be
21689 * get with elm_spinner_value_get().
21691 * By default, min is equal to 0, and max is equal to 100.
21693 * @warning Maximum must be greater than minimum.
21695 * @see elm_spinner_min_max_get()
21699 EAPI void elm_spinner_min_max_set(Evas_Object *obj, double min, double max) EINA_ARG_NONNULL(1);
21702 * Get the minimum and maximum values of the spinner.
21704 * @param obj The spinner object.
21705 * @param min Pointer where to store the minimum value.
21706 * @param max Pointer where to store the maximum value.
21708 * @note If only one value is needed, the other pointer can be passed
21711 * @see elm_spinner_min_max_set() for details.
21715 EAPI void elm_spinner_min_max_get(const Evas_Object *obj, double *min, double *max) EINA_ARG_NONNULL(1);
21718 * Set the step used to increment or decrement the spinner value.
21720 * @param obj The spinner object.
21721 * @param step The step value.
21723 * This value will be incremented or decremented to the displayed value.
21724 * It will be incremented while the user keep right or top arrow pressed,
21725 * and will be decremented while the user keep left or bottom arrow pressed.
21727 * The interval to increment / decrement can be set with
21728 * elm_spinner_interval_set().
21730 * By default step value is equal to 1.
21732 * @see elm_spinner_step_get()
21736 EAPI void elm_spinner_step_set(Evas_Object *obj, double step) EINA_ARG_NONNULL(1);
21739 * Get the step used to increment or decrement the spinner value.
21741 * @param obj The spinner object.
21742 * @return The step value.
21744 * @see elm_spinner_step_get() for more details.
21748 EAPI double elm_spinner_step_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21751 * Set the value the spinner displays.
21753 * @param obj The spinner object.
21754 * @param val The value to be displayed.
21756 * Value will be presented on the label following format specified with
21757 * elm_spinner_format_set().
21759 * @warning The value must to be between min and max values. This values
21760 * are set by elm_spinner_min_max_set().
21762 * @see elm_spinner_value_get().
21763 * @see elm_spinner_format_set().
21764 * @see elm_spinner_min_max_set().
21768 EAPI void elm_spinner_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
21771 * Get the value displayed by the spinner.
21773 * @param obj The spinner object.
21774 * @return The value displayed.
21776 * @see elm_spinner_value_set() for details.
21780 EAPI double elm_spinner_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21783 * Set whether the spinner should wrap when it reaches its
21784 * minimum or maximum value.
21786 * @param obj The spinner object.
21787 * @param wrap @c EINA_TRUE to enable wrap or @c EINA_FALSE to
21790 * Disabled by default. If disabled, when the user tries to increment the
21792 * but displayed value plus step value is bigger than maximum value,
21794 * won't allow it. The same happens when the user tries to decrement it,
21795 * but the value less step is less than minimum value.
21797 * When wrap is enabled, in such situations it will allow these changes,
21798 * but will get the value that would be less than minimum and subtracts
21799 * from maximum. Or add the value that would be more than maximum to
21803 * @li min value = 10
21804 * @li max value = 50
21805 * @li step value = 20
21806 * @li displayed value = 20
21808 * When the user decrement value (using left or bottom arrow), it will
21809 * displays @c 40, because max - (min - (displayed - step)) is
21810 * @c 50 - (@c 10 - (@c 20 - @c 20)) = @c 40.
21812 * @see elm_spinner_wrap_get().
21816 EAPI void elm_spinner_wrap_set(Evas_Object *obj, Eina_Bool wrap) EINA_ARG_NONNULL(1);
21819 * Get whether the spinner should wrap when it reaches its
21820 * minimum or maximum value.
21822 * @param obj The spinner object
21823 * @return @c EINA_TRUE means wrap is enabled. @c EINA_FALSE indicates
21824 * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
21826 * @see elm_spinner_wrap_set() for details.
21830 EAPI Eina_Bool elm_spinner_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21833 * Set whether the spinner can be directly edited by the user or not.
21835 * @param obj The spinner object.
21836 * @param editable @c EINA_TRUE to allow users to edit it or @c EINA_FALSE to
21837 * don't allow users to edit it directly.
21839 * Spinner objects can have edition @b disabled, in which state they will
21840 * be changed only by arrows.
21841 * Useful for contexts
21842 * where you don't want your users to interact with it writting the value.
21844 * when using special values, the user can see real value instead
21845 * of special label on edition.
21847 * It's enabled by default.
21849 * @see elm_spinner_editable_get()
21853 EAPI void elm_spinner_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
21856 * Get whether the spinner can be directly edited by the user or not.
21858 * @param obj The spinner object.
21859 * @return @c EINA_TRUE means edition is enabled. @c EINA_FALSE indicates
21860 * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
21862 * @see elm_spinner_editable_set() for details.
21866 EAPI Eina_Bool elm_spinner_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21869 * Set a special string to display in the place of the numerical value.
21871 * @param obj The spinner object.
21872 * @param value The value to be replaced.
21873 * @param label The label to be used.
21875 * It's useful for cases when a user should select an item that is
21876 * better indicated by a label than a value. For example, weekdays or months.
21880 * sp = elm_spinner_add(win);
21881 * elm_spinner_min_max_set(sp, 1, 3);
21882 * elm_spinner_special_value_add(sp, 1, "January");
21883 * elm_spinner_special_value_add(sp, 2, "February");
21884 * elm_spinner_special_value_add(sp, 3, "March");
21885 * evas_object_show(sp);
21890 EAPI void elm_spinner_special_value_add(Evas_Object *obj, double value, const char *label) EINA_ARG_NONNULL(1);
21893 * Set the interval on time updates for an user mouse button hold
21894 * on spinner widgets' arrows.
21896 * @param obj The spinner object.
21897 * @param interval The (first) interval value in seconds.
21899 * This interval value is @b decreased while the user holds the
21900 * mouse pointer either incrementing or decrementing spinner's value.
21902 * This helps the user to get to a given value distant from the
21903 * current one easier/faster, as it will start to change quicker and
21904 * quicker on mouse button holds.
21906 * The calculation for the next change interval value, starting from
21907 * the one set with this call, is the previous interval divided by
21908 * @c 1.05, so it decreases a little bit.
21910 * The default starting interval value for automatic changes is
21913 * @see elm_spinner_interval_get()
21917 EAPI void elm_spinner_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
21920 * Get the interval on time updates for an user mouse button hold
21921 * on spinner widgets' arrows.
21923 * @param obj The spinner object.
21924 * @return The (first) interval value, in seconds, set on it.
21926 * @see elm_spinner_interval_set() for more details.
21930 EAPI double elm_spinner_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21937 * @defgroup Index Index
21939 * @image html img/widget/index/preview-00.png
21940 * @image latex img/widget/index/preview-00.eps
21942 * An index widget gives you an index for fast access to whichever
21943 * group of other UI items one might have. It's a list of text
21944 * items (usually letters, for alphabetically ordered access).
21946 * Index widgets are by default hidden and just appear when the
21947 * user clicks over it's reserved area in the canvas. In its
21948 * default theme, it's an area one @ref Fingers "finger" wide on
21949 * the right side of the index widget's container.
21951 * When items on the index are selected, smart callbacks get
21952 * called, so that its user can make other container objects to
21953 * show a given area or child object depending on the index item
21954 * selected. You'd probably be using an index together with @ref
21955 * List "lists", @ref Genlist "generic lists" or @ref Gengrid
21958 * Smart events one can add callbacks for are:
21959 * - @c "changed" - When the selected index item changes. @c
21960 * event_info is the selected item's data pointer.
21961 * - @c "delay,changed" - When the selected index item changes, but
21962 * after a small idling period. @c event_info is the selected
21963 * item's data pointer.
21964 * - @c "selected" - When the user releases a mouse button and
21965 * selects an item. @c event_info is the selected item's data
21967 * - @c "level,up" - when the user moves a finger from the first
21968 * level to the second level
21969 * - @c "level,down" - when the user moves a finger from the second
21970 * level to the first level
21972 * The @c "delay,changed" event is so that it'll wait a small time
21973 * before actually reporting those events and, moreover, just the
21974 * last event happening on those time frames will actually be
21977 * Here are some examples on its usage:
21978 * @li @ref index_example_01
21979 * @li @ref index_example_02
21983 * @addtogroup Index
21987 typedef struct _Elm_Index_Item Elm_Index_Item; /**< Opaque handle for items of Elementary index widgets */
21990 * Add a new index widget to the given parent Elementary
21991 * (container) object
21993 * @param parent The parent object
21994 * @return a new index widget handle or @c NULL, on errors
21996 * This function inserts a new index widget on the canvas.
22000 EAPI Evas_Object *elm_index_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22003 * Set whether a given index widget is or not visible,
22006 * @param obj The index object
22007 * @param active @c EINA_TRUE to show it, @c EINA_FALSE to hide it
22009 * Not to be confused with visible as in @c evas_object_show() --
22010 * visible with regard to the widget's auto hiding feature.
22012 * @see elm_index_active_get()
22016 EAPI void elm_index_active_set(Evas_Object *obj, Eina_Bool active) EINA_ARG_NONNULL(1);
22019 * Get whether a given index widget is currently visible or not.
22021 * @param obj The index object
22022 * @return @c EINA_TRUE, if it's shown, @c EINA_FALSE otherwise
22024 * @see elm_index_active_set() for more details
22028 EAPI Eina_Bool elm_index_active_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22031 * Set the items level for a given index widget.
22033 * @param obj The index object.
22034 * @param level @c 0 or @c 1, the currently implemented levels.
22036 * @see elm_index_item_level_get()
22040 EAPI void elm_index_item_level_set(Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
22043 * Get the items level set for a given index widget.
22045 * @param obj The index object.
22046 * @return @c 0 or @c 1, which are the levels @p obj might be at.
22048 * @see elm_index_item_level_set() for more information
22052 EAPI int elm_index_item_level_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22055 * Returns the last selected item's data, for a given index widget.
22057 * @param obj The index object.
22058 * @return The item @b data associated to the last selected item on
22059 * @p obj (or @c NULL, on errors).
22061 * @warning The returned value is @b not an #Elm_Index_Item item
22062 * handle, but the data associated to it (see the @c item parameter
22063 * in elm_index_item_append(), as an example).
22067 EAPI void *elm_index_item_selected_get(const Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
22070 * Append a new item on a given index widget.
22072 * @param obj The index object.
22073 * @param letter Letter under which the item should be indexed
22074 * @param item The item data to set for the index's item
22076 * Despite the most common usage of the @p letter argument is for
22077 * single char strings, one could use arbitrary strings as index
22080 * @c item will be the pointer returned back on @c "changed", @c
22081 * "delay,changed" and @c "selected" smart events.
22085 EAPI void elm_index_item_append(Evas_Object *obj, const char *letter, const void *item) EINA_ARG_NONNULL(1);
22088 * Prepend a new item on a given index widget.
22090 * @param obj The index object.
22091 * @param letter Letter under which the item should be indexed
22092 * @param item The item data to set for the index's item
22094 * Despite the most common usage of the @p letter argument is for
22095 * single char strings, one could use arbitrary strings as index
22098 * @c item will be the pointer returned back on @c "changed", @c
22099 * "delay,changed" and @c "selected" smart events.
22103 EAPI void elm_index_item_prepend(Evas_Object *obj, const char *letter, const void *item) EINA_ARG_NONNULL(1);
22106 * Append a new item, on a given index widget, <b>after the item
22107 * having @p relative as data</b>.
22109 * @param obj The index object.
22110 * @param letter Letter under which the item should be indexed
22111 * @param item The item data to set for the index's item
22112 * @param relative The item data of the index item to be the
22113 * predecessor of this new one
22115 * Despite the most common usage of the @p letter argument is for
22116 * single char strings, one could use arbitrary strings as index
22119 * @c item will be the pointer returned back on @c "changed", @c
22120 * "delay,changed" and @c "selected" smart events.
22122 * @note If @p relative is @c NULL or if it's not found to be data
22123 * set on any previous item on @p obj, this function will behave as
22124 * elm_index_item_append().
22128 EAPI void elm_index_item_append_relative(Evas_Object *obj, const char *letter, const void *item, const void *relative) EINA_ARG_NONNULL(1);
22131 * Prepend a new item, on a given index widget, <b>after the item
22132 * having @p relative as data</b>.
22134 * @param obj The index object.
22135 * @param letter Letter under which the item should be indexed
22136 * @param item The item data to set for the index's item
22137 * @param relative The item data of the index item to be the
22138 * successor of this new one
22140 * Despite the most common usage of the @p letter argument is for
22141 * single char strings, one could use arbitrary strings as index
22144 * @c item will be the pointer returned back on @c "changed", @c
22145 * "delay,changed" and @c "selected" smart events.
22147 * @note If @p relative is @c NULL or if it's not found to be data
22148 * set on any previous item on @p obj, this function will behave as
22149 * elm_index_item_prepend().
22153 EAPI void elm_index_item_prepend_relative(Evas_Object *obj, const char *letter, const void *item, const void *relative) EINA_ARG_NONNULL(1);
22156 * Insert a new item into the given index widget, using @p cmp_func
22157 * function to sort items (by item handles).
22159 * @param obj The index object.
22160 * @param letter Letter under which the item should be indexed
22161 * @param item The item data to set for the index's item
22162 * @param cmp_func The comparing function to be used to sort index
22163 * items <b>by #Elm_Index_Item item handles</b>
22164 * @param cmp_data_func A @b fallback function to be called for the
22165 * sorting of index items <b>by item data</b>). It will be used
22166 * when @p cmp_func returns @c 0 (equality), which means an index
22167 * item with provided item data already exists. To decide which
22168 * data item should be pointed to by the index item in question, @p
22169 * cmp_data_func will be used. If @p cmp_data_func returns a
22170 * non-negative value, the previous index item data will be
22171 * replaced by the given @p item pointer. If the previous data need
22172 * to be freed, it should be done by the @p cmp_data_func function,
22173 * because all references to it will be lost. If this function is
22174 * not provided (@c NULL is given), index items will be @b
22175 * duplicated, if @p cmp_func returns @c 0.
22177 * Despite the most common usage of the @p letter argument is for
22178 * single char strings, one could use arbitrary strings as index
22181 * @c item will be the pointer returned back on @c "changed", @c
22182 * "delay,changed" and @c "selected" smart events.
22186 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);
22189 * Remove an item from a given index widget, <b>to be referenced by
22190 * it's data value</b>.
22192 * @param obj The index object
22193 * @param item The item's data pointer for the item to be removed
22196 * If a deletion callback is set, via elm_index_item_del_cb_set(),
22197 * that callback function will be called by this one.
22199 * @warning The item to be removed from @p obj will be found via
22200 * its item data pointer, and not by an #Elm_Index_Item handle.
22204 EAPI void elm_index_item_del(Evas_Object *obj, const void *item) EINA_ARG_NONNULL(1);
22207 * Find a given index widget's item, <b>using item data</b>.
22209 * @param obj The index object
22210 * @param item The item data pointed to by the desired index item
22211 * @return The index item handle, if found, or @c NULL otherwise
22215 EAPI Elm_Index_Item *elm_index_item_find(Evas_Object *obj, const void *item) EINA_ARG_NONNULL(1);
22218 * Removes @b all items from a given index widget.
22220 * @param obj The index object.
22222 * If deletion callbacks are set, via elm_index_item_del_cb_set(),
22223 * that callback function will be called for each item in @p obj.
22227 EAPI void elm_index_item_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
22230 * Go to a given items level on a index widget
22232 * @param obj The index object
22233 * @param level The index level (one of @c 0 or @c 1)
22237 EAPI void elm_index_item_go(Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
22240 * Return the data associated with a given index widget item
22242 * @param it The index widget item handle
22243 * @return The data associated with @p it
22245 * @see elm_index_item_data_set()
22249 EAPI void *elm_index_item_data_get(const Elm_Index_Item *item) EINA_ARG_NONNULL(1);
22252 * Set the data associated with a given index widget item
22254 * @param it The index widget item handle
22255 * @param data The new data pointer to set to @p it
22257 * This sets new item data on @p it.
22259 * @warning The old data pointer won't be touched by this function, so
22260 * the user had better to free that old data himself/herself.
22264 EAPI void elm_index_item_data_set(Elm_Index_Item *it, const void *data) EINA_ARG_NONNULL(1);
22267 * Set the function to be called when a given index widget item is freed.
22269 * @param it The item to set the callback on
22270 * @param func The function to call on the item's deletion
22272 * When called, @p func will have both @c data and @c event_info
22273 * arguments with the @p it item's data value and, naturally, the
22274 * @c obj argument with a handle to the parent index widget.
22278 EAPI void elm_index_item_del_cb_set(Elm_Index_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
22281 * Get the letter (string) set on a given index widget item.
22283 * @param it The index item handle
22284 * @return The letter string set on @p it
22288 EAPI const char *elm_index_item_letter_get(const Elm_Index_Item *item) EINA_ARG_NONNULL(1);
22295 * @defgroup Photocam Photocam
22297 * @image html img/widget/photocam/preview-00.png
22298 * @image latex img/widget/photocam/preview-00.eps
22300 * This is a widget specifically for displaying high-resolution digital
22301 * camera photos giving speedy feedback (fast load), low memory footprint
22302 * and zooming and panning as well as fitting logic. It is entirely focused
22303 * on jpeg images, and takes advantage of properties of the jpeg format (via
22304 * evas loader features in the jpeg loader).
22306 * Signals that you can add callbacks for are:
22307 * @li "clicked" - This is called when a user has clicked the photo without
22309 * @li "press" - This is called when a user has pressed down on the photo.
22310 * @li "longpressed" - This is called when a user has pressed down on the
22311 * photo for a long time without dragging around.
22312 * @li "clicked,double" - This is called when a user has double-clicked the
22314 * @li "load" - Photo load begins.
22315 * @li "loaded" - This is called when the image file load is complete for the
22316 * first view (low resolution blurry version).
22317 * @li "load,detail" - Photo detailed data load begins.
22318 * @li "loaded,detail" - This is called when the image file load is complete
22319 * for the detailed image data (full resolution needed).
22320 * @li "zoom,start" - Zoom animation started.
22321 * @li "zoom,stop" - Zoom animation stopped.
22322 * @li "zoom,change" - Zoom changed when using an auto zoom mode.
22323 * @li "scroll" - the content has been scrolled (moved)
22324 * @li "scroll,anim,start" - scrolling animation has started
22325 * @li "scroll,anim,stop" - scrolling animation has stopped
22326 * @li "scroll,drag,start" - dragging the contents around has started
22327 * @li "scroll,drag,stop" - dragging the contents around has stopped
22329 * @ref tutorial_photocam shows the API in action.
22333 * @brief Types of zoom available.
22335 typedef enum _Elm_Photocam_Zoom_Mode
22337 ELM_PHOTOCAM_ZOOM_MODE_MANUAL = 0, /**< Zoom controlled normally by elm_photocam_zoom_set */
22338 ELM_PHOTOCAM_ZOOM_MODE_AUTO_FIT, /**< Zoom until photo fits in photocam */
22339 ELM_PHOTOCAM_ZOOM_MODE_AUTO_FILL, /**< Zoom until photo fills photocam */
22340 ELM_PHOTOCAM_ZOOM_MODE_LAST
22341 } Elm_Photocam_Zoom_Mode;
22343 * @brief Add a new Photocam object
22345 * @param parent The parent object
22346 * @return The new object or NULL if it cannot be created
22348 EAPI Evas_Object *elm_photocam_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22350 * @brief Set the photo file to be shown
22352 * @param obj The photocam object
22353 * @param file The photo file
22354 * @return The return error (see EVAS_LOAD_ERROR_NONE, EVAS_LOAD_ERROR_GENERIC etc.)
22356 * This sets (and shows) the specified file (with a relative or absolute
22357 * path) and will return a load error (same error that
22358 * evas_object_image_load_error_get() will return). The image will change and
22359 * adjust its size at this point and begin a background load process for this
22360 * photo that at some time in the future will be displayed at the full
22363 EAPI Evas_Load_Error elm_photocam_file_set(Evas_Object *obj, const char *file) EINA_ARG_NONNULL(1);
22365 * @brief Returns the path of the current image file
22367 * @param obj The photocam object
22368 * @return Returns the path
22370 * @see elm_photocam_file_set()
22372 EAPI const char *elm_photocam_file_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22374 * @brief Set the zoom level of the photo
22376 * @param obj The photocam object
22377 * @param zoom The zoom level to set
22379 * This sets the zoom level. 1 will be 1:1 pixel for pixel. 2 will be 2:1
22380 * (that is 2x2 photo pixels will display as 1 on-screen pixel). 4:1 will be
22381 * 4x4 photo pixels as 1 screen pixel, and so on. The @p zoom parameter must
22382 * be greater than 0. It is usggested to stick to powers of 2. (1, 2, 4, 8,
22385 EAPI void elm_photocam_zoom_set(Evas_Object *obj, double zoom) EINA_ARG_NONNULL(1);
22387 * @brief Get the zoom level of the photo
22389 * @param obj The photocam object
22390 * @return The current zoom level
22392 * This returns the current zoom level of the photocam object. Note that if
22393 * you set the fill mode to other than ELM_PHOTOCAM_ZOOM_MODE_MANUAL
22394 * (which is the default), the zoom level may be changed at any time by the
22395 * photocam object itself to account for photo size and photocam viewpoer
22398 * @see elm_photocam_zoom_set()
22399 * @see elm_photocam_zoom_mode_set()
22401 EAPI double elm_photocam_zoom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22403 * @brief Set the zoom mode
22405 * @param obj The photocam object
22406 * @param mode The desired mode
22408 * This sets the zoom mode to manual or one of several automatic levels.
22409 * Manual (ELM_PHOTOCAM_ZOOM_MODE_MANUAL) means that zoom is set manually by
22410 * elm_photocam_zoom_set() and will stay at that level until changed by code
22411 * or until zoom mode is changed. This is the default mode. The Automatic
22412 * modes will allow the photocam object to automatically adjust zoom mode
22413 * based on properties. ELM_PHOTOCAM_ZOOM_MODE_AUTO_FIT) will adjust zoom so
22414 * the photo fits EXACTLY inside the scroll frame with no pixels outside this
22415 * area. ELM_PHOTOCAM_ZOOM_MODE_AUTO_FILL will be similar but ensure no
22416 * pixels within the frame are left unfilled.
22418 EAPI void elm_photocam_zoom_mode_set(Evas_Object *obj, Elm_Photocam_Zoom_Mode mode) EINA_ARG_NONNULL(1);
22420 * @brief Get the zoom mode
22422 * @param obj The photocam object
22423 * @return The current zoom mode
22425 * This gets the current zoom mode of the photocam object.
22427 * @see elm_photocam_zoom_mode_set()
22429 EAPI Elm_Photocam_Zoom_Mode elm_photocam_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22431 * @brief Get the current image pixel width and height
22433 * @param obj The photocam object
22434 * @param w A pointer to the width return
22435 * @param h A pointer to the height return
22437 * This gets the current photo pixel width and height (for the original).
22438 * The size will be returned in the integers @p w and @p h that are pointed
22441 EAPI void elm_photocam_image_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
22443 * @brief Get the area of the image that is currently shown
22446 * @param x A pointer to the X-coordinate of region
22447 * @param y A pointer to the Y-coordinate of region
22448 * @param w A pointer to the width
22449 * @param h A pointer to the height
22451 * @see elm_photocam_image_region_show()
22452 * @see elm_photocam_image_region_bring_in()
22454 EAPI void elm_photocam_region_get(const Evas_Object *obj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
22456 * @brief Set the viewed portion of the image
22458 * @param obj The photocam object
22459 * @param x X-coordinate of region in image original pixels
22460 * @param y Y-coordinate of region in image original pixels
22461 * @param w Width of region in image original pixels
22462 * @param h Height of region in image original pixels
22464 * This shows the region of the image without using animation.
22466 EAPI void elm_photocam_image_region_show(Evas_Object *obj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
22468 * @brief Bring in the viewed portion of the image
22470 * @param obj The photocam object
22471 * @param x X-coordinate of region in image original pixels
22472 * @param y Y-coordinate of region in image original pixels
22473 * @param w Width of region in image original pixels
22474 * @param h Height of region in image original pixels
22476 * This shows the region of the image using animation.
22478 EAPI void elm_photocam_image_region_bring_in(Evas_Object *obj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
22480 * @brief Set the paused state for photocam
22482 * @param obj The photocam object
22483 * @param paused The pause state to set
22485 * This sets the paused state to on(EINA_TRUE) or off (EINA_FALSE) for
22486 * photocam. The default is off. This will stop zooming using animation on
22487 * zoom levels changes and change instantly. This will stop any existing
22488 * animations that are running.
22490 EAPI void elm_photocam_paused_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
22492 * @brief Get the paused state for photocam
22494 * @param obj The photocam object
22495 * @return The current paused state
22497 * This gets the current paused state for the photocam object.
22499 * @see elm_photocam_paused_set()
22501 EAPI Eina_Bool elm_photocam_paused_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22503 * @brief Get the internal low-res image used for photocam
22505 * @param obj The photocam object
22506 * @return The internal image object handle, or NULL if none exists
22508 * This gets the internal image object inside photocam. Do not modify it. It
22509 * is for inspection only, and hooking callbacks to. Nothing else. It may be
22510 * deleted at any time as well.
22512 EAPI Evas_Object *elm_photocam_internal_image_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22514 * @brief Set the photocam scrolling bouncing.
22516 * @param obj The photocam object
22517 * @param h_bounce bouncing for horizontal
22518 * @param v_bounce bouncing for vertical
22520 EAPI void elm_photocam_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
22522 * @brief Get the photocam scrolling bouncing.
22524 * @param obj The photocam object
22525 * @param h_bounce bouncing for horizontal
22526 * @param v_bounce bouncing for vertical
22528 * @see elm_photocam_bounce_set()
22530 EAPI void elm_photocam_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
22536 * @defgroup Map Map
22537 * @ingroup Elementary
22539 * @image html img/widget/map/preview-00.png
22540 * @image latex img/widget/map/preview-00.eps
22542 * This is a widget specifically for displaying a map. It uses basically
22543 * OpenStreetMap provider http://www.openstreetmap.org/,
22544 * but custom providers can be added.
22546 * It supports some basic but yet nice features:
22547 * @li zoom and scroll
22548 * @li markers with content to be displayed when user clicks over it
22549 * @li group of markers
22552 * Smart callbacks one can listen to:
22554 * - "clicked" - This is called when a user has clicked the map without
22556 * - "press" - This is called when a user has pressed down on the map.
22557 * - "longpressed" - This is called when a user has pressed down on the map
22558 * for a long time without dragging around.
22559 * - "clicked,double" - This is called when a user has double-clicked
22561 * - "load,detail" - Map detailed data load begins.
22562 * - "loaded,detail" - This is called when all currently visible parts of
22563 * the map are loaded.
22564 * - "zoom,start" - Zoom animation started.
22565 * - "zoom,stop" - Zoom animation stopped.
22566 * - "zoom,change" - Zoom changed when using an auto zoom mode.
22567 * - "scroll" - the content has been scrolled (moved).
22568 * - "scroll,anim,start" - scrolling animation has started.
22569 * - "scroll,anim,stop" - scrolling animation has stopped.
22570 * - "scroll,drag,start" - dragging the contents around has started.
22571 * - "scroll,drag,stop" - dragging the contents around has stopped.
22572 * - "downloaded" - This is called when all currently required map images
22574 * - "route,load" - This is called when route request begins.
22575 * - "route,loaded" - This is called when route request ends.
22576 * - "name,load" - This is called when name request begins.
22577 * - "name,loaded- This is called when name request ends.
22579 * Available style for map widget:
22582 * Available style for markers:
22587 * Available style for marker bubble:
22590 * List of examples:
22591 * @li @ref map_example_01
22592 * @li @ref map_example_02
22593 * @li @ref map_example_03
22602 * @enum _Elm_Map_Zoom_Mode
22603 * @typedef Elm_Map_Zoom_Mode
22605 * Set map's zoom behavior. It can be set to manual or automatic.
22607 * Default value is #ELM_MAP_ZOOM_MODE_MANUAL.
22609 * Values <b> don't </b> work as bitmask, only one can be choosen.
22611 * @note Valid sizes are 2^zoom, consequently the map may be smaller
22612 * than the scroller view.
22614 * @see elm_map_zoom_mode_set()
22615 * @see elm_map_zoom_mode_get()
22619 typedef enum _Elm_Map_Zoom_Mode
22621 ELM_MAP_ZOOM_MODE_MANUAL, /**< Zoom controlled manually by elm_map_zoom_set(). It's set by default. */
22622 ELM_MAP_ZOOM_MODE_AUTO_FIT, /**< Zoom until map fits inside the scroll frame with no pixels outside this area. */
22623 ELM_MAP_ZOOM_MODE_AUTO_FILL, /**< Zoom until map fills scroll, ensuring no pixels are left unfilled. */
22624 ELM_MAP_ZOOM_MODE_LAST
22625 } Elm_Map_Zoom_Mode;
22628 * @enum _Elm_Map_Route_Sources
22629 * @typedef Elm_Map_Route_Sources
22631 * Set route service to be used. By default used source is
22632 * #ELM_MAP_ROUTE_SOURCE_YOURS.
22634 * @see elm_map_route_source_set()
22635 * @see elm_map_route_source_get()
22639 typedef enum _Elm_Map_Route_Sources
22641 ELM_MAP_ROUTE_SOURCE_YOURS, /**< Routing service http://www.yournavigation.org/ . Set by default.*/
22642 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. */
22643 ELM_MAP_ROUTE_SOURCE_ORS, /**< Open Route Service: http://www.openrouteservice.org/ . It's not working with Map yet. */
22644 ELM_MAP_ROUTE_SOURCE_LAST
22645 } Elm_Map_Route_Sources;
22647 typedef enum _Elm_Map_Name_Sources
22649 ELM_MAP_NAME_SOURCE_NOMINATIM,
22650 ELM_MAP_NAME_SOURCE_LAST
22651 } Elm_Map_Name_Sources;
22654 * @enum _Elm_Map_Route_Type
22655 * @typedef Elm_Map_Route_Type
22657 * Set type of transport used on route.
22659 * @see elm_map_route_add()
22663 typedef enum _Elm_Map_Route_Type
22665 ELM_MAP_ROUTE_TYPE_MOTOCAR, /**< Route should consider an automobile will be used. */
22666 ELM_MAP_ROUTE_TYPE_BICYCLE, /**< Route should consider a bicycle will be used by the user. */
22667 ELM_MAP_ROUTE_TYPE_FOOT, /**< Route should consider user will be walking. */
22668 ELM_MAP_ROUTE_TYPE_LAST
22669 } Elm_Map_Route_Type;
22672 * @enum _Elm_Map_Route_Method
22673 * @typedef Elm_Map_Route_Method
22675 * Set the routing method, what should be priorized, time or distance.
22677 * @see elm_map_route_add()
22681 typedef enum _Elm_Map_Route_Method
22683 ELM_MAP_ROUTE_METHOD_FASTEST, /**< Route should priorize time. */
22684 ELM_MAP_ROUTE_METHOD_SHORTEST, /**< Route should priorize distance. */
22685 ELM_MAP_ROUTE_METHOD_LAST
22686 } Elm_Map_Route_Method;
22688 typedef enum _Elm_Map_Name_Method
22690 ELM_MAP_NAME_METHOD_SEARCH,
22691 ELM_MAP_NAME_METHOD_REVERSE,
22692 ELM_MAP_NAME_METHOD_LAST
22693 } Elm_Map_Name_Method;
22695 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(). */
22696 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(). */
22697 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(). */
22698 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(). */
22699 typedef struct _Elm_Map_Name Elm_Map_Name; /**< A handle for specific coordinates. */
22700 typedef struct _Elm_Map_Track Elm_Map_Track;
22702 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. */
22703 typedef void (*ElmMapMarkerDelFunc) (Evas_Object *obj, Elm_Map_Marker *marker, void *data, Evas_Object *o); /**< Function to delete bubble content for marker classes. */
22704 typedef Evas_Object *(*ElmMapMarkerIconGetFunc) (Evas_Object *obj, Elm_Map_Marker *marker, void *data); /**< Icon fetching class function for marker classes. */
22705 typedef Evas_Object *(*ElmMapGroupIconGetFunc) (Evas_Object *obj, void *data); /**< Icon fetching class function for markers group classes. */
22707 typedef char *(*ElmMapModuleSourceFunc) (void);
22708 typedef int (*ElmMapModuleZoomMinFunc) (void);
22709 typedef int (*ElmMapModuleZoomMaxFunc) (void);
22710 typedef char *(*ElmMapModuleUrlFunc) (Evas_Object *obj, int x, int y, int zoom);
22711 typedef int (*ElmMapModuleRouteSourceFunc) (void);
22712 typedef char *(*ElmMapModuleRouteUrlFunc) (Evas_Object *obj, char *type_name, int method, double flon, double flat, double tlon, double tlat);
22713 typedef char *(*ElmMapModuleNameUrlFunc) (Evas_Object *obj, int method, char *name, double lon, double lat);
22714 typedef Eina_Bool (*ElmMapModuleGeoIntoCoordFunc) (const Evas_Object *obj, int zoom, double lon, double lat, int size, int *x, int *y);
22715 typedef Eina_Bool (*ElmMapModuleCoordIntoGeoFunc) (const Evas_Object *obj, int zoom, int x, int y, int size, double *lon, double *lat);
22718 * Add a new map widget to the given parent Elementary (container) object.
22720 * @param parent The parent object.
22721 * @return a new map widget handle or @c NULL, on errors.
22723 * This function inserts a new map widget on the canvas.
22727 EAPI Evas_Object *elm_map_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22730 * Set the zoom level of the map.
22732 * @param obj The map object.
22733 * @param zoom The zoom level to set.
22735 * This sets the zoom level.
22737 * It will respect limits defined by elm_map_source_zoom_min_set() and
22738 * elm_map_source_zoom_max_set().
22740 * By default these values are 0 (world map) and 18 (maximum zoom).
22742 * This function should be used when zoom mode is set to
22743 * #ELM_MAP_ZOOM_MODE_MANUAL. This is the default mode, and can be set
22744 * with elm_map_zoom_mode_set().
22746 * @see elm_map_zoom_mode_set().
22747 * @see elm_map_zoom_get().
22751 EAPI void elm_map_zoom_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
22754 * Get the zoom level of the map.
22756 * @param obj The map object.
22757 * @return The current zoom level.
22759 * This returns the current zoom level of the map object.
22761 * Note that if you set the fill mode to other than #ELM_MAP_ZOOM_MODE_MANUAL
22762 * (which is the default), the zoom level may be changed at any time by the
22763 * map object itself to account for map size and map viewport size.
22765 * @see elm_map_zoom_set() for details.
22769 EAPI int elm_map_zoom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22772 * Set the zoom mode used by the map object.
22774 * @param obj The map object.
22775 * @param mode The zoom mode of the map, being it one of
22776 * #ELM_MAP_ZOOM_MODE_MANUAL (default), #ELM_MAP_ZOOM_MODE_AUTO_FIT,
22777 * or #ELM_MAP_ZOOM_MODE_AUTO_FILL.
22779 * This sets the zoom mode to manual or one of the automatic levels.
22780 * Manual (#ELM_MAP_ZOOM_MODE_MANUAL) means that zoom is set manually by
22781 * elm_map_zoom_set() and will stay at that level until changed by code
22782 * or until zoom mode is changed. This is the default mode.
22784 * The Automatic modes will allow the map object to automatically
22785 * adjust zoom mode based on properties. #ELM_MAP_ZOOM_MODE_AUTO_FIT will
22786 * adjust zoom so the map fits inside the scroll frame with no pixels
22787 * outside this area. #ELM_MAP_ZOOM_MODE_AUTO_FILL will be similar but
22788 * ensure no pixels within the frame are left unfilled. Do not forget that
22789 * the valid sizes are 2^zoom, consequently the map may be smaller than
22790 * the scroller view.
22792 * @see elm_map_zoom_set()
22796 EAPI void elm_map_zoom_mode_set(Evas_Object *obj, Elm_Map_Zoom_Mode mode) EINA_ARG_NONNULL(1);
22799 * Get the zoom mode used by the map object.
22801 * @param obj The map object.
22802 * @return The zoom mode of the map, being it one of
22803 * #ELM_MAP_ZOOM_MODE_MANUAL (default), #ELM_MAP_ZOOM_MODE_AUTO_FIT,
22804 * or #ELM_MAP_ZOOM_MODE_AUTO_FILL.
22806 * This function returns the current zoom mode used by the map object.
22808 * @see elm_map_zoom_mode_set() for more details.
22812 EAPI Elm_Map_Zoom_Mode elm_map_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22815 * Get the current coordinates of the map.
22817 * @param obj The map object.
22818 * @param lon Pointer where to store longitude.
22819 * @param lat Pointer where to store latitude.
22821 * This gets the current center coordinates of the map object. It can be
22822 * set by elm_map_geo_region_bring_in() and elm_map_geo_region_show().
22824 * @see elm_map_geo_region_bring_in()
22825 * @see elm_map_geo_region_show()
22829 EAPI void elm_map_geo_region_get(const Evas_Object *obj, double *lon, double *lat) EINA_ARG_NONNULL(1);
22832 * Animatedly bring in given coordinates to the center of the map.
22834 * @param obj The map object.
22835 * @param lon Longitude to center at.
22836 * @param lat Latitude to center at.
22838 * This causes map to jump to the given @p lat and @p lon coordinates
22839 * and show it (by scrolling) in the center of the viewport, if it is not
22840 * already centered. This will use animation to do so and take a period
22841 * of time to complete.
22843 * @see elm_map_geo_region_show() for a function to avoid animation.
22844 * @see elm_map_geo_region_get()
22848 EAPI void elm_map_geo_region_bring_in(Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
22851 * Show the given coordinates at the center of the map, @b immediately.
22853 * @param obj The map object.
22854 * @param lon Longitude to center at.
22855 * @param lat Latitude to center at.
22857 * This causes map to @b redraw its viewport's contents to the
22858 * region contining the given @p lat and @p lon, that will be moved to the
22859 * center of the map.
22861 * @see elm_map_geo_region_bring_in() for a function to move with animation.
22862 * @see elm_map_geo_region_get()
22866 EAPI void elm_map_geo_region_show(Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
22869 * Pause or unpause the map.
22871 * @param obj The map object.
22872 * @param paused Use @c EINA_TRUE to pause the map @p obj or @c EINA_FALSE
22875 * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
22878 * The default is off.
22880 * This will stop zooming using animation, changing zoom levels will
22881 * change instantly. This will stop any existing animations that are running.
22883 * @see elm_map_paused_get()
22887 EAPI void elm_map_paused_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
22890 * Get a value whether map is paused or not.
22892 * @param obj The map object.
22893 * @return @c EINA_TRUE means map is pause. @c EINA_FALSE indicates
22894 * it is not. If @p obj is @c NULL, @c EINA_FALSE is returned.
22896 * This gets the current paused state for the map object.
22898 * @see elm_map_paused_set() for details.
22902 EAPI Eina_Bool elm_map_paused_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22905 * Set to show markers during zoom level changes or not.
22907 * @param obj The map object.
22908 * @param paused Use @c EINA_TRUE to @b not show markers or @c EINA_FALSE
22911 * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
22914 * The default is off.
22916 * This will stop zooming using animation, changing zoom levels will
22917 * change instantly. This will stop any existing animations that are running.
22919 * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
22922 * The default is off.
22924 * Enabling it will force the map to stop displaying the markers during
22925 * zoom level changes. Set to on if you have a large number of markers.
22927 * @see elm_map_paused_markers_get()
22931 EAPI void elm_map_paused_markers_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
22934 * Get a value whether markers will be displayed on zoom level changes or not
22936 * @param obj The map object.
22937 * @return @c EINA_TRUE means map @b won't display markers or @c EINA_FALSE
22938 * indicates it will. If @p obj is @c NULL, @c EINA_FALSE is returned.
22940 * This gets the current markers paused state for the map object.
22942 * @see elm_map_paused_markers_set() for details.
22946 EAPI Eina_Bool elm_map_paused_markers_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22949 * Get the information of downloading status.
22951 * @param obj The map object.
22952 * @param try_num Pointer where to store number of tiles being downloaded.
22953 * @param finish_num Pointer where to store number of tiles successfully
22956 * This gets the current downloading status for the map object, the number
22957 * of tiles being downloaded and the number of tiles already downloaded.
22961 EAPI void elm_map_utils_downloading_status_get(const Evas_Object *obj, int *try_num, int *finish_num) EINA_ARG_NONNULL(1, 2, 3);
22964 * Convert a pixel coordinate (x,y) into a geographic coordinate
22965 * (longitude, latitude).
22967 * @param obj The map object.
22968 * @param x the coordinate.
22969 * @param y the coordinate.
22970 * @param size the size in pixels of the map.
22971 * The map is a square and generally his size is : pow(2.0, zoom)*256.
22972 * @param lon Pointer where to store the longitude that correspond to x.
22973 * @param lat Pointer where to store the latitude that correspond to y.
22975 * @note Origin pixel point is the top left corner of the viewport.
22976 * Map zoom and size are taken on account.
22978 * @see elm_map_utils_convert_geo_into_coord() if you need the inverse.
22982 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);
22985 * Convert a geographic coordinate (longitude, latitude) into a pixel
22986 * coordinate (x, y).
22988 * @param obj The map object.
22989 * @param lon the longitude.
22990 * @param lat the latitude.
22991 * @param size the size in pixels of the map. The map is a square
22992 * and generally his size is : pow(2.0, zoom)*256.
22993 * @param x Pointer where to store the horizontal pixel coordinate that
22994 * correspond to the longitude.
22995 * @param y Pointer where to store the vertical pixel coordinate that
22996 * correspond to the latitude.
22998 * @note Origin pixel point is the top left corner of the viewport.
22999 * Map zoom and size are taken on account.
23001 * @see elm_map_utils_convert_coord_into_geo() if you need the inverse.
23005 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);
23008 * Convert a geographic coordinate (longitude, latitude) into a name
23011 * @param obj The map object.
23012 * @param lon the longitude.
23013 * @param lat the latitude.
23014 * @return name A #Elm_Map_Name handle for this coordinate.
23016 * To get the string for this address, elm_map_name_address_get()
23019 * @see elm_map_utils_convert_name_into_coord() if you need the inverse.
23023 EAPI Elm_Map_Name *elm_map_utils_convert_coord_into_name(const Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
23026 * Convert a name (address) into a geographic coordinate
23027 * (longitude, latitude).
23029 * @param obj The map object.
23030 * @param name The address.
23031 * @return name A #Elm_Map_Name handle for this address.
23033 * To get the longitude and latitude, elm_map_name_region_get()
23036 * @see elm_map_utils_convert_coord_into_name() if you need the inverse.
23040 EAPI Elm_Map_Name *elm_map_utils_convert_name_into_coord(const Evas_Object *obj, char *address) EINA_ARG_NONNULL(1, 2);
23043 * Convert a pixel coordinate into a rotated pixel coordinate.
23045 * @param obj The map object.
23046 * @param x horizontal coordinate of the point to rotate.
23047 * @param y vertical coordinate of the point to rotate.
23048 * @param cx rotation's center horizontal position.
23049 * @param cy rotation's center vertical position.
23050 * @param degree amount of degrees from 0.0 to 360.0 to rotate arount Z axis.
23051 * @param xx Pointer where to store rotated x.
23052 * @param yy Pointer where to store rotated y.
23056 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);
23059 * Add a new marker to the map object.
23061 * @param obj The map object.
23062 * @param lon The longitude of the marker.
23063 * @param lat The latitude of the marker.
23064 * @param clas The class, to use when marker @b isn't grouped to others.
23065 * @param clas_group The class group, to use when marker is grouped to others
23066 * @param data The data passed to the callbacks.
23068 * @return The created marker or @c NULL upon failure.
23070 * A marker will be created and shown in a specific point of the map, defined
23071 * by @p lon and @p lat.
23073 * It will be displayed using style defined by @p class when this marker
23074 * is displayed alone (not grouped). A new class can be created with
23075 * elm_map_marker_class_new().
23077 * If the marker is grouped to other markers, it will be displayed with
23078 * style defined by @p class_group. Markers with the same group are grouped
23079 * if they are close. A new group class can be created with
23080 * elm_map_marker_group_class_new().
23082 * Markers created with this method can be deleted with
23083 * elm_map_marker_remove().
23085 * A marker can have associated content to be displayed by a bubble,
23086 * when a user click over it, as well as an icon. These objects will
23087 * be fetch using class' callback functions.
23089 * @see elm_map_marker_class_new()
23090 * @see elm_map_marker_group_class_new()
23091 * @see elm_map_marker_remove()
23095 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);
23098 * Set the maximum numbers of markers' content to be displayed in a group.
23100 * @param obj The map object.
23101 * @param max The maximum numbers of items displayed in a bubble.
23103 * A bubble will be displayed when the user clicks over the group,
23104 * and will place the content of markers that belong to this group
23107 * A group can have a long list of markers, consequently the creation
23108 * of the content of the bubble can be very slow.
23110 * In order to avoid this, a maximum number of items is displayed
23113 * By default this number is 30.
23115 * Marker with the same group class are grouped if they are close.
23117 * @see elm_map_marker_add()
23121 EAPI void elm_map_max_marker_per_group_set(Evas_Object *obj, int max) EINA_ARG_NONNULL(1);
23124 * Remove a marker from the map.
23126 * @param marker The marker to remove.
23128 * @see elm_map_marker_add()
23132 EAPI void elm_map_marker_remove(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
23135 * Get the current coordinates of the marker.
23137 * @param marker marker.
23138 * @param lat Pointer where to store the marker's latitude.
23139 * @param lon Pointer where to store the marker's longitude.
23141 * These values are set when adding markers, with function
23142 * elm_map_marker_add().
23144 * @see elm_map_marker_add()
23148 EAPI void elm_map_marker_region_get(const Elm_Map_Marker *marker, double *lon, double *lat) EINA_ARG_NONNULL(1);
23151 * Animatedly bring in given marker to the center of the map.
23153 * @param marker The marker to center at.
23155 * This causes map to jump to the given @p marker's coordinates
23156 * and show it (by scrolling) in the center of the viewport, if it is not
23157 * already centered. This will use animation to do so and take a period
23158 * of time to complete.
23160 * @see elm_map_marker_show() for a function to avoid animation.
23161 * @see elm_map_marker_region_get()
23165 EAPI void elm_map_marker_bring_in(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
23168 * Show the given marker at the center of the map, @b immediately.
23170 * @param marker The marker to center at.
23172 * This causes map to @b redraw its viewport's contents to the
23173 * region contining the given @p marker's coordinates, that will be
23174 * moved to the center of the map.
23176 * @see elm_map_marker_bring_in() for a function to move with animation.
23177 * @see elm_map_markers_list_show() if more than one marker need to be
23179 * @see elm_map_marker_region_get()
23183 EAPI void elm_map_marker_show(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
23186 * Move and zoom the map to display a list of markers.
23188 * @param markers A list of #Elm_Map_Marker handles.
23190 * The map will be centered on the center point of the markers in the list.
23191 * Then the map will be zoomed in order to fit the markers using the maximum
23192 * zoom which allows display of all the markers.
23194 * @warning All the markers should belong to the same map object.
23196 * @see elm_map_marker_show() to show a single marker.
23197 * @see elm_map_marker_bring_in()
23201 EAPI void elm_map_markers_list_show(Eina_List *markers) EINA_ARG_NONNULL(1);
23204 * Get the Evas object returned by the ElmMapMarkerGetFunc callback
23206 * @param marker The marker wich content should be returned.
23207 * @return Return the evas object if it exists, else @c NULL.
23209 * To set callback function #ElmMapMarkerGetFunc for the marker class,
23210 * elm_map_marker_class_get_cb_set() should be used.
23212 * This content is what will be inside the bubble that will be displayed
23213 * when an user clicks over the marker.
23215 * This returns the actual Evas object used to be placed inside
23216 * the bubble. This may be @c NULL, as it may
23217 * not have been created or may have been deleted, at any time, by
23218 * the map. <b>Do not modify this object</b> (move, resize,
23219 * show, hide, etc.), as the map is controlling it. This
23220 * function is for querying, emitting custom signals or hooking
23221 * lower level callbacks for events on that object. Do not delete
23222 * this object under any circumstances.
23226 EAPI Evas_Object *elm_map_marker_object_get(const Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
23229 * Update the marker
23231 * @param marker The marker to be updated.
23233 * If a content is set to this marker, it will call function to delete it,
23234 * #ElmMapMarkerDelFunc, and then will fetch the content again with
23235 * #ElmMapMarkerGetFunc.
23237 * These functions are set for the marker class with
23238 * elm_map_marker_class_get_cb_set() and elm_map_marker_class_del_cb_set().
23242 EAPI void elm_map_marker_update(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
23245 * Close all the bubbles opened by the user.
23247 * @param obj The map object.
23249 * A bubble is displayed with a content fetched with #ElmMapMarkerGetFunc
23250 * when the user clicks on a marker.
23252 * This functions is set for the marker class with
23253 * elm_map_marker_class_get_cb_set().
23257 EAPI void elm_map_bubbles_close(Evas_Object *obj) EINA_ARG_NONNULL(1);
23260 * Create a new group class.
23262 * @param obj The map object.
23263 * @return Returns the new group class.
23265 * Each marker must be associated to a group class. Markers in the same
23266 * group are grouped if they are close.
23268 * The group class defines the style of the marker when a marker is grouped
23269 * to others markers. When it is alone, another class will be used.
23271 * A group class will need to be provided when creating a marker with
23272 * elm_map_marker_add().
23274 * Some properties and functions can be set by class, as:
23275 * - style, with elm_map_group_class_style_set()
23276 * - data - to be associated to the group class. It can be set using
23277 * elm_map_group_class_data_set().
23278 * - min zoom to display markers, set with
23279 * elm_map_group_class_zoom_displayed_set().
23280 * - max zoom to group markers, set using
23281 * elm_map_group_class_zoom_grouped_set().
23282 * - visibility - set if markers will be visible or not, set with
23283 * elm_map_group_class_hide_set().
23284 * - #ElmMapGroupIconGetFunc - used to fetch icon for markers group classes.
23285 * It can be set using elm_map_group_class_icon_cb_set().
23287 * @see elm_map_marker_add()
23288 * @see elm_map_group_class_style_set()
23289 * @see elm_map_group_class_data_set()
23290 * @see elm_map_group_class_zoom_displayed_set()
23291 * @see elm_map_group_class_zoom_grouped_set()
23292 * @see elm_map_group_class_hide_set()
23293 * @see elm_map_group_class_icon_cb_set()
23297 EAPI Elm_Map_Group_Class *elm_map_group_class_new(Evas_Object *obj) EINA_ARG_NONNULL(1);
23300 * Set the marker's style of a group class.
23302 * @param clas The group class.
23303 * @param style The style to be used by markers.
23305 * Each marker must be associated to a group class, and will use the style
23306 * defined by such class when grouped to other markers.
23308 * The following styles are provided by default theme:
23309 * @li @c radio - blue circle
23310 * @li @c radio2 - green circle
23313 * @see elm_map_group_class_new() for more details.
23314 * @see elm_map_marker_add()
23318 EAPI void elm_map_group_class_style_set(Elm_Map_Group_Class *clas, const char *style) EINA_ARG_NONNULL(1);
23321 * Set the icon callback function of a group class.
23323 * @param clas The group class.
23324 * @param icon_get The callback function that will return the icon.
23326 * Each marker must be associated to a group class, and it can display a
23327 * custom icon. The function @p icon_get must return this icon.
23329 * @see elm_map_group_class_new() for more details.
23330 * @see elm_map_marker_add()
23334 EAPI void elm_map_group_class_icon_cb_set(Elm_Map_Group_Class *clas, ElmMapGroupIconGetFunc icon_get) EINA_ARG_NONNULL(1);
23337 * Set the data associated to the group class.
23339 * @param clas The group class.
23340 * @param data The new user data.
23342 * This data will be passed for callback functions, like icon get callback,
23343 * that can be set with elm_map_group_class_icon_cb_set().
23345 * If a data was previously set, the object will lose the pointer for it,
23346 * so if needs to be freed, you must do it yourself.
23348 * @see elm_map_group_class_new() for more details.
23349 * @see elm_map_group_class_icon_cb_set()
23350 * @see elm_map_marker_add()
23354 EAPI void elm_map_group_class_data_set(Elm_Map_Group_Class *clas, void *data) EINA_ARG_NONNULL(1);
23357 * Set the minimum zoom from where the markers are displayed.
23359 * @param clas The group class.
23360 * @param zoom The minimum zoom.
23362 * Markers only will be displayed when the map is displayed at @p zoom
23365 * @see elm_map_group_class_new() for more details.
23366 * @see elm_map_marker_add()
23370 EAPI void elm_map_group_class_zoom_displayed_set(Elm_Map_Group_Class *clas, int zoom) EINA_ARG_NONNULL(1);
23373 * Set the zoom from where the markers are no more grouped.
23375 * @param clas The group class.
23376 * @param zoom The maximum zoom.
23378 * Markers only will be grouped when the map is displayed at
23379 * less than @p zoom.
23381 * @see elm_map_group_class_new() for more details.
23382 * @see elm_map_marker_add()
23386 EAPI void elm_map_group_class_zoom_grouped_set(Elm_Map_Group_Class *clas, int zoom) EINA_ARG_NONNULL(1);
23389 * Set if the markers associated to the group class @clas are hidden or not.
23391 * @param clas The group class.
23392 * @param hide Use @c EINA_TRUE to hide markers or @c EINA_FALSE
23395 * If @p hide is @c EINA_TRUE the markers will be hidden, but default
23400 EAPI void elm_map_group_class_hide_set(Evas_Object *obj, Elm_Map_Group_Class *clas, Eina_Bool hide) EINA_ARG_NONNULL(1, 2);
23403 * Create a new marker class.
23405 * @param obj The map object.
23406 * @return Returns the new group class.
23408 * Each marker must be associated to a class.
23410 * The marker class defines the style of the marker when a marker is
23411 * displayed alone, i.e., not grouped to to others markers. When grouped
23412 * it will use group class style.
23414 * A marker class will need to be provided when creating a marker with
23415 * elm_map_marker_add().
23417 * Some properties and functions can be set by class, as:
23418 * - style, with elm_map_marker_class_style_set()
23419 * - #ElmMapMarkerIconGetFunc - used to fetch icon for markers classes.
23420 * It can be set using elm_map_marker_class_icon_cb_set().
23421 * - #ElmMapMarkerGetFunc - used to fetch bubble content for marker classes.
23422 * Set using elm_map_marker_class_get_cb_set().
23423 * - #ElmMapMarkerDelFunc - used to delete bubble content for marker classes.
23424 * Set using elm_map_marker_class_del_cb_set().
23426 * @see elm_map_marker_add()
23427 * @see elm_map_marker_class_style_set()
23428 * @see elm_map_marker_class_icon_cb_set()
23429 * @see elm_map_marker_class_get_cb_set()
23430 * @see elm_map_marker_class_del_cb_set()
23434 EAPI Elm_Map_Marker_Class *elm_map_marker_class_new(Evas_Object *obj) EINA_ARG_NONNULL(1);
23437 * Set the marker's style of a marker class.
23439 * @param clas The marker class.
23440 * @param style The style to be used by markers.
23442 * Each marker must be associated to a marker class, and will use the style
23443 * defined by such class when alone, i.e., @b not grouped to other markers.
23445 * The following styles are provided by default theme:
23450 * @see elm_map_marker_class_new() for more details.
23451 * @see elm_map_marker_add()
23455 EAPI void elm_map_marker_class_style_set(Elm_Map_Marker_Class *clas, const char *style) EINA_ARG_NONNULL(1);
23458 * Set the icon callback function of a marker class.
23460 * @param clas The marker class.
23461 * @param icon_get The callback function that will return the icon.
23463 * Each marker must be associated to a marker class, and it can display a
23464 * custom icon. The function @p icon_get must return this icon.
23466 * @see elm_map_marker_class_new() for more details.
23467 * @see elm_map_marker_add()
23471 EAPI void elm_map_marker_class_icon_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerIconGetFunc icon_get) EINA_ARG_NONNULL(1);
23474 * Set the bubble content callback function of a marker class.
23476 * @param clas The marker class.
23477 * @param get The callback function that will return the content.
23479 * Each marker must be associated to a marker class, and it can display a
23480 * a content on a bubble that opens when the user click over the marker.
23481 * The function @p get must return this content object.
23483 * If this content will need to be deleted, elm_map_marker_class_del_cb_set()
23486 * @see elm_map_marker_class_new() for more details.
23487 * @see elm_map_marker_class_del_cb_set()
23488 * @see elm_map_marker_add()
23492 EAPI void elm_map_marker_class_get_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerGetFunc get) EINA_ARG_NONNULL(1);
23495 * Set the callback function used to delete bubble content of a marker class.
23497 * @param clas The marker class.
23498 * @param del The callback function that will delete the content.
23500 * Each marker must be associated to a marker class, and it can display a
23501 * a content on a bubble that opens when the user click over the marker.
23502 * The function to return such content can be set with
23503 * elm_map_marker_class_get_cb_set().
23505 * If this content must be freed, a callback function need to be
23506 * set for that task with this function.
23508 * If this callback is defined it will have to delete (or not) the
23509 * object inside, but if the callback is not defined the object will be
23510 * destroyed with evas_object_del().
23512 * @see elm_map_marker_class_new() for more details.
23513 * @see elm_map_marker_class_get_cb_set()
23514 * @see elm_map_marker_add()
23518 EAPI void elm_map_marker_class_del_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerDelFunc del) EINA_ARG_NONNULL(1);
23521 * Get the list of available sources.
23523 * @param obj The map object.
23524 * @return The source names list.
23526 * It will provide a list with all available sources, that can be set as
23527 * current source with elm_map_source_name_set(), or get with
23528 * elm_map_source_name_get().
23530 * Available sources:
23536 * @see elm_map_source_name_set() for more details.
23537 * @see elm_map_source_name_get()
23541 EAPI const char **elm_map_source_names_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23544 * Set the source of the map.
23546 * @param obj The map object.
23547 * @param source The source to be used.
23549 * Map widget retrieves images that composes the map from a web service.
23550 * This web service can be set with this method.
23552 * A different service can return a different maps with different
23553 * information and it can use different zoom values.
23555 * The @p source_name need to match one of the names provided by
23556 * elm_map_source_names_get().
23558 * The current source can be get using elm_map_source_name_get().
23560 * @see elm_map_source_names_get()
23561 * @see elm_map_source_name_get()
23566 EAPI void elm_map_source_name_set(Evas_Object *obj, const char *source_name) EINA_ARG_NONNULL(1);
23569 * Get the name of currently used source.
23571 * @param obj The map object.
23572 * @return Returns the name of the source in use.
23574 * @see elm_map_source_name_set() for more details.
23578 EAPI const char *elm_map_source_name_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23581 * Set the source of the route service to be used by the map.
23583 * @param obj The map object.
23584 * @param source The route service to be used, being it one of
23585 * #ELM_MAP_ROUTE_SOURCE_YOURS (default), #ELM_MAP_ROUTE_SOURCE_MONAV,
23586 * and #ELM_MAP_ROUTE_SOURCE_ORS.
23588 * Each one has its own algorithm, so the route retrieved may
23589 * differ depending on the source route. Now, only the default is working.
23591 * #ELM_MAP_ROUTE_SOURCE_YOURS is the routing service provided at
23592 * http://www.yournavigation.org/.
23594 * #ELM_MAP_ROUTE_SOURCE_MONAV, offers exact routing without heuristic
23595 * assumptions. Its routing core is based on Contraction Hierarchies.
23597 * #ELM_MAP_ROUTE_SOURCE_ORS, is provided at http://www.openrouteservice.org/
23599 * @see elm_map_route_source_get().
23603 EAPI void elm_map_route_source_set(Evas_Object *obj, Elm_Map_Route_Sources source) EINA_ARG_NONNULL(1);
23606 * Get the current route source.
23608 * @param obj The map object.
23609 * @return The source of the route service used by the map.
23611 * @see elm_map_route_source_set() for details.
23615 EAPI Elm_Map_Route_Sources elm_map_route_source_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23618 * Set the minimum zoom of the source.
23620 * @param obj The map object.
23621 * @param zoom New minimum zoom value to be used.
23623 * By default, it's 0.
23627 EAPI void elm_map_source_zoom_min_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
23630 * Get the minimum zoom of the source.
23632 * @param obj The map object.
23633 * @return Returns the minimum zoom of the source.
23635 * @see elm_map_source_zoom_min_set() for details.
23639 EAPI int elm_map_source_zoom_min_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23642 * Set the maximum zoom of the source.
23644 * @param obj The map object.
23645 * @param zoom New maximum zoom value to be used.
23647 * By default, it's 18.
23651 EAPI void elm_map_source_zoom_max_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
23654 * Get the maximum zoom of the source.
23656 * @param obj The map object.
23657 * @return Returns the maximum zoom of the source.
23659 * @see elm_map_source_zoom_min_set() for details.
23663 EAPI int elm_map_source_zoom_max_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23666 * Set the user agent used by the map object to access routing services.
23668 * @param obj The map object.
23669 * @param user_agent The user agent to be used by the map.
23671 * User agent is a client application implementing a network protocol used
23672 * in communications within a clientāserver distributed computing system
23674 * The @p user_agent identification string will transmitted in a header
23675 * field @c User-Agent.
23677 * @see elm_map_user_agent_get()
23681 EAPI void elm_map_user_agent_set(Evas_Object *obj, const char *user_agent) EINA_ARG_NONNULL(1, 2);
23684 * Get the user agent used by the map object.
23686 * @param obj The map object.
23687 * @return The user agent identification string used by the map.
23689 * @see elm_map_user_agent_set() for details.
23693 EAPI const char *elm_map_user_agent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23696 * Add a new route to the map object.
23698 * @param obj The map object.
23699 * @param type The type of transport to be considered when tracing a route.
23700 * @param method The routing method, what should be priorized.
23701 * @param flon The start longitude.
23702 * @param flat The start latitude.
23703 * @param tlon The destination longitude.
23704 * @param tlat The destination latitude.
23706 * @return The created route or @c NULL upon failure.
23708 * A route will be traced by point on coordinates (@p flat, @p flon)
23709 * to point on coordinates (@p tlat, @p tlon), using the route service
23710 * set with elm_map_route_source_set().
23712 * It will take @p type on consideration to define the route,
23713 * depending if the user will be walking or driving, the route may vary.
23714 * One of #ELM_MAP_ROUTE_TYPE_MOTOCAR, #ELM_MAP_ROUTE_TYPE_BICYCLE, or
23715 * #ELM_MAP_ROUTE_TYPE_FOOT need to be used.
23717 * Another parameter is what the route should priorize, the minor distance
23718 * or the less time to be spend on the route. So @p method should be one
23719 * of #ELM_MAP_ROUTE_METHOD_SHORTEST or #ELM_MAP_ROUTE_METHOD_FASTEST.
23721 * Routes created with this method can be deleted with
23722 * elm_map_route_remove(), colored with elm_map_route_color_set(),
23723 * and distance can be get with elm_map_route_distance_get().
23725 * @see elm_map_route_remove()
23726 * @see elm_map_route_color_set()
23727 * @see elm_map_route_distance_get()
23728 * @see elm_map_route_source_set()
23732 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);
23735 * Remove a route from the map.
23737 * @param route The route to remove.
23739 * @see elm_map_route_add()
23743 EAPI void elm_map_route_remove(Elm_Map_Route *route) EINA_ARG_NONNULL(1);
23746 * Set the route color.
23748 * @param route The route object.
23749 * @param r Red channel value, from 0 to 255.
23750 * @param g Green channel value, from 0 to 255.
23751 * @param b Blue channel value, from 0 to 255.
23752 * @param a Alpha channel value, from 0 to 255.
23754 * It uses an additive color model, so each color channel represents
23755 * how much of each primary colors must to be used. 0 represents
23756 * ausence of this color, so if all of the three are set to 0,
23757 * the color will be black.
23759 * These component values should be integers in the range 0 to 255,
23760 * (single 8-bit byte).
23762 * This sets the color used for the route. By default, it is set to
23763 * solid red (r = 255, g = 0, b = 0, a = 255).
23765 * For alpha channel, 0 represents completely transparent, and 255, opaque.
23767 * @see elm_map_route_color_get()
23771 EAPI void elm_map_route_color_set(Elm_Map_Route *route, int r, int g , int b, int a) EINA_ARG_NONNULL(1);
23774 * Get the route color.
23776 * @param route The route object.
23777 * @param r Pointer where to store the red channel value.
23778 * @param g Pointer where to store the green channel value.
23779 * @param b Pointer where to store the blue channel value.
23780 * @param a Pointer where to store the alpha channel value.
23782 * @see elm_map_route_color_set() for details.
23786 EAPI void elm_map_route_color_get(const Elm_Map_Route *route, int *r, int *g , int *b, int *a) EINA_ARG_NONNULL(1);
23789 * Get the route distance in kilometers.
23791 * @param route The route object.
23792 * @return The distance of route (unit : km).
23796 EAPI double elm_map_route_distance_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
23799 * Get the information of route nodes.
23801 * @param route The route object.
23802 * @return Returns a string with the nodes of route.
23806 EAPI const char *elm_map_route_node_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
23809 * Get the information of route waypoint.
23811 * @param route the route object.
23812 * @return Returns a string with information about waypoint of route.
23816 EAPI const char *elm_map_route_waypoint_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
23819 * Get the address of the name.
23821 * @param name The name handle.
23822 * @return Returns the address string of @p name.
23824 * This gets the coordinates of the @p name, created with one of the
23825 * conversion functions.
23827 * @see elm_map_utils_convert_name_into_coord()
23828 * @see elm_map_utils_convert_coord_into_name()
23832 EAPI const char *elm_map_name_address_get(const Elm_Map_Name *name) EINA_ARG_NONNULL(1);
23835 * Get the current coordinates of the name.
23837 * @param name The name handle.
23838 * @param lat Pointer where to store the latitude.
23839 * @param lon Pointer where to store The longitude.
23841 * This gets the coordinates of the @p name, created with one of the
23842 * conversion functions.
23844 * @see elm_map_utils_convert_name_into_coord()
23845 * @see elm_map_utils_convert_coord_into_name()
23849 EAPI void elm_map_name_region_get(const Elm_Map_Name *name, double *lon, double *lat) EINA_ARG_NONNULL(1);
23852 * Remove a name from the map.
23854 * @param name The name to remove.
23856 * Basically the struct handled by @p name will be freed, so convertions
23857 * between address and coordinates will be lost.
23859 * @see elm_map_utils_convert_name_into_coord()
23860 * @see elm_map_utils_convert_coord_into_name()
23864 EAPI void elm_map_name_remove(Elm_Map_Name *name) EINA_ARG_NONNULL(1);
23869 * @param obj The map object.
23870 * @param degree Angle from 0.0 to 360.0 to rotate arount Z axis.
23871 * @param cx Rotation's center horizontal position.
23872 * @param cy Rotation's center vertical position.
23874 * @see elm_map_rotate_get()
23878 EAPI void elm_map_rotate_set(Evas_Object *obj, double degree, Evas_Coord cx, Evas_Coord cy) EINA_ARG_NONNULL(1);
23881 * Get the rotate degree of the map
23883 * @param obj The map object
23884 * @param degree Pointer where to store degrees from 0.0 to 360.0
23885 * to rotate arount Z axis.
23886 * @param cx Pointer where to store rotation's center horizontal position.
23887 * @param cy Pointer where to store rotation's center vertical position.
23889 * @see elm_map_rotate_set() to set map rotation.
23893 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);
23896 * Enable or disable mouse wheel to be used to zoom in / out the map.
23898 * @param obj The map object.
23899 * @param disabled Use @c EINA_TRUE to disable mouse wheel or @c EINA_FALSE
23902 * Mouse wheel can be used for the user to zoom in or zoom out the map.
23904 * It's disabled by default.
23906 * @see elm_map_wheel_disabled_get()
23910 EAPI void elm_map_wheel_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
23913 * Get a value whether mouse wheel is enabled or not.
23915 * @param obj The map object.
23916 * @return @c EINA_TRUE means map is disabled. @c EINA_FALSE indicates
23917 * it is enabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
23919 * Mouse wheel can be used for the user to zoom in or zoom out the map.
23921 * @see elm_map_wheel_disabled_set() for details.
23925 EAPI Eina_Bool elm_map_wheel_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23929 * Add a track on the map
23931 * @param obj The map object.
23932 * @param emap The emap route object.
23933 * @return The route object. This is an elm object of type Route.
23935 * @see elm_route_add() for details.
23939 EAPI Evas_Object *elm_map_track_add(Evas_Object *obj, EMap_Route *emap) EINA_ARG_NONNULL(1);
23943 * Remove a track from the map
23945 * @param obj The map object.
23946 * @param route The track to remove.
23950 EAPI void elm_map_track_remove(Evas_Object *obj, Evas_Object *route) EINA_ARG_NONNULL(1);
23957 EAPI Evas_Object *elm_route_add(Evas_Object *parent);
23959 EAPI void elm_route_emap_set(Evas_Object *obj, EMap_Route *emap);
23961 EAPI double elm_route_lon_min_get(Evas_Object *obj);
23962 EAPI double elm_route_lat_min_get(Evas_Object *obj);
23963 EAPI double elm_route_lon_max_get(Evas_Object *obj);
23964 EAPI double elm_route_lat_max_get(Evas_Object *obj);
23968 * @defgroup Panel Panel
23970 * @image html img/widget/panel/preview-00.png
23971 * @image latex img/widget/panel/preview-00.eps
23973 * @brief A panel is a type of animated container that contains subobjects.
23974 * It can be expanded or contracted by clicking the button on it's edge.
23976 * Orientations are as follows:
23977 * @li ELM_PANEL_ORIENT_TOP
23978 * @li ELM_PANEL_ORIENT_LEFT
23979 * @li ELM_PANEL_ORIENT_RIGHT
23981 * Default contents parts of the panel widget that you can use for are:
23982 * @li "default" - A content of the panel
23984 * @ref tutorial_panel shows one way to use this widget.
23987 typedef enum _Elm_Panel_Orient
23989 ELM_PANEL_ORIENT_TOP, /**< Panel (dis)appears from the top */
23990 ELM_PANEL_ORIENT_BOTTOM, /**< Not implemented */
23991 ELM_PANEL_ORIENT_LEFT, /**< Panel (dis)appears from the left */
23992 ELM_PANEL_ORIENT_RIGHT, /**< Panel (dis)appears from the right */
23993 } Elm_Panel_Orient;
23995 * @brief Adds a panel object
23997 * @param parent The parent object
23999 * @return The panel object, or NULL on failure
24001 EAPI Evas_Object *elm_panel_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24003 * @brief Sets the orientation of the panel
24005 * @param parent The parent object
24006 * @param orient The panel orientation. Can be one of the following:
24007 * @li ELM_PANEL_ORIENT_TOP
24008 * @li ELM_PANEL_ORIENT_LEFT
24009 * @li ELM_PANEL_ORIENT_RIGHT
24011 * Sets from where the panel will (dis)appear.
24013 EAPI void elm_panel_orient_set(Evas_Object *obj, Elm_Panel_Orient orient) EINA_ARG_NONNULL(1);
24015 * @brief Get the orientation of the panel.
24017 * @param obj The panel object
24018 * @return The Elm_Panel_Orient, or ELM_PANEL_ORIENT_LEFT on failure.
24020 EAPI Elm_Panel_Orient elm_panel_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24022 * @brief Set the content of the panel.
24024 * @param obj The panel object
24025 * @param content The panel content
24027 * Once the content object is set, a previously set one will be deleted.
24028 * If you want to keep that old content object, use the
24029 * elm_panel_content_unset() function.
24031 * @deprecated use elm_object_content_set() instead
24034 EINA_DEPRECATED EAPI void elm_panel_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
24036 * @brief Get the content of the panel.
24038 * @param obj The panel object
24039 * @return The content that is being used
24041 * Return the content object which is set for this widget.
24043 * @see elm_panel_content_set()
24045 * @deprecated use elm_object_content_get() instead
24048 EINA_DEPRECATED EAPI Evas_Object *elm_panel_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24050 * @brief Unset the content of the panel.
24052 * @param obj The panel object
24053 * @return The content that was being used
24055 * Unparent and return the content object which was set for this widget.
24057 * @see elm_panel_content_set()
24059 * @deprecated use elm_object_content_unset() instead
24062 EINA_DEPRECATED EAPI Evas_Object *elm_panel_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24064 * @brief Set the state of the panel.
24066 * @param obj The panel object
24067 * @param hidden If true, the panel will run the animation to contract
24069 EAPI void elm_panel_hidden_set(Evas_Object *obj, Eina_Bool hidden) EINA_ARG_NONNULL(1);
24071 * @brief Get the state of the panel.
24073 * @param obj The panel object
24074 * @param hidden If true, the panel is in the "hide" state
24076 EAPI Eina_Bool elm_panel_hidden_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24078 * @brief Toggle the hidden state of the panel from code
24080 * @param obj The panel object
24082 EAPI void elm_panel_toggle(Evas_Object *obj) EINA_ARG_NONNULL(1);
24088 * @defgroup Panes Panes
24089 * @ingroup Elementary
24091 * @image html img/widget/panes/preview-00.png
24092 * @image latex img/widget/panes/preview-00.eps width=\textwidth
24094 * @image html img/panes.png
24095 * @image latex img/panes.eps width=\textwidth
24097 * The panes adds a dragable bar between two contents. When dragged
24098 * this bar will resize contents size.
24100 * Panes can be displayed vertically or horizontally, and contents
24101 * size proportion can be customized (homogeneous by default).
24103 * Smart callbacks one can listen to:
24104 * - "press" - The panes has been pressed (button wasn't released yet).
24105 * - "unpressed" - The panes was released after being pressed.
24106 * - "clicked" - The panes has been clicked>
24107 * - "clicked,double" - The panes has been double clicked
24109 * Available styles for it:
24112 * Default contents parts of the panes widget that you can use for are:
24113 * @li "left" - A leftside content of the panes
24114 * @li "right" - A rightside content of the panes
24116 * If panes is displayed vertically, left content will be displayed at
24119 * Here is an example on its usage:
24120 * @li @ref panes_example
24124 * @addtogroup Panes
24129 * Add a new panes widget to the given parent Elementary
24130 * (container) object.
24132 * @param parent The parent object.
24133 * @return a new panes widget handle or @c NULL, on errors.
24135 * This function inserts a new panes widget on the canvas.
24139 EAPI Evas_Object *elm_panes_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24142 * Set the left content of the panes widget.
24144 * @param obj The panes object.
24145 * @param content The new left content object.
24147 * Once the content object is set, a previously set one will be deleted.
24148 * If you want to keep that old content object, use the
24149 * elm_panes_content_left_unset() function.
24151 * If panes is displayed vertically, left content will be displayed at
24154 * @see elm_panes_content_left_get()
24155 * @see elm_panes_content_right_set() to set content on the other side.
24157 * @deprecated use elm_object_part_content_set() instead
24161 EINA_DEPRECATED EAPI void elm_panes_content_left_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
24164 * Set the right content of the panes widget.
24166 * @param obj The panes object.
24167 * @param content The new right content object.
24169 * Once the content object is set, a previously set one will be deleted.
24170 * If you want to keep that old content object, use the
24171 * elm_panes_content_right_unset() function.
24173 * If panes is displayed vertically, left content will be displayed at
24176 * @see elm_panes_content_right_get()
24177 * @see elm_panes_content_left_set() to set content on the other side.
24179 * @deprecated use elm_object_part_content_set() instead
24183 EINA_DEPRECATED EAPI void elm_panes_content_right_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
24186 * Get the left content of the panes.
24188 * @param obj The panes object.
24189 * @return The left content object that is being used.
24191 * Return the left content object which is set for this widget.
24193 * @see elm_panes_content_left_set() for details.
24195 * @deprecated use elm_object_part_content_get() instead
24199 EINA_DEPRECATED EAPI Evas_Object *elm_panes_content_left_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24202 * Get the right content of the panes.
24204 * @param obj The panes object
24205 * @return The right content object that is being used
24207 * Return the right content object which is set for this widget.
24209 * @see elm_panes_content_right_set() for details.
24211 * @deprecated use elm_object_part_content_get() instead
24215 EINA_DEPRECATED EAPI Evas_Object *elm_panes_content_right_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24218 * Unset the left content used for the panes.
24220 * @param obj The panes object.
24221 * @return The left content object that was being used.
24223 * Unparent and return the left content object which was set for this widget.
24225 * @see elm_panes_content_left_set() for details.
24226 * @see elm_panes_content_left_get().
24228 * @deprecated use elm_object_part_content_unset() instead
24232 EINA_DEPRECATED EAPI Evas_Object *elm_panes_content_left_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24235 * Unset the right content used for the panes.
24237 * @param obj The panes object.
24238 * @return The right content object that was being used.
24240 * Unparent and return the right content object which was set for this
24243 * @see elm_panes_content_right_set() for details.
24244 * @see elm_panes_content_right_get().
24246 * @deprecated use elm_object_part_content_unset() instead
24250 EINA_DEPRECATED EAPI Evas_Object *elm_panes_content_right_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24253 * Get the size proportion of panes widget's left side.
24255 * @param obj The panes object.
24256 * @return float value between 0.0 and 1.0 representing size proportion
24259 * @see elm_panes_content_left_size_set() for more details.
24263 EAPI double elm_panes_content_left_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24266 * Set the size proportion of panes widget's left side.
24268 * @param obj The panes object.
24269 * @param size Value between 0.0 and 1.0 representing size proportion
24272 * By default it's homogeneous, i.e., both sides have the same size.
24274 * If something different is required, it can be set with this function.
24275 * For example, if the left content should be displayed over
24276 * 75% of the panes size, @p size should be passed as @c 0.75.
24277 * This way, right content will be resized to 25% of panes size.
24279 * If displayed vertically, left content is displayed at top, and
24280 * right content at bottom.
24282 * @note This proportion will change when user drags the panes bar.
24284 * @see elm_panes_content_left_size_get()
24288 EAPI void elm_panes_content_left_size_set(Evas_Object *obj, double size) EINA_ARG_NONNULL(1);
24291 * Set the orientation of a given panes widget.
24293 * @param obj The panes object.
24294 * @param horizontal Use @c EINA_TRUE to make @p obj to be
24295 * @b horizontal, @c EINA_FALSE to make it @b vertical.
24297 * Use this function to change how your panes is to be
24298 * disposed: vertically or horizontally.
24300 * By default it's displayed horizontally.
24302 * @see elm_panes_horizontal_get()
24306 EAPI void elm_panes_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
24309 * Retrieve the orientation of a given panes widget.
24311 * @param obj The panes object.
24312 * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
24313 * @c EINA_FALSE if it's @b vertical (and on errors).
24315 * @see elm_panes_horizontal_set() for more details.
24319 EAPI Eina_Bool elm_panes_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24320 EAPI void elm_panes_fixed_set(Evas_Object *obj, Eina_Bool fixed) EINA_ARG_NONNULL(1);
24321 EAPI Eina_Bool elm_panes_fixed_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24328 * @defgroup Flip Flip
24330 * @image html img/widget/flip/preview-00.png
24331 * @image latex img/widget/flip/preview-00.eps
24333 * This widget holds 2 content objects(Evas_Object): one on the front and one
24334 * on the back. It allows you to flip from front to back and vice-versa using
24335 * various animations.
24337 * If either the front or back contents are not set the flip will treat that
24338 * as transparent. So if you wore to set the front content but not the back,
24339 * and then call elm_flip_go() you would see whatever is below the flip.
24341 * For a list of supported animations see elm_flip_go().
24343 * Signals that you can add callbacks for are:
24344 * "animate,begin" - when a flip animation was started
24345 * "animate,done" - when a flip animation is finished
24347 * @ref tutorial_flip show how to use most of the API.
24351 typedef enum _Elm_Flip_Mode
24353 ELM_FLIP_ROTATE_Y_CENTER_AXIS,
24354 ELM_FLIP_ROTATE_X_CENTER_AXIS,
24355 ELM_FLIP_ROTATE_XZ_CENTER_AXIS,
24356 ELM_FLIP_ROTATE_YZ_CENTER_AXIS,
24357 ELM_FLIP_CUBE_LEFT,
24358 ELM_FLIP_CUBE_RIGHT,
24360 ELM_FLIP_CUBE_DOWN,
24361 ELM_FLIP_PAGE_LEFT,
24362 ELM_FLIP_PAGE_RIGHT,
24366 typedef enum _Elm_Flip_Interaction
24368 ELM_FLIP_INTERACTION_NONE,
24369 ELM_FLIP_INTERACTION_ROTATE,
24370 ELM_FLIP_INTERACTION_CUBE,
24371 ELM_FLIP_INTERACTION_PAGE
24372 } Elm_Flip_Interaction;
24373 typedef enum _Elm_Flip_Direction
24375 ELM_FLIP_DIRECTION_UP, /**< Allows interaction with the top of the widget */
24376 ELM_FLIP_DIRECTION_DOWN, /**< Allows interaction with the bottom of the widget */
24377 ELM_FLIP_DIRECTION_LEFT, /**< Allows interaction with the left portion of the widget */
24378 ELM_FLIP_DIRECTION_RIGHT /**< Allows interaction with the right portion of the widget */
24379 } Elm_Flip_Direction;
24381 * @brief Add a new flip to the parent
24383 * @param parent The parent object
24384 * @return The new object or NULL if it cannot be created
24386 EAPI Evas_Object *elm_flip_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24388 * @brief Set the front content of the flip widget.
24390 * @param obj The flip object
24391 * @param content The new front content object
24393 * Once the content object is set, a previously set one will be deleted.
24394 * If you want to keep that old content object, use the
24395 * elm_flip_content_front_unset() function.
24397 EAPI void elm_flip_content_front_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
24399 * @brief Set the back content of the flip widget.
24401 * @param obj The flip object
24402 * @param content The new back content object
24404 * Once the content object is set, a previously set one will be deleted.
24405 * If you want to keep that old content object, use the
24406 * elm_flip_content_back_unset() function.
24408 EAPI void elm_flip_content_back_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
24410 * @brief Get the front content used for the flip
24412 * @param obj The flip object
24413 * @return The front content object that is being used
24415 * Return the front content object which is set for this widget.
24417 EAPI Evas_Object *elm_flip_content_front_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24419 * @brief Get the back content used for the flip
24421 * @param obj The flip object
24422 * @return The back content object that is being used
24424 * Return the back content object which is set for this widget.
24426 EAPI Evas_Object *elm_flip_content_back_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24428 * @brief Unset the front content used for the flip
24430 * @param obj The flip object
24431 * @return The front content object that was being used
24433 * Unparent and return the front content object which was set for this widget.
24435 EAPI Evas_Object *elm_flip_content_front_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24437 * @brief Unset the back content used for the flip
24439 * @param obj The flip object
24440 * @return The back content object that was being used
24442 * Unparent and return the back content object which was set for this widget.
24444 EAPI Evas_Object *elm_flip_content_back_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24446 * @brief Get flip front visibility state
24448 * @param obj The flip objct
24449 * @return EINA_TRUE if front front is showing, EINA_FALSE if the back is
24452 EAPI Eina_Bool elm_flip_front_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24454 * @brief Set flip perspective
24456 * @param obj The flip object
24457 * @param foc The coordinate to set the focus on
24458 * @param x The X coordinate
24459 * @param y The Y coordinate
24461 * @warning This function currently does nothing.
24463 EAPI void elm_flip_perspective_set(Evas_Object *obj, Evas_Coord foc, Evas_Coord x, Evas_Coord y) EINA_ARG_NONNULL(1);
24465 * @brief Runs the flip animation
24467 * @param obj The flip object
24468 * @param mode The mode type
24470 * Flips the front and back contents using the @p mode animation. This
24471 * efectively hides the currently visible content and shows the hidden one.
24473 * There a number of possible animations to use for the flipping:
24474 * @li ELM_FLIP_ROTATE_X_CENTER_AXIS - Rotate the currently visible content
24475 * around a horizontal axis in the middle of its height, the other content
24476 * is shown as the other side of the flip.
24477 * @li ELM_FLIP_ROTATE_Y_CENTER_AXIS - Rotate the currently visible content
24478 * around a vertical axis in the middle of its width, the other content is
24479 * shown as the other side of the flip.
24480 * @li ELM_FLIP_ROTATE_XZ_CENTER_AXIS - Rotate the currently visible content
24481 * around a diagonal axis in the middle of its width, the other content is
24482 * shown as the other side of the flip.
24483 * @li ELM_FLIP_ROTATE_YZ_CENTER_AXIS - Rotate the currently visible content
24484 * around a diagonal axis in the middle of its height, the other content is
24485 * shown as the other side of the flip.
24486 * @li ELM_FLIP_CUBE_LEFT - Rotate the currently visible content to the left
24487 * as if the flip was a cube, the other content is show as the right face of
24489 * @li ELM_FLIP_CUBE_RIGHT - Rotate the currently visible content to the
24490 * right as if the flip was a cube, the other content is show as the left
24491 * face of the cube.
24492 * @li ELM_FLIP_CUBE_UP - Rotate the currently visible content up as if the
24493 * flip was a cube, the other content is show as the bottom face of the cube.
24494 * @li ELM_FLIP_CUBE_DOWN - Rotate the currently visible content down as if
24495 * the flip was a cube, the other content is show as the upper face of the
24497 * @li ELM_FLIP_PAGE_LEFT - Move the currently visible content to the left as
24498 * if the flip was a book, the other content is shown as the page below that.
24499 * @li ELM_FLIP_PAGE_RIGHT - Move the currently visible content to the right
24500 * as if the flip was a book, the other content is shown as the page below
24502 * @li ELM_FLIP_PAGE_UP - Move the currently visible content up as if the
24503 * flip was a book, the other content is shown as the page below that.
24504 * @li ELM_FLIP_PAGE_DOWN - Move the currently visible content down as if the
24505 * flip was a book, the other content is shown as the page below that.
24507 * @image html elm_flip.png
24508 * @image latex elm_flip.eps width=\textwidth
24510 EAPI void elm_flip_go(Evas_Object *obj, Elm_Flip_Mode mode) EINA_ARG_NONNULL(1);
24512 * @brief Set the interactive flip mode
24514 * @param obj The flip object
24515 * @param mode The interactive flip mode to use
24517 * This sets if the flip should be interactive (allow user to click and
24518 * drag a side of the flip to reveal the back page and cause it to flip).
24519 * By default a flip is not interactive. You may also need to set which
24520 * sides of the flip are "active" for flipping and how much space they use
24521 * (a minimum of a finger size) with elm_flip_interacton_direction_enabled_set()
24522 * and elm_flip_interacton_direction_hitsize_set()
24524 * The four avilable mode of interaction are:
24525 * @li ELM_FLIP_INTERACTION_NONE - No interaction is allowed
24526 * @li ELM_FLIP_INTERACTION_ROTATE - Interaction will cause rotate animation
24527 * @li ELM_FLIP_INTERACTION_CUBE - Interaction will cause cube animation
24528 * @li ELM_FLIP_INTERACTION_PAGE - Interaction will cause page animation
24530 * @note ELM_FLIP_INTERACTION_ROTATE won't cause
24531 * ELM_FLIP_ROTATE_XZ_CENTER_AXIS or ELM_FLIP_ROTATE_YZ_CENTER_AXIS to
24532 * happen, those can only be acheived with elm_flip_go();
24534 EAPI void elm_flip_interaction_set(Evas_Object *obj, Elm_Flip_Interaction mode);
24536 * @brief Get the interactive flip mode
24538 * @param obj The flip object
24539 * @return The interactive flip mode
24541 * Returns the interactive flip mode set by elm_flip_interaction_set()
24543 EAPI Elm_Flip_Interaction elm_flip_interaction_get(const Evas_Object *obj);
24545 * @brief Set which directions of the flip respond to interactive flip
24547 * @param obj The flip object
24548 * @param dir The direction to change
24549 * @param enabled If that direction is enabled or not
24551 * By default all directions are disabled, so you may want to enable the
24552 * desired directions for flipping if you need interactive flipping. You must
24553 * call this function once for each direction that should be enabled.
24555 * @see elm_flip_interaction_set()
24557 EAPI void elm_flip_interacton_direction_enabled_set(Evas_Object *obj, Elm_Flip_Direction dir, Eina_Bool enabled);
24559 * @brief Get the enabled state of that flip direction
24561 * @param obj The flip object
24562 * @param dir The direction to check
24563 * @return If that direction is enabled or not
24565 * Gets the enabled state set by elm_flip_interacton_direction_enabled_set()
24567 * @see elm_flip_interaction_set()
24569 EAPI Eina_Bool elm_flip_interacton_direction_enabled_get(Evas_Object *obj, Elm_Flip_Direction dir);
24571 * @brief Set the amount of the flip that is sensitive to interactive flip
24573 * @param obj The flip object
24574 * @param dir The direction to modify
24575 * @param hitsize The amount of that dimension (0.0 to 1.0) to use
24577 * Set the amount of the flip that is sensitive to interactive flip, with 0
24578 * representing no area in the flip and 1 representing the entire flip. There
24579 * is however a consideration to be made in that the area will never be
24580 * smaller than the finger size set(as set in your Elementary configuration).
24582 * @see elm_flip_interaction_set()
24584 EAPI void elm_flip_interacton_direction_hitsize_set(Evas_Object *obj, Elm_Flip_Direction dir, double hitsize);
24586 * @brief Get the amount of the flip that is sensitive to interactive flip
24588 * @param obj The flip object
24589 * @param dir The direction to check
24590 * @return The size set for that direction
24592 * Returns the amount os sensitive area set by
24593 * elm_flip_interacton_direction_hitsize_set().
24595 EAPI double elm_flip_interacton_direction_hitsize_get(Evas_Object *obj, Elm_Flip_Direction dir);
24600 /* scrolledentry */
24601 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24602 EINA_DEPRECATED EAPI void elm_scrolled_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line) EINA_ARG_NONNULL(1);
24603 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_single_line_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24604 EINA_DEPRECATED EAPI void elm_scrolled_entry_password_set(Evas_Object *obj, Eina_Bool password) EINA_ARG_NONNULL(1);
24605 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_password_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24606 EINA_DEPRECATED EAPI void elm_scrolled_entry_entry_set(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
24607 EINA_DEPRECATED EAPI const char *elm_scrolled_entry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24608 EINA_DEPRECATED EAPI void elm_scrolled_entry_entry_append(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
24609 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_is_empty(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24610 EINA_DEPRECATED EAPI const char *elm_scrolled_entry_selection_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24611 EINA_DEPRECATED EAPI void elm_scrolled_entry_entry_insert(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
24612 EINA_DEPRECATED EAPI void elm_scrolled_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
24613 EINA_DEPRECATED EAPI void elm_scrolled_entry_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
24614 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24615 EINA_DEPRECATED EAPI void elm_scrolled_entry_select_none(Evas_Object *obj) EINA_ARG_NONNULL(1);
24616 EINA_DEPRECATED EAPI void elm_scrolled_entry_select_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
24617 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
24618 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
24619 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_up(Evas_Object *obj) EINA_ARG_NONNULL(1);
24620 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_down(Evas_Object *obj) EINA_ARG_NONNULL(1);
24621 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
24622 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
24623 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_line_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
24624 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_line_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
24625 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_selection_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
24626 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_selection_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
24627 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_is_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24628 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_is_visible_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24629 EINA_DEPRECATED EAPI const char *elm_scrolled_entry_cursor_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24630 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_pos_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
24631 EINA_DEPRECATED EAPI int elm_scrolled_entry_cursor_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24632 EINA_DEPRECATED EAPI void elm_scrolled_entry_selection_cut(Evas_Object *obj) EINA_ARG_NONNULL(1);
24633 EINA_DEPRECATED EAPI void elm_scrolled_entry_selection_copy(Evas_Object *obj) EINA_ARG_NONNULL(1);
24634 EINA_DEPRECATED EAPI void elm_scrolled_entry_selection_paste(Evas_Object *obj) EINA_ARG_NONNULL(1);
24635 EINA_DEPRECATED EAPI void elm_scrolled_entry_context_menu_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
24636 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);
24637 EINA_DEPRECATED EAPI void elm_scrolled_entry_context_menu_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
24638 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_context_menu_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24639 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);
24640 EINA_DEPRECATED EAPI void elm_scrolled_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
24641 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);
24642 EINA_DEPRECATED EAPI void elm_scrolled_entry_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1, 2);
24643 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24644 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24645 EINA_DEPRECATED EAPI void elm_scrolled_entry_icon_visible_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
24646 EINA_DEPRECATED EAPI void elm_scrolled_entry_end_set(Evas_Object *obj, Evas_Object *end) EINA_ARG_NONNULL(1, 2);
24647 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_end_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24648 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_end_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24649 EINA_DEPRECATED EAPI void elm_scrolled_entry_end_visible_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
24650 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);
24651 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);
24652 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);
24653 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);
24654 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);
24655 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);
24656 EINA_DEPRECATED EAPI void elm_scrolled_entry_file_set(Evas_Object *obj, const char *file, Elm_Text_Format format) EINA_ARG_NONNULL(1);
24657 EINA_DEPRECATED EAPI void elm_scrolled_entry_file_get(const Evas_Object *obj, const char **file, Elm_Text_Format *format) EINA_ARG_NONNULL(1);
24658 EINA_DEPRECATED EAPI void elm_scrolled_entry_file_save(Evas_Object *obj) EINA_ARG_NONNULL(1);
24659 EINA_DEPRECATED EAPI void elm_scrolled_entry_autosave_set(Evas_Object *obj, Eina_Bool autosave) EINA_ARG_NONNULL(1);
24660 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_autosave_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24661 EINA_DEPRECATED EAPI void elm_scrolled_entry_cnp_textonly_set(Evas_Object *obj, Eina_Bool textonly) EINA_ARG_NONNULL(1);
24662 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cnp_textonly_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
24665 * @defgroup Conformant Conformant
24666 * @ingroup Elementary
24668 * @image html img/widget/conformant/preview-00.png
24669 * @image latex img/widget/conformant/preview-00.eps width=\textwidth
24671 * @image html img/conformant.png
24672 * @image latex img/conformant.eps width=\textwidth
24674 * The aim is to provide a widget that can be used in elementary apps to
24675 * account for space taken up by the indicator, virtual keypad & softkey
24676 * windows when running the illume2 module of E17.
24678 * So conformant content will be sized and positioned considering the
24679 * space required for such stuff, and when they popup, as a keyboard
24680 * shows when an entry is selected, conformant content won't change.
24682 * Available styles for it:
24685 * Default contents parts of the conformant widget that you can use for are:
24686 * @li "default" - A content of the conformant
24688 * See how to use this widget in this example:
24689 * @ref conformant_example
24693 * @addtogroup Conformant
24698 * Add a new conformant widget to the given parent Elementary
24699 * (container) object.
24701 * @param parent The parent object.
24702 * @return A new conformant widget handle or @c NULL, on errors.
24704 * This function inserts a new conformant widget on the canvas.
24706 * @ingroup Conformant
24708 EAPI Evas_Object *elm_conformant_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24711 * Set the content of the conformant widget.
24713 * @param obj The conformant object.
24714 * @param content The content to be displayed by the conformant.
24716 * Content will be sized and positioned considering the space required
24717 * to display a virtual keyboard. So it won't fill all the conformant
24718 * size. This way is possible to be sure that content won't resize
24719 * or be re-positioned after the keyboard is displayed.
24721 * Once the content object is set, a previously set one will be deleted.
24722 * If you want to keep that old content object, use the
24723 * elm_object_content_unset() function.
24725 * @see elm_object_content_unset()
24726 * @see elm_object_content_get()
24728 * @deprecated use elm_object_content_set() instead
24730 * @ingroup Conformant
24732 EINA_DEPRECATED EAPI void elm_conformant_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
24735 * Get the content of the conformant widget.
24737 * @param obj The conformant object.
24738 * @return The content that is being used.
24740 * Return the content object which is set for this widget.
24741 * It won't be unparent from conformant. For that, use
24742 * elm_object_content_unset().
24744 * @see elm_object_content_set().
24745 * @see elm_object_content_unset()
24747 * @deprecated use elm_object_content_get() instead
24749 * @ingroup Conformant
24751 EINA_DEPRECATED EAPI Evas_Object *elm_conformant_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24754 * Unset the content of the conformant widget.
24756 * @param obj The conformant object.
24757 * @return The content that was being used.
24759 * Unparent and return the content object which was set for this widget.
24761 * @see elm_object_content_set().
24763 * @deprecated use elm_object_content_unset() instead
24765 * @ingroup Conformant
24767 EINA_DEPRECATED EAPI Evas_Object *elm_conformant_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24770 * Returns the Evas_Object that represents the content area.
24772 * @param obj The conformant object.
24773 * @return The content area of the widget.
24775 * @ingroup Conformant
24777 EAPI Evas_Object *elm_conformant_content_area_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24784 * @defgroup Mapbuf Mapbuf
24785 * @ingroup Elementary
24787 * @image html img/widget/mapbuf/preview-00.png
24788 * @image latex img/widget/mapbuf/preview-00.eps width=\textwidth
24790 * This holds one content object and uses an Evas Map of transformation
24791 * points to be later used with this content. So the content will be
24792 * moved, resized, etc as a single image. So it will improve performance
24793 * when you have a complex interafce, with a lot of elements, and will
24794 * need to resize or move it frequently (the content object and its
24797 * Default contents parts of the mapbuf widget that you can use for are:
24798 * @li "default" - A content of the mapbuf
24800 * To enable map, elm_mapbuf_enabled_set() should be used.
24802 * See how to use this widget in this example:
24803 * @ref mapbuf_example
24807 * @addtogroup Mapbuf
24812 * Add a new mapbuf widget to the given parent Elementary
24813 * (container) object.
24815 * @param parent The parent object.
24816 * @return A new mapbuf widget handle or @c NULL, on errors.
24818 * This function inserts a new mapbuf widget on the canvas.
24822 EAPI Evas_Object *elm_mapbuf_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24825 * Set the content of the mapbuf.
24827 * @param obj The mapbuf object.
24828 * @param content The content that will be filled in this mapbuf object.
24830 * Once the content object is set, a previously set one will be deleted.
24831 * If you want to keep that old content object, use the
24832 * elm_mapbuf_content_unset() function.
24834 * To enable map, elm_mapbuf_enabled_set() should be used.
24836 * @deprecated use elm_object_content_set() instead
24840 EINA_DEPRECATED EAPI void elm_mapbuf_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
24843 * Get the content of the mapbuf.
24845 * @param obj The mapbuf object.
24846 * @return The content that is being used.
24848 * Return the content object which is set for this widget.
24850 * @see elm_mapbuf_content_set() for details.
24852 * @deprecated use elm_object_content_get() instead
24856 EINA_DEPRECATED EAPI Evas_Object *elm_mapbuf_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24859 * Unset the content of the mapbuf.
24861 * @param obj The mapbuf object.
24862 * @return The content that was being used.
24864 * Unparent and return the content object which was set for this widget.
24866 * @see elm_mapbuf_content_set() for details.
24868 * @deprecated use elm_object_content_unset() instead
24872 EINA_DEPRECATED EAPI Evas_Object *elm_mapbuf_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24875 * Enable or disable the map.
24877 * @param obj The mapbuf object.
24878 * @param enabled @c EINA_TRUE to enable map or @c EINA_FALSE to disable it.
24880 * This enables the map that is set or disables it. On enable, the object
24881 * geometry will be saved, and the new geometry will change (position and
24882 * size) to reflect the map geometry set.
24884 * Also, when enabled, alpha and smooth states will be used, so if the
24885 * content isn't solid, alpha should be enabled, for example, otherwise
24886 * a black retangle will fill the content.
24888 * When disabled, the stored map will be freed and geometry prior to
24889 * enabling the map will be restored.
24891 * It's disabled by default.
24893 * @see elm_mapbuf_alpha_set()
24894 * @see elm_mapbuf_smooth_set()
24898 EAPI void elm_mapbuf_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
24901 * Get a value whether map is enabled or not.
24903 * @param obj The mapbuf object.
24904 * @return @c EINA_TRUE means map is enabled. @c EINA_FALSE indicates
24905 * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
24907 * @see elm_mapbuf_enabled_set() for details.
24911 EAPI Eina_Bool elm_mapbuf_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24914 * Enable or disable smooth map rendering.
24916 * @param obj The mapbuf object.
24917 * @param smooth @c EINA_TRUE to enable smooth map rendering or @c EINA_FALSE
24920 * This sets smoothing for map rendering. If the object is a type that has
24921 * its own smoothing settings, then both the smooth settings for this object
24922 * and the map must be turned off.
24924 * By default smooth maps are enabled.
24928 EAPI void elm_mapbuf_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
24931 * Get a value whether smooth map rendering is enabled or not.
24933 * @param obj The mapbuf object.
24934 * @return @c EINA_TRUE means smooth map rendering is enabled. @c EINA_FALSE
24935 * indicates it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
24937 * @see elm_mapbuf_smooth_set() for details.
24941 EAPI Eina_Bool elm_mapbuf_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24944 * Set or unset alpha flag for map rendering.
24946 * @param obj The mapbuf object.
24947 * @param alpha @c EINA_TRUE to enable alpha blending or @c EINA_FALSE
24950 * This sets alpha flag for map rendering. If the object is a type that has
24951 * its own alpha settings, then this will take precedence. Only image objects
24952 * have this currently. It stops alpha blending of the map area, and is
24953 * useful if you know the object and/or all sub-objects is 100% solid.
24955 * Alpha is enabled by default.
24959 EAPI void elm_mapbuf_alpha_set(Evas_Object *obj, Eina_Bool alpha) EINA_ARG_NONNULL(1);
24962 * Get a value whether alpha blending is enabled or not.
24964 * @param obj The mapbuf object.
24965 * @return @c EINA_TRUE means alpha blending is enabled. @c EINA_FALSE
24966 * indicates it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
24968 * @see elm_mapbuf_alpha_set() for details.
24972 EAPI Eina_Bool elm_mapbuf_alpha_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24979 * @defgroup Flipselector Flip Selector
24981 * @image html img/widget/flipselector/preview-00.png
24982 * @image latex img/widget/flipselector/preview-00.eps
24984 * A flip selector is a widget to show a set of @b text items, one
24985 * at a time, with the same sheet switching style as the @ref Clock
24986 * "clock" widget, when one changes the current displaying sheet
24987 * (thus, the "flip" in the name).
24989 * User clicks to flip sheets which are @b held for some time will
24990 * make the flip selector to flip continuosly and automatically for
24991 * the user. The interval between flips will keep growing in time,
24992 * so that it helps the user to reach an item which is distant from
24993 * the current selection.
24995 * Smart callbacks one can register to:
24996 * - @c "selected" - when the widget's selected text item is changed
24997 * - @c "overflowed" - when the widget's current selection is changed
24998 * from the first item in its list to the last
24999 * - @c "underflowed" - when the widget's current selection is changed
25000 * from the last item in its list to the first
25002 * Available styles for it:
25005 * To set/get the label of the flipselector item, you can use
25006 * elm_object_item_text_set/get APIs.
25007 * Once the text is set, a previously set one will be deleted.
25009 * Here is an example on its usage:
25010 * @li @ref flipselector_example
25014 * @addtogroup Flipselector
25019 * Add a new flip selector widget to the given parent Elementary
25020 * (container) widget
25022 * @param parent The parent object
25023 * @return a new flip selector widget handle or @c NULL, on errors
25025 * This function inserts a new flip selector widget on the canvas.
25027 * @ingroup Flipselector
25029 EAPI Evas_Object *elm_flipselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
25032 * Programmatically select the next item of a flip selector widget
25034 * @param obj The flipselector object
25036 * @note The selection will be animated. Also, if it reaches the
25037 * end of its list of member items, it will continue with the first
25040 * @ingroup Flipselector
25042 EAPI void elm_flipselector_flip_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
25045 * Programmatically select the previous item of a flip selector
25048 * @param obj The flipselector object
25050 * @note The selection will be animated. Also, if it reaches the
25051 * beginning of its list of member items, it will continue with the
25052 * last one backwards.
25054 * @ingroup Flipselector
25056 EAPI void elm_flipselector_flip_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
25059 * Append a (text) item to a flip selector widget
25061 * @param obj The flipselector object
25062 * @param label The (text) label of the new item
25063 * @param func Convenience callback function to take place when
25065 * @param data Data passed to @p func, above
25066 * @return A handle to the item added or @c NULL, on errors
25068 * The widget's list of labels to show will be appended with the
25069 * given value. If the user wishes so, a callback function pointer
25070 * can be passed, which will get called when this same item is
25073 * @note The current selection @b won't be modified by appending an
25074 * element to the list.
25076 * @note The maximum length of the text label is going to be
25077 * determined <b>by the widget's theme</b>. Strings larger than
25078 * that value are going to be @b truncated.
25080 * @ingroup Flipselector
25082 EAPI Elm_Object_Item *elm_flipselector_item_append(Evas_Object *obj, const char *label, Evas_Smart_Cb func, void *data) EINA_ARG_NONNULL(1);
25085 * Prepend a (text) item to a flip selector widget
25087 * @param obj The flipselector object
25088 * @param label The (text) label of the new item
25089 * @param func Convenience callback function to take place when
25091 * @param data Data passed to @p func, above
25092 * @return A handle to the item added or @c NULL, on errors
25094 * The widget's list of labels to show will be prepended with the
25095 * given value. If the user wishes so, a callback function pointer
25096 * can be passed, which will get called when this same item is
25099 * @note The current selection @b won't be modified by prepending
25100 * an element to the list.
25102 * @note The maximum length of the text label is going to be
25103 * determined <b>by the widget's theme</b>. Strings larger than
25104 * that value are going to be @b truncated.
25106 * @ingroup Flipselector
25108 EAPI Elm_Object_Item *elm_flipselector_item_prepend(Evas_Object *obj, const char *label, Evas_Smart_Cb func, void *data) EINA_ARG_NONNULL(1);
25111 * Get the internal list of items in a given flip selector widget.
25113 * @param obj The flipselector object
25114 * @return The list of items (#Elm_Object_Item as data) or
25115 * @c NULL on errors.
25117 * This list is @b not to be modified in any way and must not be
25118 * freed. Use the list members with functions like
25119 * elm_object_item_text_set(),
25120 * elm_object_item_text_get(),
25121 * elm_flipselector_item_del(),
25122 * elm_flipselector_item_selected_get(),
25123 * elm_flipselector_item_selected_set().
25125 * @warning This list is only valid until @p obj object's internal
25126 * items list is changed. It should be fetched again with another
25127 * call to this function when changes happen.
25129 * @ingroup Flipselector
25131 EAPI const Eina_List *elm_flipselector_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25134 * Get the first item in the given flip selector widget's list of
25137 * @param obj The flipselector object
25138 * @return The first item or @c NULL, if it has no items (and on
25141 * @see elm_flipselector_item_append()
25142 * @see elm_flipselector_last_item_get()
25144 * @ingroup Flipselector
25146 EAPI Elm_Object_Item *elm_flipselector_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25149 * Get the last item in the given flip selector widget's list of
25152 * @param obj The flipselector object
25153 * @return The last item or @c NULL, if it has no items (and on
25156 * @see elm_flipselector_item_prepend()
25157 * @see elm_flipselector_first_item_get()
25159 * @ingroup Flipselector
25161 EAPI Elm_Object_Item *elm_flipselector_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25164 * Get the currently selected item in a flip selector widget.
25166 * @param obj The flipselector object
25167 * @return The selected item or @c NULL, if the widget has no items
25170 * @ingroup Flipselector
25172 EAPI Elm_Object_Item *elm_flipselector_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25175 * Set whether a given flip selector widget's item should be the
25176 * currently selected one.
25178 * @param it The flip selector item
25179 * @param selected @c EINA_TRUE to select it, @c EINA_FALSE to unselect.
25181 * This sets whether @p item is or not the selected (thus, under
25182 * display) one. If @p item is different than one under display,
25183 * the latter will be unselected. If the @p item is set to be
25184 * unselected, on the other hand, the @b first item in the widget's
25185 * internal members list will be the new selected one.
25187 * @see elm_flipselector_item_selected_get()
25189 * @ingroup Flipselector
25191 EAPI void elm_flipselector_item_selected_set(Elm_Object_Item *it, Eina_Bool selected) EINA_ARG_NONNULL(1);
25194 * Get whether a given flip selector widget's item is the currently
25197 * @param it The flip selector item
25198 * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
25201 * @see elm_flipselector_item_selected_set()
25203 * @ingroup Flipselector
25205 EAPI Eina_Bool elm_flipselector_item_selected_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
25208 * Delete a given item from a flip selector widget.
25210 * @param it The item to delete
25212 * @ingroup Flipselector
25214 EAPI void elm_flipselector_item_del(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
25217 * Get the label of a given flip selector widget's item.
25219 * @param it The item to get label from
25220 * @return The text label of @p item or @c NULL, on errors
25222 * @see elm_object_item_text_set()
25224 * @deprecated see elm_object_item_text_get() instead
25225 * @ingroup Flipselector
25227 EINA_DEPRECATED EAPI const char *elm_flipselector_item_label_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
25230 * Set the label of a given flip selector widget's item.
25232 * @param it The item to set label on
25233 * @param label The text label string, in UTF-8 encoding
25235 * @see elm_object_item_text_get()
25237 * @deprecated see elm_object_item_text_set() instead
25238 * @ingroup Flipselector
25240 EINA_DEPRECATED EAPI void elm_flipselector_item_label_set(Elm_Object_Item *it, const char *label) EINA_ARG_NONNULL(1);
25243 * Gets the item before @p item in a flip selector widget's
25244 * internal list of items.
25246 * @param it The item to fetch previous from
25247 * @return The item before the @p item, in its parent's list. If
25248 * there is no previous item for @p item or there's an
25249 * error, @c NULL is returned.
25251 * @see elm_flipselector_item_next_get()
25253 * @ingroup Flipselector
25255 EAPI Elm_Object_Item *elm_flipselector_item_prev_get(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
25258 * Gets the item after @p item in a flip selector widget's
25259 * internal list of items.
25261 * @param it The item to fetch next from
25262 * @return The item after the @p item, in its parent's list. If
25263 * there is no next item for @p item or there's an
25264 * error, @c NULL is returned.
25266 * @see elm_flipselector_item_next_get()
25268 * @ingroup Flipselector
25270 EAPI Elm_Object_Item *elm_flipselector_item_next_get(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
25273 * Set the interval on time updates for an user mouse button hold
25274 * on a flip selector widget.
25276 * @param obj The flip selector object
25277 * @param interval The (first) interval value in seconds
25279 * This interval value is @b decreased while the user holds the
25280 * mouse pointer either flipping up or flipping doww a given flip
25283 * This helps the user to get to a given item distant from the
25284 * current one easier/faster, as it will start to flip quicker and
25285 * quicker on mouse button holds.
25287 * The calculation for the next flip interval value, starting from
25288 * the one set with this call, is the previous interval divided by
25289 * 1.05, so it decreases a little bit.
25291 * The default starting interval value for automatic flips is
25294 * @see elm_flipselector_interval_get()
25296 * @ingroup Flipselector
25298 EAPI void elm_flipselector_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
25301 * Get the interval on time updates for an user mouse button hold
25302 * on a flip selector widget.
25304 * @param obj The flip selector object
25305 * @return The (first) interval value, in seconds, set on it
25307 * @see elm_flipselector_interval_set() for more details
25309 * @ingroup Flipselector
25311 EAPI double elm_flipselector_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25317 * @addtogroup Calendar
25322 * @enum _Elm_Calendar_Mark_Repeat
25323 * @typedef Elm_Calendar_Mark_Repeat
25325 * Event periodicity, used to define if a mark should be repeated
25326 * @b beyond event's day. It's set when a mark is added.
25328 * So, for a mark added to 13th May with periodicity set to WEEKLY,
25329 * there will be marks every week after this date. Marks will be displayed
25330 * at 13th, 20th, 27th, 3rd June ...
25332 * Values don't work as bitmask, only one can be choosen.
25334 * @see elm_calendar_mark_add()
25336 * @ingroup Calendar
25338 typedef enum _Elm_Calendar_Mark_Repeat
25340 ELM_CALENDAR_UNIQUE, /**< Default value. Marks will be displayed only on event day. */
25341 ELM_CALENDAR_DAILY, /**< Marks will be displayed everyday after event day (inclusive). */
25342 ELM_CALENDAR_WEEKLY, /**< Marks will be displayed every week after event day (inclusive) - i.e. each seven days. */
25343 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*/
25344 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. */
25345 } Elm_Calendar_Mark_Repeat;
25347 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(). */
25350 * Add a new calendar widget to the given parent Elementary
25351 * (container) object.
25353 * @param parent The parent object.
25354 * @return a new calendar widget handle or @c NULL, on errors.
25356 * This function inserts a new calendar widget on the canvas.
25358 * @ref calendar_example_01
25360 * @ingroup Calendar
25362 EAPI Evas_Object *elm_calendar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
25365 * Get weekdays names displayed by the calendar.
25367 * @param obj The calendar object.
25368 * @return Array of seven strings to be used as weekday names.
25370 * By default, weekdays abbreviations get from system are displayed:
25371 * E.g. for an en_US locale: "Sun, Mon, Tue, Wed, Thu, Fri, Sat"
25372 * The first string is related to Sunday, the second to Monday...
25374 * @see elm_calendar_weekdays_name_set()
25376 * @ref calendar_example_05
25378 * @ingroup Calendar
25380 EAPI const char **elm_calendar_weekdays_names_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25383 * Set weekdays names to be displayed by the calendar.
25385 * @param obj The calendar object.
25386 * @param weekdays Array of seven strings to be used as weekday names.
25387 * @warning It must have 7 elements, or it will access invalid memory.
25388 * @warning The strings must be NULL terminated ('@\0').
25390 * By default, weekdays abbreviations get from system are displayed:
25391 * E.g. for an en_US locale: "Sun, Mon, Tue, Wed, Thu, Fri, Sat"
25393 * The first string should be related to Sunday, the second to Monday...
25395 * The usage should be like this:
25397 * const char *weekdays[] =
25399 * "Sunday", "Monday", "Tuesday", "Wednesday",
25400 * "Thursday", "Friday", "Saturday"
25402 * elm_calendar_weekdays_names_set(calendar, weekdays);
25405 * @see elm_calendar_weekdays_name_get()
25407 * @ref calendar_example_02
25409 * @ingroup Calendar
25411 EAPI void elm_calendar_weekdays_names_set(Evas_Object *obj, const char *weekdays[]) EINA_ARG_NONNULL(1, 2);
25414 * Set the minimum and maximum values for the year
25416 * @param obj The calendar object
25417 * @param min The minimum year, greater than 1901;
25418 * @param max The maximum year;
25420 * Maximum must be greater than minimum, except if you don't wan't to set
25422 * Default values are 1902 and -1.
25424 * If the maximum year is a negative value, it will be limited depending
25425 * on the platform architecture (year 2037 for 32 bits);
25427 * @see elm_calendar_min_max_year_get()
25429 * @ref calendar_example_03
25431 * @ingroup Calendar
25433 EAPI void elm_calendar_min_max_year_set(Evas_Object *obj, int min, int max) EINA_ARG_NONNULL(1);
25436 * Get the minimum and maximum values for the year
25438 * @param obj The calendar object.
25439 * @param min The minimum year.
25440 * @param max The maximum year.
25442 * Default values are 1902 and -1.
25444 * @see elm_calendar_min_max_year_get() for more details.
25446 * @ref calendar_example_05
25448 * @ingroup Calendar
25450 EAPI void elm_calendar_min_max_year_get(const Evas_Object *obj, int *min, int *max) EINA_ARG_NONNULL(1);
25453 * Enable or disable day selection
25455 * @param obj The calendar object.
25456 * @param enabled @c EINA_TRUE to enable selection or @c EINA_FALSE to
25459 * Enabled by default. If disabled, the user still can select months,
25460 * but not days. Selected days are highlighted on calendar.
25461 * It should be used if you won't need such selection for the widget usage.
25463 * When a day is selected, or month is changed, smart callbacks for
25464 * signal "changed" will be called.
25466 * @see elm_calendar_day_selection_enable_get()
25468 * @ref calendar_example_04
25470 * @ingroup Calendar
25472 EAPI void elm_calendar_day_selection_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
25475 * Get a value whether day selection is enabled or not.
25477 * @see elm_calendar_day_selection_enable_set() for details.
25479 * @param obj The calendar object.
25480 * @return EINA_TRUE means day selection is enabled. EINA_FALSE indicates
25481 * it's disabled. If @p obj is NULL, EINA_FALSE is returned.
25483 * @ref calendar_example_05
25485 * @ingroup Calendar
25487 EAPI Eina_Bool elm_calendar_day_selection_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25491 * Set selected date to be highlighted on calendar.
25493 * @param obj The calendar object.
25494 * @param selected_time A @b tm struct to represent the selected date.
25496 * Set the selected date, changing the displayed month if needed.
25497 * Selected date changes when the user goes to next/previous month or
25498 * select a day pressing over it on calendar.
25500 * @see elm_calendar_selected_time_get()
25502 * @ref calendar_example_04
25504 * @ingroup Calendar
25506 EAPI void elm_calendar_selected_time_set(Evas_Object *obj, struct tm *selected_time) EINA_ARG_NONNULL(1);
25509 * Get selected date.
25511 * @param obj The calendar object
25512 * @param selected_time A @b tm struct to point to selected date
25513 * @return EINA_FALSE means an error ocurred and returned time shouldn't
25516 * Get date selected by the user or set by function
25517 * elm_calendar_selected_time_set().
25518 * Selected date changes when the user goes to next/previous month or
25519 * select a day pressing over it on calendar.
25521 * @see elm_calendar_selected_time_get()
25523 * @ref calendar_example_05
25525 * @ingroup Calendar
25527 EAPI Eina_Bool elm_calendar_selected_time_get(const Evas_Object *obj, struct tm *selected_time) EINA_ARG_NONNULL(1, 2);
25530 * Set a function to format the string that will be used to display
25533 * @param obj The calendar object
25534 * @param format_function Function to set the month-year string given
25535 * the selected date
25537 * By default it uses strftime with "%B %Y" format string.
25538 * It should allocate the memory that will be used by the string,
25539 * that will be freed by the widget after usage.
25540 * A pointer to the string and a pointer to the time struct will be provided.
25545 * _format_month_year(struct tm *selected_time)
25548 * if (!strftime(buf, sizeof(buf), "%B %Y", selected_time)) return NULL;
25549 * return strdup(buf);
25552 * elm_calendar_format_function_set(calendar, _format_month_year);
25555 * @ref calendar_example_02
25557 * @ingroup Calendar
25559 EAPI void elm_calendar_format_function_set(Evas_Object *obj, char * (*format_function) (struct tm *stime)) EINA_ARG_NONNULL(1);
25562 * Add a new mark to the calendar
25564 * @param obj The calendar object
25565 * @param mark_type A string used to define the type of mark. It will be
25566 * emitted to the theme, that should display a related modification on these
25567 * days representation.
25568 * @param mark_time A time struct to represent the date of inclusion of the
25569 * mark. For marks that repeats it will just be displayed after the inclusion
25570 * date in the calendar.
25571 * @param repeat Repeat the event following this periodicity. Can be a unique
25572 * mark (that don't repeat), daily, weekly, monthly or annually.
25573 * @return The created mark or @p NULL upon failure.
25575 * Add a mark that will be drawn in the calendar respecting the insertion
25576 * time and periodicity. It will emit the type as signal to the widget theme.
25577 * Default theme supports "holiday" and "checked", but it can be extended.
25579 * It won't immediately update the calendar, drawing the marks.
25580 * For this, call elm_calendar_marks_draw(). However, when user selects
25581 * next or previous month calendar forces marks drawn.
25583 * Marks created with this method can be deleted with
25584 * elm_calendar_mark_del().
25588 * struct tm selected_time;
25589 * time_t current_time;
25591 * current_time = time(NULL) + 5 * 84600;
25592 * localtime_r(¤t_time, &selected_time);
25593 * elm_calendar_mark_add(cal, "holiday", selected_time,
25594 * ELM_CALENDAR_ANNUALLY);
25596 * current_time = time(NULL) + 1 * 84600;
25597 * localtime_r(¤t_time, &selected_time);
25598 * elm_calendar_mark_add(cal, "checked", selected_time, ELM_CALENDAR_UNIQUE);
25600 * elm_calendar_marks_draw(cal);
25603 * @see elm_calendar_marks_draw()
25604 * @see elm_calendar_mark_del()
25606 * @ref calendar_example_06
25608 * @ingroup Calendar
25610 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);
25613 * Delete mark from the calendar.
25615 * @param mark The mark to be deleted.
25617 * If deleting all calendar marks is required, elm_calendar_marks_clear()
25618 * should be used instead of getting marks list and deleting each one.
25620 * @see elm_calendar_mark_add()
25622 * @ref calendar_example_06
25624 * @ingroup Calendar
25626 EAPI void elm_calendar_mark_del(Elm_Calendar_Mark *mark) EINA_ARG_NONNULL(1);
25629 * Remove all calendar's marks
25631 * @param obj The calendar object.
25633 * @see elm_calendar_mark_add()
25634 * @see elm_calendar_mark_del()
25636 * @ingroup Calendar
25638 EAPI void elm_calendar_marks_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
25642 * Get a list of all the calendar marks.
25644 * @param obj The calendar object.
25645 * @return An @c Eina_List of calendar marks objects, or @c NULL on failure.
25647 * @see elm_calendar_mark_add()
25648 * @see elm_calendar_mark_del()
25649 * @see elm_calendar_marks_clear()
25651 * @ingroup Calendar
25653 EAPI const Eina_List *elm_calendar_marks_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25656 * Draw calendar marks.
25658 * @param obj The calendar object.
25660 * Should be used after adding, removing or clearing marks.
25661 * It will go through the entire marks list updating the calendar.
25662 * If lots of marks will be added, add all the marks and then call
25665 * When the month is changed, i.e. user selects next or previous month,
25666 * marks will be drawed.
25668 * @see elm_calendar_mark_add()
25669 * @see elm_calendar_mark_del()
25670 * @see elm_calendar_marks_clear()
25672 * @ref calendar_example_06
25674 * @ingroup Calendar
25676 EAPI void elm_calendar_marks_draw(Evas_Object *obj) EINA_ARG_NONNULL(1);
25679 * Set a day text color to the same that represents Saturdays.
25681 * @param obj The calendar object.
25682 * @param pos The text position. Position is the cell counter, from left
25683 * to right, up to down. It starts on 0 and ends on 41.
25685 * @deprecated use elm_calendar_mark_add() instead like:
25688 * struct tm t = { 0, 0, 12, 6, 0, 0, 6, 6, -1 };
25689 * elm_calendar_mark_add(obj, "sat", &t, ELM_CALENDAR_WEEKLY);
25692 * @see elm_calendar_mark_add()
25694 * @ingroup Calendar
25696 EINA_DEPRECATED EAPI void elm_calendar_text_saturday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
25699 * Set a day text color to the same that represents Sundays.
25701 * @param obj The calendar object.
25702 * @param pos The text position. Position is the cell counter, from left
25703 * to right, up to down. It starts on 0 and ends on 41.
25705 * @deprecated use elm_calendar_mark_add() instead like:
25708 * struct tm t = { 0, 0, 12, 7, 0, 0, 0, 0, -1 };
25709 * elm_calendar_mark_add(obj, "sat", &t, ELM_CALENDAR_WEEKLY);
25712 * @see elm_calendar_mark_add()
25714 * @ingroup Calendar
25716 EINA_DEPRECATED EAPI void elm_calendar_text_sunday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
25719 * Set a day text color to the same that represents Weekdays.
25721 * @param obj The calendar object
25722 * @param pos The text position. Position is the cell counter, from left
25723 * to right, up to down. It starts on 0 and ends on 41.
25725 * @deprecated use elm_calendar_mark_add() instead like:
25728 * struct tm t = { 0, 0, 12, 1, 0, 0, 0, 0, -1 };
25730 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // monday
25731 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
25732 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // tuesday
25733 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
25734 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // wednesday
25735 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
25736 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // thursday
25737 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
25738 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // friday
25741 * @see elm_calendar_mark_add()
25743 * @ingroup Calendar
25745 EINA_DEPRECATED EAPI void elm_calendar_text_weekday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
25748 * Set the interval on time updates for an user mouse button hold
25749 * on calendar widgets' month selection.
25751 * @param obj The calendar object
25752 * @param interval The (first) interval value in seconds
25754 * This interval value is @b decreased while the user holds the
25755 * mouse pointer either selecting next or previous month.
25757 * This helps the user to get to a given month distant from the
25758 * current one easier/faster, as it will start to change quicker and
25759 * quicker on mouse button holds.
25761 * The calculation for the next change interval value, starting from
25762 * the one set with this call, is the previous interval divided by
25763 * 1.05, so it decreases a little bit.
25765 * The default starting interval value for automatic changes is
25768 * @see elm_calendar_interval_get()
25770 * @ingroup Calendar
25772 EAPI void elm_calendar_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
25775 * Get the interval on time updates for an user mouse button hold
25776 * on calendar widgets' month selection.
25778 * @param obj The calendar object
25779 * @return The (first) interval value, in seconds, set on it
25781 * @see elm_calendar_interval_set() for more details
25783 * @ingroup Calendar
25785 EAPI double elm_calendar_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25792 * @defgroup Diskselector Diskselector
25793 * @ingroup Elementary
25795 * @image html img/widget/diskselector/preview-00.png
25796 * @image latex img/widget/diskselector/preview-00.eps
25798 * A diskselector is a kind of list widget. It scrolls horizontally,
25799 * and can contain label and icon objects. Three items are displayed
25800 * with the selected one in the middle.
25802 * It can act like a circular list with round mode and labels can be
25803 * reduced for a defined length for side items.
25805 * Smart callbacks one can listen to:
25806 * - "selected" - when item is selected, i.e. scroller stops.
25808 * Available styles for it:
25811 * List of examples:
25812 * @li @ref diskselector_example_01
25813 * @li @ref diskselector_example_02
25817 * @addtogroup Diskselector
25821 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(). */
25824 * Add a new diskselector widget to the given parent Elementary
25825 * (container) object.
25827 * @param parent The parent object.
25828 * @return a new diskselector widget handle or @c NULL, on errors.
25830 * This function inserts a new diskselector widget on the canvas.
25832 * @ingroup Diskselector
25834 EAPI Evas_Object *elm_diskselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
25837 * Enable or disable round mode.
25839 * @param obj The diskselector object.
25840 * @param round @c EINA_TRUE to enable round mode or @c EINA_FALSE to
25843 * Disabled by default. If round mode is enabled the items list will
25844 * work like a circle list, so when the user reaches the last item,
25845 * the first one will popup.
25847 * @see elm_diskselector_round_get()
25849 * @ingroup Diskselector
25851 EAPI void elm_diskselector_round_set(Evas_Object *obj, Eina_Bool round) EINA_ARG_NONNULL(1);
25854 * Get a value whether round mode is enabled or not.
25856 * @see elm_diskselector_round_set() for details.
25858 * @param obj The diskselector object.
25859 * @return @c EINA_TRUE means round mode is enabled. @c EINA_FALSE indicates
25860 * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
25862 * @ingroup Diskselector
25864 EAPI Eina_Bool elm_diskselector_round_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25867 * Get the side labels max length.
25869 * @deprecated use elm_diskselector_side_label_length_get() instead:
25871 * @param obj The diskselector object.
25872 * @return The max length defined for side labels, or 0 if not a valid
25875 * @ingroup Diskselector
25877 EINA_DEPRECATED EAPI int elm_diskselector_side_label_lenght_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25880 * Set the side labels max length.
25882 * @deprecated use elm_diskselector_side_label_length_set() instead:
25884 * @param obj The diskselector object.
25885 * @param len The max length defined for side labels.
25887 * @ingroup Diskselector
25889 EINA_DEPRECATED EAPI void elm_diskselector_side_label_lenght_set(Evas_Object *obj, int len) EINA_ARG_NONNULL(1);
25892 * Get the side labels max length.
25894 * @see elm_diskselector_side_label_length_set() for details.
25896 * @param obj The diskselector object.
25897 * @return The max length defined for side labels, or 0 if not a valid
25900 * @ingroup Diskselector
25902 EAPI int elm_diskselector_side_label_length_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25905 * Set the side labels max length.
25907 * @param obj The diskselector object.
25908 * @param len The max length defined for side labels.
25910 * Length is the number of characters of items' label that will be
25911 * visible when it's set on side positions. It will just crop
25912 * the string after defined size. E.g.:
25914 * An item with label "January" would be displayed on side position as
25915 * "Jan" if max length is set to 3, or "Janu", if this property
25918 * When it's selected, the entire label will be displayed, except for
25919 * width restrictions. In this case label will be cropped and "..."
25920 * will be concatenated.
25922 * Default side label max length is 3.
25924 * This property will be applyed over all items, included before or
25925 * later this function call.
25927 * @ingroup Diskselector
25929 EAPI void elm_diskselector_side_label_length_set(Evas_Object *obj, int len) EINA_ARG_NONNULL(1);
25932 * Set the number of items to be displayed.
25934 * @param obj The diskselector object.
25935 * @param num The number of items the diskselector will display.
25937 * Default value is 3, and also it's the minimun. If @p num is less
25938 * than 3, it will be set to 3.
25940 * Also, it can be set on theme, using data item @c display_item_num
25941 * on group "elm/diskselector/item/X", where X is style set.
25944 * group { name: "elm/diskselector/item/X";
25946 * item: "display_item_num" "5";
25949 * @ingroup Diskselector
25951 EAPI void elm_diskselector_display_item_num_set(Evas_Object *obj, int num) EINA_ARG_NONNULL(1);
25954 * Get the number of items in the diskselector object.
25956 * @param obj The diskselector object.
25958 * @ingroup Diskselector
25960 EAPI int elm_diskselector_display_item_num_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25963 * Set bouncing behaviour when the scrolled content reaches an edge.
25965 * Tell the internal scroller object whether it should bounce or not
25966 * when it reaches the respective edges for each axis.
25968 * @param obj The diskselector object.
25969 * @param h_bounce Whether to bounce or not in the horizontal axis.
25970 * @param v_bounce Whether to bounce or not in the vertical axis.
25972 * @see elm_scroller_bounce_set()
25974 * @ingroup Diskselector
25976 EAPI void elm_diskselector_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
25979 * Get the bouncing behaviour of the internal scroller.
25981 * Get whether the internal scroller should bounce when the edge of each
25982 * axis is reached scrolling.
25984 * @param obj The diskselector object.
25985 * @param h_bounce Pointer where to store the bounce state of the horizontal
25987 * @param v_bounce Pointer where to store the bounce state of the vertical
25990 * @see elm_scroller_bounce_get()
25991 * @see elm_diskselector_bounce_set()
25993 * @ingroup Diskselector
25995 EAPI void elm_diskselector_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
25998 * Get the scrollbar policy.
26000 * @see elm_diskselector_scroller_policy_get() for details.
26002 * @param obj The diskselector object.
26003 * @param policy_h Pointer where to store horizontal scrollbar policy.
26004 * @param policy_v Pointer where to store vertical scrollbar policy.
26006 * @ingroup Diskselector
26008 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);
26011 * Set the scrollbar policy.
26013 * @param obj The diskselector object.
26014 * @param policy_h Horizontal scrollbar policy.
26015 * @param policy_v Vertical scrollbar policy.
26017 * This sets the scrollbar visibility policy for the given scroller.
26018 * #ELM_SCROLLER_POLICY_AUTO means the scrollbar is made visible if it
26019 * is needed, and otherwise kept hidden. #ELM_SCROLLER_POLICY_ON turns
26020 * it on all the time, and #ELM_SCROLLER_POLICY_OFF always keeps it off.
26021 * This applies respectively for the horizontal and vertical scrollbars.
26023 * The both are disabled by default, i.e., are set to
26024 * #ELM_SCROLLER_POLICY_OFF.
26026 * @ingroup Diskselector
26028 EAPI void elm_diskselector_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
26031 * Remove all diskselector's items.
26033 * @param obj The diskselector object.
26035 * @see elm_diskselector_item_del()
26036 * @see elm_diskselector_item_append()
26038 * @ingroup Diskselector
26040 EAPI void elm_diskselector_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
26043 * Get a list of all the diskselector items.
26045 * @param obj The diskselector object.
26046 * @return An @c Eina_List of diskselector items, #Elm_Diskselector_Item,
26047 * or @c NULL on failure.
26049 * @see elm_diskselector_item_append()
26050 * @see elm_diskselector_item_del()
26051 * @see elm_diskselector_clear()
26053 * @ingroup Diskselector
26055 EAPI const Eina_List *elm_diskselector_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26058 * Appends a new item to the diskselector object.
26060 * @param obj The diskselector object.
26061 * @param label The label of the diskselector item.
26062 * @param icon The icon object to use at left side of the item. An
26063 * icon can be any Evas object, but usually it is an icon created
26064 * with elm_icon_add().
26065 * @param func The function to call when the item is selected.
26066 * @param data The data to associate with the item for related callbacks.
26068 * @return The created item or @c NULL upon failure.
26070 * A new item will be created and appended to the diskselector, i.e., will
26071 * be set as last item. Also, if there is no selected item, it will
26072 * be selected. This will always happens for the first appended item.
26074 * If no icon is set, label will be centered on item position, otherwise
26075 * the icon will be placed at left of the label, that will be shifted
26078 * Items created with this method can be deleted with
26079 * elm_diskselector_item_del().
26081 * Associated @p data can be properly freed when item is deleted if a
26082 * callback function is set with elm_diskselector_item_del_cb_set().
26084 * If a function is passed as argument, it will be called everytime this item
26085 * is selected, i.e., the user stops the diskselector with this
26086 * item on center position. If such function isn't needed, just passing
26087 * @c NULL as @p func is enough. The same should be done for @p data.
26089 * Simple example (with no function callback or data associated):
26091 * disk = elm_diskselector_add(win);
26092 * ic = elm_icon_add(win);
26093 * elm_icon_file_set(ic, "path/to/image", NULL);
26094 * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
26095 * elm_diskselector_item_append(disk, "label", ic, NULL, NULL);
26098 * @see elm_diskselector_item_del()
26099 * @see elm_diskselector_item_del_cb_set()
26100 * @see elm_diskselector_clear()
26101 * @see elm_icon_add()
26103 * @ingroup Diskselector
26105 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);
26109 * Delete them item from the diskselector.
26111 * @param it The item of diskselector to be deleted.
26113 * If deleting all diskselector items is required, elm_diskselector_clear()
26114 * should be used instead of getting items list and deleting each one.
26116 * @see elm_diskselector_clear()
26117 * @see elm_diskselector_item_append()
26118 * @see elm_diskselector_item_del_cb_set()
26120 * @ingroup Diskselector
26122 EAPI void elm_diskselector_item_del(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26125 * Set the function called when a diskselector item is freed.
26127 * @param it The item to set the callback on
26128 * @param func The function called
26130 * If there is a @p func, then it will be called prior item's memory release.
26131 * That will be called with the following arguments:
26133 * @li item's Evas object;
26136 * This way, a data associated to a diskselector item could be properly
26139 * @ingroup Diskselector
26141 EAPI void elm_diskselector_item_del_cb_set(Elm_Diskselector_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
26144 * Get the data associated to the item.
26146 * @param it The diskselector item
26147 * @return The data associated to @p it
26149 * The return value is a pointer to data associated to @p item when it was
26150 * created, with function elm_diskselector_item_append(). If no data
26151 * was passed as argument, it will return @c NULL.
26153 * @see elm_diskselector_item_append()
26155 * @ingroup Diskselector
26157 EAPI void *elm_diskselector_item_data_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26160 * Set the icon associated to the item.
26162 * @param it The diskselector item
26163 * @param icon The icon object to associate with @p it
26165 * The icon object to use at left side of the item. An
26166 * icon can be any Evas object, but usually it is an icon created
26167 * with elm_icon_add().
26169 * Once the icon object is set, a previously set one will be deleted.
26170 * @warning Setting the same icon for two items will cause the icon to
26171 * dissapear from the first item.
26173 * If an icon was passed as argument on item creation, with function
26174 * elm_diskselector_item_append(), it will be already
26175 * associated to the item.
26177 * @see elm_diskselector_item_append()
26178 * @see elm_diskselector_item_icon_get()
26180 * @ingroup Diskselector
26182 EAPI void elm_diskselector_item_icon_set(Elm_Diskselector_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
26185 * Get the icon associated to the item.
26187 * @param it The diskselector item
26188 * @return The icon associated to @p it
26190 * The return value is a pointer to the icon associated to @p item when it was
26191 * created, with function elm_diskselector_item_append(), or later
26192 * with function elm_diskselector_item_icon_set. If no icon
26193 * was passed as argument, it will return @c NULL.
26195 * @see elm_diskselector_item_append()
26196 * @see elm_diskselector_item_icon_set()
26198 * @ingroup Diskselector
26200 EAPI Evas_Object *elm_diskselector_item_icon_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26203 * Set the label of item.
26205 * @param it The item of diskselector.
26206 * @param label The label of item.
26208 * The label to be displayed by the item.
26210 * If no icon is set, label will be centered on item position, otherwise
26211 * the icon will be placed at left of the label, that will be shifted
26214 * An item with label "January" would be displayed on side position as
26215 * "Jan" if max length is set to 3 with function
26216 * elm_diskselector_side_label_lenght_set(), or "Janu", if this property
26219 * When this @p item is selected, the entire label will be displayed,
26220 * except for width restrictions.
26221 * In this case label will be cropped and "..." will be concatenated,
26222 * but only for display purposes. It will keep the entire string, so
26223 * if diskselector is resized the remaining characters will be displayed.
26225 * If a label was passed as argument on item creation, with function
26226 * elm_diskselector_item_append(), it will be already
26227 * displayed by the item.
26229 * @see elm_diskselector_side_label_lenght_set()
26230 * @see elm_diskselector_item_label_get()
26231 * @see elm_diskselector_item_append()
26233 * @ingroup Diskselector
26235 EAPI void elm_diskselector_item_label_set(Elm_Diskselector_Item *item, const char *label) EINA_ARG_NONNULL(1);
26238 * Get the label of item.
26240 * @param it The item of diskselector.
26241 * @return The label of item.
26243 * The return value is a pointer to the label associated to @p item when it was
26244 * created, with function elm_diskselector_item_append(), or later
26245 * with function elm_diskselector_item_label_set. If no label
26246 * was passed as argument, it will return @c NULL.
26248 * @see elm_diskselector_item_label_set() for more details.
26249 * @see elm_diskselector_item_append()
26251 * @ingroup Diskselector
26253 EAPI const char *elm_diskselector_item_label_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26256 * Get the selected item.
26258 * @param obj The diskselector object.
26259 * @return The selected diskselector item.
26261 * The selected item can be unselected with function
26262 * elm_diskselector_item_selected_set(), and the first item of
26263 * diskselector will be selected.
26265 * The selected item always will be centered on diskselector, with
26266 * full label displayed, i.e., max lenght set to side labels won't
26267 * apply on the selected item. More details on
26268 * elm_diskselector_side_label_length_set().
26270 * @ingroup Diskselector
26272 EAPI Elm_Diskselector_Item *elm_diskselector_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26275 * Set the selected state of an item.
26277 * @param it The diskselector item
26278 * @param selected The selected state
26280 * This sets the selected state of the given item @p it.
26281 * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
26283 * If a new item is selected the previosly selected will be unselected.
26284 * Previoulsy selected item can be get with function
26285 * elm_diskselector_selected_item_get().
26287 * If the item @p it is unselected, the first item of diskselector will
26290 * Selected items will be visible on center position of diskselector.
26291 * So if it was on another position before selected, or was invisible,
26292 * diskselector will animate items until the selected item reaches center
26295 * @see elm_diskselector_item_selected_get()
26296 * @see elm_diskselector_selected_item_get()
26298 * @ingroup Diskselector
26300 EAPI void elm_diskselector_item_selected_set(Elm_Diskselector_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
26303 * Get whether the @p item is selected or not.
26305 * @param it The diskselector item.
26306 * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
26307 * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
26309 * @see elm_diskselector_selected_item_set() for details.
26310 * @see elm_diskselector_item_selected_get()
26312 * @ingroup Diskselector
26314 EAPI Eina_Bool elm_diskselector_item_selected_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26317 * Get the first item of the diskselector.
26319 * @param obj The diskselector object.
26320 * @return The first item, or @c NULL if none.
26322 * The list of items follows append order. So it will return the first
26323 * item appended to the widget that wasn't deleted.
26325 * @see elm_diskselector_item_append()
26326 * @see elm_diskselector_items_get()
26328 * @ingroup Diskselector
26330 EAPI Elm_Diskselector_Item *elm_diskselector_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26333 * Get the last item of the diskselector.
26335 * @param obj The diskselector object.
26336 * @return The last item, or @c NULL if none.
26338 * The list of items follows append order. So it will return last first
26339 * item appended to the widget that wasn't deleted.
26341 * @see elm_diskselector_item_append()
26342 * @see elm_diskselector_items_get()
26344 * @ingroup Diskselector
26346 EAPI Elm_Diskselector_Item *elm_diskselector_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26349 * Get the item before @p item in diskselector.
26351 * @param it The diskselector item.
26352 * @return The item before @p item, or @c NULL if none or on failure.
26354 * The list of items follows append order. So it will return item appended
26355 * just before @p item and that wasn't deleted.
26357 * If it is the first item, @c NULL will be returned.
26358 * First item can be get by elm_diskselector_first_item_get().
26360 * @see elm_diskselector_item_append()
26361 * @see elm_diskselector_items_get()
26363 * @ingroup Diskselector
26365 EAPI Elm_Diskselector_Item *elm_diskselector_item_prev_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26368 * Get the item after @p item in diskselector.
26370 * @param it The diskselector item.
26371 * @return The item after @p item, or @c NULL if none or on failure.
26373 * The list of items follows append order. So it will return item appended
26374 * just after @p item and that wasn't deleted.
26376 * If it is the last item, @c NULL will be returned.
26377 * Last item can be get by elm_diskselector_last_item_get().
26379 * @see elm_diskselector_item_append()
26380 * @see elm_diskselector_items_get()
26382 * @ingroup Diskselector
26384 EAPI Elm_Diskselector_Item *elm_diskselector_item_next_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26387 * Set the text to be shown in the diskselector item.
26389 * @param item Target item
26390 * @param text The text to set in the content
26392 * Setup the text as tooltip to object. The item can have only one tooltip,
26393 * so any previous tooltip data is removed.
26395 * @see elm_object_tooltip_text_set() for more details.
26397 * @ingroup Diskselector
26399 EAPI void elm_diskselector_item_tooltip_text_set(Elm_Diskselector_Item *item, const char *text) EINA_ARG_NONNULL(1);
26402 * Set the content to be shown in the tooltip item.
26404 * Setup the tooltip to item. The item can have only one tooltip,
26405 * so any previous tooltip data is removed. @p func(with @p data) will
26406 * be called every time that need show the tooltip and it should
26407 * return a valid Evas_Object. This object is then managed fully by
26408 * tooltip system and is deleted when the tooltip is gone.
26410 * @param item the diskselector item being attached a tooltip.
26411 * @param func the function used to create the tooltip contents.
26412 * @param data what to provide to @a func as callback data/context.
26413 * @param del_cb called when data is not needed anymore, either when
26414 * another callback replaces @p func, the tooltip is unset with
26415 * elm_diskselector_item_tooltip_unset() or the owner @a item
26416 * dies. This callback receives as the first parameter the
26417 * given @a data, and @c event_info is the item.
26419 * @see elm_object_tooltip_content_cb_set() for more details.
26421 * @ingroup Diskselector
26423 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);
26426 * Unset tooltip from item.
26428 * @param item diskselector item to remove previously set tooltip.
26430 * Remove tooltip from item. The callback provided as del_cb to
26431 * elm_diskselector_item_tooltip_content_cb_set() will be called to notify
26432 * it is not used anymore.
26434 * @see elm_object_tooltip_unset() for more details.
26435 * @see elm_diskselector_item_tooltip_content_cb_set()
26437 * @ingroup Diskselector
26439 EAPI void elm_diskselector_item_tooltip_unset(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26443 * Sets a different style for this item tooltip.
26445 * @note before you set a style you should define a tooltip with
26446 * elm_diskselector_item_tooltip_content_cb_set() or
26447 * elm_diskselector_item_tooltip_text_set()
26449 * @param item diskselector item with tooltip already set.
26450 * @param style the theme style to use (default, transparent, ...)
26452 * @see elm_object_tooltip_style_set() for more details.
26454 * @ingroup Diskselector
26456 EAPI void elm_diskselector_item_tooltip_style_set(Elm_Diskselector_Item *item, const char *style) EINA_ARG_NONNULL(1);
26459 * Get the style for this item tooltip.
26461 * @param item diskselector item with tooltip already set.
26462 * @return style the theme style in use, defaults to "default". If the
26463 * object does not have a tooltip set, then NULL is returned.
26465 * @see elm_object_tooltip_style_get() for more details.
26466 * @see elm_diskselector_item_tooltip_style_set()
26468 * @ingroup Diskselector
26470 EAPI const char *elm_diskselector_item_tooltip_style_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26473 * Set the cursor to be shown when mouse is over the diskselector item
26475 * @param item Target item
26476 * @param cursor the cursor name to be used.
26478 * @see elm_object_cursor_set() for more details.
26480 * @ingroup Diskselector
26482 EAPI void elm_diskselector_item_cursor_set(Elm_Diskselector_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
26485 * Get the cursor to be shown when mouse is over the diskselector item
26487 * @param item diskselector item with cursor already set.
26488 * @return the cursor name.
26490 * @see elm_object_cursor_get() for more details.
26491 * @see elm_diskselector_cursor_set()
26493 * @ingroup Diskselector
26495 EAPI const char *elm_diskselector_item_cursor_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26499 * Unset the cursor to be shown when mouse is over the diskselector item
26501 * @param item Target item
26503 * @see elm_object_cursor_unset() for more details.
26504 * @see elm_diskselector_cursor_set()
26506 * @ingroup Diskselector
26508 EAPI void elm_diskselector_item_cursor_unset(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26511 * Sets a different style for this item cursor.
26513 * @note before you set a style you should define a cursor with
26514 * elm_diskselector_item_cursor_set()
26516 * @param item diskselector item with cursor already set.
26517 * @param style the theme style to use (default, transparent, ...)
26519 * @see elm_object_cursor_style_set() for more details.
26521 * @ingroup Diskselector
26523 EAPI void elm_diskselector_item_cursor_style_set(Elm_Diskselector_Item *item, const char *style) EINA_ARG_NONNULL(1);
26527 * Get the style for this item cursor.
26529 * @param item diskselector item with cursor already set.
26530 * @return style the theme style in use, defaults to "default". If the
26531 * object does not have a cursor set, then @c NULL is returned.
26533 * @see elm_object_cursor_style_get() for more details.
26534 * @see elm_diskselector_item_cursor_style_set()
26536 * @ingroup Diskselector
26538 EAPI const char *elm_diskselector_item_cursor_style_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26542 * Set if the cursor set should be searched on the theme or should use
26543 * the provided by the engine, only.
26545 * @note before you set if should look on theme you should define a cursor
26546 * with elm_diskselector_item_cursor_set().
26547 * By default it will only look for cursors provided by the engine.
26549 * @param item widget item with cursor already set.
26550 * @param engine_only boolean to define if cursors set with
26551 * elm_diskselector_item_cursor_set() should be searched only
26552 * between cursors provided by the engine or searched on widget's
26555 * @see elm_object_cursor_engine_only_set() for more details.
26557 * @ingroup Diskselector
26559 EAPI void elm_diskselector_item_cursor_engine_only_set(Elm_Diskselector_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
26562 * Get the cursor engine only usage for this item cursor.
26564 * @param item widget item with cursor already set.
26565 * @return engine_only boolean to define it cursors should be looked only
26566 * between the provided by the engine or searched on widget's theme as well.
26567 * If the item does not have a cursor set, then @c EINA_FALSE is returned.
26569 * @see elm_object_cursor_engine_only_get() for more details.
26570 * @see elm_diskselector_item_cursor_engine_only_set()
26572 * @ingroup Diskselector
26574 EAPI Eina_Bool elm_diskselector_item_cursor_engine_only_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26581 * @defgroup Colorselector Colorselector
26585 * @image html img/widget/colorselector/preview-00.png
26586 * @image latex img/widget/colorselector/preview-00.eps
26588 * @brief Widget for user to select a color.
26590 * Signals that you can add callbacks for are:
26591 * "changed" - When the color value changes(event_info is NULL).
26593 * See @ref tutorial_colorselector.
26596 * @brief Add a new colorselector to the parent
26598 * @param parent The parent object
26599 * @return The new object or NULL if it cannot be created
26601 * @ingroup Colorselector
26603 EAPI Evas_Object *elm_colorselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
26605 * Set a color for the colorselector
26607 * @param obj Colorselector object
26608 * @param r r-value of color
26609 * @param g g-value of color
26610 * @param b b-value of color
26611 * @param a a-value of color
26613 * @ingroup Colorselector
26615 EAPI void elm_colorselector_color_set(Evas_Object *obj, int r, int g , int b, int a) EINA_ARG_NONNULL(1);
26617 * Get a color from the colorselector
26619 * @param obj Colorselector object
26620 * @param r integer pointer for r-value of color
26621 * @param g integer pointer for g-value of color
26622 * @param b integer pointer for b-value of color
26623 * @param a integer pointer for a-value of color
26625 * @ingroup Colorselector
26627 EAPI void elm_colorselector_color_get(const Evas_Object *obj, int *r, int *g , int *b, int *a) EINA_ARG_NONNULL(1);
26633 * @defgroup Ctxpopup Ctxpopup
26635 * @image html img/widget/ctxpopup/preview-00.png
26636 * @image latex img/widget/ctxpopup/preview-00.eps
26638 * @brief Context popup widet.
26640 * A ctxpopup is a widget that, when shown, pops up a list of items.
26641 * It automatically chooses an area inside its parent object's view
26642 * (set via elm_ctxpopup_add() and elm_ctxpopup_hover_parent_set()) to
26643 * optimally fit into it. In the default theme, it will also point an
26644 * arrow to it's top left position at the time one shows it. Ctxpopup
26645 * items have a label and/or an icon. It is intended for a small
26646 * number of items (hence the use of list, not genlist).
26648 * @note Ctxpopup is a especialization of @ref Hover.
26650 * Signals that you can add callbacks for are:
26651 * "dismissed" - the ctxpopup was dismissed
26653 * Default contents parts of the ctxpopup widget that you can use for are:
26654 * @li "default" - A content of the ctxpopup
26656 * Default contents parts of the naviframe items that you can use for are:
26657 * @li "icon" - A icon in the title area
26659 * Default text parts of the naviframe items that you can use for are:
26660 * @li "default" - Title label in the title area
26662 * @ref tutorial_ctxpopup shows the usage of a good deal of the API.
26665 typedef enum _Elm_Ctxpopup_Direction
26667 ELM_CTXPOPUP_DIRECTION_DOWN, /**< ctxpopup show appear below clicked
26669 ELM_CTXPOPUP_DIRECTION_RIGHT, /**< ctxpopup show appear to the right of
26670 the clicked area */
26671 ELM_CTXPOPUP_DIRECTION_LEFT, /**< ctxpopup show appear to the left of
26672 the clicked area */
26673 ELM_CTXPOPUP_DIRECTION_UP, /**< ctxpopup show appear above the clicked
26675 ELM_CTXPOPUP_DIRECTION_UNKNOWN, /**< ctxpopup does not determine it's direction yet*/
26676 } Elm_Ctxpopup_Direction;
26679 * @brief Add a new Ctxpopup object to the parent.
26681 * @param parent Parent object
26682 * @return New object or @c NULL, if it cannot be created
26684 EAPI Evas_Object *elm_ctxpopup_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
26686 * @brief Set the Ctxpopup's parent
26688 * @param obj The ctxpopup object
26689 * @param area The parent to use
26691 * Set the parent object.
26693 * @note elm_ctxpopup_add() will automatically call this function
26694 * with its @c parent argument.
26696 * @see elm_ctxpopup_add()
26697 * @see elm_hover_parent_set()
26699 EAPI void elm_ctxpopup_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1, 2);
26701 * @brief Get the Ctxpopup's parent
26703 * @param obj The ctxpopup object
26705 * @see elm_ctxpopup_hover_parent_set() for more information
26707 EAPI Evas_Object *elm_ctxpopup_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26709 * @brief Clear all items in the given ctxpopup object.
26711 * @param obj Ctxpopup object
26713 EAPI void elm_ctxpopup_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
26715 * @brief Change the ctxpopup's orientation to horizontal or vertical.
26717 * @param obj Ctxpopup object
26718 * @param horizontal @c EINA_TRUE for horizontal mode, @c EINA_FALSE for vertical
26720 EAPI void elm_ctxpopup_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
26722 * @brief Get the value of current ctxpopup object's orientation.
26724 * @param obj Ctxpopup object
26725 * @return @c EINA_TRUE for horizontal mode, @c EINA_FALSE for vertical mode (or errors)
26727 * @see elm_ctxpopup_horizontal_set()
26729 EAPI Eina_Bool elm_ctxpopup_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26731 * @brief Add a new item to a ctxpopup object.
26733 * @param obj Ctxpopup object
26734 * @param icon Icon to be set on new item
26735 * @param label The Label of the new item
26736 * @param func Convenience function called when item selected
26737 * @param data Data passed to @p func
26738 * @return A handle to the item added or @c NULL, on errors
26740 * @warning Ctxpopup can't hold both an item list and a content at the same
26741 * time. When an item is added, any previous content will be removed.
26743 * @see elm_ctxpopup_content_set()
26745 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);
26747 * @brief Delete the given item in a ctxpopup object.
26749 * @param it Ctxpopup item to be deleted
26751 * @see elm_ctxpopup_item_append()
26753 EAPI void elm_ctxpopup_item_del(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26755 * @brief Set the ctxpopup item's state as disabled or enabled.
26757 * @param it Ctxpopup item to be enabled/disabled
26758 * @param disabled @c EINA_TRUE to disable it, @c EINA_FALSE to enable it
26760 * When disabled the item is greyed out to indicate it's state.
26761 * @deprecated use elm_object_item_disabled_set() instead
26763 EINA_DEPRECATED EAPI void elm_ctxpopup_item_disabled_set(Elm_Object_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1);
26765 * @brief Get the ctxpopup item's disabled/enabled state.
26767 * @param it Ctxpopup item to be enabled/disabled
26768 * @return disabled @c EINA_TRUE, if disabled, @c EINA_FALSE otherwise
26770 * @see elm_ctxpopup_item_disabled_set()
26771 * @deprecated use elm_object_item_disabled_get() instead
26773 EAPI Eina_Bool elm_ctxpopup_item_disabled_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26775 * @brief Get the icon object for the given ctxpopup item.
26777 * @param it Ctxpopup item
26778 * @return icon object or @c NULL, if the item does not have icon or an error
26781 * @see elm_ctxpopup_item_append()
26782 * @see elm_ctxpopup_item_icon_set()
26784 * @deprecated use elm_object_item_part_content_get() instead
26786 EINA_DEPRECATED EAPI Evas_Object *elm_ctxpopup_item_icon_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26788 * @brief Sets the side icon associated with the ctxpopup item
26790 * @param it Ctxpopup item
26791 * @param icon Icon object to be set
26793 * Once the icon object is set, a previously set one will be deleted.
26794 * @warning Setting the same icon for two items will cause the icon to
26795 * dissapear from the first item.
26797 * @see elm_ctxpopup_item_append()
26799 * @deprecated use elm_object_item_part_content_set() instead
26802 EINA_DEPRECATED EAPI void elm_ctxpopup_item_icon_set(Elm_Object_Item *it, Evas_Object *icon) EINA_ARG_NONNULL(1);
26804 * @brief Get the label for the given ctxpopup item.
26806 * @param it Ctxpopup item
26807 * @return label string or @c NULL, if the item does not have label or an
26810 * @see elm_ctxpopup_item_append()
26811 * @see elm_ctxpopup_item_label_set()
26813 * @deprecated use elm_object_item_text_get() instead
26815 EINA_DEPRECATED EAPI const char *elm_ctxpopup_item_label_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26817 * @brief (Re)set the label on the given ctxpopup item.
26819 * @param it Ctxpopup item
26820 * @param label String to set as label
26822 * @deprecated use elm_object_item_text_set() instead
26824 EINA_DEPRECATED EAPI void elm_ctxpopup_item_label_set(Elm_Object_Item *it, const char *label) EINA_ARG_NONNULL(1);
26826 * @brief Set an elm widget as the content of the ctxpopup.
26828 * @param obj Ctxpopup object
26829 * @param content Content to be swallowed
26831 * If the content object is already set, a previous one will bedeleted. If
26832 * you want to keep that old content object, use the
26833 * elm_ctxpopup_content_unset() function.
26835 * @warning Ctxpopup can't hold both a item list and a content at the same
26836 * time. When a content is set, any previous items will be removed.
26838 * @deprecated use elm_object_content_set() instead
26841 EINA_DEPRECATED EAPI void elm_ctxpopup_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1, 2);
26843 * @brief Unset the ctxpopup content
26845 * @param obj Ctxpopup object
26846 * @return The content that was being used
26848 * Unparent and return the content object which was set for this widget.
26850 * @deprecated use elm_object_content_unset()
26852 * @see elm_ctxpopup_content_set()
26854 * @deprecated use elm_object_content_unset() instead
26857 EINA_DEPRECATED EAPI Evas_Object *elm_ctxpopup_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
26859 * @brief Set the direction priority of a ctxpopup.
26861 * @param obj Ctxpopup object
26862 * @param first 1st priority of direction
26863 * @param second 2nd priority of direction
26864 * @param third 3th priority of direction
26865 * @param fourth 4th priority of direction
26867 * This functions gives a chance to user to set the priority of ctxpopup
26868 * showing direction. This doesn't guarantee the ctxpopup will appear in the
26869 * requested direction.
26871 * @see Elm_Ctxpopup_Direction
26873 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);
26875 * @brief Get the direction priority of a ctxpopup.
26877 * @param obj Ctxpopup object
26878 * @param first 1st priority of direction to be returned
26879 * @param second 2nd priority of direction to be returned
26880 * @param third 3th priority of direction to be returned
26881 * @param fourth 4th priority of direction to be returned
26883 * @see elm_ctxpopup_direction_priority_set() for more information.
26885 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);
26888 * @brief Get the current direction of a ctxpopup.
26890 * @param obj Ctxpopup object
26891 * @return current direction of a ctxpopup
26893 * @warning Once the ctxpopup showed up, the direction would be determined
26895 EAPI Elm_Ctxpopup_Direction elm_ctxpopup_direction_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26904 * @defgroup Transit Transit
26905 * @ingroup Elementary
26907 * Transit is designed to apply various animated transition effects to @c
26908 * Evas_Object, such like translation, rotation, etc. For using these
26909 * effects, create an @ref Elm_Transit and add the desired transition effects.
26911 * Once the effects are added into transit, they will be automatically
26912 * managed (their callback will be called until the duration is ended, and
26913 * they will be deleted on completion).
26917 * Elm_Transit *trans = elm_transit_add();
26918 * elm_transit_object_add(trans, obj);
26919 * elm_transit_effect_translation_add(trans, 0, 0, 280, 280
26920 * elm_transit_duration_set(transit, 1);
26921 * elm_transit_auto_reverse_set(transit, EINA_TRUE);
26922 * elm_transit_tween_mode_set(transit, ELM_TRANSIT_TWEEN_MODE_DECELERATE);
26923 * elm_transit_repeat_times_set(transit, 3);
26926 * Some transition effects are used to change the properties of objects. They
26928 * @li @ref elm_transit_effect_translation_add
26929 * @li @ref elm_transit_effect_color_add
26930 * @li @ref elm_transit_effect_rotation_add
26931 * @li @ref elm_transit_effect_wipe_add
26932 * @li @ref elm_transit_effect_zoom_add
26933 * @li @ref elm_transit_effect_resizing_add
26935 * Other transition effects are used to make one object disappear and another
26936 * object appear on its old place. These effects are:
26938 * @li @ref elm_transit_effect_flip_add
26939 * @li @ref elm_transit_effect_resizable_flip_add
26940 * @li @ref elm_transit_effect_fade_add
26941 * @li @ref elm_transit_effect_blend_add
26943 * It's also possible to make a transition chain with @ref
26944 * elm_transit_chain_transit_add.
26946 * @warning We strongly recommend to use elm_transit just when edje can not do
26947 * the trick. Edje has more advantage than Elm_Transit, it has more flexibility and
26948 * animations can be manipulated inside the theme.
26950 * List of examples:
26951 * @li @ref transit_example_01_explained
26952 * @li @ref transit_example_02_explained
26953 * @li @ref transit_example_03_c
26954 * @li @ref transit_example_04_c
26960 * @enum Elm_Transit_Tween_Mode
26962 * The type of acceleration used in the transition.
26966 ELM_TRANSIT_TWEEN_MODE_LINEAR, /**< Constant speed */
26967 ELM_TRANSIT_TWEEN_MODE_SINUSOIDAL, /**< Starts slow, increase speed
26968 over time, then decrease again
26970 ELM_TRANSIT_TWEEN_MODE_DECELERATE, /**< Starts fast and decrease
26972 ELM_TRANSIT_TWEEN_MODE_ACCELERATE /**< Starts slow and increase speed
26974 } Elm_Transit_Tween_Mode;
26977 * @enum Elm_Transit_Effect_Flip_Axis
26979 * The axis where flip effect should be applied.
26983 ELM_TRANSIT_EFFECT_FLIP_AXIS_X, /**< Flip on X axis */
26984 ELM_TRANSIT_EFFECT_FLIP_AXIS_Y /**< Flip on Y axis */
26985 } Elm_Transit_Effect_Flip_Axis;
26987 * @enum Elm_Transit_Effect_Wipe_Dir
26989 * The direction where the wipe effect should occur.
26993 ELM_TRANSIT_EFFECT_WIPE_DIR_LEFT, /**< Wipe to the left */
26994 ELM_TRANSIT_EFFECT_WIPE_DIR_RIGHT, /**< Wipe to the right */
26995 ELM_TRANSIT_EFFECT_WIPE_DIR_UP, /**< Wipe up */
26996 ELM_TRANSIT_EFFECT_WIPE_DIR_DOWN /**< Wipe down */
26997 } Elm_Transit_Effect_Wipe_Dir;
26998 /** @enum Elm_Transit_Effect_Wipe_Type
27000 * Whether the wipe effect should show or hide the object.
27004 ELM_TRANSIT_EFFECT_WIPE_TYPE_HIDE, /**< Hide the object during the
27006 ELM_TRANSIT_EFFECT_WIPE_TYPE_SHOW /**< Show the object during the
27008 } Elm_Transit_Effect_Wipe_Type;
27011 * @typedef Elm_Transit
27013 * The Transit created with elm_transit_add(). This type has the information
27014 * about the objects which the transition will be applied, and the
27015 * transition effects that will be used. It also contains info about
27016 * duration, number of repetitions, auto-reverse, etc.
27018 typedef struct _Elm_Transit Elm_Transit;
27019 typedef void Elm_Transit_Effect;
27021 * @typedef Elm_Transit_Effect_Transition_Cb
27023 * Transition callback called for this effect on each transition iteration.
27025 typedef void (*Elm_Transit_Effect_Transition_Cb) (Elm_Transit_Effect *effect, Elm_Transit *transit, double progress);
27027 * Elm_Transit_Effect_End_Cb
27029 * Transition callback called for this effect when the transition is over.
27031 typedef void (*Elm_Transit_Effect_End_Cb) (Elm_Transit_Effect *effect, Elm_Transit *transit);
27034 * Elm_Transit_Del_Cb
27036 * A callback called when the transit is deleted.
27038 typedef void (*Elm_Transit_Del_Cb) (void *data, Elm_Transit *transit);
27043 * @note Is not necessary to delete the transit object, it will be deleted at
27044 * the end of its operation.
27045 * @note The transit will start playing when the program enter in the main loop, is not
27046 * necessary to give a start to the transit.
27048 * @return The transit object.
27052 EAPI Elm_Transit *elm_transit_add(void);
27055 * Stops the animation and delete the @p transit object.
27057 * Call this function if you wants to stop the animation before the duration
27058 * time. Make sure the @p transit object is still alive with
27059 * elm_transit_del_cb_set() function.
27060 * All added effects will be deleted, calling its repective data_free_cb
27061 * functions. The function setted by elm_transit_del_cb_set() will be called.
27063 * @see elm_transit_del_cb_set()
27065 * @param transit The transit object to be deleted.
27068 * @warning Just call this function if you are sure the transit is alive.
27070 EAPI void elm_transit_del(Elm_Transit *transit) EINA_ARG_NONNULL(1);
27073 * Add a new effect to the transit.
27075 * @note The cb function and the data are the key to the effect. If you try to
27076 * add an already added effect, nothing is done.
27077 * @note After the first addition of an effect in @p transit, if its
27078 * effect list become empty again, the @p transit will be killed by
27079 * elm_transit_del(transit) function.
27083 * Elm_Transit *transit = elm_transit_add();
27084 * elm_transit_effect_add(transit,
27085 * elm_transit_effect_blend_op,
27086 * elm_transit_effect_blend_context_new(),
27087 * elm_transit_effect_blend_context_free);
27090 * @param transit The transit object.
27091 * @param transition_cb The operation function. It is called when the
27092 * animation begins, it is the function that actually performs the animation.
27093 * It is called with the @p data, @p transit and the time progression of the
27094 * animation (a double value between 0.0 and 1.0).
27095 * @param effect The context data of the effect.
27096 * @param end_cb The function to free the context data, it will be called
27097 * at the end of the effect, it must finalize the animation and free the
27101 * @warning The transit free the context data at the and of the transition with
27102 * the data_free_cb function, do not use the context data in another transit.
27104 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);
27107 * Delete an added effect.
27109 * This function will remove the effect from the @p transit, calling the
27110 * data_free_cb to free the @p data.
27112 * @see elm_transit_effect_add()
27114 * @note If the effect is not found, nothing is done.
27115 * @note If the effect list become empty, this function will call
27116 * elm_transit_del(transit), that is, it will kill the @p transit.
27118 * @param transit The transit object.
27119 * @param transition_cb The operation function.
27120 * @param effect The context data of the effect.
27124 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);
27127 * Add new object to apply the effects.
27129 * @note After the first addition of an object in @p transit, if its
27130 * object list become empty again, the @p transit will be killed by
27131 * elm_transit_del(transit) function.
27132 * @note If the @p obj belongs to another transit, the @p obj will be
27133 * removed from it and it will only belong to the @p transit. If the old
27134 * transit stays without objects, it will die.
27135 * @note When you add an object into the @p transit, its state from
27136 * evas_object_pass_events_get(obj) is saved, and it is applied when the
27137 * transit ends, if you change this state whith evas_object_pass_events_set()
27138 * after add the object, this state will change again when @p transit stops to
27141 * @param transit The transit object.
27142 * @param obj Object to be animated.
27145 * @warning It is not allowed to add a new object after transit begins to go.
27147 EAPI void elm_transit_object_add(Elm_Transit *transit, Evas_Object *obj) EINA_ARG_NONNULL(1, 2);
27150 * Removes an added object from the transit.
27152 * @note If the @p obj is not in the @p transit, nothing is done.
27153 * @note If the list become empty, this function will call
27154 * elm_transit_del(transit), that is, it will kill the @p transit.
27156 * @param transit The transit object.
27157 * @param obj Object to be removed from @p transit.
27160 * @warning It is not allowed to remove objects after transit begins to go.
27162 EAPI void elm_transit_object_remove(Elm_Transit *transit, Evas_Object *obj) EINA_ARG_NONNULL(1, 2);
27165 * Get the objects of the transit.
27167 * @param transit The transit object.
27168 * @return a Eina_List with the objects from the transit.
27172 EAPI const Eina_List *elm_transit_objects_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27175 * Enable/disable keeping up the objects states.
27176 * If it is not kept, the objects states will be reset when transition ends.
27178 * @note @p transit can not be NULL.
27179 * @note One state includes geometry, color, map data.
27181 * @param transit The transit object.
27182 * @param state_keep Keeping or Non Keeping.
27186 EAPI void elm_transit_objects_final_state_keep_set(Elm_Transit *transit, Eina_Bool state_keep) EINA_ARG_NONNULL(1);
27189 * Get a value whether the objects states will be reset or not.
27191 * @note @p transit can not be NULL
27193 * @see elm_transit_objects_final_state_keep_set()
27195 * @param transit The transit object.
27196 * @return EINA_TRUE means the states of the objects will be reset.
27197 * If @p transit is NULL, EINA_FALSE is returned
27201 EAPI Eina_Bool elm_transit_objects_final_state_keep_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27204 * Set the event enabled when transit is operating.
27206 * If @p enabled is EINA_TRUE, the objects of the transit will receives
27207 * events from mouse and keyboard during the animation.
27208 * @note When you add an object with elm_transit_object_add(), its state from
27209 * evas_object_pass_events_get(obj) is saved, and it is applied when the
27210 * transit ends, if you change this state with evas_object_pass_events_set()
27211 * after adding the object, this state will change again when @p transit stops
27214 * @param transit The transit object.
27215 * @param enabled Events are received when enabled is @c EINA_TRUE, and
27216 * ignored otherwise.
27220 EAPI void elm_transit_event_enabled_set(Elm_Transit *transit, Eina_Bool enabled) EINA_ARG_NONNULL(1);
27223 * Get the value of event enabled status.
27225 * @see elm_transit_event_enabled_set()
27227 * @param transit The Transit object
27228 * @return EINA_TRUE, when event is enabled. If @p transit is NULL
27229 * EINA_FALSE is returned
27233 EAPI Eina_Bool elm_transit_event_enabled_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27236 * Set the user-callback function when the transit is deleted.
27238 * @note Using this function twice will overwrite the first function setted.
27239 * @note the @p transit object will be deleted after call @p cb function.
27241 * @param transit The transit object.
27242 * @param cb Callback function pointer. This function will be called before
27243 * the deletion of the transit.
27244 * @param data Callback funtion user data. It is the @p op parameter.
27248 EAPI void elm_transit_del_cb_set(Elm_Transit *transit, Elm_Transit_Del_Cb cb, void *data) EINA_ARG_NONNULL(1);
27251 * Set reverse effect automatically.
27253 * If auto reverse is setted, after running the effects with the progress
27254 * parameter from 0 to 1, it will call the effecs again with the progress
27255 * from 1 to 0. The transit will last for a time iqual to (2 * duration * repeat),
27256 * where the duration was setted with the function elm_transit_add and
27257 * the repeat with the function elm_transit_repeat_times_set().
27259 * @param transit The transit object.
27260 * @param reverse EINA_TRUE means the auto_reverse is on.
27264 EAPI void elm_transit_auto_reverse_set(Elm_Transit *transit, Eina_Bool reverse) EINA_ARG_NONNULL(1);
27267 * Get if the auto reverse is on.
27269 * @see elm_transit_auto_reverse_set()
27271 * @param transit The transit object.
27272 * @return EINA_TRUE means auto reverse is on. If @p transit is NULL
27273 * EINA_FALSE is returned
27277 EAPI Eina_Bool elm_transit_auto_reverse_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27280 * Set the transit repeat count. Effect will be repeated by repeat count.
27282 * This function sets the number of repetition the transit will run after
27283 * the first one, that is, if @p repeat is 1, the transit will run 2 times.
27284 * If the @p repeat is a negative number, it will repeat infinite times.
27286 * @note If this function is called during the transit execution, the transit
27287 * will run @p repeat times, ignoring the times it already performed.
27289 * @param transit The transit object
27290 * @param repeat Repeat count
27294 EAPI void elm_transit_repeat_times_set(Elm_Transit *transit, int repeat) EINA_ARG_NONNULL(1);
27297 * Get the transit repeat count.
27299 * @see elm_transit_repeat_times_set()
27301 * @param transit The Transit object.
27302 * @return The repeat count. If @p transit is NULL
27307 EAPI int elm_transit_repeat_times_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27310 * Set the transit animation acceleration type.
27312 * This function sets the tween mode of the transit that can be:
27313 * ELM_TRANSIT_TWEEN_MODE_LINEAR - The default mode.
27314 * ELM_TRANSIT_TWEEN_MODE_SINUSOIDAL - Starts in accelerate mode and ends decelerating.
27315 * ELM_TRANSIT_TWEEN_MODE_DECELERATE - The animation will be slowed over time.
27316 * ELM_TRANSIT_TWEEN_MODE_ACCELERATE - The animation will accelerate over time.
27318 * @param transit The transit object.
27319 * @param tween_mode The tween type.
27323 EAPI void elm_transit_tween_mode_set(Elm_Transit *transit, Elm_Transit_Tween_Mode tween_mode) EINA_ARG_NONNULL(1);
27326 * Get the transit animation acceleration type.
27328 * @note @p transit can not be NULL
27330 * @param transit The transit object.
27331 * @return The tween type. If @p transit is NULL
27332 * ELM_TRANSIT_TWEEN_MODE_LINEAR is returned.
27336 EAPI Elm_Transit_Tween_Mode elm_transit_tween_mode_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27339 * Set the transit animation time
27341 * @note @p transit can not be NULL
27343 * @param transit The transit object.
27344 * @param duration The animation time.
27348 EAPI void elm_transit_duration_set(Elm_Transit *transit, double duration) EINA_ARG_NONNULL(1);
27351 * Get the transit animation time
27353 * @note @p transit can not be NULL
27355 * @param transit The transit object.
27357 * @return The transit animation time.
27361 EAPI double elm_transit_duration_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27364 * Starts the transition.
27365 * Once this API is called, the transit begins to measure the time.
27367 * @note @p transit can not be NULL
27369 * @param transit The transit object.
27373 EAPI void elm_transit_go(Elm_Transit *transit) EINA_ARG_NONNULL(1);
27376 * Pause/Resume the transition.
27378 * If you call elm_transit_go again, the transit will be started from the
27379 * beginning, and will be unpaused.
27381 * @note @p transit can not be NULL
27383 * @param transit The transit object.
27384 * @param paused Whether the transition should be paused or not.
27388 EAPI void elm_transit_paused_set(Elm_Transit *transit, Eina_Bool paused) EINA_ARG_NONNULL(1);
27391 * Get the value of paused status.
27393 * @see elm_transit_paused_set()
27395 * @note @p transit can not be NULL
27397 * @param transit The transit object.
27398 * @return EINA_TRUE means transition is paused. If @p transit is NULL
27399 * EINA_FALSE is returned
27403 EAPI Eina_Bool elm_transit_paused_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27406 * Get the time progression of the animation (a double value between 0.0 and 1.0).
27408 * The value returned is a fraction (current time / total time). It
27409 * represents the progression position relative to the total.
27411 * @note @p transit can not be NULL
27413 * @param transit The transit object.
27415 * @return The time progression value. If @p transit is NULL
27420 EAPI double elm_transit_progress_value_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27423 * Makes the chain relationship between two transits.
27425 * @note @p transit can not be NULL. Transit would have multiple chain transits.
27426 * @note @p chain_transit can not be NULL. Chain transits could be chained to the only one transit.
27428 * @param transit The transit object.
27429 * @param chain_transit The chain transit object. This transit will be operated
27430 * after transit is done.
27432 * This function adds @p chain_transit transition to a chain after the @p
27433 * transit, and will be started as soon as @p transit ends. See @ref
27434 * transit_example_02_explained for a full example.
27438 EAPI void elm_transit_chain_transit_add(Elm_Transit *transit, Elm_Transit *chain_transit) EINA_ARG_NONNULL(1, 2);
27441 * Cut off the chain relationship between two transits.
27443 * @note @p transit can not be NULL. Transit would have the chain relationship with @p chain transit.
27444 * @note @p chain_transit can not be NULL. Chain transits should be chained to the @p transit.
27446 * @param transit The transit object.
27447 * @param chain_transit The chain transit object.
27449 * This function remove the @p chain_transit transition from the @p transit.
27453 EAPI void elm_transit_chain_transit_del(Elm_Transit *transit, Elm_Transit *chain_transit) EINA_ARG_NONNULL(1,2);
27456 * Get the current chain transit list.
27458 * @note @p transit can not be NULL.
27460 * @param transit The transit object.
27461 * @return chain transit list.
27465 EAPI Eina_List *elm_transit_chain_transits_get(const Elm_Transit *transit);
27468 * Add the Resizing Effect to Elm_Transit.
27470 * @note This API is one of the facades. It creates resizing effect context
27471 * and add it's required APIs to elm_transit_effect_add.
27473 * @see elm_transit_effect_add()
27475 * @param transit Transit object.
27476 * @param from_w Object width size when effect begins.
27477 * @param from_h Object height size when effect begins.
27478 * @param to_w Object width size when effect ends.
27479 * @param to_h Object height size when effect ends.
27480 * @return Resizing effect context data.
27484 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);
27487 * Add the Translation Effect to Elm_Transit.
27489 * @note This API is one of the facades. It creates translation effect context
27490 * and add it's required APIs to elm_transit_effect_add.
27492 * @see elm_transit_effect_add()
27494 * @param transit Transit object.
27495 * @param from_dx X Position variation when effect begins.
27496 * @param from_dy Y Position variation when effect begins.
27497 * @param to_dx X Position variation when effect ends.
27498 * @param to_dy Y Position variation when effect ends.
27499 * @return Translation effect context data.
27502 * @warning It is highly recommended just create a transit with this effect when
27503 * the window that the objects of the transit belongs has already been created.
27504 * This is because this effect needs the geometry information about the objects,
27505 * and if the window was not created yet, it can get a wrong information.
27507 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);
27510 * Add the Zoom Effect to Elm_Transit.
27512 * @note This API is one of the facades. It creates zoom effect context
27513 * and add it's required APIs to elm_transit_effect_add.
27515 * @see elm_transit_effect_add()
27517 * @param transit Transit object.
27518 * @param from_rate Scale rate when effect begins (1 is current rate).
27519 * @param to_rate Scale rate when effect ends.
27520 * @return Zoom effect context data.
27523 * @warning It is highly recommended just create a transit with this effect when
27524 * the window that the objects of the transit belongs has already been created.
27525 * This is because this effect needs the geometry information about the objects,
27526 * and if the window was not created yet, it can get a wrong information.
27528 EAPI Elm_Transit_Effect *elm_transit_effect_zoom_add(Elm_Transit *transit, float from_rate, float to_rate);
27531 * Add the Flip Effect to Elm_Transit.
27533 * @note This API is one of the facades. It creates flip effect context
27534 * and add it's required APIs to elm_transit_effect_add.
27535 * @note This effect is applied to each pair of objects in the order they are listed
27536 * in the transit list of objects. The first object in the pair will be the
27537 * "front" object and the second will be the "back" object.
27539 * @see elm_transit_effect_add()
27541 * @param transit Transit object.
27542 * @param axis Flipping Axis(X or Y).
27543 * @param cw Flipping Direction. EINA_TRUE is clock-wise.
27544 * @return Flip effect context data.
27547 * @warning It is highly recommended just create a transit with this effect when
27548 * the window that the objects of the transit belongs has already been created.
27549 * This is because this effect needs the geometry information about the objects,
27550 * and if the window was not created yet, it can get a wrong information.
27552 EAPI Elm_Transit_Effect *elm_transit_effect_flip_add(Elm_Transit *transit, Elm_Transit_Effect_Flip_Axis axis, Eina_Bool cw);
27555 * Add the Resizable Flip Effect to Elm_Transit.
27557 * @note This API is one of the facades. It creates resizable flip effect context
27558 * and add it's required APIs to elm_transit_effect_add.
27559 * @note This effect is applied to each pair of objects in the order they are listed
27560 * in the transit list of objects. The first object in the pair will be the
27561 * "front" object and the second will be the "back" object.
27563 * @see elm_transit_effect_add()
27565 * @param transit Transit object.
27566 * @param axis Flipping Axis(X or Y).
27567 * @param cw Flipping Direction. EINA_TRUE is clock-wise.
27568 * @return Resizable flip effect context data.
27571 * @warning It is highly recommended just create a transit with this effect when
27572 * the window that the objects of the transit belongs has already been created.
27573 * This is because this effect needs the geometry information about the objects,
27574 * and if the window was not created yet, it can get a wrong information.
27576 EAPI Elm_Transit_Effect *elm_transit_effect_resizable_flip_add(Elm_Transit *transit, Elm_Transit_Effect_Flip_Axis axis, Eina_Bool cw);
27579 * Add the Wipe Effect to Elm_Transit.
27581 * @note This API is one of the facades. It creates wipe effect context
27582 * and add it's required APIs to elm_transit_effect_add.
27584 * @see elm_transit_effect_add()
27586 * @param transit Transit object.
27587 * @param type Wipe type. Hide or show.
27588 * @param dir Wipe Direction.
27589 * @return Wipe effect context data.
27592 * @warning It is highly recommended just create a transit with this effect when
27593 * the window that the objects of the transit belongs has already been created.
27594 * This is because this effect needs the geometry information about the objects,
27595 * and if the window was not created yet, it can get a wrong information.
27597 EAPI Elm_Transit_Effect *elm_transit_effect_wipe_add(Elm_Transit *transit, Elm_Transit_Effect_Wipe_Type type, Elm_Transit_Effect_Wipe_Dir dir);
27600 * Add the Color Effect to Elm_Transit.
27602 * @note This API is one of the facades. It creates color effect context
27603 * and add it's required APIs to elm_transit_effect_add.
27605 * @see elm_transit_effect_add()
27607 * @param transit Transit object.
27608 * @param from_r RGB R when effect begins.
27609 * @param from_g RGB G when effect begins.
27610 * @param from_b RGB B when effect begins.
27611 * @param from_a RGB A when effect begins.
27612 * @param to_r RGB R when effect ends.
27613 * @param to_g RGB G when effect ends.
27614 * @param to_b RGB B when effect ends.
27615 * @param to_a RGB A when effect ends.
27616 * @return Color effect context data.
27620 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);
27623 * Add the Fade Effect to Elm_Transit.
27625 * @note This API is one of the facades. It creates fade effect context
27626 * and add it's required APIs to elm_transit_effect_add.
27627 * @note This effect is applied to each pair of objects in the order they are listed
27628 * in the transit list of objects. The first object in the pair will be the
27629 * "before" object and the second will be the "after" object.
27631 * @see elm_transit_effect_add()
27633 * @param transit Transit object.
27634 * @return Fade effect context data.
27637 * @warning It is highly recommended just create a transit with this effect when
27638 * the window that the objects of the transit belongs has already been created.
27639 * This is because this effect needs the color information about the objects,
27640 * and if the window was not created yet, it can get a wrong information.
27642 EAPI Elm_Transit_Effect *elm_transit_effect_fade_add(Elm_Transit *transit);
27645 * Add the Blend Effect to Elm_Transit.
27647 * @note This API is one of the facades. It creates blend effect context
27648 * and add it's required APIs to elm_transit_effect_add.
27649 * @note This effect is applied to each pair of objects in the order they are listed
27650 * in the transit list of objects. The first object in the pair will be the
27651 * "before" object and the second will be the "after" object.
27653 * @see elm_transit_effect_add()
27655 * @param transit Transit object.
27656 * @return Blend effect context data.
27659 * @warning It is highly recommended just create a transit with this effect when
27660 * the window that the objects of the transit belongs has already been created.
27661 * This is because this effect needs the color information about the objects,
27662 * and if the window was not created yet, it can get a wrong information.
27664 EAPI Elm_Transit_Effect *elm_transit_effect_blend_add(Elm_Transit *transit);
27667 * Add the Rotation Effect to Elm_Transit.
27669 * @note This API is one of the facades. It creates rotation effect context
27670 * and add it's required APIs to elm_transit_effect_add.
27672 * @see elm_transit_effect_add()
27674 * @param transit Transit object.
27675 * @param from_degree Degree when effect begins.
27676 * @param to_degree Degree when effect is ends.
27677 * @return Rotation effect context data.
27680 * @warning It is highly recommended just create a transit with this effect when
27681 * the window that the objects of the transit belongs has already been created.
27682 * This is because this effect needs the geometry information about the objects,
27683 * and if the window was not created yet, it can get a wrong information.
27685 EAPI Elm_Transit_Effect *elm_transit_effect_rotation_add(Elm_Transit *transit, float from_degree, float to_degree);
27688 * Add the ImageAnimation Effect to Elm_Transit.
27690 * @note This API is one of the facades. It creates image animation effect context
27691 * and add it's required APIs to elm_transit_effect_add.
27692 * The @p images parameter is a list images paths. This list and
27693 * its contents will be deleted at the end of the effect by
27694 * elm_transit_effect_image_animation_context_free() function.
27698 * char buf[PATH_MAX];
27699 * Eina_List *images = NULL;
27700 * Elm_Transit *transi = elm_transit_add();
27702 * snprintf(buf, sizeof(buf), "%s/images/icon_11.png", PACKAGE_DATA_DIR);
27703 * images = eina_list_append(images, eina_stringshare_add(buf));
27705 * snprintf(buf, sizeof(buf), "%s/images/logo_small.png", PACKAGE_DATA_DIR);
27706 * images = eina_list_append(images, eina_stringshare_add(buf));
27707 * elm_transit_effect_image_animation_add(transi, images);
27711 * @see elm_transit_effect_add()
27713 * @param transit Transit object.
27714 * @param images Eina_List of images file paths. This list and
27715 * its contents will be deleted at the end of the effect by
27716 * elm_transit_effect_image_animation_context_free() function.
27717 * @return Image Animation effect context data.
27721 EAPI Elm_Transit_Effect *elm_transit_effect_image_animation_add(Elm_Transit *transit, Eina_List *images);
27726 typedef struct _Elm_Store Elm_Store;
27727 typedef struct _Elm_Store_Filesystem Elm_Store_Filesystem;
27728 typedef struct _Elm_Store_Item Elm_Store_Item;
27729 typedef struct _Elm_Store_Item_Filesystem Elm_Store_Item_Filesystem;
27730 typedef struct _Elm_Store_Item_Info Elm_Store_Item_Info;
27731 typedef struct _Elm_Store_Item_Info_Filesystem Elm_Store_Item_Info_Filesystem;
27732 typedef struct _Elm_Store_Item_Mapping Elm_Store_Item_Mapping;
27733 typedef struct _Elm_Store_Item_Mapping_Empty Elm_Store_Item_Mapping_Empty;
27734 typedef struct _Elm_Store_Item_Mapping_Icon Elm_Store_Item_Mapping_Icon;
27735 typedef struct _Elm_Store_Item_Mapping_Photo Elm_Store_Item_Mapping_Photo;
27736 typedef struct _Elm_Store_Item_Mapping_Custom Elm_Store_Item_Mapping_Custom;
27738 typedef Eina_Bool (*Elm_Store_Item_List_Cb) (void *data, Elm_Store_Item_Info *info);
27739 typedef void (*Elm_Store_Item_Fetch_Cb) (void *data, Elm_Store_Item *sti);
27740 typedef void (*Elm_Store_Item_Unfetch_Cb) (void *data, Elm_Store_Item *sti);
27741 typedef void *(*Elm_Store_Item_Mapping_Cb) (void *data, Elm_Store_Item *sti, const char *part);
27745 ELM_STORE_ITEM_MAPPING_NONE = 0,
27746 ELM_STORE_ITEM_MAPPING_LABEL, // const char * -> label
27747 ELM_STORE_ITEM_MAPPING_STATE, // Eina_Bool -> state
27748 ELM_STORE_ITEM_MAPPING_ICON, // char * -> icon path
27749 ELM_STORE_ITEM_MAPPING_PHOTO, // char * -> photo path
27750 ELM_STORE_ITEM_MAPPING_CUSTOM, // item->custom(it->data, it, part) -> void * (-> any)
27751 // can add more here as needed by common apps
27752 ELM_STORE_ITEM_MAPPING_LAST
27753 } Elm_Store_Item_Mapping_Type;
27755 struct _Elm_Store_Item_Mapping_Icon
27757 // FIXME: allow edje file icons
27759 Elm_Icon_Lookup_Order lookup_order;
27760 Eina_Bool standard_name : 1;
27761 Eina_Bool no_scale : 1;
27762 Eina_Bool smooth : 1;
27763 Eina_Bool scale_up : 1;
27764 Eina_Bool scale_down : 1;
27767 struct _Elm_Store_Item_Mapping_Empty
27772 struct _Elm_Store_Item_Mapping_Photo
27777 struct _Elm_Store_Item_Mapping_Custom
27779 Elm_Store_Item_Mapping_Cb func;
27782 struct _Elm_Store_Item_Mapping
27784 Elm_Store_Item_Mapping_Type type;
27789 Elm_Store_Item_Mapping_Empty empty;
27790 Elm_Store_Item_Mapping_Icon icon;
27791 Elm_Store_Item_Mapping_Photo photo;
27792 Elm_Store_Item_Mapping_Custom custom;
27793 // add more types here
27797 struct _Elm_Store_Item_Info
27799 Elm_Genlist_Item_Class *item_class;
27800 const Elm_Store_Item_Mapping *mapping;
27805 struct _Elm_Store_Item_Info_Filesystem
27807 Elm_Store_Item_Info base;
27811 #define ELM_STORE_ITEM_MAPPING_END { ELM_STORE_ITEM_MAPPING_NONE, NULL, 0, { .empty = { EINA_TRUE } } }
27812 #define ELM_STORE_ITEM_MAPPING_OFFSET(st, it) offsetof(st, it)
27814 EAPI void elm_store_free(Elm_Store *st);
27816 EAPI Elm_Store *elm_store_filesystem_new(void);
27817 EAPI void elm_store_filesystem_directory_set(Elm_Store *st, const char *dir) EINA_ARG_NONNULL(1);
27818 EAPI const char *elm_store_filesystem_directory_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
27819 EAPI const char *elm_store_item_filesystem_path_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27821 EAPI void elm_store_target_genlist_set(Elm_Store *st, Evas_Object *obj) EINA_ARG_NONNULL(1);
27823 EAPI void elm_store_cache_set(Elm_Store *st, int max) EINA_ARG_NONNULL(1);
27824 EAPI int elm_store_cache_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
27825 EAPI void elm_store_list_func_set(Elm_Store *st, Elm_Store_Item_List_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
27826 EAPI void elm_store_fetch_func_set(Elm_Store *st, Elm_Store_Item_Fetch_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
27827 EAPI void elm_store_fetch_thread_set(Elm_Store *st, Eina_Bool use_thread) EINA_ARG_NONNULL(1);
27828 EAPI Eina_Bool elm_store_fetch_thread_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
27830 EAPI void elm_store_unfetch_func_set(Elm_Store *st, Elm_Store_Item_Unfetch_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
27831 EAPI void elm_store_sorted_set(Elm_Store *st, Eina_Bool sorted) EINA_ARG_NONNULL(1);
27832 EAPI Eina_Bool elm_store_sorted_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
27833 EAPI void elm_store_item_data_set(Elm_Store_Item *sti, void *data) EINA_ARG_NONNULL(1);
27834 EAPI void *elm_store_item_data_get(Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27835 EAPI const Elm_Store *elm_store_item_store_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27836 EAPI const Elm_Genlist_Item *elm_store_item_genlist_item_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27839 * @defgroup SegmentControl SegmentControl
27840 * @ingroup Elementary
27842 * @image html img/widget/segment_control/preview-00.png
27843 * @image latex img/widget/segment_control/preview-00.eps width=\textwidth
27845 * @image html img/segment_control.png
27846 * @image latex img/segment_control.eps width=\textwidth
27848 * Segment control widget is a horizontal control made of multiple segment
27849 * items, each segment item functioning similar to discrete two state button.
27850 * A segment control groups the items together and provides compact
27851 * single button with multiple equal size segments.
27853 * Segment item size is determined by base widget
27854 * size and the number of items added.
27855 * Only one segment item can be at selected state. A segment item can display
27856 * combination of Text and any Evas_Object like Images or other widget.
27858 * Smart callbacks one can listen to:
27859 * - "changed" - When the user clicks on a segment item which is not
27860 * previously selected and get selected. The event_info parameter is the
27861 * segment item pointer.
27863 * Available styles for it:
27866 * Here is an example on its usage:
27867 * @li @ref segment_control_example
27871 * @addtogroup SegmentControl
27875 typedef struct _Elm_Segment_Item Elm_Segment_Item; /**< Item handle for a segment control widget. */
27878 * Add a new segment control widget to the given parent Elementary
27879 * (container) object.
27881 * @param parent The parent object.
27882 * @return a new segment control widget handle or @c NULL, on errors.
27884 * This function inserts a new segment control widget on the canvas.
27886 * @ingroup SegmentControl
27888 EAPI Evas_Object *elm_segment_control_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
27891 * Append a new item to the segment control object.
27893 * @param obj The segment control object.
27894 * @param icon The icon object to use for the left side of the item. An
27895 * icon can be any Evas object, but usually it is an icon created
27896 * with elm_icon_add().
27897 * @param label The label of the item.
27898 * Note that, NULL is different from empty string "".
27899 * @return The created item or @c NULL upon failure.
27901 * A new item will be created and appended to the segment control, i.e., will
27902 * be set as @b last item.
27904 * If it should be inserted at another position,
27905 * elm_segment_control_item_insert_at() should be used instead.
27907 * Items created with this function can be deleted with function
27908 * elm_segment_control_item_del() or elm_segment_control_item_del_at().
27910 * @note @p label set to @c NULL is different from empty string "".
27912 * only has icon, it will be displayed bigger and centered. If it has
27913 * icon and label, even that an empty string, icon will be smaller and
27914 * positioned at left.
27918 * sc = elm_segment_control_add(win);
27919 * ic = elm_icon_add(win);
27920 * elm_icon_file_set(ic, "path/to/image", NULL);
27921 * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
27922 * elm_segment_control_item_add(sc, ic, "label");
27923 * evas_object_show(sc);
27926 * @see elm_segment_control_item_insert_at()
27927 * @see elm_segment_control_item_del()
27929 * @ingroup SegmentControl
27931 EAPI Elm_Segment_Item *elm_segment_control_item_add(Evas_Object *obj, Evas_Object *icon, const char *label) EINA_ARG_NONNULL(1);
27934 * Insert a new item to the segment control object at specified position.
27936 * @param obj The segment control object.
27937 * @param icon The icon object to use for the left side of the item. An
27938 * icon can be any Evas object, but usually it is an icon created
27939 * with elm_icon_add().
27940 * @param label The label of the item.
27941 * @param index Item position. Value should be between 0 and items count.
27942 * @return The created item or @c NULL upon failure.
27944 * Index values must be between @c 0, when item will be prepended to
27945 * segment control, and items count, that can be get with
27946 * elm_segment_control_item_count_get(), case when item will be appended
27947 * to segment control, just like elm_segment_control_item_add().
27949 * Items created with this function can be deleted with function
27950 * elm_segment_control_item_del() or elm_segment_control_item_del_at().
27952 * @note @p label set to @c NULL is different from empty string "".
27954 * only has icon, it will be displayed bigger and centered. If it has
27955 * icon and label, even that an empty string, icon will be smaller and
27956 * positioned at left.
27958 * @see elm_segment_control_item_add()
27959 * @see elm_segment_control_item_count_get()
27960 * @see elm_segment_control_item_del()
27962 * @ingroup SegmentControl
27964 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);
27967 * Remove a segment control item from its parent, deleting it.
27969 * @param it The item to be removed.
27971 * Items can be added with elm_segment_control_item_add() or
27972 * elm_segment_control_item_insert_at().
27974 * @ingroup SegmentControl
27976 EAPI void elm_segment_control_item_del(Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
27979 * Remove a segment control item at given index from its parent,
27982 * @param obj The segment control object.
27983 * @param index The position of the segment control item to be deleted.
27985 * Items can be added with elm_segment_control_item_add() or
27986 * elm_segment_control_item_insert_at().
27988 * @ingroup SegmentControl
27990 EAPI void elm_segment_control_item_del_at(Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
27993 * Get the Segment items count from segment control.
27995 * @param obj The segment control object.
27996 * @return Segment items count.
27998 * It will just return the number of items added to segment control @p obj.
28000 * @ingroup SegmentControl
28002 EAPI int elm_segment_control_item_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
28005 * Get the item placed at specified index.
28007 * @param obj The segment control object.
28008 * @param index The index of the segment item.
28009 * @return The segment control item or @c NULL on failure.
28011 * Index is the position of an item in segment control widget. Its
28012 * range is from @c 0 to <tt> count - 1 </tt>.
28013 * Count is the number of items, that can be get with
28014 * elm_segment_control_item_count_get().
28016 * @ingroup SegmentControl
28018 EAPI Elm_Segment_Item *elm_segment_control_item_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
28021 * Get the label of item.
28023 * @param obj The segment control object.
28024 * @param index The index of the segment item.
28025 * @return The label of the item at @p index.
28027 * The return value is a pointer to the label associated to the item when
28028 * it was created, with function elm_segment_control_item_add(), or later
28029 * with function elm_segment_control_item_label_set. If no label
28030 * was passed as argument, it will return @c NULL.
28032 * @see elm_segment_control_item_label_set() for more details.
28033 * @see elm_segment_control_item_add()
28035 * @ingroup SegmentControl
28037 EAPI const char *elm_segment_control_item_label_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
28040 * Set the label of item.
28042 * @param it The item of segment control.
28043 * @param text The label of item.
28045 * The label to be displayed by the item.
28046 * Label will be at right of the icon (if set).
28048 * If a label was passed as argument on item creation, with function
28049 * elm_control_segment_item_add(), it will be already
28050 * displayed by the item.
28052 * @see elm_segment_control_item_label_get()
28053 * @see elm_segment_control_item_add()
28055 * @ingroup SegmentControl
28057 EAPI void elm_segment_control_item_label_set(Elm_Segment_Item* it, const char* label) EINA_ARG_NONNULL(1);
28060 * Get the icon associated to the item.
28062 * @param obj The segment control object.
28063 * @param index The index of the segment item.
28064 * @return The left side icon associated to the item at @p index.
28066 * The return value is a pointer to the icon associated to the item when
28067 * it was created, with function elm_segment_control_item_add(), or later
28068 * with function elm_segment_control_item_icon_set(). If no icon
28069 * was passed as argument, it will return @c NULL.
28071 * @see elm_segment_control_item_add()
28072 * @see elm_segment_control_item_icon_set()
28074 * @ingroup SegmentControl
28076 EAPI Evas_Object *elm_segment_control_item_icon_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
28079 * Set the icon associated to the item.
28081 * @param it The segment control item.
28082 * @param icon The icon object to associate with @p it.
28084 * The icon object to use at left side of the item. An
28085 * icon can be any Evas object, but usually it is an icon created
28086 * with elm_icon_add().
28088 * Once the icon object is set, a previously set one will be deleted.
28089 * @warning Setting the same icon for two items will cause the icon to
28090 * dissapear from the first item.
28092 * If an icon was passed as argument on item creation, with function
28093 * elm_segment_control_item_add(), it will be already
28094 * associated to the item.
28096 * @see elm_segment_control_item_add()
28097 * @see elm_segment_control_item_icon_get()
28099 * @ingroup SegmentControl
28101 EAPI void elm_segment_control_item_icon_set(Elm_Segment_Item *it, Evas_Object *icon) EINA_ARG_NONNULL(1);
28104 * Get the index of an item.
28106 * @param it The segment control item.
28107 * @return The position of item in segment control widget.
28109 * Index is the position of an item in segment control widget. Its
28110 * range is from @c 0 to <tt> count - 1 </tt>.
28111 * Count is the number of items, that can be get with
28112 * elm_segment_control_item_count_get().
28114 * @ingroup SegmentControl
28116 EAPI int elm_segment_control_item_index_get(const Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
28119 * Get the base object of the item.
28121 * @param it The segment control item.
28122 * @return The base object associated with @p it.
28124 * Base object is the @c Evas_Object that represents that item.
28126 * @ingroup SegmentControl
28128 EAPI Evas_Object *elm_segment_control_item_object_get(const Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
28131 * Get the selected item.
28133 * @param obj The segment control object.
28134 * @return The selected item or @c NULL if none of segment items is
28137 * The selected item can be unselected with function
28138 * elm_segment_control_item_selected_set().
28140 * The selected item always will be highlighted on segment control.
28142 * @ingroup SegmentControl
28144 EAPI Elm_Segment_Item *elm_segment_control_item_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
28147 * Set the selected state of an item.
28149 * @param it The segment control item
28150 * @param select The selected state
28152 * This sets the selected state of the given item @p it.
28153 * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
28155 * If a new item is selected the previosly selected will be unselected.
28156 * Previoulsy selected item can be get with function
28157 * elm_segment_control_item_selected_get().
28159 * The selected item always will be highlighted on segment control.
28161 * @see elm_segment_control_item_selected_get()
28163 * @ingroup SegmentControl
28165 EAPI void elm_segment_control_item_selected_set(Elm_Segment_Item *it, Eina_Bool select) EINA_ARG_NONNULL(1);
28172 * @defgroup Grid Grid
28174 * The grid is a grid layout widget that lays out a series of children as a
28175 * fixed "grid" of widgets using a given percentage of the grid width and
28176 * height each using the child object.
28178 * The Grid uses a "Virtual resolution" that is stretched to fill the grid
28179 * widgets size itself. The default is 100 x 100, so that means the
28180 * position and sizes of children will effectively be percentages (0 to 100)
28181 * of the width or height of the grid widget
28187 * Add a new grid to the parent
28189 * @param parent The parent object
28190 * @return The new object or NULL if it cannot be created
28194 EAPI Evas_Object *elm_grid_add(Evas_Object *parent);
28197 * Set the virtual size of the grid
28199 * @param obj The grid object
28200 * @param w The virtual width of the grid
28201 * @param h The virtual height of the grid
28205 EAPI void elm_grid_size_set(Evas_Object *obj, int w, int h);
28208 * Get the virtual size of the grid
28210 * @param obj The grid object
28211 * @param w Pointer to integer to store the virtual width of the grid
28212 * @param h Pointer to integer to store the virtual height of the grid
28216 EAPI void elm_grid_size_get(Evas_Object *obj, int *w, int *h);
28219 * Pack child at given position and size
28221 * @param obj The grid object
28222 * @param subobj The child to pack
28223 * @param x The virtual x coord at which to pack it
28224 * @param y The virtual y coord at which to pack it
28225 * @param w The virtual width at which to pack it
28226 * @param h The virtual height at which to pack it
28230 EAPI void elm_grid_pack(Evas_Object *obj, Evas_Object *subobj, int x, int y, int w, int h);
28233 * Unpack a child from a grid object
28235 * @param obj The grid object
28236 * @param subobj The child to unpack
28240 EAPI void elm_grid_unpack(Evas_Object *obj, Evas_Object *subobj);
28243 * Faster way to remove all child objects from a grid object.
28245 * @param obj The grid object
28246 * @param clear If true, it will delete just removed children
28250 EAPI void elm_grid_clear(Evas_Object *obj, Eina_Bool clear);
28253 * Set packing of an existing child at to position and size
28255 * @param subobj The child to set packing of
28256 * @param x The virtual x coord at which to pack it
28257 * @param y The virtual y coord at which to pack it
28258 * @param w The virtual width at which to pack it
28259 * @param h The virtual height at which to pack it
28263 EAPI void elm_grid_pack_set(Evas_Object *subobj, int x, int y, int w, int h);
28266 * get packing of a child
28268 * @param subobj The child to query
28269 * @param x Pointer to integer to store the virtual x coord
28270 * @param y Pointer to integer to store the virtual y coord
28271 * @param w Pointer to integer to store the virtual width
28272 * @param h Pointer to integer to store the virtual height
28276 EAPI void elm_grid_pack_get(Evas_Object *subobj, int *x, int *y, int *w, int *h);
28282 EAPI Evas_Object *elm_factory_add(Evas_Object *parent);
28283 EINA_DEPRECATED EAPI void elm_factory_content_set(Evas_Object *obj, Evas_Object *content);
28284 EINA_DEPRECATED EAPI Evas_Object *elm_factory_content_get(const Evas_Object *obj);
28285 EAPI void elm_factory_maxmin_mode_set(Evas_Object *obj, Eina_Bool enabled);
28286 EAPI Eina_Bool elm_factory_maxmin_mode_get(const Evas_Object *obj);
28287 EAPI void elm_factory_maxmin_reset_set(Evas_Object *obj);
28290 * @defgroup Video Video
28292 * @addtogroup Video
28295 * Elementary comes with two object that help design application that need
28296 * to display video. The main one, Elm_Video, display a video by using Emotion.
28297 * It does embedded the video inside an Edje object, so you can do some
28298 * animation depending on the video state change. It does also implement a
28299 * ressource management policy to remove this burden from the application writer.
28301 * The second one, Elm_Player is a video player that need to be linked with and Elm_Video.
28302 * It take care of updating its content according to Emotion event and provide a
28303 * way to theme itself. It also does automatically raise the priority of the
28304 * linked Elm_Video so it will use the video decoder if available. It also does
28305 * activate the remember function on the linked Elm_Video object.
28307 * Signals that you can add callback for are :
28309 * "forward,clicked" - the user clicked the forward button.
28310 * "info,clicked" - the user clicked the info button.
28311 * "next,clicked" - the user clicked the next button.
28312 * "pause,clicked" - the user clicked the pause button.
28313 * "play,clicked" - the user clicked the play button.
28314 * "prev,clicked" - the user clicked the prev button.
28315 * "rewind,clicked" - the user clicked the rewind button.
28316 * "stop,clicked" - the user clicked the stop button.
28318 * Default contents parts of the player widget that you can use for are:
28319 * @li "video" - A video of the player
28324 * @brief Add a new Elm_Player object to the given parent Elementary (container) object.
28326 * @param parent The parent object
28327 * @return a new player widget handle or @c NULL, on errors.
28329 * This function inserts a new player widget on the canvas.
28331 * @see elm_object_part_content_set()
28335 EAPI Evas_Object *elm_player_add(Evas_Object *parent);
28338 * @brief Link a Elm_Payer with an Elm_Video object.
28340 * @param player the Elm_Player object.
28341 * @param video The Elm_Video object.
28343 * This mean that action on the player widget will affect the
28344 * video object and the state of the video will be reflected in
28345 * the player itself.
28347 * @see elm_player_add()
28348 * @see elm_video_add()
28349 * @deprecated use elm_object_part_content_set() instead
28353 EINA_DEPRECATED EAPI void elm_player_video_set(Evas_Object *player, Evas_Object *video);
28356 * @brief Add a new Elm_Video object to the given parent Elementary (container) object.
28358 * @param parent The parent object
28359 * @return a new video widget handle or @c NULL, on errors.
28361 * This function inserts a new video widget on the canvas.
28363 * @seeelm_video_file_set()
28364 * @see elm_video_uri_set()
28368 EAPI Evas_Object *elm_video_add(Evas_Object *parent);
28371 * @brief Define the file that will be the video source.
28373 * @param video The video object to define the file for.
28374 * @param filename The file to target.
28376 * This function will explicitly define a filename as a source
28377 * for the video of the Elm_Video object.
28379 * @see elm_video_uri_set()
28380 * @see elm_video_add()
28381 * @see elm_player_add()
28385 EAPI void elm_video_file_set(Evas_Object *video, const char *filename);
28388 * @brief Define the uri that will be the video source.
28390 * @param video The video object to define the file for.
28391 * @param uri The uri to target.
28393 * This function will define an uri as a source for the video of the
28394 * Elm_Video object. URI could be remote source of video, like http:// or local source
28395 * like for example WebCam who are most of the time v4l2:// (but that depend and
28396 * you should use Emotion API to request and list the available Webcam on your system).
28398 * @see elm_video_file_set()
28399 * @see elm_video_add()
28400 * @see elm_player_add()
28404 EAPI void elm_video_uri_set(Evas_Object *video, const char *uri);
28407 * @brief Get the underlying Emotion object.
28409 * @param video The video object to proceed the request on.
28410 * @return the underlying Emotion object.
28414 EAPI Evas_Object *elm_video_emotion_get(const Evas_Object *video);
28417 * @brief Start to play the video
28419 * @param video The video object to proceed the request on.
28421 * Start to play the video and cancel all suspend state.
28425 EAPI void elm_video_play(Evas_Object *video);
28428 * @brief Pause the video
28430 * @param video The video object to proceed the request on.
28432 * Pause the video and start a timer to trigger suspend mode.
28436 EAPI void elm_video_pause(Evas_Object *video);
28439 * @brief Stop the video
28441 * @param video The video object to proceed the request on.
28443 * Stop the video and put the emotion in deep sleep mode.
28447 EAPI void elm_video_stop(Evas_Object *video);
28450 * @brief Is the video actually playing.
28452 * @param video The video object to proceed the request on.
28453 * @return EINA_TRUE if the video is actually playing.
28455 * You should consider watching event on the object instead of polling
28456 * the object state.
28460 EAPI Eina_Bool elm_video_is_playing(const Evas_Object *video);
28463 * @brief Is it possible to seek inside the video.
28465 * @param video The video object to proceed the request on.
28466 * @return EINA_TRUE if is possible to seek inside the video.
28470 EAPI Eina_Bool elm_video_is_seekable(const Evas_Object *video);
28473 * @brief Is the audio muted.
28475 * @param video The video object to proceed the request on.
28476 * @return EINA_TRUE if the audio is muted.
28480 EAPI Eina_Bool elm_video_audio_mute_get(const Evas_Object *video);
28483 * @brief Change the mute state of the Elm_Video object.
28485 * @param video The video object to proceed the request on.
28486 * @param mute The new mute state.
28490 EAPI void elm_video_audio_mute_set(Evas_Object *video, Eina_Bool mute);
28493 * @brief Get the audio level of the current video.
28495 * @param video The video object to proceed the request on.
28496 * @return the current audio level.
28500 EAPI double elm_video_audio_level_get(const Evas_Object *video);
28503 * @brief Set the audio level of anElm_Video object.
28505 * @param video The video object to proceed the request on.
28506 * @param volume The new audio volume.
28510 EAPI void elm_video_audio_level_set(Evas_Object *video, double volume);
28512 EAPI double elm_video_play_position_get(const Evas_Object *video);
28513 EAPI void elm_video_play_position_set(Evas_Object *video, double position);
28514 EAPI double elm_video_play_length_get(const Evas_Object *video);
28515 EAPI void elm_video_remember_position_set(Evas_Object *video, Eina_Bool remember);
28516 EAPI Eina_Bool elm_video_remember_position_get(const Evas_Object *video);
28517 EAPI const char *elm_video_title_get(const Evas_Object *video);
28523 * @defgroup Naviframe Naviframe
28524 * @ingroup Elementary
28526 * @brief Naviframe is a kind of view manager for the applications.
28528 * Naviframe provides functions to switch different pages with stack
28529 * mechanism. It means if one page(item) needs to be changed to the new one,
28530 * then naviframe would push the new page to it's internal stack. Of course,
28531 * it can be back to the previous page by popping the top page. Naviframe
28532 * provides some transition effect while the pages are switching (same as
28535 * Since each item could keep the different styles, users could keep the
28536 * same look & feel for the pages or different styles for the items in it's
28539 * Signals that you can add callback for are:
28540 * @li "transition,finished" - When the transition is finished in changing
28542 * @li "title,clicked" - User clicked title area
28544 * Default contents parts of the naviframe items that you can use for are:
28545 * @li "default" - A main content of the page
28546 * @li "icon" - A icon in the title area
28547 * @li "prev_btn" - A button to go to the previous page
28548 * @li "next_btn" - A button to go to the next page
28550 * Default text parts of the naviframe items that you can use for are:
28551 * @li "default" - Title label in the title area
28552 * @li "subtitle" - Sub-title label in the title area
28554 * @ref tutorial_naviframe gives a good overview of the usage of the API.
28558 * @addtogroup Naviframe
28563 * @brief Add a new Naviframe object to the parent.
28565 * @param parent Parent object
28566 * @return New object or @c NULL, if it cannot be created
28568 * @ingroup Naviframe
28570 EAPI Evas_Object *elm_naviframe_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
28572 * @brief Push a new item to the top of the naviframe stack (and show it).
28574 * @param obj The naviframe object
28575 * @param title_label The label in the title area. The name of the title
28576 * label part is "elm.text.title"
28577 * @param prev_btn The button to go to the previous item. If it is NULL,
28578 * then naviframe will create a back button automatically. The name of
28579 * the prev_btn part is "elm.swallow.prev_btn"
28580 * @param next_btn The button to go to the next item. Or It could be just an
28581 * extra function button. The name of the next_btn part is
28582 * "elm.swallow.next_btn"
28583 * @param content The main content object. The name of content part is
28584 * "elm.swallow.content"
28585 * @param item_style The current item style name. @c NULL would be default.
28586 * @return The created item or @c NULL upon failure.
28588 * The item pushed becomes one page of the naviframe, this item will be
28589 * deleted when it is popped.
28591 * @see also elm_naviframe_item_style_set()
28592 * @see also elm_naviframe_item_insert_before()
28593 * @see also elm_naviframe_item_insert_after()
28595 * The following styles are available for this item:
28598 * @ingroup Naviframe
28600 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);
28602 * @brief Insert a new item into the naviframe before item @p before.
28604 * @param before The naviframe item to insert before.
28605 * @param title_label The label in the title area. The name of the title
28606 * label part is "elm.text.title"
28607 * @param prev_btn The button to go to the previous item. If it is NULL,
28608 * then naviframe will create a back button automatically. The name of
28609 * the prev_btn part is "elm.swallow.prev_btn"
28610 * @param next_btn The button to go to the next item. Or It could be just an
28611 * extra function button. The name of the next_btn part is
28612 * "elm.swallow.next_btn"
28613 * @param content The main content object. The name of content part is
28614 * "elm.swallow.content"
28615 * @param item_style The current item style name. @c NULL would be default.
28616 * @return The created item or @c NULL upon failure.
28618 * The item is inserted into the naviframe straight away without any
28619 * transition operations. This item will be deleted when it is popped.
28621 * @see also elm_naviframe_item_style_set()
28622 * @see also elm_naviframe_item_push()
28623 * @see also elm_naviframe_item_insert_after()
28625 * The following styles are available for this item:
28628 * @ingroup Naviframe
28630 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);
28632 * @brief Insert a new item into the naviframe after item @p after.
28634 * @param after The naviframe item to insert after.
28635 * @param title_label The label in the title area. The name of the title
28636 * label part is "elm.text.title"
28637 * @param prev_btn The button to go to the previous item. If it is NULL,
28638 * then naviframe will create a back button automatically. The name of
28639 * the prev_btn part is "elm.swallow.prev_btn"
28640 * @param next_btn The button to go to the next item. Or It could be just an
28641 * extra function button. The name of the next_btn part is
28642 * "elm.swallow.next_btn"
28643 * @param content The main content object. The name of content part is
28644 * "elm.swallow.content"
28645 * @param item_style The current item style name. @c NULL would be default.
28646 * @return The created item or @c NULL upon failure.
28648 * The item is inserted into the naviframe straight away without any
28649 * transition operations. This item will be deleted when it is popped.
28651 * @see also elm_naviframe_item_style_set()
28652 * @see also elm_naviframe_item_push()
28653 * @see also elm_naviframe_item_insert_before()
28655 * The following styles are available for this item:
28658 * @ingroup Naviframe
28660 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);
28662 * @brief Pop an item that is on top of the stack
28664 * @param obj The naviframe object
28665 * @return @c NULL or the content object(if the
28666 * elm_naviframe_content_preserve_on_pop_get is true).
28668 * This pops an item that is on the top(visible) of the naviframe, makes it
28669 * disappear, then deletes the item. The item that was underneath it on the
28670 * stack will become visible.
28672 * @see also elm_naviframe_content_preserve_on_pop_get()
28674 * @ingroup Naviframe
28676 EAPI Evas_Object *elm_naviframe_item_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
28678 * @brief Pop the items between the top and the above one on the given item.
28680 * @param it The naviframe item
28682 * @ingroup Naviframe
28684 EAPI void elm_naviframe_item_pop_to(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
28686 * Promote an item already in the naviframe stack to the top of the stack
28688 * @param it The naviframe item
28690 * This will take the indicated item and promote it to the top of the stack
28691 * as if it had been pushed there. The item must already be inside the
28692 * naviframe stack to work.
28695 EAPI void elm_naviframe_item_promote(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
28697 * @brief Delete the given item instantly.
28699 * @param it The naviframe item
28701 * This just deletes the given item from the naviframe item list instantly.
28702 * So this would not emit any signals for view transitions but just change
28703 * the current view if the given item is a top one.
28705 * @ingroup Naviframe
28707 EAPI void elm_naviframe_item_del(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
28709 * @brief preserve the content objects when items are popped.
28711 * @param obj The naviframe object
28712 * @param preserve Enable the preserve mode if EINA_TRUE, disable otherwise
28714 * @see also elm_naviframe_content_preserve_on_pop_get()
28716 * @ingroup Naviframe
28718 EAPI void elm_naviframe_content_preserve_on_pop_set(Evas_Object *obj, Eina_Bool preserve) EINA_ARG_NONNULL(1);
28720 * @brief Get a value whether preserve mode is enabled or not.
28722 * @param obj The naviframe object
28723 * @return If @c EINA_TRUE, preserve mode is enabled
28725 * @see also elm_naviframe_content_preserve_on_pop_set()
28727 * @ingroup Naviframe
28729 EAPI Eina_Bool elm_naviframe_content_preserve_on_pop_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
28731 * @brief Get a top item on the naviframe stack
28733 * @param obj The naviframe object
28734 * @return The top item on the naviframe stack or @c NULL, if the stack is
28737 * @ingroup Naviframe
28739 EAPI Elm_Object_Item *elm_naviframe_top_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
28741 * @brief Get a bottom item on the naviframe stack
28743 * @param obj The naviframe object
28744 * @return The bottom item on the naviframe stack or @c NULL, if the stack is
28747 * @ingroup Naviframe
28749 EAPI Elm_Object_Item *elm_naviframe_bottom_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
28751 * @brief Set an item style
28753 * @param obj The naviframe item
28754 * @param item_style The current item style name. @c NULL would be default
28756 * The following styles are available for this item:
28759 * @see also elm_naviframe_item_style_get()
28761 * @ingroup Naviframe
28763 EAPI void elm_naviframe_item_style_set(Elm_Object_Item *it, const char *item_style) EINA_ARG_NONNULL(1);
28765 * @brief Get an item style
28767 * @param obj The naviframe item
28768 * @return The current item style name
28770 * @see also elm_naviframe_item_style_set()
28772 * @ingroup Naviframe
28774 EAPI const char *elm_naviframe_item_style_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
28776 * @brief Show/Hide the title area
28778 * @param it The naviframe item
28779 * @param visible If @c EINA_TRUE, title area will be visible, hidden
28782 * When the title area is invisible, then the controls would be hidden so as * to expand the content area to full-size.
28784 * @see also elm_naviframe_item_title_visible_get()
28786 * @ingroup Naviframe
28788 EAPI void elm_naviframe_item_title_visible_set(Elm_Object_Item *it, Eina_Bool visible) EINA_ARG_NONNULL(1);
28790 * @brief Get a value whether title area is visible or not.
28792 * @param it The naviframe item
28793 * @return If @c EINA_TRUE, title area is visible
28795 * @see also elm_naviframe_item_title_visible_set()
28797 * @ingroup Naviframe
28799 EAPI Eina_Bool elm_naviframe_item_title_visible_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
28802 * @brief Set creating prev button automatically or not
28804 * @param obj The naviframe object
28805 * @param auto_pushed If @c EINA_TRUE, the previous button(back button) will
28806 * be created internally when you pass the @c NULL to the prev_btn
28807 * parameter in elm_naviframe_item_push
28809 * @see also elm_naviframe_item_push()
28811 EAPI void elm_naviframe_prev_btn_auto_pushed_set(Evas_Object *obj, Eina_Bool auto_pushed) EINA_ARG_NONNULL(1);
28813 * @brief Get a value whether prev button(back button) will be auto pushed or
28816 * @param obj The naviframe object
28817 * @return If @c EINA_TRUE, prev button will be auto pushed.
28819 * @see also elm_naviframe_item_push()
28820 * elm_naviframe_prev_btn_auto_pushed_set()
28822 EAPI Eina_Bool elm_naviframe_prev_btn_auto_pushed_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
28824 * @brief Get a list of all the naviframe items.
28826 * @param obj The naviframe object
28827 * @return An Eina_Inlist* of naviframe items, #Elm_Object_Item,
28828 * or @c NULL on failure.
28830 EAPI Eina_Inlist *elm_naviframe_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
28837 * @defgroup Multibuttonentry Multibuttonentry
28839 * A Multibuttonentry is a widget to allow a user enter text and manage it as a number of buttons
28840 * Each text button is inserted by pressing the "return" key. If there is no space in the current row,
28841 * a new button is added to the next row. When a text button is pressed, it will become focused.
28842 * Backspace removes the focus.
28843 * When the Multibuttonentry loses focus items longer than 1 lines are shrunk to one line.
28845 * Smart callbacks one can register:
28846 * - @c "item,selected" - when item is selected. May be called on backspace key.
28847 * - @c "item,added" - when a new multibuttonentry item is added.
28848 * - @c "item,deleted" - when a multibuttonentry item is deleted.
28849 * - @c "item,clicked" - selected item of multibuttonentry is clicked.
28850 * - @c "clicked" - when multibuttonentry is clicked.
28851 * - @c "focused" - when multibuttonentry is focused.
28852 * - @c "unfocused" - when multibuttonentry is unfocused.
28853 * - @c "expanded" - when multibuttonentry is expanded.
28854 * - @c "shrank" - when multibuttonentry is shrank.
28855 * - @c "shrank,state,changed" - when shrink mode state of multibuttonentry is changed.
28857 * Here is an example on its usage:
28858 * @li @ref multibuttonentry_example
28861 * @addtogroup Multibuttonentry
28865 typedef struct _Multibuttonentry_Item Elm_Multibuttonentry_Item;
28866 typedef Eina_Bool (*Elm_Multibuttonentry_Item_Filter_callback) (Evas_Object *obj, const char *item_label, void *item_data, void *data);
28869 * @brief Add a new multibuttonentry to the parent
28871 * @param parent The parent object
28872 * @return The new object or NULL if it cannot be created
28875 EAPI Evas_Object *elm_multibuttonentry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
28879 * @param obj The multibuttonentry object
28880 * @return The label, or NULL if none
28883 EAPI const char *elm_multibuttonentry_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
28887 * @param obj The multibuttonentry object
28888 * @param label The text label string
28891 EAPI void elm_multibuttonentry_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
28893 * Get the entry of the multibuttonentry object
28895 * @param obj The multibuttonentry object
28896 * @return The entry object, or NULL if none
28899 EAPI Evas_Object *elm_multibuttonentry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
28901 * Get the guide text
28903 * @param obj The multibuttonentry object
28904 * @return The guide text, or NULL if none
28907 EAPI const char * elm_multibuttonentry_guide_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
28909 * Set the guide text
28911 * @param obj The multibuttonentry object
28912 * @param label The guide text string
28915 EAPI void elm_multibuttonentry_guide_text_set(Evas_Object *obj, const char *guidetext) EINA_ARG_NONNULL(1);
28917 * Get the value of shrink_mode state.
28919 * @param obj The multibuttonentry object
28920 * @param the value of shrink mode state.
28923 EAPI int elm_multibuttonentry_shrink_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
28925 * Set/Unset the multibuttonentry to shrink mode state of single line
28927 * @param obj The multibuttonentry object
28928 * @param the value of shrink_mode state. set this to 1 to set the multibuttonentry to shrink state of single line. set this to 0 to unset the contracted state.
28931 EAPI void elm_multibuttonentry_shrink_mode_set(Evas_Object *obj, int shrink) EINA_ARG_NONNULL(1);
28933 * Prepend a new item to the multibuttonentry
28935 * @param obj The multibuttonentry object
28936 * @param label The label of new item
28937 * @param data The ponter to the data to be attached
28938 * @return A handle to the item added or NULL if not possible
28941 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_prepend(Evas_Object *obj, const char *label, void *data) EINA_ARG_NONNULL(1);
28943 * Append a new item to the multibuttonentry
28945 * @param obj The multibuttonentry object
28946 * @param label The label of new item
28947 * @param data The ponter to the data to be attached
28948 * @return A handle to the item added or NULL if not possible
28951 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_append(Evas_Object *obj, const char *label, void *data) EINA_ARG_NONNULL(1);
28953 * Add a new item to the multibuttonentry before the indicated object
28956 * @param obj The multibuttonentry object
28957 * @param before The item before which to add it
28958 * @param label The label of new item
28959 * @param data The ponter to the data to be attached
28960 * @return A handle to the item added or NULL if not possible
28963 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_insert_before(Evas_Object *obj, Elm_Multibuttonentry_Item *before, const char *label, void *data) EINA_ARG_NONNULL(1);
28965 * Add a new item to the multibuttonentry after the indicated object
28967 * @param obj The multibuttonentry object
28968 * @param after The item after which to add it
28969 * @param label The label of new item
28970 * @param data The ponter to the data to be attached
28971 * @return A handle to the item added or NULL if not possible
28974 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_insert_after(Evas_Object *obj, Elm_Multibuttonentry_Item *after, const char *label, void *data) EINA_ARG_NONNULL(1);
28976 * Get a list of items in the multibuttonentry
28978 * @param obj The multibuttonentry object
28979 * @return The list of items, or NULL if none
28982 EAPI const Eina_List *elm_multibuttonentry_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
28984 * Get the first item in the multibuttonentry
28986 * @param obj The multibuttonentry object
28987 * @return The first item, or NULL if none
28990 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
28992 * Get the last item in the multibuttonentry
28994 * @param obj The multibuttonentry object
28995 * @return The last item, or NULL if none
28998 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
29000 * Get the selected item in the multibuttonentry
29002 * @param obj The multibuttonentry object
29003 * @return The selected item, or NULL if none
29006 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
29008 * Set the selected state of an item
29010 * @param item The item
29011 * @param selected if it's EINA_TRUE, select the item otherwise, unselect the item
29014 EAPI void elm_multibuttonentry_item_select(Elm_Multibuttonentry_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
29016 * unselect all items.
29018 * @param obj The multibuttonentry object
29021 EAPI void elm_multibuttonentry_item_unselect_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
29023 * Delete a given item
29025 * @param item The item
29028 EAPI void elm_multibuttonentry_item_del(Elm_Multibuttonentry_Item *item) EINA_ARG_NONNULL(1);
29030 * Remove all items in the multibuttonentry.
29032 * @param obj The multibuttonentry object
29035 EAPI void elm_multibuttonentry_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
29037 * Get the label of a given item
29039 * @param item The item
29040 * @return The label of a given item, or NULL if none
29043 EAPI const char *elm_multibuttonentry_item_label_get(const Elm_Multibuttonentry_Item *item) EINA_ARG_NONNULL(1);
29045 * Set the label of a given item
29047 * @param item The item
29048 * @param label The text label string
29051 EAPI void elm_multibuttonentry_item_label_set(Elm_Multibuttonentry_Item *item, const char *str) EINA_ARG_NONNULL(1);
29053 * Get the previous item in the multibuttonentry
29055 * @param item The item
29056 * @return The item before the item @p item
29059 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_prev_get(const Elm_Multibuttonentry_Item *item) EINA_ARG_NONNULL(1);
29061 * Get the next item in the multibuttonentry
29063 * @param item The item
29064 * @return The item after the item @p item
29067 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_next_get(const Elm_Multibuttonentry_Item *item) EINA_ARG_NONNULL(1);
29069 * Append a item filter function for text inserted in the Multibuttonentry
29071 * Append the given callback to the list. This functions will be called
29072 * whenever any text is inserted into the Multibuttonentry, with the text to be inserted
29073 * as a parameter. The callback function is free to alter the text in any way
29074 * it wants, but it must remember to free the given pointer and update it.
29075 * If the new text is to be discarded, the function can free it and set it text
29076 * parameter to NULL. This will also prevent any following filters from being
29079 * @param obj The multibuttonentryentry object
29080 * @param func The function to use as item filter
29081 * @param data User data to pass to @p func
29084 EAPI void elm_multibuttonentry_item_filter_append(Evas_Object *obj, Elm_Multibuttonentry_Item_Filter_callback func, void *data) EINA_ARG_NONNULL(1);
29086 * Prepend a filter function for text inserted in the Multibuttentry
29088 * Prepend the given callback to the list. See elm_multibuttonentry_item_filter_append()
29089 * for more information
29091 * @param obj The multibuttonentry object
29092 * @param func The function to use as text filter
29093 * @param data User data to pass to @p func
29096 EAPI void elm_multibuttonentry_item_filter_prepend(Evas_Object *obj, Elm_Multibuttonentry_Item_Filter_callback func, void *data) EINA_ARG_NONNULL(1);
29098 * Remove a filter from the list
29100 * Removes the given callback from the filter list. See elm_multibuttonentry_item_filter_append()
29101 * for more information.
29103 * @param obj The multibuttonentry object
29104 * @param func The filter function to remove
29105 * @param data The user data passed when adding the function
29108 EAPI void elm_multibuttonentry_item_filter_remove(Evas_Object *obj, Elm_Multibuttonentry_Item_Filter_callback func, void *data) EINA_ARG_NONNULL(1);