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
245 @page authors Authors
246 @author Carsten Haitzler <raster@@rasterman.com>
247 @author Gustavo Sverzut Barbieri <barbieri@@profusion.mobi>
248 @author Cedric Bail <cedric.bail@@free.fr>
249 @author Vincent Torri <vtorri@@univ-evry.fr>
250 @author Daniel Kolesa <quaker66@@gmail.com>
251 @author Jaime Thomas <avi.thomas@@gmail.com>
252 @author Swisscom - http://www.swisscom.ch/
253 @author Christopher Michael <devilhorns@@comcast.net>
254 @author Marco Trevisan (TreviƱo) <mail@@3v1n0.net>
255 @author Michael Bouchaud <michael.bouchaud@@gmail.com>
256 @author Jonathan Atton (Watchwolf) <jonathan.atton@@gmail.com>
257 @author Brian Wang <brian.wang.0721@@gmail.com>
258 @author Mike Blumenkrantz (discomfitor/zmike) <michael.blumenkrantz@@gmail.com>
259 @author Samsung Electronics <tbd>
260 @author Samsung SAIT <tbd>
261 @author Brett Nash <nash@@nash.id.au>
262 @author Bruno Dilly <bdilly@@profusion.mobi>
263 @author Rafael Fonseca <rfonseca@@profusion.mobi>
264 @author Chuneon Park <hermet@@hermet.pe.kr>
265 @author Woohyun Jung <wh0705.jung@@samsung.com>
266 @author Jaehwan Kim <jae.hwan.kim@@samsung.com>
267 @author Wonguk Jeong <wonguk.jeong@@samsung.com>
268 @author Leandro A. F. Pereira <leandro@@profusion.mobi>
269 @author Helen Fornazier <helen.fornazier@@profusion.mobi>
270 @author Gustavo Lima Chaves <glima@@profusion.mobi>
271 @author Fabiano FidĆŖncio <fidencio@@profusion.mobi>
272 @author Tiago FalcĆ£o <tiago@@profusion.mobi>
273 @author Otavio Pontes <otavio@@profusion.mobi>
274 @author Viktor Kojouharov <vkojouharov@@gmail.com>
275 @author Daniel Juyung Seo (SeoZ) <juyung.seo@@samsung.com> <seojuyung2@@gmail.com>
276 @author Sangho Park <sangho.g.park@@samsung.com> <gouache95@@gmail.com>
277 @author Rajeev Ranjan (Rajeev) <rajeev.r@@samsung.com> <rajeev.jnnce@@gmail.com>
278 @author Seunggyun Kim <sgyun.kim@@samsung.com> <tmdrbs@@gmail.com>
279 @author Sohyun Kim <anna1014.kim@@samsung.com> <sohyun.anna@@gmail.com>
280 @author Jihoon Kim <jihoon48.kim@@samsung.com>
281 @author Jeonghyun Yun (arosis) <jh0506.yun@@samsung.com>
282 @author Tom Hacohen <tom@@stosb.com>
283 @author Aharon Hillel <a.hillel@@partner.samsung.com>
284 @author Jonathan Atton (Watchwolf) <jonathan.atton@@gmail.com>
285 @author Shinwoo Kim <kimcinoo@@gmail.com>
286 @author Govindaraju SM <govi.sm@@samsung.com> <govism@@gmail.com>
287 @author Prince Kumar Dubey <prince.dubey@@samsung.com> <prince.dubey@@gmail.com>
288 @author Sung W. Park <sungwoo@@gmail.com>
289 @author Thierry el Borgi <thierry@@substantiel.fr>
290 @author Shilpa Singh <shilpa.singh@@samsung.com> <shilpasingh.o@@gmail.com>
291 @author Chanwook Jung <joey.jung@@samsung.com>
292 @author Hyoyoung Chang <hyoyoung.chang@@samsung.com>
293 @author Guillaume "Kuri" Friloux <guillaume.friloux@@asp64.com>
294 @author Kim Yunhan <spbear@@gmail.com>
295 @author Bluezery <ohpowel@@gmail.com>
296 @author Nicolas Aguirre <aguirre.nicolas@@gmail.com>
297 @author Sanjeev BA <iamsanjeev@@gmail.com>
299 Please contact <enlightenment-devel@lists.sourceforge.net> to get in
300 contact with the developers and maintainers.
308 * @brief Elementary's API
313 @ELM_UNIX_DEF@ ELM_UNIX
314 @ELM_WIN32_DEF@ ELM_WIN32
315 @ELM_WINCE_DEF@ ELM_WINCE
316 @ELM_EDBUS_DEF@ ELM_EDBUS
317 @ELM_EFREET_DEF@ ELM_EFREET
318 @ELM_ETHUMB_DEF@ ELM_ETHUMB
319 @ELM_WEB_DEF@ ELM_WEB
320 @ELM_EMAP_DEF@ ELM_EMAP
321 @ELM_DEBUG_DEF@ ELM_DEBUG
322 @ELM_ALLOCA_H_DEF@ ELM_ALLOCA_H
323 @ELM_LIBINTL_H_DEF@ ELM_LIBINTL_H
324 @ELM_DIRENT_H_DEF@ ELM_DIRENT_H
326 /* Standard headers for standard system calls etc. */
331 #include <sys/types.h>
332 #include <sys/stat.h>
333 #include <sys/time.h>
334 #include <sys/param.h>
348 # ifdef ELM_LIBINTL_H
349 # include <libintl.h>
360 #if defined (ELM_WIN32) || defined (ELM_WINCE)
363 # define alloca _alloca
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);
897 * Exposed symbol used only by macros and should not be used by apps
899 EAPI void elm_quicklaunch_mode_set(Eina_Bool ql_on);
902 * Exposed symbol used only by macros and should not be used by apps
904 EAPI Eina_Bool elm_quicklaunch_mode_get(void);
907 * Exposed symbol used only by macros and should not be used by apps
909 EAPI int elm_quicklaunch_init(int argc, char **argv);
912 * Exposed symbol used only by macros and should not be used by apps
914 EAPI int elm_quicklaunch_sub_init(int argc, char **argv);
917 * Exposed symbol used only by macros and should not be used by apps
919 EAPI int elm_quicklaunch_sub_shutdown(void);
922 * Exposed symbol used only by macros and should not be used by apps
924 EAPI int elm_quicklaunch_shutdown(void);
927 * Exposed symbol used only by macros and should not be used by apps
929 EAPI void elm_quicklaunch_seed(void);
932 * Exposed symbol used only by macros and should not be used by apps
934 EAPI Eina_Bool elm_quicklaunch_prepare(int argc, char **argv);
937 * Exposed symbol used only by macros and should not be used by apps
939 EAPI Eina_Bool elm_quicklaunch_fork(int argc, char **argv, char *cwd, void (postfork_func) (void *data), void *postfork_data);
942 * Exposed symbol used only by macros and should not be used by apps
944 EAPI void elm_quicklaunch_cleanup(void);
947 * Exposed symbol used only by macros and should not be used by apps
949 EAPI int elm_quicklaunch_fallback(int argc, char **argv);
952 * Exposed symbol used only by macros and should not be used by apps
954 EAPI char *elm_quicklaunch_exe_path_get(const char *exe);
957 * Request that your elementary application needs efreet
959 * This initializes the Efreet library when called and if support exists
960 * it returns EINA_TRUE, otherwise returns EINA_FALSE. This must be called
961 * before any efreet calls.
963 * @return EINA_TRUE if support exists and initialization succeeded.
967 EAPI Eina_Bool elm_need_efreet(void);
970 * Request that your elementary application needs e_dbus
972 * This initializes the E_dbus library when called and if support exists
973 * it returns EINA_TRUE, otherwise returns EINA_FALSE. This must be called
974 * before any e_dbus calls.
976 * @return EINA_TRUE if support exists and initialization succeeded.
980 EAPI Eina_Bool elm_need_e_dbus(void);
983 * Request that your elementary application needs ethumb
985 * This initializes the Ethumb library when called and if support exists
986 * it returns EINA_TRUE, otherwise returns EINA_FALSE.
987 * This must be called before any other function that deals with
988 * elm_thumb objects or ethumb_client instances.
992 EAPI Eina_Bool elm_need_ethumb(void);
995 * Request that your elementary application needs web support
997 * This initializes the Ewebkit library when called and if support exists
998 * it returns EINA_TRUE, otherwise returns EINA_FALSE.
999 * This must be called before any other function that deals with
1000 * elm_web objects or ewk_view instances.
1004 EAPI Eina_Bool elm_need_web(void);
1007 * Set a new policy's value (for a given policy group/identifier).
1009 * @param policy policy identifier, as in @ref Elm_Policy.
1010 * @param value policy value, which depends on the identifier
1012 * @return @c EINA_TRUE on success or @c EINA_FALSE, on error.
1014 * Elementary policies define applications' behavior,
1015 * somehow. These behaviors are divided in policy groups (see
1016 * #Elm_Policy enumeration). This call will emit the Ecore event
1017 * #ELM_EVENT_POLICY_CHANGED, which can be hooked at with
1018 * handlers. An #Elm_Event_Policy_Changed struct will be passed,
1021 * @note Currently, we have only one policy identifier/group
1022 * (#ELM_POLICY_QUIT), which has two possible values.
1026 EAPI Eina_Bool elm_policy_set(unsigned int policy, int value);
1029 * Gets the policy value for given policy identifier.
1031 * @param policy policy identifier, as in #Elm_Policy.
1032 * @return The currently set policy value, for that
1033 * identifier. Will be @c 0 if @p policy passed is invalid.
1037 EAPI int elm_policy_get(unsigned int policy);
1040 * Change the language of the current application
1042 * The @p lang passed must be the full name of the locale to use, for
1043 * example "en_US.utf8" or "es_ES@euro".
1045 * Changing language with this function will make Elementary run through
1046 * all its widgets, translating strings set with
1047 * elm_object_domain_translatable_text_part_set(). This way, an entire
1048 * UI can have its language changed without having to restart the program.
1050 * For more complex cases, like having formatted strings that need
1051 * translation, widgets will also emit a "language,changed" signal that
1052 * the user can listen to to manually translate the text.
1054 * @param lang Language to set, must be the full name of the locale
1058 EAPI void elm_language_set(const char *lang);
1061 * Set a label of an object
1063 * @param obj The Elementary object
1064 * @param part The text part name to set (NULL for the default label)
1065 * @param label The new text of the label
1067 * @note Elementary objects may have many labels (e.g. Action Slider)
1068 * @deprecated Use elm_object_part_text_set() instead.
1071 EINA_DEPRECATED EAPI void elm_object_text_part_set(Evas_Object *obj, const char *part, const char *label);
1074 * Set a label of an object
1076 * @param obj The Elementary object
1077 * @param part The text part name to set (NULL for the default label)
1078 * @param label The new text of the label
1080 * @note Elementary objects may have many labels (e.g. Action Slider)
1084 EAPI void elm_object_part_text_set(Evas_Object *obj, const char *part, const char *label);
1086 #define elm_object_text_set(obj, label) elm_object_part_text_set((obj), NULL, (label))
1089 * Get a label of an object
1091 * @param obj The Elementary object
1092 * @param part The text part name to get (NULL for the default label)
1093 * @return text of the label or NULL for any error
1095 * @note Elementary objects may have many labels (e.g. Action Slider)
1096 * @deprecated Use elm_object_part_text_get() instead.
1099 EINA_DEPRECATED EAPI const char *elm_object_text_part_get(const Evas_Object *obj, const char *part);
1102 * Get a label of an object
1104 * @param obj The Elementary object
1105 * @param part The text part name to get (NULL for the default label)
1106 * @return text of the label or NULL for any error
1108 * @note Elementary objects may have many labels (e.g. Action Slider)
1112 EAPI const char *elm_object_part_text_get(const Evas_Object *obj, const char *part);
1114 #define elm_object_text_get(obj) elm_object_part_text_get((obj), NULL)
1117 * Set the text for an objects' part, marking it as translatable.
1119 * The string to set as @p text must be the original one. Do not pass the
1120 * return of @c gettext() here. Elementary will translate the string
1121 * internally and set it on the object using elm_object_part_text_set(),
1122 * also storing the original string so that it can be automatically
1123 * translated when the language is changed with elm_language_set().
1125 * The @p domain will be stored along to find the translation in the
1126 * correct catalog. It can be NULL, in which case it will use whatever
1127 * domain was set by the application with @c textdomain(). This is useful
1128 * in case you are building a library on top of Elementary that will have
1129 * its own translatable strings, that should not be mixed with those of
1130 * programs using the library.
1132 * @param obj The object containing the text part
1133 * @param part The name of the part to set
1134 * @param domain The translation domain to use
1135 * @param text The original, non-translated text to set
1139 EAPI void elm_object_domain_translatable_text_part_set(Evas_Object *obj, const char *part, const char *domain, const char *text);
1141 #define elm_object_domain_translatable_text_set(obj, domain, text) elm_object_domain_translatable_text_part_set((obj), NULL, (domain), (text))
1143 #define elm_object_translatable_text_set(obj, text) elm_object_domain_translatable_text_part_set((obj), NULL, NULL, (text))
1146 * Gets the original string set as translatable for an object
1148 * When setting translated strings, the function elm_object_part_text_get()
1149 * will return the translation returned by @c gettext(). To get the
1150 * original string use this function.
1152 * @param obj The object
1153 * @param part The name of the part that was set
1155 * @return The original, untranslated string
1159 EAPI const char *elm_object_translatable_text_part_get(const Evas_Object *obj, const char *part);
1161 #define elm_object_translatable_text_get(obj) elm_object_translatable_text_part_get((obj), NULL)
1164 * Set a content of an object
1166 * @param obj The Elementary object
1167 * @param part The content part name to set (NULL for the default content)
1168 * @param content The new content of the object
1170 * @note Elementary objects may have many contents
1171 * @deprecated Use elm_object_part_content_set instead.
1174 EINA_DEPRECATED EAPI void elm_object_content_part_set(Evas_Object *obj, const char *part, Evas_Object *content);
1177 * Set a content of an object
1179 * @param obj The Elementary object
1180 * @param part The content part name to set (NULL for the default content)
1181 * @param content The new content of the object
1183 * @note Elementary objects may have many contents
1187 EAPI void elm_object_part_content_set(Evas_Object *obj, const char *part, Evas_Object *content);
1189 #define elm_object_content_set(obj, content) elm_object_part_content_set((obj), NULL, (content))
1192 * Get a content of an object
1194 * @param obj The Elementary object
1195 * @param item The content part name to get (NULL for the default content)
1196 * @return content of the object or NULL for any error
1198 * @note Elementary objects may have many contents
1199 * @deprecated Use elm_object_part_content_get instead.
1202 EINA_DEPRECATED EAPI Evas_Object *elm_object_content_part_get(const Evas_Object *obj, const char *part);
1205 * Get a content of an object
1207 * @param obj The Elementary object
1208 * @param item The content part name to get (NULL for the default content)
1209 * @return content of the object or NULL for any error
1211 * @note Elementary objects may have many contents
1215 EAPI Evas_Object *elm_object_part_content_get(const Evas_Object *obj, const char *part);
1217 #define elm_object_content_get(obj) elm_object_part_content_get((obj), NULL)
1220 * Unset a content of an object
1222 * @param obj The Elementary object
1223 * @param item The content part name to unset (NULL for the default content)
1225 * @note Elementary objects may have many contents
1226 * @deprecated Use elm_object_part_content_unset instead.
1229 EINA_DEPRECATED EAPI Evas_Object *elm_object_content_part_unset(Evas_Object *obj, const char *part);
1232 * Unset a content of an object
1234 * @param obj The Elementary object
1235 * @param item The content part name to unset (NULL for the default content)
1237 * @note Elementary objects may have many contents
1241 EAPI Evas_Object *elm_object_part_content_unset(Evas_Object *obj, const char *part);
1243 #define elm_object_content_unset(obj) elm_object_part_content_unset((obj), NULL)
1246 * Set the text to read out when in accessibility mode
1248 * @param obj The object which is to be described
1249 * @param txt The text that describes the widget to people with poor or no vision
1253 EAPI void elm_object_access_info_set(Evas_Object *obj, const char *txt);
1256 * Get a named object from the children
1258 * @param obj The parent object whose children to look at
1259 * @param name The name of the child to find
1260 * @param recurse Set to thge maximum number of levels to recurse (0 == none, 1 is only look at 1 level of children etc.)
1261 * @return The found object of that name, or NULL if none is found
1263 * This function searches the children (or recursively children of
1264 * children and so on) of the given @p obj object looking for a child with
1265 * the name of @p name. If the child is found the object is returned, or
1266 * NULL is returned. You can set the name of an object with
1267 * evas_object_name_set(). If the name is not unique within the child
1268 * objects (or the tree is @p recurse is greater than 0) then it is
1269 * undefined as to which child of that name is returned, so ensure the name
1270 * is unique amongst children. If recurse is set to -1 it will recurse
1275 EAPI Evas_Object *elm_object_name_find(const Evas_Object *obj, const char *name, int recurse);
1278 * Get the widget object's handle which contains a given item
1280 * @param item The Elementary object item
1281 * @return The widget object
1283 * @note This returns the widget object itself that an item belongs to.
1287 EAPI Evas_Object *elm_object_item_object_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
1290 * Set a content of an object item
1292 * @param it The Elementary object item
1293 * @param part The content part name to set (NULL for the default content)
1294 * @param content The new content of the object item
1296 * @note Elementary object items may have many contents
1297 * @deprecated Use elm_object_item_part_content_set instead.
1300 EINA_DEPRECATED EAPI void elm_object_item_content_part_set(Elm_Object_Item *it, const char *part, Evas_Object *content);
1303 * Set a content of an object item
1305 * @param it The Elementary object item
1306 * @param part The content part name to set (NULL for the default content)
1307 * @param content The new content of the object item
1309 * @note Elementary object items may have many contents
1313 EAPI void elm_object_item_part_content_set(Elm_Object_Item *it, const char *part, Evas_Object *content);
1315 #define elm_object_item_content_set(it, content) elm_object_item_part_content_set((it), NULL, (content))
1318 * Get a content of an object item
1320 * @param it The Elementary object item
1321 * @param part The content part name to unset (NULL for the default content)
1322 * @return content of the object item or NULL for any error
1324 * @note Elementary object items may have many contents
1325 * @deprecated Use elm_object_item_part_content_get instead.
1328 EAPI Evas_Object *elm_object_item_content_part_get(const Elm_Object_Item *it, const char *part);
1331 * Get a content of an object item
1333 * @param it The Elementary object item
1334 * @param part The content part name to unset (NULL for the default content)
1335 * @return content of the object item or NULL for any error
1337 * @note Elementary object items may have many contents
1341 EAPI Evas_Object *elm_object_item_part_content_get(const Elm_Object_Item *it, const char *part);
1343 #define elm_object_item_content_get(it) elm_object_item_part_content_get((it), NULL)
1346 * Unset a content of an object item
1348 * @param it The Elementary object item
1349 * @param part The content part name to unset (NULL for the default content)
1351 * @note Elementary object items may have many contents
1352 * @deprecated Use elm_object_item_part_content_unset instead.
1355 EINA_DEPRECATED EAPI Evas_Object *elm_object_item_content_part_unset(Elm_Object_Item *it, const char *part);
1358 * Unset a content of an object item
1360 * @param it The Elementary object item
1361 * @param part The content part name to unset (NULL for the default content)
1363 * @note Elementary object items may have many contents
1367 EAPI Evas_Object *elm_object_item_part_content_unset(Elm_Object_Item *it, const char *part);
1369 #define elm_object_item_content_unset(it) elm_object_item_part_content_unset((it), NULL)
1372 * Set a label of an object item
1374 * @param it The Elementary object item
1375 * @param part The text part name to set (NULL for the default label)
1376 * @param label The new text of the label
1378 * @note Elementary object items may have many labels
1379 * @deprecated Use elm_object_item_part_text_set instead.
1382 EINA_DEPRECATED EAPI void elm_object_item_text_part_set(Elm_Object_Item *it, const char *part, const char *label);
1385 * Set a label of an object item
1387 * @param it The Elementary object item
1388 * @param part The text part name to set (NULL for the default label)
1389 * @param label The new text of the label
1391 * @note Elementary object items may have many labels
1395 EAPI void elm_object_item_part_text_set(Elm_Object_Item *it, const char *part, const char *label);
1397 #define elm_object_item_text_set(it, label) elm_object_item_part_text_set((it), NULL, (label))
1400 * Get a label of an object item
1402 * @param it The Elementary object item
1403 * @param part The text part name to get (NULL for the default label)
1404 * @return text of the label or NULL for any error
1406 * @note Elementary object items may have many labels
1407 * @deprecated Use elm_object_item_part_text_get instead.
1410 EINA_DEPRECATED EAPI const char *elm_object_item_text_part_get(const Elm_Object_Item *it, const char *part);
1412 * Get a label of an object item
1414 * @param it The Elementary object item
1415 * @param part The text part name to get (NULL for the default label)
1416 * @return text of the label or NULL for any error
1418 * @note Elementary object items may have many labels
1422 EAPI const char *elm_object_item_part_text_get(const Elm_Object_Item *it, const char *part);
1424 #define elm_object_item_text_get(it) elm_object_item_part_text_get((it), NULL)
1427 * Set the text to read out when in accessibility mode
1429 * @param it The object item which is to be described
1430 * @param txt The text that describes the widget to people with poor or no vision
1434 EAPI void elm_object_item_access_info_set(Elm_Object_Item *it, const char *txt);
1437 * Get the data associated with an object item
1438 * @param it The Elementary object item
1439 * @return The data associated with @p it
1443 EAPI void *elm_object_item_data_get(const Elm_Object_Item *it);
1446 * Set the data associated with an object item
1447 * @param it The Elementary object item
1448 * @param data The data to be associated with @p it
1452 EAPI void elm_object_item_data_set(Elm_Object_Item *it, void *data);
1455 * Send a signal to the edje object of the widget item.
1457 * This function sends a signal to the edje object of the obj item. An
1458 * edje program can respond to a signal by specifying matching
1459 * 'signal' and 'source' fields.
1461 * @param it The Elementary object item
1462 * @param emission The signal's name.
1463 * @param source The signal's source.
1466 EAPI void elm_object_item_signal_emit(Elm_Object_Item *it, const char *emission, const char *source) EINA_ARG_NONNULL(1);
1469 * Set the disabled state of an widget item.
1471 * @param obj The Elementary object item
1472 * @param disabled The state to put in in: @c EINA_TRUE for
1473 * disabled, @c EINA_FALSE for enabled
1475 * Elementary object item can be @b disabled, in which state they won't
1476 * receive input and, in general, will be themed differently from
1477 * their normal state, usually greyed out. Useful for contexts
1478 * where you don't want your users to interact with some of the
1479 * parts of you interface.
1481 * This sets the state for the widget item, either disabling it or
1486 EAPI void elm_object_item_disabled_set(Elm_Object_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1);
1489 * Get the disabled state of an widget item.
1491 * @param obj The Elementary object
1492 * @return @c EINA_TRUE, if the widget item is disabled, @c EINA_FALSE
1493 * if it's enabled (or on errors)
1495 * This gets the state of the widget, which might be enabled or disabled.
1499 EAPI Eina_Bool elm_object_item_disabled_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
1506 * @defgroup Caches Caches
1508 * These are functions which let one fine-tune some cache values for
1509 * Elementary applications, thus allowing for performance adjustments.
1515 * @brief Flush all caches.
1517 * Frees all data that was in cache and is not currently being used to reduce
1518 * memory usage. This frees Edje's, Evas' and Eet's cache. This is equivalent
1519 * to calling all of the following functions:
1520 * @li edje_file_cache_flush()
1521 * @li edje_collection_cache_flush()
1522 * @li eet_clearcache()
1523 * @li evas_image_cache_flush()
1524 * @li evas_font_cache_flush()
1525 * @li evas_render_dump()
1526 * @note Evas caches are flushed for every canvas associated with a window.
1530 EAPI void elm_all_flush(void);
1533 * Get the configured cache flush interval time
1535 * This gets the globally configured cache flush interval time, in
1538 * @return The cache flush interval time
1541 * @see elm_all_flush()
1543 EAPI int elm_cache_flush_interval_get(void);
1546 * Set the configured cache flush interval time
1548 * This sets the globally configured cache flush interval time, in ticks
1550 * @param size The cache flush interval time
1553 * @see elm_all_flush()
1555 EAPI void elm_cache_flush_interval_set(int size);
1558 * Set the configured cache flush interval time for all applications on the
1561 * This sets the globally configured cache flush interval time -- in ticks
1562 * -- for all applications on the display.
1564 * @param size The cache flush interval time
1567 EAPI void elm_cache_flush_interval_all_set(int size);
1570 * Get the configured cache flush enabled state
1572 * This gets the globally configured cache flush state - if it is enabled
1573 * or not. When cache flushing is enabled, elementary will regularly
1574 * (see elm_cache_flush_interval_get() ) flush caches and dump data out of
1575 * memory and allow usage to re-seed caches and data in memory where it
1576 * can do so. An idle application will thus minimise its memory usage as
1577 * data will be freed from memory and not be re-loaded as it is idle and
1578 * not rendering or doing anything graphically right now.
1580 * @return The cache flush state
1583 * @see elm_all_flush()
1585 EAPI Eina_Bool elm_cache_flush_enabled_get(void);
1588 * Set the configured cache flush enabled state
1590 * This sets the globally configured cache flush enabled state.
1592 * @param size The cache flush enabled state
1595 * @see elm_all_flush()
1597 EAPI void elm_cache_flush_enabled_set(Eina_Bool enabled);
1600 * Set the configured cache flush enabled state for all applications on the
1603 * This sets the globally configured cache flush enabled state for all
1604 * applications on the display.
1606 * @param size The cache flush enabled state
1609 EAPI void elm_cache_flush_enabled_all_set(Eina_Bool enabled);
1612 * Get the configured font cache size
1614 * This gets the globally configured font cache size, in bytes.
1616 * @return The font cache size
1619 EAPI int elm_font_cache_get(void);
1622 * Set the configured font cache size
1624 * This sets the globally configured font cache size, in bytes
1626 * @param size The font cache size
1629 EAPI void elm_font_cache_set(int size);
1632 * Set the configured font cache size for all applications on the
1635 * This sets the globally configured font cache size -- in bytes
1636 * -- for all applications on the display.
1638 * @param size The font cache size
1641 EAPI void elm_font_cache_all_set(int size);
1644 * Get the configured image cache size
1646 * This gets the globally configured image cache size, in bytes
1648 * @return The image cache size
1651 EAPI int elm_image_cache_get(void);
1654 * Set the configured image cache size
1656 * This sets the globally configured image cache size, in bytes
1658 * @param size The image cache size
1661 EAPI void elm_image_cache_set(int size);
1664 * Set the configured image cache size for all applications on the
1667 * This sets the globally configured image cache size -- in bytes
1668 * -- for all applications on the display.
1670 * @param size The image cache size
1673 EAPI void elm_image_cache_all_set(int size);
1676 * Get the configured edje file cache size.
1678 * This gets the globally configured edje file cache size, in number
1681 * @return The edje file cache size
1684 EAPI int elm_edje_file_cache_get(void);
1687 * Set the configured edje file cache size
1689 * This sets the globally configured edje file cache size, in number
1692 * @param size The edje file cache size
1695 EAPI void elm_edje_file_cache_set(int size);
1698 * Set the configured edje file cache size for all applications on the
1701 * This sets the globally configured edje file cache size -- in number
1702 * of files -- for all applications on the display.
1704 * @param size The edje file cache size
1707 EAPI void elm_edje_file_cache_all_set(int size);
1710 * Get the configured edje collections (groups) cache size.
1712 * This gets the globally configured edje collections cache size, in
1713 * number of collections.
1715 * @return The edje collections cache size
1718 EAPI int elm_edje_collection_cache_get(void);
1721 * Set the configured edje collections (groups) cache size
1723 * This sets the globally configured edje collections cache size, in
1724 * number of collections.
1726 * @param size The edje collections cache size
1729 EAPI void elm_edje_collection_cache_set(int size);
1732 * Set the configured edje collections (groups) cache size for all
1733 * applications on the display
1735 * This sets the globally configured edje collections cache size -- in
1736 * number of collections -- for all applications on the display.
1738 * @param size The edje collections cache size
1741 EAPI void elm_edje_collection_cache_all_set(int size);
1748 * @defgroup Scaling Widget Scaling
1750 * Different widgets can be scaled independently. These functions
1751 * allow you to manipulate this scaling on a per-widget basis. The
1752 * object and all its children get their scaling factors multiplied
1753 * by the scale factor set. This is multiplicative, in that if a
1754 * child also has a scale size set it is in turn multiplied by its
1755 * parent's scale size. @c 1.0 means ādon't scaleā, @c 2.0 is
1756 * double size, @c 0.5 is half, etc.
1758 * @ref general_functions_example_page "This" example contemplates
1759 * some of these functions.
1763 * Get the global scaling factor
1765 * This gets the globally configured scaling factor that is applied to all
1768 * @return The scaling factor
1771 EAPI double elm_scale_get(void);
1774 * Set the global scaling factor
1776 * This sets the globally configured scaling factor that is applied to all
1779 * @param scale The scaling factor to set
1782 EAPI void elm_scale_set(double scale);
1785 * Set the global scaling factor for all applications on the display
1787 * This sets the globally configured scaling factor that is applied to all
1788 * objects for all applications.
1789 * @param scale The scaling factor to set
1792 EAPI void elm_scale_all_set(double scale);
1795 * Set the scaling factor for a given Elementary object
1797 * @param obj The Elementary to operate on
1798 * @param scale Scale factor (from @c 0.0 up, with @c 1.0 meaning
1803 EAPI void elm_object_scale_set(Evas_Object *obj, double scale) EINA_ARG_NONNULL(1);
1806 * Get the scaling factor for a given Elementary object
1808 * @param obj The object
1809 * @return The scaling factor set by elm_object_scale_set()
1813 EAPI double elm_object_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1816 * @defgroup Password_last_show Password last input show
1818 * Last show feature of password mode enables user to view
1819 * the last input entered for few seconds before masking it.
1820 * These functions allow to set this feature in password mode
1821 * of entry widget and also allow to manipulate the duration
1822 * for which the input has to be visible.
1828 * Get show last setting of password mode.
1830 * This gets the show last input setting of password mode which might be
1831 * enabled or disabled.
1833 * @return @c EINA_TRUE, if the last input show setting is enabled, @c EINA_FALSE
1835 * @ingroup Password_last_show
1837 EAPI Eina_Bool elm_password_show_last_get(void);
1840 * Set show last setting in password mode.
1842 * This enables or disables show last setting of password mode.
1844 * @param password_show_last If EINA_TRUE enable's last input show in password mode.
1845 * @see elm_password_show_last_timeout_set()
1846 * @ingroup Password_last_show
1848 EAPI void elm_password_show_last_set(Eina_Bool password_show_last);
1851 * Get's the timeout value in last show password mode.
1853 * This gets the time out value for which the last input entered in password
1854 * mode will be visible.
1856 * @return The timeout value of last show password mode.
1857 * @ingroup Password_last_show
1859 EAPI double elm_password_show_last_timeout_get(void);
1862 * Set's the timeout value in last show password mode.
1864 * This sets the time out value for which the last input entered in password
1865 * mode will be visible.
1867 * @param password_show_last_timeout The timeout value.
1868 * @see elm_password_show_last_set()
1869 * @ingroup Password_last_show
1871 EAPI void elm_password_show_last_timeout_set(double password_show_last_timeout);
1878 * @defgroup UI-Mirroring Selective Widget mirroring
1880 * These functions allow you to set ui-mirroring on specific
1881 * widgets or the whole interface. Widgets can be in one of two
1882 * modes, automatic and manual. Automatic means they'll be changed
1883 * according to the system mirroring mode and manual means only
1884 * explicit changes will matter. You are not supposed to change
1885 * mirroring state of a widget set to automatic, will mostly work,
1886 * but the behavior is not really defined.
1891 EAPI Eina_Bool elm_mirrored_get(void);
1892 EAPI void elm_mirrored_set(Eina_Bool mirrored);
1895 * Get the system mirrored mode. This determines the default mirrored mode
1898 * @return EINA_TRUE if mirrored is set, EINA_FALSE otherwise
1900 EAPI Eina_Bool elm_object_mirrored_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1903 * Set the system mirrored mode. This determines the default mirrored mode
1906 * @param mirrored EINA_TRUE to set mirrored mode, EINA_FALSE to unset it.
1908 EAPI void elm_object_mirrored_set(Evas_Object *obj, Eina_Bool mirrored) EINA_ARG_NONNULL(1);
1911 * Returns the widget's mirrored mode setting.
1913 * @param obj The widget.
1914 * @return mirrored mode setting of the object.
1917 EAPI Eina_Bool elm_object_mirrored_automatic_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1920 * Sets the widget's mirrored mode setting.
1921 * When widget in automatic mode, it follows the system mirrored mode set by
1922 * elm_mirrored_set().
1923 * @param obj The widget.
1924 * @param automatic EINA_TRUE for auto mirrored mode. EINA_FALSE for manual.
1926 EAPI void elm_object_mirrored_automatic_set(Evas_Object *obj, Eina_Bool automatic) EINA_ARG_NONNULL(1);
1933 * Set the style to use by a widget
1935 * Sets the style name that will define the appearance of a widget. Styles
1936 * vary from widget to widget and may also be defined by other themes
1937 * by means of extensions and overlays.
1939 * @param obj The Elementary widget to style
1940 * @param style The style name to use
1942 * @see elm_theme_extension_add()
1943 * @see elm_theme_extension_del()
1944 * @see elm_theme_overlay_add()
1945 * @see elm_theme_overlay_del()
1949 EAPI void elm_object_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
1951 * Get the style used by the widget
1953 * This gets the style being used for that widget. Note that the string
1954 * pointer is only valid as longas the object is valid and the style doesn't
1957 * @param obj The Elementary widget to query for its style
1958 * @return The style name used
1960 * @see elm_object_style_set()
1964 EAPI const char *elm_object_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1967 * @defgroup Styles Styles
1969 * Widgets can have different styles of look. These generic API's
1970 * set styles of widgets, if they support them (and if the theme(s)
1973 * @ref general_functions_example_page "This" example contemplates
1974 * some of these functions.
1978 * Set the disabled state of an Elementary object.
1980 * @param obj The Elementary object to operate on
1981 * @param disabled The state to put in in: @c EINA_TRUE for
1982 * disabled, @c EINA_FALSE for enabled
1984 * Elementary objects can be @b disabled, in which state they won't
1985 * receive input and, in general, will be themed differently from
1986 * their normal state, usually greyed out. Useful for contexts
1987 * where you don't want your users to interact with some of the
1988 * parts of you interface.
1990 * This sets the state for the widget, either disabling it or
1995 EAPI void elm_object_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
1998 * Get the disabled state of an Elementary object.
2000 * @param obj The Elementary object to operate on
2001 * @return @c EINA_TRUE, if the widget is disabled, @c EINA_FALSE
2002 * if it's enabled (or on errors)
2004 * This gets the state of the widget, which might be enabled or disabled.
2008 EAPI Eina_Bool elm_object_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2011 * @defgroup WidgetNavigation Widget Tree Navigation.
2013 * How to check if an Evas Object is an Elementary widget? How to
2014 * get the first elementary widget that is parent of the given
2015 * object? These are all covered in widget tree navigation.
2017 * @ref general_functions_example_page "This" example contemplates
2018 * some of these functions.
2022 * Check if the given Evas Object is an Elementary widget.
2024 * @param obj the object to query.
2025 * @return @c EINA_TRUE if it is an elementary widget variant,
2026 * @c EINA_FALSE otherwise
2027 * @ingroup WidgetNavigation
2029 EAPI Eina_Bool elm_object_widget_check(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2032 * Get the first parent of the given object that is an Elementary
2035 * @param obj the Elementary object to query parent from.
2036 * @return the parent object that is an Elementary widget, or @c
2037 * NULL, if it was not found.
2039 * Use this to query for an object's parent widget.
2041 * @note Most of Elementary users wouldn't be mixing non-Elementary
2042 * smart objects in the objects tree of an application, as this is
2043 * an advanced usage of Elementary with Evas. So, except for the
2044 * application's window, which is the root of that tree, all other
2045 * objects would have valid Elementary widget parents.
2047 * @ingroup WidgetNavigation
2049 EAPI Evas_Object *elm_object_parent_widget_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2052 * Get the top level parent of an Elementary widget.
2054 * @param obj The object to query.
2055 * @return The top level Elementary widget, or @c NULL if parent cannot be
2057 * @ingroup WidgetNavigation
2059 EAPI Evas_Object *elm_object_top_widget_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2062 * Get the string that represents this Elementary widget.
2064 * @note Elementary is weird and exposes itself as a single
2065 * Evas_Object_Smart_Class of type "elm_widget", so
2066 * evas_object_type_get() always return that, making debug and
2067 * language bindings hard. This function tries to mitigate this
2068 * problem, but the solution is to change Elementary to use
2069 * proper inheritance.
2071 * @param obj the object to query.
2072 * @return Elementary widget name, or @c NULL if not a valid widget.
2073 * @ingroup WidgetNavigation
2075 EAPI const char *elm_object_widget_type_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2078 * @defgroup Config Elementary Config
2080 * Elementary configuration is formed by a set options bounded to a
2081 * given @ref Profile profile, like @ref Theme theme, @ref Fingers
2082 * "finger size", etc. These are functions with which one syncronizes
2083 * changes made to those values to the configuration storing files, de
2084 * facto. You most probably don't want to use the functions in this
2085 * group unlees you're writing an elementary configuration manager.
2091 * Save back Elementary's configuration, so that it will persist on
2094 * @return @c EINA_TRUE, when sucessful. @c EINA_FALSE, otherwise.
2097 * This function will take effect -- thus, do I/O -- immediately. Use
2098 * it when you want to apply all configuration changes at once. The
2099 * current configuration set will get saved onto the current profile
2100 * configuration file.
2103 EAPI Eina_Bool elm_config_save(void);
2106 * Reload Elementary's configuration, bounded to current selected
2109 * @return @c EINA_TRUE, when sucessful. @c EINA_FALSE, otherwise.
2112 * Useful when you want to force reloading of configuration values for
2113 * a profile. If one removes user custom configuration directories,
2114 * for example, it will force a reload with system values instead.
2117 EAPI void elm_config_reload(void);
2124 * @defgroup Profile Elementary Profile
2126 * Profiles are pre-set options that affect the whole look-and-feel of
2127 * Elementary-based applications. There are, for example, profiles
2128 * aimed at desktop computer applications and others aimed at mobile,
2129 * touchscreen-based ones. You most probably don't want to use the
2130 * functions in this group unlees you're writing an elementary
2131 * configuration manager.
2137 * Get Elementary's profile in use.
2139 * This gets the global profile that is applied to all Elementary
2142 * @return The profile's name
2145 EAPI const char *elm_profile_current_get(void);
2148 * Get an Elementary's profile directory path in the filesystem. One
2149 * may want to fetch a system profile's dir or an user one (fetched
2152 * @param profile The profile's name
2153 * @param is_user Whether to lookup for an user profile (@c EINA_TRUE)
2154 * or a system one (@c EINA_FALSE)
2155 * @return The profile's directory path.
2158 * @note You must free it with elm_profile_dir_free().
2160 EAPI const char *elm_profile_dir_get(const char *profile, Eina_Bool is_user);
2163 * Free an Elementary's profile directory path, as returned by
2164 * elm_profile_dir_get().
2166 * @param p_dir The profile's path
2170 EAPI void elm_profile_dir_free(const char *p_dir);
2173 * Get Elementary's list of available profiles.
2175 * @return The profiles list. List node data are the profile name
2179 * @note One must free this list, after usage, with the function
2180 * elm_profile_list_free().
2182 EAPI Eina_List *elm_profile_list_get(void);
2185 * Free Elementary's list of available profiles.
2187 * @param l The profiles list, as returned by elm_profile_list_get().
2191 EAPI void elm_profile_list_free(Eina_List *l);
2194 * Set Elementary's profile.
2196 * This sets the global profile that is applied to Elementary
2197 * applications. Just the process the call comes from will be
2200 * @param profile The profile's name
2204 EAPI void elm_profile_set(const char *profile);
2207 * Set Elementary's profile.
2209 * This sets the global profile that is applied to all Elementary
2210 * applications. All running Elementary windows will be affected.
2212 * @param profile The profile's name
2216 EAPI void elm_profile_all_set(const char *profile);
2223 * @defgroup Engine Elementary Engine
2225 * These are functions setting and querying which rendering engine
2226 * Elementary will use for drawing its windows' pixels.
2228 * The following are the available engines:
2229 * @li "software_x11"
2232 * @li "software_16_x11"
2233 * @li "software_8_x11"
2236 * @li "software_gdi"
2237 * @li "software_16_wince_gdi"
2239 * @li "software_16_sdl"
2243 * @li "opengl_cocoa"
2250 * @brief Get Elementary's rendering engine in use.
2252 * @return The rendering engine's name
2253 * @note there's no need to free the returned string, here.
2255 * This gets the global rendering engine that is applied to all Elementary
2258 * @see elm_engine_set()
2260 EAPI const char *elm_engine_current_get(void);
2263 * @brief Set Elementary's rendering engine for use.
2265 * @param engine The rendering engine's name
2267 * This sets global rendering engine that is applied to all Elementary
2268 * applications. Note that it will take effect only to Elementary windows
2269 * created after this is called.
2271 * @see elm_win_add()
2273 EAPI void elm_engine_set(const char *engine);
2280 * @defgroup Fonts Elementary Fonts
2282 * These are functions dealing with font rendering, selection and the
2283 * like for Elementary applications. One might fetch which system
2284 * fonts are there to use and set custom fonts for individual classes
2285 * of UI items containing text (text classes).
2290 typedef struct _Elm_Text_Class
2296 typedef struct _Elm_Font_Overlay
2298 const char *text_class;
2300 Evas_Font_Size size;
2303 typedef struct _Elm_Font_Properties
2307 } Elm_Font_Properties;
2310 * Get Elementary's list of supported text classes.
2312 * @return The text classes list, with @c Elm_Text_Class blobs as data.
2315 * Release the list with elm_text_classes_list_free().
2317 EAPI const Eina_List *elm_text_classes_list_get(void);
2320 * Free Elementary's list of supported text classes.
2324 * @see elm_text_classes_list_get().
2326 EAPI void elm_text_classes_list_free(const Eina_List *list);
2329 * Get Elementary's list of font overlays, set with
2330 * elm_font_overlay_set().
2332 * @return The font overlays list, with @c Elm_Font_Overlay blobs as
2337 * For each text class, one can set a <b>font overlay</b> for it,
2338 * overriding the default font properties for that class coming from
2339 * the theme in use. There is no need to free this list.
2341 * @see elm_font_overlay_set() and elm_font_overlay_unset().
2343 EAPI const Eina_List *elm_font_overlay_list_get(void);
2346 * Set a font overlay for a given Elementary text class.
2348 * @param text_class Text class name
2349 * @param font Font name and style string
2350 * @param size Font size
2354 * @p font has to be in the format returned by
2355 * elm_font_fontconfig_name_get(). @see elm_font_overlay_list_get()
2356 * and elm_font_overlay_unset().
2358 EAPI void elm_font_overlay_set(const char *text_class, const char *font, Evas_Font_Size size);
2361 * Unset a font overlay for a given Elementary text class.
2363 * @param text_class Text class name
2367 * This will bring back text elements belonging to text class
2368 * @p text_class back to their default font settings.
2370 EAPI void elm_font_overlay_unset(const char *text_class);
2373 * Apply the changes made with elm_font_overlay_set() and
2374 * elm_font_overlay_unset() on the current Elementary window.
2378 * This applies all font overlays set to all objects in the UI.
2380 EAPI void elm_font_overlay_apply(void);
2383 * Apply the changes made with elm_font_overlay_set() and
2384 * elm_font_overlay_unset() on all Elementary application windows.
2388 * This applies all font overlays set to all objects in the UI.
2390 EAPI void elm_font_overlay_all_apply(void);
2393 * Translate a font (family) name string in fontconfig's font names
2394 * syntax into an @c Elm_Font_Properties struct.
2396 * @param font The font name and styles string
2397 * @return the font properties struct
2401 * @note The reverse translation can be achived with
2402 * elm_font_fontconfig_name_get(), for one style only (single font
2403 * instance, not family).
2405 EAPI Elm_Font_Properties *elm_font_properties_get(const char *font) EINA_ARG_NONNULL(1);
2408 * Free font properties return by elm_font_properties_get().
2410 * @param efp the font properties struct
2414 EAPI void elm_font_properties_free(Elm_Font_Properties *efp) EINA_ARG_NONNULL(1);
2417 * Translate a font name, bound to a style, into fontconfig's font names
2420 * @param name The font (family) name
2421 * @param style The given style (may be @c NULL)
2423 * @return the font name and style string
2427 * @note The reverse translation can be achived with
2428 * elm_font_properties_get(), for one style only (single font
2429 * instance, not family).
2431 EAPI const char *elm_font_fontconfig_name_get(const char *name, const char *style) EINA_ARG_NONNULL(1);
2434 * Free the font string return by elm_font_fontconfig_name_get().
2436 * @param efp the font properties struct
2440 EAPI void elm_font_fontconfig_name_free(const char *name) EINA_ARG_NONNULL(1);
2443 * Create a font hash table of available system fonts.
2445 * One must call it with @p list being the return value of
2446 * evas_font_available_list(). The hash will be indexed by font
2447 * (family) names, being its values @c Elm_Font_Properties blobs.
2449 * @param list The list of available system fonts, as returned by
2450 * evas_font_available_list().
2451 * @return the font hash.
2455 * @note The user is supposed to get it populated at least with 3
2456 * default font families (Sans, Serif, Monospace), which should be
2457 * present on most systems.
2459 EAPI Eina_Hash *elm_font_available_hash_add(Eina_List *list);
2462 * Free the hash return by elm_font_available_hash_add().
2464 * @param hash the hash to be freed.
2468 EAPI void elm_font_available_hash_del(Eina_Hash *hash);
2475 * @defgroup Fingers Fingers
2477 * Elementary is designed to be finger-friendly for touchscreens,
2478 * and so in addition to scaling for display resolution, it can
2479 * also scale based on finger "resolution" (or size). You can then
2480 * customize the granularity of the areas meant to receive clicks
2483 * Different profiles may have pre-set values for finger sizes.
2485 * @ref general_functions_example_page "This" example contemplates
2486 * some of these functions.
2492 * Get the configured "finger size"
2494 * @return The finger size
2496 * This gets the globally configured finger size, <b>in pixels</b>
2500 EAPI Evas_Coord elm_finger_size_get(void);
2503 * Set the configured finger size
2505 * This sets the globally configured finger size in pixels
2507 * @param size The finger size
2510 EAPI void elm_finger_size_set(Evas_Coord size);
2513 * Set the configured finger size for all applications on the display
2515 * This sets the globally configured finger size in pixels for all
2516 * applications on the display
2518 * @param size The finger size
2521 EAPI void elm_finger_size_all_set(Evas_Coord size);
2528 * @defgroup Focus Focus
2530 * An Elementary application has, at all times, one (and only one)
2531 * @b focused object. This is what determines where the input
2532 * events go to within the application's window. Also, focused
2533 * objects can be decorated differently, in order to signal to the
2534 * user where the input is, at a given moment.
2536 * Elementary applications also have the concept of <b>focus
2537 * chain</b>: one can cycle through all the windows' focusable
2538 * objects by input (tab key) or programmatically. The default
2539 * focus chain for an application is the one define by the order in
2540 * which the widgets where added in code. One will cycle through
2541 * top level widgets, and, for each one containg sub-objects, cycle
2542 * through them all, before returning to the level
2543 * above. Elementary also allows one to set @b custom focus chains
2544 * for their applications.
2546 * Besides the focused decoration a widget may exhibit, when it
2547 * gets focus, Elementary has a @b global focus highlight object
2548 * that can be enabled for a window. If one chooses to do so, this
2549 * extra highlight effect will surround the current focused object,
2552 * @note Some Elementary widgets are @b unfocusable, after
2553 * creation, by their very nature: they are not meant to be
2554 * interacted with input events, but are there just for visual
2557 * @ref general_functions_example_page "This" example contemplates
2558 * some of these functions.
2562 * Get the enable status of the focus highlight
2564 * This gets whether the highlight on focused objects is enabled or not
2567 EAPI Eina_Bool elm_focus_highlight_enabled_get(void);
2570 * Set the enable status of the focus highlight
2572 * Set whether to show or not the highlight on focused objects
2573 * @param enable Enable highlight if EINA_TRUE, disable otherwise
2576 EAPI void elm_focus_highlight_enabled_set(Eina_Bool enable);
2579 * Get the enable status of the highlight animation
2581 * Get whether the focus highlight, if enabled, will animate its switch from
2582 * one object to the next
2585 EAPI Eina_Bool elm_focus_highlight_animate_get(void);
2588 * Set the enable status of the highlight animation
2590 * Set whether the focus highlight, if enabled, will animate its switch from
2591 * one object to the next
2592 * @param animate Enable animation if EINA_TRUE, disable otherwise
2595 EAPI void elm_focus_highlight_animate_set(Eina_Bool animate);
2598 * Get the whether an Elementary object has the focus or not.
2600 * @param obj The Elementary object to get the information from
2601 * @return @c EINA_TRUE, if the object is focused, @c EINA_FALSE if
2602 * not (and on errors).
2604 * @see elm_object_focus_set()
2608 EAPI Eina_Bool elm_object_focus_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2611 * Set/unset focus to a given Elementary object.
2613 * @param obj The Elementary object to operate on.
2614 * @param enable @c EINA_TRUE Set focus to a given object,
2615 * @c EINA_FALSE Unset focus to a given object.
2617 * @note When you set focus to this object, if it can handle focus, will
2618 * take the focus away from the one who had it previously and will, for
2619 * now on, be the one receiving input events. Unsetting focus will remove
2620 * the focus from @p obj, passing it back to the previous element in the
2623 * @see elm_object_focus_get(), elm_object_focus_custom_chain_get()
2627 EAPI void elm_object_focus_set(Evas_Object *obj, Eina_Bool focus) EINA_ARG_NONNULL(1);
2630 * Make a given Elementary object the focused one.
2632 * @param obj The Elementary object to make focused.
2634 * @note This object, if it can handle focus, will take the focus
2635 * away from the one who had it previously and will, for now on, be
2636 * the one receiving input events.
2638 * @see elm_object_focus_get()
2639 * @deprecated use elm_object_focus_set() instead.
2643 EINA_DEPRECATED EAPI void elm_object_focus(Evas_Object *obj) EINA_ARG_NONNULL(1);
2646 * Remove the focus from an Elementary object
2648 * @param obj The Elementary to take focus from
2650 * This removes the focus from @p obj, passing it back to the
2651 * previous element in the focus chain list.
2653 * @see elm_object_focus() and elm_object_focus_custom_chain_get()
2654 * @deprecated use elm_object_focus_set() instead.
2658 EINA_DEPRECATED EAPI void elm_object_unfocus(Evas_Object *obj) EINA_ARG_NONNULL(1);
2661 * Set the ability for an Element object to be focused
2663 * @param obj The Elementary object to operate on
2664 * @param enable @c EINA_TRUE if the object can be focused, @c
2665 * EINA_FALSE if not (and on errors)
2667 * This sets whether the object @p obj is able to take focus or
2668 * not. Unfocusable objects do nothing when programmatically
2669 * focused, being the nearest focusable parent object the one
2670 * really getting focus. Also, when they receive mouse input, they
2671 * will get the event, but not take away the focus from where it
2676 EAPI void elm_object_focus_allow_set(Evas_Object *obj, Eina_Bool enable) EINA_ARG_NONNULL(1);
2679 * Get whether an Elementary object is focusable or not
2681 * @param obj The Elementary object to operate on
2682 * @return @c EINA_TRUE if the object is allowed to be focused, @c
2683 * EINA_FALSE if not (and on errors)
2685 * @note Objects which are meant to be interacted with by input
2686 * events are created able to be focused, by default. All the
2691 EAPI Eina_Bool elm_object_focus_allow_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2694 * Set custom focus chain.
2696 * This function overwrites any previous custom focus chain within
2697 * the list of objects. The previous list will be deleted and this list
2698 * will be managed by elementary. After it is set, don't modify it.
2700 * @note On focus cycle, only will be evaluated children of this container.
2702 * @param obj The container object
2703 * @param objs Chain of objects to pass focus
2706 EAPI void elm_object_focus_custom_chain_set(Evas_Object *obj, Eina_List *objs) EINA_ARG_NONNULL(1);
2709 * Unset a custom focus chain on a given Elementary widget
2711 * @param obj The container object to remove focus chain from
2713 * Any focus chain previously set on @p obj (for its child objects)
2714 * is removed entirely after this call.
2718 EAPI void elm_object_focus_custom_chain_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
2721 * Get custom focus chain
2723 * @param obj The container object
2726 EAPI const Eina_List *elm_object_focus_custom_chain_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2729 * Append object to custom focus chain.
2731 * @note If relative_child equal to NULL or not in custom chain, the object
2732 * will be added in end.
2734 * @note On focus cycle, only will be evaluated children of this container.
2736 * @param obj The container object
2737 * @param child The child to be added in custom chain
2738 * @param relative_child The relative object to position the child
2741 EAPI void elm_object_focus_custom_chain_append(Evas_Object *obj, Evas_Object *child, Evas_Object *relative_child) EINA_ARG_NONNULL(1, 2);
2744 * Prepend object to custom focus chain.
2746 * @note If relative_child equal to NULL or not in custom chain, the object
2747 * will be added in begin.
2749 * @note On focus cycle, only will be evaluated children of this container.
2751 * @param obj The container object
2752 * @param child The child to be added in custom chain
2753 * @param relative_child The relative object to position the child
2756 EAPI void elm_object_focus_custom_chain_prepend(Evas_Object *obj, Evas_Object *child, Evas_Object *relative_child) EINA_ARG_NONNULL(1, 2);
2759 * Give focus to next object in object tree.
2761 * Give focus to next object in focus chain of one object sub-tree.
2762 * If the last object of chain already have focus, the focus will go to the
2763 * first object of chain.
2765 * @param obj The object root of sub-tree
2766 * @param dir Direction to cycle the focus
2770 EAPI void elm_object_focus_cycle(Evas_Object *obj, Elm_Focus_Direction dir) EINA_ARG_NONNULL(1);
2773 * Give focus to near object in one direction.
2775 * Give focus to near object in direction of one object.
2776 * If none focusable object in given direction, the focus will not change.
2778 * @param obj The reference object
2779 * @param x Horizontal component of direction to focus
2780 * @param y Vertical component of direction to focus
2784 EAPI void elm_object_focus_direction_go(Evas_Object *obj, int x, int y) EINA_ARG_NONNULL(1);
2787 * Make the elementary object and its children to be unfocusable
2790 * @param obj The Elementary object to operate on
2791 * @param tree_unfocusable @c EINA_TRUE for unfocusable,
2792 * @c EINA_FALSE for focusable.
2794 * This sets whether the object @p obj and its children objects
2795 * are able to take focus or not. If the tree is set as unfocusable,
2796 * newest focused object which is not in this tree will get focus.
2797 * This API can be helpful for an object to be deleted.
2798 * When an object will be deleted soon, it and its children may not
2799 * want to get focus (by focus reverting or by other focus controls).
2800 * Then, just use this API before deleting.
2802 * @see elm_object_tree_unfocusable_get()
2806 EAPI void elm_object_tree_unfocusable_set(Evas_Object *obj, Eina_Bool tree_unfocusable) EINA_ARG_NONNULL(1);
2809 * Get whether an Elementary object and its children are unfocusable or not.
2811 * @param obj The Elementary object to get the information from
2812 * @return @c EINA_TRUE, if the tree is unfocussable,
2813 * @c EINA_FALSE if not (and on errors).
2815 * @see elm_object_tree_unfocusable_set()
2819 EAPI Eina_Bool elm_object_tree_unfocusable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2822 * @defgroup Scrolling Scrolling
2824 * These are functions setting how scrollable views in Elementary
2825 * widgets should behave on user interaction.
2831 * Get whether scrollers should bounce when they reach their
2832 * viewport's edge during a scroll.
2834 * @return the thumb scroll bouncing state
2836 * This is the default behavior for touch screens, in general.
2837 * @ingroup Scrolling
2839 EAPI Eina_Bool elm_scroll_bounce_enabled_get(void);
2842 * Set whether scrollers should bounce when they reach their
2843 * viewport's edge during a scroll.
2845 * @param enabled the thumb scroll bouncing state
2847 * @see elm_thumbscroll_bounce_enabled_get()
2848 * @ingroup Scrolling
2850 EAPI void elm_scroll_bounce_enabled_set(Eina_Bool enabled);
2853 * Set whether scrollers should bounce when they reach their
2854 * viewport's edge during a scroll, for all Elementary application
2857 * @param enabled the thumb scroll bouncing state
2859 * @see elm_thumbscroll_bounce_enabled_get()
2860 * @ingroup Scrolling
2862 EAPI void elm_scroll_bounce_enabled_all_set(Eina_Bool enabled);
2865 * Get the amount of inertia a scroller will impose at bounce
2868 * @return the thumb scroll bounce friction
2870 * @ingroup Scrolling
2872 EAPI double elm_scroll_bounce_friction_get(void);
2875 * Set the amount of inertia a scroller will impose at bounce
2878 * @param friction the thumb scroll bounce friction
2880 * @see elm_thumbscroll_bounce_friction_get()
2881 * @ingroup Scrolling
2883 EAPI void elm_scroll_bounce_friction_set(double friction);
2886 * Set the amount of inertia a scroller will impose at bounce
2887 * animations, for all Elementary application windows.
2889 * @param friction the thumb scroll bounce friction
2891 * @see elm_thumbscroll_bounce_friction_get()
2892 * @ingroup Scrolling
2894 EAPI void elm_scroll_bounce_friction_all_set(double friction);
2897 * Get the amount of inertia a <b>paged</b> scroller will impose at
2898 * page fitting animations.
2900 * @return the page scroll friction
2902 * @ingroup Scrolling
2904 EAPI double elm_scroll_page_scroll_friction_get(void);
2907 * Set the amount of inertia a <b>paged</b> scroller will impose at
2908 * page fitting animations.
2910 * @param friction the page scroll friction
2912 * @see elm_thumbscroll_page_scroll_friction_get()
2913 * @ingroup Scrolling
2915 EAPI void elm_scroll_page_scroll_friction_set(double friction);
2918 * Set the amount of inertia a <b>paged</b> scroller will impose at
2919 * page fitting animations, for all Elementary application windows.
2921 * @param friction the page scroll friction
2923 * @see elm_thumbscroll_page_scroll_friction_get()
2924 * @ingroup Scrolling
2926 EAPI void elm_scroll_page_scroll_friction_all_set(double friction);
2929 * Get the amount of inertia a scroller will impose at region bring
2932 * @return the bring in scroll friction
2934 * @ingroup Scrolling
2936 EAPI double elm_scroll_bring_in_scroll_friction_get(void);
2939 * Set the amount of inertia a scroller will impose at region bring
2942 * @param friction the bring in scroll friction
2944 * @see elm_thumbscroll_bring_in_scroll_friction_get()
2945 * @ingroup Scrolling
2947 EAPI void elm_scroll_bring_in_scroll_friction_set(double friction);
2950 * Set the amount of inertia a scroller will impose at region bring
2951 * animations, for all Elementary application windows.
2953 * @param friction the bring in scroll friction
2955 * @see elm_thumbscroll_bring_in_scroll_friction_get()
2956 * @ingroup Scrolling
2958 EAPI void elm_scroll_bring_in_scroll_friction_all_set(double friction);
2961 * Get the amount of inertia scrollers will impose at animations
2962 * triggered by Elementary widgets' zooming API.
2964 * @return the zoom friction
2966 * @ingroup Scrolling
2968 EAPI double elm_scroll_zoom_friction_get(void);
2971 * Set the amount of inertia scrollers will impose at animations
2972 * triggered by Elementary widgets' zooming API.
2974 * @param friction the zoom friction
2976 * @see elm_thumbscroll_zoom_friction_get()
2977 * @ingroup Scrolling
2979 EAPI void elm_scroll_zoom_friction_set(double friction);
2982 * Set the amount of inertia scrollers will impose at animations
2983 * triggered by Elementary widgets' zooming API, for all Elementary
2984 * application windows.
2986 * @param friction the zoom friction
2988 * @see elm_thumbscroll_zoom_friction_get()
2989 * @ingroup Scrolling
2991 EAPI void elm_scroll_zoom_friction_all_set(double friction);
2994 * Get whether scrollers should be draggable from any point in their
2997 * @return the thumb scroll state
2999 * @note This is the default behavior for touch screens, in general.
3000 * @note All other functions namespaced with "thumbscroll" will only
3001 * have effect if this mode is enabled.
3003 * @ingroup Scrolling
3005 EAPI Eina_Bool elm_scroll_thumbscroll_enabled_get(void);
3008 * Set whether scrollers should be draggable from any point in their
3011 * @param enabled the thumb scroll state
3013 * @see elm_thumbscroll_enabled_get()
3014 * @ingroup Scrolling
3016 EAPI void elm_scroll_thumbscroll_enabled_set(Eina_Bool enabled);
3019 * Set whether scrollers should be draggable from any point in their
3020 * views, for all Elementary application windows.
3022 * @param enabled the thumb scroll state
3024 * @see elm_thumbscroll_enabled_get()
3025 * @ingroup Scrolling
3027 EAPI void elm_scroll_thumbscroll_enabled_all_set(Eina_Bool enabled);
3030 * Get the number of pixels one should travel while dragging a
3031 * scroller's view to actually trigger scrolling.
3033 * @return the thumb scroll threshould
3035 * One would use higher values for touch screens, in general, because
3036 * of their inherent imprecision.
3037 * @ingroup Scrolling
3039 EAPI unsigned int elm_scroll_thumbscroll_threshold_get(void);
3042 * Set the number of pixels one should travel while dragging a
3043 * scroller's view to actually trigger scrolling.
3045 * @param threshold the thumb scroll threshould
3047 * @see elm_thumbscroll_threshould_get()
3048 * @ingroup Scrolling
3050 EAPI void elm_scroll_thumbscroll_threshold_set(unsigned int threshold);
3053 * Set the number of pixels one should travel while dragging a
3054 * scroller's view to actually trigger scrolling, for all Elementary
3055 * application windows.
3057 * @param threshold the thumb scroll threshould
3059 * @see elm_thumbscroll_threshould_get()
3060 * @ingroup Scrolling
3062 EAPI void elm_scroll_thumbscroll_threshold_all_set(unsigned int threshold);
3065 * Get the minimum speed of mouse cursor movement which will trigger
3066 * list self scrolling animation after a mouse up event
3069 * @return the thumb scroll momentum threshould
3071 * @ingroup Scrolling
3073 EAPI double elm_scroll_thumbscroll_momentum_threshold_get(void);
3076 * Set the minimum speed of mouse cursor movement which will trigger
3077 * list self scrolling animation after a mouse up event
3080 * @param threshold the thumb scroll momentum threshould
3082 * @see elm_thumbscroll_momentum_threshould_get()
3083 * @ingroup Scrolling
3085 EAPI void elm_scroll_thumbscroll_momentum_threshold_set(double threshold);
3088 * Set the minimum speed of mouse cursor movement which will trigger
3089 * list self scrolling animation after a mouse up event
3090 * (pixels/second), for all Elementary application windows.
3092 * @param threshold the thumb scroll momentum threshould
3094 * @see elm_thumbscroll_momentum_threshould_get()
3095 * @ingroup Scrolling
3097 EAPI void elm_scroll_thumbscroll_momentum_threshold_all_set(double threshold);
3100 * Get the amount of inertia a scroller will impose at self scrolling
3103 * @return the thumb scroll friction
3105 * @ingroup Scrolling
3107 EAPI double elm_scroll_thumbscroll_friction_get(void);
3110 * Set the amount of inertia a scroller will impose at self scrolling
3113 * @param friction the thumb scroll friction
3115 * @see elm_thumbscroll_friction_get()
3116 * @ingroup Scrolling
3118 EAPI void elm_scroll_thumbscroll_friction_set(double friction);
3121 * Set the amount of inertia a scroller will impose at self scrolling
3122 * animations, for all Elementary application windows.
3124 * @param friction the thumb scroll friction
3126 * @see elm_thumbscroll_friction_get()
3127 * @ingroup Scrolling
3129 EAPI void elm_scroll_thumbscroll_friction_all_set(double friction);
3132 * Get the amount of lag between your actual mouse cursor dragging
3133 * movement and a scroller's view movement itself, while pushing it
3134 * into bounce state manually.
3136 * @return the thumb scroll border friction
3138 * @ingroup Scrolling
3140 EAPI double elm_scroll_thumbscroll_border_friction_get(void);
3143 * Set the amount of lag between your actual mouse cursor dragging
3144 * movement and a scroller's view movement itself, while pushing it
3145 * into bounce state manually.
3147 * @param friction the thumb scroll border friction. @c 0.0 for
3148 * perfect synchrony between two movements, @c 1.0 for maximum
3151 * @see elm_thumbscroll_border_friction_get()
3152 * @note parameter value will get bound to 0.0 - 1.0 interval, always
3154 * @ingroup Scrolling
3156 EAPI void elm_scroll_thumbscroll_border_friction_set(double friction);
3159 * Set the amount of lag between your actual mouse cursor dragging
3160 * movement and a scroller's view movement itself, while pushing it
3161 * into bounce state manually, for all Elementary application windows.
3163 * @param friction the thumb scroll border friction. @c 0.0 for
3164 * perfect synchrony between two movements, @c 1.0 for maximum
3167 * @see elm_thumbscroll_border_friction_get()
3168 * @note parameter value will get bound to 0.0 - 1.0 interval, always
3170 * @ingroup Scrolling
3172 EAPI void elm_scroll_thumbscroll_border_friction_all_set(double friction);
3175 * Get the sensitivity amount which is be multiplied by the length of
3178 * @return the thumb scroll sensitivity friction
3180 * @ingroup Scrolling
3182 EAPI double elm_scroll_thumbscroll_sensitivity_friction_get(void);
3185 * Set the sensitivity amount which is be multiplied by the length of
3188 * @param friction the thumb scroll sensitivity friction. @c 0.1 for
3189 * minimun sensitivity, @c 1.0 for maximum sensitivity. 0.25
3192 * @see elm_thumbscroll_sensitivity_friction_get()
3193 * @note parameter value will get bound to 0.1 - 1.0 interval, always
3195 * @ingroup Scrolling
3197 EAPI void elm_scroll_thumbscroll_sensitivity_friction_set(double friction);
3200 * Set the sensitivity amount which is be multiplied by the length of
3201 * mouse dragging, for all Elementary application windows.
3203 * @param friction the thumb scroll sensitivity friction. @c 0.1 for
3204 * minimun sensitivity, @c 1.0 for maximum sensitivity. 0.25
3207 * @see elm_thumbscroll_sensitivity_friction_get()
3208 * @note parameter value will get bound to 0.1 - 1.0 interval, always
3210 * @ingroup Scrolling
3212 EAPI void elm_scroll_thumbscroll_sensitivity_friction_all_set(double friction);
3219 * @defgroup Scrollhints Scrollhints
3221 * Objects when inside a scroller can scroll, but this may not always be
3222 * desirable in certain situations. This allows an object to hint to itself
3223 * and parents to "not scroll" in one of 2 ways. If any child object of a
3224 * scroller has pushed a scroll freeze or hold then it affects all parent
3225 * scrollers until all children have released them.
3227 * 1. To hold on scrolling. This means just flicking and dragging may no
3228 * longer scroll, but pressing/dragging near an edge of the scroller will
3229 * still scroll. This is automatically used by the entry object when
3232 * 2. To totally freeze scrolling. This means it stops. until
3239 * Push the scroll hold by 1
3241 * This increments the scroll hold count by one. If it is more than 0 it will
3242 * take effect on the parents of the indicated object.
3244 * @param obj The object
3245 * @ingroup Scrollhints
3247 EAPI void elm_object_scroll_hold_push(Evas_Object *obj) EINA_ARG_NONNULL(1);
3250 * Pop the scroll hold by 1
3252 * This decrements the scroll hold count by one. If it is more than 0 it will
3253 * take effect on the parents of the indicated object.
3255 * @param obj The object
3256 * @ingroup Scrollhints
3258 EAPI void elm_object_scroll_hold_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
3261 * Push the scroll freeze by 1
3263 * This increments the scroll freeze count by one. If it is more
3264 * than 0 it will take effect on the parents of the indicated
3267 * @param obj The object
3268 * @ingroup Scrollhints
3270 EAPI void elm_object_scroll_freeze_push(Evas_Object *obj) EINA_ARG_NONNULL(1);
3273 * Pop the scroll freeze by 1
3275 * This decrements the scroll freeze count by one. If it is more
3276 * than 0 it will take effect on the parents of the indicated
3279 * @param obj The object
3280 * @ingroup Scrollhints
3282 EAPI void elm_object_scroll_freeze_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
3285 * Lock the scrolling of the given widget (and thus all parents)
3287 * This locks the given object from scrolling in the X axis (and implicitly
3288 * also locks all parent scrollers too from doing the same).
3290 * @param obj The object
3291 * @param lock The lock state (1 == locked, 0 == unlocked)
3292 * @ingroup Scrollhints
3294 EAPI void elm_object_scroll_lock_x_set(Evas_Object *obj, Eina_Bool lock) EINA_ARG_NONNULL(1);
3297 * Lock the scrolling of the given widget (and thus all parents)
3299 * This locks the given object from scrolling in the Y axis (and implicitly
3300 * also locks all parent scrollers too from doing the same).
3302 * @param obj The object
3303 * @param lock The lock state (1 == locked, 0 == unlocked)
3304 * @ingroup Scrollhints
3306 EAPI void elm_object_scroll_lock_y_set(Evas_Object *obj, Eina_Bool lock) EINA_ARG_NONNULL(1);
3309 * Get the scrolling lock of the given widget
3311 * This gets the lock for X axis scrolling.
3313 * @param obj The object
3314 * @ingroup Scrollhints
3316 EAPI Eina_Bool elm_object_scroll_lock_x_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3319 * Get the scrolling lock of the given widget
3321 * This gets the lock for X axis scrolling.
3323 * @param obj The object
3324 * @ingroup Scrollhints
3326 EAPI Eina_Bool elm_object_scroll_lock_y_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3333 * Send a signal to the widget edje object.
3335 * This function sends a signal to the edje object of the obj. An
3336 * edje program can respond to a signal by specifying matching
3337 * 'signal' and 'source' fields.
3339 * @param obj The object
3340 * @param emission The signal's name.
3341 * @param source The signal's source.
3344 EAPI void elm_object_signal_emit(Evas_Object *obj, const char *emission, const char *source) EINA_ARG_NONNULL(1);
3347 * Add a callback for a signal emitted by widget edje object.
3349 * This function connects a callback function to a signal emitted by the
3350 * edje object of the obj.
3351 * Globs can occur in either the emission or source name.
3353 * @param obj The object
3354 * @param emission The signal's name.
3355 * @param source The signal's source.
3356 * @param func The callback function to be executed when the signal is
3358 * @param data A pointer to data to pass in to the callback function.
3361 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);
3364 * Remove a signal-triggered callback from a widget edje object.
3366 * This function removes a callback, previoulsy attached to a
3367 * signal emitted by the edje object of the obj. The parameters
3368 * emission, source and func must match exactly those passed to a
3369 * previous call to elm_object_signal_callback_add(). The data
3370 * pointer that was passed to this call will be returned.
3372 * @param obj The object
3373 * @param emission The signal's name.
3374 * @param source The signal's source.
3375 * @param func The callback function to be executed when the signal is
3377 * @return The data pointer
3380 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);
3383 * Add a callback for input events (key up, key down, mouse wheel)
3384 * on a given Elementary widget
3386 * @param obj The widget to add an event callback on
3387 * @param func The callback function to be executed when the event
3389 * @param data Data to pass in to @p func
3391 * Every widget in an Elementary interface set to receive focus,
3392 * with elm_object_focus_allow_set(), will propagate @b all of its
3393 * key up, key down and mouse wheel input events up to its parent
3394 * object, and so on. All of the focusable ones in this chain which
3395 * had an event callback set, with this call, will be able to treat
3396 * those events. There are two ways of making the propagation of
3397 * these event upwards in the tree of widgets to @b cease:
3398 * - Just return @c EINA_TRUE on @p func. @c EINA_FALSE will mean
3399 * the event was @b not processed, so the propagation will go on.
3400 * - The @c event_info pointer passed to @p func will contain the
3401 * event's structure and, if you OR its @c event_flags inner
3402 * value to @c EVAS_EVENT_FLAG_ON_HOLD, you're telling Elementary
3403 * one has already handled it, thus killing the event's
3406 * @note Your event callback will be issued on those events taking
3407 * place only if no other child widget of @obj has consumed the
3410 * @note Not to be confused with @c
3411 * evas_object_event_callback_add(), which will add event callbacks
3412 * per type on general Evas objects (no event propagation
3413 * infrastructure taken in account).
3415 * @note Not to be confused with @c
3416 * elm_object_signal_callback_add(), which will add callbacks to @b
3417 * signals coming from a widget's theme, not input events.
3419 * @note Not to be confused with @c
3420 * edje_object_signal_callback_add(), which does the same as
3421 * elm_object_signal_callback_add(), but directly on an Edje
3424 * @note Not to be confused with @c
3425 * evas_object_smart_callback_add(), which adds callbacks to smart
3426 * objects' <b>smart events</b>, and not input events.
3428 * @see elm_object_event_callback_del()
3432 EAPI void elm_object_event_callback_add(Evas_Object *obj, Elm_Event_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
3435 * Remove an event callback from a widget.
3437 * This function removes a callback, previoulsy attached to event emission
3439 * The parameters func and data must match exactly those passed to
3440 * a previous call to elm_object_event_callback_add(). The data pointer that
3441 * was passed to this call will be returned.
3443 * @param obj The object
3444 * @param func The callback function to be executed when the event is
3446 * @param data Data to pass in to the callback function.
3447 * @return The data pointer
3450 EAPI void *elm_object_event_callback_del(Evas_Object *obj, Elm_Event_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
3453 * Adjust size of an element for finger usage.
3455 * @param times_w How many fingers should fit horizontally
3456 * @param w Pointer to the width size to adjust
3457 * @param times_h How many fingers should fit vertically
3458 * @param h Pointer to the height size to adjust
3460 * This takes width and height sizes (in pixels) as input and a
3461 * size multiple (which is how many fingers you want to place
3462 * within the area, being "finger" the size set by
3463 * elm_finger_size_set()), and adjusts the size to be large enough
3464 * to accommodate the resulting size -- if it doesn't already
3465 * accommodate it. On return the @p w and @p h sizes pointed to by
3466 * these parameters will be modified, on those conditions.
3468 * @note This is kind of a low level Elementary call, most useful
3469 * on size evaluation times for widgets. An external user wouldn't
3470 * be calling, most of the time.
3474 EAPI void elm_coords_finger_size_adjust(int times_w, Evas_Coord *w, int times_h, Evas_Coord *h);
3477 * Get the duration for occuring long press event.
3479 * @return Timeout for long press event
3480 * @ingroup Longpress
3482 EAPI double elm_longpress_timeout_get(void);
3485 * Set the duration for occuring long press event.
3487 * @param lonpress_timeout Timeout for long press event
3488 * @ingroup Longpress
3490 EAPI void elm_longpress_timeout_set(double longpress_timeout);
3493 * @defgroup Debug Debug
3494 * don't use it unless you are sure
3500 * Print Tree object hierarchy in stdout
3502 * @param obj The root object
3505 EAPI void elm_object_tree_dump(const Evas_Object *top);
3508 * Print Elm Objects tree hierarchy in file as dot(graphviz) syntax.
3510 * @param obj The root object
3511 * @param file The path of output file
3514 EAPI void elm_object_tree_dot_dump(const Evas_Object *top, const char *file);
3521 * @defgroup Theme Theme
3523 * Elementary uses Edje to theme its widgets, naturally. But for the most
3524 * part this is hidden behind a simpler interface that lets the user set
3525 * extensions and choose the style of widgets in a much easier way.
3527 * Instead of thinking in terms of paths to Edje files and their groups
3528 * each time you want to change the appearance of a widget, Elementary
3529 * works so you can add any theme file with extensions or replace the
3530 * main theme at one point in the application, and then just set the style
3531 * of widgets with elm_object_style_set() and related functions. Elementary
3532 * will then look in its list of themes for a matching group and apply it,
3533 * and when the theme changes midway through the application, all widgets
3534 * will be updated accordingly.
3536 * There are three concepts you need to know to understand how Elementary
3537 * theming works: default theme, extensions and overlays.
3539 * Default theme, obviously enough, is the one that provides the default
3540 * look of all widgets. End users can change the theme used by Elementary
3541 * by setting the @c ELM_THEME environment variable before running an
3542 * application, or globally for all programs using the @c elementary_config
3543 * utility. Applications can change the default theme using elm_theme_set(),
3544 * but this can go against the user wishes, so it's not an adviced practice.
3546 * Ideally, applications should find everything they need in the already
3547 * provided theme, but there may be occasions when that's not enough and
3548 * custom styles are required to correctly express the idea. For this
3549 * cases, Elementary has extensions.
3551 * Extensions allow the application developer to write styles of its own
3552 * to apply to some widgets. This requires knowledge of how each widget
3553 * is themed, as extensions will always replace the entire group used by
3554 * the widget, so important signals and parts need to be there for the
3555 * object to behave properly (see documentation of Edje for details).
3556 * Once the theme for the extension is done, the application needs to add
3557 * it to the list of themes Elementary will look into, using
3558 * elm_theme_extension_add(), and set the style of the desired widgets as
3559 * he would normally with elm_object_style_set().
3561 * Overlays, on the other hand, can replace the look of all widgets by
3562 * overriding the default style. Like extensions, it's up to the application
3563 * developer to write the theme for the widgets it wants, the difference
3564 * being that when looking for the theme, Elementary will check first the
3565 * list of overlays, then the set theme and lastly the list of extensions,
3566 * so with overlays it's possible to replace the default view and every
3567 * widget will be affected. This is very much alike to setting the whole
3568 * theme for the application and will probably clash with the end user
3569 * options, not to mention the risk of ending up with not matching styles
3570 * across the program. Unless there's a very special reason to use them,
3571 * overlays should be avoided for the resons exposed before.
3573 * All these theme lists are handled by ::Elm_Theme instances. Elementary
3574 * keeps one default internally and every function that receives one of
3575 * these can be called with NULL to refer to this default (except for
3576 * elm_theme_free()). It's possible to create a new instance of a
3577 * ::Elm_Theme to set other theme for a specific widget (and all of its
3578 * children), but this is as discouraged, if not even more so, than using
3579 * overlays. Don't use this unless you really know what you are doing.
3581 * But to be less negative about things, you can look at the following
3583 * @li @ref theme_example_01 "Using extensions"
3584 * @li @ref theme_example_02 "Using overlays"
3589 * @typedef Elm_Theme
3591 * Opaque handler for the list of themes Elementary looks for when
3592 * rendering widgets.
3594 * Stay out of this unless you really know what you are doing. For most
3595 * cases, sticking to the default is all a developer needs.
3597 typedef struct _Elm_Theme Elm_Theme;
3600 * Create a new specific theme
3602 * This creates an empty specific theme that only uses the default theme. A
3603 * specific theme has its own private set of extensions and overlays too
3604 * (which are empty by default). Specific themes do not fall back to themes
3605 * of parent objects. They are not intended for this use. Use styles, overlays
3606 * and extensions when needed, but avoid specific themes unless there is no
3607 * other way (example: you want to have a preview of a new theme you are
3608 * selecting in a "theme selector" window. The preview is inside a scroller
3609 * and should display what the theme you selected will look like, but not
3610 * actually apply it yet. The child of the scroller will have a specific
3611 * theme set to show this preview before the user decides to apply it to all
3614 EAPI Elm_Theme *elm_theme_new(void);
3617 * Free a specific theme
3619 * @param th The theme to free
3621 * This frees a theme created with elm_theme_new().
3623 EAPI void elm_theme_free(Elm_Theme *th);
3626 * Copy the theme fom the source to the destination theme
3628 * @param th The source theme to copy from
3629 * @param thdst The destination theme to copy data to
3631 * This makes a one-time static copy of all the theme config, extensions
3632 * and overlays from @p th to @p thdst. If @p th references a theme, then
3633 * @p thdst is also set to reference it, with all the theme settings,
3634 * overlays and extensions that @p th had.
3636 EAPI void elm_theme_copy(Elm_Theme *th, Elm_Theme *thdst);
3639 * Tell the source theme to reference the ref theme
3641 * @param th The theme that will do the referencing
3642 * @param thref The theme that is the reference source
3644 * This clears @p th to be empty and then sets it to refer to @p thref
3645 * so @p th acts as an override to @p thref, but where its overrides
3646 * don't apply, it will fall through to @p thref for configuration.
3648 EAPI void elm_theme_ref_set(Elm_Theme *th, Elm_Theme *thref);
3651 * Return the theme referred to
3653 * @param th The theme to get the reference from
3654 * @return The referenced theme handle
3656 * This gets the theme set as the reference theme by elm_theme_ref_set().
3657 * If no theme is set as a reference, NULL is returned.
3659 EAPI Elm_Theme *elm_theme_ref_get(Elm_Theme *th);
3662 * Return the default theme
3664 * @return The default theme handle
3666 * This returns the internal default theme setup handle that all widgets
3667 * use implicitly unless a specific theme is set. This is also often use
3668 * as a shorthand of NULL.
3670 EAPI Elm_Theme *elm_theme_default_get(void);
3673 * Prepends a theme overlay to the list of overlays
3675 * @param th The theme to add to, or if NULL, the default theme
3676 * @param item The Edje file path to be used
3678 * Use this if your application needs to provide some custom overlay theme
3679 * (An Edje file that replaces some default styles of widgets) where adding
3680 * new styles, or changing system theme configuration is not possible. Do
3681 * NOT use this instead of a proper system theme configuration. Use proper
3682 * configuration files, profiles, environment variables etc. to set a theme
3683 * so that the theme can be altered by simple confiugration by a user. Using
3684 * this call to achieve that effect is abusing the API and will create lots
3687 * @see elm_theme_extension_add()
3689 EAPI void elm_theme_overlay_add(Elm_Theme *th, const char *item);
3692 * Delete a theme overlay from the list of overlays
3694 * @param th The theme to delete from, or if NULL, the default theme
3695 * @param item The name of the theme overlay
3697 * @see elm_theme_overlay_add()
3699 EAPI void elm_theme_overlay_del(Elm_Theme *th, const char *item);
3702 * Appends a theme extension to the list of extensions.
3704 * @param th The theme to add to, or if NULL, the default theme
3705 * @param item The Edje file path to be used
3707 * This is intended when an application needs more styles of widgets or new
3708 * widget themes that the default does not provide (or may not provide). The
3709 * application has "extended" usage by coming up with new custom style names
3710 * for widgets for specific uses, but as these are not "standard", they are
3711 * not guaranteed to be provided by a default theme. This means the
3712 * application is required to provide these extra elements itself in specific
3713 * Edje files. This call adds one of those Edje files to the theme search
3714 * path to be search after the default theme. The use of this call is
3715 * encouraged when default styles do not meet the needs of the application.
3716 * Use this call instead of elm_theme_overlay_add() for almost all cases.
3718 * @see elm_object_style_set()
3720 EAPI void elm_theme_extension_add(Elm_Theme *th, const char *item);
3723 * Deletes a theme extension from the list of extensions.
3725 * @param th The theme to delete from, or if NULL, the default theme
3726 * @param item The name of the theme extension
3728 * @see elm_theme_extension_add()
3730 EAPI void elm_theme_extension_del(Elm_Theme *th, const char *item);
3733 * Set the theme search order for the given theme
3735 * @param th The theme to set the search order, or if NULL, the default theme
3736 * @param theme Theme search string
3738 * This sets the search string for the theme in path-notation from first
3739 * theme to search, to last, delimited by the : character. Example:
3741 * "shiny:/path/to/file.edj:default"
3743 * See the ELM_THEME environment variable for more information.
3745 * @see elm_theme_get()
3746 * @see elm_theme_list_get()
3748 EAPI void elm_theme_set(Elm_Theme *th, const char *theme);
3751 * Return the theme search order
3753 * @param th The theme to get the search order, or if NULL, the default theme
3754 * @return The internal search order path
3756 * This function returns a colon separated string of theme elements as
3757 * returned by elm_theme_list_get().
3759 * @see elm_theme_set()
3760 * @see elm_theme_list_get()
3762 EAPI const char *elm_theme_get(Elm_Theme *th);
3765 * Return a list of theme elements to be used in a theme.
3767 * @param th Theme to get the list of theme elements from.
3768 * @return The internal list of theme elements
3770 * This returns the internal list of theme elements (will only be valid as
3771 * long as the theme is not modified by elm_theme_set() or theme is not
3772 * freed by elm_theme_free(). This is a list of strings which must not be
3773 * altered as they are also internal. If @p th is NULL, then the default
3774 * theme element list is returned.
3776 * A theme element can consist of a full or relative path to a .edj file,
3777 * or a name, without extension, for a theme to be searched in the known
3778 * theme paths for Elemementary.
3780 * @see elm_theme_set()
3781 * @see elm_theme_get()
3783 EAPI const Eina_List *elm_theme_list_get(const Elm_Theme *th);
3786 * Return the full patrh for a theme element
3788 * @param f The theme element name
3789 * @param in_search_path Pointer to a boolean to indicate if item is in the search path or not
3790 * @return The full path to the file found.
3792 * This returns a string you should free with free() on success, NULL on
3793 * failure. This will search for the given theme element, and if it is a
3794 * full or relative path element or a simple searchable name. The returned
3795 * path is the full path to the file, if searched, and the file exists, or it
3796 * is simply the full path given in the element or a resolved path if
3797 * relative to home. The @p in_search_path boolean pointed to is set to
3798 * EINA_TRUE if the file was a searchable file andis in the search path,
3799 * and EINA_FALSE otherwise.
3801 EAPI char *elm_theme_list_item_path_get(const char *f, Eina_Bool *in_search_path);
3804 * Flush the current theme.
3806 * @param th Theme to flush
3808 * This flushes caches that let elementary know where to find theme elements
3809 * in the given theme. If @p th is NULL, then the default theme is flushed.
3810 * Call this function if source theme data has changed in such a way as to
3811 * make any caches Elementary kept invalid.
3813 EAPI void elm_theme_flush(Elm_Theme *th);
3816 * This flushes all themes (default and specific ones).
3818 * This will flush all themes in the current application context, by calling
3819 * elm_theme_flush() on each of them.
3821 EAPI void elm_theme_full_flush(void);
3824 * Set the theme for all elementary using applications on the current display
3826 * @param theme The name of the theme to use. Format same as the ELM_THEME
3827 * environment variable.
3829 EAPI void elm_theme_all_set(const char *theme);
3832 * Return a list of theme elements in the theme search path
3834 * @return A list of strings that are the theme element names.
3836 * This lists all available theme files in the standard Elementary search path
3837 * for theme elements, and returns them in alphabetical order as theme
3838 * element names in a list of strings. Free this with
3839 * elm_theme_name_available_list_free() when you are done with the list.
3841 EAPI Eina_List *elm_theme_name_available_list_new(void);
3844 * Free the list returned by elm_theme_name_available_list_new()
3846 * This frees the list of themes returned by
3847 * elm_theme_name_available_list_new(). Once freed the list should no longer
3848 * be used. a new list mys be created.
3850 EAPI void elm_theme_name_available_list_free(Eina_List *list);
3853 * Set a specific theme to be used for this object and its children
3855 * @param obj The object to set the theme on
3856 * @param th The theme to set
3858 * This sets a specific theme that will be used for the given object and any
3859 * child objects it has. If @p th is NULL then the theme to be used is
3860 * cleared and the object will inherit its theme from its parent (which
3861 * ultimately will use the default theme if no specific themes are set).
3863 * Use special themes with great care as this will annoy users and make
3864 * configuration difficult. Avoid any custom themes at all if it can be
3867 EAPI void elm_object_theme_set(Evas_Object *obj, Elm_Theme *th) EINA_ARG_NONNULL(1);
3870 * Get the specific theme to be used
3872 * @param obj The object to get the specific theme from
3873 * @return The specifc theme set.
3875 * This will return a specific theme set, or NULL if no specific theme is
3876 * set on that object. It will not return inherited themes from parents, only
3877 * the specific theme set for that specific object. See elm_object_theme_set()
3878 * for more information.
3880 EAPI Elm_Theme *elm_object_theme_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3883 * Get a data item from a theme
3885 * @param th The theme, or NULL for default theme
3886 * @param key The data key to search with
3887 * @return The data value, or NULL on failure
3889 * This function is used to return data items from edc in @p th, an overlay, or an extension.
3890 * It works the same way as edje_file_data_get() except that the return is stringshared.
3892 EAPI const char *elm_theme_data_get(Elm_Theme *th, const char *key) EINA_ARG_NONNULL(2);
3899 /** @defgroup Win Win
3901 * @image html img/widget/win/preview-00.png
3902 * @image latex img/widget/win/preview-00.eps
3904 * The window class of Elementary. Contains functions to manipulate
3905 * windows. The Evas engine used to render the window contents is specified
3906 * in the system or user elementary config files (whichever is found last),
3907 * and can be overridden with the ELM_ENGINE environment variable for
3908 * testing. Engines that may be supported (depending on Evas and Ecore-Evas
3909 * compilation setup and modules actually installed at runtime) are (listed
3910 * in order of best supported and most likely to be complete and work to
3913 * @li "x11", "x", "software-x11", "software_x11" (Software rendering in X11)
3914 * @li "gl", "opengl", "opengl-x11", "opengl_x11" (OpenGL or OpenGL-ES2
3916 * @li "shot:..." (Virtual screenshot renderer - renders to output file and
3918 * @li "fb", "software-fb", "software_fb" (Linux framebuffer direct software
3920 * @li "sdl", "software-sdl", "software_sdl" (SDL software rendering to SDL
3922 * @li "gl-sdl", "gl_sdl", "opengl-sdl", "opengl_sdl" (OpenGL or OpenGL-ES2
3923 * rendering using SDL as the buffer)
3924 * @li "gdi", "software-gdi", "software_gdi" (Windows WIN32 rendering via
3925 * GDI with software)
3926 * @li "dfb", "directfb" (Rendering to a DirectFB window)
3927 * @li "x11-8", "x8", "software-8-x11", "software_8_x11" (Rendering in
3928 * grayscale using dedicated 8bit software engine in X11)
3929 * @li "x11-16", "x16", "software-16-x11", "software_16_x11" (Rendering in
3930 * X11 using 16bit software engine)
3931 * @li "wince-gdi", "software-16-wince-gdi", "software_16_wince_gdi"
3932 * (Windows CE rendering via GDI with 16bit software renderer)
3933 * @li "sdl-16", "software-16-sdl", "software_16_sdl" (Rendering to SDL
3934 * buffer with 16bit software renderer)
3935 * @li "ews" (rendering to EWS - Ecore + Evas Single Process Windowing System)
3936 * @li "gl-cocoa", "gl_cocoa", "opengl-cocoa", "opengl_cocoa" (OpenGL rendering in Cocoa)
3937 * @li "psl1ght" (PS3 rendering using PSL1GHT)
3939 * All engines use a simple string to select the engine to render, EXCEPT
3940 * the "shot" engine. This actually encodes the output of the virtual
3941 * screenshot and how long to delay in the engine string. The engine string
3942 * is encoded in the following way:
3944 * "shot:[delay=XX][:][repeat=DDD][:][file=XX]"
3946 * Where options are separated by a ":" char if more than one option is
3947 * given, with delay, if provided being the first option and file the last
3948 * (order is important). The delay specifies how long to wait after the
3949 * window is shown before doing the virtual "in memory" rendering and then
3950 * save the output to the file specified by the file option (and then exit).
3951 * If no delay is given, the default is 0.5 seconds. If no file is given the
3952 * default output file is "out.png". Repeat option is for continous
3953 * capturing screenshots. Repeat range is from 1 to 999 and filename is
3954 * fixed to "out001.png" Some examples of using the shot engine:
3956 * ELM_ENGINE="shot:delay=1.0:repeat=5:file=elm_test.png" elementary_test
3957 * ELM_ENGINE="shot:delay=1.0:file=elm_test.png" elementary_test
3958 * ELM_ENGINE="shot:file=elm_test2.png" elementary_test
3959 * ELM_ENGINE="shot:delay=2.0" elementary_test
3960 * ELM_ENGINE="shot:" elementary_test
3962 * Signals that you can add callbacks for are:
3964 * @li "delete,request": the user requested to close the window. See
3965 * elm_win_autodel_set().
3966 * @li "focus,in": window got focus
3967 * @li "focus,out": window lost focus
3968 * @li "moved": window that holds the canvas was moved
3971 * @li @ref win_example_01
3976 * Defines the types of window that can be created
3978 * These are hints set on the window so that a running Window Manager knows
3979 * how the window should be handled and/or what kind of decorations it
3982 * Currently, only the X11 backed engines use them.
3984 typedef enum _Elm_Win_Type
3986 ELM_WIN_BASIC, /**< A normal window. Indicates a normal, top-level
3987 window. Almost every window will be created with this
3989 ELM_WIN_DIALOG_BASIC, /**< Used for simple dialog windows/ */
3990 ELM_WIN_DESKTOP, /**< For special desktop windows, like a background
3991 window holding desktop icons. */
3992 ELM_WIN_DOCK, /**< The window is used as a dock or panel. Usually would
3993 be kept on top of any other window by the Window
3995 ELM_WIN_TOOLBAR, /**< The window is used to hold a floating toolbar, or
3997 ELM_WIN_MENU, /**< Similar to #ELM_WIN_TOOLBAR. */
3998 ELM_WIN_UTILITY, /**< A persistent utility window, like a toolbox or
4000 ELM_WIN_SPLASH, /**< Splash window for a starting up application. */
4001 ELM_WIN_DROPDOWN_MENU, /**< The window is a dropdown menu, as when an
4002 entry in a menubar is clicked. Typically used
4003 with elm_win_override_set(). This hint exists
4004 for completion only, as the EFL way of
4005 implementing a menu would not normally use a
4006 separate window for its contents. */
4007 ELM_WIN_POPUP_MENU, /**< Like #ELM_WIN_DROPDOWN_MENU, but for the menu
4008 triggered by right-clicking an object. */
4009 ELM_WIN_TOOLTIP, /**< The window is a tooltip. A short piece of
4010 explanatory text that typically appear after the
4011 mouse cursor hovers over an object for a while.
4012 Typically used with elm_win_override_set() and also
4013 not very commonly used in the EFL. */
4014 ELM_WIN_NOTIFICATION, /**< A notification window, like a warning about
4015 battery life or a new E-Mail received. */
4016 ELM_WIN_COMBO, /**< A window holding the contents of a combo box. Not
4017 usually used in the EFL. */
4018 ELM_WIN_DND, /**< Used to indicate the window is a representation of an
4019 object being dragged across different windows, or even
4020 applications. Typically used with
4021 elm_win_override_set(). */
4022 ELM_WIN_INLINED_IMAGE, /**< The window is rendered onto an image
4023 buffer. No actual window is created for this
4024 type, instead the window and all of its
4025 contents will be rendered to an image buffer.
4026 This allows to have children window inside a
4027 parent one just like any other object would
4028 be, and do other things like applying @c
4029 Evas_Map effects to it. This is the only type
4030 of window that requires the @c parent
4031 parameter of elm_win_add() to be a valid @c
4036 * The differents layouts that can be requested for the virtual keyboard.
4038 * When the application window is being managed by Illume, it may request
4039 * any of the following layouts for the virtual keyboard.
4041 typedef enum _Elm_Win_Keyboard_Mode
4043 ELM_WIN_KEYBOARD_UNKNOWN, /**< Unknown keyboard state */
4044 ELM_WIN_KEYBOARD_OFF, /**< Request to deactivate the keyboard */
4045 ELM_WIN_KEYBOARD_ON, /**< Enable keyboard with default layout */
4046 ELM_WIN_KEYBOARD_ALPHA, /**< Alpha (a-z) keyboard layout */
4047 ELM_WIN_KEYBOARD_NUMERIC, /**< Numeric keyboard layout */
4048 ELM_WIN_KEYBOARD_PIN, /**< PIN keyboard layout */
4049 ELM_WIN_KEYBOARD_PHONE_NUMBER, /**< Phone keyboard layout */
4050 ELM_WIN_KEYBOARD_HEX, /**< Hexadecimal numeric keyboard layout */
4051 ELM_WIN_KEYBOARD_TERMINAL, /**< Full (QUERTY) keyboard layout */
4052 ELM_WIN_KEYBOARD_PASSWORD, /**< Password keyboard layout */
4053 ELM_WIN_KEYBOARD_IP, /**< IP keyboard layout */
4054 ELM_WIN_KEYBOARD_HOST, /**< Host keyboard layout */
4055 ELM_WIN_KEYBOARD_FILE, /**< File keyboard layout */
4056 ELM_WIN_KEYBOARD_URL, /**< URL keyboard layout */
4057 ELM_WIN_KEYBOARD_KEYPAD, /**< Keypad layout */
4058 ELM_WIN_KEYBOARD_J2ME /**< J2ME keyboard layout */
4059 } Elm_Win_Keyboard_Mode;
4062 * Available commands that can be sent to the Illume manager.
4064 * When running under an Illume session, a window may send commands to the
4065 * Illume manager to perform different actions.
4067 typedef enum _Elm_Illume_Command
4069 ELM_ILLUME_COMMAND_FOCUS_BACK, /**< Reverts focus to the previous
4071 ELM_ILLUME_COMMAND_FOCUS_FORWARD, /**< Sends focus to the next window\
4073 ELM_ILLUME_COMMAND_FOCUS_HOME, /**< Hides all windows to show the Home
4075 ELM_ILLUME_COMMAND_CLOSE /**< Closes the currently active window */
4076 } Elm_Illume_Command;
4079 * Adds a window object. If this is the first window created, pass NULL as
4082 * @param parent Parent object to add the window to, or NULL
4083 * @param name The name of the window
4084 * @param type The window type, one of #Elm_Win_Type.
4086 * The @p parent paramter can be @c NULL for every window @p type except
4087 * #ELM_WIN_INLINED_IMAGE, which needs a parent to retrieve the canvas on
4088 * which the image object will be created.
4090 * @return The created object, or NULL on failure
4092 EAPI Evas_Object *elm_win_add(Evas_Object *parent, const char *name, Elm_Win_Type type);
4095 * Adds a window object with standard setup
4097 * @param name The name of the window
4098 * @param title The title for the window
4100 * This creates a window like elm_win_add() but also puts in a standard
4101 * background with elm_bg_add(), as well as setting the window title to
4102 * @p title. The window type created is of type ELM_WIN_BASIC, with NULL
4103 * as the parent widget.
4105 * @return The created object, or NULL on failure
4107 * @see elm_win_add()
4109 EAPI Evas_Object *elm_win_util_standard_add(const char *name, const char *title);
4112 * Add @p subobj as a resize object of window @p obj.
4115 * Setting an object as a resize object of the window means that the
4116 * @p subobj child's size and position will be controlled by the window
4117 * directly. That is, the object will be resized to match the window size
4118 * and should never be moved or resized manually by the developer.
4120 * In addition, resize objects of the window control what the minimum size
4121 * of it will be, as well as whether it can or not be resized by the user.
4123 * For the end user to be able to resize a window by dragging the handles
4124 * or borders provided by the Window Manager, or using any other similar
4125 * mechanism, all of the resize objects in the window should have their
4126 * evas_object_size_hint_weight_set() set to EVAS_HINT_EXPAND.
4128 * Also notice that the window can get resized to the current size of the
4129 * object if the EVAS_HINT_EXPAND is set @b after the call to
4130 * elm_win_resize_object_add(). So if the object should get resized to the
4131 * size of the window, set this hint @b before adding it as a resize object
4132 * (this happens because the size of the window and the object are evaluated
4133 * as soon as the object is added to the window).
4135 * @param obj The window object
4136 * @param subobj The resize object to add
4138 EAPI void elm_win_resize_object_add(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
4141 * Delete @p subobj as a resize object of window @p obj.
4143 * This function removes the object @p subobj from the resize objects of
4144 * the window @p obj. It will not delete the object itself, which will be
4145 * left unmanaged and should be deleted by the developer, manually handled
4146 * or set as child of some other container.
4148 * @param obj The window object
4149 * @param subobj The resize object to add
4151 EAPI void elm_win_resize_object_del(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
4154 * Set the title of the window
4156 * @param obj The window object
4157 * @param title The title to set
4159 EAPI void elm_win_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
4162 * Get the title of the window
4164 * The returned string is an internal one and should not be freed or
4165 * modified. It will also be rendered invalid if a new title is set or if
4166 * the window is destroyed.
4168 * @param obj The window object
4171 EAPI const char *elm_win_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4174 * Set the window's autodel state.
4176 * When closing the window in any way outside of the program control, like
4177 * pressing the X button in the titlebar or using a command from the
4178 * Window Manager, a "delete,request" signal is emitted to indicate that
4179 * this event occurred and the developer can take any action, which may
4180 * include, or not, destroying the window object.
4182 * When the @p autodel parameter is set, the window will be automatically
4183 * destroyed when this event occurs, after the signal is emitted.
4184 * If @p autodel is @c EINA_FALSE, then the window will not be destroyed
4185 * and is up to the program to do so when it's required.
4187 * @param obj The window object
4188 * @param autodel If true, the window will automatically delete itself when
4191 EAPI void elm_win_autodel_set(Evas_Object *obj, Eina_Bool autodel) EINA_ARG_NONNULL(1);
4194 * Get the window's autodel state.
4196 * @param obj The window object
4197 * @return If the window will automatically delete itself when closed
4199 * @see elm_win_autodel_set()
4201 EAPI Eina_Bool elm_win_autodel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4204 * Activate a window object.
4206 * This function sends a request to the Window Manager to activate the
4207 * window pointed by @p obj. If honored by the WM, the window will receive
4208 * the keyboard focus.
4210 * @note This is just a request that a Window Manager may ignore, so calling
4211 * this function does not ensure in any way that the window will be the
4212 * active one after it.
4214 * @param obj The window object
4216 EAPI void elm_win_activate(Evas_Object *obj) EINA_ARG_NONNULL(1);
4219 * Lower a window object.
4221 * Places the window pointed by @p obj at the bottom of the stack, so that
4222 * no other window is covered by it.
4224 * If elm_win_override_set() is not set, the Window Manager may ignore this
4227 * @param obj The window object
4229 EAPI void elm_win_lower(Evas_Object *obj) EINA_ARG_NONNULL(1);
4232 * Raise a window object.
4234 * Places the window pointed by @p obj at the top of the stack, so that it's
4235 * not covered by any other window.
4237 * If elm_win_override_set() is not set, the Window Manager may ignore this
4240 * @param obj The window object
4242 EAPI void elm_win_raise(Evas_Object *obj) EINA_ARG_NONNULL(1);
4245 * Center a window on its screen
4247 * This function centers window @p obj horizontally and/or vertically based on the values
4249 * @param obj The window object
4250 * @param h If true, center horizontally. If false, do not change horizontal location.
4251 * @param v If true, center vertically. If false, do not change vertical location.
4253 EAPI void elm_win_center(Evas_Object *obj, Eina_Bool h, Eina_Bool v) EINA_ARG_NONNULL(1);
4256 * Set the borderless state of a window.
4258 * This function requests the Window Manager to not draw any decoration
4259 * around the window.
4261 * @param obj The window object
4262 * @param borderless If true, the window is borderless
4264 EAPI void elm_win_borderless_set(Evas_Object *obj, Eina_Bool borderless) EINA_ARG_NONNULL(1);
4267 * Get the borderless state of a window.
4269 * @param obj The window object
4270 * @return If true, the window is borderless
4272 EAPI Eina_Bool elm_win_borderless_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4275 * Set the shaped state of a window.
4277 * Shaped windows, when supported, will render the parts of the window that
4278 * has no content, transparent.
4280 * If @p shaped is EINA_FALSE, then it is strongly adviced to have some
4281 * background object or cover the entire window in any other way, or the
4282 * parts of the canvas that have no data will show framebuffer artifacts.
4284 * @param obj The window object
4285 * @param shaped If true, the window is shaped
4287 * @see elm_win_alpha_set()
4289 EAPI void elm_win_shaped_set(Evas_Object *obj, Eina_Bool shaped) EINA_ARG_NONNULL(1);
4292 * Get the shaped state of a window.
4294 * @param obj The window object
4295 * @return If true, the window is shaped
4297 * @see elm_win_shaped_set()
4299 EAPI Eina_Bool elm_win_shaped_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4302 * Set the alpha channel state of a window.
4304 * If @p alpha is EINA_TRUE, the alpha channel of the canvas will be enabled
4305 * possibly making parts of the window completely or partially transparent.
4306 * This is also subject to the underlying system supporting it, like for
4307 * example, running under a compositing manager. If no compositing is
4308 * available, enabling this option will instead fallback to using shaped
4309 * windows, with elm_win_shaped_set().
4311 * @param obj The window object
4312 * @param alpha If true, the window has an alpha channel
4314 * @see elm_win_alpha_set()
4316 EAPI void elm_win_alpha_set(Evas_Object *obj, Eina_Bool alpha) EINA_ARG_NONNULL(1);
4319 * Get the transparency state of a window.
4321 * @param obj The window object
4322 * @return If true, the window is transparent
4324 * @see elm_win_transparent_set()
4326 EAPI Eina_Bool elm_win_transparent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4329 * Set the transparency state of a window.
4331 * Use elm_win_alpha_set() instead.
4333 * @param obj The window object
4334 * @param transparent If true, the window is transparent
4336 * @see elm_win_alpha_set()
4338 EAPI void elm_win_transparent_set(Evas_Object *obj, Eina_Bool transparent) EINA_ARG_NONNULL(1);
4341 * Get the alpha channel state of a window.
4343 * @param obj The window object
4344 * @return If true, the window has an alpha channel
4346 EAPI Eina_Bool elm_win_alpha_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4349 * Set the override state of a window.
4351 * A window with @p override set to EINA_TRUE will not be managed by the
4352 * Window Manager. This means that no decorations of any kind will be shown
4353 * for it, moving and resizing must be handled by the application, as well
4354 * as the window visibility.
4356 * This should not be used for normal windows, and even for not so normal
4357 * ones, it should only be used when there's a good reason and with a lot
4358 * of care. Mishandling override windows may result situations that
4359 * disrupt the normal workflow of the end user.
4361 * @param obj The window object
4362 * @param override If true, the window is overridden
4364 EAPI void elm_win_override_set(Evas_Object *obj, Eina_Bool override) EINA_ARG_NONNULL(1);
4367 * Get the override state of a window.
4369 * @param obj The window object
4370 * @return If true, the window is overridden
4372 * @see elm_win_override_set()
4374 EAPI Eina_Bool elm_win_override_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4377 * Set the fullscreen state of a window.
4379 * @param obj The window object
4380 * @param fullscreen If true, the window is fullscreen
4382 EAPI void elm_win_fullscreen_set(Evas_Object *obj, Eina_Bool fullscreen) EINA_ARG_NONNULL(1);
4385 * Get the fullscreen state of a window.
4387 * @param obj The window object
4388 * @return If true, the window is fullscreen
4390 EAPI Eina_Bool elm_win_fullscreen_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4393 * Set the maximized state of a window.
4395 * @param obj The window object
4396 * @param maximized If true, the window is maximized
4398 EAPI void elm_win_maximized_set(Evas_Object *obj, Eina_Bool maximized) EINA_ARG_NONNULL(1);
4401 * Get the maximized state of a window.
4403 * @param obj The window object
4404 * @return If true, the window is maximized
4406 EAPI Eina_Bool elm_win_maximized_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4409 * Set the iconified state of a window.
4411 * @param obj The window object
4412 * @param iconified If true, the window is iconified
4414 EAPI void elm_win_iconified_set(Evas_Object *obj, Eina_Bool iconified) EINA_ARG_NONNULL(1);
4417 * Get the iconified state of a window.
4419 * @param obj The window object
4420 * @return If true, the window is iconified
4422 EAPI Eina_Bool elm_win_iconified_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4425 * Set the layer of the window.
4427 * What this means exactly will depend on the underlying engine used.
4429 * In the case of X11 backed engines, the value in @p layer has the
4430 * following meanings:
4431 * @li < 3: The window will be placed below all others.
4432 * @li > 5: The window will be placed above all others.
4433 * @li other: The window will be placed in the default layer.
4435 * @param obj The window object
4436 * @param layer The layer of the window
4438 EAPI void elm_win_layer_set(Evas_Object *obj, int layer) EINA_ARG_NONNULL(1);
4441 * Get the layer of the window.
4443 * @param obj The window object
4444 * @return The layer of the window
4446 * @see elm_win_layer_set()
4448 EAPI int elm_win_layer_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4451 * Set the rotation of the window.
4453 * Most engines only work with multiples of 90.
4455 * This function is used to set the orientation of the window @p obj to
4456 * match that of the screen. The window itself will be resized to adjust
4457 * to the new geometry of its contents. If you want to keep the window size,
4458 * see elm_win_rotation_with_resize_set().
4460 * @param obj The window object
4461 * @param rotation The rotation of the window, in degrees (0-360),
4462 * counter-clockwise.
4464 EAPI void elm_win_rotation_set(Evas_Object *obj, int rotation) EINA_ARG_NONNULL(1);
4467 * Rotates the window and resizes it.
4469 * Like elm_win_rotation_set(), but it also resizes the window's contents so
4470 * that they fit inside the current window geometry.
4472 * @param obj The window object
4473 * @param layer The rotation of the window in degrees (0-360),
4474 * counter-clockwise.
4476 EAPI void elm_win_rotation_with_resize_set(Evas_Object *obj, int rotation) EINA_ARG_NONNULL(1);
4479 * Get the rotation of the window.
4481 * @param obj The window object
4482 * @return The rotation of the window in degrees (0-360)
4484 * @see elm_win_rotation_set()
4485 * @see elm_win_rotation_with_resize_set()
4487 EAPI int elm_win_rotation_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4490 * Set the sticky state of the window.
4492 * Hints the Window Manager that the window in @p obj should be left fixed
4493 * at its position even when the virtual desktop it's on moves or changes.
4495 * @param obj The window object
4496 * @param sticky If true, the window's sticky state is enabled
4498 EAPI void elm_win_sticky_set(Evas_Object *obj, Eina_Bool sticky) EINA_ARG_NONNULL(1);
4501 * Get the sticky state of the window.
4503 * @param obj The window object
4504 * @return If true, the window's sticky state is enabled
4506 * @see elm_win_sticky_set()
4508 EAPI Eina_Bool elm_win_sticky_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4511 * Set if this window is an illume conformant window
4513 * @param obj The window object
4514 * @param conformant The conformant flag (1 = conformant, 0 = non-conformant)
4516 EAPI void elm_win_conformant_set(Evas_Object *obj, Eina_Bool conformant) EINA_ARG_NONNULL(1);
4519 * Get if this window is an illume conformant window
4521 * @param obj The window object
4522 * @return A boolean if this window is illume conformant or not
4524 EAPI Eina_Bool elm_win_conformant_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4527 * Set a window to be an illume quickpanel window
4529 * By default window objects are not quickpanel windows.
4531 * @param obj The window object
4532 * @param quickpanel The quickpanel flag (1 = quickpanel, 0 = normal window)
4534 EAPI void elm_win_quickpanel_set(Evas_Object *obj, Eina_Bool quickpanel) EINA_ARG_NONNULL(1);
4537 * Get if this window is a quickpanel or not
4539 * @param obj The window object
4540 * @return A boolean if this window is a quickpanel or not
4542 EAPI Eina_Bool elm_win_quickpanel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4545 * Set the major priority of a quickpanel window
4547 * @param obj The window object
4548 * @param priority The major priority for this quickpanel
4550 EAPI void elm_win_quickpanel_priority_major_set(Evas_Object *obj, int priority) EINA_ARG_NONNULL(1);
4553 * Get the major priority of a quickpanel window
4555 * @param obj The window object
4556 * @return The major priority of this quickpanel
4558 EAPI int elm_win_quickpanel_priority_major_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4561 * Set the minor priority of a quickpanel window
4563 * @param obj The window object
4564 * @param priority The minor priority for this quickpanel
4566 EAPI void elm_win_quickpanel_priority_minor_set(Evas_Object *obj, int priority) EINA_ARG_NONNULL(1);
4569 * Get the minor priority of a quickpanel window
4571 * @param obj The window object
4572 * @return The minor priority of this quickpanel
4574 EAPI int elm_win_quickpanel_priority_minor_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4577 * Set which zone this quickpanel should appear in
4579 * @param obj The window object
4580 * @param zone The requested zone for this quickpanel
4582 EAPI void elm_win_quickpanel_zone_set(Evas_Object *obj, int zone) EINA_ARG_NONNULL(1);
4585 * Get which zone this quickpanel should appear in
4587 * @param obj The window object
4588 * @return The requested zone for this quickpanel
4590 EAPI int elm_win_quickpanel_zone_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4593 * Set the window to be skipped by keyboard focus
4595 * This sets the window to be skipped by normal keyboard input. This means
4596 * a window manager will be asked to not focus this window as well as omit
4597 * it from things like the taskbar, pager, "alt-tab" list etc. etc.
4599 * Call this and enable it on a window BEFORE you show it for the first time,
4600 * otherwise it may have no effect.
4602 * Use this for windows that have only output information or might only be
4603 * interacted with by the mouse or fingers, and never for typing input.
4604 * Be careful that this may have side-effects like making the window
4605 * non-accessible in some cases unless the window is specially handled. Use
4608 * @param obj The window object
4609 * @param skip The skip flag state (EINA_TRUE if it is to be skipped)
4611 EAPI void elm_win_prop_focus_skip_set(Evas_Object *obj, Eina_Bool skip) EINA_ARG_NONNULL(1);
4614 * Send a command to the windowing environment
4616 * This is intended to work in touchscreen or small screen device
4617 * environments where there is a more simplistic window management policy in
4618 * place. This uses the window object indicated to select which part of the
4619 * environment to control (the part that this window lives in), and provides
4620 * a command and an optional parameter structure (use NULL for this if not
4623 * @param obj The window object that lives in the environment to control
4624 * @param command The command to send
4625 * @param params Optional parameters for the command
4627 EAPI void elm_win_illume_command_send(Evas_Object *obj, Elm_Illume_Command command, void *params) EINA_ARG_NONNULL(1);
4630 * Get the inlined image object handle
4632 * When you create a window with elm_win_add() of type ELM_WIN_INLINED_IMAGE,
4633 * then the window is in fact an evas image object inlined in the parent
4634 * canvas. You can get this object (be careful to not manipulate it as it
4635 * is under control of elementary), and use it to do things like get pixel
4636 * data, save the image to a file, etc.
4638 * @param obj The window object to get the inlined image from
4639 * @return The inlined image object, or NULL if none exists
4641 EAPI Evas_Object *elm_win_inlined_image_object_get(Evas_Object *obj);
4644 * Determine whether a window has focus
4645 * @param obj The window to query
4646 * @return EINA_TRUE if the window exists and has focus, else EINA_FALSE
4648 EAPI Eina_Bool elm_win_focus_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4651 * Constrain the maximum width and height of a window to the width and height of its screen
4653 * When @p constrain is true, @p obj will never resize larger than the screen.
4654 * @param obj The window object
4655 * @param constrain EINA_TRUE to restrict the window's maximum size, EINA_FALSE to disable restriction
4657 EAPI void elm_win_screen_constrain_set(Evas_Object *obj, Eina_Bool constrain) EINA_ARG_NONNULL(1);
4660 * Retrieve the constraints on the maximum width and height of a window relative to the width and height of its screen
4662 * When this function returns true, @p obj will never resize larger than the screen.
4663 * @param obj The window object
4664 * @return EINA_TRUE to restrict the window's maximum size, EINA_FALSE to disable restriction
4666 EAPI Eina_Bool elm_win_screen_constrain_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
4669 * Get screen geometry details for the screen that a window is on
4670 * @param obj The window to query
4671 * @param x where to return the horizontal offset value. May be NULL.
4672 * @param y where to return the vertical offset value. May be NULL.
4673 * @param w where to return the width value. May be NULL.
4674 * @param h where to return the height value. May be NULL.
4676 EAPI void elm_win_screen_size_get(const Evas_Object *obj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
4679 * Set the enabled status for the focus highlight in a window
4681 * This function will enable or disable the focus highlight only for the
4682 * given window, regardless of the global setting for it
4684 * @param obj The window where to enable the highlight
4685 * @param enabled The enabled value for the highlight
4687 EAPI void elm_win_focus_highlight_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
4690 * Get the enabled value of the focus highlight for this window
4692 * @param obj The window in which to check if the focus highlight is enabled
4694 * @return EINA_TRUE if enabled, EINA_FALSE otherwise
4696 EAPI Eina_Bool elm_win_focus_highlight_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4699 * Set the style for the focus highlight on this window
4701 * Sets the style to use for theming the highlight of focused objects on
4702 * the given window. If @p style is NULL, the default will be used.
4704 * @param obj The window where to set the style
4705 * @param style The style to set
4707 EAPI void elm_win_focus_highlight_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
4710 * Get the style set for the focus highlight object
4712 * Gets the style set for this windows highilght object, or NULL if none
4715 * @param obj The window to retrieve the highlights style from
4717 * @return The style set or NULL if none was. Default is used in that case.
4719 EAPI const char *elm_win_focus_highlight_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4722 * ecore_x_icccm_hints_set -> accepts_focus (add to ecore_evas)
4723 * ecore_x_icccm_hints_set -> window_group (add to ecore_evas)
4724 * ecore_x_icccm_size_pos_hints_set -> request_pos (add to ecore_evas)
4725 * ecore_x_icccm_client_leader_set -> l (add to ecore_evas)
4726 * ecore_x_icccm_window_role_set -> role (add to ecore_evas)
4727 * ecore_x_icccm_transient_for_set -> forwin (add to ecore_evas)
4728 * ecore_x_netwm_window_type_set -> type (add to ecore_evas)
4730 * (add to ecore_x) set netwm argb icon! (add to ecore_evas)
4731 * (blank mouse, private mouse obj, defaultmouse)
4736 * Sets the keyboard mode of the window.
4738 * @param obj The window object
4739 * @param mode The mode to set, one of #Elm_Win_Keyboard_Mode
4741 EAPI void elm_win_keyboard_mode_set(Evas_Object *obj, Elm_Win_Keyboard_Mode mode) EINA_ARG_NONNULL(1);
4744 * Gets the keyboard mode of the window.
4746 * @param obj The window object
4747 * @return The mode, one of #Elm_Win_Keyboard_Mode
4749 EAPI Elm_Win_Keyboard_Mode elm_win_keyboard_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4752 * Sets whether the window is a keyboard.
4754 * @param obj The window object
4755 * @param is_keyboard If true, the window is a virtual keyboard
4757 EAPI void elm_win_keyboard_win_set(Evas_Object *obj, Eina_Bool is_keyboard) EINA_ARG_NONNULL(1);
4760 * Gets whether the window is a keyboard.
4762 * @param obj The window object
4763 * @return If the window is a virtual keyboard
4765 EAPI Eina_Bool elm_win_keyboard_win_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4768 * Get the screen position of a window.
4770 * @param obj The window object
4771 * @param x The int to store the x coordinate to
4772 * @param y The int to store the y coordinate to
4774 EAPI void elm_win_screen_position_get(const Evas_Object *obj, int *x, int *y) EINA_ARG_NONNULL(1);
4781 * @defgroup Inwin Inwin
4783 * @image html img/widget/inwin/preview-00.png
4784 * @image latex img/widget/inwin/preview-00.eps
4785 * @image html img/widget/inwin/preview-01.png
4786 * @image latex img/widget/inwin/preview-01.eps
4787 * @image html img/widget/inwin/preview-02.png
4788 * @image latex img/widget/inwin/preview-02.eps
4790 * An inwin is a window inside a window that is useful for a quick popup.
4791 * It does not hover.
4793 * It works by creating an object that will occupy the entire window, so it
4794 * must be created using an @ref Win "elm_win" as parent only. The inwin
4795 * object can be hidden or restacked below every other object if it's
4796 * needed to show what's behind it without destroying it. If this is done,
4797 * the elm_win_inwin_activate() function can be used to bring it back to
4798 * full visibility again.
4800 * There are three styles available in the default theme. These are:
4801 * @li default: The inwin is sized to take over most of the window it's
4803 * @li minimal: The size of the inwin will be the minimum necessary to show
4805 * @li minimal_vertical: Horizontally, the inwin takes as much space as
4806 * possible, but it's sized vertically the most it needs to fit its\
4809 * Some examples of Inwin can be found in the following:
4810 * @li @ref inwin_example_01
4816 * Adds an inwin to the current window
4818 * The @p obj used as parent @b MUST be an @ref Win "Elementary Window".
4819 * Never call this function with anything other than the top-most window
4820 * as its parameter, unless you are fond of undefined behavior.
4822 * After creating the object, the widget will set itself as resize object
4823 * for the window with elm_win_resize_object_add(), so when shown it will
4824 * appear to cover almost the entire window (how much of it depends on its
4825 * content and the style used). It must not be added into other container
4826 * objects and it needs not be moved or resized manually.
4828 * @param parent The parent object
4829 * @return The new object or NULL if it cannot be created
4831 EAPI Evas_Object *elm_win_inwin_add(Evas_Object *obj) EINA_ARG_NONNULL(1);
4834 * Activates an inwin object, ensuring its visibility
4836 * This function will make sure that the inwin @p obj is completely visible
4837 * by calling evas_object_show() and evas_object_raise() on it, to bring it
4838 * to the front. It also sets the keyboard focus to it, which will be passed
4841 * The object's theme will also receive the signal "elm,action,show" with
4844 * @param obj The inwin to activate
4846 EAPI void elm_win_inwin_activate(Evas_Object *obj) EINA_ARG_NONNULL(1);
4849 * Set the content of an inwin object.
4851 * Once the content object is set, a previously set one will be deleted.
4852 * If you want to keep that old content object, use the
4853 * elm_win_inwin_content_unset() function.
4855 * @param obj The inwin object
4856 * @param content The object to set as content
4858 EAPI void elm_win_inwin_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
4861 * Get the content of an inwin object.
4863 * Return the content object which is set for this widget.
4865 * The returned object is valid as long as the inwin is still alive and no
4866 * other content is set on it. Deleting the object will notify the inwin
4867 * about it and this one will be left empty.
4869 * If you need to remove an inwin's content to be reused somewhere else,
4870 * see elm_win_inwin_content_unset().
4872 * @param obj The inwin object
4873 * @return The content that is being used
4875 EAPI Evas_Object *elm_win_inwin_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4878 * Unset the content of an inwin object.
4880 * Unparent and return the content object which was set for this widget.
4882 * @param obj The inwin object
4883 * @return The content that was being used
4885 EAPI Evas_Object *elm_win_inwin_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4890 /* X specific calls - won't work on non-x engines (return 0) */
4893 * Get the Ecore_X_Window of an Evas_Object
4895 * @param obj The object
4897 * @return The Ecore_X_Window of @p obj
4901 EAPI Ecore_X_Window elm_win_xwindow_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4903 /* smart callbacks called:
4904 * "delete,request" - the user requested to delete the window
4905 * "focus,in" - window got focus
4906 * "focus,out" - window lost focus
4907 * "moved" - window that holds the canvas was moved
4913 * @image html img/widget/bg/preview-00.png
4914 * @image latex img/widget/bg/preview-00.eps
4916 * @brief Background object, used for setting a solid color, image or Edje
4917 * group as background to a window or any container object.
4919 * The bg object is used for setting a solid background to a window or
4920 * packing into any container object. It works just like an image, but has
4921 * some properties useful to a background, like setting it to tiled,
4922 * centered, scaled or stretched.
4924 * Default contents parts of the bg widget that you can use for are:
4925 * @li "overlay" - overlay of the bg
4927 * Here is some sample code using it:
4928 * @li @ref bg_01_example_page
4929 * @li @ref bg_02_example_page
4930 * @li @ref bg_03_example_page
4934 typedef enum _Elm_Bg_Option
4936 ELM_BG_OPTION_CENTER, /**< center the background */
4937 ELM_BG_OPTION_SCALE, /**< scale the background retaining aspect ratio */
4938 ELM_BG_OPTION_STRETCH, /**< stretch the background to fill */
4939 ELM_BG_OPTION_TILE /**< tile background at its original size */
4943 * Add a new background to the parent
4945 * @param parent The parent object
4946 * @return The new object or NULL if it cannot be created
4950 EAPI Evas_Object *elm_bg_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4953 * Set the file (image or edje) used for the background
4955 * @param obj The bg object
4956 * @param file The file path
4957 * @param group Optional key (group in Edje) within the file
4959 * This sets the image file used in the background object. The image (or edje)
4960 * will be stretched (retaining aspect if its an image file) to completely fill
4961 * the bg object. This may mean some parts are not visible.
4963 * @note Once the image of @p obj is set, a previously set one will be deleted,
4964 * even if @p file is NULL.
4968 EAPI void elm_bg_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1);
4971 * Get the file (image or edje) used for the background
4973 * @param obj The bg object
4974 * @param file The file path
4975 * @param group Optional key (group in Edje) within the file
4979 EAPI void elm_bg_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
4982 * Set the option used for the background image
4984 * @param obj The bg object
4985 * @param option The desired background option (TILE, SCALE)
4987 * This sets the option used for manipulating the display of the background
4988 * image. The image can be tiled or scaled.
4992 EAPI void elm_bg_option_set(Evas_Object *obj, Elm_Bg_Option option) EINA_ARG_NONNULL(1);
4995 * Get the option used for the background image
4997 * @param obj The bg object
4998 * @return The desired background option (CENTER, SCALE, STRETCH or TILE)
5002 EAPI Elm_Bg_Option elm_bg_option_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5004 * Set the option used for the background color
5006 * @param obj The bg object
5011 * This sets the color used for the background rectangle. Its range goes
5016 EAPI void elm_bg_color_set(Evas_Object *obj, int r, int g, int b) EINA_ARG_NONNULL(1);
5018 * Get the option used for the background color
5020 * @param obj The bg object
5027 EAPI void elm_bg_color_get(const Evas_Object *obj, int *r, int *g, int *b) EINA_ARG_NONNULL(1);
5030 * Set the overlay object used for the background object.
5032 * @param obj The bg object
5033 * @param overlay The overlay object
5035 * This provides a way for elm_bg to have an 'overlay' that will be on top
5036 * of the bg. Once the over object is set, a previously set one will be
5037 * deleted, even if you set the new one to NULL. If you want to keep that
5038 * old content object, use the elm_bg_overlay_unset() function.
5040 * @deprecated use elm_object_part_content_set() instead
5045 EINA_DEPRECATED EAPI void elm_bg_overlay_set(Evas_Object *obj, Evas_Object *overlay) EINA_ARG_NONNULL(1);
5048 * Get the overlay object used for the background object.
5050 * @param obj The bg object
5051 * @return The content that is being used
5053 * Return the content object which is set for this widget
5055 * @deprecated use elm_object_part_content_get() instead
5059 EINA_DEPRECATED EAPI Evas_Object *elm_bg_overlay_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5062 * Get the overlay object used for the background object.
5064 * @param obj The bg object
5065 * @return The content that was being used
5067 * Unparent and return the overlay object which was set for this widget
5069 * @deprecated use elm_object_part_content_unset() instead
5073 EINA_DEPRECATED EAPI Evas_Object *elm_bg_overlay_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
5076 * Set the size of the pixmap representation of the image.
5078 * This option just makes sense if an image is going to be set in the bg.
5080 * @param obj The bg object
5081 * @param w The new width of the image pixmap representation.
5082 * @param h The new height of the image pixmap representation.
5084 * This function sets a new size for pixmap representation of the given bg
5085 * image. It allows the image to be loaded already in the specified size,
5086 * reducing the memory usage and load time when loading a big image with load
5087 * size set to a smaller size.
5089 * NOTE: this is just a hint, the real size of the pixmap may differ
5090 * depending on the type of image being loaded, being bigger than requested.
5094 EAPI void elm_bg_load_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
5101 * @defgroup Icon Icon
5103 * @image html img/widget/icon/preview-00.png
5104 * @image latex img/widget/icon/preview-00.eps
5106 * An object that provides standard icon images (delete, edit, arrows, etc.)
5107 * or a custom file (PNG, JPG, EDJE, etc.) used for an icon.
5109 * The icon image requested can be in the elementary theme, or in the
5110 * freedesktop.org paths. It's possible to set the order of preference from
5111 * where the image will be used.
5113 * This API is very similar to @ref Image, but with ready to use images.
5115 * Default images provided by the theme are described below.
5117 * The first list contains icons that were first intended to be used in
5118 * toolbars, but can be used in many other places too:
5134 * Now some icons that were designed to be used in menus (but again, you can
5135 * use them anywhere else):
5140 * @li menu/arrow_down
5141 * @li menu/arrow_left
5142 * @li menu/arrow_right
5151 * And here we have some media player specific icons:
5152 * @li media_player/forward
5153 * @li media_player/info
5154 * @li media_player/next
5155 * @li media_player/pause
5156 * @li media_player/play
5157 * @li media_player/prev
5158 * @li media_player/rewind
5159 * @li media_player/stop
5161 * Signals that you can add callbacks for are:
5163 * "clicked" - This is called when a user has clicked the icon
5165 * An example of usage for this API follows:
5166 * @li @ref tutorial_icon
5174 typedef enum _Elm_Icon_Type
5182 * @enum _Elm_Icon_Lookup_Order
5183 * @typedef Elm_Icon_Lookup_Order
5185 * Lookup order used by elm_icon_standard_set(). Should look for icons in the
5186 * theme, FDO paths, or both?
5190 typedef enum _Elm_Icon_Lookup_Order
5192 ELM_ICON_LOOKUP_FDO_THEME, /**< icon look up order: freedesktop, theme */
5193 ELM_ICON_LOOKUP_THEME_FDO, /**< icon look up order: theme, freedesktop */
5194 ELM_ICON_LOOKUP_FDO, /**< icon look up order: freedesktop */
5195 ELM_ICON_LOOKUP_THEME /**< icon look up order: theme */
5196 } Elm_Icon_Lookup_Order;
5199 * Add a new icon object to the parent.
5201 * @param parent The parent object
5202 * @return The new object or NULL if it cannot be created
5204 * @see elm_icon_file_set()
5208 EAPI Evas_Object *elm_icon_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5211 * Set the file that will be used as icon.
5213 * @param obj The icon object
5214 * @param file The path to file that will be used as icon image
5215 * @param group The group that the icon belongs to an edje file
5217 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
5219 * @note The icon image set by this function can be changed by
5220 * elm_icon_standard_set().
5222 * @see elm_icon_file_get()
5226 EAPI Eina_Bool elm_icon_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
5229 * Set a location in memory to be used as an icon
5231 * @param obj The icon object
5232 * @param img The binary data that will be used as an image
5233 * @param size The size of binary data @p img
5234 * @param format Optional format of @p img to pass to the image loader
5235 * @param key Optional key of @p img to pass to the image loader (eg. if @p img is an edje file)
5237 * The @p format string should be something like "png", "jpg", "tga",
5238 * "tiff", "bmp" etc. if it is provided (NULL if not). This improves
5239 * the loader performance as it tries the "correct" loader first before
5240 * trying a range of other possible loaders until one succeeds.
5242 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
5244 * @note The icon image set by this function can be changed by
5245 * elm_icon_standard_set().
5249 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);
5252 * Get the file that will be used as icon.
5254 * @param obj The icon object
5255 * @param file The path to file that will be used as the icon image
5256 * @param group The group that the icon belongs to, in edje file
5258 * @see elm_icon_file_set()
5262 EAPI void elm_icon_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
5265 * Set the file that will be used, but use a generated thumbnail.
5267 * @param obj The icon object
5268 * @param file The path to file that will be used as icon image
5269 * @param group The group that the icon belongs to an edje file
5271 * This functions like elm_icon_file_set() but requires the Ethumb library
5272 * support to be enabled successfully with elm_need_ethumb(). When set
5273 * the file indicated has a thumbnail generated and cached on disk for
5274 * future use or will directly use an existing cached thumbnail if it
5277 * @see elm_icon_file_set()
5281 EAPI void elm_icon_thumb_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
5284 * Set the icon by icon standards names.
5286 * @param obj The icon object
5287 * @param name The icon name
5289 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
5291 * For example, freedesktop.org defines standard icon names such as "home",
5292 * "network", etc. There can be different icon sets to match those icon
5293 * keys. The @p name given as parameter is one of these "keys", and will be
5294 * used to look in the freedesktop.org paths and elementary theme. One can
5295 * change the lookup order with elm_icon_order_lookup_set().
5297 * If name is not found in any of the expected locations and it is the
5298 * absolute path of an image file, this image will be used.
5300 * @note The icon image set by this function can be changed by
5301 * elm_icon_file_set().
5303 * @see elm_icon_standard_get()
5304 * @see elm_icon_file_set()
5308 EAPI Eina_Bool elm_icon_standard_set(Evas_Object *obj, const char *name) EINA_ARG_NONNULL(1);
5311 * Get the icon name set by icon standard names.
5313 * @param obj The icon object
5314 * @return The icon name
5316 * If the icon image was set using elm_icon_file_set() instead of
5317 * elm_icon_standard_set(), then this function will return @c NULL.
5319 * @see elm_icon_standard_set()
5323 EAPI const char *elm_icon_standard_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5326 * Set the smooth scaling for an icon object.
5328 * @param obj The icon object
5329 * @param smooth @c EINA_TRUE if smooth scaling should be used, @c EINA_FALSE
5330 * otherwise. Default is @c EINA_TRUE.
5332 * Set the scaling algorithm to be used when scaling the icon image. Smooth
5333 * scaling provides a better resulting image, but is slower.
5335 * The smooth scaling should be disabled when making animations that change
5336 * the icon size, since they will be faster. Animations that don't require
5337 * resizing of the icon can keep the smooth scaling enabled (even if the icon
5338 * is already scaled, since the scaled icon image will be cached).
5340 * @see elm_icon_smooth_get()
5344 EAPI void elm_icon_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
5347 * Get whether smooth scaling is enabled for an icon object.
5349 * @param obj The icon object
5350 * @return @c EINA_TRUE if smooth scaling is enabled, @c EINA_FALSE otherwise.
5352 * @see elm_icon_smooth_set()
5356 EAPI Eina_Bool elm_icon_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5359 * Disable scaling of this object.
5361 * @param obj The icon object.
5362 * @param no_scale @c EINA_TRUE if the object is not scalable, @c EINA_FALSE
5363 * otherwise. Default is @c EINA_FALSE.
5365 * This function disables scaling of the icon object through the function
5366 * elm_object_scale_set(). However, this does not affect the object
5367 * size/resize in any way. For that effect, take a look at
5368 * elm_icon_scale_set().
5370 * @see elm_icon_no_scale_get()
5371 * @see elm_icon_scale_set()
5372 * @see elm_object_scale_set()
5376 EAPI void elm_icon_no_scale_set(Evas_Object *obj, Eina_Bool no_scale) EINA_ARG_NONNULL(1);
5379 * Get whether scaling is disabled on the object.
5381 * @param obj The icon object
5382 * @return @c EINA_TRUE if scaling is disabled, @c EINA_FALSE otherwise
5384 * @see elm_icon_no_scale_set()
5388 EAPI Eina_Bool elm_icon_no_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5391 * Set if the object is (up/down) resizable.
5393 * @param obj The icon object
5394 * @param scale_up A bool to set if the object is resizable up. Default is
5396 * @param scale_down A bool to set if the object is resizable down. Default
5399 * This function limits the icon object resize ability. If @p scale_up is set to
5400 * @c EINA_FALSE, the object can't have its height or width resized to a value
5401 * higher than the original icon size. Same is valid for @p scale_down.
5403 * @see elm_icon_scale_get()
5407 EAPI void elm_icon_scale_set(Evas_Object *obj, Eina_Bool scale_up, Eina_Bool scale_down) EINA_ARG_NONNULL(1);
5410 * Get if the object is (up/down) resizable.
5412 * @param obj The icon object
5413 * @param scale_up A bool to set if the object is resizable up
5414 * @param scale_down A bool to set if the object is resizable down
5416 * @see elm_icon_scale_set()
5420 EAPI void elm_icon_scale_get(const Evas_Object *obj, Eina_Bool *scale_up, Eina_Bool *scale_down) EINA_ARG_NONNULL(1);
5423 * Get the object's image size
5425 * @param obj The icon object
5426 * @param w A pointer to store the width in
5427 * @param h A pointer to store the height in
5431 EAPI void elm_icon_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
5434 * Set if the icon fill the entire object area.
5436 * @param obj The icon object
5437 * @param fill_outside @c EINA_TRUE if the object is filled outside,
5438 * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
5440 * When the icon object is resized to a different aspect ratio from the
5441 * original icon image, the icon image will still keep its aspect. This flag
5442 * tells how the image should fill the object's area. They are: keep the
5443 * entire icon inside the limits of height and width of the object (@p
5444 * fill_outside is @c EINA_FALSE) or let the extra width or height go outside
5445 * of the object, and the icon will fill the entire object (@p fill_outside
5448 * @note Unlike @ref Image, there's no option in icon to set the aspect ratio
5449 * retain property to false. Thus, the icon image will always keep its
5450 * original aspect ratio.
5452 * @see elm_icon_fill_outside_get()
5453 * @see elm_image_fill_outside_set()
5457 EAPI void elm_icon_fill_outside_set(Evas_Object *obj, Eina_Bool fill_outside) EINA_ARG_NONNULL(1);
5460 * Get if the object is filled outside.
5462 * @param obj The icon object
5463 * @return @c EINA_TRUE if the object is filled outside, @c EINA_FALSE otherwise.
5465 * @see elm_icon_fill_outside_set()
5469 EAPI Eina_Bool elm_icon_fill_outside_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5472 * Set the prescale size for the icon.
5474 * @param obj The icon object
5475 * @param size The prescale size. This value is used for both width and
5478 * This function sets a new size for pixmap representation of the given
5479 * icon. It allows the icon to be loaded already in the specified size,
5480 * reducing the memory usage and load time when loading a big icon with load
5481 * size set to a smaller size.
5483 * It's equivalent to the elm_bg_load_size_set() function for bg.
5485 * @note this is just a hint, the real size of the pixmap may differ
5486 * depending on the type of icon being loaded, being bigger than requested.
5488 * @see elm_icon_prescale_get()
5489 * @see elm_bg_load_size_set()
5493 EAPI void elm_icon_prescale_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
5496 * Get the prescale size for the icon.
5498 * @param obj The icon object
5499 * @return The prescale size
5501 * @see elm_icon_prescale_set()
5505 EAPI int elm_icon_prescale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5508 * Gets the image object of the icon. DO NOT MODIFY THIS.
5510 * @param obj The icon object
5511 * @return The internal icon object
5515 EAPI Evas_Object *elm_icon_object_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
5518 * Sets the icon lookup order used by elm_icon_standard_set().
5520 * @param obj The icon object
5521 * @param order The icon lookup order (can be one of
5522 * ELM_ICON_LOOKUP_FDO_THEME, ELM_ICON_LOOKUP_THEME_FDO, ELM_ICON_LOOKUP_FDO
5523 * or ELM_ICON_LOOKUP_THEME)
5525 * @see elm_icon_order_lookup_get()
5526 * @see Elm_Icon_Lookup_Order
5530 EAPI void elm_icon_order_lookup_set(Evas_Object *obj, Elm_Icon_Lookup_Order order) EINA_ARG_NONNULL(1);
5533 * Gets the icon lookup order.
5535 * @param obj The icon object
5536 * @return The icon lookup order
5538 * @see elm_icon_order_lookup_set()
5539 * @see Elm_Icon_Lookup_Order
5543 EAPI Elm_Icon_Lookup_Order elm_icon_order_lookup_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5546 * Enable or disable preloading of the icon
5548 * @param obj The icon object
5549 * @param disable If EINA_TRUE, preloading will be disabled
5552 EAPI void elm_icon_preload_set(Evas_Object *obj, Eina_Bool disable) EINA_ARG_NONNULL(1);
5555 * Get if the icon supports animation or not.
5557 * @param obj The icon object
5558 * @return @c EINA_TRUE if the icon supports animation,
5559 * @c EINA_FALSE otherwise.
5561 * Return if this elm icon's image can be animated. Currently Evas only
5562 * supports gif animation. If the return value is EINA_FALSE, other
5563 * elm_icon_animated_XXX APIs won't work.
5566 EAPI Eina_Bool elm_icon_animated_available_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5569 * Set animation mode of the icon.
5571 * @param obj The icon object
5572 * @param anim @c EINA_TRUE if the object do animation job,
5573 * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
5575 * Since the default animation mode is set to EINA_FALSE,
5576 * the icon is shown without animation. Files like animated GIF files
5577 * can animate, and this is supported if you enable animated support
5579 * Set it to EINA_TRUE when the icon needs to be animated.
5582 EAPI void elm_icon_animated_set(Evas_Object *obj, Eina_Bool animated) EINA_ARG_NONNULL(1);
5585 * Get animation mode of the icon.
5587 * @param obj The icon object
5588 * @return The animation mode of the icon object
5589 * @see elm_icon_animated_set
5592 EAPI Eina_Bool elm_icon_animated_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5595 * Set animation play mode of the icon.
5597 * @param obj The icon object
5598 * @param play @c EINA_TRUE the object play animation images,
5599 * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
5601 * To play elm icon's animation, set play to EINA_TURE.
5602 * For example, you make gif player using this set/get API and click event.
5603 * This literally lets you control current play or paused state. To have
5604 * this work with animated GIF files for example, you first, before
5605 * setting the file have to use elm_icon_animated_set() to enable animation
5606 * at all on the icon.
5608 * 1. Click event occurs
5609 * 2. Check play flag using elm_icon_animaged_play_get
5610 * 3. If elm icon was playing, set play to EINA_FALSE.
5611 * Then animation will be stopped and vice versa
5614 EAPI void elm_icon_animated_play_set(Evas_Object *obj, Eina_Bool play) EINA_ARG_NONNULL(1);
5617 * Get animation play mode of the icon.
5619 * @param obj The icon object
5620 * @return The play mode of the icon object
5622 * @see elm_icon_animated_play_get
5625 EAPI Eina_Bool elm_icon_animated_play_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5632 * @defgroup Image Image
5634 * @image html img/widget/image/preview-00.png
5635 * @image latex img/widget/image/preview-00.eps
5638 * An object that allows one to load an image file to it. It can be used
5639 * anywhere like any other elementary widget.
5641 * This widget provides most of the functionality provided from @ref Bg or @ref
5642 * Icon, but with a slightly different API (use the one that fits better your
5645 * The features not provided by those two other image widgets are:
5646 * @li allowing to get the basic @c Evas_Object with elm_image_object_get();
5647 * @li change the object orientation with elm_image_orient_set();
5648 * @li and turning the image editable with elm_image_editable_set().
5650 * Signals that you can add callbacks for are:
5652 * @li @c "clicked" - This is called when a user has clicked the image
5654 * An example of usage for this API follows:
5655 * @li @ref tutorial_image
5664 * @enum _Elm_Image_Orient
5665 * @typedef Elm_Image_Orient
5667 * Possible orientation options for elm_image_orient_set().
5669 * @image html elm_image_orient_set.png
5670 * @image latex elm_image_orient_set.eps width=\textwidth
5674 typedef enum _Elm_Image_Orient
5676 ELM_IMAGE_ORIENT_NONE = 0, /**< no orientation change */
5677 ELM_IMAGE_ORIENT_0 = 0, /**< no orientation change */
5678 ELM_IMAGE_ROTATE_90 = 1, /**< rotate 90 degrees clockwise */
5679 ELM_IMAGE_ROTATE_180 = 2, /**< rotate 180 degrees clockwise */
5680 ELM_IMAGE_ROTATE_270 = 3, /**< rotate 90 degrees counter-clockwise (i.e. 270 degrees clockwise) */
5681 /*EINA_DEPRECATED*/ELM_IMAGE_ROTATE_90_CW = 1, /**< rotate 90 degrees clockwise */
5682 /*EINA_DEPRECATED*/ELM_IMAGE_ROTATE_180_CW = 2, /**< rotate 180 degrees clockwise */
5683 /*EINA_DEPRECATED*/ELM_IMAGE_ROTATE_90_CCW = 3, /**< rotate 90 degrees counter-clockwise (i.e. 270 degrees clockwise) */
5684 ELM_IMAGE_FLIP_HORIZONTAL = 4, /**< flip image horizontally */
5685 ELM_IMAGE_FLIP_VERTICAL = 5, /**< flip image vertically */
5686 ELM_IMAGE_FLIP_TRANSPOSE = 6, /**< flip the image along the y = (width - x) line (bottom-left to top-right) */
5687 ELM_IMAGE_FLIP_TRANSVERSE = 7 /**< flip the image along the y = x line (top-left to bottom-right) */
5691 * Add a new image to the parent.
5693 * @param parent The parent object
5694 * @return The new object or NULL if it cannot be created
5696 * @see elm_image_file_set()
5700 EAPI Evas_Object *elm_image_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5703 * Set the file that will be used as image.
5705 * @param obj The image object
5706 * @param file The path to file that will be used as image
5707 * @param group The group that the image belongs in edje file (if it's an
5710 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
5712 * @see elm_image_file_get()
5716 EAPI Eina_Bool elm_image_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
5719 * Get the file that will be used as image.
5721 * @param obj The image object
5722 * @param file The path to file
5723 * @param group The group that the image belongs in edje file
5725 * @see elm_image_file_set()
5729 EAPI void elm_image_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
5732 * Set the smooth effect for an image.
5734 * @param obj The image object
5735 * @param smooth @c EINA_TRUE if smooth scaling should be used, @c EINA_FALSE
5736 * otherwise. Default is @c EINA_TRUE.
5738 * Set the scaling algorithm to be used when scaling the image. Smooth
5739 * scaling provides a better resulting image, but is slower.
5741 * The smooth scaling should be disabled when making animations that change
5742 * the image size, since it will be faster. Animations that don't require
5743 * resizing of the image can keep the smooth scaling enabled (even if the
5744 * image is already scaled, since the scaled image will be cached).
5746 * @see elm_image_smooth_get()
5750 EAPI void elm_image_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
5753 * Get the smooth effect for an image.
5755 * @param obj The image object
5756 * @return @c EINA_TRUE if smooth scaling is enabled, @c EINA_FALSE otherwise.
5758 * @see elm_image_smooth_get()
5762 EAPI Eina_Bool elm_image_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5765 * Gets the current size of the image.
5767 * @param obj The image object.
5768 * @param w Pointer to store width, or NULL.
5769 * @param h Pointer to store height, or NULL.
5771 * This is the real size of the image, not the size of the object.
5773 * On error, neither w and h will be fileld with 0.
5777 EAPI void elm_image_object_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
5780 * Disable scaling of this object.
5782 * @param obj The image object.
5783 * @param no_scale @c EINA_TRUE if the object is not scalable, @c EINA_FALSE
5784 * otherwise. Default is @c EINA_FALSE.
5786 * This function disables scaling of the elm_image widget through the
5787 * function elm_object_scale_set(). However, this does not affect the widget
5788 * size/resize in any way. For that effect, take a look at
5789 * elm_image_scale_set().
5791 * @see elm_image_no_scale_get()
5792 * @see elm_image_scale_set()
5793 * @see elm_object_scale_set()
5797 EAPI void elm_image_no_scale_set(Evas_Object *obj, Eina_Bool no_scale) EINA_ARG_NONNULL(1);
5800 * Get whether scaling is disabled on the object.
5802 * @param obj The image object
5803 * @return @c EINA_TRUE if scaling is disabled, @c EINA_FALSE otherwise
5805 * @see elm_image_no_scale_set()
5809 EAPI Eina_Bool elm_image_no_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5812 * Set if the object is (up/down) resizable.
5814 * @param obj The image object
5815 * @param scale_up A bool to set if the object is resizable up. Default is
5817 * @param scale_down A bool to set if the object is resizable down. Default
5820 * This function limits the image resize ability. If @p scale_up is set to
5821 * @c EINA_FALSE, the object can't have its height or width resized to a value
5822 * higher than the original image size. Same is valid for @p scale_down.
5824 * @see elm_image_scale_get()
5828 EAPI void elm_image_scale_set(Evas_Object *obj, Eina_Bool scale_up, Eina_Bool scale_down) EINA_ARG_NONNULL(1);
5831 * Get if the object is (up/down) resizable.
5833 * @param obj The image object
5834 * @param scale_up A bool to set if the object is resizable up
5835 * @param scale_down A bool to set if the object is resizable down
5837 * @see elm_image_scale_set()
5841 EAPI void elm_image_scale_get(const Evas_Object *obj, Eina_Bool *scale_up, Eina_Bool *scale_down) EINA_ARG_NONNULL(1);
5844 * Set if the image fills the entire object area, when keeping the aspect ratio.
5846 * @param obj The image object
5847 * @param fill_outside @c EINA_TRUE if the object is filled outside,
5848 * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
5850 * When the image should keep its aspect ratio even if resized to another
5851 * aspect ratio, there are two possibilities to resize it: keep the entire
5852 * image inside the limits of height and width of the object (@p fill_outside
5853 * is @c EINA_FALSE) or let the extra width or height go outside of the object,
5854 * and the image will fill the entire object (@p fill_outside is @c EINA_TRUE).
5856 * @note This option will have no effect if
5857 * elm_image_aspect_ratio_retained_set() is set to @c EINA_FALSE.
5859 * @see elm_image_fill_outside_get()
5860 * @see elm_image_aspect_ratio_retained_set()
5864 EAPI void elm_image_fill_outside_set(Evas_Object *obj, Eina_Bool fill_outside) EINA_ARG_NONNULL(1);
5867 * Get if the object is filled outside
5869 * @param obj The image object
5870 * @return @c EINA_TRUE if the object is filled outside, @c EINA_FALSE otherwise.
5872 * @see elm_image_fill_outside_set()
5876 EAPI Eina_Bool elm_image_fill_outside_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5879 * Set the prescale size for the image
5881 * @param obj The image object
5882 * @param size The prescale size. This value is used for both width and
5885 * This function sets a new size for pixmap representation of the given
5886 * image. It allows the image to be loaded already in the specified size,
5887 * reducing the memory usage and load time when loading a big image with load
5888 * size set to a smaller size.
5890 * It's equivalent to the elm_bg_load_size_set() function for bg.
5892 * @note this is just a hint, the real size of the pixmap may differ
5893 * depending on the type of image being loaded, being bigger than requested.
5895 * @see elm_image_prescale_get()
5896 * @see elm_bg_load_size_set()
5900 EAPI void elm_image_prescale_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
5903 * Get the prescale size for the image
5905 * @param obj The image object
5906 * @return The prescale size
5908 * @see elm_image_prescale_set()
5912 EAPI int elm_image_prescale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5915 * Set the image orientation.
5917 * @param obj The image object
5918 * @param orient The image orientation @ref Elm_Image_Orient
5919 * Default is #ELM_IMAGE_ORIENT_NONE.
5921 * This function allows to rotate or flip the given image.
5923 * @see elm_image_orient_get()
5924 * @see @ref Elm_Image_Orient
5928 EAPI void elm_image_orient_set(Evas_Object *obj, Elm_Image_Orient orient) EINA_ARG_NONNULL(1);
5931 * Get the image orientation.
5933 * @param obj The image object
5934 * @return The image orientation @ref Elm_Image_Orient
5936 * @see elm_image_orient_set()
5937 * @see @ref Elm_Image_Orient
5941 EAPI Elm_Image_Orient elm_image_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5944 * Make the image 'editable'.
5946 * @param obj Image object.
5947 * @param set Turn on or off editability. Default is @c EINA_FALSE.
5949 * This means the image is a valid drag target for drag and drop, and can be
5950 * cut or pasted too.
5954 EAPI void elm_image_editable_set(Evas_Object *obj, Eina_Bool set) EINA_ARG_NONNULL(1);
5957 * Check if the image 'editable'.
5959 * @param obj Image object.
5960 * @return Editability.
5962 * A return value of EINA_TRUE means the image is a valid drag target
5963 * for drag and drop, and can be cut or pasted too.
5967 EAPI Eina_Bool elm_image_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5970 * Get the basic Evas_Image object from this object (widget).
5972 * @param obj The image object to get the inlined image from
5973 * @return The inlined image object, or NULL if none exists
5975 * This function allows one to get the underlying @c Evas_Object of type
5976 * Image from this elementary widget. It can be useful to do things like get
5977 * the pixel data, save the image to a file, etc.
5979 * @note Be careful to not manipulate it, as it is under control of
5984 EAPI Evas_Object *elm_image_object_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5987 * Set whether the original aspect ratio of the image should be kept on resize.
5989 * @param obj The image object.
5990 * @param retained @c EINA_TRUE if the image should retain the aspect,
5991 * @c EINA_FALSE otherwise.
5993 * The original aspect ratio (width / height) of the image is usually
5994 * distorted to match the object's size. Enabling this option will retain
5995 * this original aspect, and the way that the image is fit into the object's
5996 * area depends on the option set by elm_image_fill_outside_set().
5998 * @see elm_image_aspect_ratio_retained_get()
5999 * @see elm_image_fill_outside_set()
6003 EAPI void elm_image_aspect_ratio_retained_set(Evas_Object *obj, Eina_Bool retained) EINA_ARG_NONNULL(1);
6006 * Get if the object retains the original aspect ratio.
6008 * @param obj The image object.
6009 * @return @c EINA_TRUE if the object keeps the original aspect, @c EINA_FALSE
6014 EAPI Eina_Bool elm_image_aspect_ratio_retained_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6021 typedef void (*Elm_GLView_Func_Cb)(Evas_Object *obj);
6023 typedef enum _Elm_GLView_Mode
6025 ELM_GLVIEW_ALPHA = 1,
6026 ELM_GLVIEW_DEPTH = 2,
6027 ELM_GLVIEW_STENCIL = 4
6031 * Defines a policy for the glview resizing.
6033 * @note Default is ELM_GLVIEW_RESIZE_POLICY_RECREATE
6035 typedef enum _Elm_GLView_Resize_Policy
6037 ELM_GLVIEW_RESIZE_POLICY_RECREATE = 1, /**< Resize the internal surface along with the image */
6038 ELM_GLVIEW_RESIZE_POLICY_SCALE = 2 /**< Only reize the internal image and not the surface */
6039 } Elm_GLView_Resize_Policy;
6041 typedef enum _Elm_GLView_Render_Policy
6043 ELM_GLVIEW_RENDER_POLICY_ON_DEMAND = 1, /**< Render only when there is a need for redrawing */
6044 ELM_GLVIEW_RENDER_POLICY_ALWAYS = 2 /**< Render always even when it is not visible */
6045 } Elm_GLView_Render_Policy;
6050 * A simple GLView widget that allows GL rendering.
6052 * Signals that you can add callbacks for are:
6058 * Add a new glview to the parent
6060 * @param parent The parent object
6061 * @return The new object or NULL if it cannot be created
6065 EAPI Evas_Object *elm_glview_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6068 * Sets the size of the glview
6070 * @param obj The glview object
6071 * @param width width of the glview object
6072 * @param height height of the glview object
6076 EAPI void elm_glview_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
6079 * Gets the size of the glview.
6081 * @param obj The glview object
6082 * @param width width of the glview object
6083 * @param height height of the glview object
6085 * Note that this function returns the actual image size of the
6086 * glview. This means that when the scale policy is set to
6087 * ELM_GLVIEW_RESIZE_POLICY_SCALE, it'll return the non-scaled
6092 EAPI void elm_glview_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
6095 * Gets the gl api struct for gl rendering
6097 * @param obj The glview object
6098 * @return The api object or NULL if it cannot be created
6102 EAPI Evas_GL_API *elm_glview_gl_api_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6105 * Set the mode of the GLView. Supports Three simple modes.
6107 * @param obj The glview object
6108 * @param mode The mode Options OR'ed enabling Alpha, Depth, Stencil.
6109 * @return True if set properly.
6113 EAPI Eina_Bool elm_glview_mode_set(Evas_Object *obj, Elm_GLView_Mode mode) EINA_ARG_NONNULL(1);
6116 * Set the resize policy for the glview object.
6118 * @param obj The glview object.
6119 * @param policy The scaling policy.
6121 * By default, the resize policy is set to
6122 * ELM_GLVIEW_RESIZE_POLICY_RECREATE. When resize is called it
6123 * destroys the previous surface and recreates the newly specified
6124 * size. If the policy is set to ELM_GLVIEW_RESIZE_POLICY_SCALE,
6125 * however, glview only scales the image object and not the underlying
6130 EAPI Eina_Bool elm_glview_resize_policy_set(Evas_Object *obj, Elm_GLView_Resize_Policy policy) EINA_ARG_NONNULL(1);
6133 * Set the render policy for the glview object.
6135 * @param obj The glview object.
6136 * @param policy The render policy.
6138 * By default, the render policy is set to
6139 * ELM_GLVIEW_RENDER_POLICY_ON_DEMAND. This policy is set such
6140 * that during the render loop, glview is only redrawn if it needs
6141 * to be redrawn. (i.e. When it is visible) If the policy is set to
6142 * ELM_GLVIEWW_RENDER_POLICY_ALWAYS, it redraws regardless of
6143 * whether it is visible/need redrawing or not.
6147 EAPI Eina_Bool elm_glview_render_policy_set(Evas_Object *obj, Elm_GLView_Render_Policy policy) EINA_ARG_NONNULL(1);
6150 * Set the init function that runs once in the main loop.
6152 * @param obj The glview object.
6153 * @param func The init function to be registered.
6155 * The registered init function gets called once during the render loop.
6159 EAPI void elm_glview_init_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
6162 * Set the render function that runs in the main loop.
6164 * @param obj The glview object.
6165 * @param func The delete function to be registered.
6167 * The registered del function gets called when GLView object is deleted.
6171 EAPI void elm_glview_del_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
6174 * Set the resize function that gets called when resize happens.
6176 * @param obj The glview object.
6177 * @param func The resize function to be registered.
6181 EAPI void elm_glview_resize_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
6184 * Set the render function that runs in the main loop.
6186 * @param obj The glview object.
6187 * @param func The render function to be registered.
6191 EAPI void elm_glview_render_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
6194 * Notifies that there has been changes in the GLView.
6196 * @param obj The glview object.
6200 EAPI void elm_glview_changed_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
6210 * @image html img/widget/box/preview-00.png
6211 * @image latex img/widget/box/preview-00.eps width=\textwidth
6213 * @image html img/box.png
6214 * @image latex img/box.eps width=\textwidth
6216 * A box arranges objects in a linear fashion, governed by a layout function
6217 * that defines the details of this arrangement.
6219 * By default, the box will use an internal function to set the layout to
6220 * a single row, either vertical or horizontal. This layout is affected
6221 * by a number of parameters, such as the homogeneous flag set by
6222 * elm_box_homogeneous_set(), the values given by elm_box_padding_set() and
6223 * elm_box_align_set() and the hints set to each object in the box.
6225 * For this default layout, it's possible to change the orientation with
6226 * elm_box_horizontal_set(). The box will start in the vertical orientation,
6227 * placing its elements ordered from top to bottom. When horizontal is set,
6228 * the order will go from left to right. If the box is set to be
6229 * homogeneous, every object in it will be assigned the same space, that
6230 * of the largest object. Padding can be used to set some spacing between
6231 * the cell given to each object. The alignment of the box, set with
6232 * elm_box_align_set(), determines how the bounding box of all the elements
6233 * will be placed within the space given to the box widget itself.
6235 * The size hints of each object also affect how they are placed and sized
6236 * within the box. evas_object_size_hint_min_set() will give the minimum
6237 * size the object can have, and the box will use it as the basis for all
6238 * latter calculations. Elementary widgets set their own minimum size as
6239 * needed, so there's rarely any need to use it manually.
6241 * evas_object_size_hint_weight_set(), when not in homogeneous mode, is
6242 * used to tell whether the object will be allocated the minimum size it
6243 * needs or if the space given to it should be expanded. It's important
6244 * to realize that expanding the size given to the object is not the same
6245 * thing as resizing the object. It could very well end being a small
6246 * widget floating in a much larger empty space. If not set, the weight
6247 * for objects will normally be 0.0 for both axis, meaning the widget will
6248 * not be expanded. To take as much space possible, set the weight to
6249 * EVAS_HINT_EXPAND (defined to 1.0) for the desired axis to expand.
6251 * Besides how much space each object is allocated, it's possible to control
6252 * how the widget will be placed within that space using
6253 * evas_object_size_hint_align_set(). By default, this value will be 0.5
6254 * for both axis, meaning the object will be centered, but any value from
6255 * 0.0 (left or top, for the @c x and @c y axis, respectively) to 1.0
6256 * (right or bottom) can be used. The special value EVAS_HINT_FILL, which
6257 * is -1.0, means the object will be resized to fill the entire space it
6260 * In addition, customized functions to define the layout can be set, which
6261 * allow the application developer to organize the objects within the box
6262 * in any number of ways.
6264 * The special elm_box_layout_transition() function can be used
6265 * to switch from one layout to another, animating the motion of the
6266 * children of the box.
6268 * @note Objects should not be added to box objects using _add() calls.
6270 * Some examples on how to use boxes follow:
6271 * @li @ref box_example_01
6272 * @li @ref box_example_02
6277 * @typedef Elm_Box_Transition
6279 * Opaque handler containing the parameters to perform an animated
6280 * transition of the layout the box uses.
6282 * @see elm_box_transition_new()
6283 * @see elm_box_layout_set()
6284 * @see elm_box_layout_transition()
6286 typedef struct _Elm_Box_Transition Elm_Box_Transition;
6289 * Add a new box to the parent
6291 * By default, the box will be in vertical mode and non-homogeneous.
6293 * @param parent The parent object
6294 * @return The new object or NULL if it cannot be created
6296 EAPI Evas_Object *elm_box_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6299 * Set the horizontal orientation
6301 * By default, box object arranges their contents vertically from top to
6303 * By calling this function with @p horizontal as EINA_TRUE, the box will
6304 * become horizontal, arranging contents from left to right.
6306 * @note This flag is ignored if a custom layout function is set.
6308 * @param obj The box object
6309 * @param horizontal The horizontal flag (EINA_TRUE = horizontal,
6310 * EINA_FALSE = vertical)
6312 EAPI void elm_box_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
6315 * Get the horizontal orientation
6317 * @param obj The box object
6318 * @return EINA_TRUE if the box is set to horizontal mode, EINA_FALSE otherwise
6320 EAPI Eina_Bool elm_box_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6323 * Set the box to arrange its children homogeneously
6325 * If enabled, homogeneous layout makes all items the same size, according
6326 * to the size of the largest of its children.
6328 * @note This flag is ignored if a custom layout function is set.
6330 * @param obj The box object
6331 * @param homogeneous The homogeneous flag
6333 EAPI void elm_box_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
6336 * Get whether the box is using homogeneous mode or not
6338 * @param obj The box object
6339 * @return EINA_TRUE if it's homogeneous, EINA_FALSE otherwise
6341 EAPI Eina_Bool elm_box_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6344 * Add an object to the beginning of the pack list
6346 * Pack @p subobj into the box @p obj, placing it first in the list of
6347 * children objects. The actual position the object will get on screen
6348 * depends on the layout used. If no custom layout is set, it will be at
6349 * the top or left, depending if the box is vertical or horizontal,
6352 * @param obj The box object
6353 * @param subobj The object to add to the box
6355 * @see elm_box_pack_end()
6356 * @see elm_box_pack_before()
6357 * @see elm_box_pack_after()
6358 * @see elm_box_unpack()
6359 * @see elm_box_unpack_all()
6360 * @see elm_box_clear()
6362 EAPI void elm_box_pack_start(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
6365 * Add an object at the end of the pack list
6367 * Pack @p subobj into the box @p obj, placing it last in the list of
6368 * children objects. The actual position the object will get on screen
6369 * depends on the layout used. If no custom layout is set, it will be at
6370 * the bottom or right, depending if the box is vertical or horizontal,
6373 * @param obj The box object
6374 * @param subobj The object to add to the box
6376 * @see elm_box_pack_start()
6377 * @see elm_box_pack_before()
6378 * @see elm_box_pack_after()
6379 * @see elm_box_unpack()
6380 * @see elm_box_unpack_all()
6381 * @see elm_box_clear()
6383 EAPI void elm_box_pack_end(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
6386 * Adds an object to the box before the indicated object
6388 * This will add the @p subobj to the box indicated before the object
6389 * indicated with @p before. If @p before is not already in the box, results
6390 * are undefined. Before means either to the left of the indicated object or
6391 * above it depending on orientation.
6393 * @param obj The box object
6394 * @param subobj The object to add to the box
6395 * @param before The object before which to add it
6397 * @see elm_box_pack_start()
6398 * @see elm_box_pack_end()
6399 * @see elm_box_pack_after()
6400 * @see elm_box_unpack()
6401 * @see elm_box_unpack_all()
6402 * @see elm_box_clear()
6404 EAPI void elm_box_pack_before(Evas_Object *obj, Evas_Object *subobj, Evas_Object *before) EINA_ARG_NONNULL(1);
6407 * Adds an object to the box after the indicated object
6409 * This will add the @p subobj to the box indicated after the object
6410 * indicated with @p after. If @p after is not already in the box, results
6411 * are undefined. After means either to the right of the indicated object or
6412 * below it depending on orientation.
6414 * @param obj The box object
6415 * @param subobj The object to add to the box
6416 * @param after The object after which to add it
6418 * @see elm_box_pack_start()
6419 * @see elm_box_pack_end()
6420 * @see elm_box_pack_before()
6421 * @see elm_box_unpack()
6422 * @see elm_box_unpack_all()
6423 * @see elm_box_clear()
6425 EAPI void elm_box_pack_after(Evas_Object *obj, Evas_Object *subobj, Evas_Object *after) EINA_ARG_NONNULL(1);
6428 * Clear the box of all children
6430 * Remove all the elements contained by the box, deleting the respective
6433 * @param obj The box object
6435 * @see elm_box_unpack()
6436 * @see elm_box_unpack_all()
6438 EAPI void elm_box_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
6443 * Remove the object given by @p subobj from the box @p obj without
6446 * @param obj The box object
6448 * @see elm_box_unpack_all()
6449 * @see elm_box_clear()
6451 EAPI void elm_box_unpack(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
6454 * Remove all items from the box, without deleting them
6456 * Clear the box from all children, but don't delete the respective objects.
6457 * If no other references of the box children exist, the objects will never
6458 * be deleted, and thus the application will leak the memory. Make sure
6459 * when using this function that you hold a reference to all the objects
6460 * in the box @p obj.
6462 * @param obj The box object
6464 * @see elm_box_clear()
6465 * @see elm_box_unpack()
6467 EAPI void elm_box_unpack_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
6470 * Retrieve a list of the objects packed into the box
6472 * Returns a new @c Eina_List with a pointer to @c Evas_Object in its nodes.
6473 * The order of the list corresponds to the packing order the box uses.
6475 * You must free this list with eina_list_free() once you are done with it.
6477 * @param obj The box object
6479 EAPI const Eina_List *elm_box_children_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6482 * Set the space (padding) between the box's elements.
6484 * Extra space in pixels that will be added between a box child and its
6485 * neighbors after its containing cell has been calculated. This padding
6486 * is set for all elements in the box, besides any possible padding that
6487 * individual elements may have through their size hints.
6489 * @param obj The box object
6490 * @param horizontal The horizontal space between elements
6491 * @param vertical The vertical space between elements
6493 EAPI void elm_box_padding_set(Evas_Object *obj, Evas_Coord horizontal, Evas_Coord vertical) EINA_ARG_NONNULL(1);
6496 * Get the space (padding) between the box's elements.
6498 * @param obj The box object
6499 * @param horizontal The horizontal space between elements
6500 * @param vertical The vertical space between elements
6502 * @see elm_box_padding_set()
6504 EAPI void elm_box_padding_get(const Evas_Object *obj, Evas_Coord *horizontal, Evas_Coord *vertical) EINA_ARG_NONNULL(1);
6507 * Set the alignment of the whole bouding box of contents.
6509 * Sets how the bounding box containing all the elements of the box, after
6510 * their sizes and position has been calculated, will be aligned within
6511 * the space given for the whole box widget.
6513 * @param obj The box object
6514 * @param horizontal The horizontal alignment of elements
6515 * @param vertical The vertical alignment of elements
6517 EAPI void elm_box_align_set(Evas_Object *obj, double horizontal, double vertical) EINA_ARG_NONNULL(1);
6520 * Get the alignment of the whole bouding box of contents.
6522 * @param obj The box object
6523 * @param horizontal The horizontal alignment of elements
6524 * @param vertical The vertical alignment of elements
6526 * @see elm_box_align_set()
6528 EAPI void elm_box_align_get(const Evas_Object *obj, double *horizontal, double *vertical) EINA_ARG_NONNULL(1);
6531 * Force the box to recalculate its children packing.
6533 * If any children was added or removed, box will not calculate the
6534 * values immediately rather leaving it to the next main loop
6535 * iteration. While this is great as it would save lots of
6536 * recalculation, whenever you need to get the position of a just
6537 * added item you must force recalculate before doing so.
6539 * @param obj The box object.
6541 EAPI void elm_box_recalculate(Evas_Object *obj);
6544 * Set the layout defining function to be used by the box
6546 * Whenever anything changes that requires the box in @p obj to recalculate
6547 * the size and position of its elements, the function @p cb will be called
6548 * to determine what the layout of the children will be.
6550 * Once a custom function is set, everything about the children layout
6551 * is defined by it. The flags set by elm_box_horizontal_set() and
6552 * elm_box_homogeneous_set() no longer have any meaning, and the values
6553 * given by elm_box_padding_set() and elm_box_align_set() are up to this
6554 * layout function to decide if they are used and how. These last two
6555 * will be found in the @c priv parameter, of type @c Evas_Object_Box_Data,
6556 * passed to @p cb. The @c Evas_Object the function receives is not the
6557 * Elementary widget, but the internal Evas Box it uses, so none of the
6558 * functions described here can be used on it.
6560 * Any of the layout functions in @c Evas can be used here, as well as the
6561 * special elm_box_layout_transition().
6563 * The final @p data argument received by @p cb is the same @p data passed
6564 * here, and the @p free_data function will be called to free it
6565 * whenever the box is destroyed or another layout function is set.
6567 * Setting @p cb to NULL will revert back to the default layout function.
6569 * @param obj The box object
6570 * @param cb The callback function used for layout
6571 * @param data Data that will be passed to layout function
6572 * @param free_data Function called to free @p data
6574 * @see elm_box_layout_transition()
6576 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);
6579 * Special layout function that animates the transition from one layout to another
6581 * Normally, when switching the layout function for a box, this will be
6582 * reflected immediately on screen on the next render, but it's also
6583 * possible to do this through an animated transition.
6585 * This is done by creating an ::Elm_Box_Transition and setting the box
6586 * layout to this function.
6590 * Elm_Box_Transition *t = elm_box_transition_new(1.0,
6591 * evas_object_box_layout_vertical, // start
6592 * NULL, // data for initial layout
6593 * NULL, // free function for initial data
6594 * evas_object_box_layout_horizontal, // end
6595 * NULL, // data for final layout
6596 * NULL, // free function for final data
6597 * anim_end, // will be called when animation ends
6598 * NULL); // data for anim_end function\
6599 * elm_box_layout_set(box, elm_box_layout_transition, t,
6600 * elm_box_transition_free);
6603 * @note This function can only be used with elm_box_layout_set(). Calling
6604 * it directly will not have the expected results.
6606 * @see elm_box_transition_new
6607 * @see elm_box_transition_free
6608 * @see elm_box_layout_set
6610 EAPI void elm_box_layout_transition(Evas_Object *obj, Evas_Object_Box_Data *priv, void *data);
6613 * Create a new ::Elm_Box_Transition to animate the switch of layouts
6615 * If you want to animate the change from one layout to another, you need
6616 * to set the layout function of the box to elm_box_layout_transition(),
6617 * passing as user data to it an instance of ::Elm_Box_Transition with the
6618 * necessary information to perform this animation. The free function to
6619 * set for the layout is elm_box_transition_free().
6621 * The parameters to create an ::Elm_Box_Transition sum up to how long
6622 * will it be, in seconds, a layout function to describe the initial point,
6623 * another for the final position of the children and one function to be
6624 * called when the whole animation ends. This last function is useful to
6625 * set the definitive layout for the box, usually the same as the end
6626 * layout for the animation, but could be used to start another transition.
6628 * @param start_layout The layout function that will be used to start the animation
6629 * @param start_layout_data The data to be passed the @p start_layout function
6630 * @param start_layout_free_data Function to free @p start_layout_data
6631 * @param end_layout The layout function that will be used to end the animation
6632 * @param end_layout_free_data The data to be passed the @p end_layout function
6633 * @param end_layout_free_data Function to free @p end_layout_data
6634 * @param transition_end_cb Callback function called when animation ends
6635 * @param transition_end_data Data to be passed to @p transition_end_cb
6636 * @return An instance of ::Elm_Box_Transition
6638 * @see elm_box_transition_new
6639 * @see elm_box_layout_transition
6641 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);
6644 * Free a Elm_Box_Transition instance created with elm_box_transition_new().
6646 * This function is mostly useful as the @c free_data parameter in
6647 * elm_box_layout_set() when elm_box_layout_transition().
6649 * @param data The Elm_Box_Transition instance to be freed.
6651 * @see elm_box_transition_new
6652 * @see elm_box_layout_transition
6654 EAPI void elm_box_transition_free(void *data);
6662 * @defgroup Button Button
6664 * @image html img/widget/button/preview-00.png
6665 * @image latex img/widget/button/preview-00.eps
6666 * @image html img/widget/button/preview-01.png
6667 * @image latex img/widget/button/preview-01.eps
6668 * @image html img/widget/button/preview-02.png
6669 * @image latex img/widget/button/preview-02.eps
6671 * This is a push-button. Press it and run some function. It can contain
6672 * a simple label and icon object and it also has an autorepeat feature.
6674 * This widgets emits the following signals:
6675 * @li "clicked": the user clicked the button (press/release).
6676 * @li "repeated": the user pressed the button without releasing it.
6677 * @li "pressed": button was pressed.
6678 * @li "unpressed": button was released after being pressed.
6679 * In all three cases, the @c event parameter of the callback will be
6682 * Also, defined in the default theme, the button has the following styles
6684 * @li default: a normal button.
6685 * @li anchor: Like default, but the button fades away when the mouse is not
6686 * over it, leaving only the text or icon.
6687 * @li hoversel_vertical: Internally used by @ref Hoversel to give a
6688 * continuous look across its options.
6689 * @li hoversel_vertical_entry: Another internal for @ref Hoversel.
6691 * Default contents parts of the button widget that you can use for are:
6692 * @li "icon" - An icon of the button
6694 * Default text parts of the button widget that you can use for are:
6695 * @li "default" - Label of the button
6697 * Follow through a complete example @ref button_example_01 "here".
6702 * Add a new button to the parent's canvas
6704 * @param parent The parent object
6705 * @return The new object or NULL if it cannot be created
6707 EAPI Evas_Object *elm_button_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6710 * Set the label used in the button
6712 * The passed @p label can be NULL to clean any existing text in it and
6713 * leave the button as an icon only object.
6715 * @param obj The button object
6716 * @param label The text will be written on the button
6717 * @deprecated use elm_object_text_set() instead.
6719 EINA_DEPRECATED EAPI void elm_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
6722 * Get the label set for the button
6724 * The string returned is an internal pointer and should not be freed or
6725 * altered. It will also become invalid when the button is destroyed.
6726 * The string returned, if not NULL, is a stringshare, so if you need to
6727 * keep it around even after the button is destroyed, you can use
6728 * eina_stringshare_ref().
6730 * @param obj The button object
6731 * @return The text set to the label, or NULL if nothing is set
6732 * @deprecated use elm_object_text_set() instead.
6734 EINA_DEPRECATED EAPI const char *elm_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6737 * Set the icon used for the button
6739 * Setting a new icon will delete any other that was previously set, making
6740 * any reference to them invalid. If you need to maintain the previous
6741 * object alive, unset it first with elm_button_icon_unset().
6743 * @param obj The button object
6744 * @param icon The icon object for the button
6745 * @deprecated use elm_object_part_content_set() instead.
6747 EINA_DEPRECATED EAPI void elm_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
6750 * Get the icon used for the button
6752 * Return the icon object which is set for this widget. If the button is
6753 * destroyed or another icon is set, the returned object will be deleted
6754 * and any reference to it will be invalid.
6756 * @param obj The button object
6757 * @return The icon object that is being used
6759 * @deprecated use elm_object_part_content_get() instead
6761 EINA_DEPRECATED EAPI Evas_Object *elm_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6764 * Remove the icon set without deleting it and return the object
6766 * This function drops the reference the button holds of the icon object
6767 * and returns this last object. It is used in case you want to remove any
6768 * icon, or set another one, without deleting the actual object. The button
6769 * will be left without an icon set.
6771 * @param obj The button object
6772 * @return The icon object that was being used
6773 * @deprecated use elm_object_part_content_unset() instead.
6775 EINA_DEPRECATED EAPI Evas_Object *elm_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6778 * Turn on/off the autorepeat event generated when the button is kept pressed
6780 * When off, no autorepeat is performed and buttons emit a normal @c clicked
6781 * signal when they are clicked.
6783 * When on, keeping a button pressed will continuously emit a @c repeated
6784 * signal until the button is released. The time it takes until it starts
6785 * emitting the signal is given by
6786 * elm_button_autorepeat_initial_timeout_set(), and the time between each
6787 * new emission by elm_button_autorepeat_gap_timeout_set().
6789 * @param obj The button object
6790 * @param on A bool to turn on/off the event
6792 EAPI void elm_button_autorepeat_set(Evas_Object *obj, Eina_Bool on) EINA_ARG_NONNULL(1);
6795 * Get whether the autorepeat feature is enabled
6797 * @param obj The button object
6798 * @return EINA_TRUE if autorepeat is on, EINA_FALSE otherwise
6800 * @see elm_button_autorepeat_set()
6802 EAPI Eina_Bool elm_button_autorepeat_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6805 * Set the initial timeout before the autorepeat event is generated
6807 * Sets the timeout, in seconds, since the button is pressed until the
6808 * first @c repeated signal is emitted. If @p t is 0.0 or less, there
6809 * won't be any delay and the even will be fired the moment the button is
6812 * @param obj The button object
6813 * @param t Timeout in seconds
6815 * @see elm_button_autorepeat_set()
6816 * @see elm_button_autorepeat_gap_timeout_set()
6818 EAPI void elm_button_autorepeat_initial_timeout_set(Evas_Object *obj, double t) EINA_ARG_NONNULL(1);
6821 * Get the initial timeout before the autorepeat event is generated
6823 * @param obj The button object
6824 * @return Timeout in seconds
6826 * @see elm_button_autorepeat_initial_timeout_set()
6828 EAPI double elm_button_autorepeat_initial_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6831 * Set the interval between each generated autorepeat event
6833 * After the first @c repeated event is fired, all subsequent ones will
6834 * follow after a delay of @p t seconds for each.
6836 * @param obj The button object
6837 * @param t Interval in seconds
6839 * @see elm_button_autorepeat_initial_timeout_set()
6841 EAPI void elm_button_autorepeat_gap_timeout_set(Evas_Object *obj, double t) EINA_ARG_NONNULL(1);
6844 * Get the interval between each generated autorepeat event
6846 * @param obj The button object
6847 * @return Interval in seconds
6849 EAPI double elm_button_autorepeat_gap_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6856 * @defgroup File_Selector_Button File Selector Button
6858 * @image html img/widget/fileselector_button/preview-00.png
6859 * @image latex img/widget/fileselector_button/preview-00.eps
6860 * @image html img/widget/fileselector_button/preview-01.png
6861 * @image latex img/widget/fileselector_button/preview-01.eps
6862 * @image html img/widget/fileselector_button/preview-02.png
6863 * @image latex img/widget/fileselector_button/preview-02.eps
6865 * This is a button that, when clicked, creates an Elementary
6866 * window (or inner window) <b> with a @ref Fileselector "file
6867 * selector widget" within</b>. When a file is chosen, the (inner)
6868 * window is closed and the button emits a signal having the
6869 * selected file as it's @c event_info.
6871 * This widget encapsulates operations on its internal file
6872 * selector on its own API. There is less control over its file
6873 * selector than that one would have instatiating one directly.
6875 * The following styles are available for this button:
6878 * @li @c "hoversel_vertical"
6879 * @li @c "hoversel_vertical_entry"
6881 * Smart callbacks one can register to:
6882 * - @c "file,chosen" - the user has selected a path, whose string
6883 * pointer comes as the @c event_info data (a stringshared
6886 * Here is an example on its usage:
6887 * @li @ref fileselector_button_example
6889 * @see @ref File_Selector_Entry for a similar widget.
6894 * Add a new file selector button widget to the given parent
6895 * Elementary (container) object
6897 * @param parent The parent object
6898 * @return a new file selector button widget handle or @c NULL, on
6901 EAPI Evas_Object *elm_fileselector_button_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6904 * Set the label for a given file selector button widget
6906 * @param obj The file selector button widget
6907 * @param label The text label to be displayed on @p obj
6909 * @deprecated use elm_object_text_set() instead.
6911 EINA_DEPRECATED EAPI void elm_fileselector_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
6914 * Get the label set for a given file selector button widget
6916 * @param obj The file selector button widget
6917 * @return The button label
6919 * @deprecated use elm_object_text_set() instead.
6921 EINA_DEPRECATED EAPI const char *elm_fileselector_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6924 * Set the icon on a given file selector button widget
6926 * @param obj The file selector button widget
6927 * @param icon The icon object for the button
6929 * Once the icon object is set, a previously set one will be
6930 * deleted. If you want to keep the latter, use the
6931 * elm_fileselector_button_icon_unset() function.
6933 * @see elm_fileselector_button_icon_get()
6935 EAPI void elm_fileselector_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
6938 * Get the icon set for a given file selector button widget
6940 * @param obj The file selector button widget
6941 * @return The icon object currently set on @p obj or @c NULL, if
6944 * @see elm_fileselector_button_icon_set()
6946 EAPI Evas_Object *elm_fileselector_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6949 * Unset the icon used in a given file selector button widget
6951 * @param obj The file selector button widget
6952 * @return The icon object that was being used on @p obj or @c
6955 * Unparent and return the icon object which was set for this
6958 * @see elm_fileselector_button_icon_set()
6960 EAPI Evas_Object *elm_fileselector_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6963 * Set the title for a given file selector button widget's window
6965 * @param obj The file selector button widget
6966 * @param title The title string
6968 * This will change the window's title, when the file selector pops
6969 * out after a click on the button. Those windows have the default
6970 * (unlocalized) value of @c "Select a file" as titles.
6972 * @note It will only take any effect if the file selector
6973 * button widget is @b not under "inwin mode".
6975 * @see elm_fileselector_button_window_title_get()
6977 EAPI void elm_fileselector_button_window_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
6980 * Get the title set for a given file selector button widget's
6983 * @param obj The file selector button widget
6984 * @return Title of the file selector button's window
6986 * @see elm_fileselector_button_window_title_get() for more details
6988 EAPI const char *elm_fileselector_button_window_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6991 * Set the size of a given file selector button widget's window,
6992 * holding the file selector itself.
6994 * @param obj The file selector button widget
6995 * @param width The window's width
6996 * @param height The window's height
6998 * @note it will only take any effect if the file selector button
6999 * widget is @b not under "inwin mode". The default size for the
7000 * window (when applicable) is 400x400 pixels.
7002 * @see elm_fileselector_button_window_size_get()
7004 EAPI void elm_fileselector_button_window_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
7007 * Get the size of a given file selector button widget's window,
7008 * holding the file selector itself.
7010 * @param obj The file selector button widget
7011 * @param width Pointer into which to store the width value
7012 * @param height Pointer into which to store the height value
7014 * @note Use @c NULL pointers on the size values you're not
7015 * interested in: they'll be ignored by the function.
7017 * @see elm_fileselector_button_window_size_set(), for more details
7019 EAPI void elm_fileselector_button_window_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
7022 * Set the initial file system path for a given file selector
7025 * @param obj The file selector button widget
7026 * @param path The path string
7028 * It must be a <b>directory</b> path, which will have the contents
7029 * displayed initially in the file selector's view, when invoked
7030 * from @p obj. The default initial path is the @c "HOME"
7031 * environment variable's value.
7033 * @see elm_fileselector_button_path_get()
7035 EAPI void elm_fileselector_button_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
7038 * Get the initial file system path set for a given file selector
7041 * @param obj The file selector button widget
7042 * @return path The path string
7044 * @see elm_fileselector_button_path_set() for more details
7046 EAPI const char *elm_fileselector_button_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7049 * Enable/disable a tree view in the given file selector button
7050 * widget's internal file selector
7052 * @param obj The file selector button widget
7053 * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
7056 * This has the same effect as elm_fileselector_expandable_set(),
7057 * but now applied to a file selector button's internal file
7060 * @note There's no way to put a file selector button's internal
7061 * file selector in "grid mode", as one may do with "pure" file
7064 * @see elm_fileselector_expandable_get()
7066 EAPI void elm_fileselector_button_expandable_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
7069 * Get whether tree view is enabled for the given file selector
7070 * button widget's internal file selector
7072 * @param obj The file selector button widget
7073 * @return @c EINA_TRUE if @p obj widget's internal file selector
7074 * is in tree view, @c EINA_FALSE otherwise (and or errors)
7076 * @see elm_fileselector_expandable_set() for more details
7078 EAPI Eina_Bool elm_fileselector_button_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7081 * Set whether a given file selector button widget's internal file
7082 * selector is to display folders only or the directory contents,
7085 * @param obj The file selector button widget
7086 * @param only @c EINA_TRUE to make @p obj widget's internal file
7087 * selector only display directories, @c EINA_FALSE to make files
7088 * to be displayed in it too
7090 * This has the same effect as elm_fileselector_folder_only_set(),
7091 * but now applied to a file selector button's internal file
7094 * @see elm_fileselector_folder_only_get()
7096 EAPI void elm_fileselector_button_folder_only_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
7099 * Get whether a given file selector button widget's internal file
7100 * selector is displaying folders only or the directory contents,
7103 * @param obj The file selector button widget
7104 * @return @c EINA_TRUE if @p obj widget's internal file
7105 * selector is only displaying directories, @c EINA_FALSE if files
7106 * are being displayed in it too (and on errors)
7108 * @see elm_fileselector_button_folder_only_set() for more details
7110 EAPI Eina_Bool elm_fileselector_button_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7113 * Enable/disable the file name entry box where the user can type
7114 * in a name for a file, in a given file selector button widget's
7115 * internal file selector.
7117 * @param obj The file selector button widget
7118 * @param is_save @c EINA_TRUE to make @p obj widget's internal
7119 * file selector a "saving dialog", @c EINA_FALSE otherwise
7121 * This has the same effect as elm_fileselector_is_save_set(),
7122 * but now applied to a file selector button's internal file
7125 * @see elm_fileselector_is_save_get()
7127 EAPI void elm_fileselector_button_is_save_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
7130 * Get whether the given file selector button widget's internal
7131 * file selector is in "saving dialog" mode
7133 * @param obj The file selector button widget
7134 * @return @c EINA_TRUE, if @p obj widget's internal file selector
7135 * is in "saving dialog" mode, @c EINA_FALSE otherwise (and on
7138 * @see elm_fileselector_button_is_save_set() for more details
7140 EAPI Eina_Bool elm_fileselector_button_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7143 * Set whether a given file selector button widget's internal file
7144 * selector will raise an Elementary "inner window", instead of a
7145 * dedicated Elementary window. By default, it won't.
7147 * @param obj The file selector button widget
7148 * @param value @c EINA_TRUE to make it use an inner window, @c
7149 * EINA_TRUE to make it use a dedicated window
7151 * @see elm_win_inwin_add() for more information on inner windows
7152 * @see elm_fileselector_button_inwin_mode_get()
7154 EAPI void elm_fileselector_button_inwin_mode_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
7157 * Get whether a given file selector button widget's internal file
7158 * selector will raise an Elementary "inner window", instead of a
7159 * dedicated Elementary window.
7161 * @param obj The file selector button widget
7162 * @return @c EINA_TRUE if will use an inner window, @c EINA_TRUE
7163 * if it will use a dedicated window
7165 * @see elm_fileselector_button_inwin_mode_set() for more details
7167 EAPI Eina_Bool elm_fileselector_button_inwin_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7174 * @defgroup File_Selector_Entry File Selector Entry
7176 * @image html img/widget/fileselector_entry/preview-00.png
7177 * @image latex img/widget/fileselector_entry/preview-00.eps
7179 * This is an entry made to be filled with or display a <b>file
7180 * system path string</b>. Besides the entry itself, the widget has
7181 * a @ref File_Selector_Button "file selector button" on its side,
7182 * which will raise an internal @ref Fileselector "file selector widget",
7183 * when clicked, for path selection aided by file system
7186 * This file selector may appear in an Elementary window or in an
7187 * inner window. When a file is chosen from it, the (inner) window
7188 * is closed and the selected file's path string is exposed both as
7189 * an smart event and as the new text on the entry.
7191 * This widget encapsulates operations on its internal file
7192 * selector on its own API. There is less control over its file
7193 * selector than that one would have instatiating one directly.
7195 * Smart callbacks one can register to:
7196 * - @c "changed" - The text within the entry was changed
7197 * - @c "activated" - The entry has had editing finished and
7198 * changes are to be "committed"
7199 * - @c "press" - The entry has been clicked
7200 * - @c "longpressed" - The entry has been clicked (and held) for a
7202 * - @c "clicked" - The entry has been clicked
7203 * - @c "clicked,double" - The entry has been double clicked
7204 * - @c "focused" - The entry has received focus
7205 * - @c "unfocused" - The entry has lost focus
7206 * - @c "selection,paste" - A paste action has occurred on the
7208 * - @c "selection,copy" - A copy action has occurred on the entry
7209 * - @c "selection,cut" - A cut action has occurred on the entry
7210 * - @c "unpressed" - The file selector entry's button was released
7211 * after being pressed.
7212 * - @c "file,chosen" - The user has selected a path via the file
7213 * selector entry's internal file selector, whose string pointer
7214 * comes as the @c event_info data (a stringshared string)
7216 * Here is an example on its usage:
7217 * @li @ref fileselector_entry_example
7219 * @see @ref File_Selector_Button for a similar widget.
7224 * Add a new file selector entry widget to the given parent
7225 * Elementary (container) object
7227 * @param parent The parent object
7228 * @return a new file selector entry widget handle or @c NULL, on
7231 EAPI Evas_Object *elm_fileselector_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7234 * Set the label for a given file selector entry widget's button
7236 * @param obj The file selector entry widget
7237 * @param label The text label to be displayed on @p obj widget's
7240 * @deprecated use elm_object_text_set() instead.
7242 EINA_DEPRECATED EAPI void elm_fileselector_entry_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
7245 * Get the label set for a given file selector entry widget's button
7247 * @param obj The file selector entry widget
7248 * @return The widget button's label
7250 * @deprecated use elm_object_text_set() instead.
7252 EINA_DEPRECATED EAPI const char *elm_fileselector_entry_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7255 * Set the icon on a given file selector entry widget's button
7257 * @param obj The file selector entry widget
7258 * @param icon The icon object for the entry's button
7260 * Once the icon object is set, a previously set one will be
7261 * deleted. If you want to keep the latter, use the
7262 * elm_fileselector_entry_button_icon_unset() function.
7264 * @see elm_fileselector_entry_button_icon_get()
7266 EAPI void elm_fileselector_entry_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
7269 * Get the icon set for a given file selector entry widget's button
7271 * @param obj The file selector entry widget
7272 * @return The icon object currently set on @p obj widget's button
7273 * or @c NULL, if none is
7275 * @see elm_fileselector_entry_button_icon_set()
7277 EAPI Evas_Object *elm_fileselector_entry_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7280 * Unset the icon used in a given file selector entry widget's
7283 * @param obj The file selector entry widget
7284 * @return The icon object that was being used on @p obj widget's
7285 * button or @c NULL, on errors
7287 * Unparent and return the icon object which was set for this
7290 * @see elm_fileselector_entry_button_icon_set()
7292 EAPI Evas_Object *elm_fileselector_entry_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
7295 * Set the title for a given file selector entry widget's window
7297 * @param obj The file selector entry widget
7298 * @param title The title string
7300 * This will change the window's title, when the file selector pops
7301 * out after a click on the entry's button. Those windows have the
7302 * default (unlocalized) value of @c "Select a file" as titles.
7304 * @note It will only take any effect if the file selector
7305 * entry widget is @b not under "inwin mode".
7307 * @see elm_fileselector_entry_window_title_get()
7309 EAPI void elm_fileselector_entry_window_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
7312 * Get the title set for a given file selector entry widget's
7315 * @param obj The file selector entry widget
7316 * @return Title of the file selector entry's window
7318 * @see elm_fileselector_entry_window_title_get() for more details
7320 EAPI const char *elm_fileselector_entry_window_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7323 * Set the size of a given file selector entry widget's window,
7324 * holding the file selector itself.
7326 * @param obj The file selector entry widget
7327 * @param width The window's width
7328 * @param height The window's height
7330 * @note it will only take any effect if the file selector entry
7331 * widget is @b not under "inwin mode". The default size for the
7332 * window (when applicable) is 400x400 pixels.
7334 * @see elm_fileselector_entry_window_size_get()
7336 EAPI void elm_fileselector_entry_window_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
7339 * Get the size of a given file selector entry widget's window,
7340 * holding the file selector itself.
7342 * @param obj The file selector entry widget
7343 * @param width Pointer into which to store the width value
7344 * @param height Pointer into which to store the height value
7346 * @note Use @c NULL pointers on the size values you're not
7347 * interested in: they'll be ignored by the function.
7349 * @see elm_fileselector_entry_window_size_set(), for more details
7351 EAPI void elm_fileselector_entry_window_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
7354 * Set the initial file system path and the entry's path string for
7355 * a given file selector entry widget
7357 * @param obj The file selector entry widget
7358 * @param path The path string
7360 * It must be a <b>directory</b> path, which will have the contents
7361 * displayed initially in the file selector's view, when invoked
7362 * from @p obj. The default initial path is the @c "HOME"
7363 * environment variable's value.
7365 * @see elm_fileselector_entry_path_get()
7367 EAPI void elm_fileselector_entry_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
7370 * Get the entry's path string for a given file selector entry
7373 * @param obj The file selector entry widget
7374 * @return path The path string
7376 * @see elm_fileselector_entry_path_set() for more details
7378 EAPI const char *elm_fileselector_entry_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7381 * Enable/disable a tree view in the given file selector entry
7382 * widget's internal file selector
7384 * @param obj The file selector entry widget
7385 * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
7388 * This has the same effect as elm_fileselector_expandable_set(),
7389 * but now applied to a file selector entry's internal file
7392 * @note There's no way to put a file selector entry's internal
7393 * file selector in "grid mode", as one may do with "pure" file
7396 * @see elm_fileselector_expandable_get()
7398 EAPI void elm_fileselector_entry_expandable_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
7401 * Get whether tree view is enabled for the given file selector
7402 * entry widget's internal file selector
7404 * @param obj The file selector entry widget
7405 * @return @c EINA_TRUE if @p obj widget's internal file selector
7406 * is in tree view, @c EINA_FALSE otherwise (and or errors)
7408 * @see elm_fileselector_expandable_set() for more details
7410 EAPI Eina_Bool elm_fileselector_entry_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7413 * Set whether a given file selector entry widget's internal file
7414 * selector is to display folders only or the directory contents,
7417 * @param obj The file selector entry widget
7418 * @param only @c EINA_TRUE to make @p obj widget's internal file
7419 * selector only display directories, @c EINA_FALSE to make files
7420 * to be displayed in it too
7422 * This has the same effect as elm_fileselector_folder_only_set(),
7423 * but now applied to a file selector entry's internal file
7426 * @see elm_fileselector_folder_only_get()
7428 EAPI void elm_fileselector_entry_folder_only_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
7431 * Get whether a given file selector entry widget's internal file
7432 * selector is displaying folders only or the directory contents,
7435 * @param obj The file selector entry widget
7436 * @return @c EINA_TRUE if @p obj widget's internal file
7437 * selector is only displaying directories, @c EINA_FALSE if files
7438 * are being displayed in it too (and on errors)
7440 * @see elm_fileselector_entry_folder_only_set() for more details
7442 EAPI Eina_Bool elm_fileselector_entry_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7445 * Enable/disable the file name entry box where the user can type
7446 * in a name for a file, in a given file selector entry widget's
7447 * internal file selector.
7449 * @param obj The file selector entry widget
7450 * @param is_save @c EINA_TRUE to make @p obj widget's internal
7451 * file selector a "saving dialog", @c EINA_FALSE otherwise
7453 * This has the same effect as elm_fileselector_is_save_set(),
7454 * but now applied to a file selector entry's internal file
7457 * @see elm_fileselector_is_save_get()
7459 EAPI void elm_fileselector_entry_is_save_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
7462 * Get whether the given file selector entry widget's internal
7463 * file selector is in "saving dialog" mode
7465 * @param obj The file selector entry widget
7466 * @return @c EINA_TRUE, if @p obj widget's internal file selector
7467 * is in "saving dialog" mode, @c EINA_FALSE otherwise (and on
7470 * @see elm_fileselector_entry_is_save_set() for more details
7472 EAPI Eina_Bool elm_fileselector_entry_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7475 * Set whether a given file selector entry widget's internal file
7476 * selector will raise an Elementary "inner window", instead of a
7477 * dedicated Elementary window. By default, it won't.
7479 * @param obj The file selector entry widget
7480 * @param value @c EINA_TRUE to make it use an inner window, @c
7481 * EINA_TRUE to make it use a dedicated window
7483 * @see elm_win_inwin_add() for more information on inner windows
7484 * @see elm_fileselector_entry_inwin_mode_get()
7486 EAPI void elm_fileselector_entry_inwin_mode_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
7489 * Get whether a given file selector entry widget's internal file
7490 * selector will raise an Elementary "inner window", instead of a
7491 * dedicated Elementary window.
7493 * @param obj The file selector entry widget
7494 * @return @c EINA_TRUE if will use an inner window, @c EINA_TRUE
7495 * if it will use a dedicated window
7497 * @see elm_fileselector_entry_inwin_mode_set() for more details
7499 EAPI Eina_Bool elm_fileselector_entry_inwin_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7502 * Set the initial file system path for a given file selector entry
7505 * @param obj The file selector entry widget
7506 * @param path The path string
7508 * It must be a <b>directory</b> path, which will have the contents
7509 * displayed initially in the file selector's view, when invoked
7510 * from @p obj. The default initial path is the @c "HOME"
7511 * environment variable's value.
7513 * @see elm_fileselector_entry_path_get()
7515 EAPI void elm_fileselector_entry_selected_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
7518 * Get the parent directory's path to the latest file selection on
7519 * a given filer selector entry widget
7521 * @param obj The file selector object
7522 * @return The (full) path of the directory of the last selection
7523 * on @p obj widget, a @b stringshared string
7525 * @see elm_fileselector_entry_path_set()
7527 EAPI const char *elm_fileselector_entry_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7534 * @defgroup Scroller Scroller
7536 * A scroller holds a single object and "scrolls it around". This means that
7537 * it allows the user to use a scrollbar (or a finger) to drag the viewable
7538 * region around, allowing to move through a much larger object that is
7539 * contained in the scroller. The scroller will always have a small minimum
7540 * size by default as it won't be limited by the contents of the scroller.
7542 * Signals that you can add callbacks for are:
7543 * @li "edge,left" - the left edge of the content has been reached
7544 * @li "edge,right" - the right edge of the content has been reached
7545 * @li "edge,top" - the top edge of the content has been reached
7546 * @li "edge,bottom" - the bottom edge of the content has been reached
7547 * @li "scroll" - the content has been scrolled (moved)
7548 * @li "scroll,anim,start" - scrolling animation has started
7549 * @li "scroll,anim,stop" - scrolling animation has stopped
7550 * @li "scroll,drag,start" - dragging the contents around has started
7551 * @li "scroll,drag,stop" - dragging the contents around has stopped
7552 * @note The "scroll,anim,*" and "scroll,drag,*" signals are only emitted by
7555 * @note When Elemementary is in embedded mode the scrollbars will not be
7556 * dragable, they appear merely as indicators of how much has been scrolled.
7557 * @note When Elementary is in desktop mode the thumbscroll(a.k.a.
7558 * fingerscroll) won't work.
7560 * Default contents parts of the scroller widget that you can use for are:
7561 * @li "default" - A content of the scroller
7563 * In @ref tutorial_scroller you'll find an example of how to use most of
7569 * @brief Type that controls when scrollbars should appear.
7571 * @see elm_scroller_policy_set()
7573 typedef enum _Elm_Scroller_Policy
7575 ELM_SCROLLER_POLICY_AUTO = 0, /**< Show scrollbars as needed */
7576 ELM_SCROLLER_POLICY_ON, /**< Always show scrollbars */
7577 ELM_SCROLLER_POLICY_OFF, /**< Never show scrollbars */
7578 ELM_SCROLLER_POLICY_LAST
7579 } Elm_Scroller_Policy;
7582 * @brief Add a new scroller to the parent
7584 * @param parent The parent object
7585 * @return The new object or NULL if it cannot be created
7587 EAPI Evas_Object *elm_scroller_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7590 * @brief Set the content of the scroller widget (the object to be scrolled around).
7592 * @param obj The scroller object
7593 * @param content The new content object
7595 * Once the content object is set, a previously set one will be deleted.
7596 * If you want to keep that old content object, use the
7597 * elm_scroller_content_unset() function.
7598 * @deprecated use elm_object_content_set() instead
7600 EINA_DEPRECATED EAPI void elm_scroller_content_set(Evas_Object *obj, Evas_Object *child) EINA_ARG_NONNULL(1);
7603 * @brief Get the content of the scroller widget
7605 * @param obj The slider object
7606 * @return The content that is being used
7608 * Return the content object which is set for this widget
7610 * @see elm_scroller_content_set()
7611 * @deprecated use elm_object_content_get() instead.
7613 EINA_DEPRECATED EAPI Evas_Object *elm_scroller_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7616 * @brief Unset the content of the scroller widget
7618 * @param obj The slider object
7619 * @return The content that was being used
7621 * Unparent and return the content object which was set for this widget
7623 * @see elm_scroller_content_set()
7624 * @deprecated use elm_object_content_unset() instead.
7626 EINA_DEPRECATED EAPI Evas_Object *elm_scroller_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
7629 * @brief Set custom theme elements for the scroller
7631 * @param obj The scroller object
7632 * @param widget The widget name to use (default is "scroller")
7633 * @param base The base name to use (default is "base")
7635 EAPI void elm_scroller_custom_widget_base_theme_set(Evas_Object *obj, const char *widget, const char *base) EINA_ARG_NONNULL(1, 2, 3);
7638 * @brief Make the scroller minimum size limited to the minimum size of the content
7640 * @param obj The scroller object
7641 * @param w Enable limiting minimum size horizontally
7642 * @param h Enable limiting minimum size vertically
7644 * By default the scroller will be as small as its design allows,
7645 * irrespective of its content. This will make the scroller minimum size the
7646 * right size horizontally and/or vertically to perfectly fit its content in
7649 EAPI void elm_scroller_content_min_limit(Evas_Object *obj, Eina_Bool w, Eina_Bool h) EINA_ARG_NONNULL(1);
7652 * @brief Show a specific virtual region within the scroller content object
7654 * @param obj The scroller object
7655 * @param x X coordinate of the region
7656 * @param y Y coordinate of the region
7657 * @param w Width of the region
7658 * @param h Height of the region
7660 * This will ensure all (or part if it does not fit) of the designated
7661 * region in the virtual content object (0, 0 starting at the top-left of the
7662 * virtual content object) is shown within the scroller.
7664 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);
7667 * @brief Set the scrollbar visibility policy
7669 * @param obj The scroller object
7670 * @param policy_h Horizontal scrollbar policy
7671 * @param policy_v Vertical scrollbar policy
7673 * This sets the scrollbar visibility policy for the given scroller.
7674 * ELM_SCROLLER_POLICY_AUTO means the scrollbar is made visible if it is
7675 * needed, and otherwise kept hidden. ELM_SCROLLER_POLICY_ON turns it on all
7676 * the time, and ELM_SCROLLER_POLICY_OFF always keeps it off. This applies
7677 * respectively for the horizontal and vertical scrollbars.
7679 EAPI void elm_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
7682 * @brief Gets scrollbar visibility policy
7684 * @param obj The scroller object
7685 * @param policy_h Horizontal scrollbar policy
7686 * @param policy_v Vertical scrollbar policy
7688 * @see elm_scroller_policy_set()
7690 EAPI void elm_scroller_policy_get(const Evas_Object *obj, Elm_Scroller_Policy *policy_h, Elm_Scroller_Policy *policy_v) EINA_ARG_NONNULL(1);
7693 * @brief Get the currently visible content region
7695 * @param obj The scroller object
7696 * @param x X coordinate of the region
7697 * @param y Y coordinate of the region
7698 * @param w Width of the region
7699 * @param h Height of the region
7701 * This gets the current region in the content object that is visible through
7702 * the scroller. The region co-ordinates are returned in the @p x, @p y, @p
7703 * w, @p h values pointed to.
7705 * @note All coordinates are relative to the content.
7707 * @see elm_scroller_region_show()
7709 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);
7712 * @brief Get the size of the content object
7714 * @param obj The scroller object
7715 * @param w Width of the content object.
7716 * @param h Height of the content object.
7718 * This gets the size of the content object of the scroller.
7720 EAPI void elm_scroller_child_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
7723 * @brief Set bouncing behavior
7725 * @param obj The scroller object
7726 * @param h_bounce Allow bounce horizontally
7727 * @param v_bounce Allow bounce vertically
7729 * When scrolling, the scroller may "bounce" when reaching an edge of the
7730 * content object. This is a visual way to indicate the end has been reached.
7731 * This is enabled by default for both axis. This API will set if it is enabled
7732 * for the given axis with the boolean parameters for each axis.
7734 EAPI void elm_scroller_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
7737 * @brief Get the bounce behaviour
7739 * @param obj The Scroller object
7740 * @param h_bounce Will the scroller bounce horizontally or not
7741 * @param v_bounce Will the scroller bounce vertically or not
7743 * @see elm_scroller_bounce_set()
7745 EAPI void elm_scroller_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
7748 * @brief Set scroll page size relative to viewport size.
7750 * @param obj The scroller object
7751 * @param h_pagerel The horizontal page relative size
7752 * @param v_pagerel The vertical page relative size
7754 * The scroller is capable of limiting scrolling by the user to "pages". That
7755 * is to jump by and only show a "whole page" at a time as if the continuous
7756 * area of the scroller content is split into page sized pieces. This sets
7757 * the size of a page relative to the viewport of the scroller. 1.0 is "1
7758 * viewport" is size (horizontally or vertically). 0.0 turns it off in that
7759 * axis. This is mutually exclusive with page size
7760 * (see elm_scroller_page_size_set() for more information). Likewise 0.5
7761 * is "half a viewport". Sane usable values are normally between 0.0 and 1.0
7762 * including 1.0. If you only want 1 axis to be page "limited", use 0.0 for
7765 EAPI void elm_scroller_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel) EINA_ARG_NONNULL(1);
7768 * @brief Set scroll page size.
7770 * @param obj The scroller object
7771 * @param h_pagesize The horizontal page size
7772 * @param v_pagesize The vertical page size
7774 * This sets the page size to an absolute fixed value, with 0 turning it off
7777 * @see elm_scroller_page_relative_set()
7779 EAPI void elm_scroller_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize) EINA_ARG_NONNULL(1);
7782 * @brief Get scroll current page number.
7784 * @param obj The scroller object
7785 * @param h_pagenumber The horizontal page number
7786 * @param v_pagenumber The vertical page number
7788 * The page number starts from 0. 0 is the first page.
7789 * Current page means the page which meets the top-left of the viewport.
7790 * If there are two or more pages in the viewport, it returns the number of the page
7791 * which meets the top-left of the viewport.
7793 * @see elm_scroller_last_page_get()
7794 * @see elm_scroller_page_show()
7795 * @see elm_scroller_page_brint_in()
7797 EAPI void elm_scroller_current_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber) EINA_ARG_NONNULL(1);
7800 * @brief Get scroll last page number.
7802 * @param obj The scroller object
7803 * @param h_pagenumber The horizontal page number
7804 * @param v_pagenumber The vertical page number
7806 * The page number starts from 0. 0 is the first page.
7807 * This returns the last page number among the pages.
7809 * @see elm_scroller_current_page_get()
7810 * @see elm_scroller_page_show()
7811 * @see elm_scroller_page_brint_in()
7813 EAPI void elm_scroller_last_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber) EINA_ARG_NONNULL(1);
7816 * Show a specific virtual region within the scroller content object by page number.
7818 * @param obj The scroller object
7819 * @param h_pagenumber The horizontal page number
7820 * @param v_pagenumber The vertical page number
7822 * 0, 0 of the indicated page is located at the top-left of the viewport.
7823 * This will jump to the page directly without animation.
7828 * sc = elm_scroller_add(win);
7829 * elm_scroller_content_set(sc, content);
7830 * elm_scroller_page_relative_set(sc, 1, 0);
7831 * elm_scroller_current_page_get(sc, &h_page, &v_page);
7832 * elm_scroller_page_show(sc, h_page + 1, v_page);
7835 * @see elm_scroller_page_bring_in()
7837 EAPI void elm_scroller_page_show(Evas_Object *obj, int h_pagenumber, int v_pagenumber) EINA_ARG_NONNULL(1);
7840 * Show a specific virtual region within the scroller content object by page number.
7842 * @param obj The scroller object
7843 * @param h_pagenumber The horizontal page number
7844 * @param v_pagenumber The vertical page number
7846 * 0, 0 of the indicated page is located at the top-left of the viewport.
7847 * This will slide to the page with animation.
7852 * sc = elm_scroller_add(win);
7853 * elm_scroller_content_set(sc, content);
7854 * elm_scroller_page_relative_set(sc, 1, 0);
7855 * elm_scroller_last_page_get(sc, &h_page, &v_page);
7856 * elm_scroller_page_bring_in(sc, h_page, v_page);
7859 * @see elm_scroller_page_show()
7861 EAPI void elm_scroller_page_bring_in(Evas_Object *obj, int h_pagenumber, int v_pagenumber) EINA_ARG_NONNULL(1);
7864 * @brief Show a specific virtual region within the scroller content object.
7866 * @param obj The scroller object
7867 * @param x X coordinate of the region
7868 * @param y Y coordinate of the region
7869 * @param w Width of the region
7870 * @param h Height of the region
7872 * This will ensure all (or part if it does not fit) of the designated
7873 * region in the virtual content object (0, 0 starting at the top-left of the
7874 * virtual content object) is shown within the scroller. Unlike
7875 * elm_scroller_region_show(), this allow the scroller to "smoothly slide"
7876 * to this location (if configuration in general calls for transitions). It
7877 * may not jump immediately to the new location and make take a while and
7878 * show other content along the way.
7880 * @see elm_scroller_region_show()
7882 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);
7885 * @brief Set event propagation on a scroller
7887 * @param obj The scroller object
7888 * @param propagation If propagation is enabled or not
7890 * This enables or disabled event propagation from the scroller content to
7891 * the scroller and its parent. By default event propagation is disabled.
7893 EAPI void elm_scroller_propagate_events_set(Evas_Object *obj, Eina_Bool propagation) EINA_ARG_NONNULL(1);
7896 * @brief Get event propagation for a scroller
7898 * @param obj The scroller object
7899 * @return The propagation state
7901 * This gets the event propagation for a scroller.
7903 * @see elm_scroller_propagate_events_set()
7905 EAPI Eina_Bool elm_scroller_propagate_events_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7908 * @brief Set scrolling gravity on a scroller
7910 * @param obj The scroller object
7911 * @param x The scrolling horizontal gravity
7912 * @param y The scrolling vertical gravity
7914 * The gravity, defines how the scroller will adjust its view
7915 * when the size of the scroller contents increase.
7917 * The scroller will adjust the view to glue itself as follows.
7919 * x=0.0, for showing the left most region of the content.
7920 * x=1.0, for showing the right most region of the content.
7921 * y=0.0, for showing the bottom most region of the content.
7922 * y=1.0, for showing the top most region of the content.
7924 * Default values for x and y are 0.0
7926 EAPI void elm_scroller_gravity_set(Evas_Object *obj, double x, double y) EINA_ARG_NONNULL(1);
7929 * @brief Get scrolling gravity values for a scroller
7931 * @param obj The scroller object
7932 * @param x The scrolling horizontal gravity
7933 * @param y The scrolling vertical gravity
7935 * This gets gravity values for a scroller.
7937 * @see elm_scroller_gravity_set()
7940 EAPI void elm_scroller_gravity_get(const Evas_Object *obj, double *x, double *y) EINA_ARG_NONNULL(1);
7947 * @defgroup Label Label
7949 * @image html img/widget/label/preview-00.png
7950 * @image latex img/widget/label/preview-00.eps
7952 * @brief Widget to display text, with simple html-like markup.
7954 * The Label widget @b doesn't allow text to overflow its boundaries, if the
7955 * text doesn't fit the geometry of the label it will be ellipsized or be
7956 * cut. Elementary provides several styles for this widget:
7957 * @li default - No animation
7958 * @li marker - Centers the text in the label and make it bold by default
7959 * @li slide_long - The entire text appears from the right of the screen and
7960 * slides until it disappears in the left of the screen(reappering on the
7962 * @li slide_short - The text appears in the left of the label and slides to
7963 * the right to show the overflow. When all of the text has been shown the
7964 * position is reset.
7965 * @li slide_bounce - The text appears in the left of the label and slides to
7966 * the right to show the overflow. When all of the text has been shown the
7967 * animation reverses, moving the text to the left.
7969 * Custom themes can of course invent new markup tags and style them any way
7972 * The following signals may be emitted by the label widget:
7973 * @li "language,changed": The program's language changed.
7975 * See @ref tutorial_label for a demonstration of how to use a label widget.
7980 * @brief Add a new label to the parent
7982 * @param parent The parent object
7983 * @return The new object or NULL if it cannot be created
7985 EAPI Evas_Object *elm_label_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7988 * @brief Set the label on the label object
7990 * @param obj The label object
7991 * @param label The label will be used on the label object
7992 * @deprecated See elm_object_text_set()
7994 EINA_DEPRECATED EAPI void elm_label_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
7997 * @brief Get the label used on the label object
7999 * @param obj The label object
8000 * @return The string inside the label
8001 * @deprecated See elm_object_text_get()
8003 EINA_DEPRECATED EAPI const char *elm_label_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8006 * @brief Set the wrapping behavior of the label
8008 * @param obj The label object
8009 * @param wrap To wrap text or not
8011 * By default no wrapping is done. Possible values for @p wrap are:
8012 * @li ELM_WRAP_NONE - No wrapping
8013 * @li ELM_WRAP_CHAR - wrap between characters
8014 * @li ELM_WRAP_WORD - wrap between words
8015 * @li ELM_WRAP_MIXED - Word wrap, and if that fails, char wrap
8017 EAPI void elm_label_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
8020 * @brief Get the wrapping behavior of the label
8022 * @param obj The label object
8025 * @see elm_label_line_wrap_set()
8027 EAPI Elm_Wrap_Type elm_label_line_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8030 * @brief Set wrap width of the label
8032 * @param obj The label object
8033 * @param w The wrap width in pixels at a minimum where words need to wrap
8035 * This function sets the maximum width size hint of the label.
8037 * @warning This is only relevant if the label is inside a container.
8039 EAPI void elm_label_wrap_width_set(Evas_Object *obj, Evas_Coord w) EINA_ARG_NONNULL(1);
8042 * @brief Get wrap width of the label
8044 * @param obj The label object
8045 * @return The wrap width in pixels at a minimum where words need to wrap
8047 * @see elm_label_wrap_width_set()
8049 EAPI Evas_Coord elm_label_wrap_width_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8052 * @brief Set wrap height of the label
8054 * @param obj The label object
8055 * @param h The wrap height in pixels at a minimum where words need to wrap
8057 * This function sets the maximum height size hint of the label.
8059 * @warning This is only relevant if the label is inside a container.
8061 EAPI void elm_label_wrap_height_set(Evas_Object *obj, Evas_Coord h) EINA_ARG_NONNULL(1);
8064 * @brief get wrap width of the label
8066 * @param obj The label object
8067 * @return The wrap height in pixels at a minimum where words need to wrap
8069 EAPI Evas_Coord elm_label_wrap_height_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8072 * @brief Set the font size on the label object.
8074 * @param obj The label object
8075 * @param size font size
8077 * @warning NEVER use this. It is for hyper-special cases only. use styles
8078 * instead. e.g. "default", "marker", "slide_long" etc.
8080 EAPI void elm_label_fontsize_set(Evas_Object *obj, int fontsize) EINA_ARG_NONNULL(1);
8083 * @brief Set the text color on the label object
8085 * @param obj The label object
8086 * @param r Red property background color of The label object
8087 * @param g Green property background color of The label object
8088 * @param b Blue property background color of The label object
8089 * @param a Alpha property background color of The label object
8091 * @warning NEVER use this. It is for hyper-special cases only. use styles
8092 * instead. e.g. "default", "marker", "slide_long" etc.
8094 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);
8097 * @brief Set the text align on the label object
8099 * @param obj The label object
8100 * @param align align mode ("left", "center", "right")
8102 * @warning NEVER use this. It is for hyper-special cases only. use styles
8103 * instead. e.g. "default", "marker", "slide_long" etc.
8105 EAPI void elm_label_text_align_set(Evas_Object *obj, const char *alignmode) EINA_ARG_NONNULL(1);
8108 * @brief Set background color of the label
8110 * @param obj The label object
8111 * @param r Red property background color of The label object
8112 * @param g Green property background color of The label object
8113 * @param b Blue property background color of The label object
8114 * @param a Alpha property background alpha of The label object
8116 * @warning NEVER use this. It is for hyper-special cases only. use styles
8117 * instead. e.g. "default", "marker", "slide_long" etc.
8119 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);
8122 * @brief Set the ellipsis behavior of the label
8124 * @param obj The label object
8125 * @param ellipsis To ellipsis text or not
8127 * If set to true and the text doesn't fit in the label an ellipsis("...")
8128 * will be shown at the end of the widget.
8130 * @warning This doesn't work with slide(elm_label_slide_set()) or if the
8131 * choosen wrap method was ELM_WRAP_WORD.
8133 EAPI void elm_label_ellipsis_set(Evas_Object *obj, Eina_Bool ellipsis) EINA_ARG_NONNULL(1);
8136 * @brief Set the text slide of the label
8138 * @param obj The label object
8139 * @param slide To start slide or stop
8141 * If set to true, the text of the label will slide/scroll through the length of
8144 * @warning This only works with the themes "slide_short", "slide_long" and
8147 EAPI void elm_label_slide_set(Evas_Object *obj, Eina_Bool slide) EINA_ARG_NONNULL(1);
8150 * @brief Get the text slide mode of the label
8152 * @param obj The label object
8153 * @return slide slide mode value
8155 * @see elm_label_slide_set()
8157 EAPI Eina_Bool elm_label_slide_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
8160 * @brief Set the slide duration(speed) of the label
8162 * @param obj The label object
8163 * @return The duration in seconds in moving text from slide begin position
8164 * to slide end position
8166 EAPI void elm_label_slide_duration_set(Evas_Object *obj, double duration) EINA_ARG_NONNULL(1);
8169 * @brief Get the slide duration(speed) of the label
8171 * @param obj The label object
8172 * @return The duration time in moving text from slide begin position to slide end position
8174 * @see elm_label_slide_duration_set()
8176 EAPI double elm_label_slide_duration_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
8183 * @defgroup Toggle Toggle
8185 * @image html img/widget/toggle/preview-00.png
8186 * @image latex img/widget/toggle/preview-00.eps
8188 * @brief A toggle is a slider which can be used to toggle between
8189 * two values. It has two states: on and off.
8191 * This widget is deprecated. Please use elm_check_add() instead using the
8192 * toggle style like:
8195 * obj = elm_check_add(parent);
8196 * elm_object_style_set(obj, "toggle");
8197 * elm_object_part_text_set(obj, "on", "ON");
8198 * elm_object_part_text_set(obj, "off", "OFF");
8201 * Signals that you can add callbacks for are:
8202 * @li "changed" - Whenever the toggle value has been changed. Is not called
8203 * until the toggle is released by the cursor (assuming it
8204 * has been triggered by the cursor in the first place).
8206 * Default contents parts of the toggle widget that you can use for are:
8207 * @li "icon" - An icon of the toggle
8209 * Default text parts of the toggle widget that you can use for are:
8210 * @li "elm.text" - Label of the toggle
8212 * @ref tutorial_toggle show how to use a toggle.
8217 * @brief Add a toggle to @p parent.
8219 * @param parent The parent object
8221 * @return The toggle object
8223 EINA_DEPRECATED EAPI Evas_Object *elm_toggle_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
8226 * @brief Sets the label to be displayed with the toggle.
8228 * @param obj The toggle object
8229 * @param label The label to be displayed
8231 * @deprecated use elm_object_text_set() instead.
8233 EINA_DEPRECATED EAPI void elm_toggle_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
8236 * @brief Gets the label of the toggle
8238 * @param obj toggle object
8239 * @return The label of the toggle
8241 * @deprecated use elm_object_text_get() instead.
8243 EINA_DEPRECATED EAPI const char *elm_toggle_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8246 * @brief Set the icon used for the toggle
8248 * @param obj The toggle object
8249 * @param icon The icon object for the button
8251 * Once the icon object is set, a previously set one will be deleted
8252 * If you want to keep that old content object, use the
8253 * elm_toggle_icon_unset() function.
8255 * @deprecated use elm_object_part_content_set() instead.
8257 EINA_DEPRECATED EAPI void elm_toggle_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
8260 * @brief Get the icon used for the toggle
8262 * @param obj The toggle object
8263 * @return The icon object that is being used
8265 * Return the icon object which is set for this widget.
8267 * @see elm_toggle_icon_set()
8269 * @deprecated use elm_object_part_content_get() instead.
8271 EINA_DEPRECATED EAPI Evas_Object *elm_toggle_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8274 * @brief Unset the icon used for the toggle
8276 * @param obj The toggle object
8277 * @return The icon object that was being used
8279 * Unparent and return the icon object which was set for this widget.
8281 * @see elm_toggle_icon_set()
8283 * @deprecated use elm_object_part_content_unset() instead.
8285 EINA_DEPRECATED EAPI Evas_Object *elm_toggle_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
8288 * @brief Sets the labels to be associated with the on and off states of the toggle.
8290 * @param obj The toggle object
8291 * @param onlabel The label displayed when the toggle is in the "on" state
8292 * @param offlabel The label displayed when the toggle is in the "off" state
8294 * @deprecated use elm_object_part_text_set() for "on" and "off" parts
8297 EINA_DEPRECATED EAPI void elm_toggle_states_labels_set(Evas_Object *obj, const char *onlabel, const char *offlabel) EINA_ARG_NONNULL(1);
8300 * @brief Gets the labels associated with the on and off states of the
8303 * @param obj The toggle object
8304 * @param onlabel A char** to place the onlabel of @p obj into
8305 * @param offlabel A char** to place the offlabel of @p obj into
8307 * @deprecated use elm_object_part_text_get() for "on" and "off" parts
8310 EINA_DEPRECATED EAPI void elm_toggle_states_labels_get(const Evas_Object *obj, const char **onlabel, const char **offlabel) EINA_ARG_NONNULL(1);
8313 * @brief Sets the state of the toggle to @p state.
8315 * @param obj The toggle object
8316 * @param state The state of @p obj
8318 * @deprecated use elm_check_state_set() instead.
8320 EINA_DEPRECATED EAPI void elm_toggle_state_set(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
8323 * @brief Gets the state of the toggle to @p state.
8325 * @param obj The toggle object
8326 * @return The state of @p obj
8328 * @deprecated use elm_check_state_get() instead.
8330 EINA_DEPRECATED EAPI Eina_Bool elm_toggle_state_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8333 * @brief Sets the state pointer of the toggle to @p statep.
8335 * @param obj The toggle object
8336 * @param statep The state pointer of @p obj
8338 * @deprecated use elm_check_state_pointer_set() instead.
8340 EINA_DEPRECATED EAPI void elm_toggle_state_pointer_set(Evas_Object *obj, Eina_Bool *statep) EINA_ARG_NONNULL(1);
8347 * @defgroup Frame Frame
8349 * @image html img/widget/frame/preview-00.png
8350 * @image latex img/widget/frame/preview-00.eps
8352 * @brief Frame is a widget that holds some content and has a title.
8354 * The default look is a frame with a title, but Frame supports multple
8362 * @li outdent_bottom
8364 * Of all this styles only default shows the title. Frame emits no signals.
8366 * Default contents parts of the frame widget that you can use for are:
8367 * @li "default" - A content of the frame
8369 * Default text parts of the frame widget that you can use for are:
8370 * @li "elm.text" - Label of the frame
8372 * For a detailed example see the @ref tutorial_frame.
8378 * @brief Add a new frame to the parent
8380 * @param parent The parent object
8381 * @return The new object or NULL if it cannot be created
8383 EAPI Evas_Object *elm_frame_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
8386 * @brief Set the frame label
8388 * @param obj The frame object
8389 * @param label The label of this frame object
8391 * @deprecated use elm_object_text_set() instead.
8393 EINA_DEPRECATED EAPI void elm_frame_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
8396 * @brief Get the frame label
8398 * @param obj The frame object
8400 * @return The label of this frame objet or NULL if unable to get frame
8402 * @deprecated use elm_object_text_get() instead.
8404 EINA_DEPRECATED EAPI const char *elm_frame_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8407 * @brief Set the content of the frame widget
8409 * Once the content object is set, a previously set one will be deleted.
8410 * If you want to keep that old content object, use the
8411 * elm_frame_content_unset() function.
8413 * @param obj The frame object
8414 * @param content The content will be filled in this frame object
8416 * @deprecated use elm_object_content_set() instead.
8418 EINA_DEPRECATED EAPI void elm_frame_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
8421 * @brief Get the content of the frame widget
8423 * Return the content object which is set for this widget
8425 * @param obj The frame object
8426 * @return The content that is being used
8428 * @deprecated use elm_object_content_get() instead.
8430 EINA_DEPRECATED EAPI Evas_Object *elm_frame_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8433 * @brief Unset the content of the frame widget
8435 * Unparent and return the content object which was set for this widget
8437 * @param obj The frame object
8438 * @return The content that was being used
8440 * @deprecated use elm_object_content_unset() instead.
8442 EINA_DEPRECATED EAPI Evas_Object *elm_frame_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
8449 * @defgroup Table Table
8451 * A container widget to arrange other widgets in a table where items can
8452 * also span multiple columns or rows - even overlap (and then be raised or
8453 * lowered accordingly to adjust stacking if they do overlap).
8455 * For a Table widget the row/column count is not fixed.
8456 * The table widget adjusts itself when subobjects are added to it dynamically.
8458 * The followin are examples of how to use a table:
8459 * @li @ref tutorial_table_01
8460 * @li @ref tutorial_table_02
8466 * @brief Add a new table to the parent
8468 * @param parent The parent object
8469 * @return The new object or NULL if it cannot be created
8471 EAPI Evas_Object *elm_table_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
8474 * @brief Set the homogeneous layout in the table
8476 * @param obj The layout object
8477 * @param homogeneous A boolean to set if the layout is homogeneous in the
8478 * table (EINA_TRUE = homogeneous, EINA_FALSE = no homogeneous)
8480 EAPI void elm_table_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
8483 * @brief Get the current table homogeneous mode.
8485 * @param obj The table object
8486 * @return A boolean to indicating if the layout is homogeneous in the table
8487 * (EINA_TRUE = homogeneous, EINA_FALSE = no homogeneous)
8489 EAPI Eina_Bool elm_table_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8492 * @brief Set padding between cells.
8494 * @param obj The layout object.
8495 * @param horizontal set the horizontal padding.
8496 * @param vertical set the vertical padding.
8498 * Default value is 0.
8500 EAPI void elm_table_padding_set(Evas_Object *obj, Evas_Coord horizontal, Evas_Coord vertical) EINA_ARG_NONNULL(1);
8503 * @brief Get padding between cells.
8505 * @param obj The layout object.
8506 * @param horizontal set the horizontal padding.
8507 * @param vertical set the vertical padding.
8509 EAPI void elm_table_padding_get(const Evas_Object *obj, Evas_Coord *horizontal, Evas_Coord *vertical) EINA_ARG_NONNULL(1);
8512 * @brief Add a subobject on the table with the coordinates passed
8514 * @param obj The table object
8515 * @param subobj The subobject to be added to the table
8516 * @param x Row number
8517 * @param y Column number
8521 * @note All positioning inside the table is relative to rows and columns, so
8522 * a value of 0 for x and y, means the top left cell of the table, and a
8523 * value of 1 for w and h means @p subobj only takes that 1 cell.
8525 EAPI void elm_table_pack(Evas_Object *obj, Evas_Object *subobj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
8528 * @brief Remove child from table.
8530 * @param obj The table object
8531 * @param subobj The subobject
8533 EAPI void elm_table_unpack(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
8536 * @brief Faster way to remove all child objects from a table object.
8538 * @param obj The table object
8539 * @param clear If true, will delete children, else just remove from table.
8541 EAPI void elm_table_clear(Evas_Object *obj, Eina_Bool clear) EINA_ARG_NONNULL(1);
8544 * @brief Set the packing location of an existing child of the table
8546 * @param subobj The subobject to be modified in the table
8547 * @param x Row number
8548 * @param y Column number
8552 * Modifies the position of an object already in the table.
8554 * @note All positioning inside the table is relative to rows and columns, so
8555 * a value of 0 for x and y, means the top left cell of the table, and a
8556 * value of 1 for w and h means @p subobj only takes that 1 cell.
8558 EAPI void elm_table_pack_set(Evas_Object *subobj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
8561 * @brief Get the packing location of an existing child of the table
8563 * @param subobj The subobject to be modified in the table
8564 * @param x Row number
8565 * @param y Column number
8569 * @see elm_table_pack_set()
8571 EAPI void elm_table_pack_get(Evas_Object *subobj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
8577 /* TEMPORARY: DOCS WILL BE FILLED IN WITH CNP/SED */
8578 typedef struct Elm_Gen_Item Elm_Gen_Item;
8579 typedef struct _Elm_Gen_Item_Class Elm_Gen_Item_Class;
8580 typedef struct _Elm_Gen_Item_Class_Func Elm_Gen_Item_Class_Func; /**< Class functions for gen item classes. */
8581 typedef char *(*Elm_Gen_Item_Text_Get_Cb) (void *data, Evas_Object *obj, const char *part); /**< Label fetching class function for gen item classes. */
8582 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. */
8583 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. */
8584 typedef void (*Elm_Gen_Item_Del_Cb) (void *data, Evas_Object *obj); /**< Deletion class function for gen item classes. */
8585 struct _Elm_Gen_Item_Class
8587 const char *item_style;
8588 struct _Elm_Gen_Item_Class_Func
8590 Elm_Gen_Item_Text_Get_Cb text_get;
8591 Elm_Gen_Item_Content_Get_Cb content_get;
8592 Elm_Gen_Item_State_Get_Cb state_get;
8593 Elm_Gen_Item_Del_Cb del;
8596 EINA_DEPRECATED EAPI void elm_gen_clear(Evas_Object *obj);
8597 EINA_DEPRECATED EAPI void elm_gen_item_selected_set(Elm_Gen_Item *it, Eina_Bool selected);
8598 EINA_DEPRECATED EAPI Eina_Bool elm_gen_item_selected_get(const Elm_Gen_Item *it);
8599 EINA_DEPRECATED EAPI void elm_gen_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select);
8600 EINA_DEPRECATED EAPI Eina_Bool elm_gen_always_select_mode_get(const Evas_Object *obj);
8601 EINA_DEPRECATED EAPI void elm_gen_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select);
8602 EINA_DEPRECATED EAPI Eina_Bool elm_gen_no_select_mode_get(const Evas_Object *obj);
8603 EINA_DEPRECATED EAPI void elm_gen_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce);
8604 EINA_DEPRECATED EAPI void elm_gen_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce);
8605 EINA_DEPRECATED EAPI void elm_gen_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel);
8606 EINA_DEPRECATED EAPI void elm_gen_page_relative_get(const Evas_Object *obj, double *h_pagerel, double *v_pagerel);
8608 EINA_DEPRECATED EAPI void elm_gen_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize);
8609 EINA_DEPRECATED EAPI void elm_gen_current_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber);
8610 EINA_DEPRECATED EAPI void elm_gen_last_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber);
8611 EINA_DEPRECATED EAPI void elm_gen_page_show(const Evas_Object *obj, int h_pagenumber, int v_pagenumber);
8612 EINA_DEPRECATED EAPI void elm_gen_page_bring_in(const Evas_Object *obj, int h_pagenumber, int v_pagenumber);
8613 EINA_DEPRECATED EAPI Elm_Gen_Item *elm_gen_first_item_get(const Evas_Object *obj);
8614 EINA_DEPRECATED EAPI Elm_Gen_Item *elm_gen_last_item_get(const Evas_Object *obj);
8615 EINA_DEPRECATED EAPI Elm_Gen_Item *elm_gen_item_next_get(const Elm_Gen_Item *it);
8616 EINA_DEPRECATED EAPI Elm_Gen_Item *elm_gen_item_prev_get(const Elm_Gen_Item *it);
8617 EINA_DEPRECATED EAPI Evas_Object *elm_gen_item_widget_get(const Elm_Gen_Item *it);
8620 * @defgroup Gengrid Gengrid (Generic grid)
8622 * This widget aims to position objects in a grid layout while
8623 * actually creating and rendering only the visible ones, using the
8624 * same idea as the @ref Genlist "genlist": the user defines a @b
8625 * class for each item, specifying functions that will be called at
8626 * object creation, deletion, etc. When those items are selected by
8627 * the user, a callback function is issued. Users may interact with
8628 * a gengrid via the mouse (by clicking on items to select them and
8629 * clicking on the grid's viewport and swiping to pan the whole
8630 * view) or via the keyboard, navigating through item with the
8633 * @section Gengrid_Layouts Gengrid layouts
8635 * Gengrid may layout its items in one of two possible layouts:
8639 * When in "horizontal mode", items will be placed in @b columns,
8640 * from top to bottom and, when the space for a column is filled,
8641 * another one is started on the right, thus expanding the grid
8642 * horizontally, making for horizontal scrolling. When in "vertical
8643 * mode" , though, items will be placed in @b rows, from left to
8644 * right and, when the space for a row is filled, another one is
8645 * started below, thus expanding the grid vertically (and making
8646 * for vertical scrolling).
8648 * @section Gengrid_Items Gengrid items
8650 * An item in a gengrid can have 0 or more texts (they can be
8651 * regular text or textblock Evas objects - that's up to the style
8652 * to determine), 0 or more contents (which are simply objects
8653 * swallowed into the gengrid item's theming Edje object) and 0 or
8654 * more <b>boolean states</b>, which have the behavior left to the
8655 * user to define. The Edje part names for each of these properties
8656 * will be looked up, in the theme file for the gengrid, under the
8657 * Edje (string) data items named @c "texts", @c "contents" and @c
8658 * "states", respectively. For each of those properties, if more
8659 * than one part is provided, they must have names listed separated
8660 * by spaces in the data fields. For the default gengrid item
8661 * theme, we have @b one text part (@c "elm.text"), @b two content
8662 * parts (@c "elm.swalllow.icon" and @c "elm.swallow.end") and @b
8665 * A gengrid item may be at one of several styles. Elementary
8666 * provides one by default - "default", but this can be extended by
8667 * system or application custom themes/overlays/extensions (see
8668 * @ref Theme "themes" for more details).
8670 * @section Gengrid_Item_Class Gengrid item classes
8672 * In order to have the ability to add and delete items on the fly,
8673 * gengrid implements a class (callback) system where the
8674 * application provides a structure with information about that
8675 * type of item (gengrid may contain multiple different items with
8676 * different classes, states and styles). Gengrid will call the
8677 * functions in this struct (methods) when an item is "realized"
8678 * (i.e., created dynamically, while the user is scrolling the
8679 * grid). All objects will simply be deleted when no longer needed
8680 * with evas_object_del(). The #Elm_GenGrid_Item_Class structure
8681 * contains the following members:
8682 * - @c item_style - This is a constant string and simply defines
8683 * the name of the item style. It @b must be specified and the
8684 * default should be @c "default".
8685 * - @c func.text_get - This function is called when an item
8686 * object is actually created. The @c data parameter will point to
8687 * the same data passed to elm_gengrid_item_append() and related
8688 * item creation functions. The @c obj parameter is the gengrid
8689 * object itself, while the @c part one is the name string of one
8690 * of the existing text parts in the Edje group implementing the
8691 * item's theme. This function @b must return a strdup'()ed string,
8692 * as the caller will free() it when done. See
8693 * #Elm_Gengrid_Item_Text_Get_Cb.
8694 * - @c func.content_get - This function is called when an item object
8695 * is actually created. The @c data parameter will point to the
8696 * same data passed to elm_gengrid_item_append() and related item
8697 * creation functions. The @c obj parameter is the gengrid object
8698 * itself, while the @c part one is the name string of one of the
8699 * existing (content) swallow parts in the Edje group implementing the
8700 * item's theme. It must return @c NULL, when no content is desired,
8701 * or a valid object handle, otherwise. The object will be deleted
8702 * by the gengrid on its deletion or when the item is "unrealized".
8703 * See #Elm_Gengrid_Item_Content_Get_Cb.
8704 * - @c func.state_get - This function is called when an item
8705 * object is actually created. The @c data parameter will point to
8706 * the same data passed to elm_gengrid_item_append() and related
8707 * item creation functions. The @c obj parameter is the gengrid
8708 * object itself, while the @c part one is the name string of one
8709 * of the state parts in the Edje group implementing the item's
8710 * theme. Return @c EINA_FALSE for false/off or @c EINA_TRUE for
8711 * true/on. Gengrids will emit a signal to its theming Edje object
8712 * with @c "elm,state,XXX,active" and @c "elm" as "emission" and
8713 * "source" arguments, respectively, when the state is true (the
8714 * default is false), where @c XXX is the name of the (state) part.
8715 * See #Elm_Gengrid_Item_State_Get_Cb.
8716 * - @c func.del - This is called when elm_gengrid_item_del() is
8717 * called on an item or elm_gengrid_clear() is called on the
8718 * gengrid. This is intended for use when gengrid items are
8719 * deleted, so any data attached to the item (e.g. its data
8720 * parameter on creation) can be deleted. See #Elm_Gengrid_Item_Del_Cb.
8722 * @section Gengrid_Usage_Hints Usage hints
8724 * If the user wants to have multiple items selected at the same
8725 * time, elm_gengrid_multi_select_set() will permit it. If the
8726 * gengrid is single-selection only (the default), then
8727 * elm_gengrid_select_item_get() will return the selected item or
8728 * @c NULL, if none is selected. If the gengrid is under
8729 * multi-selection, then elm_gengrid_selected_items_get() will
8730 * return a list (that is only valid as long as no items are
8731 * modified (added, deleted, selected or unselected) of child items
8734 * If an item changes (internal (boolean) state, text or content
8735 * changes), then use elm_gengrid_item_update() to have gengrid
8736 * update the item with the new state. A gengrid will re-"realize"
8737 * the item, thus calling the functions in the
8738 * #Elm_Gengrid_Item_Class set for that item.
8740 * To programmatically (un)select an item, use
8741 * elm_gengrid_item_selected_set(). To get its selected state use
8742 * elm_gengrid_item_selected_get(). To make an item disabled
8743 * (unable to be selected and appear differently) use
8744 * elm_gengrid_item_disabled_set() to set this and
8745 * elm_gengrid_item_disabled_get() to get the disabled state.
8747 * Grid cells will only have their selection smart callbacks called
8748 * when firstly getting selected. Any further clicks will do
8749 * nothing, unless you enable the "always select mode", with
8750 * elm_gengrid_always_select_mode_set(), thus making every click to
8751 * issue selection callbacks. elm_gengrid_no_select_mode_set() will
8752 * turn off the ability to select items entirely in the widget and
8753 * they will neither appear selected nor call the selection smart
8756 * Remember that you can create new styles and add your own theme
8757 * augmentation per application with elm_theme_extension_add(). If
8758 * you absolutely must have a specific style that overrides any
8759 * theme the user or system sets up you can use
8760 * elm_theme_overlay_add() to add such a file.
8762 * @section Gengrid_Smart_Events Gengrid smart events
8764 * Smart events that you can add callbacks for are:
8765 * - @c "activated" - The user has double-clicked or pressed
8766 * (enter|return|spacebar) on an item. The @c event_info parameter
8767 * is the gengrid item that was activated.
8768 * - @c "clicked,double" - The user has double-clicked an item.
8769 * The @c event_info parameter is the gengrid item that was double-clicked.
8770 * - @c "longpressed" - This is called when the item is pressed for a certain
8771 * amount of time. By default it's 1 second.
8772 * - @c "selected" - The user has made an item selected. The
8773 * @c event_info parameter is the gengrid item that was selected.
8774 * - @c "unselected" - The user has made an item unselected. The
8775 * @c event_info parameter is the gengrid item that was unselected.
8776 * - @c "realized" - This is called when the item in the gengrid
8777 * has its implementing Evas object instantiated, de facto. @c
8778 * event_info is the gengrid item that was created. The object
8779 * may be deleted at any time, so it is highly advised to the
8780 * caller @b not to use the object pointer returned from
8781 * elm_gengrid_item_object_get(), because it may point to freed
8783 * - @c "unrealized" - This is called when the implementing Evas
8784 * object for this item is deleted. @c event_info is the gengrid
8785 * item that was deleted.
8786 * - @c "changed" - Called when an item is added, removed, resized
8787 * or moved and when the gengrid is resized or gets "horizontal"
8789 * - @c "scroll,anim,start" - This is called when scrolling animation has
8791 * - @c "scroll,anim,stop" - This is called when scrolling animation has
8793 * - @c "drag,start,up" - Called when the item in the gengrid has
8794 * been dragged (not scrolled) up.
8795 * - @c "drag,start,down" - Called when the item in the gengrid has
8796 * been dragged (not scrolled) down.
8797 * - @c "drag,start,left" - Called when the item in the gengrid has
8798 * been dragged (not scrolled) left.
8799 * - @c "drag,start,right" - Called when the item in the gengrid has
8800 * been dragged (not scrolled) right.
8801 * - @c "drag,stop" - Called when the item in the gengrid has
8802 * stopped being dragged.
8803 * - @c "drag" - Called when the item in the gengrid is being
8805 * - @c "scroll" - called when the content has been scrolled
8807 * - @c "scroll,drag,start" - called when dragging the content has
8809 * - @c "scroll,drag,stop" - called when dragging the content has
8811 * - @c "edge,top" - This is called when the gengrid is scrolled until
8813 * - @c "edge,bottom" - This is called when the gengrid is scrolled
8814 * until the bottom edge.
8815 * - @c "edge,left" - This is called when the gengrid is scrolled
8816 * until the left edge.
8817 * - @c "edge,right" - This is called when the gengrid is scrolled
8818 * until the right edge.
8820 * List of gengrid examples:
8821 * @li @ref gengrid_example
8825 * @addtogroup Gengrid
8829 typedef struct _Elm_Gengrid_Item_Class Elm_Gengrid_Item_Class; /**< Gengrid item class definition structs */
8830 #define Elm_Gengrid_Item_Class Elm_Gen_Item_Class
8831 typedef struct _Elm_Gengrid_Item Elm_Gengrid_Item; /**< Gengrid item handles */
8832 #define Elm_Gengrid_Item Elm_Gen_Item /**< Item of Elm_Genlist. Sub-type of Elm_Widget_Item */
8833 typedef struct _Elm_Gengrid_Item_Class_Func Elm_Gengrid_Item_Class_Func; /**< Class functions for gengrid item classes. */
8836 * Text fetching class function for Elm_Gen_Item_Class.
8837 * @param data The data passed in the item creation function
8838 * @param obj The base widget object
8839 * @param part The part name of the swallow
8840 * @return The allocated (NOT stringshared) string to set as the text
8842 typedef char *(*Elm_Gengrid_Item_Text_Get_Cb) (void *data, Evas_Object *obj, const char *part);
8845 * Content (swallowed object) fetching class function for Elm_Gen_Item_Class.
8846 * @param data The data passed in the item creation function
8847 * @param obj The base widget object
8848 * @param part The part name of the swallow
8849 * @return The content object to swallow
8851 typedef Evas_Object *(*Elm_Gengrid_Item_Content_Get_Cb) (void *data, Evas_Object *obj, const char *part);
8854 * State fetching class function for Elm_Gen_Item_Class.
8855 * @param data The data passed in the item creation function
8856 * @param obj The base widget object
8857 * @param part The part name of the swallow
8858 * @return The hell if I know
8860 typedef Eina_Bool (*Elm_Gengrid_Item_State_Get_Cb) (void *data, Evas_Object *obj, const char *part);
8863 * Deletion class function for Elm_Gen_Item_Class.
8864 * @param data The data passed in the item creation function
8865 * @param obj The base widget object
8867 typedef void (*Elm_Gengrid_Item_Del_Cb) (void *data, Evas_Object *obj);
8870 * @struct _Elm_Gengrid_Item_Class
8872 * Gengrid item class definition. See @ref Gengrid_Item_Class for
8875 struct _Elm_Gengrid_Item_Class
8877 const char *item_style;
8878 struct _Elm_Gengrid_Item_Class_Func
8880 Elm_Gengrid_Item_Text_Get_Cb text_get; /**< Text fetching class function for gengrid item classes.*/
8881 Elm_Gengrid_Item_Content_Get_Cb content_get; /**< Content fetching class function for gengrid item classes. */
8882 Elm_Gengrid_Item_State_Get_Cb state_get; /**< State fetching class function for gengrid item classes. */
8883 Elm_Gengrid_Item_Del_Cb del; /**< Deletion class function for gengrid item classes. */
8885 }; /**< #Elm_Gengrid_Item_Class member definitions */
8886 #define Elm_Gengrid_Item_Class_Func Elm_Gen_Item_Class_Func
8889 * Add a new gengrid widget to the given parent Elementary
8890 * (container) object
8892 * @param parent The parent object
8893 * @return a new gengrid widget handle or @c NULL, on errors
8895 * This function inserts a new gengrid widget on the canvas.
8897 * @see elm_gengrid_item_size_set()
8898 * @see elm_gengrid_group_item_size_set()
8899 * @see elm_gengrid_horizontal_set()
8900 * @see elm_gengrid_item_append()
8901 * @see elm_gengrid_item_del()
8902 * @see elm_gengrid_clear()
8906 EAPI Evas_Object *elm_gengrid_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
8909 * Set the size for the items of a given gengrid widget
8911 * @param obj The gengrid object.
8912 * @param w The items' width.
8913 * @param h The items' height;
8915 * A gengrid, after creation, has still no information on the size
8916 * to give to each of its cells. So, you most probably will end up
8917 * with squares one @ref Fingers "finger" wide, the default
8918 * size. Use this function to force a custom size for you items,
8919 * making them as big as you wish.
8921 * @see elm_gengrid_item_size_get()
8925 EAPI void elm_gengrid_item_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
8928 * Get the size set for the items of a given gengrid widget
8930 * @param obj The gengrid object.
8931 * @param w Pointer to a variable where to store the items' width.
8932 * @param h Pointer to a variable where to store the items' height.
8934 * @note Use @c NULL pointers on the size values you're not
8935 * interested in: they'll be ignored by the function.
8937 * @see elm_gengrid_item_size_get() for more details
8941 EAPI void elm_gengrid_item_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
8944 * Set the size for the group items of a given gengrid widget
8946 * @param obj The gengrid object.
8947 * @param w The group items' width.
8948 * @param h The group items' height;
8950 * A gengrid, after creation, has still no information on the size
8951 * to give to each of its cells. So, you most probably will end up
8952 * with squares one @ref Fingers "finger" wide, the default
8953 * size. Use this function to force a custom size for you group items,
8954 * making them as big as you wish.
8956 * @see elm_gengrid_group_item_size_get()
8960 EAPI void elm_gengrid_group_item_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
8963 * Get the size set for the group items of a given gengrid widget
8965 * @param obj The gengrid object.
8966 * @param w Pointer to a variable where to store the group items' width.
8967 * @param h Pointer to a variable where to store the group items' height.
8969 * @note Use @c NULL pointers on the size values you're not
8970 * interested in: they'll be ignored by the function.
8972 * @see elm_gengrid_group_item_size_get() for more details
8976 EAPI void elm_gengrid_group_item_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
8979 * Set the items grid's alignment within a given gengrid widget
8981 * @param obj The gengrid object.
8982 * @param align_x Alignment in the horizontal axis (0 <= align_x <= 1).
8983 * @param align_y Alignment in the vertical axis (0 <= align_y <= 1).
8985 * This sets the alignment of the whole grid of items of a gengrid
8986 * within its given viewport. By default, those values are both
8987 * 0.5, meaning that the gengrid will have its items grid placed
8988 * exactly in the middle of its viewport.
8990 * @note If given alignment values are out of the cited ranges,
8991 * they'll be changed to the nearest boundary values on the valid
8994 * @see elm_gengrid_align_get()
8998 EAPI void elm_gengrid_align_set(Evas_Object *obj, double align_x, double align_y) EINA_ARG_NONNULL(1);
9001 * Get the items grid's alignment values within a given gengrid
9004 * @param obj The gengrid object.
9005 * @param align_x Pointer to a variable where to store the
9006 * horizontal alignment.
9007 * @param align_y Pointer to a variable where to store the vertical
9010 * @note Use @c NULL pointers on the alignment values you're not
9011 * interested in: they'll be ignored by the function.
9013 * @see elm_gengrid_align_set() for more details
9017 EAPI void elm_gengrid_align_get(const Evas_Object *obj, double *align_x, double *align_y) EINA_ARG_NONNULL(1);
9020 * Set whether a given gengrid widget is or not able have items
9023 * @param obj The gengrid object
9024 * @param reorder_mode Use @c EINA_TRUE to turn reoderding on,
9025 * @c EINA_FALSE to turn it off
9027 * If a gengrid is set to allow reordering, a click held for more
9028 * than 0.5 over a given item will highlight it specially,
9029 * signalling the gengrid has entered the reordering state. From
9030 * that time on, the user will be able to, while still holding the
9031 * mouse button down, move the item freely in the gengrid's
9032 * viewport, replacing to said item to the locations it goes to.
9033 * The replacements will be animated and, whenever the user
9034 * releases the mouse button, the item being replaced gets a new
9035 * definitive place in the grid.
9037 * @see elm_gengrid_reorder_mode_get()
9041 EAPI void elm_gengrid_reorder_mode_set(Evas_Object *obj, Eina_Bool reorder_mode) EINA_ARG_NONNULL(1);
9044 * Get whether a given gengrid widget is or not able have items
9047 * @param obj The gengrid object
9048 * @return @c EINA_TRUE, if reoderding is on, @c EINA_FALSE if it's
9051 * @see elm_gengrid_reorder_mode_set() for more details
9055 EAPI Eina_Bool elm_gengrid_reorder_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9058 * Append a new item in a given gengrid widget.
9060 * @param obj The gengrid object.
9061 * @param gic The item class for the item.
9062 * @param data The item data.
9063 * @param func Convenience function called when the item is
9065 * @param func_data Data to be passed to @p func.
9066 * @return A handle to the item added or @c NULL, on errors.
9068 * This adds an item to the beginning of the gengrid.
9070 * @see elm_gengrid_item_prepend()
9071 * @see elm_gengrid_item_insert_before()
9072 * @see elm_gengrid_item_insert_after()
9073 * @see elm_gengrid_item_del()
9077 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);
9080 * Prepend a new item in a given gengrid widget.
9082 * @param obj The gengrid object.
9083 * @param gic The item class for the item.
9084 * @param data The item data.
9085 * @param func Convenience function called when the item is
9087 * @param func_data Data to be passed to @p func.
9088 * @return A handle to the item added or @c NULL, on errors.
9090 * This adds an item to the end of the gengrid.
9092 * @see elm_gengrid_item_append()
9093 * @see elm_gengrid_item_insert_before()
9094 * @see elm_gengrid_item_insert_after()
9095 * @see elm_gengrid_item_del()
9099 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);
9102 * Insert an item before another in a gengrid widget
9104 * @param obj The gengrid object.
9105 * @param gic The item class for the item.
9106 * @param data The item data.
9107 * @param relative The item to place this new one before.
9108 * @param func Convenience function called when the item is
9110 * @param func_data Data to be passed to @p func.
9111 * @return A handle to the item added or @c NULL, on errors.
9113 * This inserts an item before another in the gengrid.
9115 * @see elm_gengrid_item_append()
9116 * @see elm_gengrid_item_prepend()
9117 * @see elm_gengrid_item_insert_after()
9118 * @see elm_gengrid_item_del()
9122 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);
9125 * Insert an item after another in a gengrid widget
9127 * @param obj The gengrid object.
9128 * @param gic The item class for the item.
9129 * @param data The item data.
9130 * @param relative The item to place this new one after.
9131 * @param func Convenience function called when the item is
9133 * @param func_data Data to be passed to @p func.
9134 * @return A handle to the item added or @c NULL, on errors.
9136 * This inserts an item after another in the gengrid.
9138 * @see elm_gengrid_item_append()
9139 * @see elm_gengrid_item_prepend()
9140 * @see elm_gengrid_item_insert_after()
9141 * @see elm_gengrid_item_del()
9145 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);
9148 * Insert an item in a gengrid widget using a user-defined sort function.
9150 * @param obj The gengrid object.
9151 * @param gic The item class for the item.
9152 * @param data The item data.
9153 * @param comp User defined comparison function that defines the sort order based on
9154 * Elm_Gen_Item and its data param.
9155 * @param func Convenience function called when the item is selected.
9156 * @param func_data Data to be passed to @p func.
9157 * @return A handle to the item added or @c NULL, on errors.
9159 * This inserts an item in the gengrid based on user defined comparison function.
9161 * @see elm_gengrid_item_append()
9162 * @see elm_gengrid_item_prepend()
9163 * @see elm_gengrid_item_insert_after()
9164 * @see elm_gengrid_item_del()
9165 * @see elm_gengrid_item_direct_sorted_insert()
9169 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);
9172 * Insert an item in a gengrid widget using a user-defined sort function.
9174 * @param obj The gengrid object.
9175 * @param gic The item class for the item.
9176 * @param data The item data.
9177 * @param comp User defined comparison function that defines the sort order based on
9179 * @param func Convenience function called when the item is selected.
9180 * @param func_data Data to be passed to @p func.
9181 * @return A handle to the item added or @c NULL, on errors.
9183 * This inserts an item in the gengrid based on user defined comparison function.
9185 * @see elm_gengrid_item_append()
9186 * @see elm_gengrid_item_prepend()
9187 * @see elm_gengrid_item_insert_after()
9188 * @see elm_gengrid_item_del()
9189 * @see elm_gengrid_item_sorted_insert()
9193 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);
9196 * Set whether items on a given gengrid widget are to get their
9197 * selection callbacks issued for @b every subsequent selection
9198 * click on them or just for the first click.
9200 * @param obj The gengrid object
9201 * @param always_select @c EINA_TRUE to make items "always
9202 * selected", @c EINA_FALSE, otherwise
9204 * By default, grid items will only call their selection callback
9205 * function when firstly getting selected, any subsequent further
9206 * clicks will do nothing. With this call, you make those
9207 * subsequent clicks also to issue the selection callbacks.
9209 * @note <b>Double clicks</b> will @b always be reported on items.
9211 * @see elm_gengrid_always_select_mode_get()
9215 EAPI void elm_gengrid_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
9218 * Get whether items on a given gengrid widget have their selection
9219 * callbacks issued for @b every subsequent selection click on them
9220 * or just for the first click.
9222 * @param obj The gengrid object.
9223 * @return @c EINA_TRUE if the gengrid items are "always selected",
9224 * @c EINA_FALSE, otherwise
9226 * @see elm_gengrid_always_select_mode_set() for more details
9230 EAPI Eina_Bool elm_gengrid_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9233 * Set whether items on a given gengrid widget can be selected or not.
9235 * @param obj The gengrid object
9236 * @param no_select @c EINA_TRUE to make items selectable,
9237 * @c EINA_FALSE otherwise
9239 * This will make items in @p obj selectable or not. In the latter
9240 * case, any user interaction on the gengrid items will neither make
9241 * them appear selected nor them call their selection callback
9244 * @see elm_gengrid_no_select_mode_get()
9248 EAPI void elm_gengrid_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
9251 * Get whether items on a given gengrid widget can be selected or
9254 * @param obj The gengrid object
9255 * @return @c EINA_TRUE, if items are selectable, @c EINA_FALSE
9258 * @see elm_gengrid_no_select_mode_set() for more details
9262 EAPI Eina_Bool elm_gengrid_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9265 * Enable or disable multi-selection in a given gengrid widget
9267 * @param obj The gengrid object.
9268 * @param multi @c EINA_TRUE, to enable multi-selection,
9269 * @c EINA_FALSE to disable it.
9271 * Multi-selection is the ability to have @b more than one
9272 * item selected, on a given gengrid, simultaneously. When it is
9273 * enabled, a sequence of clicks on different items will make them
9274 * all selected, progressively. A click on an already selected item
9275 * will unselect it. If interacting via the keyboard,
9276 * multi-selection is enabled while holding the "Shift" key.
9278 * @note By default, multi-selection is @b disabled on gengrids
9280 * @see elm_gengrid_multi_select_get()
9284 EAPI void elm_gengrid_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
9287 * Get whether multi-selection is enabled or disabled for a given
9290 * @param obj The gengrid object.
9291 * @return @c EINA_TRUE, if multi-selection is enabled, @c
9292 * EINA_FALSE otherwise
9294 * @see elm_gengrid_multi_select_set() for more details
9298 EAPI Eina_Bool elm_gengrid_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9301 * Enable or disable bouncing effect for a given gengrid widget
9303 * @param obj The gengrid object
9304 * @param h_bounce @c EINA_TRUE, to enable @b horizontal bouncing,
9305 * @c EINA_FALSE to disable it
9306 * @param v_bounce @c EINA_TRUE, to enable @b vertical bouncing,
9307 * @c EINA_FALSE to disable it
9309 * The bouncing effect occurs whenever one reaches the gengrid's
9310 * edge's while panning it -- it will scroll past its limits a
9311 * little bit and return to the edge again, in a animated for,
9314 * @note By default, gengrids have bouncing enabled on both axis
9316 * @see elm_gengrid_bounce_get()
9320 EAPI void elm_gengrid_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
9323 * Get whether bouncing effects are enabled or disabled, for a
9324 * given gengrid widget, on each axis
9326 * @param obj The gengrid object
9327 * @param h_bounce Pointer to a variable where to store the
9328 * horizontal bouncing flag.
9329 * @param v_bounce Pointer to a variable where to store the
9330 * vertical bouncing flag.
9332 * @see elm_gengrid_bounce_set() for more details
9336 EAPI void elm_gengrid_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
9339 * Set a given gengrid widget's scrolling page size, relative to
9340 * its viewport size.
9342 * @param obj The gengrid object
9343 * @param h_pagerel The horizontal page (relative) size
9344 * @param v_pagerel The vertical page (relative) size
9346 * The gengrid's scroller is capable of binding scrolling by the
9347 * user to "pages". It means that, while scrolling and, specially
9348 * after releasing the mouse button, the grid will @b snap to the
9349 * nearest displaying page's area. When page sizes are set, the
9350 * grid's continuous content area is split into (equal) page sized
9353 * This function sets the size of a page <b>relatively to the
9354 * viewport dimensions</b> of the gengrid, for each axis. A value
9355 * @c 1.0 means "the exact viewport's size", in that axis, while @c
9356 * 0.0 turns paging off in that axis. Likewise, @c 0.5 means "half
9357 * a viewport". Sane usable values are, than, between @c 0.0 and @c
9358 * 1.0. Values beyond those will make it behave behave
9359 * inconsistently. If you only want one axis to snap to pages, use
9360 * the value @c 0.0 for the other one.
9362 * There is a function setting page size values in @b absolute
9363 * values, too -- elm_gengrid_page_size_set(). Naturally, its use
9364 * is mutually exclusive to this one.
9366 * @see elm_gengrid_page_relative_get()
9370 EAPI void elm_gengrid_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel) EINA_ARG_NONNULL(1);
9373 * Get a given gengrid widget's scrolling page size, relative to
9374 * its viewport size.
9376 * @param obj The gengrid object
9377 * @param h_pagerel Pointer to a variable where to store the
9378 * horizontal page (relative) size
9379 * @param v_pagerel Pointer to a variable where to store the
9380 * vertical page (relative) size
9382 * @see elm_gengrid_page_relative_set() for more details
9386 EAPI void elm_gengrid_page_relative_get(const Evas_Object *obj, double *h_pagerel, double *v_pagerel) EINA_ARG_NONNULL(1);
9389 * Set a given gengrid widget's scrolling page size
9391 * @param obj The gengrid object
9392 * @param h_pagerel The horizontal page size, in pixels
9393 * @param v_pagerel The vertical page size, in pixels
9395 * The gengrid's scroller is capable of binding scrolling by the
9396 * user to "pages". It means that, while scrolling and, specially
9397 * after releasing the mouse button, the grid will @b snap to the
9398 * nearest displaying page's area. When page sizes are set, the
9399 * grid's continuous content area is split into (equal) page sized
9402 * This function sets the size of a page of the gengrid, in pixels,
9403 * for each axis. Sane usable values are, between @c 0 and the
9404 * dimensions of @p obj, for each axis. Values beyond those will
9405 * make it behave behave inconsistently. If you only want one axis
9406 * to snap to pages, use the value @c 0 for the other one.
9408 * There is a function setting page size values in @b relative
9409 * values, too -- elm_gengrid_page_relative_set(). Naturally, its
9410 * use is mutually exclusive to this one.
9414 EAPI void elm_gengrid_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize) EINA_ARG_NONNULL(1);
9417 * @brief Get gengrid current page number.
9419 * @param obj The gengrid object
9420 * @param h_pagenumber The horizontal page number
9421 * @param v_pagenumber The vertical page number
9423 * The page number starts from 0. 0 is the first page.
9424 * Current page means the page which meet the top-left of the viewport.
9425 * If there are two or more pages in the viewport, it returns the number of page
9426 * which meet the top-left of the viewport.
9428 * @see elm_gengrid_last_page_get()
9429 * @see elm_gengrid_page_show()
9430 * @see elm_gengrid_page_brint_in()
9432 EAPI void elm_gengrid_current_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber) EINA_ARG_NONNULL(1);
9435 * @brief Get scroll last page number.
9437 * @param obj The gengrid object
9438 * @param h_pagenumber The horizontal page number
9439 * @param v_pagenumber The vertical page number
9441 * The page number starts from 0. 0 is the first page.
9442 * This returns the last page number among the pages.
9444 * @see elm_gengrid_current_page_get()
9445 * @see elm_gengrid_page_show()
9446 * @see elm_gengrid_page_brint_in()
9448 EAPI void elm_gengrid_last_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber) EINA_ARG_NONNULL(1);
9451 * Show a specific virtual region within the gengrid content object by page number.
9453 * @param obj The gengrid object
9454 * @param h_pagenumber The horizontal page number
9455 * @param v_pagenumber The vertical page number
9457 * 0, 0 of the indicated page is located at the top-left of the viewport.
9458 * This will jump to the page directly without animation.
9463 * sc = elm_gengrid_add(win);
9464 * elm_gengrid_content_set(sc, content);
9465 * elm_gengrid_page_relative_set(sc, 1, 0);
9466 * elm_gengrid_current_page_get(sc, &h_page, &v_page);
9467 * elm_gengrid_page_show(sc, h_page + 1, v_page);
9470 * @see elm_gengrid_page_bring_in()
9472 EAPI void elm_gengrid_page_show(const Evas_Object *obj, int h_pagenumber, int v_pagenumber) EINA_ARG_NONNULL(1);
9475 * Show a specific virtual region within the gengrid content object by page number.
9477 * @param obj The gengrid object
9478 * @param h_pagenumber The horizontal page number
9479 * @param v_pagenumber The vertical page number
9481 * 0, 0 of the indicated page is located at the top-left of the viewport.
9482 * This will slide to the page with animation.
9487 * sc = elm_gengrid_add(win);
9488 * elm_gengrid_content_set(sc, content);
9489 * elm_gengrid_page_relative_set(sc, 1, 0);
9490 * elm_gengrid_last_page_get(sc, &h_page, &v_page);
9491 * elm_gengrid_page_bring_in(sc, h_page, v_page);
9494 * @see elm_gengrid_page_show()
9496 EAPI void elm_gengrid_page_bring_in(const Evas_Object *obj, int h_pagenumber, int v_pagenumber) EINA_ARG_NONNULL(1);
9499 * Set the direction in which a given gengrid widget will expand while
9500 * placing its items.
9502 * @param obj The gengrid object.
9503 * @param setting @c EINA_TRUE to make the gengrid expand
9504 * horizontally, @c EINA_FALSE to expand vertically.
9506 * When in "horizontal mode" (@c EINA_TRUE), items will be placed
9507 * in @b columns, from top to bottom and, when the space for a
9508 * column is filled, another one is started on the right, thus
9509 * expanding the grid horizontally. When in "vertical mode"
9510 * (@c EINA_FALSE), though, items will be placed in @b rows, from left
9511 * to right and, when the space for a row is filled, another one is
9512 * started below, thus expanding the grid vertically.
9514 * @see elm_gengrid_horizontal_get()
9518 EAPI void elm_gengrid_horizontal_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
9521 * Get for what direction a given gengrid widget will expand while
9522 * placing its items.
9524 * @param obj The gengrid object.
9525 * @return @c EINA_TRUE, if @p obj is set to expand horizontally,
9526 * @c EINA_FALSE if it's set to expand vertically.
9528 * @see elm_gengrid_horizontal_set() for more detais
9532 EAPI Eina_Bool elm_gengrid_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9535 * Get the first item in a given gengrid widget
9537 * @param obj The gengrid object
9538 * @return The first item's handle or @c NULL, if there are no
9539 * items in @p obj (and on errors)
9541 * This returns the first item in the @p obj's internal list of
9544 * @see elm_gengrid_last_item_get()
9548 EAPI Elm_Gengrid_Item *elm_gengrid_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9551 * Get the last item in a given gengrid widget
9553 * @param obj The gengrid object
9554 * @return The last item's handle or @c NULL, if there are no
9555 * items in @p obj (and on errors)
9557 * This returns the last item in the @p obj's internal list of
9560 * @see elm_gengrid_first_item_get()
9564 EAPI Elm_Gengrid_Item *elm_gengrid_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9567 * Get the @b next item in a gengrid widget's internal list of items,
9568 * given a handle to one of those items.
9570 * @param item The gengrid item to fetch next from
9571 * @return The item after @p item, or @c NULL if there's none (and
9574 * This returns the item placed after the @p item, on the container
9577 * @see elm_gengrid_item_prev_get()
9581 EAPI Elm_Gengrid_Item *elm_gengrid_item_next_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9584 * Get the @b previous item in a gengrid widget's internal list of items,
9585 * given a handle to one of those items.
9587 * @param item The gengrid item to fetch previous from
9588 * @return The item before @p item, or @c NULL if there's none (and
9591 * This returns the item placed before the @p item, on the container
9594 * @see elm_gengrid_item_next_get()
9598 EAPI Elm_Gengrid_Item *elm_gengrid_item_prev_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9601 * Get the gengrid object's handle which contains a given gengrid
9604 * @param item The item to fetch the container from
9605 * @return The gengrid (parent) object
9607 * This returns the gengrid object itself that an item belongs to.
9611 EAPI Evas_Object *elm_gengrid_item_gengrid_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9614 * Remove a gengrid item from its parent, deleting it.
9616 * @param item The item to be removed.
9617 * @return @c EINA_TRUE on success or @c EINA_FALSE, otherwise.
9619 * @see elm_gengrid_clear(), to remove all items in a gengrid at
9624 EAPI void elm_gengrid_item_del(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9627 * Update the contents of a given gengrid item
9629 * @param item The gengrid item
9631 * This updates an item by calling all the item class functions
9632 * again to get the contents, texts and states. Use this when the
9633 * original item data has changed and you want the changes to be
9638 EAPI void elm_gengrid_item_update(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9641 * Get the Gengrid Item class for the given Gengrid Item.
9643 * @param item The gengrid item
9645 * This returns the Gengrid_Item_Class for the given item. It can be used to examine
9646 * the function pointers and item_style.
9650 EAPI const Elm_Gengrid_Item_Class *elm_gengrid_item_item_class_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9653 * Get the Gengrid Item class for the given Gengrid Item.
9655 * This sets the Gengrid_Item_Class for the given item. It can be used to examine
9656 * the function pointers and item_style.
9658 * @param item The gengrid item
9659 * @param gic The gengrid item class describing the function pointers and the item style.
9663 EAPI void elm_gengrid_item_item_class_set(Elm_Gengrid_Item *item, const Elm_Gengrid_Item_Class *gic) EINA_ARG_NONNULL(1, 2);
9666 * Return the data associated to a given gengrid item
9668 * @param item The gengrid item.
9669 * @return the data associated with this item.
9671 * This returns the @c data value passed on the
9672 * elm_gengrid_item_append() and related item addition calls.
9674 * @see elm_gengrid_item_append()
9675 * @see elm_gengrid_item_data_set()
9679 EAPI void *elm_gengrid_item_data_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9682 * Set the data associated with a given gengrid item
9684 * @param item The gengrid item
9685 * @param data The data pointer to set on it
9687 * This @b overrides the @c data value passed on the
9688 * elm_gengrid_item_append() and related item addition calls. This
9689 * function @b won't call elm_gengrid_item_update() automatically,
9690 * so you'd issue it afterwards if you want to have the item
9691 * updated to reflect the new data.
9693 * @see elm_gengrid_item_data_get()
9694 * @see elm_gengrid_item_update()
9698 EAPI void elm_gengrid_item_data_set(Elm_Gengrid_Item *item, const void *data) EINA_ARG_NONNULL(1);
9701 * Get a given gengrid item's position, relative to the whole
9702 * gengrid's grid area.
9704 * @param item The Gengrid item.
9705 * @param x Pointer to variable to store the item's <b>row number</b>.
9706 * @param y Pointer to variable to store the item's <b>column number</b>.
9708 * This returns the "logical" position of the item within the
9709 * gengrid. For example, @c (0, 1) would stand for first row,
9714 EAPI void elm_gengrid_item_pos_get(const Elm_Gengrid_Item *item, unsigned int *x, unsigned int *y) EINA_ARG_NONNULL(1);
9717 * Set whether a given gengrid item is selected or not
9719 * @param item The gengrid item
9720 * @param selected Use @c EINA_TRUE, to make it selected, @c
9721 * EINA_FALSE to make it unselected
9723 * This sets the selected state of an item. If multi-selection is
9724 * not enabled on the containing gengrid and @p selected is @c
9725 * EINA_TRUE, any other previously selected items will get
9726 * unselected in favor of this new one.
9728 * @see elm_gengrid_item_selected_get()
9732 EAPI void elm_gengrid_item_selected_set(Elm_Gengrid_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
9735 * Get whether a given gengrid item is selected or not
9737 * @param item The gengrid item
9738 * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
9740 * This API returns EINA_TRUE for all the items selected in multi-select mode as well.
9742 * @see elm_gengrid_item_selected_set() for more details
9746 EAPI Eina_Bool elm_gengrid_item_selected_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9749 * Get the real Evas object created to implement the view of a
9750 * given gengrid item
9752 * @param item The gengrid item.
9753 * @return the Evas object implementing this item's view.
9755 * This returns the actual Evas object used to implement the
9756 * specified gengrid item's view. This may be @c NULL, as it may
9757 * not have been created or may have been deleted, at any time, by
9758 * the gengrid. <b>Do not modify this object</b> (move, resize,
9759 * show, hide, etc.), as the gengrid is controlling it. This
9760 * function is for querying, emitting custom signals or hooking
9761 * lower level callbacks for events on that object. Do not delete
9762 * this object under any circumstances.
9764 * @see elm_gengrid_item_data_get()
9768 EAPI const Evas_Object *elm_gengrid_item_object_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9771 * Show the portion of a gengrid's internal grid containing a given
9772 * item, @b immediately.
9774 * @param item The item to display
9776 * This causes gengrid to @b redraw its viewport's contents to the
9777 * region contining the given @p item item, if it is not fully
9780 * @see elm_gengrid_item_bring_in()
9784 EAPI void elm_gengrid_item_show(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9787 * Animatedly bring in, to the visible area of a gengrid, a given
9790 * @param item The gengrid item to display
9792 * This causes gengrid to jump to the given @p item and show
9793 * it (by scrolling), if it is not fully visible. This will use
9794 * animation to do so and take a period of time to complete.
9796 * @see elm_gengrid_item_show()
9800 EAPI void elm_gengrid_item_bring_in(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9803 * Set whether a given gengrid item is disabled or not.
9805 * @param item The gengrid item
9806 * @param disabled Use @c EINA_TRUE, true disable it, @c EINA_FALSE
9807 * to enable it back.
9809 * A disabled item cannot be selected or unselected. It will also
9810 * change its appearance, to signal the user it's disabled.
9812 * @see elm_gengrid_item_disabled_get()
9816 EAPI void elm_gengrid_item_disabled_set(Elm_Gengrid_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
9819 * Get whether a given gengrid item is disabled or not.
9821 * @param item The gengrid item
9822 * @return @c EINA_TRUE, if it's disabled, @c EINA_FALSE otherwise
9825 * @see elm_gengrid_item_disabled_set() for more details
9829 EAPI Eina_Bool elm_gengrid_item_disabled_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9832 * Set the text to be shown in a given gengrid item's tooltips.
9834 * @param item The gengrid item
9835 * @param text The text to set in the content
9837 * This call will setup the text to be used as tooltip to that item
9838 * (analogous to elm_object_tooltip_text_set(), but being item
9839 * tooltips with higher precedence than object tooltips). It can
9840 * have only one tooltip at a time, so any previous tooltip data
9845 EAPI void elm_gengrid_item_tooltip_text_set(Elm_Gengrid_Item *item, const char *text) EINA_ARG_NONNULL(1);
9848 * Set the content to be shown in a given gengrid item's tooltip
9850 * @param item The gengrid item.
9851 * @param func The function returning the tooltip contents.
9852 * @param data What to provide to @a func as callback data/context.
9853 * @param del_cb Called when data is not needed anymore, either when
9854 * another callback replaces @p func, the tooltip is unset with
9855 * elm_gengrid_item_tooltip_unset() or the owner @p item
9856 * dies. This callback receives as its first parameter the
9857 * given @p data, being @c event_info the item handle.
9859 * This call will setup the tooltip's contents to @p item
9860 * (analogous to elm_object_tooltip_content_cb_set(), but being
9861 * item tooltips with higher precedence than object tooltips). It
9862 * can have only one tooltip at a time, so any previous tooltip
9863 * content will get removed. @p func (with @p data) will be called
9864 * every time Elementary needs to show the tooltip and it should
9865 * return a valid Evas object, which will be fully managed by the
9866 * tooltip system, getting deleted when the tooltip is gone.
9870 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);
9873 * Unset a tooltip from a given gengrid item
9875 * @param item gengrid item to remove a previously set tooltip from.
9877 * This call removes any tooltip set on @p item. The callback
9878 * provided as @c del_cb to
9879 * elm_gengrid_item_tooltip_content_cb_set() will be called to
9880 * notify it is not used anymore (and have resources cleaned, if
9883 * @see elm_gengrid_item_tooltip_content_cb_set()
9887 EAPI void elm_gengrid_item_tooltip_unset(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9890 * Set a different @b style for a given gengrid item's tooltip.
9892 * @param item gengrid item with tooltip set
9893 * @param style the <b>theme style</b> to use on tooltips (e.g. @c
9894 * "default", @c "transparent", etc)
9896 * Tooltips can have <b>alternate styles</b> to be displayed on,
9897 * which are defined by the theme set on Elementary. This function
9898 * works analogously as elm_object_tooltip_style_set(), but here
9899 * applied only to gengrid item objects. The default style for
9900 * tooltips is @c "default".
9902 * @note before you set a style you should define a tooltip with
9903 * elm_gengrid_item_tooltip_content_cb_set() or
9904 * elm_gengrid_item_tooltip_text_set()
9906 * @see elm_gengrid_item_tooltip_style_get()
9910 EAPI void elm_gengrid_item_tooltip_style_set(Elm_Gengrid_Item *item, const char *style) EINA_ARG_NONNULL(1);
9913 * Get the style set a given gengrid item's tooltip.
9915 * @param item gengrid item with tooltip already set on.
9916 * @return style the theme style in use, which defaults to
9917 * "default". If the object does not have a tooltip set,
9918 * then @c NULL is returned.
9920 * @see elm_gengrid_item_tooltip_style_set() for more details
9924 EAPI const char *elm_gengrid_item_tooltip_style_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9927 * @brief Disable size restrictions on an object's tooltip
9928 * @param item The tooltip's anchor object
9929 * @param disable If EINA_TRUE, size restrictions are disabled
9930 * @return EINA_FALSE on failure, EINA_TRUE on success
9932 * This function allows a tooltip to expand beyond its parant window's canvas.
9933 * It will instead be limited only by the size of the display.
9935 EAPI Eina_Bool elm_gengrid_item_tooltip_window_mode_set(Elm_Gengrid_Item *item, Eina_Bool disable);
9938 * @brief Retrieve size restriction state of an object's tooltip
9939 * @param item The tooltip's anchor object
9940 * @return If EINA_TRUE, size restrictions are disabled
9942 * This function returns whether a tooltip is allowed to expand beyond
9943 * its parant window's canvas.
9944 * It will instead be limited only by the size of the display.
9946 EAPI Eina_Bool elm_gengrid_item_tooltip_window_mode_get(const Elm_Gengrid_Item *item);
9949 * Set the type of mouse pointer/cursor decoration to be shown,
9950 * when the mouse pointer is over the given gengrid widget item
9952 * @param item gengrid item to customize cursor on
9953 * @param cursor the cursor type's name
9955 * This function works analogously as elm_object_cursor_set(), but
9956 * here the cursor's changing area is restricted to the item's
9957 * area, and not the whole widget's. Note that that item cursors
9958 * have precedence over widget cursors, so that a mouse over @p
9959 * item will always show cursor @p type.
9961 * If this function is called twice for an object, a previously set
9962 * cursor will be unset on the second call.
9964 * @see elm_object_cursor_set()
9965 * @see elm_gengrid_item_cursor_get()
9966 * @see elm_gengrid_item_cursor_unset()
9970 EAPI void elm_gengrid_item_cursor_set(Elm_Gengrid_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
9973 * Get the type of mouse pointer/cursor decoration set to be shown,
9974 * when the mouse pointer is over the given gengrid widget item
9976 * @param item gengrid item with custom cursor set
9977 * @return the cursor type's name or @c NULL, if no custom cursors
9978 * were set to @p item (and on errors)
9980 * @see elm_object_cursor_get()
9981 * @see elm_gengrid_item_cursor_set() for more details
9982 * @see elm_gengrid_item_cursor_unset()
9986 EAPI const char *elm_gengrid_item_cursor_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9989 * Unset any custom mouse pointer/cursor decoration set to be
9990 * shown, when the mouse pointer is over the given gengrid widget
9991 * item, thus making it show the @b default cursor again.
9993 * @param item a gengrid item
9995 * Use this call to undo any custom settings on this item's cursor
9996 * decoration, bringing it back to defaults (no custom style set).
9998 * @see elm_object_cursor_unset()
9999 * @see elm_gengrid_item_cursor_set() for more details
10003 EAPI void elm_gengrid_item_cursor_unset(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
10006 * Set a different @b style for a given custom cursor set for a
10009 * @param item gengrid item with custom cursor set
10010 * @param style the <b>theme style</b> to use (e.g. @c "default",
10011 * @c "transparent", etc)
10013 * This function only makes sense when one is using custom mouse
10014 * cursor decorations <b>defined in a theme file</b> , which can
10015 * have, given a cursor name/type, <b>alternate styles</b> on
10016 * it. It works analogously as elm_object_cursor_style_set(), but
10017 * here applied only to gengrid item objects.
10019 * @warning Before you set a cursor style you should have defined a
10020 * custom cursor previously on the item, with
10021 * elm_gengrid_item_cursor_set()
10023 * @see elm_gengrid_item_cursor_engine_only_set()
10024 * @see elm_gengrid_item_cursor_style_get()
10028 EAPI void elm_gengrid_item_cursor_style_set(Elm_Gengrid_Item *item, const char *style) EINA_ARG_NONNULL(1);
10031 * Get the current @b style set for a given gengrid item's custom
10034 * @param item gengrid item with custom cursor set.
10035 * @return style the cursor style in use. If the object does not
10036 * have a cursor set, then @c NULL is returned.
10038 * @see elm_gengrid_item_cursor_style_set() for more details
10042 EAPI const char *elm_gengrid_item_cursor_style_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
10045 * Set if the (custom) cursor for a given gengrid item should be
10046 * searched in its theme, also, or should only rely on the
10047 * rendering engine.
10049 * @param item item with custom (custom) cursor already set on
10050 * @param engine_only Use @c EINA_TRUE to have cursors looked for
10051 * only on those provided by the rendering engine, @c EINA_FALSE to
10052 * have them searched on the widget's theme, as well.
10054 * @note This call is of use only if you've set a custom cursor
10055 * for gengrid items, with elm_gengrid_item_cursor_set().
10057 * @note By default, cursors will only be looked for between those
10058 * provided by the rendering engine.
10062 EAPI void elm_gengrid_item_cursor_engine_only_set(Elm_Gengrid_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
10065 * Get if the (custom) cursor for a given gengrid item is being
10066 * searched in its theme, also, or is only relying on the rendering
10069 * @param item a gengrid item
10070 * @return @c EINA_TRUE, if cursors are being looked for only on
10071 * those provided by the rendering engine, @c EINA_FALSE if they
10072 * are being searched on the widget's theme, as well.
10074 * @see elm_gengrid_item_cursor_engine_only_set(), for more details
10078 EAPI Eina_Bool elm_gengrid_item_cursor_engine_only_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
10081 * Remove all items from a given gengrid widget
10083 * @param obj The gengrid object.
10085 * This removes (and deletes) all items in @p obj, leaving it
10088 * @see elm_gengrid_item_del(), to remove just one item.
10092 EAPI void elm_gengrid_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
10095 * Get the selected item in a given gengrid widget
10097 * @param obj The gengrid object.
10098 * @return The selected item's handleor @c NULL, if none is
10099 * selected at the moment (and on errors)
10101 * This returns the selected item in @p obj. If multi selection is
10102 * enabled on @p obj (@see elm_gengrid_multi_select_set()), only
10103 * the first item in the list is selected, which might not be very
10104 * useful. For that case, see elm_gengrid_selected_items_get().
10108 EAPI Elm_Gengrid_Item *elm_gengrid_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10111 * Get <b>a list</b> of selected items in a given gengrid
10113 * @param obj The gengrid object.
10114 * @return The list of selected items or @c NULL, if none is
10115 * selected at the moment (and on errors)
10117 * This returns a list of the selected items, in the order that
10118 * they appear in the grid. This list is only valid as long as no
10119 * more items are selected or unselected (or unselected implictly
10120 * by deletion). The list contains #Elm_Gengrid_Item pointers as
10123 * @see elm_gengrid_selected_item_get()
10127 EAPI const Eina_List *elm_gengrid_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10134 * @defgroup Clock Clock
10136 * @image html img/widget/clock/preview-00.png
10137 * @image latex img/widget/clock/preview-00.eps
10139 * This is a @b digital clock widget. In its default theme, it has a
10140 * vintage "flipping numbers clock" appearance, which will animate
10141 * sheets of individual algarisms individually as time goes by.
10143 * A newly created clock will fetch system's time (already
10144 * considering local time adjustments) to start with, and will tick
10145 * accondingly. It may or may not show seconds.
10147 * Clocks have an @b edition mode. When in it, the sheets will
10148 * display extra arrow indications on the top and bottom and the
10149 * user may click on them to raise or lower the time values. After
10150 * it's told to exit edition mode, it will keep ticking with that
10151 * new time set (it keeps the difference from local time).
10153 * Also, when under edition mode, user clicks on the cited arrows
10154 * which are @b held for some time will make the clock to flip the
10155 * sheet, thus editing the time, continuosly and automatically for
10156 * the user. The interval between sheet flips will keep growing in
10157 * time, so that it helps the user to reach a time which is distant
10158 * from the one set.
10160 * The time display is, by default, in military mode (24h), but an
10161 * am/pm indicator may be optionally shown, too, when it will
10164 * Smart callbacks one can register to:
10165 * - "changed" - the clock's user changed the time
10167 * Here is an example on its usage:
10168 * @li @ref clock_example
10172 * @addtogroup Clock
10177 * Identifiers for which clock digits should be editable, when a
10178 * clock widget is in edition mode. Values may be ORed together to
10179 * make a mask, naturally.
10181 * @see elm_clock_edit_set()
10182 * @see elm_clock_digit_edit_set()
10184 typedef enum _Elm_Clock_Digedit
10186 ELM_CLOCK_NONE = 0, /**< Default value. Means that all digits are editable, when in edition mode. */
10187 ELM_CLOCK_HOUR_DECIMAL = 1 << 0, /**< Decimal algarism of hours value should be editable */
10188 ELM_CLOCK_HOUR_UNIT = 1 << 1, /**< Unit algarism of hours value should be editable */
10189 ELM_CLOCK_MIN_DECIMAL = 1 << 2, /**< Decimal algarism of minutes value should be editable */
10190 ELM_CLOCK_MIN_UNIT = 1 << 3, /**< Unit algarism of minutes value should be editable */
10191 ELM_CLOCK_SEC_DECIMAL = 1 << 4, /**< Decimal algarism of seconds value should be editable */
10192 ELM_CLOCK_SEC_UNIT = 1 << 5, /**< Unit algarism of seconds value should be editable */
10193 ELM_CLOCK_ALL = (1 << 6) - 1 /**< All digits should be editable */
10194 } Elm_Clock_Digedit;
10197 * Add a new clock widget to the given parent Elementary
10198 * (container) object
10200 * @param parent The parent object
10201 * @return a new clock widget handle or @c NULL, on errors
10203 * This function inserts a new clock widget on the canvas.
10207 EAPI Evas_Object *elm_clock_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10210 * Set a clock widget's time, programmatically
10212 * @param obj The clock widget object
10213 * @param hrs The hours to set
10214 * @param min The minutes to set
10215 * @param sec The secondes to set
10217 * This function updates the time that is showed by the clock
10220 * Values @b must be set within the following ranges:
10221 * - 0 - 23, for hours
10222 * - 0 - 59, for minutes
10223 * - 0 - 59, for seconds,
10225 * even if the clock is not in "military" mode.
10227 * @warning The behavior for values set out of those ranges is @b
10232 EAPI void elm_clock_time_set(Evas_Object *obj, int hrs, int min, int sec) EINA_ARG_NONNULL(1);
10235 * Get a clock widget's time values
10237 * @param obj The clock object
10238 * @param[out] hrs Pointer to the variable to get the hours value
10239 * @param[out] min Pointer to the variable to get the minutes value
10240 * @param[out] sec Pointer to the variable to get the seconds value
10242 * This function gets the time set for @p obj, returning
10243 * it on the variables passed as the arguments to function
10245 * @note Use @c NULL pointers on the time values you're not
10246 * interested in: they'll be ignored by the function.
10250 EAPI void elm_clock_time_get(const Evas_Object *obj, int *hrs, int *min, int *sec) EINA_ARG_NONNULL(1);
10253 * Set whether a given clock widget is under <b>edition mode</b> or
10254 * under (default) displaying-only mode.
10256 * @param obj The clock object
10257 * @param edit @c EINA_TRUE to put it in edition, @c EINA_FALSE to
10258 * put it back to "displaying only" mode
10260 * This function makes a clock's time to be editable or not <b>by
10261 * user interaction</b>. When in edition mode, clocks @b stop
10262 * ticking, until one brings them back to canonical mode. The
10263 * elm_clock_digit_edit_set() function will influence which digits
10264 * of the clock will be editable. By default, all of them will be
10265 * (#ELM_CLOCK_NONE).
10267 * @note am/pm sheets, if being shown, will @b always be editable
10268 * under edition mode.
10270 * @see elm_clock_edit_get()
10274 EAPI void elm_clock_edit_set(Evas_Object *obj, Eina_Bool edit) EINA_ARG_NONNULL(1);
10277 * Retrieve whether a given clock widget is under <b>edition
10278 * mode</b> or under (default) displaying-only mode.
10280 * @param obj The clock object
10281 * @param edit @c EINA_TRUE, if it's in edition mode, @c EINA_FALSE
10284 * This function retrieves whether the clock's time can be edited
10285 * or not by user interaction.
10287 * @see elm_clock_edit_set() for more details
10291 EAPI Eina_Bool elm_clock_edit_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10294 * Set what digits of the given clock widget should be editable
10295 * when in edition mode.
10297 * @param obj The clock object
10298 * @param digedit Bit mask indicating the digits to be editable
10299 * (values in #Elm_Clock_Digedit).
10301 * If the @p digedit param is #ELM_CLOCK_NONE, editing will be
10302 * disabled on @p obj (same effect as elm_clock_edit_set(), with @c
10305 * @see elm_clock_digit_edit_get()
10309 EAPI void elm_clock_digit_edit_set(Evas_Object *obj, Elm_Clock_Digedit digedit) EINA_ARG_NONNULL(1);
10312 * Retrieve what digits of the given clock widget should be
10313 * editable when in edition mode.
10315 * @param obj The clock object
10316 * @return Bit mask indicating the digits to be editable
10317 * (values in #Elm_Clock_Digedit).
10319 * @see elm_clock_digit_edit_set() for more details
10323 EAPI Elm_Clock_Digedit elm_clock_digit_edit_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10326 * Set if the given clock widget must show hours in military or
10329 * @param obj The clock object
10330 * @param am_pm @c EINA_TRUE to put it in am/pm mode, @c EINA_FALSE
10333 * This function sets if the clock must show hours in military or
10334 * am/pm mode. In some countries like Brazil the military mode
10335 * (00-24h-format) is used, in opposition to the USA, where the
10336 * am/pm mode is more commonly used.
10338 * @see elm_clock_show_am_pm_get()
10342 EAPI void elm_clock_show_am_pm_set(Evas_Object *obj, Eina_Bool am_pm) EINA_ARG_NONNULL(1);
10345 * Get if the given clock widget shows hours in military or am/pm
10348 * @param obj The clock object
10349 * @return @c EINA_TRUE, if in am/pm mode, @c EINA_FALSE if in
10352 * This function gets if the clock shows hours in military or am/pm
10355 * @see elm_clock_show_am_pm_set() for more details
10359 EAPI Eina_Bool elm_clock_show_am_pm_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10362 * Set if the given clock widget must show time with seconds or not
10364 * @param obj The clock object
10365 * @param seconds @c EINA_TRUE to show seconds, @c EINA_FALSE otherwise
10367 * This function sets if the given clock must show or not elapsed
10368 * seconds. By default, they are @b not shown.
10370 * @see elm_clock_show_seconds_get()
10374 EAPI void elm_clock_show_seconds_set(Evas_Object *obj, Eina_Bool seconds) EINA_ARG_NONNULL(1);
10377 * Get whether the given clock widget is showing time with seconds
10380 * @param obj The clock object
10381 * @return @c EINA_TRUE if it's showing seconds, @c EINA_FALSE otherwise
10383 * This function gets whether @p obj is showing or not the elapsed
10386 * @see elm_clock_show_seconds_set()
10390 EAPI Eina_Bool elm_clock_show_seconds_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10393 * Set the interval on time updates for an user mouse button hold
10394 * on clock widgets' time edition.
10396 * @param obj The clock object
10397 * @param interval The (first) interval value in seconds
10399 * This interval value is @b decreased while the user holds the
10400 * mouse pointer either incrementing or decrementing a given the
10401 * clock digit's value.
10403 * This helps the user to get to a given time distant from the
10404 * current one easier/faster, as it will start to flip quicker and
10405 * quicker on mouse button holds.
10407 * The calculation for the next flip interval value, starting from
10408 * the one set with this call, is the previous interval divided by
10409 * 1.05, so it decreases a little bit.
10411 * The default starting interval value for automatic flips is
10414 * @see elm_clock_interval_get()
10418 EAPI void elm_clock_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
10421 * Get the interval on time updates for an user mouse button hold
10422 * on clock widgets' time edition.
10424 * @param obj The clock object
10425 * @return The (first) interval value, in seconds, set on it
10427 * @see elm_clock_interval_set() for more details
10431 EAPI double elm_clock_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10438 * @defgroup Layout Layout
10440 * @image html img/widget/layout/preview-00.png
10441 * @image latex img/widget/layout/preview-00.eps width=\textwidth
10443 * @image html img/layout-predefined.png
10444 * @image latex img/layout-predefined.eps width=\textwidth
10446 * This is a container widget that takes a standard Edje design file and
10447 * wraps it very thinly in a widget.
10449 * An Edje design (theme) file has a very wide range of possibilities to
10450 * describe the behavior of elements added to the Layout. Check out the Edje
10451 * documentation and the EDC reference to get more information about what can
10452 * be done with Edje.
10454 * Just like @ref List, @ref Box, and other container widgets, any
10455 * object added to the Layout will become its child, meaning that it will be
10456 * deleted if the Layout is deleted, move if the Layout is moved, and so on.
10458 * The Layout widget can contain as many Contents, Boxes or Tables as
10459 * described in its theme file. For instance, objects can be added to
10460 * different Tables by specifying the respective Table part names. The same
10461 * is valid for Content and Box.
10463 * The objects added as child of the Layout will behave as described in the
10464 * part description where they were added. There are 3 possible types of
10465 * parts where a child can be added:
10467 * @section secContent Content (SWALLOW part)
10469 * Only one object can be added to the @c SWALLOW part (but you still can
10470 * have many @c SWALLOW parts and one object on each of them). Use the @c
10471 * elm_object_content_set/get/unset functions to set, retrieve and unset
10472 * objects as content of the @c SWALLOW. After being set to this part, the
10473 * object size, position, visibility, clipping and other description
10474 * properties will be totally controlled by the description of the given part
10475 * (inside the Edje theme file).
10477 * One can use @c evas_object_size_hint_* functions on the child to have some
10478 * kind of control over its behavior, but the resulting behavior will still
10479 * depend heavily on the @c SWALLOW part description.
10481 * The Edje theme also can change the part description, based on signals or
10482 * scripts running inside the theme. This change can also be animated. All of
10483 * this will affect the child object set as content accordingly. The object
10484 * size will be changed if the part size is changed, it will animate move if
10485 * the part is moving, and so on.
10487 * The following picture demonstrates a Layout widget with a child object
10488 * added to its @c SWALLOW:
10490 * @image html layout_swallow.png
10491 * @image latex layout_swallow.eps width=\textwidth
10493 * @section secBox Box (BOX part)
10495 * An Edje @c BOX part is very similar to the Elementary @ref Box widget. It
10496 * allows one to add objects to the box and have them distributed along its
10497 * area, accordingly to the specified @a layout property (now by @a layout we
10498 * mean the chosen layouting design of the Box, not the Layout widget
10501 * A similar effect for having a box with its position, size and other things
10502 * controlled by the Layout theme would be to create an Elementary @ref Box
10503 * widget and add it as a Content in the @c SWALLOW part.
10505 * The main difference of using the Layout Box is that its behavior, the box
10506 * properties like layouting format, padding, align, etc. will be all
10507 * controlled by the theme. This means, for example, that a signal could be
10508 * sent to the Layout theme (with elm_object_signal_emit()) and the theme
10509 * handled the signal by changing the box padding, or align, or both. Using
10510 * the Elementary @ref Box widget is not necessarily harder or easier, it
10511 * just depends on the circunstances and requirements.
10513 * The Layout Box can be used through the @c elm_layout_box_* set of
10516 * The following picture demonstrates a Layout widget with many child objects
10517 * added to its @c BOX part:
10519 * @image html layout_box.png
10520 * @image latex layout_box.eps width=\textwidth
10522 * @section secTable Table (TABLE part)
10524 * Just like the @ref secBox, the Layout Table is very similar to the
10525 * Elementary @ref Table widget. It allows one to add objects to the Table
10526 * specifying the row and column where the object should be added, and any
10527 * column or row span if necessary.
10529 * Again, we could have this design by adding a @ref Table widget to the @c
10530 * SWALLOW part using elm_object_part_content_set(). The same difference happens
10531 * here when choosing to use the Layout Table (a @c TABLE part) instead of
10532 * the @ref Table plus @c SWALLOW part. It's just a matter of convenience.
10534 * The Layout Table can be used through the @c elm_layout_table_* set of
10537 * The following picture demonstrates a Layout widget with many child objects
10538 * added to its @c TABLE part:
10540 * @image html layout_table.png
10541 * @image latex layout_table.eps width=\textwidth
10543 * @section secPredef Predefined Layouts
10545 * Another interesting thing about the Layout widget is that it offers some
10546 * predefined themes that come with the default Elementary theme. These
10547 * themes can be set by the call elm_layout_theme_set(), and provide some
10548 * basic functionality depending on the theme used.
10550 * Most of them already send some signals, some already provide a toolbar or
10551 * back and next buttons.
10553 * These are available predefined theme layouts. All of them have class = @c
10554 * layout, group = @c application, and style = one of the following options:
10556 * @li @c toolbar-content - application with toolbar and main content area
10557 * @li @c toolbar-content-back - application with toolbar and main content
10558 * area with a back button and title area
10559 * @li @c toolbar-content-back-next - application with toolbar and main
10560 * content area with a back and next buttons and title area
10561 * @li @c content-back - application with a main content area with a back
10562 * button and title area
10563 * @li @c content-back-next - application with a main content area with a
10564 * back and next buttons and title area
10565 * @li @c toolbar-vbox - application with toolbar and main content area as a
10567 * @li @c toolbar-table - application with toolbar and main content area as a
10570 * @section secExamples Examples
10572 * Some examples of the Layout widget can be found here:
10573 * @li @ref layout_example_01
10574 * @li @ref layout_example_02
10575 * @li @ref layout_example_03
10576 * @li @ref layout_example_edc
10581 * Add a new layout to the parent
10583 * @param parent The parent object
10584 * @return The new object or NULL if it cannot be created
10586 * @see elm_layout_file_set()
10587 * @see elm_layout_theme_set()
10591 EAPI Evas_Object *elm_layout_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10594 * Set the file that will be used as layout
10596 * @param obj The layout object
10597 * @param file The path to file (edj) that will be used as layout
10598 * @param group The group that the layout belongs in edje file
10600 * @return (1 = success, 0 = error)
10604 EAPI Eina_Bool elm_layout_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1);
10607 * Set the edje group from the elementary theme that will be used as layout
10609 * @param obj The layout object
10610 * @param clas the clas of the group
10611 * @param group the group
10612 * @param style the style to used
10614 * @return (1 = success, 0 = error)
10618 EAPI Eina_Bool elm_layout_theme_set(Evas_Object *obj, const char *clas, const char *group, const char *style) EINA_ARG_NONNULL(1);
10621 * Set the layout content.
10623 * @param obj The layout object
10624 * @param swallow The swallow part name in the edje file
10625 * @param content The child that will be added in this layout object
10627 * Once the content object is set, a previously set one will be deleted.
10628 * If you want to keep that old content object, use the
10629 * elm_object_part_content_unset() function.
10631 * @note In an Edje theme, the part used as a content container is called @c
10632 * SWALLOW. This is why the parameter name is called @p swallow, but it is
10633 * expected to be a part name just like the second parameter of
10634 * elm_layout_box_append().
10636 * @see elm_layout_box_append()
10637 * @see elm_object_part_content_get()
10638 * @see elm_object_part_content_unset()
10640 * @deprecated use elm_object_part_content_set() instead
10644 EINA_DEPRECATED EAPI void elm_layout_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content) EINA_ARG_NONNULL(1);
10647 * Get the child object in the given content part.
10649 * @param obj The layout object
10650 * @param swallow The SWALLOW part to get its content
10652 * @return The swallowed object or NULL if none or an error occurred
10654 * @deprecated use elm_object_part_content_get() instead
10658 EINA_DEPRECATED EAPI Evas_Object *elm_layout_content_get(const Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
10661 * Unset the layout content.
10663 * @param obj The layout object
10664 * @param swallow The swallow part name in the edje file
10665 * @return The content that was being used
10667 * Unparent and return the content object which was set for this part.
10669 * @deprecated use elm_object_part_content_unset() instead
10673 EINA_DEPRECATED EAPI Evas_Object *elm_layout_content_unset(Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
10676 * Set the text of the given part
10678 * @param obj The layout object
10679 * @param part The TEXT part where to set the text
10680 * @param text The text to set
10683 * @deprecated use elm_object_part_text_set() instead.
10685 EINA_DEPRECATED EAPI void elm_layout_text_set(Evas_Object *obj, const char *part, const char *text) EINA_ARG_NONNULL(1);
10688 * Get the text set in the given part
10690 * @param obj The layout object
10691 * @param part The TEXT part to retrieve the text off
10693 * @return The text set in @p part
10696 * @deprecated use elm_object_part_text_get() instead.
10698 EINA_DEPRECATED EAPI const char *elm_layout_text_get(const Evas_Object *obj, const char *part) EINA_ARG_NONNULL(1);
10701 * Append child to layout box part.
10703 * @param obj the layout object
10704 * @param part the box part to which the object will be appended.
10705 * @param child the child object to append to box.
10707 * Once the object is appended, it will become child of the layout. Its
10708 * lifetime will be bound to the layout, whenever the layout dies the child
10709 * will be deleted automatically. One should use elm_layout_box_remove() to
10710 * make this layout forget about the object.
10712 * @see elm_layout_box_prepend()
10713 * @see elm_layout_box_insert_before()
10714 * @see elm_layout_box_insert_at()
10715 * @see elm_layout_box_remove()
10719 EAPI void elm_layout_box_append(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1);
10722 * Prepend child to layout box part.
10724 * @param obj the layout object
10725 * @param part the box part to prepend.
10726 * @param child the child object to prepend to box.
10728 * Once the object is prepended, it will become child of the layout. Its
10729 * lifetime will be bound to the layout, whenever the layout dies the child
10730 * will be deleted automatically. One should use elm_layout_box_remove() to
10731 * make this layout forget about the object.
10733 * @see elm_layout_box_append()
10734 * @see elm_layout_box_insert_before()
10735 * @see elm_layout_box_insert_at()
10736 * @see elm_layout_box_remove()
10740 EAPI void elm_layout_box_prepend(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1);
10743 * Insert child to layout box part before a reference object.
10745 * @param obj the layout object
10746 * @param part the box part to insert.
10747 * @param child the child object to insert into box.
10748 * @param reference another reference object to insert before in box.
10750 * Once the object is inserted, it will become child of the layout. Its
10751 * lifetime will be bound to the layout, whenever the layout dies the child
10752 * will be deleted automatically. One should use elm_layout_box_remove() to
10753 * make this layout forget about the object.
10755 * @see elm_layout_box_append()
10756 * @see elm_layout_box_prepend()
10757 * @see elm_layout_box_insert_before()
10758 * @see elm_layout_box_remove()
10762 EAPI void elm_layout_box_insert_before(Evas_Object *obj, const char *part, Evas_Object *child, const Evas_Object *reference) EINA_ARG_NONNULL(1);
10765 * Insert child to layout box part at a given position.
10767 * @param obj the layout object
10768 * @param part the box part to insert.
10769 * @param child the child object to insert into box.
10770 * @param pos the numeric position >=0 to insert the child.
10772 * Once the object is inserted, it will become child of the layout. Its
10773 * lifetime will be bound to the layout, whenever the layout dies the child
10774 * will be deleted automatically. One should use elm_layout_box_remove() to
10775 * make this layout forget about the object.
10777 * @see elm_layout_box_append()
10778 * @see elm_layout_box_prepend()
10779 * @see elm_layout_box_insert_before()
10780 * @see elm_layout_box_remove()
10784 EAPI void elm_layout_box_insert_at(Evas_Object *obj, const char *part, Evas_Object *child, unsigned int pos) EINA_ARG_NONNULL(1);
10787 * Remove a child of the given part box.
10789 * @param obj The layout object
10790 * @param part The box part name to remove child.
10791 * @param child The object to remove from box.
10792 * @return The object that was being used, or NULL if not found.
10794 * The object will be removed from the box part and its lifetime will
10795 * not be handled by the layout anymore. This is equivalent to
10796 * elm_object_part_content_unset() for box.
10798 * @see elm_layout_box_append()
10799 * @see elm_layout_box_remove_all()
10803 EAPI Evas_Object *elm_layout_box_remove(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1, 2, 3);
10806 * Remove all children of the given part box.
10808 * @param obj The layout object
10809 * @param part The box part name to remove child.
10810 * @param clear If EINA_TRUE, then all objects will be deleted as
10811 * well, otherwise they will just be removed and will be
10812 * dangling on the canvas.
10814 * The objects will be removed from the box part and their lifetime will
10815 * not be handled by the layout anymore. This is equivalent to
10816 * elm_layout_box_remove() for all box children.
10818 * @see elm_layout_box_append()
10819 * @see elm_layout_box_remove()
10823 EAPI void elm_layout_box_remove_all(Evas_Object *obj, const char *part, Eina_Bool clear) EINA_ARG_NONNULL(1, 2);
10826 * Insert child to layout table part.
10828 * @param obj the layout object
10829 * @param part the box part to pack child.
10830 * @param child_obj the child object to pack into table.
10831 * @param col the column to which the child should be added. (>= 0)
10832 * @param row the row to which the child should be added. (>= 0)
10833 * @param colspan how many columns should be used to store this object. (>=
10835 * @param rowspan how many rows should be used to store this object. (>= 1)
10837 * Once the object is inserted, it will become child of the table. Its
10838 * lifetime will be bound to the layout, and whenever the layout dies the
10839 * child will be deleted automatically. One should use
10840 * elm_layout_table_remove() to make this layout forget about the object.
10842 * If @p colspan or @p rowspan are bigger than 1, that object will occupy
10843 * more space than a single cell. For instance, the following code:
10845 * elm_layout_table_pack(layout, "table_part", child, 0, 1, 3, 1);
10848 * Would result in an object being added like the following picture:
10850 * @image html layout_colspan.png
10851 * @image latex layout_colspan.eps width=\textwidth
10853 * @see elm_layout_table_unpack()
10854 * @see elm_layout_table_clear()
10858 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);
10861 * Unpack (remove) a child of the given part table.
10863 * @param obj The layout object
10864 * @param part The table part name to remove child.
10865 * @param child_obj The object to remove from table.
10866 * @return The object that was being used, or NULL if not found.
10868 * The object will be unpacked from the table part and its lifetime
10869 * will not be handled by the layout anymore. This is equivalent to
10870 * elm_object_part_content_unset() for table.
10872 * @see elm_layout_table_pack()
10873 * @see elm_layout_table_clear()
10877 EAPI Evas_Object *elm_layout_table_unpack(Evas_Object *obj, const char *part, Evas_Object *child_obj) EINA_ARG_NONNULL(1, 2, 3);
10880 * Remove all the child objects of the given part table.
10882 * @param obj The layout object
10883 * @param part The table part name to remove child.
10884 * @param clear If EINA_TRUE, then all objects will be deleted as
10885 * well, otherwise they will just be removed and will be
10886 * dangling on the canvas.
10888 * The objects will be removed from the table part and their lifetime will
10889 * not be handled by the layout anymore. This is equivalent to
10890 * elm_layout_table_unpack() for all table children.
10892 * @see elm_layout_table_pack()
10893 * @see elm_layout_table_unpack()
10897 EAPI void elm_layout_table_clear(Evas_Object *obj, const char *part, Eina_Bool clear) EINA_ARG_NONNULL(1, 2);
10900 * Get the edje layout
10902 * @param obj The layout object
10904 * @return A Evas_Object with the edje layout settings loaded
10905 * with function elm_layout_file_set
10907 * This returns the edje object. It is not expected to be used to then
10908 * swallow objects via edje_object_part_swallow() for example. Use
10909 * elm_object_part_content_set() instead so child object handling and sizing is
10912 * @note This function should only be used if you really need to call some
10913 * low level Edje function on this edje object. All the common stuff (setting
10914 * text, emitting signals, hooking callbacks to signals, etc.) can be done
10915 * with proper elementary functions.
10917 * @see elm_object_signal_callback_add()
10918 * @see elm_object_signal_emit()
10919 * @see elm_object_part_text_set()
10920 * @see elm_object_part_content_set()
10921 * @see elm_layout_box_append()
10922 * @see elm_layout_table_pack()
10923 * @see elm_layout_data_get()
10927 EAPI Evas_Object *elm_layout_edje_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10930 * Get the edje data from the given layout
10932 * @param obj The layout object
10933 * @param key The data key
10935 * @return The edje data string
10937 * This function fetches data specified inside the edje theme of this layout.
10938 * This function return NULL if data is not found.
10940 * In EDC this comes from a data block within the group block that @p
10941 * obj was loaded from. E.g.
10948 * item: "key1" "value1";
10949 * item: "key2" "value2";
10957 EAPI const char *elm_layout_data_get(const Evas_Object *obj, const char *key) EINA_ARG_NONNULL(1, 2);
10962 * @param obj The layout object
10964 * Manually forces a sizing re-evaluation. This is useful when the minimum
10965 * size required by the edje theme of this layout has changed. The change on
10966 * the minimum size required by the edje theme is not immediately reported to
10967 * the elementary layout, so one needs to call this function in order to tell
10968 * the widget (layout) that it needs to reevaluate its own size.
10970 * The minimum size of the theme is calculated based on minimum size of
10971 * parts, the size of elements inside containers like box and table, etc. All
10972 * of this can change due to state changes, and that's when this function
10973 * should be called.
10975 * Also note that a standard signal of "size,eval" "elm" emitted from the
10976 * edje object will cause this to happen too.
10980 EAPI void elm_layout_sizing_eval(Evas_Object *obj) EINA_ARG_NONNULL(1);
10983 * Sets a specific cursor for an edje part.
10985 * @param obj The layout object.
10986 * @param part_name a part from loaded edje group.
10987 * @param cursor cursor name to use, see Elementary_Cursor.h
10989 * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
10990 * part not exists or it has "mouse_events: 0".
10994 EAPI Eina_Bool elm_layout_part_cursor_set(Evas_Object *obj, const char *part_name, const char *cursor) EINA_ARG_NONNULL(1, 2);
10997 * Get the cursor to be shown when mouse is over an edje part
10999 * @param obj The layout object.
11000 * @param part_name a part from loaded edje group.
11001 * @return the cursor name.
11005 EAPI const char *elm_layout_part_cursor_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
11008 * Unsets a cursor previously set with elm_layout_part_cursor_set().
11010 * @param obj The layout object.
11011 * @param part_name a part from loaded edje group, that had a cursor set
11012 * with elm_layout_part_cursor_set().
11016 EAPI void elm_layout_part_cursor_unset(Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
11019 * Sets a specific cursor style for an edje part.
11021 * @param obj The layout object.
11022 * @param part_name a part from loaded edje group.
11023 * @param style the theme style to use (default, transparent, ...)
11025 * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
11026 * part not exists or it did not had a cursor set.
11030 EAPI Eina_Bool elm_layout_part_cursor_style_set(Evas_Object *obj, const char *part_name, const char *style) EINA_ARG_NONNULL(1, 2);
11033 * Gets a specific cursor style for an edje part.
11035 * @param obj The layout object.
11036 * @param part_name a part from loaded edje group.
11038 * @return the theme style in use, defaults to "default". If the
11039 * object does not have a cursor set, then NULL is returned.
11043 EAPI const char *elm_layout_part_cursor_style_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
11046 * Sets if the cursor set should be searched on the theme or should use
11047 * the provided by the engine, only.
11049 * @note before you set if should look on theme you should define a
11050 * cursor with elm_layout_part_cursor_set(). By default it will only
11051 * look for cursors provided by the engine.
11053 * @param obj The layout object.
11054 * @param part_name a part from loaded edje group.
11055 * @param engine_only if cursors should be just provided by the engine (EINA_TRUE)
11056 * or should also search on widget's theme as well (EINA_FALSE)
11058 * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
11059 * part not exists or it did not had a cursor set.
11063 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);
11066 * Gets a specific cursor engine_only for an edje part.
11068 * @param obj The layout object.
11069 * @param part_name a part from loaded edje group.
11071 * @return whenever the cursor is just provided by engine or also from theme.
11075 EAPI Eina_Bool elm_layout_part_cursor_engine_only_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
11078 * @def elm_layout_icon_set
11079 * Convenience macro to set the icon object in a layout that follows the
11080 * Elementary naming convention for its parts.
11084 #define elm_layout_icon_set(_ly, _obj) \
11087 elm_object_part_content_set((_ly), "elm.swallow.icon", (_obj)); \
11088 if ((_obj)) sig = "elm,state,icon,visible"; \
11089 else sig = "elm,state,icon,hidden"; \
11090 elm_object_signal_emit((_ly), sig, "elm"); \
11094 * @def elm_layout_icon_get
11095 * Convienience macro to get the icon object from a layout that follows the
11096 * Elementary naming convention for its parts.
11100 #define elm_layout_icon_get(_ly) \
11101 elm_object_part_content_get((_ly), "elm.swallow.icon")
11104 * @def elm_layout_end_set
11105 * Convienience macro to set the end object in a layout that follows the
11106 * Elementary naming convention for its parts.
11110 #define elm_layout_end_set(_ly, _obj) \
11113 elm_object_part_content_set((_ly), "elm.swallow.end", (_obj)); \
11114 if ((_obj)) sig = "elm,state,end,visible"; \
11115 else sig = "elm,state,end,hidden"; \
11116 elm_object_signal_emit((_ly), sig, "elm"); \
11120 * @def elm_layout_end_get
11121 * Convienience macro to get the end object in a layout that follows the
11122 * Elementary naming convention for its parts.
11126 #define elm_layout_end_get(_ly) \
11127 elm_object_part_content_get((_ly), "elm.swallow.end")
11130 * @def elm_layout_label_set
11131 * Convienience macro to set the label in a layout that follows the
11132 * Elementary naming convention for its parts.
11135 * @deprecated use elm_object_text_set() instead.
11137 #define elm_layout_label_set(_ly, _txt) \
11138 elm_layout_text_set((_ly), "elm.text", (_txt))
11141 * @def elm_layout_label_get
11142 * Convenience macro to get the label in a layout that follows the
11143 * Elementary naming convention for its parts.
11146 * @deprecated use elm_object_text_set() instead.
11148 #define elm_layout_label_get(_ly) \
11149 elm_layout_text_get((_ly), "elm.text")
11151 /* smart callbacks called:
11152 * "theme,changed" - when elm theme is changed.
11156 * @defgroup Notify Notify
11158 * @image html img/widget/notify/preview-00.png
11159 * @image latex img/widget/notify/preview-00.eps
11161 * Display a container in a particular region of the parent(top, bottom,
11162 * etc). A timeout can be set to automatically hide the notify. This is so
11163 * that, after an evas_object_show() on a notify object, if a timeout was set
11164 * on it, it will @b automatically get hidden after that time.
11166 * Signals that you can add callbacks for are:
11167 * @li "timeout" - when timeout happens on notify and it's hidden
11168 * @li "block,clicked" - when a click outside of the notify happens
11170 * Default contents parts of the notify widget that you can use for are:
11171 * @li "default" - A content of the notify
11173 * @ref tutorial_notify show usage of the API.
11179 * @brief Possible orient values for notify.
11181 * This values should be used in conjunction to elm_notify_orient_set() to
11182 * set the position in which the notify should appear(relative to its parent)
11183 * and in conjunction with elm_notify_orient_get() to know where the notify
11186 typedef enum _Elm_Notify_Orient
11188 ELM_NOTIFY_ORIENT_TOP, /**< Notify should appear in the top of parent, default */
11189 ELM_NOTIFY_ORIENT_CENTER, /**< Notify should appear in the center of parent */
11190 ELM_NOTIFY_ORIENT_BOTTOM, /**< Notify should appear in the bottom of parent */
11191 ELM_NOTIFY_ORIENT_LEFT, /**< Notify should appear in the left of parent */
11192 ELM_NOTIFY_ORIENT_RIGHT, /**< Notify should appear in the right of parent */
11193 ELM_NOTIFY_ORIENT_TOP_LEFT, /**< Notify should appear in the top left of parent */
11194 ELM_NOTIFY_ORIENT_TOP_RIGHT, /**< Notify should appear in the top right of parent */
11195 ELM_NOTIFY_ORIENT_BOTTOM_LEFT, /**< Notify should appear in the bottom left of parent */
11196 ELM_NOTIFY_ORIENT_BOTTOM_RIGHT, /**< Notify should appear in the bottom right of parent */
11197 ELM_NOTIFY_ORIENT_LAST /**< Sentinel value, @b don't use */
11198 } Elm_Notify_Orient;
11201 * @brief Add a new notify to the parent
11203 * @param parent The parent object
11204 * @return The new object or NULL if it cannot be created
11206 EAPI Evas_Object *elm_notify_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
11209 * @brief Set the content of the notify widget
11211 * @param obj The notify object
11212 * @param content The content will be filled in this notify object
11214 * Once the content object is set, a previously set one will be deleted. If
11215 * you want to keep that old content object, use the
11216 * elm_notify_content_unset() function.
11218 * @deprecated use elm_object_content_set() instead
11221 EINA_DEPRECATED EAPI void elm_notify_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
11224 * @brief Unset the content of the notify widget
11226 * @param obj The notify object
11227 * @return The content that was being used
11229 * Unparent and return the content object which was set for this widget
11231 * @see elm_notify_content_set()
11232 * @deprecated use elm_object_content_unset() instead
11235 EINA_DEPRECATED EAPI Evas_Object *elm_notify_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
11238 * @brief Return the content of the notify widget
11240 * @param obj The notify object
11241 * @return The content that is being used
11243 * @see elm_notify_content_set()
11244 * @deprecated use elm_object_content_get() instead
11247 EINA_DEPRECATED EAPI Evas_Object *elm_notify_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11250 * @brief Set the notify parent
11252 * @param obj The notify object
11253 * @param content The new parent
11255 * Once the parent object is set, a previously set one will be disconnected
11258 EAPI void elm_notify_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
11261 * @brief Get the notify parent
11263 * @param obj The notify object
11264 * @return The parent
11266 * @see elm_notify_parent_set()
11268 EAPI Evas_Object *elm_notify_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11271 * @brief Set the orientation
11273 * @param obj The notify object
11274 * @param orient The new orientation
11276 * Sets the position in which the notify will appear in its parent.
11278 * @see @ref Elm_Notify_Orient for possible values.
11280 EAPI void elm_notify_orient_set(Evas_Object *obj, Elm_Notify_Orient orient) EINA_ARG_NONNULL(1);
11283 * @brief Return the orientation
11284 * @param obj The notify object
11285 * @return The orientation of the notification
11287 * @see elm_notify_orient_set()
11288 * @see Elm_Notify_Orient
11290 EAPI Elm_Notify_Orient elm_notify_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11293 * @brief Set the time interval after which the notify window is going to be
11296 * @param obj The notify object
11297 * @param time The timeout in seconds
11299 * This function sets a timeout and starts the timer controlling when the
11300 * notify is hidden. Since calling evas_object_show() on a notify restarts
11301 * the timer controlling when the notify is hidden, setting this before the
11302 * notify is shown will in effect mean starting the timer when the notify is
11305 * @note Set a value <= 0.0 to disable a running timer.
11307 * @note If the value > 0.0 and the notify is previously visible, the
11308 * timer will be started with this value, canceling any running timer.
11310 EAPI void elm_notify_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
11313 * @brief Return the timeout value (in seconds)
11314 * @param obj the notify object
11316 * @see elm_notify_timeout_set()
11318 EAPI double elm_notify_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11321 * @brief Sets whether events should be passed to by a click outside
11324 * @param obj The notify object
11325 * @param repeats EINA_TRUE Events are repeats, else no
11327 * When true if the user clicks outside the window the events will be caught
11328 * by the others widgets, else the events are blocked.
11330 * @note The default value is EINA_TRUE.
11332 EAPI void elm_notify_repeat_events_set(Evas_Object *obj, Eina_Bool repeat) EINA_ARG_NONNULL(1);
11335 * @brief Return true if events are repeat below the notify object
11336 * @param obj the notify object
11338 * @see elm_notify_repeat_events_set()
11340 EAPI Eina_Bool elm_notify_repeat_events_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11347 * @defgroup Hover Hover
11349 * @image html img/widget/hover/preview-00.png
11350 * @image latex img/widget/hover/preview-00.eps
11352 * A Hover object will hover over its @p parent object at the @p target
11353 * location. Anything in the background will be given a darker coloring to
11354 * indicate that the hover object is on top (at the default theme). When the
11355 * hover is clicked it is dismissed(hidden), if the contents of the hover are
11356 * clicked that @b doesn't cause the hover to be dismissed.
11358 * A Hover object has two parents. One parent that owns it during creation
11359 * and the other parent being the one over which the hover object spans.
11362 * @note The hover object will take up the entire space of @p target
11365 * Elementary has the following styles for the hover widget:
11369 * @li hoversel_vertical
11371 * The following are the available position for content:
11383 * Signals that you can add callbacks for are:
11384 * @li "clicked" - the user clicked the empty space in the hover to dismiss
11385 * @li "smart,changed" - a content object placed under the "smart"
11386 * policy was replaced to a new slot direction.
11388 * See @ref tutorial_hover for more information.
11392 typedef enum _Elm_Hover_Axis
11394 ELM_HOVER_AXIS_NONE, /**< ELM_HOVER_AXIS_NONE -- no prefered orientation */
11395 ELM_HOVER_AXIS_HORIZONTAL, /**< ELM_HOVER_AXIS_HORIZONTAL -- horizontal */
11396 ELM_HOVER_AXIS_VERTICAL, /**< ELM_HOVER_AXIS_VERTICAL -- vertical */
11397 ELM_HOVER_AXIS_BOTH /**< ELM_HOVER_AXIS_BOTH -- both */
11401 * @brief Adds a hover object to @p parent
11403 * @param parent The parent object
11404 * @return The hover object or NULL if one could not be created
11406 EAPI Evas_Object *elm_hover_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
11409 * @brief Sets the target object for the hover.
11411 * @param obj The hover object
11412 * @param target The object to center the hover onto.
11414 * This function will cause the hover to be centered on the target object.
11416 EAPI void elm_hover_target_set(Evas_Object *obj, Evas_Object *target) EINA_ARG_NONNULL(1);
11419 * @brief Gets the target object for the hover.
11421 * @param obj The hover object
11422 * @return The target object for the hover.
11424 * @see elm_hover_target_set()
11426 EAPI Evas_Object *elm_hover_target_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11429 * @brief Sets the parent object for the hover.
11431 * @param obj The hover object
11432 * @param parent The object to locate the hover over.
11434 * This function will cause the hover to take up the entire space that the
11435 * parent object fills.
11437 EAPI void elm_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
11440 * @brief Gets the parent object for the hover.
11442 * @param obj The hover object
11443 * @return The parent object to locate the hover over.
11445 * @see elm_hover_parent_set()
11447 EAPI Evas_Object *elm_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11450 * @brief Sets the content of the hover object and the direction in which it
11453 * @param obj The hover object
11454 * @param swallow The direction that the object will be displayed
11455 * at. Accepted values are "left", "top-left", "top", "top-right",
11456 * "right", "bottom-right", "bottom", "bottom-left", "middle" and
11458 * @param content The content to place at @p swallow
11460 * Once the content object is set for a given direction, a previously
11461 * set one (on the same direction) will be deleted. If you want to
11462 * keep that old content object, use the elm_hover_content_unset()
11465 * All directions may have contents at the same time, except for
11466 * "smart". This is a special placement hint and its use case
11467 * independs of the calculations coming from
11468 * elm_hover_best_content_location_get(). Its use is for cases when
11469 * one desires only one hover content, but with a dynamic special
11470 * placement within the hover area. The content's geometry, whenever
11471 * it changes, will be used to decide on a best location, not
11472 * extrapolating the hover's parent object view to show it in (still
11473 * being the hover's target determinant of its medium part -- move and
11474 * resize it to simulate finger sizes, for example). If one of the
11475 * directions other than "smart" are used, a previously content set
11476 * using it will be deleted, and vice-versa.
11478 EAPI void elm_hover_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content) EINA_ARG_NONNULL(1);
11481 * @brief Get the content of the hover object, in a given direction.
11483 * Return the content object which was set for this widget in the
11484 * @p swallow direction.
11486 * @param obj The hover object
11487 * @param swallow The direction that the object was display at.
11488 * @return The content that was being used
11490 * @see elm_hover_content_set()
11492 EAPI Evas_Object *elm_hover_content_get(const Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
11495 * @brief Unset the content of the hover object, in a given direction.
11497 * Unparent and return the content object set at @p swallow direction.
11499 * @param obj The hover object
11500 * @param swallow The direction that the object was display at.
11501 * @return The content that was being used.
11503 * @see elm_hover_content_set()
11505 EAPI Evas_Object *elm_hover_content_unset(Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
11508 * @brief Returns the best swallow location for content in the hover.
11510 * @param obj The hover object
11511 * @param pref_axis The preferred orientation axis for the hover object to use
11512 * @return The edje location to place content into the hover or @c
11515 * Best is defined here as the location at which there is the most available
11518 * @p pref_axis may be one of
11519 * - @c ELM_HOVER_AXIS_NONE -- no prefered orientation
11520 * - @c ELM_HOVER_AXIS_HORIZONTAL -- horizontal
11521 * - @c ELM_HOVER_AXIS_VERTICAL -- vertical
11522 * - @c ELM_HOVER_AXIS_BOTH -- both
11524 * If ELM_HOVER_AXIS_HORIZONTAL is choosen the returned position will
11525 * nescessarily be along the horizontal axis("left" or "right"). If
11526 * ELM_HOVER_AXIS_VERTICAL is choosen the returned position will nescessarily
11527 * be along the vertical axis("top" or "bottom"). Chossing
11528 * ELM_HOVER_AXIS_BOTH or ELM_HOVER_AXIS_NONE has the same effect and the
11529 * returned position may be in either axis.
11531 * @see elm_hover_content_set()
11533 EAPI const char *elm_hover_best_content_location_get(const Evas_Object *obj, Elm_Hover_Axis pref_axis) EINA_ARG_NONNULL(1);
11541 * @defgroup Entry Entry
11543 * @image html img/widget/entry/preview-00.png
11544 * @image latex img/widget/entry/preview-00.eps width=\textwidth
11545 * @image html img/widget/entry/preview-01.png
11546 * @image latex img/widget/entry/preview-01.eps width=\textwidth
11547 * @image html img/widget/entry/preview-02.png
11548 * @image latex img/widget/entry/preview-02.eps width=\textwidth
11549 * @image html img/widget/entry/preview-03.png
11550 * @image latex img/widget/entry/preview-03.eps width=\textwidth
11552 * An entry is a convenience widget which shows a box that the user can
11553 * enter text into. Entries by default don't scroll, so they grow to
11554 * accomodate the entire text, resizing the parent window as needed. This
11555 * can be changed with the elm_entry_scrollable_set() function.
11557 * They can also be single line or multi line (the default) and when set
11558 * to multi line mode they support text wrapping in any of the modes
11559 * indicated by #Elm_Wrap_Type.
11561 * Other features include password mode, filtering of inserted text with
11562 * elm_entry_text_filter_append() and related functions, inline "items" and
11563 * formatted markup text.
11565 * @section entry-markup Formatted text
11567 * The markup tags supported by the Entry are defined by the theme, but
11568 * even when writing new themes or extensions it's a good idea to stick to
11569 * a sane default, to maintain coherency and avoid application breakages.
11570 * Currently defined by the default theme are the following tags:
11571 * @li \<br\>: Inserts a line break.
11572 * @li \<ps\>: Inserts a paragraph separator. This is preferred over line
11574 * @li \<tab\>: Inserts a tab.
11575 * @li \<em\>...\</em\>: Emphasis. Sets the @em oblique style for the
11577 * @li \<b\>...\</b\>: Sets the @b bold style for the enclosed text.
11578 * @li \<link\>...\</link\>: Underlines the enclosed text.
11579 * @li \<hilight\>...\</hilight\>: Hilights the enclosed text.
11581 * @section entry-special Special markups
11583 * Besides those used to format text, entries support two special markup
11584 * tags used to insert clickable portions of text or items inlined within
11587 * @subsection entry-anchors Anchors
11589 * Anchors are similar to HTML anchors. Text can be surrounded by \<a\> and
11590 * \</a\> tags and an event will be generated when this text is clicked,
11594 * This text is outside <a href=anc-01>but this one is an anchor</a>
11597 * The @c href attribute in the opening tag gives the name that will be
11598 * used to identify the anchor and it can be any valid utf8 string.
11600 * When an anchor is clicked, an @c "anchor,clicked" signal is emitted with
11601 * an #Elm_Entry_Anchor_Info in the @c event_info parameter for the
11602 * callback function. The same applies for "anchor,in" (mouse in), "anchor,out"
11603 * (mouse out), "anchor,down" (mouse down), and "anchor,up" (mouse up) events on
11606 * @subsection entry-items Items
11608 * Inlined in the text, any other @c Evas_Object can be inserted by using
11609 * \<item\> tags this way:
11612 * <item size=16x16 vsize=full href=emoticon/haha></item>
11615 * Just like with anchors, the @c href identifies each item, but these need,
11616 * in addition, to indicate their size, which is done using any one of
11617 * @c size, @c absize or @c relsize attributes. These attributes take their
11618 * value in the WxH format, where W is the width and H the height of the
11621 * @li absize: Absolute pixel size for the item. Whatever value is set will
11622 * be the item's size regardless of any scale value the object may have
11623 * been set to. The final line height will be adjusted to fit larger items.
11624 * @li size: Similar to @c absize, but it's adjusted to the scale value set
11626 * @li relsize: Size is adjusted for the item to fit within the current
11629 * Besides their size, items are specificed a @c vsize value that affects
11630 * how their final size and position are calculated. The possible values
11632 * @li ascent: Item will be placed within the line's baseline and its
11633 * ascent. That is, the height between the line where all characters are
11634 * positioned and the highest point in the line. For @c size and @c absize
11635 * items, the descent value will be added to the total line height to make
11636 * them fit. @c relsize items will be adjusted to fit within this space.
11637 * @li full: Items will be placed between the descent and ascent, or the
11638 * lowest point in the line and its highest.
11640 * The next image shows different configurations of items and how
11641 * the previously mentioned options affect their sizes. In all cases,
11642 * the green line indicates the ascent, blue for the baseline and red for
11645 * @image html entry_item.png
11646 * @image latex entry_item.eps width=\textwidth
11648 * And another one to show how size differs from absize. In the first one,
11649 * the scale value is set to 1.0, while the second one is using one of 2.0.
11651 * @image html entry_item_scale.png
11652 * @image latex entry_item_scale.eps width=\textwidth
11654 * After the size for an item is calculated, the entry will request an
11655 * object to place in its space. For this, the functions set with
11656 * elm_entry_item_provider_append() and related functions will be called
11657 * in order until one of them returns a @c non-NULL value. If no providers
11658 * are available, or all of them return @c NULL, then the entry falls back
11659 * to one of the internal defaults, provided the name matches with one of
11662 * All of the following are currently supported:
11665 * - emoticon/angry-shout
11666 * - emoticon/crazy-laugh
11667 * - emoticon/evil-laugh
11669 * - emoticon/goggle-smile
11670 * - emoticon/grumpy
11671 * - emoticon/grumpy-smile
11672 * - emoticon/guilty
11673 * - emoticon/guilty-smile
11675 * - emoticon/half-smile
11676 * - emoticon/happy-panting
11678 * - emoticon/indifferent
11680 * - emoticon/knowing-grin
11682 * - emoticon/little-bit-sorry
11683 * - emoticon/love-lots
11685 * - emoticon/minimal-smile
11686 * - emoticon/not-happy
11687 * - emoticon/not-impressed
11689 * - emoticon/opensmile
11692 * - emoticon/squint-laugh
11693 * - emoticon/surprised
11694 * - emoticon/suspicious
11695 * - emoticon/tongue-dangling
11696 * - emoticon/tongue-poke
11698 * - emoticon/unhappy
11699 * - emoticon/very-sorry
11702 * - emoticon/worried
11705 * Alternatively, an item may reference an image by its path, using
11706 * the URI form @c file:///path/to/an/image.png and the entry will then
11707 * use that image for the item.
11709 * @section entry-files Loading and saving files
11711 * Entries have convinience functions to load text from a file and save
11712 * changes back to it after a short delay. The automatic saving is enabled
11713 * by default, but can be disabled with elm_entry_autosave_set() and files
11714 * can be loaded directly as plain text or have any markup in them
11715 * recognized. See elm_entry_file_set() for more details.
11717 * @section entry-signals Emitted signals
11719 * This widget emits the following signals:
11721 * @li "changed": The text within the entry was changed.
11722 * @li "changed,user": The text within the entry was changed because of user interaction.
11723 * @li "activated": The enter key was pressed on a single line entry.
11724 * @li "press": A mouse button has been pressed on the entry.
11725 * @li "longpressed": A mouse button has been pressed and held for a couple
11727 * @li "clicked": The entry has been clicked (mouse press and release).
11728 * @li "clicked,double": The entry has been double clicked.
11729 * @li "clicked,triple": The entry has been triple clicked.
11730 * @li "focused": The entry has received focus.
11731 * @li "unfocused": The entry has lost focus.
11732 * @li "selection,paste": A paste of the clipboard contents was requested.
11733 * @li "selection,copy": A copy of the selected text into the clipboard was
11735 * @li "selection,cut": A cut of the selected text into the clipboard was
11737 * @li "selection,start": A selection has begun and no previous selection
11739 * @li "selection,changed": The current selection has changed.
11740 * @li "selection,cleared": The current selection has been cleared.
11741 * @li "cursor,changed": The cursor has changed position.
11742 * @li "anchor,clicked": An anchor has been clicked. The event_info
11743 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
11744 * @li "anchor,in": Mouse cursor has moved into an anchor. The event_info
11745 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
11746 * @li "anchor,out": Mouse cursor has moved out of an anchor. The event_info
11747 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
11748 * @li "anchor,up": Mouse button has been unpressed on an anchor. The event_info
11749 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
11750 * @li "anchor,down": Mouse button has been pressed on an anchor. The event_info
11751 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
11752 * @li "preedit,changed": The preedit string has changed.
11753 * @li "language,changed": Program language changed.
11755 * @section entry-examples
11757 * An overview of the Entry API can be seen in @ref entry_example_01
11763 * @typedef Elm_Entry_Anchor_Info
11765 * The info sent in the callback for the "anchor,clicked" signals emitted
11768 typedef struct _Elm_Entry_Anchor_Info Elm_Entry_Anchor_Info;
11771 * @struct _Elm_Entry_Anchor_Info
11773 * The info sent in the callback for the "anchor,clicked" signals emitted
11776 struct _Elm_Entry_Anchor_Info
11778 const char *name; /**< The name of the anchor, as stated in its href */
11779 int button; /**< The mouse button used to click on it */
11780 Evas_Coord x, /**< Anchor geometry, relative to canvas */
11781 y, /**< Anchor geometry, relative to canvas */
11782 w, /**< Anchor geometry, relative to canvas */
11783 h; /**< Anchor geometry, relative to canvas */
11787 * @typedef Elm_Entry_Filter_Cb
11788 * This callback type is used by entry filters to modify text.
11789 * @param data The data specified as the last param when adding the filter
11790 * @param entry The entry object
11791 * @param text A pointer to the location of the text being filtered. This data can be modified,
11792 * but any additional allocations must be managed by the user.
11793 * @see elm_entry_text_filter_append
11794 * @see elm_entry_text_filter_prepend
11796 typedef void (*Elm_Entry_Filter_Cb)(void *data, Evas_Object *entry, char **text);
11799 * @typedef Elm_Entry_Change_Info
11800 * This corresponds to Edje_Entry_Change_Info. Includes information about
11801 * a change in the entry.
11803 typedef Edje_Entry_Change_Info Elm_Entry_Change_Info;
11807 * This adds an entry to @p parent object.
11809 * By default, entries are:
11813 * @li autosave is enabled
11815 * @param parent The parent object
11816 * @return The new object or NULL if it cannot be created
11818 EAPI Evas_Object *elm_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
11821 * Sets the entry to single line mode.
11823 * In single line mode, entries don't ever wrap when the text reaches the
11824 * edge, and instead they keep growing horizontally. Pressing the @c Enter
11825 * key will generate an @c "activate" event instead of adding a new line.
11827 * When @p single_line is @c EINA_FALSE, line wrapping takes effect again
11828 * and pressing enter will break the text into a different line
11829 * without generating any events.
11831 * @param obj The entry object
11832 * @param single_line If true, the text in the entry
11833 * will be on a single line.
11835 EAPI void elm_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line) EINA_ARG_NONNULL(1);
11838 * Gets whether the entry is set to be single line.
11840 * @param obj The entry object
11841 * @return single_line If true, the text in the entry is set to display
11842 * on a single line.
11844 * @see elm_entry_single_line_set()
11846 EAPI Eina_Bool elm_entry_single_line_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11849 * Sets the entry to password mode.
11851 * In password mode, entries are implicitly single line and the display of
11852 * any text in them is replaced with asterisks (*).
11854 * @param obj The entry object
11855 * @param password If true, password mode is enabled.
11857 EAPI void elm_entry_password_set(Evas_Object *obj, Eina_Bool password) EINA_ARG_NONNULL(1);
11860 * Gets whether the entry is set to password mode.
11862 * @param obj The entry object
11863 * @return If true, the entry is set to display all characters
11864 * as asterisks (*).
11866 * @see elm_entry_password_set()
11868 EAPI Eina_Bool elm_entry_password_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11871 * This sets the text displayed within the entry to @p entry.
11873 * @param obj The entry object
11874 * @param entry The text to be displayed
11876 * @deprecated Use elm_object_text_set() instead.
11877 * @note Using this function bypasses text filters
11879 EAPI void elm_entry_entry_set(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
11882 * This returns the text currently shown in object @p entry.
11883 * See also elm_entry_entry_set().
11885 * @param obj The entry object
11886 * @return The currently displayed text or NULL on failure
11888 * @deprecated Use elm_object_text_get() instead.
11890 EAPI const char *elm_entry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11893 * Appends @p entry to the text of the entry.
11895 * Adds the text in @p entry to the end of any text already present in the
11898 * The appended text is subject to any filters set for the widget.
11900 * @param obj The entry object
11901 * @param entry The text to be displayed
11903 * @see elm_entry_text_filter_append()
11905 EAPI void elm_entry_entry_append(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
11908 * Gets whether the entry is empty.
11910 * Empty means no text at all. If there are any markup tags, like an item
11911 * tag for which no provider finds anything, and no text is displayed, this
11912 * function still returns EINA_FALSE.
11914 * @param obj The entry object
11915 * @return EINA_TRUE if the entry is empty, EINA_FALSE otherwise.
11917 EAPI Eina_Bool elm_entry_is_empty(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11920 * Gets any selected text within the entry.
11922 * If there's any selected text in the entry, this function returns it as
11923 * a string in markup format. NULL is returned if no selection exists or
11924 * if an error occurred.
11926 * The returned value points to an internal string and should not be freed
11927 * or modified in any way. If the @p entry object is deleted or its
11928 * contents are changed, the returned pointer should be considered invalid.
11930 * @param obj The entry object
11931 * @return The selected text within the entry or NULL on failure
11933 EAPI const char *elm_entry_selection_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11936 * Returns the actual textblock object of the entry.
11938 * This function exposes the internal textblock object that actually
11939 * contains and draws the text. This should be used for low-level
11940 * manipulations that are otherwise not possible.
11942 * Changing the textblock directly from here will not notify edje/elm to
11943 * recalculate the textblock size automatically, so any modifications
11944 * done to the textblock returned by this function should be followed by
11945 * a call to elm_entry_calc_force().
11947 * The return value is marked as const as an additional warning.
11948 * One should not use the returned object with any of the generic evas
11949 * functions (geometry_get/resize/move and etc), but only with the textblock
11950 * functions; The former will either not work at all, or break the correct
11953 * IMPORTANT: Many functions may change (i.e delete and create a new one)
11954 * the internal textblock object. Do NOT cache the returned object, and try
11955 * not to mix calls on this object with regular elm_entry calls (which may
11956 * change the internal textblock object). This applies to all cursors
11957 * returned from textblock calls, and all the other derivative values.
11959 * @param obj The entry object
11960 * @return The textblock object.
11962 EAPI const Evas_Object *elm_entry_textblock_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11965 * Forces calculation of the entry size and text layouting.
11967 * This should be used after modifying the textblock object directly. See
11968 * elm_entry_textblock_get() for more information.
11970 * @param obj The entry object
11972 * @see elm_entry_textblock_get()
11974 EAPI void elm_entry_calc_force(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11977 * Inserts the given text into the entry at the current cursor position.
11979 * This inserts text at the cursor position as if it was typed
11980 * by the user (note that this also allows markup which a user
11981 * can't just "type" as it would be converted to escaped text, so this
11982 * call can be used to insert things like emoticon items or bold push/pop
11983 * tags, other font and color change tags etc.)
11985 * If any selection exists, it will be replaced by the inserted text.
11987 * The inserted text is subject to any filters set for the widget.
11989 * @param obj The entry object
11990 * @param entry The text to insert
11992 * @see elm_entry_text_filter_append()
11994 EAPI void elm_entry_entry_insert(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
11997 * Set the line wrap type to use on multi-line entries.
11999 * Sets the wrap type used by the entry to any of the specified in
12000 * #Elm_Wrap_Type. This tells how the text will be implicitly cut into a new
12001 * line (without inserting a line break or paragraph separator) when it
12002 * reaches the far edge of the widget.
12004 * Note that this only makes sense for multi-line entries. A widget set
12005 * to be single line will never wrap.
12007 * @param obj The entry object
12008 * @param wrap The wrap mode to use. See #Elm_Wrap_Type for details on them
12010 EAPI void elm_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
12013 * Gets the wrap mode the entry was set to use.
12015 * @param obj The entry object
12016 * @return Wrap type
12018 * @see also elm_entry_line_wrap_set()
12020 EAPI Elm_Wrap_Type elm_entry_line_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12023 * Sets if the entry is to be editable or not.
12025 * By default, entries are editable and when focused, any text input by the
12026 * user will be inserted at the current cursor position. But calling this
12027 * function with @p editable as EINA_FALSE will prevent the user from
12028 * inputting text into the entry.
12030 * The only way to change the text of a non-editable entry is to use
12031 * elm_object_text_set(), elm_entry_entry_insert() and other related
12034 * @param obj The entry object
12035 * @param editable If EINA_TRUE, user input will be inserted in the entry,
12036 * if not, the entry is read-only and no user input is allowed.
12038 EAPI void elm_entry_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
12041 * Gets whether the entry is editable or not.
12043 * @param obj The entry object
12044 * @return If true, the entry is editable by the user.
12045 * If false, it is not editable by the user
12047 * @see elm_entry_editable_set()
12049 EAPI Eina_Bool elm_entry_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12052 * This drops any existing text selection within the entry.
12054 * @param obj The entry object
12056 EAPI void elm_entry_select_none(Evas_Object *obj) EINA_ARG_NONNULL(1);
12059 * This selects all text within the entry.
12061 * @param obj The entry object
12063 EAPI void elm_entry_select_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
12066 * This moves the cursor one place to the right within the entry.
12068 * @param obj The entry object
12069 * @return EINA_TRUE upon success, EINA_FALSE upon failure
12071 EAPI Eina_Bool elm_entry_cursor_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
12074 * This moves the cursor one place to the left within the entry.
12076 * @param obj The entry object
12077 * @return EINA_TRUE upon success, EINA_FALSE upon failure
12079 EAPI Eina_Bool elm_entry_cursor_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
12082 * This moves the cursor one line up within the entry.
12084 * @param obj The entry object
12085 * @return EINA_TRUE upon success, EINA_FALSE upon failure
12087 EAPI Eina_Bool elm_entry_cursor_up(Evas_Object *obj) EINA_ARG_NONNULL(1);
12090 * This moves the cursor one line down within the entry.
12092 * @param obj The entry object
12093 * @return EINA_TRUE upon success, EINA_FALSE upon failure
12095 EAPI Eina_Bool elm_entry_cursor_down(Evas_Object *obj) EINA_ARG_NONNULL(1);
12098 * This moves the cursor to the beginning of the entry.
12100 * @param obj The entry object
12102 EAPI void elm_entry_cursor_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
12105 * This moves the cursor to the end of the entry.
12107 * @param obj The entry object
12109 EAPI void elm_entry_cursor_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
12112 * This moves the cursor to the beginning of the current line.
12114 * @param obj The entry object
12116 EAPI void elm_entry_cursor_line_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
12119 * This moves the cursor to the end of the current line.
12121 * @param obj The entry object
12123 EAPI void elm_entry_cursor_line_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
12126 * This begins a selection within the entry as though
12127 * the user were holding down the mouse button to make a selection.
12129 * @param obj The entry object
12131 EAPI void elm_entry_cursor_selection_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
12134 * This ends a selection within the entry as though
12135 * the user had just released the mouse button while making a selection.
12137 * @param obj The entry object
12139 EAPI void elm_entry_cursor_selection_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
12142 * Gets whether a format node exists at the current cursor position.
12144 * A format node is anything that defines how the text is rendered. It can
12145 * be a visible format node, such as a line break or a paragraph separator,
12146 * or an invisible one, such as bold begin or end tag.
12147 * This function returns whether any format node exists at the current
12150 * @param obj The entry object
12151 * @return EINA_TRUE if the current cursor position contains a format node,
12152 * EINA_FALSE otherwise.
12154 * @see elm_entry_cursor_is_visible_format_get()
12156 EAPI Eina_Bool elm_entry_cursor_is_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12159 * Gets if the current cursor position holds a visible format node.
12161 * @param obj The entry object
12162 * @return EINA_TRUE if the current cursor is a visible format, EINA_FALSE
12163 * if it's an invisible one or no format exists.
12165 * @see elm_entry_cursor_is_format_get()
12167 EAPI Eina_Bool elm_entry_cursor_is_visible_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12170 * Gets the character pointed by the cursor at its current position.
12172 * This function returns a string with the utf8 character stored at the
12173 * current cursor position.
12174 * Only the text is returned, any format that may exist will not be part
12175 * of the return value.
12177 * @param obj The entry object
12178 * @return The text pointed by the cursors.
12180 EAPI const char *elm_entry_cursor_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12183 * This function returns the geometry of the cursor.
12185 * It's useful if you want to draw something on the cursor (or where it is),
12186 * or for example in the case of scrolled entry where you want to show the
12189 * @param obj The entry object
12190 * @param x returned geometry
12191 * @param y returned geometry
12192 * @param w returned geometry
12193 * @param h returned geometry
12194 * @return EINA_TRUE upon success, EINA_FALSE upon failure
12196 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);
12199 * Sets the cursor position in the entry to the given value
12201 * The value in @p pos is the index of the character position within the
12202 * contents of the string as returned by elm_entry_cursor_pos_get().
12204 * @param obj The entry object
12205 * @param pos The position of the cursor
12207 EAPI void elm_entry_cursor_pos_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
12210 * Retrieves the current position of the cursor in the entry
12212 * @param obj The entry object
12213 * @return The cursor position
12215 EAPI int elm_entry_cursor_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12218 * This executes a "cut" action on the selected text in the entry.
12220 * @param obj The entry object
12222 EAPI void elm_entry_selection_cut(Evas_Object *obj) EINA_ARG_NONNULL(1);
12225 * This executes a "copy" action on the selected text in the entry.
12227 * @param obj The entry object
12229 EAPI void elm_entry_selection_copy(Evas_Object *obj) EINA_ARG_NONNULL(1);
12232 * This executes a "paste" action in the entry.
12234 * @param obj The entry object
12236 EAPI void elm_entry_selection_paste(Evas_Object *obj) EINA_ARG_NONNULL(1);
12239 * This clears and frees the items in a entry's contextual (longpress)
12242 * @param obj The entry object
12244 * @see elm_entry_context_menu_item_add()
12246 EAPI void elm_entry_context_menu_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
12249 * This adds an item to the entry's contextual menu.
12251 * A longpress on an entry will make the contextual menu show up, if this
12252 * hasn't been disabled with elm_entry_context_menu_disabled_set().
12253 * By default, this menu provides a few options like enabling selection mode,
12254 * which is useful on embedded devices that need to be explicit about it,
12255 * and when a selection exists it also shows the copy and cut actions.
12257 * With this function, developers can add other options to this menu to
12258 * perform any action they deem necessary.
12260 * @param obj The entry object
12261 * @param label The item's text label
12262 * @param icon_file The item's icon file
12263 * @param icon_type The item's icon type
12264 * @param func The callback to execute when the item is clicked
12265 * @param data The data to associate with the item for related functions
12267 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);
12270 * This disables the entry's contextual (longpress) menu.
12272 * @param obj The entry object
12273 * @param disabled If true, the menu is disabled
12275 EAPI void elm_entry_context_menu_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
12278 * This returns whether the entry's contextual (longpress) menu is
12281 * @param obj The entry object
12282 * @return If true, the menu is disabled
12284 EAPI Eina_Bool elm_entry_context_menu_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12287 * This appends a custom item provider to the list for that entry
12289 * This appends the given callback. The list is walked from beginning to end
12290 * with each function called given the item href string in the text. If the
12291 * function returns an object handle other than NULL (it should create an
12292 * object to do this), then this object is used to replace that item. If
12293 * not the next provider is called until one provides an item object, or the
12294 * default provider in entry does.
12296 * @param obj The entry object
12297 * @param func The function called to provide the item object
12298 * @param data The data passed to @p func
12300 * @see @ref entry-items
12302 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);
12305 * This prepends a custom item provider to the list for that entry
12307 * This prepends the given callback. See elm_entry_item_provider_append() for
12310 * @param obj The entry object
12311 * @param func The function called to provide the item object
12312 * @param data The data passed to @p func
12314 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);
12317 * This removes a custom item provider to the list for that entry
12319 * This removes the given callback. See elm_entry_item_provider_append() for
12322 * @param obj The entry object
12323 * @param func The function called to provide the item object
12324 * @param data The data passed to @p func
12326 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);
12329 * Append a filter function for text inserted in the entry
12331 * Append the given callback to the list. This functions will be called
12332 * whenever any text is inserted into the entry, with the text to be inserted
12333 * as a parameter. The callback function is free to alter the text in any way
12334 * it wants, but it must remember to free the given pointer and update it.
12335 * If the new text is to be discarded, the function can free it and set its
12336 * text parameter to NULL. This will also prevent any following filters from
12339 * @param obj The entry object
12340 * @param func The function to use as text filter
12341 * @param data User data to pass to @p func
12343 EAPI void elm_entry_text_filter_append(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
12346 * Prepend a filter function for text insdrted in the entry
12348 * Prepend the given callback to the list. See elm_entry_text_filter_append()
12349 * for more information
12351 * @param obj The entry object
12352 * @param func The function to use as text filter
12353 * @param data User data to pass to @p func
12355 EAPI void elm_entry_text_filter_prepend(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
12358 * Remove a filter from the list
12360 * Removes the given callback from the filter list. See
12361 * elm_entry_text_filter_append() for more information.
12363 * @param obj The entry object
12364 * @param func The filter function to remove
12365 * @param data The user data passed when adding the function
12367 EAPI void elm_entry_text_filter_remove(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
12370 * This converts a markup (HTML-like) string into UTF-8.
12372 * The returned string is a malloc'ed buffer and it should be freed when
12373 * not needed anymore.
12375 * @param s The string (in markup) to be converted
12376 * @return The converted string (in UTF-8). It should be freed.
12378 EAPI char *elm_entry_markup_to_utf8(const char *s) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
12381 * This converts a UTF-8 string into markup (HTML-like).
12383 * The returned string is a malloc'ed buffer and it should be freed when
12384 * not needed anymore.
12386 * @param s The string (in UTF-8) to be converted
12387 * @return The converted string (in markup). It should be freed.
12389 EAPI char *elm_entry_utf8_to_markup(const char *s) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
12392 * This sets the file (and implicitly loads it) for the text to display and
12393 * then edit. All changes are written back to the file after a short delay if
12394 * the entry object is set to autosave (which is the default).
12396 * If the entry had any other file set previously, any changes made to it
12397 * will be saved if the autosave feature is enabled, otherwise, the file
12398 * will be silently discarded and any non-saved changes will be lost.
12400 * @param obj The entry object
12401 * @param file The path to the file to load and save
12402 * @param format The file format
12404 EAPI void elm_entry_file_set(Evas_Object *obj, const char *file, Elm_Text_Format format) EINA_ARG_NONNULL(1);
12407 * Gets the file being edited by the entry.
12409 * This function can be used to retrieve any file set on the entry for
12410 * edition, along with the format used to load and save it.
12412 * @param obj The entry object
12413 * @param file The path to the file to load and save
12414 * @param format The file format
12416 EAPI void elm_entry_file_get(const Evas_Object *obj, const char **file, Elm_Text_Format *format) EINA_ARG_NONNULL(1);
12419 * This function writes any changes made to the file set with
12420 * elm_entry_file_set()
12422 * @param obj The entry object
12424 EAPI void elm_entry_file_save(Evas_Object *obj) EINA_ARG_NONNULL(1);
12427 * This sets the entry object to 'autosave' the loaded text file or not.
12429 * @param obj The entry object
12430 * @param autosave Autosave the loaded file or not
12432 * @see elm_entry_file_set()
12434 EAPI void elm_entry_autosave_set(Evas_Object *obj, Eina_Bool autosave) EINA_ARG_NONNULL(1);
12437 * This gets the entry object's 'autosave' status.
12439 * @param obj The entry object
12440 * @return Autosave the loaded file or not
12442 * @see elm_entry_file_set()
12444 EAPI Eina_Bool elm_entry_autosave_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12447 * Control pasting of text and images for the widget.
12449 * Normally the entry allows both text and images to be pasted. By setting
12450 * textonly to be true, this prevents images from being pasted.
12452 * Note this only changes the behaviour of text.
12454 * @param obj The entry object
12455 * @param textonly paste mode - EINA_TRUE is text only, EINA_FALSE is
12456 * text+image+other.
12458 EAPI void elm_entry_cnp_textonly_set(Evas_Object *obj, Eina_Bool textonly) EINA_ARG_NONNULL(1);
12461 * Getting elm_entry text paste/drop mode.
12463 * In textonly mode, only text may be pasted or dropped into the widget.
12465 * @param obj The entry object
12466 * @return If the widget only accepts text from pastes.
12468 EAPI Eina_Bool elm_entry_cnp_textonly_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12471 * Enable or disable scrolling in entry
12473 * Normally the entry is not scrollable unless you enable it with this call.
12475 * @param obj The entry object
12476 * @param scroll EINA_TRUE if it is to be scrollable, EINA_FALSE otherwise
12478 EAPI void elm_entry_scrollable_set(Evas_Object *obj, Eina_Bool scroll);
12481 * Get the scrollable state of the entry
12483 * Normally the entry is not scrollable. This gets the scrollable state
12484 * of the entry. See elm_entry_scrollable_set() for more information.
12486 * @param obj The entry object
12487 * @return The scrollable state
12489 EAPI Eina_Bool elm_entry_scrollable_get(const Evas_Object *obj);
12492 * This sets a widget to be displayed to the left of a scrolled entry.
12494 * @param obj The scrolled entry object
12495 * @param icon The widget to display on the left side of the scrolled
12498 * @note A previously set widget will be destroyed.
12499 * @note If the object being set does not have minimum size hints set,
12500 * it won't get properly displayed.
12502 * @see elm_entry_end_set()
12504 EAPI void elm_entry_icon_set(Evas_Object *obj, Evas_Object *icon);
12507 * Gets the leftmost widget of the scrolled entry. This object is
12508 * owned by the scrolled entry and should not be modified.
12510 * @param obj The scrolled entry object
12511 * @return the left widget inside the scroller
12513 EAPI Evas_Object *elm_entry_icon_get(const Evas_Object *obj);
12516 * Unset the leftmost widget of the scrolled entry, unparenting and
12519 * @param obj The scrolled entry object
12520 * @return the previously set icon sub-object of this entry, on
12523 * @see elm_entry_icon_set()
12525 EAPI Evas_Object *elm_entry_icon_unset(Evas_Object *obj);
12528 * Sets the visibility of the left-side widget of the scrolled entry,
12529 * set by elm_entry_icon_set().
12531 * @param obj The scrolled entry object
12532 * @param setting EINA_TRUE if the object should be displayed,
12533 * EINA_FALSE if not.
12535 EAPI void elm_entry_icon_visible_set(Evas_Object *obj, Eina_Bool setting);
12538 * This sets a widget to be displayed to the end of a scrolled entry.
12540 * @param obj The scrolled entry object
12541 * @param end The widget to display on the right side of the scrolled
12544 * @note A previously set widget will be destroyed.
12545 * @note If the object being set does not have minimum size hints set,
12546 * it won't get properly displayed.
12548 * @see elm_entry_icon_set
12550 EAPI void elm_entry_end_set(Evas_Object *obj, Evas_Object *end);
12553 * Gets the endmost widget of the scrolled entry. This object is owned
12554 * by the scrolled entry and should not be modified.
12556 * @param obj The scrolled entry object
12557 * @return the right widget inside the scroller
12559 EAPI Evas_Object *elm_entry_end_get(const Evas_Object *obj);
12562 * Unset the endmost widget of the scrolled entry, unparenting and
12565 * @param obj The scrolled entry object
12566 * @return the previously set icon sub-object of this entry, on
12569 * @see elm_entry_icon_set()
12571 EAPI Evas_Object *elm_entry_end_unset(Evas_Object *obj);
12574 * Sets the visibility of the end widget of the scrolled entry, set by
12575 * elm_entry_end_set().
12577 * @param obj The scrolled entry object
12578 * @param setting EINA_TRUE if the object should be displayed,
12579 * EINA_FALSE if not.
12581 EAPI void elm_entry_end_visible_set(Evas_Object *obj, Eina_Bool setting);
12584 * This sets the scrolled entry's scrollbar policy (ie. enabling/disabling
12587 * Setting an entry to single-line mode with elm_entry_single_line_set()
12588 * will automatically disable the display of scrollbars when the entry
12589 * moves inside its scroller.
12591 * @param obj The scrolled entry object
12592 * @param h The horizontal scrollbar policy to apply
12593 * @param v The vertical scrollbar policy to apply
12595 EAPI void elm_entry_scrollbar_policy_set(Evas_Object *obj, Elm_Scroller_Policy h, Elm_Scroller_Policy v);
12598 * This enables/disables bouncing within the entry.
12600 * This function sets whether the entry will bounce when scrolling reaches
12601 * the end of the contained entry.
12603 * @param obj The scrolled entry object
12604 * @param h The horizontal bounce state
12605 * @param v The vertical bounce state
12607 EAPI void elm_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce);
12610 * Get the bounce mode
12612 * @param obj The Entry object
12613 * @param h_bounce Allow bounce horizontally
12614 * @param v_bounce Allow bounce vertically
12616 EAPI void elm_entry_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce);
12618 /* pre-made filters for entries */
12620 * @typedef Elm_Entry_Filter_Limit_Size
12622 * Data for the elm_entry_filter_limit_size() entry filter.
12624 typedef struct _Elm_Entry_Filter_Limit_Size Elm_Entry_Filter_Limit_Size;
12627 * @struct _Elm_Entry_Filter_Limit_Size
12629 * Data for the elm_entry_filter_limit_size() entry filter.
12631 struct _Elm_Entry_Filter_Limit_Size
12633 int max_char_count; /**< The maximum number of characters allowed. */
12634 int max_byte_count; /**< The maximum number of bytes allowed*/
12638 * Filter inserted text based on user defined character and byte limits
12640 * Add this filter to an entry to limit the characters that it will accept
12641 * based the the contents of the provided #Elm_Entry_Filter_Limit_Size.
12642 * The funtion works on the UTF-8 representation of the string, converting
12643 * it from the set markup, thus not accounting for any format in it.
12645 * The user must create an #Elm_Entry_Filter_Limit_Size structure and pass
12646 * it as data when setting the filter. In it, it's possible to set limits
12647 * by character count or bytes (any of them is disabled if 0), and both can
12648 * be set at the same time. In that case, it first checks for characters,
12651 * The function will cut the inserted text in order to allow only the first
12652 * number of characters that are still allowed. The cut is made in
12653 * characters, even when limiting by bytes, in order to always contain
12654 * valid ones and avoid half unicode characters making it in.
12656 * This filter, like any others, does not apply when setting the entry text
12657 * directly with elm_object_text_set() (or the deprecated
12658 * elm_entry_entry_set()).
12660 EAPI void elm_entry_filter_limit_size(void *data, Evas_Object *entry, char **text) EINA_ARG_NONNULL(1, 2, 3);
12663 * @typedef Elm_Entry_Filter_Accept_Set
12665 * Data for the elm_entry_filter_accept_set() entry filter.
12667 typedef struct _Elm_Entry_Filter_Accept_Set Elm_Entry_Filter_Accept_Set;
12670 * @struct _Elm_Entry_Filter_Accept_Set
12672 * Data for the elm_entry_filter_accept_set() entry filter.
12674 struct _Elm_Entry_Filter_Accept_Set
12676 const char *accepted; /**< Set of characters accepted in the entry. */
12677 const char *rejected; /**< Set of characters rejected from the entry. */
12681 * Filter inserted text based on accepted or rejected sets of characters
12683 * Add this filter to an entry to restrict the set of accepted characters
12684 * based on the sets in the provided #Elm_Entry_Filter_Accept_Set.
12685 * This structure contains both accepted and rejected sets, but they are
12686 * mutually exclusive.
12688 * The @c accepted set takes preference, so if it is set, the filter will
12689 * only work based on the accepted characters, ignoring anything in the
12690 * @c rejected value. If @c accepted is @c NULL, then @c rejected is used.
12692 * In both cases, the function filters by matching utf8 characters to the
12693 * raw markup text, so it can be used to remove formatting tags.
12695 * This filter, like any others, does not apply when setting the entry text
12696 * directly with elm_object_text_set() (or the deprecated
12697 * elm_entry_entry_set()).
12699 EAPI void elm_entry_filter_accept_set(void *data, Evas_Object *entry, char **text) EINA_ARG_NONNULL(1, 3);
12701 * Set the input panel layout of the entry
12703 * @param obj The entry object
12704 * @param layout layout type
12706 EAPI void elm_entry_input_panel_layout_set(Evas_Object *obj, Elm_Input_Panel_Layout layout) EINA_ARG_NONNULL(1);
12709 * Get the input panel layout of the entry
12711 * @param obj The entry object
12712 * @return layout type
12714 * @see elm_entry_input_panel_layout_set
12716 EAPI Elm_Input_Panel_Layout elm_entry_input_panel_layout_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
12719 * Set the autocapitalization type on the immodule.
12721 * @param obj The entry object
12722 * @param autocapital_type The type of autocapitalization
12724 EAPI void elm_entry_autocapital_type_set(Evas_Object *obj, Elm_Autocapital_Type autocapital_type) EINA_ARG_NONNULL(1);
12727 * Retrieve the autocapitalization type on the immodule.
12729 * @param obj The entry object
12730 * @return autocapitalization type
12732 EAPI Elm_Autocapital_Type elm_entry_autocapital_type_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
12735 * Sets the attribute to show the input panel automatically.
12737 * @param obj The entry object
12738 * @param enabled If true, the input panel is appeared when entry is clicked or has a focus
12740 EAPI void elm_entry_input_panel_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
12743 * Retrieve the attribute to show the input panel automatically.
12745 * @param obj The entry object
12746 * @return EINA_TRUE if input panel will be appeared when the entry is clicked or has a focus, EINA_FALSE otherwise
12748 EAPI Eina_Bool elm_entry_input_panel_enabled_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
12754 /* composite widgets - these basically put together basic widgets above
12755 * in convenient packages that do more than basic stuff */
12759 * @defgroup Anchorview Anchorview
12761 * @image html img/widget/anchorview/preview-00.png
12762 * @image latex img/widget/anchorview/preview-00.eps
12764 * Anchorview is for displaying text that contains markup with anchors
12765 * like <c>\<a href=1234\>something\</\></c> in it.
12767 * Besides being styled differently, the anchorview widget provides the
12768 * necessary functionality so that clicking on these anchors brings up a
12769 * popup with user defined content such as "call", "add to contacts" or
12770 * "open web page". This popup is provided using the @ref Hover widget.
12772 * This widget is very similar to @ref Anchorblock, so refer to that
12773 * widget for an example. The only difference Anchorview has is that the
12774 * widget is already provided with scrolling functionality, so if the
12775 * text set to it is too large to fit in the given space, it will scroll,
12776 * whereas the @ref Anchorblock widget will keep growing to ensure all the
12777 * text can be displayed.
12779 * This widget emits the following signals:
12780 * @li "anchor,clicked": will be called when an anchor is clicked. The
12781 * @p event_info parameter on the callback will be a pointer of type
12782 * ::Elm_Entry_Anchorview_Info.
12784 * See @ref Anchorblock for an example on how to use both of them.
12794 * @typedef Elm_Entry_Anchorview_Info
12796 * The info sent in the callback for "anchor,clicked" signals emitted by
12797 * the Anchorview widget.
12799 typedef struct _Elm_Entry_Anchorview_Info Elm_Entry_Anchorview_Info;
12802 * @struct _Elm_Entry_Anchorview_Info
12804 * The info sent in the callback for "anchor,clicked" signals emitted by
12805 * the Anchorview widget.
12807 struct _Elm_Entry_Anchorview_Info
12809 const char *name; /**< Name of the anchor, as indicated in its href
12811 int button; /**< The mouse button used to click on it */
12812 Evas_Object *hover; /**< The hover object to use for the popup */
12814 Evas_Coord x, y, w, h;
12815 } anchor, /**< Geometry selection of text used as anchor */
12816 hover_parent; /**< Geometry of the object used as parent by the
12818 Eina_Bool hover_left : 1; /**< Hint indicating if there's space
12819 for content on the left side of
12820 the hover. Before calling the
12821 callback, the widget will make the
12822 necessary calculations to check
12823 which sides are fit to be set with
12824 content, based on the position the
12825 hover is activated and its distance
12826 to the edges of its parent object
12828 Eina_Bool hover_right : 1; /**< Hint indicating content fits on
12829 the right side of the hover.
12830 See @ref hover_left */
12831 Eina_Bool hover_top : 1; /**< Hint indicating content fits on top
12832 of the hover. See @ref hover_left */
12833 Eina_Bool hover_bottom : 1; /**< Hint indicating content fits
12834 below the hover. See @ref
12839 * Add a new Anchorview object
12841 * @param parent The parent object
12842 * @return The new object or NULL if it cannot be created
12844 EAPI Evas_Object *elm_anchorview_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12847 * Set the text to show in the anchorview
12849 * Sets the text of the anchorview to @p text. This text can include markup
12850 * format tags, including <c>\<a href=anchorname\></c> to begin a segment of
12851 * text that will be specially styled and react to click events, ended with
12852 * either of \</a\> or \</\>. When clicked, the anchor will emit an
12853 * "anchor,clicked" signal that you can attach a callback to with
12854 * evas_object_smart_callback_add(). The name of the anchor given in the
12855 * event info struct will be the one set in the href attribute, in this
12856 * case, anchorname.
12858 * Other markup can be used to style the text in different ways, but it's
12859 * up to the style defined in the theme which tags do what.
12860 * @deprecated use elm_object_text_set() instead.
12862 EINA_DEPRECATED EAPI void elm_anchorview_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1);
12865 * Get the markup text set for the anchorview
12867 * Retrieves the text set on the anchorview, with markup tags included.
12869 * @param obj The anchorview object
12870 * @return The markup text set or @c NULL if nothing was set or an error
12872 * @deprecated use elm_object_text_set() instead.
12874 EINA_DEPRECATED EAPI const char *elm_anchorview_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12877 * Set the parent of the hover popup
12879 * Sets the parent object to use by the hover created by the anchorview
12880 * when an anchor is clicked. See @ref Hover for more details on this.
12881 * If no parent is set, the same anchorview object will be used.
12883 * @param obj The anchorview object
12884 * @param parent The object to use as parent for the hover
12886 EAPI void elm_anchorview_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
12889 * Get the parent of the hover popup
12891 * Get the object used as parent for the hover created by the anchorview
12892 * widget. See @ref Hover for more details on this.
12894 * @param obj The anchorview object
12895 * @return The object used as parent for the hover, NULL if none is set.
12897 EAPI Evas_Object *elm_anchorview_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12900 * Set the style that the hover should use
12902 * When creating the popup hover, anchorview will request that it's
12903 * themed according to @p style.
12905 * @param obj The anchorview object
12906 * @param style The style to use for the underlying hover
12908 * @see elm_object_style_set()
12910 EAPI void elm_anchorview_hover_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
12913 * Get the style that the hover should use
12915 * Get the style the hover created by anchorview will use.
12917 * @param obj The anchorview object
12918 * @return The style to use by the hover. NULL means the default is used.
12920 * @see elm_object_style_set()
12922 EAPI const char *elm_anchorview_hover_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12925 * Ends the hover popup in the anchorview
12927 * When an anchor is clicked, the anchorview widget will create a hover
12928 * object to use as a popup with user provided content. This function
12929 * terminates this popup, returning the anchorview to its normal state.
12931 * @param obj The anchorview object
12933 EAPI void elm_anchorview_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
12936 * Set bouncing behaviour when the scrolled content reaches an edge
12938 * Tell the internal scroller object whether it should bounce or not
12939 * when it reaches the respective edges for each axis.
12941 * @param obj The anchorview object
12942 * @param h_bounce Whether to bounce or not in the horizontal axis
12943 * @param v_bounce Whether to bounce or not in the vertical axis
12945 * @see elm_scroller_bounce_set()
12947 EAPI void elm_anchorview_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
12950 * Get the set bouncing behaviour of the internal scroller
12952 * Get whether the internal scroller should bounce when the edge of each
12953 * axis is reached scrolling.
12955 * @param obj The anchorview object
12956 * @param h_bounce Pointer where to store the bounce state of the horizontal
12958 * @param v_bounce Pointer where to store the bounce state of the vertical
12961 * @see elm_scroller_bounce_get()
12963 EAPI void elm_anchorview_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
12966 * Appends a custom item provider to the given anchorview
12968 * Appends the given function to the list of items providers. This list is
12969 * called, one function at a time, with the given @p data pointer, the
12970 * anchorview object and, in the @p item parameter, the item name as
12971 * referenced in its href string. Following functions in the list will be
12972 * called in order until one of them returns something different to NULL,
12973 * which should be an Evas_Object which will be used in place of the item
12976 * Items in the markup text take the form \<item relsize=16x16 vsize=full
12977 * href=item/name\>\</item\>
12979 * @param obj The anchorview object
12980 * @param func The function to add to the list of providers
12981 * @param data User data that will be passed to the callback function
12983 * @see elm_entry_item_provider_append()
12985 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);
12988 * Prepend a custom item provider to the given anchorview
12990 * Like elm_anchorview_item_provider_append(), but it adds the function
12991 * @p func to the beginning of the list, instead of the end.
12993 * @param obj The anchorview object
12994 * @param func The function to add to the list of providers
12995 * @param data User data that will be passed to the callback function
12997 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);
13000 * Remove a custom item provider from the list of the given anchorview
13002 * Removes the function and data pairing that matches @p func and @p data.
13003 * That is, unless the same function and same user data are given, the
13004 * function will not be removed from the list. This allows us to add the
13005 * same callback several times, with different @p data pointers and be
13006 * able to remove them later without conflicts.
13008 * @param obj The anchorview object
13009 * @param func The function to remove from the list
13010 * @param data The data matching the function to remove from the list
13012 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);
13020 * @defgroup Anchorblock Anchorblock
13022 * @image html img/widget/anchorblock/preview-00.png
13023 * @image latex img/widget/anchorblock/preview-00.eps
13025 * Anchorblock is for displaying text that contains markup with anchors
13026 * like <c>\<a href=1234\>something\</\></c> in it.
13028 * Besides being styled differently, the anchorblock widget provides the
13029 * necessary functionality so that clicking on these anchors brings up a
13030 * popup with user defined content such as "call", "add to contacts" or
13031 * "open web page". This popup is provided using the @ref Hover widget.
13033 * This widget emits the following signals:
13034 * @li "anchor,clicked": will be called when an anchor is clicked. The
13035 * @p event_info parameter on the callback will be a pointer of type
13036 * ::Elm_Entry_Anchorblock_Info.
13042 * Since examples are usually better than plain words, we might as well
13043 * try @ref tutorial_anchorblock_example "one".
13047 * @addtogroup Anchorblock
13052 * @typedef Elm_Entry_Anchorblock_Info
13054 * The info sent in the callback for "anchor,clicked" signals emitted by
13055 * the Anchorblock widget.
13057 typedef struct _Elm_Entry_Anchorblock_Info Elm_Entry_Anchorblock_Info;
13060 * @struct _Elm_Entry_Anchorblock_Info
13062 * The info sent in the callback for "anchor,clicked" signals emitted by
13063 * the Anchorblock widget.
13065 struct _Elm_Entry_Anchorblock_Info
13067 const char *name; /**< Name of the anchor, as indicated in its href
13069 int button; /**< The mouse button used to click on it */
13070 Evas_Object *hover; /**< The hover object to use for the popup */
13072 Evas_Coord x, y, w, h;
13073 } anchor, /**< Geometry selection of text used as anchor */
13074 hover_parent; /**< Geometry of the object used as parent by the
13076 Eina_Bool hover_left : 1; /**< Hint indicating if there's space
13077 for content on the left side of
13078 the hover. Before calling the
13079 callback, the widget will make the
13080 necessary calculations to check
13081 which sides are fit to be set with
13082 content, based on the position the
13083 hover is activated and its distance
13084 to the edges of its parent object
13086 Eina_Bool hover_right : 1; /**< Hint indicating content fits on
13087 the right side of the hover.
13088 See @ref hover_left */
13089 Eina_Bool hover_top : 1; /**< Hint indicating content fits on top
13090 of the hover. See @ref hover_left */
13091 Eina_Bool hover_bottom : 1; /**< Hint indicating content fits
13092 below the hover. See @ref
13097 * Add a new Anchorblock object
13099 * @param parent The parent object
13100 * @return The new object or NULL if it cannot be created
13102 EAPI Evas_Object *elm_anchorblock_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
13105 * Set the text to show in the anchorblock
13107 * Sets the text of the anchorblock to @p text. This text can include markup
13108 * format tags, including <c>\<a href=anchorname\></a></c> to begin a segment
13109 * of text that will be specially styled and react to click events, ended
13110 * with either of \</a\> or \</\>. When clicked, the anchor will emit an
13111 * "anchor,clicked" signal that you can attach a callback to with
13112 * evas_object_smart_callback_add(). The name of the anchor given in the
13113 * event info struct will be the one set in the href attribute, in this
13114 * case, anchorname.
13116 * Other markup can be used to style the text in different ways, but it's
13117 * up to the style defined in the theme which tags do what.
13118 * @deprecated use elm_object_text_set() instead.
13120 EINA_DEPRECATED EAPI void elm_anchorblock_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1);
13123 * Get the markup text set for the anchorblock
13125 * Retrieves the text set on the anchorblock, with markup tags included.
13127 * @param obj The anchorblock object
13128 * @return The markup text set or @c NULL if nothing was set or an error
13130 * @deprecated use elm_object_text_set() instead.
13132 EINA_DEPRECATED EAPI const char *elm_anchorblock_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13135 * Set the parent of the hover popup
13137 * Sets the parent object to use by the hover created by the anchorblock
13138 * when an anchor is clicked. See @ref Hover for more details on this.
13140 * @param obj The anchorblock object
13141 * @param parent The object to use as parent for the hover
13143 EAPI void elm_anchorblock_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
13146 * Get the parent of the hover popup
13148 * Get the object used as parent for the hover created by the anchorblock
13149 * widget. See @ref Hover for more details on this.
13150 * If no parent is set, the same anchorblock object will be used.
13152 * @param obj The anchorblock object
13153 * @return The object used as parent for the hover, NULL if none is set.
13155 EAPI Evas_Object *elm_anchorblock_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13158 * Set the style that the hover should use
13160 * When creating the popup hover, anchorblock will request that it's
13161 * themed according to @p style.
13163 * @param obj The anchorblock object
13164 * @param style The style to use for the underlying hover
13166 * @see elm_object_style_set()
13168 EAPI void elm_anchorblock_hover_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
13171 * Get the style that the hover should use
13173 * Get the style, the hover created by anchorblock will use.
13175 * @param obj The anchorblock object
13176 * @return The style to use by the hover. NULL means the default is used.
13178 * @see elm_object_style_set()
13180 EAPI const char *elm_anchorblock_hover_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13183 * Ends the hover popup in the anchorblock
13185 * When an anchor is clicked, the anchorblock widget will create a hover
13186 * object to use as a popup with user provided content. This function
13187 * terminates this popup, returning the anchorblock to its normal state.
13189 * @param obj The anchorblock object
13191 EAPI void elm_anchorblock_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
13194 * Appends a custom item provider to the given anchorblock
13196 * Appends the given function to the list of items providers. This list is
13197 * called, one function at a time, with the given @p data pointer, the
13198 * anchorblock object and, in the @p item parameter, the item name as
13199 * referenced in its href string. Following functions in the list will be
13200 * called in order until one of them returns something different to NULL,
13201 * which should be an Evas_Object which will be used in place of the item
13204 * Items in the markup text take the form \<item relsize=16x16 vsize=full
13205 * href=item/name\>\</item\>
13207 * @param obj The anchorblock object
13208 * @param func The function to add to the list of providers
13209 * @param data User data that will be passed to the callback function
13211 * @see elm_entry_item_provider_append()
13213 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);
13216 * Prepend a custom item provider to the given anchorblock
13218 * Like elm_anchorblock_item_provider_append(), but it adds the function
13219 * @p func to the beginning of the list, instead of the end.
13221 * @param obj The anchorblock object
13222 * @param func The function to add to the list of providers
13223 * @param data User data that will be passed to the callback function
13225 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);
13228 * Remove a custom item provider from the list of the given anchorblock
13230 * Removes the function and data pairing that matches @p func and @p data.
13231 * That is, unless the same function and same user data are given, the
13232 * function will not be removed from the list. This allows us to add the
13233 * same callback several times, with different @p data pointers and be
13234 * able to remove them later without conflicts.
13236 * @param obj The anchorblock object
13237 * @param func The function to remove from the list
13238 * @param data The data matching the function to remove from the list
13240 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);
13247 * @defgroup Bubble Bubble
13249 * @image html img/widget/bubble/preview-00.png
13250 * @image latex img/widget/bubble/preview-00.eps
13251 * @image html img/widget/bubble/preview-01.png
13252 * @image latex img/widget/bubble/preview-01.eps
13253 * @image html img/widget/bubble/preview-02.png
13254 * @image latex img/widget/bubble/preview-02.eps
13256 * @brief The Bubble is a widget to show text similar to how speech is
13257 * represented in comics.
13259 * The bubble widget contains 5 important visual elements:
13260 * @li The frame is a rectangle with rounded edjes and an "arrow".
13261 * @li The @p icon is an image to which the frame's arrow points to.
13262 * @li The @p label is a text which appears to the right of the icon if the
13263 * corner is "top_left" or "bottom_left" and is right aligned to the frame
13265 * @li The @p info is a text which appears to the right of the label. Info's
13266 * font is of a ligther color than label.
13267 * @li The @p content is an evas object that is shown inside the frame.
13269 * The position of the arrow, icon, label and info depends on which corner is
13270 * selected. The four available corners are:
13271 * @li "top_left" - Default
13273 * @li "bottom_left"
13274 * @li "bottom_right"
13276 * Signals that you can add callbacks for are:
13277 * @li "clicked" - This is called when a user has clicked the bubble.
13279 * Default contents parts of the bubble that you can use for are:
13280 * @li "default" - A content of the bubble
13281 * @li "icon" - An icon of the bubble
13283 * Default text parts of the button widget that you can use for are:
13284 * @li NULL - Label of the bubble
13286 * For an example of using a buble see @ref bubble_01_example_page "this".
13292 * Add a new bubble to the parent
13294 * @param parent The parent object
13295 * @return The new object or NULL if it cannot be created
13297 * This function adds a text bubble to the given parent evas object.
13299 EAPI Evas_Object *elm_bubble_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
13302 * Set the label of the bubble
13304 * @param obj The bubble object
13305 * @param label The string to set in the label
13307 * This function sets the title of the bubble. Where this appears depends on
13308 * the selected corner.
13309 * @deprecated use elm_object_text_set() instead.
13311 EINA_DEPRECATED EAPI void elm_bubble_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
13314 * Get the label of the bubble
13316 * @param obj The bubble object
13317 * @return The string of set in the label
13319 * This function gets the title of the bubble.
13320 * @deprecated use elm_object_text_get() instead.
13322 EINA_DEPRECATED EAPI const char *elm_bubble_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13325 * Set the info of the bubble
13327 * @param obj The bubble object
13328 * @param info The given info about the bubble
13330 * This function sets the info of the bubble. Where this appears depends on
13331 * the selected corner.
13332 * @deprecated use elm_object_part_text_set() instead. (with "info" as the parameter).
13334 EINA_DEPRECATED EAPI void elm_bubble_info_set(Evas_Object *obj, const char *info) EINA_ARG_NONNULL(1);
13337 * Get the info of the bubble
13339 * @param obj The bubble object
13341 * @return The "info" string of the bubble
13343 * This function gets the info text.
13344 * @deprecated use elm_object_part_text_get() instead. (with "info" as the parameter).
13346 EINA_DEPRECATED EAPI const char *elm_bubble_info_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13349 * Set the content to be shown in the bubble
13351 * Once the content object is set, a previously set one will be deleted.
13352 * If you want to keep the old content object, use the
13353 * elm_bubble_content_unset() function.
13355 * @param obj The bubble object
13356 * @param content The given content of the bubble
13358 * This function sets the content shown on the middle of the bubble.
13360 * @deprecated use elm_object_content_set() instead
13363 EINA_DEPRECATED EAPI void elm_bubble_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
13366 * Get the content shown in the bubble
13368 * Return the content object which is set for this widget.
13370 * @param obj The bubble object
13371 * @return The content that is being used
13373 * @deprecated use elm_object_content_get() instead
13376 EINA_DEPRECATED EAPI Evas_Object *elm_bubble_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13379 * Unset the content shown in the bubble
13381 * Unparent and return the content object which was set for this widget.
13383 * @param obj The bubble object
13384 * @return The content that was being used
13386 * @deprecated use elm_object_content_unset() instead
13389 EINA_DEPRECATED EAPI Evas_Object *elm_bubble_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
13392 * Set the icon of the bubble
13394 * Once the icon object is set, a previously set one will be deleted.
13395 * If you want to keep the old content object, use the
13396 * elm_icon_content_unset() function.
13398 * @param obj The bubble object
13399 * @param icon The given icon for the bubble
13401 * @deprecated use elm_object_part_content_set() instead
13404 EINA_DEPRECATED EAPI void elm_bubble_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
13407 * Get the icon of the bubble
13409 * @param obj The bubble object
13410 * @return The icon for the bubble
13412 * This function gets the icon shown on the top left of bubble.
13414 * @deprecated use elm_object_part_content_get() instead
13417 EINA_DEPRECATED EAPI Evas_Object *elm_bubble_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13420 * Unset the icon of the bubble
13422 * Unparent and return the icon object which was set for this widget.
13424 * @param obj The bubble object
13425 * @return The icon that was being used
13427 * @deprecated use elm_object_part_content_unset() instead
13430 EINA_DEPRECATED EAPI Evas_Object *elm_bubble_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
13433 * Set the corner of the bubble
13435 * @param obj The bubble object.
13436 * @param corner The given corner for the bubble.
13438 * This function sets the corner of the bubble. The corner will be used to
13439 * determine where the arrow in the frame points to and where label, icon and
13442 * Possible values for corner are:
13443 * @li "top_left" - Default
13445 * @li "bottom_left"
13446 * @li "bottom_right"
13448 EAPI void elm_bubble_corner_set(Evas_Object *obj, const char *corner) EINA_ARG_NONNULL(1, 2);
13451 * Get the corner of the bubble
13453 * @param obj The bubble object.
13454 * @return The given corner for the bubble.
13456 * This function gets the selected corner of the bubble.
13458 EAPI const char *elm_bubble_corner_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13465 * @defgroup Photo Photo
13467 * For displaying the photo of a person (contact). Simple, yet
13468 * with a very specific purpose.
13470 * Signals that you can add callbacks for are:
13472 * "clicked" - This is called when a user has clicked the photo
13473 * "drag,start" - Someone started dragging the image out of the object
13474 * "drag,end" - Dragged item was dropped (somewhere)
13480 * Add a new photo to the parent
13482 * @param parent The parent object
13483 * @return The new object or NULL if it cannot be created
13487 EAPI Evas_Object *elm_photo_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
13490 * Set the file that will be used as photo
13492 * @param obj The photo object
13493 * @param file The path to file that will be used as photo
13495 * @return (1 = success, 0 = error)
13499 EAPI Eina_Bool elm_photo_file_set(Evas_Object *obj, const char *file) EINA_ARG_NONNULL(1);
13502 * Set the file that will be used as thumbnail in the photo.
13504 * @param obj The photo object.
13505 * @param file The path to file that will be used as thumb.
13506 * @param group The key used in case of an EET file.
13510 EAPI void elm_photo_thumb_set(const Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
13513 * Set the size that will be used on the photo
13515 * @param obj The photo object
13516 * @param size The size that the photo will be
13520 EAPI void elm_photo_size_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
13523 * Set if the photo should be completely visible or not.
13525 * @param obj The photo object
13526 * @param fill if true the photo will be completely visible
13530 EAPI void elm_photo_fill_inside_set(Evas_Object *obj, Eina_Bool fill) EINA_ARG_NONNULL(1);
13533 * Set editability of the photo.
13535 * An editable photo can be dragged to or from, and can be cut or
13536 * pasted too. Note that pasting an image or dropping an item on
13537 * the image will delete the existing content.
13539 * @param obj The photo object.
13540 * @param set To set of clear editablity.
13542 EAPI void elm_photo_editable_set(Evas_Object *obj, Eina_Bool set) EINA_ARG_NONNULL(1);
13548 /* gesture layer */
13550 * @defgroup Elm_Gesture_Layer Gesture Layer
13551 * Gesture Layer Usage:
13553 * Use Gesture Layer to detect gestures.
13554 * The advantage is that you don't have to implement
13555 * gesture detection, just set callbacks of gesture state.
13556 * By using gesture layer we make standard interface.
13558 * In order to use Gesture Layer you start with @ref elm_gesture_layer_add
13559 * with a parent object parameter.
13560 * Next 'activate' gesture layer with a @ref elm_gesture_layer_attach
13561 * call. Usually with same object as target (2nd parameter).
13563 * Now you need to tell gesture layer what gestures you follow.
13564 * This is done with @ref elm_gesture_layer_cb_set call.
13565 * By setting the callback you actually saying to gesture layer:
13566 * I would like to know when the gesture @ref Elm_Gesture_Types
13567 * switches to state @ref Elm_Gesture_State.
13569 * Next, you need to implement the actual action that follows the input
13570 * in your callback.
13572 * Note that if you like to stop being reported about a gesture, just set
13573 * all callbacks referring this gesture to NULL.
13574 * (again with @ref elm_gesture_layer_cb_set)
13576 * The information reported by gesture layer to your callback is depending
13577 * on @ref Elm_Gesture_Types:
13578 * @ref Elm_Gesture_Taps_Info is the info reported for tap gestures:
13579 * @ref ELM_GESTURE_N_TAPS, @ref ELM_GESTURE_N_LONG_TAPS,
13580 * @ref ELM_GESTURE_N_DOUBLE_TAPS, @ref ELM_GESTURE_N_TRIPLE_TAPS.
13582 * @ref Elm_Gesture_Momentum_Info is info reported for momentum gestures:
13583 * @ref ELM_GESTURE_MOMENTUM.
13585 * @ref Elm_Gesture_Line_Info is the info reported for line gestures:
13586 * (this also contains @ref Elm_Gesture_Momentum_Info internal structure)
13587 * @ref ELM_GESTURE_N_LINES, @ref ELM_GESTURE_N_FLICKS.
13588 * Note that we consider a flick as a line-gesture that should be completed
13589 * in flick-time-limit as defined in @ref Config.
13591 * @ref Elm_Gesture_Zoom_Info is the info reported for @ref ELM_GESTURE_ZOOM gesture.
13593 * @ref Elm_Gesture_Rotate_Info is the info reported for @ref ELM_GESTURE_ROTATE gesture.
13596 * Gesture Layer Tweaks:
13598 * Note that line, flick, gestures can start without the need to remove fingers from surface.
13599 * When user fingers rests on same-spot gesture is ended and starts again when fingers moved.
13601 * Setting glayer_continues_enable to false in @ref Config will change this behavior
13602 * so gesture starts when user touches (a *DOWN event) touch-surface
13603 * and ends when no fingers touches surface (a *UP event).
13607 * @enum _Elm_Gesture_Types
13608 * Enum of supported gesture types.
13609 * @ingroup Elm_Gesture_Layer
13611 enum _Elm_Gesture_Types
13613 ELM_GESTURE_FIRST = 0,
13615 ELM_GESTURE_N_TAPS, /**< N fingers single taps */
13616 ELM_GESTURE_N_LONG_TAPS, /**< N fingers single long-taps */
13617 ELM_GESTURE_N_DOUBLE_TAPS, /**< N fingers double-single taps */
13618 ELM_GESTURE_N_TRIPLE_TAPS, /**< N fingers triple-single taps */
13620 ELM_GESTURE_MOMENTUM, /**< Reports momentum in the dircetion of move */
13622 ELM_GESTURE_N_LINES, /**< N fingers line gesture */
13623 ELM_GESTURE_N_FLICKS, /**< N fingers flick gesture */
13625 ELM_GESTURE_ZOOM, /**< Zoom */
13626 ELM_GESTURE_ROTATE, /**< Rotate */
13632 * @typedef Elm_Gesture_Types
13633 * gesture types enum
13634 * @ingroup Elm_Gesture_Layer
13636 typedef enum _Elm_Gesture_Types Elm_Gesture_Types;
13639 * @enum _Elm_Gesture_State
13640 * Enum of gesture states.
13641 * @ingroup Elm_Gesture_Layer
13643 enum _Elm_Gesture_State
13645 ELM_GESTURE_STATE_UNDEFINED = -1, /**< Gesture not STARTed */
13646 ELM_GESTURE_STATE_START, /**< Gesture STARTed */
13647 ELM_GESTURE_STATE_MOVE, /**< Gesture is ongoing */
13648 ELM_GESTURE_STATE_END, /**< Gesture completed */
13649 ELM_GESTURE_STATE_ABORT /**< Onging gesture was ABORTed */
13653 * @typedef Elm_Gesture_State
13654 * gesture states enum
13655 * @ingroup Elm_Gesture_Layer
13657 typedef enum _Elm_Gesture_State Elm_Gesture_State;
13660 * @struct _Elm_Gesture_Taps_Info
13661 * Struct holds taps info for user
13662 * @ingroup Elm_Gesture_Layer
13664 struct _Elm_Gesture_Taps_Info
13666 Evas_Coord x, y; /**< Holds center point between fingers */
13667 unsigned int n; /**< Number of fingers tapped */
13668 unsigned int timestamp; /**< event timestamp */
13672 * @typedef Elm_Gesture_Taps_Info
13673 * holds taps info for user
13674 * @ingroup Elm_Gesture_Layer
13676 typedef struct _Elm_Gesture_Taps_Info Elm_Gesture_Taps_Info;
13679 * @struct _Elm_Gesture_Momentum_Info
13680 * Struct holds momentum info for user
13681 * x1 and y1 are not necessarily in sync
13682 * x1 holds x value of x direction starting point
13683 * and same holds for y1.
13684 * This is noticeable when doing V-shape movement
13685 * @ingroup Elm_Gesture_Layer
13687 struct _Elm_Gesture_Momentum_Info
13688 { /* Report line ends, timestamps, and momentum computed */
13689 Evas_Coord x1; /**< Final-swipe direction starting point on X */
13690 Evas_Coord y1; /**< Final-swipe direction starting point on Y */
13691 Evas_Coord x2; /**< Final-swipe direction ending point on X */
13692 Evas_Coord y2; /**< Final-swipe direction ending point on Y */
13694 unsigned int tx; /**< Timestamp of start of final x-swipe */
13695 unsigned int ty; /**< Timestamp of start of final y-swipe */
13697 Evas_Coord mx; /**< Momentum on X */
13698 Evas_Coord my; /**< Momentum on Y */
13700 unsigned int n; /**< Number of fingers */
13704 * @typedef Elm_Gesture_Momentum_Info
13705 * holds momentum info for user
13706 * @ingroup Elm_Gesture_Layer
13708 typedef struct _Elm_Gesture_Momentum_Info Elm_Gesture_Momentum_Info;
13711 * @struct _Elm_Gesture_Line_Info
13712 * Struct holds line info for user
13713 * @ingroup Elm_Gesture_Layer
13715 struct _Elm_Gesture_Line_Info
13716 { /* Report line ends, timestamps, and momentum computed */
13717 Elm_Gesture_Momentum_Info momentum; /**< Line momentum info */
13718 double angle; /**< Angle (direction) of lines */
13722 * @typedef Elm_Gesture_Line_Info
13723 * Holds line info for user
13724 * @ingroup Elm_Gesture_Layer
13726 typedef struct _Elm_Gesture_Line_Info Elm_Gesture_Line_Info;
13729 * @struct _Elm_Gesture_Zoom_Info
13730 * Struct holds zoom info for user
13731 * @ingroup Elm_Gesture_Layer
13733 struct _Elm_Gesture_Zoom_Info
13735 Evas_Coord x, y; /**< Holds zoom center point reported to user */
13736 Evas_Coord radius; /**< Holds radius between fingers reported to user */
13737 double zoom; /**< Zoom value: 1.0 means no zoom */
13738 double momentum; /**< Zoom momentum: zoom growth per second (NOT YET SUPPORTED) */
13742 * @typedef Elm_Gesture_Zoom_Info
13743 * Holds zoom info for user
13744 * @ingroup Elm_Gesture_Layer
13746 typedef struct _Elm_Gesture_Zoom_Info Elm_Gesture_Zoom_Info;
13749 * @struct _Elm_Gesture_Rotate_Info
13750 * Struct holds rotation info for user
13751 * @ingroup Elm_Gesture_Layer
13753 struct _Elm_Gesture_Rotate_Info
13755 Evas_Coord x, y; /**< Holds zoom center point reported to user */
13756 Evas_Coord radius; /**< Holds radius between fingers reported to user */
13757 double base_angle; /**< Holds start-angle */
13758 double angle; /**< Rotation value: 0.0 means no rotation */
13759 double momentum; /**< Rotation momentum: rotation done per second (NOT YET SUPPORTED) */
13763 * @typedef Elm_Gesture_Rotate_Info
13764 * Holds rotation info for user
13765 * @ingroup Elm_Gesture_Layer
13767 typedef struct _Elm_Gesture_Rotate_Info Elm_Gesture_Rotate_Info;
13770 * @typedef Elm_Gesture_Event_Cb
13771 * User callback used to stream gesture info from gesture layer
13772 * @param data user data
13773 * @param event_info gesture report info
13774 * Returns a flag field to be applied on the causing event.
13775 * You should probably return EVAS_EVENT_FLAG_ON_HOLD if your widget acted
13776 * upon the event, in an irreversible way.
13778 * @ingroup Elm_Gesture_Layer
13780 typedef Evas_Event_Flags (*Elm_Gesture_Event_Cb) (void *data, void *event_info);
13783 * Use function to set callbacks to be notified about
13784 * change of state of gesture.
13785 * When a user registers a callback with this function
13786 * this means this gesture has to be tested.
13788 * When ALL callbacks for a gesture are set to NULL
13789 * it means user isn't interested in gesture-state
13790 * and it will not be tested.
13792 * @param obj Pointer to gesture-layer.
13793 * @param idx The gesture you would like to track its state.
13794 * @param cb callback function pointer.
13795 * @param cb_type what event this callback tracks: START, MOVE, END, ABORT.
13796 * @param data user info to be sent to callback (usually, Smart Data)
13798 * @ingroup Elm_Gesture_Layer
13800 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);
13803 * Call this function to get repeat-events settings.
13805 * @param obj Pointer to gesture-layer.
13807 * @return repeat events settings.
13808 * @see elm_gesture_layer_hold_events_set()
13809 * @ingroup Elm_Gesture_Layer
13811 EAPI Eina_Bool elm_gesture_layer_hold_events_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
13814 * This function called in order to make gesture-layer repeat events.
13815 * Set this of you like to get the raw events only if gestures were not detected.
13816 * Clear this if you like gesture layer to fwd events as testing gestures.
13818 * @param obj Pointer to gesture-layer.
13819 * @param r Repeat: TRUE/FALSE
13821 * @ingroup Elm_Gesture_Layer
13823 EAPI void elm_gesture_layer_hold_events_set(Evas_Object *obj, Eina_Bool r) EINA_ARG_NONNULL(1);
13826 * This function sets step-value for zoom action.
13827 * Set step to any positive value.
13828 * Cancel step setting by setting to 0.0
13830 * @param obj Pointer to gesture-layer.
13831 * @param s new zoom step value.
13833 * @ingroup Elm_Gesture_Layer
13835 EAPI void elm_gesture_layer_zoom_step_set(Evas_Object *obj, double s) EINA_ARG_NONNULL(1);
13838 * This function sets step-value for rotate action.
13839 * Set step to any positive value.
13840 * Cancel step setting by setting to 0.0
13842 * @param obj Pointer to gesture-layer.
13843 * @param s new roatate step value.
13845 * @ingroup Elm_Gesture_Layer
13847 EAPI void elm_gesture_layer_rotate_step_set(Evas_Object *obj, double s) EINA_ARG_NONNULL(1);
13850 * This function called to attach gesture-layer to an Evas_Object.
13851 * @param obj Pointer to gesture-layer.
13852 * @param t Pointer to underlying object (AKA Target)
13854 * @return TRUE, FALSE on success, failure.
13856 * @ingroup Elm_Gesture_Layer
13858 EAPI Eina_Bool elm_gesture_layer_attach(Evas_Object *obj, Evas_Object *t) EINA_ARG_NONNULL(1, 2);
13861 * Call this function to construct a new gesture-layer object.
13862 * This does not activate the gesture layer. You have to
13863 * call elm_gesture_layer_attach in order to 'activate' gesture-layer.
13865 * @param parent the parent object.
13867 * @return Pointer to new gesture-layer object.
13869 * @ingroup Elm_Gesture_Layer
13871 EAPI Evas_Object *elm_gesture_layer_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
13874 * @defgroup Thumb Thumb
13876 * @image html img/widget/thumb/preview-00.png
13877 * @image latex img/widget/thumb/preview-00.eps
13879 * A thumb object is used for displaying the thumbnail of an image or video.
13880 * You must have compiled Elementary with Ethumb_Client support and the DBus
13881 * service must be present and auto-activated in order to have thumbnails to
13884 * Once the thumbnail object becomes visible, it will check if there is a
13885 * previously generated thumbnail image for the file set on it. If not, it
13886 * will start generating this thumbnail.
13888 * Different config settings will cause different thumbnails to be generated
13889 * even on the same file.
13891 * Generated thumbnails are stored under @c $HOME/.thumbnails/. Check the
13892 * Ethumb documentation to change this path, and to see other configuration
13895 * Signals that you can add callbacks for are:
13897 * - "clicked" - This is called when a user has clicked the thumb without dragging
13899 * - "clicked,double" - This is called when a user has double-clicked the thumb.
13900 * - "press" - This is called when a user has pressed down the thumb.
13901 * - "generate,start" - The thumbnail generation started.
13902 * - "generate,stop" - The generation process stopped.
13903 * - "generate,error" - The generation failed.
13904 * - "load,error" - The thumbnail image loading failed.
13906 * available styles:
13910 * An example of use of thumbnail:
13912 * - @ref thumb_example_01
13916 * @addtogroup Thumb
13921 * @enum _Elm_Thumb_Animation_Setting
13922 * @typedef Elm_Thumb_Animation_Setting
13924 * Used to set if a video thumbnail is animating or not.
13928 typedef enum _Elm_Thumb_Animation_Setting
13930 ELM_THUMB_ANIMATION_START = 0, /**< Play animation once */
13931 ELM_THUMB_ANIMATION_LOOP, /**< Keep playing animation until stop is requested */
13932 ELM_THUMB_ANIMATION_STOP, /**< Stop playing the animation */
13933 ELM_THUMB_ANIMATION_LAST
13934 } Elm_Thumb_Animation_Setting;
13937 * Add a new thumb object to the parent.
13939 * @param parent The parent object.
13940 * @return The new object or NULL if it cannot be created.
13942 * @see elm_thumb_file_set()
13943 * @see elm_thumb_ethumb_client_get()
13947 EAPI Evas_Object *elm_thumb_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
13950 * Reload thumbnail if it was generated before.
13952 * @param obj The thumb object to reload
13954 * This is useful if the ethumb client configuration changed, like its
13955 * size, aspect or any other property one set in the handle returned
13956 * by elm_thumb_ethumb_client_get().
13958 * If the options didn't change, the thumbnail won't be generated again, but
13959 * the old one will still be used.
13961 * @see elm_thumb_file_set()
13965 EAPI void elm_thumb_reload(Evas_Object *obj) EINA_ARG_NONNULL(1);
13968 * Set the file that will be used as thumbnail.
13970 * @param obj The thumb object.
13971 * @param file The path to file that will be used as thumb.
13972 * @param key The key used in case of an EET file.
13974 * The file can be an image or a video (in that case, acceptable extensions are:
13975 * avi, mp4, ogv, mov, mpg and wmv). To start the video animation, use the
13976 * function elm_thumb_animate().
13978 * @see elm_thumb_file_get()
13979 * @see elm_thumb_reload()
13980 * @see elm_thumb_animate()
13984 EAPI void elm_thumb_file_set(Evas_Object *obj, const char *file, const char *key) EINA_ARG_NONNULL(1);
13987 * Get the image or video path and key used to generate the thumbnail.
13989 * @param obj The thumb object.
13990 * @param file Pointer to filename.
13991 * @param key Pointer to key.
13993 * @see elm_thumb_file_set()
13994 * @see elm_thumb_path_get()
13998 EAPI void elm_thumb_file_get(const Evas_Object *obj, const char **file, const char **key) EINA_ARG_NONNULL(1);
14001 * Get the path and key to the image or video generated by ethumb.
14003 * One just need to make sure that the thumbnail was generated before getting
14004 * its path; otherwise, the path will be NULL. One way to do that is by asking
14005 * for the path when/after the "generate,stop" smart callback is called.
14007 * @param obj The thumb object.
14008 * @param file Pointer to thumb path.
14009 * @param key Pointer to thumb key.
14011 * @see elm_thumb_file_get()
14015 EAPI void elm_thumb_path_get(const Evas_Object *obj, const char **file, const char **key) EINA_ARG_NONNULL(1);
14018 * Set the animation state for the thumb object. If its content is an animated
14019 * video, you may start/stop the animation or tell it to play continuously and
14022 * @param obj The thumb object.
14023 * @param setting The animation setting.
14025 * @see elm_thumb_file_set()
14029 EAPI void elm_thumb_animate_set(Evas_Object *obj, Elm_Thumb_Animation_Setting s) EINA_ARG_NONNULL(1);
14032 * Get the animation state for the thumb object.
14034 * @param obj The thumb object.
14035 * @return getting The animation setting or @c ELM_THUMB_ANIMATION_LAST,
14038 * @see elm_thumb_animate_set()
14042 EAPI Elm_Thumb_Animation_Setting elm_thumb_animate_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14045 * Get the ethumb_client handle so custom configuration can be made.
14047 * @return Ethumb_Client instance or NULL.
14049 * This must be called before the objects are created to be sure no object is
14050 * visible and no generation started.
14052 * Example of usage:
14055 * #include <Elementary.h>
14056 * #ifndef ELM_LIB_QUICKLAUNCH
14058 * elm_main(int argc, char **argv)
14060 * Ethumb_Client *client;
14062 * elm_need_ethumb();
14066 * client = elm_thumb_ethumb_client_get();
14069 * ERR("could not get ethumb_client");
14072 * ethumb_client_size_set(client, 100, 100);
14073 * ethumb_client_crop_align_set(client, 0.5, 0.5);
14076 * // Create elm_thumb objects here
14086 * @note There's only one client handle for Ethumb, so once a configuration
14087 * change is done to it, any other request for thumbnails (for any thumbnail
14088 * object) will use that configuration. Thus, this configuration is global.
14092 EAPI void *elm_thumb_ethumb_client_get(void);
14095 * Get the ethumb_client connection state.
14097 * @return EINA_TRUE if the client is connected to the server or EINA_FALSE
14100 EAPI Eina_Bool elm_thumb_ethumb_client_connected(void);
14103 * Make the thumbnail 'editable'.
14105 * @param obj Thumb object.
14106 * @param set Turn on or off editability. Default is @c EINA_FALSE.
14108 * This means the thumbnail is a valid drag target for drag and drop, and can be
14109 * cut or pasted too.
14111 * @see elm_thumb_editable_get()
14115 EAPI Eina_Bool elm_thumb_editable_set(Evas_Object *obj, Eina_Bool edit) EINA_ARG_NONNULL(1);
14118 * Make the thumbnail 'editable'.
14120 * @param obj Thumb object.
14121 * @return Editability.
14123 * This means the thumbnail is a valid drag target for drag and drop, and can be
14124 * cut or pasted too.
14126 * @see elm_thumb_editable_set()
14130 EAPI Eina_Bool elm_thumb_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14137 * @defgroup Web Web
14139 * @image html img/widget/web/preview-00.png
14140 * @image latex img/widget/web/preview-00.eps
14142 * A web object is used for displaying web pages (HTML/CSS/JS)
14143 * using WebKit-EFL. You must have compiled Elementary with
14146 * Signals that you can add callbacks for are:
14147 * @li "download,request": A file download has been requested. Event info is
14148 * a pointer to a Elm_Web_Download
14149 * @li "editorclient,contents,changed": Editor client's contents changed
14150 * @li "editorclient,selection,changed": Editor client's selection changed
14151 * @li "frame,created": A new frame was created. Event info is an
14152 * Evas_Object which can be handled with WebKit's ewk_frame API
14153 * @li "icon,received": An icon was received by the main frame
14154 * @li "inputmethod,changed": Input method changed. Event info is an
14155 * Eina_Bool indicating whether it's enabled or not
14156 * @li "js,windowobject,clear": JS window object has been cleared
14157 * @li "link,hover,in": Mouse cursor is hovering over a link. Event info
14158 * is a char *link[2], where the first string contains the URL the link
14159 * points to, and the second one the title of the link
14160 * @li "link,hover,out": Mouse cursor left the link
14161 * @li "load,document,finished": Loading of a document finished. Event info
14162 * is the frame that finished loading
14163 * @li "load,error": Load failed. Event info is a pointer to
14164 * Elm_Web_Frame_Load_Error
14165 * @li "load,finished": Load finished. Event info is NULL on success, on
14166 * error it's a pointer to Elm_Web_Frame_Load_Error
14167 * @li "load,newwindow,show": A new window was created and is ready to be
14169 * @li "load,progress": Overall load progress. Event info is a pointer to
14170 * a double containing a value between 0.0 and 1.0
14171 * @li "load,provisional": Started provisional load
14172 * @li "load,started": Loading of a document started
14173 * @li "menubar,visible,get": Queries if the menubar is visible. Event info
14174 * is a pointer to Eina_Bool where the callback should set EINA_TRUE if
14175 * the menubar is visible, or EINA_FALSE in case it's not
14176 * @li "menubar,visible,set": Informs menubar visibility. Event info is
14177 * an Eina_Bool indicating the visibility
14178 * @li "popup,created": A dropdown widget was activated, requesting its
14179 * popup menu to be created. Event info is a pointer to Elm_Web_Menu
14180 * @li "popup,willdelete": The web object is ready to destroy the popup
14181 * object created. Event info is a pointer to Elm_Web_Menu
14182 * @li "ready": Page is fully loaded
14183 * @li "scrollbars,visible,get": Queries visibility of scrollbars. Event
14184 * info is a pointer to Eina_Bool where the visibility state should be set
14185 * @li "scrollbars,visible,set": Informs scrollbars visibility. Event info
14186 * is an Eina_Bool with the visibility state set
14187 * @li "statusbar,text,set": Text of the statusbar changed. Even info is
14188 * a string with the new text
14189 * @li "statusbar,visible,get": Queries visibility of the status bar.
14190 * Event info is a pointer to Eina_Bool where the visibility state should be
14192 * @li "statusbar,visible,set": Informs statusbar visibility. Event info is
14193 * an Eina_Bool with the visibility value
14194 * @li "title,changed": Title of the main frame changed. Event info is a
14195 * string with the new title
14196 * @li "toolbars,visible,get": Queries visibility of toolbars. Event info
14197 * is a pointer to Eina_Bool where the visibility state should be set
14198 * @li "toolbars,visible,set": Informs the visibility of toolbars. Event
14199 * info is an Eina_Bool with the visibility state
14200 * @li "tooltip,text,set": Show and set text of a tooltip. Event info is
14201 * a string with the text to show
14202 * @li "uri,changed": URI of the main frame changed. Event info is a string
14204 * @li "view,resized": The web object internal's view changed sized
14205 * @li "windows,close,request": A JavaScript request to close the current
14206 * window was requested
14207 * @li "zoom,animated,end": Animated zoom finished
14209 * available styles:
14212 * An example of use of web:
14214 * - @ref web_example_01 TBD
14223 * Structure used to report load errors.
14225 * Load errors are reported as signal by elm_web. All the strings are
14226 * temporary references and should @b not be used after the signal
14227 * callback returns. If it's required, make copies with strdup() or
14228 * eina_stringshare_add() (they are not even guaranteed to be
14229 * stringshared, so must use eina_stringshare_add() and not
14230 * eina_stringshare_ref()).
14232 typedef struct _Elm_Web_Frame_Load_Error Elm_Web_Frame_Load_Error;
14235 * Structure used to report load errors.
14237 * Load errors are reported as signal by elm_web. All the strings are
14238 * temporary references and should @b not be used after the signal
14239 * callback returns. If it's required, make copies with strdup() or
14240 * eina_stringshare_add() (they are not even guaranteed to be
14241 * stringshared, so must use eina_stringshare_add() and not
14242 * eina_stringshare_ref()).
14244 struct _Elm_Web_Frame_Load_Error
14246 int code; /**< Numeric error code */
14247 Eina_Bool is_cancellation; /**< Error produced by cancelling a request */
14248 const char *domain; /**< Error domain name */
14249 const char *description; /**< Error description (already localized) */
14250 const char *failing_url; /**< The URL that failed to load */
14251 Evas_Object *frame; /**< Frame object that produced the error */
14255 * The possibles types that the items in a menu can be
14257 typedef enum _Elm_Web_Menu_Item_Type
14259 ELM_WEB_MENU_SEPARATOR,
14260 ELM_WEB_MENU_GROUP,
14261 ELM_WEB_MENU_OPTION
14262 } Elm_Web_Menu_Item_Type;
14265 * Structure describing the items in a menu
14267 typedef struct _Elm_Web_Menu_Item Elm_Web_Menu_Item;
14270 * Structure describing the items in a menu
14272 struct _Elm_Web_Menu_Item
14274 const char *text; /**< The text for the item */
14275 Elm_Web_Menu_Item_Type type; /**< The type of the item */
14279 * Structure describing the menu of a popup
14281 * This structure will be passed as the @c event_info for the "popup,create"
14282 * signal, which is emitted when a dropdown menu is opened. Users wanting
14283 * to handle these popups by themselves should listen to this signal and
14284 * set the @c handled property of the struct to @c EINA_TRUE. Leaving this
14285 * property as @c EINA_FALSE means that the user will not handle the popup
14286 * and the default implementation will be used.
14288 * When the popup is ready to be dismissed, a "popup,willdelete" signal
14289 * will be emitted to notify the user that it can destroy any objects and
14290 * free all data related to it.
14292 * @see elm_web_popup_selected_set()
14293 * @see elm_web_popup_destroy()
14295 typedef struct _Elm_Web_Menu Elm_Web_Menu;
14298 * Structure describing the menu of a popup
14300 * This structure will be passed as the @c event_info for the "popup,create"
14301 * signal, which is emitted when a dropdown menu is opened. Users wanting
14302 * to handle these popups by themselves should listen to this signal and
14303 * set the @c handled property of the struct to @c EINA_TRUE. Leaving this
14304 * property as @c EINA_FALSE means that the user will not handle the popup
14305 * and the default implementation will be used.
14307 * When the popup is ready to be dismissed, a "popup,willdelete" signal
14308 * will be emitted to notify the user that it can destroy any objects and
14309 * free all data related to it.
14311 * @see elm_web_popup_selected_set()
14312 * @see elm_web_popup_destroy()
14314 struct _Elm_Web_Menu
14316 Eina_List *items; /**< List of #Elm_Web_Menu_Item */
14317 int x; /**< The X position of the popup, relative to the elm_web object */
14318 int y; /**< The Y position of the popup, relative to the elm_web object */
14319 int width; /**< Width of the popup menu */
14320 int height; /**< Height of the popup menu */
14322 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. */
14325 typedef struct _Elm_Web_Download Elm_Web_Download;
14326 struct _Elm_Web_Download
14332 * Types of zoom available.
14334 typedef enum _Elm_Web_Zoom_Mode
14336 ELM_WEB_ZOOM_MODE_MANUAL = 0, /**< Zoom controlled normally by elm_web_zoom_set */
14337 ELM_WEB_ZOOM_MODE_AUTO_FIT, /**< Zoom until content fits in web object */
14338 ELM_WEB_ZOOM_MODE_AUTO_FILL, /**< Zoom until content fills web object */
14339 ELM_WEB_ZOOM_MODE_LAST
14340 } Elm_Web_Zoom_Mode;
14343 * Opaque handler containing the features (such as statusbar, menubar, etc)
14344 * that are to be set on a newly requested window.
14346 typedef struct _Elm_Web_Window_Features Elm_Web_Window_Features;
14349 * Callback type for the create_window hook.
14351 * The function parameters are:
14352 * @li @p data User data pointer set when setting the hook function
14353 * @li @p obj The elm_web object requesting the new window
14354 * @li @p js Set to @c EINA_TRUE if the request was originated from
14355 * JavaScript. @c EINA_FALSE otherwise.
14356 * @li @p window_features A pointer of #Elm_Web_Window_Features indicating
14357 * the features requested for the new window.
14359 * The returned value of the function should be the @c elm_web widget where
14360 * the request will be loaded. That is, if a new window or tab is created,
14361 * the elm_web widget in it should be returned, and @b NOT the window
14363 * Returning @c NULL should cancel the request.
14365 * @see elm_web_window_create_hook_set()
14367 typedef Evas_Object *(*Elm_Web_Window_Open)(void *data, Evas_Object *obj, Eina_Bool js, const Elm_Web_Window_Features *window_features);
14370 * Callback type for the JS alert hook.
14372 * The function parameters are:
14373 * @li @p data User data pointer set when setting the hook function
14374 * @li @p obj The elm_web object requesting the new window
14375 * @li @p message The message to show in the alert dialog
14377 * The function should return the object representing the alert dialog.
14378 * Elm_Web will run a second main loop to handle the dialog and normal
14379 * flow of the application will be restored when the object is deleted, so
14380 * the user should handle the popup properly in order to delete the object
14381 * when the action is finished.
14382 * If the function returns @c NULL the popup will be ignored.
14384 * @see elm_web_dialog_alert_hook_set()
14386 typedef Evas_Object *(*Elm_Web_Dialog_Alert)(void *data, Evas_Object *obj, const char *message);
14389 * Callback type for the JS confirm hook.
14391 * The function parameters are:
14392 * @li @p data User data pointer set when setting the hook function
14393 * @li @p obj The elm_web object requesting the new window
14394 * @li @p message The message to show in the confirm dialog
14395 * @li @p ret Pointer where to store the user selection. @c EINA_TRUE if
14396 * the user selected @c Ok, @c EINA_FALSE otherwise.
14398 * The function should return the object representing the confirm dialog.
14399 * Elm_Web will run a second main loop to handle the dialog and normal
14400 * flow of the application will be restored when the object is deleted, so
14401 * the user should handle the popup properly in order to delete the object
14402 * when the action is finished.
14403 * If the function returns @c NULL the popup will be ignored.
14405 * @see elm_web_dialog_confirm_hook_set()
14407 typedef Evas_Object *(*Elm_Web_Dialog_Confirm)(void *data, Evas_Object *obj, const char *message, Eina_Bool *ret);
14410 * Callback type for the JS prompt hook.
14412 * The function parameters are:
14413 * @li @p data User data pointer set when setting the hook function
14414 * @li @p obj The elm_web object requesting the new window
14415 * @li @p message The message to show in the prompt dialog
14416 * @li @p def_value The default value to present the user in the entry
14417 * @li @p value Pointer where to store the value given by the user. Must
14418 * be a malloc'ed string or @c NULL if the user cancelled the popup.
14419 * @li @p ret Pointer where to store the user selection. @c EINA_TRUE if
14420 * the user selected @c Ok, @c EINA_FALSE otherwise.
14422 * The function should return the object representing the prompt dialog.
14423 * Elm_Web will run a second main loop to handle the dialog and normal
14424 * flow of the application will be restored when the object is deleted, so
14425 * the user should handle the popup properly in order to delete the object
14426 * when the action is finished.
14427 * If the function returns @c NULL the popup will be ignored.
14429 * @see elm_web_dialog_prompt_hook_set()
14431 typedef Evas_Object *(*Elm_Web_Dialog_Prompt)(void *data, Evas_Object *obj, const char *message, const char *def_value, char **value, Eina_Bool *ret);
14434 * Callback type for the JS file selector hook.
14436 * The function parameters are:
14437 * @li @p data User data pointer set when setting the hook function
14438 * @li @p obj The elm_web object requesting the new window
14439 * @li @p allows_multiple @c EINA_TRUE if multiple files can be selected.
14440 * @li @p accept_types Mime types accepted
14441 * @li @p selected Pointer where to store the list of malloc'ed strings
14442 * containing the path to each file selected. Must be @c NULL if the file
14443 * dialog is cancelled
14444 * @li @p ret Pointer where to store the user selection. @c EINA_TRUE if
14445 * the user selected @c Ok, @c EINA_FALSE otherwise.
14447 * The function should return the object representing the file selector
14449 * Elm_Web will run a second main loop to handle the dialog and normal
14450 * flow of the application will be restored when the object is deleted, so
14451 * the user should handle the popup properly in order to delete the object
14452 * when the action is finished.
14453 * If the function returns @c NULL the popup will be ignored.
14455 * @see elm_web_dialog_file selector_hook_set()
14457 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);
14460 * Callback type for the JS console message hook.
14462 * When a console message is added from JavaScript, any set function to the
14463 * console message hook will be called for the user to handle. There is no
14464 * default implementation of this hook.
14466 * The function parameters are:
14467 * @li @p data User data pointer set when setting the hook function
14468 * @li @p obj The elm_web object that originated the message
14469 * @li @p message The message sent
14470 * @li @p line_number The line number
14471 * @li @p source_id Source id
14473 * @see elm_web_console_message_hook_set()
14475 typedef void (*Elm_Web_Console_Message)(void *data, Evas_Object *obj, const char *message, unsigned int line_number, const char *source_id);
14478 * Add a new web object to the parent.
14480 * @param parent The parent object.
14481 * @return The new object or NULL if it cannot be created.
14483 * @see elm_web_uri_set()
14484 * @see elm_web_webkit_view_get()
14486 EAPI Evas_Object *elm_web_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
14489 * Get internal ewk_view object from web object.
14491 * Elementary may not provide some low level features of EWebKit,
14492 * instead of cluttering the API with proxy methods we opted to
14493 * return the internal reference. Be careful using it as it may
14494 * interfere with elm_web behavior.
14496 * @param obj The web object.
14497 * @return The internal ewk_view object or NULL if it does not
14498 * exist. (Failure to create or Elementary compiled without
14501 * @see elm_web_add()
14503 EAPI Evas_Object *elm_web_webkit_view_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14506 * Sets the function to call when a new window is requested
14508 * This hook will be called when a request to create a new window is
14509 * issued from the web page loaded.
14510 * There is no default implementation for this feature, so leaving this
14511 * unset or passing @c NULL in @p func will prevent new windows from
14514 * @param obj The web object where to set the hook function
14515 * @param func The hook function to be called when a window is requested
14516 * @param data User data
14518 EAPI void elm_web_window_create_hook_set(Evas_Object *obj, Elm_Web_Window_Open func, void *data);
14521 * Sets the function to call when an alert dialog
14523 * This hook will be called when a JavaScript alert dialog is requested.
14524 * If no function is set or @c NULL is passed in @p func, the default
14525 * implementation will take place.
14527 * @param obj The web object where to set the hook function
14528 * @param func The callback function to be used
14529 * @param data User data
14531 * @see elm_web_inwin_mode_set()
14533 EAPI void elm_web_dialog_alert_hook_set(Evas_Object *obj, Elm_Web_Dialog_Alert func, void *data);
14536 * Sets the function to call when an confirm dialog
14538 * This hook will be called when a JavaScript confirm dialog is requested.
14539 * If no function is set or @c NULL is passed in @p func, the default
14540 * implementation will take place.
14542 * @param obj The web object where to set the hook function
14543 * @param func The callback function to be used
14544 * @param data User data
14546 * @see elm_web_inwin_mode_set()
14548 EAPI void elm_web_dialog_confirm_hook_set(Evas_Object *obj, Elm_Web_Dialog_Confirm func, void *data);
14551 * Sets the function to call when an prompt dialog
14553 * This hook will be called when a JavaScript prompt dialog is requested.
14554 * If no function is set or @c NULL is passed in @p func, the default
14555 * implementation will take place.
14557 * @param obj The web object where to set the hook function
14558 * @param func The callback function to be used
14559 * @param data User data
14561 * @see elm_web_inwin_mode_set()
14563 EAPI void elm_web_dialog_prompt_hook_set(Evas_Object *obj, Elm_Web_Dialog_Prompt func, void *data);
14566 * Sets the function to call when an file selector dialog
14568 * This hook will be called when a JavaScript file selector dialog is
14570 * If no function is set or @c NULL is passed in @p func, the default
14571 * implementation will take place.
14573 * @param obj The web object where to set the hook function
14574 * @param func The callback function to be used
14575 * @param data User data
14577 * @see elm_web_inwin_mode_set()
14579 EAPI void elm_web_dialog_file_selector_hook_set(Evas_Object *obj, Elm_Web_Dialog_File_Selector func, void *data);
14582 * Sets the function to call when a console message is emitted from JS
14584 * This hook will be called when a console message is emitted from
14585 * JavaScript. There is no default implementation for this feature.
14587 * @param obj The web object where to set the hook function
14588 * @param func The callback function to be used
14589 * @param data User data
14591 EAPI void elm_web_console_message_hook_set(Evas_Object *obj, Elm_Web_Console_Message func, void *data);
14594 * Gets the status of the tab propagation
14596 * @param obj The web object to query
14597 * @return EINA_TRUE if tab propagation is enabled, EINA_FALSE otherwise
14599 * @see elm_web_tab_propagate_set()
14601 EAPI Eina_Bool elm_web_tab_propagate_get(const Evas_Object *obj);
14604 * Sets whether to use tab propagation
14606 * If tab propagation is enabled, whenever the user presses the Tab key,
14607 * Elementary will handle it and switch focus to the next widget.
14608 * The default value is disabled, where WebKit will handle the Tab key to
14609 * cycle focus though its internal objects, jumping to the next widget
14610 * only when that cycle ends.
14612 * @param obj The web object
14613 * @param propagate Whether to propagate Tab keys to Elementary or not
14615 EAPI void elm_web_tab_propagate_set(Evas_Object *obj, Eina_Bool propagate);
14618 * Sets the URI for the web object
14620 * It must be a full URI, with resource included, in the form
14621 * http://www.enlightenment.org or file:///tmp/something.html
14623 * @param obj The web object
14624 * @param uri The URI to set
14625 * @return EINA_TRUE if the URI could be, EINA_FALSE if an error occurred
14627 EAPI Eina_Bool elm_web_uri_set(Evas_Object *obj, const char *uri);
14630 * Gets the current URI for the object
14632 * The returned string must not be freed and is guaranteed to be
14635 * @param obj The web object
14636 * @return A stringshared internal string with the current URI, or NULL on
14639 EAPI const char *elm_web_uri_get(const Evas_Object *obj);
14642 * Gets the current title
14644 * The returned string must not be freed and is guaranteed to be
14647 * @param obj The web object
14648 * @return A stringshared internal string with the current title, or NULL on
14651 EAPI const char *elm_web_title_get(const Evas_Object *obj);
14654 * Sets the background color to be used by the web object
14656 * This is the color that will be used by default when the loaded page
14657 * does not set it's own. Color values are pre-multiplied.
14659 * @param obj The web object
14660 * @param r Red component
14661 * @param g Green component
14662 * @param b Blue component
14663 * @param a Alpha component
14665 EAPI void elm_web_bg_color_set(Evas_Object *obj, int r, int g, int b, int a);
14668 * Gets the background color to be used by the web object
14670 * This is the color that will be used by default when the loaded page
14671 * does not set it's own. Color values are pre-multiplied.
14673 * @param obj The web object
14674 * @param r Red component
14675 * @param g Green component
14676 * @param b Blue component
14677 * @param a Alpha component
14679 EAPI void elm_web_bg_color_get(const Evas_Object *obj, int *r, int *g, int *b, int *a);
14682 * Gets a copy of the currently selected text
14684 * The string returned must be freed by the user when it's done with it.
14686 * @param obj The web object
14687 * @return A newly allocated string, or NULL if nothing is selected or an
14690 EAPI char *elm_view_selection_get(const Evas_Object *obj);
14693 * Tells the web object which index in the currently open popup was selected
14695 * When the user handles the popup creation from the "popup,created" signal,
14696 * it needs to tell the web object which item was selected by calling this
14697 * function with the index corresponding to the item.
14699 * @param obj The web object
14700 * @param index The index selected
14702 * @see elm_web_popup_destroy()
14704 EAPI void elm_web_popup_selected_set(Evas_Object *obj, int index);
14707 * Dismisses an open dropdown popup
14709 * When the popup from a dropdown widget is to be dismissed, either after
14710 * selecting an option or to cancel it, this function must be called, which
14711 * will later emit an "popup,willdelete" signal to notify the user that
14712 * any memory and objects related to this popup can be freed.
14714 * @param obj The web object
14715 * @return EINA_TRUE if the menu was successfully destroyed, or EINA_FALSE
14716 * if there was no menu to destroy
14718 EAPI Eina_Bool elm_web_popup_destroy(Evas_Object *obj);
14721 * Searches the given string in a document.
14723 * @param obj The web object where to search the text
14724 * @param string String to search
14725 * @param case_sensitive If search should be case sensitive or not
14726 * @param forward If search is from cursor and on or backwards
14727 * @param wrap If search should wrap at the end
14729 * @return @c EINA_TRUE if the given string was found, @c EINA_FALSE if not
14732 EAPI Eina_Bool elm_web_text_search(const Evas_Object *obj, const char *string, Eina_Bool case_sensitive, Eina_Bool forward, Eina_Bool wrap);
14735 * Marks matches of the given string in a document.
14737 * @param obj The web object where to search text
14738 * @param string String to match
14739 * @param case_sensitive If match should be case sensitive or not
14740 * @param highlight If matches should be highlighted
14741 * @param limit Maximum amount of matches, or zero to unlimited
14743 * @return number of matched @a string
14745 EAPI unsigned int elm_web_text_matches_mark(Evas_Object *obj, const char *string, Eina_Bool case_sensitive, Eina_Bool highlight, unsigned int limit);
14748 * Clears all marked matches in the document
14750 * @param obj The web object
14752 * @return EINA_TRUE on success, EINA_FALSE otherwise
14754 EAPI Eina_Bool elm_web_text_matches_unmark_all(Evas_Object *obj);
14757 * Sets whether to highlight the matched marks
14759 * If enabled, marks set with elm_web_text_matches_mark() will be
14762 * @param obj The web object
14763 * @param highlight Whether to highlight the marks or not
14765 * @return EINA_TRUE on success, EINA_FALSE otherwise
14767 EAPI Eina_Bool elm_web_text_matches_highlight_set(Evas_Object *obj, Eina_Bool highlight);
14770 * Gets whether highlighting marks is enabled
14772 * @param The web object
14774 * @return EINA_TRUE is marks are set to be highlighted, EINA_FALSE
14777 EAPI Eina_Bool elm_web_text_matches_highlight_get(const Evas_Object *obj);
14780 * Gets the overall loading progress of the page
14782 * Returns the estimated loading progress of the page, with a value between
14783 * 0.0 and 1.0. This is an estimated progress accounting for all the frames
14784 * included in the page.
14786 * @param The web object
14788 * @return A value between 0.0 and 1.0 indicating the progress, or -1.0 on
14791 EAPI double elm_web_load_progress_get(const Evas_Object *obj);
14794 * Stops loading the current page
14796 * Cancels the loading of the current page in the web object. This will
14797 * cause a "load,error" signal to be emitted, with the is_cancellation
14798 * flag set to EINA_TRUE.
14800 * @param obj The web object
14802 * @return EINA_TRUE if the cancel was successful, EINA_FALSE otherwise
14804 EAPI Eina_Bool elm_web_stop(Evas_Object *obj);
14807 * Requests a reload of the current document in the object
14809 * @param obj The web object
14811 * @return EINA_TRUE on success, EINA_FALSE otherwise
14813 EAPI Eina_Bool elm_web_reload(Evas_Object *obj);
14816 * Requests a reload of the current document, avoiding any existing caches
14818 * @param obj The web object
14820 * @return EINA_TRUE on success, EINA_FALSE otherwise
14822 EAPI Eina_Bool elm_web_reload_full(Evas_Object *obj);
14825 * Goes back one step in the browsing history
14827 * This is equivalent to calling elm_web_object_navigate(obj, -1);
14829 * @param obj The web object
14831 * @return EINA_TRUE on success, EINA_FALSE otherwise
14833 * @see elm_web_history_enable_set()
14834 * @see elm_web_back_possible()
14835 * @see elm_web_forward()
14836 * @see elm_web_navigate()
14838 EAPI Eina_Bool elm_web_back(Evas_Object *obj);
14841 * Goes forward one step in the browsing history
14843 * This is equivalent to calling elm_web_object_navigate(obj, 1);
14845 * @param obj The web object
14847 * @return EINA_TRUE on success, EINA_FALSE otherwise
14849 * @see elm_web_history_enable_set()
14850 * @see elm_web_forward_possible()
14851 * @see elm_web_back()
14852 * @see elm_web_navigate()
14854 EAPI Eina_Bool elm_web_forward(Evas_Object *obj);
14857 * Jumps the given number of steps in the browsing history
14859 * The @p steps value can be a negative integer to back in history, or a
14860 * positive to move forward.
14862 * @param obj The web object
14863 * @param steps The number of steps to jump
14865 * @return EINA_TRUE on success, EINA_FALSE on error or if not enough
14866 * history exists to jump the given number of steps
14868 * @see elm_web_history_enable_set()
14869 * @see elm_web_navigate_possible()
14870 * @see elm_web_back()
14871 * @see elm_web_forward()
14873 EAPI Eina_Bool elm_web_navigate(Evas_Object *obj, int steps);
14876 * Queries whether it's possible to go back in history
14878 * @param obj The web object
14880 * @return EINA_TRUE if it's possible to back in history, EINA_FALSE
14883 EAPI Eina_Bool elm_web_back_possible(Evas_Object *obj);
14886 * Queries whether it's possible to go forward in history
14888 * @param obj The web object
14890 * @return EINA_TRUE if it's possible to forward in history, EINA_FALSE
14893 EAPI Eina_Bool elm_web_forward_possible(Evas_Object *obj);
14896 * Queries whether it's possible to jump the given number of steps
14898 * The @p steps value can be a negative integer to back in history, or a
14899 * positive to move forward.
14901 * @param obj The web object
14902 * @param steps The number of steps to check for
14904 * @return EINA_TRUE if enough history exists to perform the given jump,
14905 * EINA_FALSE otherwise
14907 EAPI Eina_Bool elm_web_navigate_possible(Evas_Object *obj, int steps);
14910 * Gets whether browsing history is enabled for the given object
14912 * @param obj The web object
14914 * @return EINA_TRUE if history is enabled, EINA_FALSE otherwise
14916 EAPI Eina_Bool elm_web_history_enable_get(const Evas_Object *obj);
14919 * Enables or disables the browsing history
14921 * @param obj The web object
14922 * @param enable Whether to enable or disable the browsing history
14924 EAPI void elm_web_history_enable_set(Evas_Object *obj, Eina_Bool enable);
14927 * Sets the zoom level of the web object
14929 * Zoom level matches the Webkit API, so 1.0 means normal zoom, with higher
14930 * values meaning zoom in and lower meaning zoom out. This function will
14931 * only affect the zoom level if the mode set with elm_web_zoom_mode_set()
14932 * is ::ELM_WEB_ZOOM_MODE_MANUAL.
14934 * @param obj The web object
14935 * @param zoom The zoom level to set
14937 EAPI void elm_web_zoom_set(Evas_Object *obj, double zoom);
14940 * Gets the current zoom level set on the web object
14942 * Note that this is the zoom level set on the web object and not that
14943 * of the underlying Webkit one. In the ::ELM_WEB_ZOOM_MODE_MANUAL mode,
14944 * the two zoom levels should match, but for the other two modes the
14945 * Webkit zoom is calculated internally to match the chosen mode without
14946 * changing the zoom level set for the web object.
14948 * @param obj The web object
14950 * @return The zoom level set on the object
14952 EAPI double elm_web_zoom_get(const Evas_Object *obj);
14955 * Sets the zoom mode to use
14957 * The modes can be any of those defined in ::Elm_Web_Zoom_Mode, except
14958 * ::ELM_WEB_ZOOM_MODE_LAST. The default is ::ELM_WEB_ZOOM_MODE_MANUAL.
14960 * ::ELM_WEB_ZOOM_MODE_MANUAL means the zoom level will be controlled
14961 * with the elm_web_zoom_set() function.
14962 * ::ELM_WEB_ZOOM_MODE_AUTO_FIT will calculate the needed zoom level to
14963 * make sure the entirety of the web object's contents are shown.
14964 * ::ELM_WEB_ZOOM_MODE_AUTO_FILL will calculate the needed zoom level to
14965 * fit the contents in the web object's size, without leaving any space
14968 * @param obj The web object
14969 * @param mode The mode to set
14971 EAPI void elm_web_zoom_mode_set(Evas_Object *obj, Elm_Web_Zoom_Mode mode);
14974 * Gets the currently set zoom mode
14976 * @param obj The web object
14978 * @return The current zoom mode set for the object, or
14979 * ::ELM_WEB_ZOOM_MODE_LAST on error
14981 EAPI Elm_Web_Zoom_Mode elm_web_zoom_mode_get(const Evas_Object *obj);
14984 * Shows the given region in the web object
14986 * @param obj The web object
14987 * @param x The x coordinate of the region to show
14988 * @param y The y coordinate of the region to show
14989 * @param w The width of the region to show
14990 * @param h The height of the region to show
14992 EAPI void elm_web_region_show(Evas_Object *obj, int x, int y, int w, int h);
14995 * Brings in the region to the visible area
14997 * Like elm_web_region_show(), but it animates the scrolling of the object
15000 * @param obj The web object
15001 * @param x The x coordinate of the region to show
15002 * @param y The y coordinate of the region to show
15003 * @param w The width of the region to show
15004 * @param h The height of the region to show
15006 EAPI void elm_web_region_bring_in(Evas_Object *obj, int x, int y, int w, int h);
15009 * Sets the default dialogs to use an Inwin instead of a normal window
15011 * If set, then the default implementation for the JavaScript dialogs and
15012 * file selector will be opened in an Inwin. Otherwise they will use a
15013 * normal separated window.
15015 * @param obj The web object
15016 * @param value EINA_TRUE to use Inwin, EINA_FALSE to use a normal window
15018 EAPI void elm_web_inwin_mode_set(Evas_Object *obj, Eina_Bool value);
15021 * Gets whether Inwin mode is set for the current object
15023 * @param obj The web object
15025 * @return EINA_TRUE if Inwin mode is set, EINA_FALSE otherwise
15027 EAPI Eina_Bool elm_web_inwin_mode_get(const Evas_Object *obj);
15029 EAPI void elm_web_window_features_ref(Elm_Web_Window_Features *wf);
15030 EAPI void elm_web_window_features_unref(Elm_Web_Window_Features *wf);
15031 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);
15032 EAPI void elm_web_window_features_int_property_get(const Elm_Web_Window_Features *wf, int *x, int *y, int *w, int *h);
15039 * @defgroup Hoversel Hoversel
15041 * @image html img/widget/hoversel/preview-00.png
15042 * @image latex img/widget/hoversel/preview-00.eps
15044 * A hoversel is a button that pops up a list of items (automatically
15045 * choosing the direction to display) that have a label and, optionally, an
15046 * icon to select from. It is a convenience widget to avoid the need to do
15047 * all the piecing together yourself. It is intended for a small number of
15048 * items in the hoversel menu (no more than 8), though is capable of many
15051 * Signals that you can add callbacks for are:
15052 * "clicked" - the user clicked the hoversel button and popped up the sel
15053 * "selected" - an item in the hoversel list is selected. event_info is the item
15054 * "dismissed" - the hover is dismissed
15056 * Default contents parts of the hoversel widget that you can use for are:
15057 * @li "icon" - An icon of the hoversel
15059 * Default text parts of the hoversel widget that you can use for are:
15060 * @li "default" - Label of the hoversel
15062 * Supported elm_object common APIs.
15063 * @li elm_object_disabled_set
15064 * @li elm_object_text_set
15065 * @li elm_object_part_text_set
15066 * @li elm_object_text_get
15067 * @li elm_object_part_text_get
15068 * @li elm_object_content_set
15069 * @li elm_object_part_content_set
15070 * @li elm_object_content_unset
15071 * @li elm_object_part_content_unset
15073 * Supported elm_object_item common APIs.
15074 * @li elm_object_item_text_get
15075 * @li elm_object_item_part_text_get
15077 * See @ref tutorial_hoversel for an example.
15082 * @brief Add a new Hoversel object
15084 * @param parent The parent object
15085 * @return The new object or NULL if it cannot be created
15087 EAPI Evas_Object *elm_hoversel_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
15090 * @brief This sets the hoversel to expand horizontally.
15092 * @param obj The hoversel object
15093 * @param horizontal If true, the hover will expand horizontally to the
15096 * @note The initial button will display horizontally regardless of this
15099 EAPI void elm_hoversel_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
15102 * @brief This returns whether the hoversel is set to expand horizontally.
15104 * @param obj The hoversel object
15105 * @return If true, the hover will expand horizontally to the right.
15107 * @see elm_hoversel_horizontal_set()
15109 EAPI Eina_Bool elm_hoversel_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15112 * @brief Set the Hover parent
15114 * @param obj The hoversel object
15115 * @param parent The parent to use
15117 * Sets the hover parent object, the area that will be darkened when the
15118 * hoversel is clicked. Should probably be the window that the hoversel is
15119 * in. See @ref Hover objects for more information.
15121 EAPI void elm_hoversel_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
15123 * @brief Get the Hover parent
15125 * @param obj The hoversel object
15126 * @return The used parent
15128 * Gets the hover parent object.
15130 * @see elm_hoversel_hover_parent_set()
15132 EAPI Evas_Object *elm_hoversel_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15135 * @brief Set the hoversel button label
15137 * @param obj The hoversel object
15138 * @param label The label text.
15140 * This sets the label of the button that is always visible (before it is
15141 * clicked and expanded).
15143 * @deprecated elm_object_text_set()
15145 EINA_DEPRECATED EAPI void elm_hoversel_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
15148 * @brief Get the hoversel button label
15150 * @param obj The hoversel object
15151 * @return The label text.
15153 * @deprecated elm_object_text_get()
15155 EINA_DEPRECATED EAPI const char *elm_hoversel_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15158 * @brief Set the icon of the hoversel button
15160 * @param obj The hoversel object
15161 * @param icon The icon object
15163 * Sets the icon of the button that is always visible (before it is clicked
15164 * and expanded). Once the icon object is set, a previously set one will be
15165 * deleted, if you want to keep that old content object, use the
15166 * elm_hoversel_icon_unset() function.
15168 * @see elm_object_content_set() for the button widget
15169 * @deprecated Use elm_object_item_part_content_set() instead
15171 EINA_DEPRECATED EAPI void elm_hoversel_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
15174 * @brief Get the icon of the hoversel button
15176 * @param obj The hoversel object
15177 * @return The icon object
15179 * Get the icon of the button that is always visible (before it is clicked
15180 * and expanded). Also see elm_object_content_get() for the button widget.
15182 * @see elm_hoversel_icon_set()
15183 * @deprecated Use elm_object_item_part_content_get() instead
15185 EINA_DEPRECATED EAPI Evas_Object *elm_hoversel_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15188 * @brief Get and unparent the icon of the hoversel button
15190 * @param obj The hoversel object
15191 * @return The icon object that was being used
15193 * Unparent and return the icon of the button that is always visible
15194 * (before it is clicked and expanded).
15196 * @see elm_hoversel_icon_set()
15197 * @see elm_object_content_unset() for the button widget
15198 * @deprecated Use elm_object_item_part_content_unset() instead
15200 EINA_DEPRECATED EAPI Evas_Object *elm_hoversel_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
15203 * @brief This triggers the hoversel popup from code, the same as if the user
15204 * had clicked the button.
15206 * @param obj The hoversel object
15208 EAPI void elm_hoversel_hover_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
15211 * @brief This dismisses the hoversel popup as if the user had clicked
15212 * outside the hover.
15214 * @param obj The hoversel object
15216 EAPI void elm_hoversel_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
15219 * @brief Returns whether the hoversel is expanded.
15221 * @param obj The hoversel object
15222 * @return This will return EINA_TRUE if the hoversel is expanded or
15223 * EINA_FALSE if it is not expanded.
15225 EAPI Eina_Bool elm_hoversel_expanded_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15228 * @brief This will remove all the children items from the hoversel.
15230 * @param obj The hoversel object
15232 * @warning Should @b not be called while the hoversel is active; use
15233 * elm_hoversel_expanded_get() to check first.
15235 * @see elm_hoversel_item_del_cb_set()
15236 * @see elm_hoversel_item_del()
15238 EAPI void elm_hoversel_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
15241 * @brief Get the list of items within the given hoversel.
15243 * @param obj The hoversel object
15244 * @return Returns a list of Elm_Object_Item*
15246 * @see elm_hoversel_item_add()
15248 EAPI const Eina_List *elm_hoversel_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15251 * @brief Add an item to the hoversel button
15253 * @param obj The hoversel object
15254 * @param label The text label to use for the item (NULL if not desired)
15255 * @param icon_file An image file path on disk to use for the icon or standard
15256 * icon name (NULL if not desired)
15257 * @param icon_type The icon type if relevant
15258 * @param func Convenience function to call when this item is selected
15259 * @param data Data to pass to item-related functions
15260 * @return A handle to the item added.
15262 * This adds an item to the hoversel to show when it is clicked. Note: if you
15263 * need to use an icon from an edje file then use
15264 * elm_hoversel_item_icon_set() right after the this function, and set
15265 * icon_file to NULL here.
15267 * For more information on what @p icon_file and @p icon_type are see the
15268 * @ref Icon "icon documentation".
15270 EAPI Elm_Object_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);
15273 * @brief Delete an item from the hoversel
15275 * @param it The item to delete
15277 * This deletes the item from the hoversel (should not be called while the
15278 * hoversel is active; use elm_hoversel_expanded_get() to check first).
15280 * @see elm_hoversel_item_add()
15281 * @see elm_hoversel_item_del_cb_set()
15283 EAPI void elm_hoversel_item_del(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
15286 * @brief Set the function to be called when an item from the hoversel is
15289 * @param item The item to set the callback on
15290 * @param func The function called
15292 * That function will receive these parameters:
15293 * @li void * item data
15294 * @li Evas_Object * hoversel object
15295 * @li Elm_Object_Item * hoversel item
15297 * @see elm_hoversel_item_add()
15299 EAPI void elm_hoversel_item_del_cb_set(Elm_Object_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
15302 * @brief This returns the data pointer supplied with elm_hoversel_item_add()
15303 * that will be passed to associated function callbacks.
15305 * @param it The item to get the data from
15306 * @return The data pointer set with elm_hoversel_item_add()
15308 * @see elm_hoversel_item_add()
15309 * @deprecated Use elm_object_item_data_get() instead
15311 EINA_DEPRECATED EAPI void *elm_hoversel_item_data_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
15314 * @brief This returns the label text of the given hoversel item.
15316 * @param it The item to get the label
15317 * @return The label text of the hoversel item
15319 * @see elm_hoversel_item_add()
15320 * @deprecated Use elm_object_item_text_get() instead
15322 EINA_DEPRECATED EAPI const char *elm_hoversel_item_label_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
15325 * @brief This sets the icon for the given hoversel item.
15327 * @param item The item to set the icon
15328 * @param icon_file An image file path on disk to use for the icon or standard
15330 * @param icon_group The edje group to use if @p icon_file is an edje file. Set this
15331 * to NULL if the icon is not an edje file
15332 * @param icon_type The icon type
15334 * The icon can be loaded from the standard set, from an image file, or from
15337 * @see elm_hoversel_item_add()
15339 EAPI void elm_hoversel_item_icon_set(Elm_Object_Item *it, const char *icon_file, const char *icon_group, Elm_Icon_Type icon_type) EINA_ARG_NONNULL(1);
15342 * @brief Get the icon object of the hoversel item
15344 * @param item The item to get the icon from
15345 * @param icon_file The image file path on disk used for the icon or standard
15347 * @param icon_group The edje group used if @p icon_file is an edje file. NULL
15348 * if the icon is not an edje file
15349 * @param icon_type The icon type
15351 * @see elm_hoversel_item_icon_set()
15352 * @see elm_hoversel_item_add()
15354 EAPI void elm_hoversel_item_icon_get(const Elm_Object_Item *it, const char **icon_file, const char **icon_group, Elm_Icon_Type *icon_type) EINA_ARG_NONNULL(1);
15361 * @defgroup Toolbar Toolbar
15362 * @ingroup Elementary
15364 * @image html img/widget/toolbar/preview-00.png
15365 * @image latex img/widget/toolbar/preview-00.eps width=\textwidth
15367 * @image html img/toolbar.png
15368 * @image latex img/toolbar.eps width=\textwidth
15370 * A toolbar is a widget that displays a list of items inside
15371 * a box. It can be scrollable, show a menu with items that don't fit
15372 * to toolbar size or even crop them.
15374 * Only one item can be selected at a time.
15376 * Items can have multiple states, or show menus when selected by the user.
15378 * Smart callbacks one can listen to:
15379 * - "clicked" - when the user clicks on a toolbar item and becomes selected.
15380 * - "language,changed" - when the program language changes
15382 * Available styles for it:
15384 * - @c "transparent" - no background or shadow, just show the content
15386 * Default text parts of the toolbar items that you can use for are:
15387 * @li "default" - label of the toolbar item
15389 * Supported elm_object_item common APIs.
15390 * @li elm_object_item_disabled_set
15391 * @li elm_object_item_text_set
15392 * @li elm_object_item_part_text_set
15393 * @li elm_object_item_text_get
15394 * @li elm_object_item_part_text_get
15396 * List of examples:
15397 * @li @ref toolbar_example_01
15398 * @li @ref toolbar_example_02
15399 * @li @ref toolbar_example_03
15403 * @addtogroup Toolbar
15408 * @enum _Elm_Toolbar_Shrink_Mode
15409 * @typedef Elm_Toolbar_Shrink_Mode
15411 * Set toolbar's items display behavior, it can be scrollabel,
15412 * show a menu with exceeding items, or simply hide them.
15414 * @note Default value is #ELM_TOOLBAR_SHRINK_MENU. It reads value
15417 * Values <b> don't </b> work as bitmask, only one can be choosen.
15419 * @see elm_toolbar_mode_shrink_set()
15420 * @see elm_toolbar_mode_shrink_get()
15424 typedef enum _Elm_Toolbar_Shrink_Mode
15426 ELM_TOOLBAR_SHRINK_NONE, /**< Set toolbar minimun size to fit all the items. */
15427 ELM_TOOLBAR_SHRINK_HIDE, /**< Hide exceeding items. */
15428 ELM_TOOLBAR_SHRINK_SCROLL, /**< Allow accessing exceeding items through a scroller. */
15429 ELM_TOOLBAR_SHRINK_MENU, /**< Inserts a button to pop up a menu with exceeding items. */
15430 ELM_TOOLBAR_SHRINK_LAST /**< Indicates error if returned by elm_toolbar_shrink_mode_get() */
15431 } Elm_Toolbar_Shrink_Mode;
15433 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(). */
15436 * Add a new toolbar widget to the given parent Elementary
15437 * (container) object.
15439 * @param parent The parent object.
15440 * @return a new toolbar widget handle or @c NULL, on errors.
15442 * This function inserts a new toolbar widget on the canvas.
15446 EAPI Evas_Object *elm_toolbar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
15449 * Set the icon size, in pixels, to be used by toolbar items.
15451 * @param obj The toolbar object
15452 * @param icon_size The icon size in pixels
15454 * @note Default value is @c 32. It reads value from elm config.
15456 * @see elm_toolbar_icon_size_get()
15460 EAPI void elm_toolbar_icon_size_set(Evas_Object *obj, int icon_size) EINA_ARG_NONNULL(1);
15463 * Get the icon size, in pixels, to be used by toolbar items.
15465 * @param obj The toolbar object.
15466 * @return The icon size in pixels.
15468 * @see elm_toolbar_icon_size_set() for details.
15472 EAPI int elm_toolbar_icon_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15475 * Sets icon lookup order, for toolbar items' icons.
15477 * @param obj The toolbar object.
15478 * @param order The icon lookup order.
15480 * Icons added before calling this function will not be affected.
15481 * The default lookup order is #ELM_ICON_LOOKUP_THEME_FDO.
15483 * @see elm_toolbar_icon_order_lookup_get()
15487 EAPI void elm_toolbar_icon_order_lookup_set(Evas_Object *obj, Elm_Icon_Lookup_Order order) EINA_ARG_NONNULL(1);
15490 * Gets the icon lookup order.
15492 * @param obj The toolbar object.
15493 * @return The icon lookup order.
15495 * @see elm_toolbar_icon_order_lookup_set() for details.
15499 EAPI Elm_Icon_Lookup_Order elm_toolbar_icon_order_lookup_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15502 * Set whether the toolbar should always have an item selected.
15504 * @param obj The toolbar object.
15505 * @param wrap @c EINA_TRUE to enable always-select mode or @c EINA_FALSE to
15508 * This will cause the toolbar to always have an item selected, and clicking
15509 * the selected item will not cause a selected event to be emitted. Enabling this mode
15510 * will immediately select the first toolbar item.
15512 * Always-selected is disabled by default.
15514 * @see elm_toolbar_always_select_mode_get().
15518 EAPI void elm_toolbar_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
15521 * Get whether the toolbar should always have an item selected.
15523 * @param obj The toolbar object.
15524 * @return @c EINA_TRUE means an item will always be selected, @c EINA_FALSE indicates
15525 * that it is possible to have no items selected. If @p obj is @c NULL, @c EINA_FALSE is returned.
15527 * @see elm_toolbar_always_select_mode_set() for details.
15531 EAPI Eina_Bool elm_toolbar_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15534 * Set whether the toolbar items' should be selected by the user or not.
15536 * @param obj The toolbar object.
15537 * @param wrap @c EINA_TRUE to disable selection or @c EINA_FALSE to
15540 * This will turn off the ability to select items entirely and they will
15541 * neither appear selected nor emit selected signals. The clicked
15542 * callback function will still be called.
15544 * Selection is enabled by default.
15546 * @see elm_toolbar_no_select_mode_get().
15550 EAPI void elm_toolbar_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
15553 * Set whether the toolbar items' should be selected by the user or not.
15555 * @param obj The toolbar object.
15556 * @return @c EINA_TRUE means items can be selected. @c EINA_FALSE indicates
15557 * they can't. If @p obj is @c NULL, @c EINA_FALSE is returned.
15559 * @see elm_toolbar_no_select_mode_set() for details.
15563 EAPI Eina_Bool elm_toolbar_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15566 * Append item to the toolbar.
15568 * @param obj The toolbar object.
15569 * @param icon A string with icon name or the absolute path of an image file.
15570 * @param label The label of the item.
15571 * @param func The function to call when the item is clicked.
15572 * @param data The data to associate with the item for related callbacks.
15573 * @return The created item or @c NULL upon failure.
15575 * A new item will be created and appended to the toolbar, i.e., will
15576 * be set as @b last item.
15578 * Items created with this method can be deleted with
15579 * elm_toolbar_item_del().
15581 * Associated @p data can be properly freed when item is deleted if a
15582 * callback function is set with elm_toolbar_item_del_cb_set().
15584 * If a function is passed as argument, it will be called everytime this item
15585 * is selected, i.e., the user clicks over an unselected item.
15586 * If such function isn't needed, just passing
15587 * @c NULL as @p func is enough. The same should be done for @p data.
15589 * Toolbar will load icon image from fdo or current theme.
15590 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
15591 * If an absolute path is provided it will load it direct from a file.
15593 * @see elm_toolbar_item_icon_set()
15594 * @see elm_toolbar_item_del()
15595 * @see elm_toolbar_item_del_cb_set()
15599 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);
15602 * Prepend item to the toolbar.
15604 * @param obj The toolbar object.
15605 * @param icon A string with icon name or the absolute path of an image file.
15606 * @param label The label of the item.
15607 * @param func The function to call when the item is clicked.
15608 * @param data The data to associate with the item for related callbacks.
15609 * @return The created item or @c NULL upon failure.
15611 * A new item will be created and prepended to the toolbar, i.e., will
15612 * be set as @b first item.
15614 * Items created with this method can be deleted with
15615 * elm_toolbar_item_del().
15617 * Associated @p data can be properly freed when item is deleted if a
15618 * callback function is set with elm_toolbar_item_del_cb_set().
15620 * If a function is passed as argument, it will be called everytime this item
15621 * is selected, i.e., the user clicks over an unselected item.
15622 * If such function isn't needed, just passing
15623 * @c NULL as @p func is enough. The same should be done for @p data.
15625 * Toolbar will load icon image from fdo or current theme.
15626 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
15627 * If an absolute path is provided it will load it direct from a file.
15629 * @see elm_toolbar_item_icon_set()
15630 * @see elm_toolbar_item_del()
15631 * @see elm_toolbar_item_del_cb_set()
15635 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);
15638 * Insert a new item into the toolbar object before item @p before.
15640 * @param obj The toolbar object.
15641 * @param before The toolbar item to insert before.
15642 * @param icon A string with icon name or the absolute path of an image file.
15643 * @param label The label of the item.
15644 * @param func The function to call when the item is clicked.
15645 * @param data The data to associate with the item for related callbacks.
15646 * @return The created item or @c NULL upon failure.
15648 * A new item will be created and added to the toolbar. Its position in
15649 * this toolbar will be just before item @p before.
15651 * Items created with this method can be deleted with
15652 * elm_toolbar_item_del().
15654 * Associated @p data can be properly freed when item is deleted if a
15655 * callback function is set with elm_toolbar_item_del_cb_set().
15657 * If a function is passed as argument, it will be called everytime this item
15658 * is selected, i.e., the user clicks over an unselected item.
15659 * If such function isn't needed, just passing
15660 * @c NULL as @p func is enough. The same should be done for @p data.
15662 * Toolbar will load icon image from fdo or current theme.
15663 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
15664 * If an absolute path is provided it will load it direct from a file.
15666 * @see elm_toolbar_item_icon_set()
15667 * @see elm_toolbar_item_del()
15668 * @see elm_toolbar_item_del_cb_set()
15672 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);
15675 * Insert a new item into the toolbar object after item @p after.
15677 * @param obj The toolbar object.
15678 * @param after The toolbar item to insert after.
15679 * @param icon A string with icon name or the absolute path of an image file.
15680 * @param label The label of the item.
15681 * @param func The function to call when the item is clicked.
15682 * @param data The data to associate with the item for related callbacks.
15683 * @return The created item or @c NULL upon failure.
15685 * A new item will be created and added to the toolbar. Its position in
15686 * this toolbar will be just after item @p after.
15688 * Items created with this method can be deleted with
15689 * elm_toolbar_item_del().
15691 * Associated @p data can be properly freed when item is deleted if a
15692 * callback function is set with elm_toolbar_item_del_cb_set().
15694 * If a function is passed as argument, it will be called everytime this item
15695 * is selected, i.e., the user clicks over an unselected item.
15696 * If such function isn't needed, just passing
15697 * @c NULL as @p func is enough. The same should be done for @p data.
15699 * Toolbar will load icon image from fdo or current theme.
15700 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
15701 * If an absolute path is provided it will load it direct from a file.
15703 * @see elm_toolbar_item_icon_set()
15704 * @see elm_toolbar_item_del()
15705 * @see elm_toolbar_item_del_cb_set()
15709 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);
15712 * Get the first item in the given toolbar widget's list of
15715 * @param obj The toolbar object
15716 * @return The first item or @c NULL, if it has no items (and on
15719 * @see elm_toolbar_item_append()
15720 * @see elm_toolbar_last_item_get()
15724 EAPI Elm_Object_Item *elm_toolbar_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15727 * Get the last item in the given toolbar widget's list of
15730 * @param obj The toolbar object
15731 * @return The last item or @c NULL, if it has no items (and on
15734 * @see elm_toolbar_item_prepend()
15735 * @see elm_toolbar_first_item_get()
15739 EAPI Elm_Object_Item *elm_toolbar_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15742 * Get the item after @p item in toolbar.
15744 * @param it The toolbar item.
15745 * @return The item after @p item, or @c NULL if none or on failure.
15747 * @note If it is the last item, @c NULL will be returned.
15749 * @see elm_toolbar_item_append()
15753 EAPI Elm_Object_Item *elm_toolbar_item_next_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
15756 * Get the item before @p item in toolbar.
15758 * @param item The toolbar item.
15759 * @return The item before @p item, or @c NULL if none or on failure.
15761 * @note If it is the first item, @c NULL will be returned.
15763 * @see elm_toolbar_item_prepend()
15767 EAPI Elm_Object_Item *elm_toolbar_item_prev_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
15770 * Get the toolbar object from an item.
15772 * @param it The item.
15773 * @return The toolbar object.
15775 * This returns the toolbar object itself that an item belongs to.
15777 * @deprecated use elm_object_item_object_get() instead.
15780 EINA_DEPRECATED EAPI Evas_Object *elm_toolbar_item_toolbar_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
15783 * Set the priority of a toolbar item.
15785 * @param it The toolbar item.
15786 * @param priority The item priority. The default is zero.
15788 * This is used only when the toolbar shrink mode is set to
15789 * #ELM_TOOLBAR_SHRINK_MENU or #ELM_TOOLBAR_SHRINK_HIDE.
15790 * When space is less than required, items with low priority
15791 * will be removed from the toolbar and added to a dynamically-created menu,
15792 * while items with higher priority will remain on the toolbar,
15793 * with the same order they were added.
15795 * @see elm_toolbar_item_priority_get()
15799 EAPI void elm_toolbar_item_priority_set(Elm_Object_Item *it, int priority) EINA_ARG_NONNULL(1);
15802 * Get the priority of a toolbar item.
15804 * @param it The toolbar item.
15805 * @return The @p item priority, or @c 0 on failure.
15807 * @see elm_toolbar_item_priority_set() for details.
15811 EAPI int elm_toolbar_item_priority_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
15814 * Get the label of item.
15816 * @param it The item of toolbar.
15817 * @return The label of item.
15819 * The return value is a pointer to the label associated to @p item when
15820 * it was created, with function elm_toolbar_item_append() or similar,
15822 * with function elm_toolbar_item_label_set. If no label
15823 * was passed as argument, it will return @c NULL.
15825 * @see elm_toolbar_item_label_set() for more details.
15826 * @see elm_toolbar_item_append()
15828 * @deprecated use elm_object_item_text_get() instead.
15831 EINA_DEPRECATED EAPI const char *elm_toolbar_item_label_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
15834 * Set the label of item.
15836 * @param it The item of toolbar.
15837 * @param text The label of item.
15839 * The label to be displayed by the item.
15840 * Label will be placed at icons bottom (if set).
15842 * If a label was passed as argument on item creation, with function
15843 * elm_toolbar_item_append() or similar, it will be already
15844 * displayed by the item.
15846 * @see elm_toolbar_item_label_get()
15847 * @see elm_toolbar_item_append()
15849 * @deprecated use elm_object_item_text_set() instead
15852 EINA_DEPRECATED EAPI void elm_toolbar_item_label_set(Elm_Object_Item *it, const char *label) EINA_ARG_NONNULL(1);
15855 * Return the data associated with a given toolbar widget item.
15857 * @param it The toolbar widget item handle.
15858 * @return The data associated with @p item.
15860 * @see elm_toolbar_item_data_set()
15862 * @deprecated use elm_object_item_data_get() instead.
15865 EINA_DEPRECATED EAPI void *elm_toolbar_item_data_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
15868 * Set the data associated with a given toolbar widget item.
15870 * @param it The toolbar widget item handle
15871 * @param data The new data pointer to set to @p item.
15873 * This sets new item data on @p item.
15875 * @warning The old data pointer won't be touched by this function, so
15876 * the user had better to free that old data himself/herself.
15878 * @deprecated use elm_object_item_data_set() instead.
15881 EINA_DEPRECATED EAPI void elm_toolbar_item_data_set(Elm_Object_Item *it, const void *data) EINA_ARG_NONNULL(1);
15884 * Returns a pointer to a toolbar item by its label.
15886 * @param obj The toolbar object.
15887 * @param label The label of the item to find.
15889 * @return The pointer to the toolbar item matching @p label or @c NULL
15894 EAPI Elm_Object_Item *elm_toolbar_item_find_by_label(const Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
15897 * Get whether the @p item is selected or not.
15899 * @param it The toolbar item.
15900 * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
15901 * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
15903 * @see elm_toolbar_selected_item_set() for details.
15904 * @see elm_toolbar_item_selected_get()
15908 EAPI Eina_Bool elm_toolbar_item_selected_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
15911 * Set the selected state of an item.
15913 * @param it The toolbar item
15914 * @param selected The selected state
15916 * This sets the selected state of the given item @p it.
15917 * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
15919 * If a new item is selected the previosly selected will be unselected.
15920 * Previoulsy selected item can be get with function
15921 * elm_toolbar_selected_item_get().
15923 * Selected items will be highlighted.
15925 * @see elm_toolbar_item_selected_get()
15926 * @see elm_toolbar_selected_item_get()
15930 EAPI void elm_toolbar_item_selected_set(Elm_Object_Item *it, Eina_Bool selected) EINA_ARG_NONNULL(1);
15933 * Get the selected item.
15935 * @param obj The toolbar object.
15936 * @return The selected toolbar item.
15938 * The selected item can be unselected with function
15939 * elm_toolbar_item_selected_set().
15941 * The selected item always will be highlighted on toolbar.
15943 * @see elm_toolbar_selected_items_get()
15947 EAPI Elm_Object_Item *elm_toolbar_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15950 * Set the icon associated with @p item.
15952 * @param obj The parent of this item.
15953 * @param it The toolbar item.
15954 * @param icon A string with icon name or the absolute path of an image file.
15956 * Toolbar will load icon image from fdo or current theme.
15957 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
15958 * If an absolute path is provided it will load it direct from a file.
15960 * @see elm_toolbar_icon_order_lookup_set()
15961 * @see elm_toolbar_icon_order_lookup_get()
15965 EAPI void elm_toolbar_item_icon_set(Elm_Object_Item *it, const char *icon) EINA_ARG_NONNULL(1);
15968 * Get the string used to set the icon of @p item.
15970 * @param it The toolbar item.
15971 * @return The string associated with the icon object.
15973 * @see elm_toolbar_item_icon_set() for details.
15977 EAPI const char *elm_toolbar_item_icon_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
15980 * Get the object of @p item.
15982 * @param it The toolbar item.
15983 * @return The object
15987 EAPI Evas_Object *elm_toolbar_item_object_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
15990 * Get the icon object of @p item.
15992 * @param it The toolbar item.
15993 * @return The icon object
15995 * @see elm_toolbar_item_icon_set(), elm_toolbar_item_icon_file_set(),
15996 * or elm_toolbar_item_icon_memfile_set() for details.
16000 EAPI Evas_Object *elm_toolbar_item_icon_object_get(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
16003 * Set the icon associated with @p item to an image in a binary buffer.
16005 * @param it The toolbar item.
16006 * @param img The binary data that will be used as an image
16007 * @param size The size of binary data @p img
16008 * @param format Optional format of @p img to pass to the image loader
16009 * @param key Optional key of @p img to pass to the image loader (eg. if @p img is an edje file)
16011 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
16013 * @note The icon image set by this function can be changed by
16014 * elm_toolbar_item_icon_set().
16018 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);
16021 * Set the icon associated with @p item to an image in a binary buffer.
16023 * @param it The toolbar item.
16024 * @param file The file that contains the image
16025 * @param key Optional key of @p img to pass to the image loader (eg. if @p img is an edje file)
16027 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
16029 * @note The icon image set by this function can be changed by
16030 * elm_toolbar_item_icon_set().
16034 EAPI Eina_Bool elm_toolbar_item_icon_file_set(Elm_Object_Item *it, const char *file, const char *key) EINA_ARG_NONNULL(1);
16037 * Delete them item from the toolbar.
16039 * @param it The item of toolbar to be deleted.
16041 * @see elm_toolbar_item_append()
16042 * @see elm_toolbar_item_del_cb_set()
16046 EAPI void elm_toolbar_item_del(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
16049 * Set the function called when a toolbar item is freed.
16051 * @param it The item to set the callback on.
16052 * @param func The function called.
16054 * If there is a @p func, then it will be called prior item's memory release.
16055 * That will be called with the following arguments:
16057 * @li item's Evas object;
16060 * This way, a data associated to a toolbar item could be properly freed.
16064 EAPI void elm_toolbar_item_del_cb_set(Elm_Object_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
16067 * Get a value whether toolbar item is disabled or not.
16069 * @param it The item.
16070 * @return The disabled state.
16072 * @see elm_toolbar_item_disabled_set() for more details.
16074 * @deprecated use elm_object_item_disabled_get() instead.
16077 EINA_DEPRECATED EAPI Eina_Bool elm_toolbar_item_disabled_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
16080 * Sets the disabled/enabled state of a toolbar item.
16082 * @param it The item.
16083 * @param disabled The disabled state.
16085 * A disabled item cannot be selected or unselected. It will also
16086 * change its appearance (generally greyed out). This sets the
16087 * disabled state (@c EINA_TRUE for disabled, @c EINA_FALSE for
16090 * @deprecated use elm_object_item_disabled_set() instead.
16093 EINA_DEPRECATED EAPI void elm_toolbar_item_disabled_set(Elm_Object_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1);
16096 * Set or unset item as a separator.
16098 * @param it The toolbar item.
16099 * @param setting @c EINA_TRUE to set item @p item as separator or
16100 * @c EINA_FALSE to unset, i.e., item will be used as a regular item.
16102 * Items aren't set as separator by default.
16104 * If set as separator it will display separator theme, so won't display
16107 * @see elm_toolbar_item_separator_get()
16111 EAPI void elm_toolbar_item_separator_set(Elm_Object_Item *it, Eina_Bool separator) EINA_ARG_NONNULL(1);
16114 * Get a value whether item is a separator or not.
16116 * @param it The toolbar item.
16117 * @return @c EINA_TRUE means item @p it is a separator. @c EINA_FALSE
16118 * indicates it's not. If @p it is @c NULL, @c EINA_FALSE is returned.
16120 * @see elm_toolbar_item_separator_set() for details.
16124 EAPI Eina_Bool elm_toolbar_item_separator_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
16127 * Set the shrink state of toolbar @p obj.
16129 * @param obj The toolbar object.
16130 * @param shrink_mode Toolbar's items display behavior.
16132 * The toolbar won't scroll if #ELM_TOOLBAR_SHRINK_NONE,
16133 * but will enforce a minimun size so all the items will fit, won't scroll
16134 * and won't show the items that don't fit if #ELM_TOOLBAR_SHRINK_HIDE,
16135 * will scroll if #ELM_TOOLBAR_SHRINK_SCROLL, and will create a button to
16136 * pop up excess elements with #ELM_TOOLBAR_SHRINK_MENU.
16140 EAPI void elm_toolbar_mode_shrink_set(Evas_Object *obj, Elm_Toolbar_Shrink_Mode shrink_mode) EINA_ARG_NONNULL(1);
16143 * Get the shrink mode of toolbar @p obj.
16145 * @param obj The toolbar object.
16146 * @return Toolbar's items display behavior.
16148 * @see elm_toolbar_mode_shrink_set() for details.
16152 EAPI Elm_Toolbar_Shrink_Mode elm_toolbar_mode_shrink_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16155 * Enable/disable homogeneous mode.
16157 * @param obj The toolbar object
16158 * @param homogeneous Assume the items within the toolbar are of the
16159 * same size (EINA_TRUE = on, EINA_FALSE = off). Default is @c EINA_FALSE.
16161 * This will enable the homogeneous mode where items are of the same size.
16162 * @see elm_toolbar_homogeneous_get()
16166 EAPI void elm_toolbar_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
16169 * Get whether the homogeneous mode is enabled.
16171 * @param obj The toolbar object.
16172 * @return Assume the items within the toolbar are of the same height
16173 * and width (EINA_TRUE = on, EINA_FALSE = off).
16175 * @see elm_toolbar_homogeneous_set()
16179 EAPI Eina_Bool elm_toolbar_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16182 * Set the parent object of the toolbar items' menus.
16184 * @param obj The toolbar object.
16185 * @param parent The parent of the menu objects.
16187 * Each item can be set as item menu, with elm_toolbar_item_menu_set().
16189 * For more details about setting the parent for toolbar menus, see
16190 * elm_menu_parent_set().
16192 * @see elm_menu_parent_set() for details.
16193 * @see elm_toolbar_item_menu_set() for details.
16197 EAPI void elm_toolbar_menu_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
16200 * Get the parent object of the toolbar items' menus.
16202 * @param obj The toolbar object.
16203 * @return The parent of the menu objects.
16205 * @see elm_toolbar_menu_parent_set() for details.
16209 EAPI Evas_Object *elm_toolbar_menu_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16212 * Set the alignment of the items.
16214 * @param obj The toolbar object.
16215 * @param align The new alignment, a float between <tt> 0.0 </tt>
16216 * and <tt> 1.0 </tt>.
16218 * Alignment of toolbar items, from <tt> 0.0 </tt> to indicates to align
16219 * left, to <tt> 1.0 </tt>, to align to right. <tt> 0.5 </tt> centralize
16222 * Centered items by default.
16224 * @see elm_toolbar_align_get()
16228 EAPI void elm_toolbar_align_set(Evas_Object *obj, double align) EINA_ARG_NONNULL(1);
16231 * Get the alignment of the items.
16233 * @param obj The toolbar object.
16234 * @return toolbar items alignment, a float between <tt> 0.0 </tt> and
16237 * @see elm_toolbar_align_set() for details.
16241 EAPI double elm_toolbar_align_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16244 * Set whether the toolbar item opens a menu.
16246 * @param it The toolbar item.
16247 * @param menu If @c EINA_TRUE, @p item will opens a menu when selected.
16249 * A toolbar item can be set to be a menu, using this function.
16251 * Once it is set to be a menu, it can be manipulated through the
16252 * menu-like function elm_toolbar_menu_parent_set() and the other
16253 * elm_menu functions, using the Evas_Object @c menu returned by
16254 * elm_toolbar_item_menu_get().
16256 * So, items to be displayed in this item's menu should be added with
16257 * elm_menu_item_add().
16259 * The following code exemplifies the most basic usage:
16261 * tb = elm_toolbar_add(win)
16262 * item = elm_toolbar_item_append(tb, "refresh", "Menu", NULL, NULL);
16263 * elm_toolbar_item_menu_set(item, EINA_TRUE);
16264 * elm_toolbar_menu_parent_set(tb, win);
16265 * menu = elm_toolbar_item_menu_get(item);
16266 * elm_menu_item_add(menu, NULL, "edit-cut", "Cut", NULL, NULL);
16267 * menu_item = elm_menu_item_add(menu, NULL, "edit-copy", "Copy", NULL,
16271 * @see elm_toolbar_item_menu_get()
16275 EAPI void elm_toolbar_item_menu_set(Elm_Object_Item *it, Eina_Bool menu) EINA_ARG_NONNULL(1);
16278 * Get toolbar item's menu.
16280 * @param it The toolbar item.
16281 * @return Item's menu object or @c NULL on failure.
16283 * If @p item wasn't set as menu item with elm_toolbar_item_menu_set(),
16284 * this function will set it.
16286 * @see elm_toolbar_item_menu_set() for details.
16290 EAPI Evas_Object *elm_toolbar_item_menu_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
16293 * Add a new state to @p item.
16295 * @param it The toolbar item.
16296 * @param icon A string with icon name or the absolute path of an image file.
16297 * @param label The label of the new state.
16298 * @param func The function to call when the item is clicked when this
16299 * state is selected.
16300 * @param data The data to associate with the state.
16301 * @return The toolbar item state, or @c NULL upon failure.
16303 * Toolbar will load icon image from fdo or current theme.
16304 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
16305 * If an absolute path is provided it will load it direct from a file.
16307 * States created with this function can be removed with
16308 * elm_toolbar_item_state_del().
16310 * @see elm_toolbar_item_state_del()
16311 * @see elm_toolbar_item_state_sel()
16312 * @see elm_toolbar_item_state_get()
16316 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);
16319 * Delete a previoulsy added state to @p item.
16321 * @param it The toolbar item.
16322 * @param state The state to be deleted.
16323 * @return @c EINA_TRUE on success or @c EINA_FALSE on failure.
16325 * @see elm_toolbar_item_state_add()
16327 EAPI Eina_Bool elm_toolbar_item_state_del(Elm_Object_Item *it, Elm_Toolbar_Item_State *state) EINA_ARG_NONNULL(1);
16330 * Set @p state as the current state of @p it.
16332 * @param it The toolbar item.
16333 * @param state The state to use.
16334 * @return @c EINA_TRUE on success or @c EINA_FALSE on failure.
16336 * If @p state is @c NULL, it won't select any state and the default item's
16337 * icon and label will be used. It's the same behaviour than
16338 * elm_toolbar_item_state_unser().
16340 * @see elm_toolbar_item_state_unset()
16344 EAPI Eina_Bool elm_toolbar_item_state_set(Elm_Object_Item *it, Elm_Toolbar_Item_State *state) EINA_ARG_NONNULL(1);
16347 * Unset the state of @p it.
16349 * @param it The toolbar item.
16351 * The default icon and label from this item will be displayed.
16353 * @see elm_toolbar_item_state_set() for more details.
16357 EAPI void elm_toolbar_item_state_unset(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
16360 * Get the current state of @p it.
16362 * @param it The toolbar item.
16363 * @return The selected state or @c NULL if none is selected or on failure.
16365 * @see elm_toolbar_item_state_set() for details.
16366 * @see elm_toolbar_item_state_unset()
16367 * @see elm_toolbar_item_state_add()
16371 EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
16374 * Get the state after selected state in toolbar's @p item.
16376 * @param it The toolbar item to change state.
16377 * @return The state after current state, or @c NULL on failure.
16379 * If last state is selected, this function will return first state.
16381 * @see elm_toolbar_item_state_set()
16382 * @see elm_toolbar_item_state_add()
16386 EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_next(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
16389 * Get the state before selected state in toolbar's @p item.
16391 * @param it The toolbar item to change state.
16392 * @return The state before current state, or @c NULL on failure.
16394 * If first state is selected, this function will return last state.
16396 * @see elm_toolbar_item_state_set()
16397 * @see elm_toolbar_item_state_add()
16401 EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_prev(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
16404 * Set the text to be shown in a given toolbar item's tooltips.
16406 * @param it toolbar item.
16407 * @param text The text to set in the content.
16409 * Setup the text as tooltip to object. The item can have only one tooltip,
16410 * so any previous tooltip data - set with this function or
16411 * elm_toolbar_item_tooltip_content_cb_set() - is removed.
16413 * @see elm_object_tooltip_text_set() for more details.
16417 EAPI void elm_toolbar_item_tooltip_text_set(Elm_Object_Item *it, const char *text) EINA_ARG_NONNULL(1);
16420 * Set the content to be shown in the tooltip item.
16422 * Setup the tooltip to item. The item can have only one tooltip,
16423 * so any previous tooltip data is removed. @p func(with @p data) will
16424 * be called every time that need show the tooltip and it should
16425 * return a valid Evas_Object. This object is then managed fully by
16426 * tooltip system and is deleted when the tooltip is gone.
16428 * @param it the toolbar item being attached a tooltip.
16429 * @param func the function used to create the tooltip contents.
16430 * @param data what to provide to @a func as callback data/context.
16431 * @param del_cb called when data is not needed anymore, either when
16432 * another callback replaces @a func, the tooltip is unset with
16433 * elm_toolbar_item_tooltip_unset() or the owner @a item
16434 * dies. This callback receives as the first parameter the
16435 * given @a data, and @c event_info is the item.
16437 * @see elm_object_tooltip_content_cb_set() for more details.
16441 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);
16444 * Unset tooltip from item.
16446 * @param it toolbar item to remove previously set tooltip.
16448 * Remove tooltip from item. The callback provided as del_cb to
16449 * elm_toolbar_item_tooltip_content_cb_set() will be called to notify
16450 * it is not used anymore.
16452 * @see elm_object_tooltip_unset() for more details.
16453 * @see elm_toolbar_item_tooltip_content_cb_set()
16457 EAPI void elm_toolbar_item_tooltip_unset(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
16460 * Sets a different style for this item tooltip.
16462 * @note before you set a style you should define a tooltip with
16463 * elm_toolbar_item_tooltip_content_cb_set() or
16464 * elm_toolbar_item_tooltip_text_set()
16466 * @param it toolbar item with tooltip already set.
16467 * @param style the theme style to use (default, transparent, ...)
16469 * @see elm_object_tooltip_style_set() for more details.
16473 EAPI void elm_toolbar_item_tooltip_style_set(Elm_Object_Item *it, const char *style) EINA_ARG_NONNULL(1);
16476 * Get the style for this item tooltip.
16478 * @param it toolbar item with tooltip already set.
16479 * @return style the theme style in use, defaults to "default". If the
16480 * object does not have a tooltip set, then NULL is returned.
16482 * @see elm_object_tooltip_style_get() for more details.
16483 * @see elm_toolbar_item_tooltip_style_set()
16487 EAPI const char *elm_toolbar_item_tooltip_style_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
16490 * Set the type of mouse pointer/cursor decoration to be shown,
16491 * when the mouse pointer is over the given toolbar widget item
16493 * @param it toolbar item to customize cursor on
16494 * @param cursor the cursor type's name
16496 * This function works analogously as elm_object_cursor_set(), but
16497 * here the cursor's changing area is restricted to the item's
16498 * area, and not the whole widget's. Note that that item cursors
16499 * have precedence over widget cursors, so that a mouse over an
16500 * item with custom cursor set will always show @b that cursor.
16502 * If this function is called twice for an object, a previously set
16503 * cursor will be unset on the second call.
16505 * @see elm_object_cursor_set()
16506 * @see elm_toolbar_item_cursor_get()
16507 * @see elm_toolbar_item_cursor_unset()
16511 EAPI void elm_toolbar_item_cursor_set(Elm_Object_Item *it, const char *cursor) EINA_ARG_NONNULL(1);
16514 * Get the type of mouse pointer/cursor decoration set to be shown,
16515 * when the mouse pointer is over the given toolbar widget item
16517 * @param it toolbar item with custom cursor set
16518 * @return the cursor type's name or @c NULL, if no custom cursors
16519 * were set to @p item (and on errors)
16521 * @see elm_object_cursor_get()
16522 * @see elm_toolbar_item_cursor_set()
16523 * @see elm_toolbar_item_cursor_unset()
16527 EAPI const char *elm_toolbar_item_cursor_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
16530 * Unset any custom mouse pointer/cursor decoration set to be
16531 * shown, when the mouse pointer is over the given toolbar widget
16532 * item, thus making it show the @b default cursor again.
16534 * @param it a toolbar item
16536 * Use this call to undo any custom settings on this item's cursor
16537 * decoration, bringing it back to defaults (no custom style set).
16539 * @see elm_object_cursor_unset()
16540 * @see elm_toolbar_item_cursor_set()
16544 EAPI void elm_toolbar_item_cursor_unset(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
16547 * Set a different @b style for a given custom cursor set for a
16550 * @param it toolbar item with custom cursor set
16551 * @param style the <b>theme style</b> to use (e.g. @c "default",
16552 * @c "transparent", etc)
16554 * This function only makes sense when one is using custom mouse
16555 * cursor decorations <b>defined in a theme file</b>, which can have,
16556 * given a cursor name/type, <b>alternate styles</b> on it. It
16557 * works analogously as elm_object_cursor_style_set(), but here
16558 * applyed only to toolbar item objects.
16560 * @warning Before you set a cursor style you should have definen a
16561 * custom cursor previously on the item, with
16562 * elm_toolbar_item_cursor_set()
16564 * @see elm_toolbar_item_cursor_engine_only_set()
16565 * @see elm_toolbar_item_cursor_style_get()
16569 EAPI void elm_toolbar_item_cursor_style_set(Elm_Object_Item *it, const char *style) EINA_ARG_NONNULL(1);
16572 * Get the current @b style set for a given toolbar item's custom
16575 * @param it toolbar item with custom cursor set.
16576 * @return style the cursor style in use. If the object does not
16577 * have a cursor set, then @c NULL is returned.
16579 * @see elm_toolbar_item_cursor_style_set() for more details
16583 EAPI const char *elm_toolbar_item_cursor_style_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
16586 * Set if the (custom)cursor for a given toolbar item should be
16587 * searched in its theme, also, or should only rely on the
16588 * rendering engine.
16590 * @param it item with custom (custom) cursor already set on
16591 * @param engine_only Use @c EINA_TRUE to have cursors looked for
16592 * only on those provided by the rendering engine, @c EINA_FALSE to
16593 * have them searched on the widget's theme, as well.
16595 * @note This call is of use only if you've set a custom cursor
16596 * for toolbar items, with elm_toolbar_item_cursor_set().
16598 * @note By default, cursors will only be looked for between those
16599 * provided by the rendering engine.
16603 EAPI void elm_toolbar_item_cursor_engine_only_set(Elm_Object_Item *it, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
16606 * Get if the (custom) cursor for a given toolbar item is being
16607 * searched in its theme, also, or is only relying on the rendering
16610 * @param it a toolbar item
16611 * @return @c EINA_TRUE, if cursors are being looked for only on
16612 * those provided by the rendering engine, @c EINA_FALSE if they
16613 * are being searched on the widget's theme, as well.
16615 * @see elm_toolbar_item_cursor_engine_only_set(), for more details
16619 EAPI Eina_Bool elm_toolbar_item_cursor_engine_only_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
16622 * Change a toolbar's orientation
16623 * @param obj The toolbar object
16624 * @param vertical If @c EINA_TRUE, the toolbar is vertical
16625 * By default, a toolbar will be horizontal. Use this function to create a vertical toolbar.
16627 * @deprecated use elm_toolbar_horizontal_set() instead.
16629 EINA_DEPRECATED EAPI void elm_toolbar_orientation_set(Evas_Object *obj, Eina_Bool vertical) EINA_ARG_NONNULL(1);
16632 * Change a toolbar's orientation
16633 * @param obj The toolbar object
16634 * @param horizontal If @c EINA_TRUE, the toolbar is horizontal
16635 * By default, a toolbar will be horizontal. Use this function to create a vertical toolbar.
16638 EAPI void elm_toolbar_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
16641 * Get a toolbar's orientation
16642 * @param obj The toolbar object
16643 * @return If @c EINA_TRUE, the toolbar is vertical
16644 * By default, a toolbar will be horizontal. Use this function to determine whether a toolbar is vertical.
16646 * @deprecated use elm_toolbar_horizontal_get() instead.
16648 EINA_DEPRECATED EAPI Eina_Bool elm_toolbar_orientation_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16651 * Get a toolbar's orientation
16652 * @param obj The toolbar object
16653 * @return If @c EINA_TRUE, the toolbar is horizontal
16654 * By default, a toolbar will be horizontal. Use this function to determine whether a toolbar is vertical.
16657 EAPI Eina_Bool elm_toolbar_horizontal_get(const Evas_Object *obj);
16663 * @defgroup Tooltips Tooltips
16665 * The Tooltip is an (internal, for now) smart object used to show a
16666 * content in a frame on mouse hover of objects(or widgets), with
16667 * tips/information about them.
16672 EAPI double elm_tooltip_delay_get(void);
16673 EAPI Eina_Bool elm_tooltip_delay_set(double delay);
16674 EAPI void elm_object_tooltip_show(Evas_Object *obj) EINA_ARG_NONNULL(1);
16675 EAPI void elm_object_tooltip_hide(Evas_Object *obj) EINA_ARG_NONNULL(1);
16676 EAPI void elm_object_tooltip_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1, 2);
16677 EAPI void elm_object_tooltip_domain_translatable_text_set(Evas_Object *obj, const char *domain, const char *text) EINA_ARG_NONNULL(1, 3);
16678 #define elm_object_tooltip_translatable_text_set(obj, text) elm_object_tooltip_domain_translatable_text_set((obj), NULL, (text))
16679 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);
16680 EAPI void elm_object_tooltip_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
16681 EAPI void elm_object_tooltip_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
16682 EAPI const char *elm_object_tooltip_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16683 EAPI Eina_Bool elm_object_tooltip_window_mode_set(Evas_Object *obj, Eina_Bool disable) EINA_ARG_NONNULL(1);
16684 EAPI Eina_Bool elm_object_tooltip_window_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16691 * @defgroup Cursors Cursors
16693 * The Elementary cursor is an internal smart object used to
16694 * customize the mouse cursor displayed over objects (or
16695 * widgets). In the most common scenario, the cursor decoration
16696 * comes from the graphical @b engine Elementary is running
16697 * on. Those engines may provide different decorations for cursors,
16698 * and Elementary provides functions to choose them (think of X11
16699 * cursors, as an example).
16701 * There's also the possibility of, besides using engine provided
16702 * cursors, also use ones coming from Edje theming files. Both
16703 * globally and per widget, Elementary makes it possible for one to
16704 * make the cursors lookup to be held on engines only or on
16705 * Elementary's theme file, too. To set cursor's hot spot,
16706 * two data items should be added to cursor's theme: "hot_x" and
16707 * "hot_y", that are the offset from upper-left corner of the cursor
16708 * (coordinates 0,0).
16714 * Set the cursor to be shown when mouse is over the object
16716 * Set the cursor that will be displayed when mouse is over the
16717 * object. The object can have only one cursor set to it, so if
16718 * this function is called twice for an object, the previous set
16720 * If using X cursors, a definition of all the valid cursor names
16721 * is listed on Elementary_Cursors.h. If an invalid name is set
16722 * the default cursor will be used.
16724 * @param obj the object being set a cursor.
16725 * @param cursor the cursor name to be used.
16729 EAPI void elm_object_cursor_set(Evas_Object *obj, const char *cursor) EINA_ARG_NONNULL(1);
16732 * Get the cursor to be shown when mouse is over the object
16734 * @param obj an object with cursor already set.
16735 * @return the cursor name.
16739 EAPI const char *elm_object_cursor_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16742 * Unset cursor for object
16744 * Unset cursor for object, and set the cursor to default if the mouse
16745 * was over this object.
16747 * @param obj Target object
16748 * @see elm_object_cursor_set()
16752 EAPI void elm_object_cursor_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
16755 * Sets a different style for this object cursor.
16757 * @note before you set a style you should define a cursor with
16758 * elm_object_cursor_set()
16760 * @param obj an object with cursor already set.
16761 * @param style the theme style to use (default, transparent, ...)
16765 EAPI void elm_object_cursor_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
16768 * Get the style for this object cursor.
16770 * @param obj an object with cursor already set.
16771 * @return style the theme style in use, defaults to "default". If the
16772 * object does not have a cursor set, then NULL is returned.
16776 EAPI const char *elm_object_cursor_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16779 * Set if the cursor set should be searched on the theme or should use
16780 * the provided by the engine, only.
16782 * @note before you set if should look on theme you should define a cursor
16783 * with elm_object_cursor_set(). By default it will only look for cursors
16784 * provided by the engine.
16786 * @param obj an object with cursor already set.
16787 * @param engine_only boolean to define it cursors should be looked only
16788 * between the provided by the engine or searched on widget's theme as well.
16792 EAPI void elm_object_cursor_engine_only_set(Evas_Object *obj, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
16795 * Get the cursor engine only usage for this object cursor.
16797 * @param obj an object with cursor already set.
16798 * @return engine_only boolean to define it cursors should be
16799 * looked only between the provided by the engine or searched on
16800 * widget's theme as well. If the object does not have a cursor
16801 * set, then EINA_FALSE is returned.
16805 EAPI Eina_Bool elm_object_cursor_engine_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16808 * Get the configured cursor engine only usage
16810 * This gets the globally configured exclusive usage of engine cursors.
16812 * @return 1 if only engine cursors should be used
16815 EAPI int elm_cursor_engine_only_get(void);
16818 * Set the configured cursor engine only usage
16820 * This sets the globally configured exclusive usage of engine cursors.
16821 * It won't affect cursors set before changing this value.
16823 * @param engine_only If 1 only engine cursors will be enabled, if 0 will
16824 * look for them on theme before.
16825 * @return EINA_TRUE if value is valid and setted (0 or 1)
16828 EAPI Eina_Bool elm_cursor_engine_only_set(int engine_only);
16835 * @defgroup Menu Menu
16837 * @image html img/widget/menu/preview-00.png
16838 * @image latex img/widget/menu/preview-00.eps
16840 * A menu is a list of items displayed above its parent. When the menu is
16841 * showing its parent is darkened. Each item can have a sub-menu. The menu
16842 * object can be used to display a menu on a right click event, in a toolbar,
16845 * Signals that you can add callbacks for are:
16846 * @li "clicked" - the user clicked the empty space in the menu to dismiss.
16848 * Default contents parts of the menu items that you can use for are:
16849 * @li "default" - A main content of the menu item
16851 * Default text parts of the menu items that you can use for are:
16852 * @li "default" - label in the menu item
16854 * @see @ref tutorial_menu
16859 * @brief Add a new menu to the parent
16861 * @param parent The parent object.
16862 * @return The new object or NULL if it cannot be created.
16864 EAPI Evas_Object *elm_menu_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
16867 * @brief Set the parent for the given menu widget
16869 * @param obj The menu object.
16870 * @param parent The new parent.
16872 EAPI void elm_menu_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
16875 * @brief Get the parent for the given menu widget
16877 * @param obj The menu object.
16878 * @return The parent.
16880 * @see elm_menu_parent_set()
16882 EAPI Evas_Object *elm_menu_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16885 * @brief Move the menu to a new position
16887 * @param obj The menu object.
16888 * @param x The new position.
16889 * @param y The new position.
16891 * Sets the top-left position of the menu to (@p x,@p y).
16893 * @note @p x and @p y coordinates are relative to parent.
16895 EAPI void elm_menu_move(Evas_Object *obj, Evas_Coord x, Evas_Coord y) EINA_ARG_NONNULL(1);
16898 * @brief Close a opened menu
16900 * @param obj the menu object
16903 * Hides the menu and all it's sub-menus.
16905 EAPI void elm_menu_close(Evas_Object *obj) EINA_ARG_NONNULL(1);
16908 * @brief Returns a list of @p item's items.
16910 * @param obj The menu object
16911 * @return An Eina_List* of @p item's items
16913 EAPI const Eina_List *elm_menu_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16916 * @brief Get the Evas_Object of an Elm_Object_Item
16918 * @param it The menu item object.
16919 * @return The edje object containing the swallowed content
16921 * @warning Don't manipulate this object!
16924 EAPI Evas_Object *elm_menu_item_object_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
16927 * @brief Add an item at the end of the given menu widget
16929 * @param obj The menu object.
16930 * @param parent The parent menu item (optional)
16931 * @param icon An icon display on the item. The icon will be destryed by the menu.
16932 * @param label The label of the item.
16933 * @param func Function called when the user select the item.
16934 * @param data Data sent by the callback.
16935 * @return Returns the new item.
16937 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);
16940 * @brief Add an object swallowed in an item at the end of the given menu
16943 * @param obj The menu object.
16944 * @param parent The parent menu item (optional)
16945 * @param subobj The object to swallow
16946 * @param func Function called when the user select the item.
16947 * @param data Data sent by the callback.
16948 * @return Returns the new item.
16950 * Add an evas object as an item to the menu.
16952 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);
16955 * @brief Set the label of a menu item
16957 * @param it The menu item object.
16958 * @param label The label to set for @p item
16960 * @warning Don't use this funcion on items created with
16961 * elm_menu_item_add_object() or elm_menu_item_separator_add().
16963 * @deprecated Use elm_object_item_text_set() instead
16965 EINA_DEPRECATED EAPI void elm_menu_item_label_set(Elm_Object_Item *it, const char *label) EINA_ARG_NONNULL(1);
16968 * @brief Get the label of a menu item
16970 * @param it The menu item object.
16971 * @return The label of @p item
16972 * @deprecated Use elm_object_item_text_get() instead
16974 EINA_DEPRECATED EAPI const char *elm_menu_item_label_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
16977 * @brief Set the icon of a menu item to the standard icon with name @p icon
16979 * @param it The menu item object.
16980 * @param icon The icon object to set for the content of @p item
16982 * Once this icon is set, any previously set icon will be deleted.
16984 EAPI void elm_menu_item_object_icon_name_set(Elm_Object_Item *it, const char *icon) EINA_ARG_NONNULL(1, 2);
16987 * @brief Get the string representation from the icon of a menu item
16989 * @param it The menu item object.
16990 * @return The string representation of @p item's icon or NULL
16992 * @see elm_menu_item_object_icon_name_set()
16994 EAPI const char *elm_menu_item_object_icon_name_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
16997 * @brief Set the content object of a menu item
16999 * @param it The menu item object
17000 * @param The content object or NULL
17001 * @return EINA_TRUE on success, else EINA_FALSE
17003 * Use this function to change the object swallowed by a menu item, deleting
17004 * any previously swallowed object.
17006 * @deprecated Use elm_object_item_content_set() instead
17008 EINA_DEPRECATED EAPI Eina_Bool elm_menu_item_object_content_set(Elm_Object_Item *it, Evas_Object *obj) EINA_ARG_NONNULL(1);
17011 * @brief Get the content object of a menu item
17013 * @param it The menu item object
17014 * @return The content object or NULL
17015 * @note If @p item was added with elm_menu_item_add_object, this
17016 * function will return the object passed, else it will return the
17019 * @see elm_menu_item_object_content_set()
17021 * @deprecated Use elm_object_item_content_get() instead
17023 EINA_DEPRECATED EAPI Evas_Object *elm_menu_item_object_content_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
17026 * @brief Set the selected state of @p item.
17028 * @param it The menu item object.
17029 * @param selected The selected/unselected state of the item
17031 EAPI void elm_menu_item_selected_set(Elm_Object_Item *it, Eina_Bool selected) EINA_ARG_NONNULL(1);
17034 * @brief Get the selected state of @p item.
17036 * @param it The menu item object.
17037 * @return The selected/unselected state of the item
17039 * @see elm_menu_item_selected_set()
17041 EAPI Eina_Bool elm_menu_item_selected_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
17044 * @brief Set the disabled state of @p item.
17046 * @param it The menu item object.
17047 * @param disabled The enabled/disabled state of the item
17048 * @deprecated Use elm_object_item_disabled_set() instead
17050 EINA_DEPRECATED EAPI void elm_menu_item_disabled_set(Elm_Object_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1);
17053 * @brief Get the disabled state of @p item.
17055 * @param it The menu item object.
17056 * @return The enabled/disabled state of the item
17058 * @see elm_menu_item_disabled_set()
17059 * @deprecated Use elm_object_item_disabled_get() instead
17061 EINA_DEPRECATED EAPI Eina_Bool elm_menu_item_disabled_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
17064 * @brief Add a separator item to menu @p obj under @p parent.
17066 * @param obj The menu object
17067 * @param parent The item to add the separator under
17068 * @return The created item or NULL on failure
17070 * This is item is a @ref Separator.
17072 EAPI Elm_Object_Item *elm_menu_item_separator_add(Evas_Object *obj, Elm_Object_Item *parent) EINA_ARG_NONNULL(1);
17075 * @brief Returns whether @p item is a separator.
17077 * @param it The item to check
17078 * @return If true, @p item is a separator
17080 * @see elm_menu_item_separator_add()
17082 EAPI Eina_Bool elm_menu_item_is_separator(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
17085 * @brief Deletes an item from the menu.
17087 * @param it The item to delete.
17089 * @see elm_menu_item_add()
17091 EAPI void elm_menu_item_del(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
17094 * @brief Set the function called when a menu item is deleted.
17096 * @param it The item to set the callback on
17097 * @param func The function called
17099 * @see elm_menu_item_add()
17100 * @see elm_menu_item_del()
17102 EAPI void elm_menu_item_del_cb_set(Elm_Object_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
17105 * @brief Returns the data associated with menu item @p item.
17107 * @param it The item
17108 * @return The data associated with @p item or NULL if none was set.
17110 * This is the data set with elm_menu_add() or elm_menu_item_data_set().
17112 * @deprecated Use elm_object_item_data_get() instead
17114 EINA_DEPRECATED EAPI void *elm_menu_item_data_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
17117 * @brief Sets the data to be associated with menu item @p item.
17119 * @param it The item
17120 * @param data The data to be associated with @p item
17122 * @deprecated Use elm_object_item_data_set() instead
17124 EINA_DEPRECATED EAPI void elm_menu_item_data_set(Elm_Object_Item *it, const void *data) EINA_ARG_NONNULL(1);
17127 * @brief Returns a list of @p item's subitems.
17129 * @param it The item
17130 * @return An Eina_List* of @p item's subitems
17132 * @see elm_menu_add()
17134 EAPI const Eina_List *elm_menu_item_subitems_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
17137 * @brief Get the position of a menu item
17139 * @param it The menu item
17140 * @return The item's index
17142 * This function returns the index position of a menu item in a menu.
17143 * For a sub-menu, this number is relative to the first item in the sub-menu.
17145 * @note Index values begin with 0
17147 EAPI unsigned int elm_menu_item_index_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1) EINA_PURE;
17150 * @brief @brief Return a menu item's owner menu
17152 * @param it The menu item
17153 * @return The menu object owning @p item, or NULL on failure
17155 * Use this function to get the menu object owning an item.
17157 EAPI Evas_Object *elm_menu_item_menu_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1) EINA_PURE;
17160 * @brief Get the selected item in the menu
17162 * @param obj The menu object
17163 * @return The selected item, or NULL if none
17165 * @see elm_menu_item_selected_get()
17166 * @see elm_menu_item_selected_set()
17168 EAPI Elm_Object_Item *elm_menu_selected_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
17171 * @brief Get the last item in the menu
17173 * @param obj The menu object
17174 * @return The last item, or NULL if none
17176 EAPI Elm_Object_Item *elm_menu_last_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
17179 * @brief Get the first item in the menu
17181 * @param obj The menu object
17182 * @return The first item, or NULL if none
17184 EAPI Elm_Object_Item *elm_menu_first_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
17187 * @brief Get the next item in the menu.
17189 * @param it The menu item object.
17190 * @return The item after it, or NULL if none
17192 EAPI Elm_Object_Item *elm_menu_item_next_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
17195 * @brief Get the previous item in the menu.
17197 * @param it The menu item object.
17198 * @return The item before it, or NULL if none
17200 EAPI Elm_Object_Item *elm_menu_item_prev_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
17207 * @defgroup List List
17208 * @ingroup Elementary
17210 * @image html img/widget/list/preview-00.png
17211 * @image latex img/widget/list/preview-00.eps width=\textwidth
17213 * @image html img/list.png
17214 * @image latex img/list.eps width=\textwidth
17216 * A list widget is a container whose children are displayed vertically or
17217 * horizontally, in order, and can be selected.
17218 * The list can accept only one or multiple items selection. Also has many
17219 * modes of items displaying.
17221 * A list is a very simple type of list widget. For more robust
17222 * lists, @ref Genlist should probably be used.
17224 * Smart callbacks one can listen to:
17225 * - @c "activated" - The user has double-clicked or pressed
17226 * (enter|return|spacebar) on an item. The @c event_info parameter
17227 * is the item that was activated.
17228 * - @c "clicked,double" - The user has double-clicked an item.
17229 * The @c event_info parameter is the item that was double-clicked.
17230 * - "selected" - when the user selected an item
17231 * - "unselected" - when the user unselected an item
17232 * - "longpressed" - an item in the list is long-pressed
17233 * - "edge,top" - the list is scrolled until the top edge
17234 * - "edge,bottom" - the list is scrolled until the bottom edge
17235 * - "edge,left" - the list is scrolled until the left edge
17236 * - "edge,right" - the list is scrolled until the right edge
17237 * - "language,changed" - the program's language changed
17239 * Available styles for it:
17242 * List of examples:
17243 * @li @ref list_example_01
17244 * @li @ref list_example_02
17245 * @li @ref list_example_03
17254 * @enum _Elm_List_Mode
17255 * @typedef Elm_List_Mode
17257 * Set list's resize behavior, transverse axis scroll and
17258 * items cropping. See each mode's description for more details.
17260 * @note Default value is #ELM_LIST_SCROLL.
17262 * Values <b> don't </b> work as bitmask, only one can be choosen.
17264 * @see elm_list_mode_set()
17265 * @see elm_list_mode_get()
17269 typedef enum _Elm_List_Mode
17271 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. */
17272 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). */
17273 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. */
17274 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. */
17275 ELM_LIST_LAST /**< Indicates error if returned by elm_list_mode_get() */
17278 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(). */
17281 * Add a new list widget to the given parent Elementary
17282 * (container) object.
17284 * @param parent The parent object.
17285 * @return a new list widget handle or @c NULL, on errors.
17287 * This function inserts a new list widget on the canvas.
17291 EAPI Evas_Object *elm_list_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
17296 * @param obj The list object
17298 * @note Call before running show() on the list object.
17299 * @warning If not called, it won't display the list properly.
17302 * li = elm_list_add(win);
17303 * elm_list_item_append(li, "First", NULL, NULL, NULL, NULL);
17304 * elm_list_item_append(li, "Second", NULL, NULL, NULL, NULL);
17306 * evas_object_show(li);
17311 EAPI void elm_list_go(Evas_Object *obj) EINA_ARG_NONNULL(1);
17314 * Enable or disable multiple items selection on the list object.
17316 * @param obj The list object
17317 * @param multi @c EINA_TRUE to enable multi selection or @c EINA_FALSE to
17320 * Disabled by default. If disabled, the user can select a single item of
17321 * the list each time. Selected items are highlighted on list.
17322 * If enabled, many items can be selected.
17324 * If a selected item is selected again, it will be unselected.
17326 * @see elm_list_multi_select_get()
17330 EAPI void elm_list_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
17333 * Get a value whether multiple items selection is enabled or not.
17335 * @see elm_list_multi_select_set() for details.
17337 * @param obj The list object.
17338 * @return @c EINA_TRUE means multiple items selection is enabled.
17339 * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
17340 * @c EINA_FALSE is returned.
17344 EAPI Eina_Bool elm_list_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17347 * Set which mode to use for the list object.
17349 * @param obj The list object
17350 * @param mode One of #Elm_List_Mode: #ELM_LIST_COMPRESS, #ELM_LIST_SCROLL,
17351 * #ELM_LIST_LIMIT or #ELM_LIST_EXPAND.
17353 * Set list's resize behavior, transverse axis scroll and
17354 * items cropping. See each mode's description for more details.
17356 * @note Default value is #ELM_LIST_SCROLL.
17358 * Only one can be set, if a previous one was set, it will be changed
17359 * by the new mode set. Bitmask won't work as well.
17361 * @see elm_list_mode_get()
17365 EAPI void elm_list_mode_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
17368 * Get the mode the list is at.
17370 * @param obj The list object
17371 * @return One of #Elm_List_Mode: #ELM_LIST_COMPRESS, #ELM_LIST_SCROLL,
17372 * #ELM_LIST_LIMIT, #ELM_LIST_EXPAND or #ELM_LIST_LAST on errors.
17374 * @note see elm_list_mode_set() for more information.
17378 EAPI Elm_List_Mode elm_list_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17381 * Enable or disable horizontal mode on the list object.
17383 * @param obj The list object.
17384 * @param horizontal @c EINA_TRUE to enable horizontal or @c EINA_FALSE to
17385 * disable it, i.e., to enable vertical mode.
17387 * @note Vertical mode is set by default.
17389 * On horizontal mode items are displayed on list from left to right,
17390 * instead of from top to bottom. Also, the list will scroll horizontally.
17391 * Each item will presents left icon on top and right icon, or end, at
17394 * @see elm_list_horizontal_get()
17398 EAPI void elm_list_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
17401 * Get a value whether horizontal mode is enabled or not.
17403 * @param obj The list object.
17404 * @return @c EINA_TRUE means horizontal mode selection is enabled.
17405 * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
17406 * @c EINA_FALSE is returned.
17408 * @see elm_list_horizontal_set() for details.
17412 EAPI Eina_Bool elm_list_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17415 * Enable or disable always select mode on the list object.
17417 * @param obj The list object
17418 * @param always_select @c EINA_TRUE to enable always select mode or
17419 * @c EINA_FALSE to disable it.
17421 * @note Always select mode is disabled by default.
17423 * Default behavior of list items is to only call its callback function
17424 * the first time it's pressed, i.e., when it is selected. If a selected
17425 * item is pressed again, and multi-select is disabled, it won't call
17426 * this function (if multi-select is enabled it will unselect the item).
17428 * If always select is enabled, it will call the callback function
17429 * everytime a item is pressed, so it will call when the item is selected,
17430 * and again when a selected item is pressed.
17432 * @see elm_list_always_select_mode_get()
17433 * @see elm_list_multi_select_set()
17437 EAPI void elm_list_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
17440 * Get a value whether always select mode is enabled or not, meaning that
17441 * an item will always call its callback function, even if already selected.
17443 * @param obj The list object
17444 * @return @c EINA_TRUE means horizontal mode selection is enabled.
17445 * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
17446 * @c EINA_FALSE is returned.
17448 * @see elm_list_always_select_mode_set() for details.
17452 EAPI Eina_Bool elm_list_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17455 * Set bouncing behaviour when the scrolled content reaches an edge.
17457 * Tell the internal scroller object whether it should bounce or not
17458 * when it reaches the respective edges for each axis.
17460 * @param obj The list object
17461 * @param h_bounce Whether to bounce or not in the horizontal axis.
17462 * @param v_bounce Whether to bounce or not in the vertical axis.
17464 * @see elm_scroller_bounce_set()
17468 EAPI void elm_list_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
17471 * Get the bouncing behaviour of the internal scroller.
17473 * Get whether the internal scroller should bounce when the edge of each
17474 * axis is reached scrolling.
17476 * @param obj The list object.
17477 * @param h_bounce Pointer where to store the bounce state of the horizontal
17479 * @param v_bounce Pointer where to store the bounce state of the vertical
17482 * @see elm_scroller_bounce_get()
17483 * @see elm_list_bounce_set()
17487 EAPI void elm_list_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
17490 * Set the scrollbar policy.
17492 * @param obj The list object
17493 * @param policy_h Horizontal scrollbar policy.
17494 * @param policy_v Vertical scrollbar policy.
17496 * This sets the scrollbar visibility policy for the given scroller.
17497 * #ELM_SCROLLER_POLICY_AUTO means the scrollbar is made visible if it
17498 * is needed, and otherwise kept hidden. #ELM_SCROLLER_POLICY_ON turns
17499 * it on all the time, and #ELM_SCROLLER_POLICY_OFF always keeps it off.
17500 * This applies respectively for the horizontal and vertical scrollbars.
17502 * The both are disabled by default, i.e., are set to
17503 * #ELM_SCROLLER_POLICY_OFF.
17507 EAPI void elm_list_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
17510 * Get the scrollbar policy.
17512 * @see elm_list_scroller_policy_get() for details.
17514 * @param obj The list object.
17515 * @param policy_h Pointer where to store horizontal scrollbar policy.
17516 * @param policy_v Pointer where to store vertical scrollbar policy.
17520 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);
17523 * Append a new item to the list object.
17525 * @param obj The list object.
17526 * @param label The label of the list item.
17527 * @param icon The icon object to use for the left side of the item. An
17528 * icon can be any Evas object, but usually it is an icon created
17529 * with elm_icon_add().
17530 * @param end The icon object to use for the right side of the item. An
17531 * icon can be any Evas object.
17532 * @param func The function to call when the item is clicked.
17533 * @param data The data to associate with the item for related callbacks.
17535 * @return The created item or @c NULL upon failure.
17537 * A new item will be created and appended to the list, i.e., will
17538 * be set as @b last item.
17540 * Items created with this method can be deleted with
17541 * elm_list_item_del().
17543 * Associated @p data can be properly freed when item is deleted if a
17544 * callback function is set with elm_list_item_del_cb_set().
17546 * If a function is passed as argument, it will be called everytime this item
17547 * is selected, i.e., the user clicks over an unselected item.
17548 * If always select is enabled it will call this function every time
17549 * user clicks over an item (already selected or not).
17550 * If such function isn't needed, just passing
17551 * @c NULL as @p func is enough. The same should be done for @p data.
17553 * Simple example (with no function callback or data associated):
17555 * li = elm_list_add(win);
17556 * ic = elm_icon_add(win);
17557 * elm_icon_file_set(ic, "path/to/image", NULL);
17558 * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
17559 * elm_list_item_append(li, "label", ic, NULL, NULL, NULL);
17561 * evas_object_show(li);
17564 * @see elm_list_always_select_mode_set()
17565 * @see elm_list_item_del()
17566 * @see elm_list_item_del_cb_set()
17567 * @see elm_list_clear()
17568 * @see elm_icon_add()
17572 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);
17575 * Prepend a new item to the list object.
17577 * @param obj The list object.
17578 * @param label The label of the list item.
17579 * @param icon The icon object to use for the left side of the item. An
17580 * icon can be any Evas object, but usually it is an icon created
17581 * with elm_icon_add().
17582 * @param end The icon object to use for the right side of the item. An
17583 * icon can be any Evas object.
17584 * @param func The function to call when the item is clicked.
17585 * @param data The data to associate with the item for related callbacks.
17587 * @return The created item or @c NULL upon failure.
17589 * A new item will be created and prepended to the list, i.e., will
17590 * be set as @b first item.
17592 * Items created with this method can be deleted with
17593 * elm_list_item_del().
17595 * Associated @p data can be properly freed when item is deleted if a
17596 * callback function is set with elm_list_item_del_cb_set().
17598 * If a function is passed as argument, it will be called everytime this item
17599 * is selected, i.e., the user clicks over an unselected item.
17600 * If always select is enabled it will call this function every time
17601 * user clicks over an item (already selected or not).
17602 * If such function isn't needed, just passing
17603 * @c NULL as @p func is enough. The same should be done for @p data.
17605 * @see elm_list_item_append() for a simple code example.
17606 * @see elm_list_always_select_mode_set()
17607 * @see elm_list_item_del()
17608 * @see elm_list_item_del_cb_set()
17609 * @see elm_list_clear()
17610 * @see elm_icon_add()
17614 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);
17617 * Insert a new item into the list object before item @p before.
17619 * @param obj The list object.
17620 * @param before The list item to insert before.
17621 * @param label The label of the list item.
17622 * @param icon The icon object to use for the left side of the item. An
17623 * icon can be any Evas object, but usually it is an icon created
17624 * with elm_icon_add().
17625 * @param end The icon object to use for the right side of the item. An
17626 * icon can be any Evas object.
17627 * @param func The function to call when the item is clicked.
17628 * @param data The data to associate with the item for related callbacks.
17630 * @return The created item or @c NULL upon failure.
17632 * A new item will be created and added to the list. Its position in
17633 * this list will be just before item @p before.
17635 * Items created with this method can be deleted with
17636 * elm_list_item_del().
17638 * Associated @p data can be properly freed when item is deleted if a
17639 * callback function is set with elm_list_item_del_cb_set().
17641 * If a function is passed as argument, it will be called everytime this item
17642 * is selected, i.e., the user clicks over an unselected item.
17643 * If always select is enabled it will call this function every time
17644 * user clicks over an item (already selected or not).
17645 * If such function isn't needed, just passing
17646 * @c NULL as @p func is enough. The same should be done for @p data.
17648 * @see elm_list_item_append() for a simple code example.
17649 * @see elm_list_always_select_mode_set()
17650 * @see elm_list_item_del()
17651 * @see elm_list_item_del_cb_set()
17652 * @see elm_list_clear()
17653 * @see elm_icon_add()
17657 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);
17660 * Insert a new item into the list object after item @p after.
17662 * @param obj The list object.
17663 * @param after The list item to insert after.
17664 * @param label The label of the list item.
17665 * @param icon The icon object to use for the left side of the item. An
17666 * icon can be any Evas object, but usually it is an icon created
17667 * with elm_icon_add().
17668 * @param end The icon object to use for the right side of the item. An
17669 * icon can be any Evas object.
17670 * @param func The function to call when the item is clicked.
17671 * @param data The data to associate with the item for related callbacks.
17673 * @return The created item or @c NULL upon failure.
17675 * A new item will be created and added to the list. Its position in
17676 * this list will be just after item @p after.
17678 * Items created with this method can be deleted with
17679 * elm_list_item_del().
17681 * Associated @p data can be properly freed when item is deleted if a
17682 * callback function is set with elm_list_item_del_cb_set().
17684 * If a function is passed as argument, it will be called everytime this item
17685 * is selected, i.e., the user clicks over an unselected item.
17686 * If always select is enabled it will call this function every time
17687 * user clicks over an item (already selected or not).
17688 * If such function isn't needed, just passing
17689 * @c NULL as @p func is enough. The same should be done for @p data.
17691 * @see elm_list_item_append() for a simple code example.
17692 * @see elm_list_always_select_mode_set()
17693 * @see elm_list_item_del()
17694 * @see elm_list_item_del_cb_set()
17695 * @see elm_list_clear()
17696 * @see elm_icon_add()
17700 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);
17703 * Insert a new item into the sorted list object.
17705 * @param obj The list object.
17706 * @param label The label of the list item.
17707 * @param icon The icon object to use for the left side of the item. An
17708 * icon can be any Evas object, but usually it is an icon created
17709 * with elm_icon_add().
17710 * @param end The icon object to use for the right side of the item. An
17711 * icon can be any Evas object.
17712 * @param func The function to call when the item is clicked.
17713 * @param data The data to associate with the item for related callbacks.
17714 * @param cmp_func The comparing function to be used to sort list
17715 * items <b>by #Elm_List_Item item handles</b>. This function will
17716 * receive two items and compare them, returning a non-negative integer
17717 * if the second item should be place after the first, or negative value
17718 * if should be placed before.
17720 * @return The created item or @c NULL upon failure.
17722 * @note This function inserts values into a list object assuming it was
17723 * sorted and the result will be sorted.
17725 * A new item will be created and added to the list. Its position in
17726 * this list will be found comparing the new item with previously inserted
17727 * items using function @p cmp_func.
17729 * Items created with this method can be deleted with
17730 * elm_list_item_del().
17732 * Associated @p data can be properly freed when item is deleted if a
17733 * callback function is set with elm_list_item_del_cb_set().
17735 * If a function is passed as argument, it will be called everytime this item
17736 * is selected, i.e., the user clicks over an unselected item.
17737 * If always select is enabled it will call this function every time
17738 * user clicks over an item (already selected or not).
17739 * If such function isn't needed, just passing
17740 * @c NULL as @p func is enough. The same should be done for @p data.
17742 * @see elm_list_item_append() for a simple code example.
17743 * @see elm_list_always_select_mode_set()
17744 * @see elm_list_item_del()
17745 * @see elm_list_item_del_cb_set()
17746 * @see elm_list_clear()
17747 * @see elm_icon_add()
17751 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);
17754 * Remove all list's items.
17756 * @param obj The list object
17758 * @see elm_list_item_del()
17759 * @see elm_list_item_append()
17763 EAPI void elm_list_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
17766 * Get a list of all the list items.
17768 * @param obj The list object
17769 * @return An @c Eina_List of list items, #Elm_List_Item,
17770 * or @c NULL on failure.
17772 * @see elm_list_item_append()
17773 * @see elm_list_item_del()
17774 * @see elm_list_clear()
17778 EAPI const Eina_List *elm_list_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17781 * Get the selected item.
17783 * @param obj The list object.
17784 * @return The selected list item.
17786 * The selected item can be unselected with function
17787 * elm_list_item_selected_set().
17789 * The selected item always will be highlighted on list.
17791 * @see elm_list_selected_items_get()
17795 EAPI Elm_List_Item *elm_list_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17798 * Return a list of the currently selected list items.
17800 * @param obj The list object.
17801 * @return An @c Eina_List of list items, #Elm_List_Item,
17802 * or @c NULL on failure.
17804 * Multiple items can be selected if multi select is enabled. It can be
17805 * done with elm_list_multi_select_set().
17807 * @see elm_list_selected_item_get()
17808 * @see elm_list_multi_select_set()
17812 EAPI const Eina_List *elm_list_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17815 * Set the selected state of an item.
17817 * @param item The list item
17818 * @param selected The selected state
17820 * This sets the selected state of the given item @p it.
17821 * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
17823 * If a new item is selected the previosly selected will be unselected,
17824 * unless multiple selection is enabled with elm_list_multi_select_set().
17825 * Previoulsy selected item can be get with function
17826 * elm_list_selected_item_get().
17828 * Selected items will be highlighted.
17830 * @see elm_list_item_selected_get()
17831 * @see elm_list_selected_item_get()
17832 * @see elm_list_multi_select_set()
17836 EAPI void elm_list_item_selected_set(Elm_List_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
17839 * Get whether the @p item is selected or not.
17841 * @param item The list item.
17842 * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
17843 * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
17845 * @see elm_list_selected_item_set() for details.
17846 * @see elm_list_item_selected_get()
17850 EAPI Eina_Bool elm_list_item_selected_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17853 * Set or unset item as a separator.
17855 * @param it The list item.
17856 * @param setting @c EINA_TRUE to set item @p it as separator or
17857 * @c EINA_FALSE to unset, i.e., item will be used as a regular item.
17859 * Items aren't set as separator by default.
17861 * If set as separator it will display separator theme, so won't display
17864 * @see elm_list_item_separator_get()
17868 EAPI void elm_list_item_separator_set(Elm_List_Item *it, Eina_Bool setting) EINA_ARG_NONNULL(1);
17871 * Get a value whether item is a separator or not.
17873 * @see elm_list_item_separator_set() for details.
17875 * @param it The list item.
17876 * @return @c EINA_TRUE means item @p it is a separator. @c EINA_FALSE
17877 * indicates it's not. If @p it is @c NULL, @c EINA_FALSE is returned.
17881 EAPI Eina_Bool elm_list_item_separator_get(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
17884 * Show @p item in the list view.
17886 * @param item The list item to be shown.
17888 * It won't animate list until item is visible. If such behavior is wanted,
17889 * use elm_list_bring_in() intead.
17893 EAPI void elm_list_item_show(Elm_List_Item *item) EINA_ARG_NONNULL(1);
17896 * Bring in the given item to list view.
17898 * @param item The item.
17900 * This causes list to jump to the given item @p item and show it
17901 * (by scrolling), if it is not fully visible.
17903 * This may use animation to do so and take a period of time.
17905 * If animation isn't wanted, elm_list_item_show() can be used.
17909 EAPI void elm_list_item_bring_in(Elm_List_Item *item) EINA_ARG_NONNULL(1);
17912 * Delete them item from the list.
17914 * @param item The item of list to be deleted.
17916 * If deleting all list items is required, elm_list_clear()
17917 * should be used instead of getting items list and deleting each one.
17919 * @see elm_list_clear()
17920 * @see elm_list_item_append()
17921 * @see elm_list_item_del_cb_set()
17925 EAPI void elm_list_item_del(Elm_List_Item *item) EINA_ARG_NONNULL(1);
17928 * Set the function called when a list item is freed.
17930 * @param item The item to set the callback on
17931 * @param func The function called
17933 * If there is a @p func, then it will be called prior item's memory release.
17934 * That will be called with the following arguments:
17936 * @li item's Evas object;
17939 * This way, a data associated to a list item could be properly freed.
17943 EAPI void elm_list_item_del_cb_set(Elm_List_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
17946 * Get the data associated to the item.
17948 * @param item The list item
17949 * @return The data associated to @p item
17951 * The return value is a pointer to data associated to @p item when it was
17952 * created, with function elm_list_item_append() or similar. If no data
17953 * was passed as argument, it will return @c NULL.
17955 * @see elm_list_item_append()
17959 EAPI void *elm_list_item_data_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17962 * Get the left side icon associated to the item.
17964 * @param item The list item
17965 * @return The left side icon associated to @p item
17967 * The return value is a pointer to the icon associated to @p item when
17969 * created, with function elm_list_item_append() or similar, or later
17970 * with function elm_list_item_icon_set(). If no icon
17971 * was passed as argument, it will return @c NULL.
17973 * @see elm_list_item_append()
17974 * @see elm_list_item_icon_set()
17978 EAPI Evas_Object *elm_list_item_icon_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17981 * Set the left side icon associated to the item.
17983 * @param item The list item
17984 * @param icon The left side icon object to associate with @p item
17986 * The icon object to use at left side of the item. An
17987 * icon can be any Evas object, but usually it is an icon created
17988 * with elm_icon_add().
17990 * Once the icon object is set, a previously set one will be deleted.
17991 * @warning Setting the same icon for two items will cause the icon to
17992 * dissapear from the first item.
17994 * If an icon was passed as argument on item creation, with function
17995 * elm_list_item_append() or similar, it will be already
17996 * associated to the item.
17998 * @see elm_list_item_append()
17999 * @see elm_list_item_icon_get()
18003 EAPI void elm_list_item_icon_set(Elm_List_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
18006 * Get the right side icon associated to the item.
18008 * @param item The list item
18009 * @return The right side icon associated to @p item
18011 * The return value is a pointer to the icon associated to @p item when
18013 * created, with function elm_list_item_append() or similar, or later
18014 * with function elm_list_item_icon_set(). If no icon
18015 * was passed as argument, it will return @c NULL.
18017 * @see elm_list_item_append()
18018 * @see elm_list_item_icon_set()
18022 EAPI Evas_Object *elm_list_item_end_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
18025 * Set the right side icon associated to the item.
18027 * @param item The list item
18028 * @param end The right side icon object to associate with @p item
18030 * The icon object to use at right side of the item. An
18031 * icon can be any Evas object, but usually it is an icon created
18032 * with elm_icon_add().
18034 * Once the icon object is set, a previously set one will be deleted.
18035 * @warning Setting the same icon for two items will cause the icon to
18036 * dissapear from the first item.
18038 * If an icon was passed as argument on item creation, with function
18039 * elm_list_item_append() or similar, it will be already
18040 * associated to the item.
18042 * @see elm_list_item_append()
18043 * @see elm_list_item_end_get()
18047 EAPI void elm_list_item_end_set(Elm_List_Item *item, Evas_Object *end) EINA_ARG_NONNULL(1);
18050 * Gets the base object of the item.
18052 * @param item The list item
18053 * @return The base object associated with @p item
18055 * Base object is the @c Evas_Object that represents that item.
18059 EAPI Evas_Object *elm_list_item_object_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
18060 EINA_DEPRECATED EAPI Evas_Object *elm_list_item_base_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
18063 * Get the label of item.
18065 * @param item The item of list.
18066 * @return The label of item.
18068 * The return value is a pointer to the label associated to @p item when
18069 * it was created, with function elm_list_item_append(), or later
18070 * with function elm_list_item_label_set. If no label
18071 * was passed as argument, it will return @c NULL.
18073 * @see elm_list_item_label_set() for more details.
18074 * @see elm_list_item_append()
18078 EAPI const char *elm_list_item_label_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
18081 * Set the label of item.
18083 * @param item The item of list.
18084 * @param text The label of item.
18086 * The label to be displayed by the item.
18087 * Label will be placed between left and right side icons (if set).
18089 * If a label was passed as argument on item creation, with function
18090 * elm_list_item_append() or similar, it will be already
18091 * displayed by the item.
18093 * @see elm_list_item_label_get()
18094 * @see elm_list_item_append()
18098 EAPI void elm_list_item_label_set(Elm_List_Item *item, const char *text) EINA_ARG_NONNULL(1);
18101 * Get the item before @p it in list.
18103 * @param it The list item.
18104 * @return The item before @p it, or @c NULL if none or on failure.
18106 * @note If it is the first item, @c NULL will be returned.
18108 * @see elm_list_item_append()
18109 * @see elm_list_items_get()
18113 EAPI Elm_List_Item *elm_list_item_prev(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
18116 * Get the item after @p it in list.
18118 * @param it The list item.
18119 * @return The item after @p it, or @c NULL if none or on failure.
18121 * @note If it is the last item, @c NULL will be returned.
18123 * @see elm_list_item_append()
18124 * @see elm_list_items_get()
18128 EAPI Elm_List_Item *elm_list_item_next(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
18131 * Sets the disabled/enabled state of a list item.
18133 * @param it The item.
18134 * @param disabled The disabled state.
18136 * A disabled item cannot be selected or unselected. It will also
18137 * change its appearance (generally greyed out). This sets the
18138 * disabled state (@c EINA_TRUE for disabled, @c EINA_FALSE for
18143 EAPI void elm_list_item_disabled_set(Elm_List_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1);
18146 * Get a value whether list item is disabled or not.
18148 * @param it The item.
18149 * @return The disabled state.
18151 * @see elm_list_item_disabled_set() for more details.
18155 EAPI Eina_Bool elm_list_item_disabled_get(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
18158 * Set the text to be shown in a given list item's tooltips.
18160 * @param item Target item.
18161 * @param text The text to set in the content.
18163 * Setup the text as tooltip to object. The item can have only one tooltip,
18164 * so any previous tooltip data - set with this function or
18165 * elm_list_item_tooltip_content_cb_set() - is removed.
18167 * @see elm_object_tooltip_text_set() for more details.
18171 EAPI void elm_list_item_tooltip_text_set(Elm_List_Item *item, const char *text) EINA_ARG_NONNULL(1);
18174 * @brief Disable size restrictions on an object's tooltip
18175 * @param item The tooltip's anchor object
18176 * @param disable If EINA_TRUE, size restrictions are disabled
18177 * @return EINA_FALSE on failure, EINA_TRUE on success
18179 * This function allows a tooltip to expand beyond its parant window's canvas.
18180 * It will instead be limited only by the size of the display.
18182 EAPI Eina_Bool elm_list_item_tooltip_window_mode_set(Elm_List_Item *item, Eina_Bool disable) EINA_ARG_NONNULL(1);
18184 * @brief Retrieve size restriction state of an object's tooltip
18185 * @param obj The tooltip's anchor object
18186 * @return If EINA_TRUE, size restrictions are disabled
18188 * This function returns whether a tooltip is allowed to expand beyond
18189 * its parant window's canvas.
18190 * It will instead be limited only by the size of the display.
18192 EAPI Eina_Bool elm_list_item_tooltip_window_mode_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
18195 * Set the content to be shown in the tooltip item.
18197 * Setup the tooltip to item. The item can have only one tooltip,
18198 * so any previous tooltip data is removed. @p func(with @p data) will
18199 * be called every time that need show the tooltip and it should
18200 * return a valid Evas_Object. This object is then managed fully by
18201 * tooltip system and is deleted when the tooltip is gone.
18203 * @param item the list item being attached a tooltip.
18204 * @param func the function used to create the tooltip contents.
18205 * @param data what to provide to @a func as callback data/context.
18206 * @param del_cb called when data is not needed anymore, either when
18207 * another callback replaces @a func, the tooltip is unset with
18208 * elm_list_item_tooltip_unset() or the owner @a item
18209 * dies. This callback receives as the first parameter the
18210 * given @a data, and @c event_info is the item.
18212 * @see elm_object_tooltip_content_cb_set() for more details.
18216 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);
18219 * Unset tooltip from item.
18221 * @param item list item to remove previously set tooltip.
18223 * Remove tooltip from item. The callback provided as del_cb to
18224 * elm_list_item_tooltip_content_cb_set() will be called to notify
18225 * it is not used anymore.
18227 * @see elm_object_tooltip_unset() for more details.
18228 * @see elm_list_item_tooltip_content_cb_set()
18232 EAPI void elm_list_item_tooltip_unset(Elm_List_Item *item) EINA_ARG_NONNULL(1);
18235 * Sets a different style for this item tooltip.
18237 * @note before you set a style you should define a tooltip with
18238 * elm_list_item_tooltip_content_cb_set() or
18239 * elm_list_item_tooltip_text_set()
18241 * @param item list item with tooltip already set.
18242 * @param style the theme style to use (default, transparent, ...)
18244 * @see elm_object_tooltip_style_set() for more details.
18248 EAPI void elm_list_item_tooltip_style_set(Elm_List_Item *item, const char *style) EINA_ARG_NONNULL(1);
18251 * Get the style for this item tooltip.
18253 * @param item list item with tooltip already set.
18254 * @return style the theme style in use, defaults to "default". If the
18255 * object does not have a tooltip set, then NULL is returned.
18257 * @see elm_object_tooltip_style_get() for more details.
18258 * @see elm_list_item_tooltip_style_set()
18262 EAPI const char *elm_list_item_tooltip_style_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
18265 * Set the type of mouse pointer/cursor decoration to be shown,
18266 * when the mouse pointer is over the given list widget item
18268 * @param item list item to customize cursor on
18269 * @param cursor the cursor type's name
18271 * This function works analogously as elm_object_cursor_set(), but
18272 * here the cursor's changing area is restricted to the item's
18273 * area, and not the whole widget's. Note that that item cursors
18274 * have precedence over widget cursors, so that a mouse over an
18275 * item with custom cursor set will always show @b that cursor.
18277 * If this function is called twice for an object, a previously set
18278 * cursor will be unset on the second call.
18280 * @see elm_object_cursor_set()
18281 * @see elm_list_item_cursor_get()
18282 * @see elm_list_item_cursor_unset()
18286 EAPI void elm_list_item_cursor_set(Elm_List_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
18289 * Get the type of mouse pointer/cursor decoration set to be shown,
18290 * when the mouse pointer is over the given list widget item
18292 * @param item list item with custom cursor set
18293 * @return the cursor type's name or @c NULL, if no custom cursors
18294 * were set to @p item (and on errors)
18296 * @see elm_object_cursor_get()
18297 * @see elm_list_item_cursor_set()
18298 * @see elm_list_item_cursor_unset()
18302 EAPI const char *elm_list_item_cursor_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
18305 * Unset any custom mouse pointer/cursor decoration set to be
18306 * shown, when the mouse pointer is over the given list widget
18307 * item, thus making it show the @b default cursor again.
18309 * @param item a list item
18311 * Use this call to undo any custom settings on this item's cursor
18312 * decoration, bringing it back to defaults (no custom style set).
18314 * @see elm_object_cursor_unset()
18315 * @see elm_list_item_cursor_set()
18319 EAPI void elm_list_item_cursor_unset(Elm_List_Item *item) EINA_ARG_NONNULL(1);
18322 * Set a different @b style for a given custom cursor set for a
18325 * @param item list item with custom cursor set
18326 * @param style the <b>theme style</b> to use (e.g. @c "default",
18327 * @c "transparent", etc)
18329 * This function only makes sense when one is using custom mouse
18330 * cursor decorations <b>defined in a theme file</b>, which can have,
18331 * given a cursor name/type, <b>alternate styles</b> on it. It
18332 * works analogously as elm_object_cursor_style_set(), but here
18333 * applyed only to list item objects.
18335 * @warning Before you set a cursor style you should have definen a
18336 * custom cursor previously on the item, with
18337 * elm_list_item_cursor_set()
18339 * @see elm_list_item_cursor_engine_only_set()
18340 * @see elm_list_item_cursor_style_get()
18344 EAPI void elm_list_item_cursor_style_set(Elm_List_Item *item, const char *style) EINA_ARG_NONNULL(1);
18347 * Get the current @b style set for a given list item's custom
18350 * @param item list item with custom cursor set.
18351 * @return style the cursor style in use. If the object does not
18352 * have a cursor set, then @c NULL is returned.
18354 * @see elm_list_item_cursor_style_set() for more details
18358 EAPI const char *elm_list_item_cursor_style_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
18361 * Set if the (custom)cursor for a given list item should be
18362 * searched in its theme, also, or should only rely on the
18363 * rendering engine.
18365 * @param item item with custom (custom) cursor already set on
18366 * @param engine_only Use @c EINA_TRUE to have cursors looked for
18367 * only on those provided by the rendering engine, @c EINA_FALSE to
18368 * have them searched on the widget's theme, as well.
18370 * @note This call is of use only if you've set a custom cursor
18371 * for list items, with elm_list_item_cursor_set().
18373 * @note By default, cursors will only be looked for between those
18374 * provided by the rendering engine.
18378 EAPI void elm_list_item_cursor_engine_only_set(Elm_List_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
18381 * Get if the (custom) cursor for a given list item is being
18382 * searched in its theme, also, or is only relying on the rendering
18385 * @param item a list item
18386 * @return @c EINA_TRUE, if cursors are being looked for only on
18387 * those provided by the rendering engine, @c EINA_FALSE if they
18388 * are being searched on the widget's theme, as well.
18390 * @see elm_list_item_cursor_engine_only_set(), for more details
18394 EAPI Eina_Bool elm_list_item_cursor_engine_only_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
18401 * @defgroup Slider Slider
18402 * @ingroup Elementary
18404 * @image html img/widget/slider/preview-00.png
18405 * @image latex img/widget/slider/preview-00.eps width=\textwidth
18407 * The slider adds a dragable āsliderā widget for selecting the value of
18408 * something within a range.
18410 * A slider can be horizontal or vertical. It can contain an Icon and has a
18411 * primary label as well as a units label (that is formatted with floating
18412 * point values and thus accepts a printf-style format string, like
18413 * ā%1.2f unitsā. There is also an indicator string that may be somewhere
18414 * else (like on the slider itself) that also accepts a format string like
18415 * units. Label, Icon Unit and Indicator strings/objects are optional.
18417 * A slider may be inverted which means values invert, with high vales being
18418 * on the left or top and low values on the right or bottom (as opposed to
18419 * normally being low on the left or top and high on the bottom and right).
18421 * The slider should have its minimum and maximum values set by the
18422 * application with elm_slider_min_max_set() and value should also be set by
18423 * the application before use with elm_slider_value_set(). The span of the
18424 * slider is its length (horizontally or vertically). This will be scaled by
18425 * the object or applications scaling factor. At any point code can query the
18426 * slider for its value with elm_slider_value_get().
18428 * Smart callbacks one can listen to:
18429 * - "changed" - Whenever the slider value is changed by the user.
18430 * - "slider,drag,start" - dragging the slider indicator around has started.
18431 * - "slider,drag,stop" - dragging the slider indicator around has stopped.
18432 * - "delay,changed" - A short time after the value is changed by the user.
18433 * This will be called only when the user stops dragging for
18434 * a very short period or when they release their
18435 * finger/mouse, so it avoids possibly expensive reactions to
18436 * the value change.
18438 * Available styles for it:
18441 * Default contents parts of the slider widget that you can use for are:
18442 * @li "icon" - An icon of the slider
18443 * @li "end" - A end part content of the slider
18445 * Default text parts of the silder widget that you can use for are:
18446 * @li "default" - Label of the silder
18447 * Here is an example on its usage:
18448 * @li @ref slider_example
18452 * @addtogroup Slider
18457 * Add a new slider widget to the given parent Elementary
18458 * (container) object.
18460 * @param parent The parent object.
18461 * @return a new slider widget handle or @c NULL, on errors.
18463 * This function inserts a new slider widget on the canvas.
18467 EAPI Evas_Object *elm_slider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
18470 * Set the label of a given slider widget
18472 * @param obj The progress bar object
18473 * @param label The text label string, in UTF-8
18476 * @deprecated use elm_object_text_set() instead.
18478 EINA_DEPRECATED EAPI void elm_slider_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
18481 * Get the label of a given slider widget
18483 * @param obj The progressbar object
18484 * @return The text label string, in UTF-8
18487 * @deprecated use elm_object_text_get() instead.
18489 EINA_DEPRECATED EAPI const char *elm_slider_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18492 * Set the icon object of the slider object.
18494 * @param obj The slider object.
18495 * @param icon The icon object.
18497 * On horizontal mode, icon is placed at left, and on vertical mode,
18500 * @note Once the icon object is set, a previously set one will be deleted.
18501 * If you want to keep that old content object, use the
18502 * elm_slider_icon_unset() function.
18504 * @warning If the object being set does not have minimum size hints set,
18505 * it won't get properly displayed.
18508 * @deprecated use elm_object_part_content_set() instead.
18510 EINA_DEPRECATED EAPI void elm_slider_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
18513 * Unset an icon set on a given slider widget.
18515 * @param obj The slider object.
18516 * @return The icon object that was being used, if any was set, or
18517 * @c NULL, otherwise (and on errors).
18519 * On horizontal mode, icon is placed at left, and on vertical mode,
18522 * This call will unparent and return the icon object which was set
18523 * for this widget, previously, on success.
18525 * @see elm_slider_icon_set() for more details
18526 * @see elm_slider_icon_get()
18527 * @deprecated use elm_object_part_content_unset() instead.
18531 EINA_DEPRECATED EAPI Evas_Object *elm_slider_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
18534 * Retrieve the icon object set for a given slider widget.
18536 * @param obj The slider object.
18537 * @return The icon object's handle, if @p obj had one set, or @c NULL,
18538 * otherwise (and on errors).
18540 * On horizontal mode, icon is placed at left, and on vertical mode,
18543 * @see elm_slider_icon_set() for more details
18544 * @see elm_slider_icon_unset()
18546 * @deprecated use elm_object_part_content_get() instead.
18550 EINA_DEPRECATED EAPI Evas_Object *elm_slider_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18553 * Set the end object of the slider object.
18555 * @param obj The slider object.
18556 * @param end The end object.
18558 * On horizontal mode, end is placed at left, and on vertical mode,
18559 * placed at bottom.
18561 * @note Once the icon object is set, a previously set one will be deleted.
18562 * If you want to keep that old content object, use the
18563 * elm_slider_end_unset() function.
18565 * @warning If the object being set does not have minimum size hints set,
18566 * it won't get properly displayed.
18568 * @deprecated use elm_object_part_content_set() instead.
18572 EINA_DEPRECATED EAPI void elm_slider_end_set(Evas_Object *obj, Evas_Object *end) EINA_ARG_NONNULL(1);
18575 * Unset an end object set on a given slider widget.
18577 * @param obj The slider object.
18578 * @return The end object that was being used, if any was set, or
18579 * @c NULL, otherwise (and on errors).
18581 * On horizontal mode, end is placed at left, and on vertical mode,
18582 * placed at bottom.
18584 * This call will unparent and return the icon object which was set
18585 * for this widget, previously, on success.
18587 * @see elm_slider_end_set() for more details.
18588 * @see elm_slider_end_get()
18590 * @deprecated use elm_object_part_content_unset() instead
18595 EINA_DEPRECATED EAPI Evas_Object *elm_slider_end_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
18598 * Retrieve the end object set for a given slider widget.
18600 * @param obj The slider object.
18601 * @return The end object's handle, if @p obj had one set, or @c NULL,
18602 * otherwise (and on errors).
18604 * On horizontal mode, icon is placed at right, and on vertical mode,
18605 * placed at bottom.
18607 * @see elm_slider_end_set() for more details.
18608 * @see elm_slider_end_unset()
18611 * @deprecated use elm_object_part_content_get() instead
18616 EINA_DEPRECATED EAPI Evas_Object *elm_slider_end_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18619 * Set the (exact) length of the bar region of a given slider widget.
18621 * @param obj The slider object.
18622 * @param size The length of the slider's bar region.
18624 * This sets the minimum width (when in horizontal mode) or height
18625 * (when in vertical mode) of the actual bar area of the slider
18626 * @p obj. This in turn affects the object's minimum size. Use
18627 * this when you're not setting other size hints expanding on the
18628 * given direction (like weight and alignment hints) and you would
18629 * like it to have a specific size.
18631 * @note Icon, end, label, indicator and unit text around @p obj
18632 * will require their
18633 * own space, which will make @p obj to require more the @p size,
18636 * @see elm_slider_span_size_get()
18640 EAPI void elm_slider_span_size_set(Evas_Object *obj, Evas_Coord size) EINA_ARG_NONNULL(1);
18643 * Get the length set for the bar region of a given slider widget
18645 * @param obj The slider object.
18646 * @return The length of the slider's bar region.
18648 * If that size was not set previously, with
18649 * elm_slider_span_size_set(), this call will return @c 0.
18653 EAPI Evas_Coord elm_slider_span_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18656 * Set the format string for the unit label.
18658 * @param obj The slider object.
18659 * @param format The format string for the unit display.
18661 * Unit label is displayed all the time, if set, after slider's bar.
18662 * In horizontal mode, at right and in vertical mode, at bottom.
18664 * If @c NULL, unit label won't be visible. If not it sets the format
18665 * string for the label text. To the label text is provided a floating point
18666 * value, so the label text can display up to 1 floating point value.
18667 * Note that this is optional.
18669 * Use a format string such as "%1.2f meters" for example, and it will
18670 * display values like: "3.14 meters" for a value equal to 3.14159.
18672 * Default is unit label disabled.
18674 * @see elm_slider_indicator_format_get()
18678 EAPI void elm_slider_unit_format_set(Evas_Object *obj, const char *format) EINA_ARG_NONNULL(1);
18681 * Get the unit label format of the slider.
18683 * @param obj The slider object.
18684 * @return The unit label format string in UTF-8.
18686 * Unit label is displayed all the time, if set, after slider's bar.
18687 * In horizontal mode, at right and in vertical mode, at bottom.
18689 * @see elm_slider_unit_format_set() for more
18690 * information on how this works.
18694 EAPI const char *elm_slider_unit_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18697 * Set the format string for the indicator label.
18699 * @param obj The slider object.
18700 * @param indicator The format string for the indicator display.
18702 * The slider may display its value somewhere else then unit label,
18703 * for example, above the slider knob that is dragged around. This function
18704 * sets the format string used for this.
18706 * If @c NULL, indicator label won't be visible. If not it sets the format
18707 * string for the label text. To the label text is provided a floating point
18708 * value, so the label text can display up to 1 floating point value.
18709 * Note that this is optional.
18711 * Use a format string such as "%1.2f meters" for example, and it will
18712 * display values like: "3.14 meters" for a value equal to 3.14159.
18714 * Default is indicator label disabled.
18716 * @see elm_slider_indicator_format_get()
18720 EAPI void elm_slider_indicator_format_set(Evas_Object *obj, const char *indicator) EINA_ARG_NONNULL(1);
18723 * Get the indicator label format of the slider.
18725 * @param obj The slider object.
18726 * @return The indicator label format string in UTF-8.
18728 * The slider may display its value somewhere else then unit label,
18729 * for example, above the slider knob that is dragged around. This function
18730 * gets the format string used for this.
18732 * @see elm_slider_indicator_format_set() for more
18733 * information on how this works.
18737 EAPI const char *elm_slider_indicator_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18740 * Set the format function pointer for the indicator label
18742 * @param obj The slider object.
18743 * @param func The indicator format function.
18744 * @param free_func The freeing function for the format string.
18746 * Set the callback function to format the indicator string.
18748 * @see elm_slider_indicator_format_set() for more info on how this works.
18752 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);
18755 * Set the format function pointer for the units label
18757 * @param obj The slider object.
18758 * @param func The units format function.
18759 * @param free_func The freeing function for the format string.
18761 * Set the callback function to format the indicator string.
18763 * @see elm_slider_units_format_set() for more info on how this works.
18767 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);
18770 * Set the orientation of a given slider widget.
18772 * @param obj The slider object.
18773 * @param horizontal Use @c EINA_TRUE to make @p obj to be
18774 * @b horizontal, @c EINA_FALSE to make it @b vertical.
18776 * Use this function to change how your slider is to be
18777 * disposed: vertically or horizontally.
18779 * By default it's displayed horizontally.
18781 * @see elm_slider_horizontal_get()
18785 EAPI void elm_slider_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
18788 * Retrieve the orientation of a given slider widget
18790 * @param obj The slider object.
18791 * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
18792 * @c EINA_FALSE if it's @b vertical (and on errors).
18794 * @see elm_slider_horizontal_set() for more details.
18798 EAPI Eina_Bool elm_slider_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18801 * Set the minimum and maximum values for the slider.
18803 * @param obj The slider object.
18804 * @param min The minimum value.
18805 * @param max The maximum value.
18807 * Define the allowed range of values to be selected by the user.
18809 * If actual value is less than @p min, it will be updated to @p min. If it
18810 * is bigger then @p max, will be updated to @p max. Actual value can be
18811 * get with elm_slider_value_get().
18813 * By default, min is equal to 0.0, and max is equal to 1.0.
18815 * @warning Maximum must be greater than minimum, otherwise behavior
18818 * @see elm_slider_min_max_get()
18822 EAPI void elm_slider_min_max_set(Evas_Object *obj, double min, double max) EINA_ARG_NONNULL(1);
18825 * Get the minimum and maximum values of the slider.
18827 * @param obj The slider object.
18828 * @param min Pointer where to store the minimum value.
18829 * @param max Pointer where to store the maximum value.
18831 * @note If only one value is needed, the other pointer can be passed
18834 * @see elm_slider_min_max_set() for details.
18838 EAPI void elm_slider_min_max_get(const Evas_Object *obj, double *min, double *max) EINA_ARG_NONNULL(1);
18841 * Set the value the slider displays.
18843 * @param obj The slider object.
18844 * @param val The value to be displayed.
18846 * Value will be presented on the unit label following format specified with
18847 * elm_slider_unit_format_set() and on indicator with
18848 * elm_slider_indicator_format_set().
18850 * @warning The value must to be between min and max values. This values
18851 * are set by elm_slider_min_max_set().
18853 * @see elm_slider_value_get()
18854 * @see elm_slider_unit_format_set()
18855 * @see elm_slider_indicator_format_set()
18856 * @see elm_slider_min_max_set()
18860 EAPI void elm_slider_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
18863 * Get the value displayed by the spinner.
18865 * @param obj The spinner object.
18866 * @return The value displayed.
18868 * @see elm_spinner_value_set() for details.
18872 EAPI double elm_slider_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18875 * Invert a given slider widget's displaying values order
18877 * @param obj The slider object.
18878 * @param inverted Use @c EINA_TRUE to make @p obj inverted,
18879 * @c EINA_FALSE to bring it back to default, non-inverted values.
18881 * A slider may be @b inverted, in which state it gets its
18882 * values inverted, with high vales being on the left or top and
18883 * low values on the right or bottom, as opposed to normally have
18884 * the low values on the former and high values on the latter,
18885 * respectively, for horizontal and vertical modes.
18887 * @see elm_slider_inverted_get()
18891 EAPI void elm_slider_inverted_set(Evas_Object *obj, Eina_Bool inverted) EINA_ARG_NONNULL(1);
18894 * Get whether a given slider widget's displaying values are
18897 * @param obj The slider object.
18898 * @return @c EINA_TRUE, if @p obj has inverted values,
18899 * @c EINA_FALSE otherwise (and on errors).
18901 * @see elm_slider_inverted_set() for more details.
18905 EAPI Eina_Bool elm_slider_inverted_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18908 * Set whether to enlarge slider indicator (augmented knob) or not.
18910 * @param obj The slider object.
18911 * @param show @c EINA_TRUE will make it enlarge, @c EINA_FALSE will
18912 * let the knob always at default size.
18914 * By default, indicator will be bigger while dragged by the user.
18916 * @warning It won't display values set with
18917 * elm_slider_indicator_format_set() if you disable indicator.
18921 EAPI void elm_slider_indicator_show_set(Evas_Object *obj, Eina_Bool show) EINA_ARG_NONNULL(1);
18924 * Get whether a given slider widget's enlarging indicator or not.
18926 * @param obj The slider object.
18927 * @return @c EINA_TRUE, if @p obj is enlarging indicator, or
18928 * @c EINA_FALSE otherwise (and on errors).
18930 * @see elm_slider_indicator_show_set() for details.
18934 EAPI Eina_Bool elm_slider_indicator_show_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18941 * @addtogroup Actionslider Actionslider
18943 * @image html img/widget/actionslider/preview-00.png
18944 * @image latex img/widget/actionslider/preview-00.eps
18946 * An actionslider is a switcher for 2 or 3 labels with customizable magnet
18947 * properties. The user drags and releases the indicator, to choose a label.
18949 * Labels occupy the following positions.
18954 * Positions can be enabled or disabled.
18956 * Magnets can be set on the above positions.
18958 * When the indicator is released, it will move to its nearest "enabled and magnetized" position.
18960 * @note By default all positions are set as enabled.
18962 * Signals that you can add callbacks for are:
18964 * "selected" - when user selects an enabled position (the label is passed
18967 * "pos_changed" - when the indicator reaches any of the positions("left",
18968 * "right" or "center").
18970 * See an example of actionslider usage @ref actionslider_example_page "here"
18973 typedef enum _Elm_Actionslider_Pos
18975 ELM_ACTIONSLIDER_NONE = 0,
18976 ELM_ACTIONSLIDER_LEFT = 1 << 0,
18977 ELM_ACTIONSLIDER_CENTER = 1 << 1,
18978 ELM_ACTIONSLIDER_RIGHT = 1 << 2,
18979 ELM_ACTIONSLIDER_ALL = (1 << 3) -1
18980 } Elm_Actionslider_Pos;
18983 * Add a new actionslider to the parent.
18985 * @param parent The parent object
18986 * @return The new actionslider object or NULL if it cannot be created
18988 EAPI Evas_Object *elm_actionslider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
18991 * Set actionslider labels.
18993 * @param obj The actionslider object
18994 * @param left_label The label to be set on the left.
18995 * @param center_label The label to be set on the center.
18996 * @param right_label The label to be set on the right.
18997 * @deprecated use elm_object_text_set() instead.
18999 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);
19002 * Get actionslider labels.
19004 * @param obj The actionslider object
19005 * @param left_label A char** to place the left_label of @p obj into.
19006 * @param center_label A char** to place the center_label of @p obj into.
19007 * @param right_label A char** to place the right_label of @p obj into.
19008 * @deprecated use elm_object_text_set() instead.
19010 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);
19013 * Get actionslider selected label.
19015 * @param obj The actionslider object
19016 * @return The selected label
19018 EAPI const char *elm_actionslider_selected_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19021 * Set actionslider indicator position.
19023 * @param obj The actionslider object.
19024 * @param pos The position of the indicator.
19026 EAPI void elm_actionslider_indicator_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
19029 * Get actionslider indicator position.
19031 * @param obj The actionslider object.
19032 * @return The position of the indicator.
19034 EAPI Elm_Actionslider_Pos elm_actionslider_indicator_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19037 * Set actionslider magnet position. To make multiple positions magnets @c or
19038 * them together(e.g.: ELM_ACTIONSLIDER_LEFT | ELM_ACTIONSLIDER_RIGHT)
19040 * @param obj The actionslider object.
19041 * @param pos Bit mask indicating the magnet positions.
19043 EAPI void elm_actionslider_magnet_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
19046 * Get actionslider magnet position.
19048 * @param obj The actionslider object.
19049 * @return The positions with magnet property.
19051 EAPI Elm_Actionslider_Pos elm_actionslider_magnet_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19054 * Set actionslider enabled position. To set multiple positions as enabled @c or
19055 * them together(e.g.: ELM_ACTIONSLIDER_LEFT | ELM_ACTIONSLIDER_RIGHT).
19057 * @note All the positions are enabled by default.
19059 * @param obj The actionslider object.
19060 * @param pos Bit mask indicating the enabled positions.
19062 EAPI void elm_actionslider_enabled_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
19065 * Get actionslider enabled position.
19067 * @param obj The actionslider object.
19068 * @return The enabled positions.
19070 EAPI Elm_Actionslider_Pos elm_actionslider_enabled_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19073 * Set the label used on the indicator.
19075 * @param obj The actionslider object
19076 * @param label The label to be set on the indicator.
19077 * @deprecated use elm_object_text_set() instead.
19079 EINA_DEPRECATED EAPI void elm_actionslider_indicator_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
19082 * Get the label used on the indicator object.
19084 * @param obj The actionslider object
19085 * @return The indicator label
19086 * @deprecated use elm_object_text_get() instead.
19088 EINA_DEPRECATED EAPI const char *elm_actionslider_indicator_label_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
19095 * @defgroup Genlist Genlist
19097 * @image html img/widget/genlist/preview-00.png
19098 * @image latex img/widget/genlist/preview-00.eps
19099 * @image html img/genlist.png
19100 * @image latex img/genlist.eps
19102 * This widget aims to have more expansive list than the simple list in
19103 * Elementary that could have more flexible items and allow many more entries
19104 * while still being fast and low on memory usage. At the same time it was
19105 * also made to be able to do tree structures. But the price to pay is more
19106 * complexity when it comes to usage. If all you want is a simple list with
19107 * icons and a single text, use the normal @ref List object.
19109 * Genlist has a fairly large API, mostly because it's relatively complex,
19110 * trying to be both expansive, powerful and efficient. First we will begin
19111 * an overview on the theory behind genlist.
19113 * @section Genlist_Item_Class Genlist item classes - creating items
19115 * In order to have the ability to add and delete items on the fly, genlist
19116 * implements a class (callback) system where the application provides a
19117 * structure with information about that type of item (genlist may contain
19118 * multiple different items with different classes, states and styles).
19119 * Genlist will call the functions in this struct (methods) when an item is
19120 * "realized" (i.e., created dynamically, while the user is scrolling the
19121 * grid). All objects will simply be deleted when no longer needed with
19122 * evas_object_del(). The #Elm_Genlist_Item_Class structure contains the
19123 * following members:
19124 * - @c item_style - This is a constant string and simply defines the name
19125 * of the item style. It @b must be specified and the default should be @c
19128 * - @c func - A struct with pointers to functions that will be called when
19129 * an item is going to be actually created. All of them receive a @c data
19130 * parameter that will point to the same data passed to
19131 * elm_genlist_item_append() and related item creation functions, and a @c
19132 * obj parameter that points to the genlist object itself.
19134 * The function pointers inside @c func are @c text_get, @c content_get, @c
19135 * state_get and @c del. The 3 first functions also receive a @c part
19136 * parameter described below. A brief description of these functions follows:
19138 * - @c text_get - The @c part parameter is the name string of one of the
19139 * existing text parts in the Edje group implementing the item's theme.
19140 * This function @b must return a strdup'()ed string, as the caller will
19141 * free() it when done. See #Elm_Genlist_Item_Text_Get_Cb.
19142 * - @c content_get - The @c part parameter is the name string of one of the
19143 * existing (content) swallow parts in the Edje group implementing the item's
19144 * theme. It must return @c NULL, when no content is desired, or a valid
19145 * object handle, otherwise. The object will be deleted by the genlist on
19146 * its deletion or when the item is "unrealized". See
19147 * #Elm_Genlist_Item_Content_Get_Cb.
19148 * - @c func.state_get - The @c part parameter is the name string of one of
19149 * the state parts in the Edje group implementing the item's theme. Return
19150 * @c EINA_FALSE for false/off or @c EINA_TRUE for true/on. Genlists will
19151 * emit a signal to its theming Edje object with @c "elm,state,XXX,active"
19152 * and @c "elm" as "emission" and "source" arguments, respectively, when
19153 * the state is true (the default is false), where @c XXX is the name of
19154 * the (state) part. See #Elm_Genlist_Item_State_Get_Cb.
19155 * - @c func.del - This is intended for use when genlist items are deleted,
19156 * so any data attached to the item (e.g. its data parameter on creation)
19157 * can be deleted. See #Elm_Genlist_Item_Del_Cb.
19159 * available item styles:
19161 * - default_style - The text part is a textblock
19163 * @image html img/widget/genlist/preview-04.png
19164 * @image latex img/widget/genlist/preview-04.eps
19168 * @image html img/widget/genlist/preview-01.png
19169 * @image latex img/widget/genlist/preview-01.eps
19171 * - icon_top_text_bottom
19173 * @image html img/widget/genlist/preview-02.png
19174 * @image latex img/widget/genlist/preview-02.eps
19178 * @image html img/widget/genlist/preview-03.png
19179 * @image latex img/widget/genlist/preview-03.eps
19181 * @section Genlist_Items Structure of items
19183 * An item in a genlist can have 0 or more texts (they can be regular
19184 * text or textblock Evas objects - that's up to the style to determine), 0
19185 * or more contents (which are simply objects swallowed into the genlist item's
19186 * theming Edje object) and 0 or more <b>boolean states</b>, which have the
19187 * behavior left to the user to define. The Edje part names for each of
19188 * these properties will be looked up, in the theme file for the genlist,
19189 * under the Edje (string) data items named @c "labels", @c "contents" and @c
19190 * "states", respectively. For each of those properties, if more than one
19191 * part is provided, they must have names listed separated by spaces in the
19192 * data fields. For the default genlist item theme, we have @b one text
19193 * part (@c "elm.text"), @b two content parts (@c "elm.swalllow.icon" and @c
19194 * "elm.swallow.end") and @b no state parts.
19196 * A genlist item may be at one of several styles. Elementary provides one
19197 * by default - "default", but this can be extended by system or application
19198 * custom themes/overlays/extensions (see @ref Theme "themes" for more
19201 * @section Genlist_Manipulation Editing and Navigating
19203 * Items can be added by several calls. All of them return a @ref
19204 * Elm_Genlist_Item handle that is an internal member inside the genlist.
19205 * They all take a data parameter that is meant to be used for a handle to
19206 * the applications internal data (eg the struct with the original item
19207 * data). The parent parameter is the parent genlist item this belongs to if
19208 * it is a tree or an indexed group, and NULL if there is no parent. The
19209 * flags can be a bitmask of #ELM_GENLIST_ITEM_NONE,
19210 * #ELM_GENLIST_ITEM_SUBITEMS and #ELM_GENLIST_ITEM_GROUP. If
19211 * #ELM_GENLIST_ITEM_SUBITEMS is set then this item is displayed as an item
19212 * that is able to expand and have child items. If ELM_GENLIST_ITEM_GROUP
19213 * is set then this item is group index item that is displayed at the top
19214 * until the next group comes. The func parameter is a convenience callback
19215 * that is called when the item is selected and the data parameter will be
19216 * the func_data parameter, obj be the genlist object and event_info will be
19217 * the genlist item.
19219 * elm_genlist_item_append() adds an item to the end of the list, or if
19220 * there is a parent, to the end of all the child items of the parent.
19221 * elm_genlist_item_prepend() is the same but adds to the beginning of
19222 * the list or children list. elm_genlist_item_insert_before() inserts at
19223 * item before another item and elm_genlist_item_insert_after() inserts after
19224 * the indicated item.
19226 * The application can clear the list with elm_genlist_clear() which deletes
19227 * all the items in the list and elm_genlist_item_del() will delete a specific
19228 * item. elm_genlist_item_subitems_clear() will clear all items that are
19229 * children of the indicated parent item.
19231 * To help inspect list items you can jump to the item at the top of the list
19232 * with elm_genlist_first_item_get() which will return the item pointer, and
19233 * similarly elm_genlist_last_item_get() gets the item at the end of the list.
19234 * elm_genlist_item_next_get() and elm_genlist_item_prev_get() get the next
19235 * and previous items respectively relative to the indicated item. Using
19236 * these calls you can walk the entire item list/tree. Note that as a tree
19237 * the items are flattened in the list, so elm_genlist_item_parent_get() will
19238 * let you know which item is the parent (and thus know how to skip them if
19241 * @section Genlist_Muti_Selection Multi-selection
19243 * If the application wants multiple items to be able to be selected,
19244 * elm_genlist_multi_select_set() can enable this. If the list is
19245 * single-selection only (the default), then elm_genlist_selected_item_get()
19246 * will return the selected item, if any, or NULL if none is selected. If the
19247 * list is multi-select then elm_genlist_selected_items_get() will return a
19248 * list (that is only valid as long as no items are modified (added, deleted,
19249 * selected or unselected)).
19251 * @section Genlist_Usage_Hints Usage hints
19253 * There are also convenience functions. elm_genlist_item_genlist_get() will
19254 * return the genlist object the item belongs to. elm_genlist_item_show()
19255 * will make the scroller scroll to show that specific item so its visible.
19256 * elm_genlist_item_data_get() returns the data pointer set by the item
19257 * creation functions.
19259 * If an item changes (state of boolean changes, text or contents change),
19260 * then use elm_genlist_item_update() to have genlist update the item with
19261 * the new state. Genlist will re-realize the item thus call the functions
19262 * in the _Elm_Genlist_Item_Class for that item.
19264 * To programmatically (un)select an item use elm_genlist_item_selected_set().
19265 * To get its selected state use elm_genlist_item_selected_get(). Similarly
19266 * to expand/contract an item and get its expanded state, use
19267 * elm_genlist_item_expanded_set() and elm_genlist_item_expanded_get(). And
19268 * again to make an item disabled (unable to be selected and appear
19269 * differently) use elm_genlist_item_disabled_set() to set this and
19270 * elm_genlist_item_disabled_get() to get the disabled state.
19272 * In general to indicate how the genlist should expand items horizontally to
19273 * fill the list area, use elm_genlist_horizontal_set(). Valid modes are
19274 * ELM_LIST_LIMIT and ELM_LIST_SCROLL. The default is ELM_LIST_SCROLL. This
19275 * mode means that if items are too wide to fit, the scroller will scroll
19276 * horizontally. Otherwise items are expanded to fill the width of the
19277 * viewport of the scroller. If it is ELM_LIST_LIMIT, items will be expanded
19278 * to the viewport width and limited to that size. This can be combined with
19279 * a different style that uses edjes' ellipsis feature (cutting text off like
19282 * Items will only call their selection func and callback when first becoming
19283 * selected. Any further clicks will do nothing, unless you enable always
19284 * select with elm_genlist_always_select_mode_set(). This means even if
19285 * selected, every click will make the selected callbacks be called.
19286 * elm_genlist_no_select_mode_set() will turn off the ability to select
19287 * items entirely and they will neither appear selected nor call selected
19288 * callback functions.
19290 * Remember that you can create new styles and add your own theme augmentation
19291 * per application with elm_theme_extension_add(). If you absolutely must
19292 * have a specific style that overrides any theme the user or system sets up
19293 * you can use elm_theme_overlay_add() to add such a file.
19295 * @section Genlist_Implementation Implementation
19297 * Evas tracks every object you create. Every time it processes an event
19298 * (mouse move, down, up etc.) it needs to walk through objects and find out
19299 * what event that affects. Even worse every time it renders display updates,
19300 * in order to just calculate what to re-draw, it needs to walk through many
19301 * many many objects. Thus, the more objects you keep active, the more
19302 * overhead Evas has in just doing its work. It is advisable to keep your
19303 * active objects to the minimum working set you need. Also remember that
19304 * object creation and deletion carries an overhead, so there is a
19305 * middle-ground, which is not easily determined. But don't keep massive lists
19306 * of objects you can't see or use. Genlist does this with list objects. It
19307 * creates and destroys them dynamically as you scroll around. It groups them
19308 * into blocks so it can determine the visibility etc. of a whole block at
19309 * once as opposed to having to walk the whole list. This 2-level list allows
19310 * for very large numbers of items to be in the list (tests have used up to
19311 * 2,000,000 items). Also genlist employs a queue for adding items. As items
19312 * may be different sizes, every item added needs to be calculated as to its
19313 * size and thus this presents a lot of overhead on populating the list, this
19314 * genlist employs a queue. Any item added is queued and spooled off over
19315 * time, actually appearing some time later, so if your list has many members
19316 * you may find it takes a while for them to all appear, with your process
19317 * consuming a lot of CPU while it is busy spooling.
19319 * Genlist also implements a tree structure, but it does so with callbacks to
19320 * the application, with the application filling in tree structures when
19321 * requested (allowing for efficient building of a very deep tree that could
19322 * even be used for file-management). See the above smart signal callbacks for
19325 * @section Genlist_Smart_Events Genlist smart events
19327 * Signals that you can add callbacks for are:
19328 * - @c "activated" - The user has double-clicked or pressed
19329 * (enter|return|spacebar) on an item. The @c event_info parameter is the
19330 * item that was activated.
19331 * - @c "clicked,double" - The user has double-clicked an item. The @c
19332 * event_info parameter is the item that was double-clicked.
19333 * - @c "selected" - This is called when a user has made an item selected.
19334 * The event_info parameter is the genlist item that was selected.
19335 * - @c "unselected" - This is called when a user has made an item
19336 * unselected. The event_info parameter is the genlist item that was
19338 * - @c "expanded" - This is called when elm_genlist_item_expanded_set() is
19339 * called and the item is now meant to be expanded. The event_info
19340 * parameter is the genlist item that was indicated to expand. It is the
19341 * job of this callback to then fill in the child items.
19342 * - @c "contracted" - This is called when elm_genlist_item_expanded_set() is
19343 * called and the item is now meant to be contracted. The event_info
19344 * parameter is the genlist item that was indicated to contract. It is the
19345 * job of this callback to then delete the child items.
19346 * - @c "expand,request" - This is called when a user has indicated they want
19347 * to expand a tree branch item. The callback should decide if the item can
19348 * expand (has any children) and then call elm_genlist_item_expanded_set()
19349 * appropriately to set the state. The event_info parameter is the genlist
19350 * item that was indicated to expand.
19351 * - @c "contract,request" - This is called when a user has indicated they
19352 * want to contract a tree branch item. The callback should decide if the
19353 * item can contract (has any children) and then call
19354 * elm_genlist_item_expanded_set() appropriately to set the state. The
19355 * event_info parameter is the genlist item that was indicated to contract.
19356 * - @c "realized" - This is called when the item in the list is created as a
19357 * real evas object. event_info parameter is the genlist item that was
19358 * created. The object may be deleted at any time, so it is up to the
19359 * caller to not use the object pointer from elm_genlist_item_object_get()
19360 * in a way where it may point to freed objects.
19361 * - @c "unrealized" - This is called just before an item is unrealized.
19362 * After this call content objects provided will be deleted and the item
19363 * object itself delete or be put into a floating cache.
19364 * - @c "drag,start,up" - This is called when the item in the list has been
19365 * dragged (not scrolled) up.
19366 * - @c "drag,start,down" - This is called when the item in the list has been
19367 * dragged (not scrolled) down.
19368 * - @c "drag,start,left" - This is called when the item in the list has been
19369 * dragged (not scrolled) left.
19370 * - @c "drag,start,right" - This is called when the item in the list has
19371 * been dragged (not scrolled) right.
19372 * - @c "drag,stop" - This is called when the item in the list has stopped
19374 * - @c "drag" - This is called when the item in the list is being dragged.
19375 * - @c "longpressed" - This is called when the item is pressed for a certain
19376 * amount of time. By default it's 1 second.
19377 * - @c "scroll,anim,start" - This is called when scrolling animation has
19379 * - @c "scroll,anim,stop" - This is called when scrolling animation has
19381 * - @c "scroll,drag,start" - This is called when dragging the content has
19383 * - @c "scroll,drag,stop" - This is called when dragging the content has
19385 * - @c "edge,top" - This is called when the genlist is scrolled until
19387 * - @c "edge,bottom" - This is called when the genlist is scrolled
19388 * until the bottom edge.
19389 * - @c "edge,left" - This is called when the genlist is scrolled
19390 * until the left edge.
19391 * - @c "edge,right" - This is called when the genlist is scrolled
19392 * until the right edge.
19393 * - @c "multi,swipe,left" - This is called when the genlist is multi-touch
19395 * - @c "multi,swipe,right" - This is called when the genlist is multi-touch
19397 * - @c "multi,swipe,up" - This is called when the genlist is multi-touch
19399 * - @c "multi,swipe,down" - This is called when the genlist is multi-touch
19401 * - @c "multi,pinch,out" - This is called when the genlist is multi-touch
19402 * pinched out. "- @c multi,pinch,in" - This is called when the genlist is
19403 * multi-touch pinched in.
19404 * - @c "swipe" - This is called when the genlist is swiped.
19405 * - @c "moved" - This is called when a genlist item is moved.
19406 * - @c "language,changed" - This is called when the program's language is
19409 * @section Genlist_Examples Examples
19411 * Here is a list of examples that use the genlist, trying to show some of
19412 * its capabilities:
19413 * - @ref genlist_example_01
19414 * - @ref genlist_example_02
19415 * - @ref genlist_example_03
19416 * - @ref genlist_example_04
19417 * - @ref genlist_example_05
19421 * @addtogroup Genlist
19426 * @enum _Elm_Genlist_Item_Flags
19427 * @typedef Elm_Genlist_Item_Flags
19429 * Defines if the item is of any special type (has subitems or it's the
19430 * index of a group), or is just a simple item.
19434 typedef enum _Elm_Genlist_Item_Flags
19436 ELM_GENLIST_ITEM_NONE = 0, /**< simple item */
19437 ELM_GENLIST_ITEM_SUBITEMS = (1 << 0), /**< may expand and have child items */
19438 ELM_GENLIST_ITEM_GROUP = (1 << 1) /**< index of a group of items */
19439 } Elm_Genlist_Item_Flags;
19440 typedef enum _Elm_Genlist_Item_Field_Flags
19442 ELM_GENLIST_ITEM_FIELD_ALL = 0,
19443 ELM_GENLIST_ITEM_FIELD_LABEL = (1 << 0),
19444 ELM_GENLIST_ITEM_FIELD_CONTENT = (1 << 1),
19445 ELM_GENLIST_ITEM_FIELD_STATE = (1 << 2)
19446 } Elm_Genlist_Item_Field_Flags;
19447 typedef struct _Elm_Genlist_Item_Class Elm_Genlist_Item_Class; /**< Genlist item class definition structs */
19448 #define Elm_Genlist_Item_Class Elm_Gen_Item_Class
19449 typedef struct _Elm_Genlist_Item Elm_Genlist_Item; /**< Item of Elm_Genlist. Sub-type of Elm_Widget_Item */
19450 #define Elm_Genlist_Item Elm_Gen_Item /**< Item of Elm_Genlist. Sub-type of Elm_Widget_Item */
19451 typedef struct _Elm_Genlist_Item_Class_Func Elm_Genlist_Item_Class_Func; /**< Class functions for genlist item class */
19454 * Text fetching class function for Elm_Gen_Item_Class.
19455 * @param data The data passed in the item creation function
19456 * @param obj The base widget object
19457 * @param part The part name of the swallow
19458 * @return The allocated (NOT stringshared) string to set as the text
19460 typedef char *(*Elm_Genlist_Item_Text_Get_Cb) (void *data, Evas_Object *obj, const char *part);
19463 * Content (swallowed object) fetching class function for Elm_Gen_Item_Class.
19464 * @param data The data passed in the item creation function
19465 * @param obj The base widget object
19466 * @param part The part name of the swallow
19467 * @return The content object to swallow
19469 typedef Evas_Object *(*Elm_Genlist_Item_Content_Get_Cb) (void *data, Evas_Object *obj, const char *part);
19472 * State fetching class function for Elm_Gen_Item_Class.
19473 * @param data The data passed in the item creation function
19474 * @param obj The base widget object
19475 * @param part The part name of the swallow
19476 * @return The hell if I know
19478 typedef Eina_Bool (*Elm_Genlist_Item_State_Get_Cb) (void *data, Evas_Object *obj, const char *part);
19481 * Deletion class function for Elm_Gen_Item_Class.
19482 * @param data The data passed in the item creation function
19483 * @param obj The base widget object
19485 typedef void (*Elm_Genlist_Item_Del_Cb) (void *data, Evas_Object *obj);
19488 * @struct _Elm_Genlist_Item_Class
19490 * Genlist item class definition structs.
19492 * This struct contains the style and fetching functions that will define the
19493 * contents of each item.
19495 * @see @ref Genlist_Item_Class
19497 struct _Elm_Genlist_Item_Class
19499 const char *item_style; /**< style of this class. */
19500 struct Elm_Genlist_Item_Class_Func
19502 Elm_Genlist_Item_Text_Get_Cb text_get; /**< Text fetching class function for genlist item classes.*/
19503 Elm_Genlist_Item_Content_Get_Cb content_get; /**< Content fetching class function for genlist item classes. */
19504 Elm_Genlist_Item_State_Get_Cb state_get; /**< State fetching class function for genlist item classes. */
19505 Elm_Genlist_Item_Del_Cb del; /**< Deletion class function for genlist item classes. */
19508 #define Elm_Genlist_Item_Class_Func Elm_Gen_Item_Class_Func
19510 * Add a new genlist widget to the given parent Elementary
19511 * (container) object
19513 * @param parent The parent object
19514 * @return a new genlist widget handle or @c NULL, on errors
19516 * This function inserts a new genlist widget on the canvas.
19518 * @see elm_genlist_item_append()
19519 * @see elm_genlist_item_del()
19520 * @see elm_genlist_clear()
19524 EAPI Evas_Object *elm_genlist_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
19527 * Remove all items from a given genlist widget.
19529 * @param obj The genlist object
19531 * This removes (and deletes) all items in @p obj, leaving it empty.
19533 * @see elm_genlist_item_del(), to remove just one item.
19537 EAPI void elm_genlist_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
19540 * Enable or disable multi-selection in the genlist
19542 * @param obj The genlist object
19543 * @param multi Multi-select enable/disable. Default is disabled.
19545 * This enables (@c EINA_TRUE) or disables (@c EINA_FALSE) multi-selection in
19546 * the list. This allows more than 1 item to be selected. To retrieve the list
19547 * of selected items, use elm_genlist_selected_items_get().
19549 * @see elm_genlist_selected_items_get()
19550 * @see elm_genlist_multi_select_get()
19554 EAPI void elm_genlist_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
19557 * Gets if multi-selection in genlist is enabled or disabled.
19559 * @param obj The genlist object
19560 * @return Multi-select enabled/disabled
19561 * (@c EINA_TRUE = enabled/@c EINA_FALSE = disabled). Default is @c EINA_FALSE.
19563 * @see elm_genlist_multi_select_set()
19567 EAPI Eina_Bool elm_genlist_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19570 * This sets the horizontal stretching mode.
19572 * @param obj The genlist object
19573 * @param mode The mode to use (one of #ELM_LIST_SCROLL or #ELM_LIST_LIMIT).
19575 * This sets the mode used for sizing items horizontally. Valid modes
19576 * are #ELM_LIST_LIMIT and #ELM_LIST_SCROLL. The default is
19577 * ELM_LIST_SCROLL. This mode means that if items are too wide to fit,
19578 * the scroller will scroll horizontally. Otherwise items are expanded
19579 * to fill the width of the viewport of the scroller. If it is
19580 * ELM_LIST_LIMIT, items will be expanded to the viewport width and
19581 * limited to that size.
19583 * @see elm_genlist_horizontal_get()
19587 EAPI void elm_genlist_horizontal_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
19588 EINA_DEPRECATED EAPI void elm_genlist_horizontal_mode_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
19591 * Gets the horizontal stretching mode.
19593 * @param obj The genlist object
19594 * @return The mode to use
19595 * (#ELM_LIST_LIMIT, #ELM_LIST_SCROLL)
19597 * @see elm_genlist_horizontal_set()
19601 EAPI Elm_List_Mode elm_genlist_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19602 EINA_DEPRECATED EAPI Elm_List_Mode elm_genlist_horizontal_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19605 * Set the always select mode.
19607 * @param obj The genlist object
19608 * @param always_select The always select mode (@c EINA_TRUE = on, @c
19609 * EINA_FALSE = off). Default is @c EINA_FALSE.
19611 * Items will only call their selection func and callback when first
19612 * becoming selected. Any further clicks will do nothing, unless you
19613 * enable always select with elm_genlist_always_select_mode_set().
19614 * This means that, even if selected, every click will make the selected
19615 * callbacks be called.
19617 * @see elm_genlist_always_select_mode_get()
19621 EAPI void elm_genlist_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
19624 * Get the always select mode.
19626 * @param obj The genlist object
19627 * @return The always select mode
19628 * (@c EINA_TRUE = on, @c EINA_FALSE = off)
19630 * @see elm_genlist_always_select_mode_set()
19634 EAPI Eina_Bool elm_genlist_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19637 * Enable/disable the no select mode.
19639 * @param obj The genlist object
19640 * @param no_select The no select mode
19641 * (EINA_TRUE = on, EINA_FALSE = off)
19643 * This will turn off the ability to select items entirely and they
19644 * will neither appear selected nor call selected callback functions.
19646 * @see elm_genlist_no_select_mode_get()
19650 EAPI void elm_genlist_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
19653 * Gets whether the no select mode is enabled.
19655 * @param obj The genlist object
19656 * @return The no select mode
19657 * (@c EINA_TRUE = on, @c EINA_FALSE = off)
19659 * @see elm_genlist_no_select_mode_set()
19663 EAPI Eina_Bool elm_genlist_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19666 * Enable/disable compress mode.
19668 * @param obj The genlist object
19669 * @param compress The compress mode
19670 * (@c EINA_TRUE = on, @c EINA_FALSE = off). Default is @c EINA_FALSE.
19672 * This will enable the compress mode where items are "compressed"
19673 * horizontally to fit the genlist scrollable viewport width. This is
19674 * special for genlist. Do not rely on
19675 * elm_genlist_horizontal_set() being set to @c ELM_LIST_COMPRESS to
19676 * work as genlist needs to handle it specially.
19678 * @see elm_genlist_compress_mode_get()
19682 EAPI void elm_genlist_compress_mode_set(Evas_Object *obj, Eina_Bool compress) EINA_ARG_NONNULL(1);
19685 * Get whether the compress mode is enabled.
19687 * @param obj The genlist object
19688 * @return The compress mode
19689 * (@c EINA_TRUE = on, @c EINA_FALSE = off)
19691 * @see elm_genlist_compress_mode_set()
19695 EAPI Eina_Bool elm_genlist_compress_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19698 * Enable/disable height-for-width mode.
19700 * @param obj The genlist object
19701 * @param setting The height-for-width mode (@c EINA_TRUE = on,
19702 * @c EINA_FALSE = off). Default is @c EINA_FALSE.
19704 * With height-for-width mode the item width will be fixed (restricted
19705 * to a minimum of) to the list width when calculating its size in
19706 * order to allow the height to be calculated based on it. This allows,
19707 * for instance, text block to wrap lines if the Edje part is
19708 * configured with "text.min: 0 1".
19710 * @note This mode will make list resize slower as it will have to
19711 * recalculate every item height again whenever the list width
19714 * @note When height-for-width mode is enabled, it also enables
19715 * compress mode (see elm_genlist_compress_mode_set()) and
19716 * disables homogeneous (see elm_genlist_homogeneous_set()).
19720 EAPI void elm_genlist_height_for_width_mode_set(Evas_Object *obj, Eina_Bool height_for_width) EINA_ARG_NONNULL(1);
19723 * Get whether the height-for-width mode is enabled.
19725 * @param obj The genlist object
19726 * @return The height-for-width mode (@c EINA_TRUE = on, @c EINA_FALSE =
19731 EAPI Eina_Bool elm_genlist_height_for_width_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19734 * Enable/disable horizontal and vertical bouncing effect.
19736 * @param obj The genlist object
19737 * @param h_bounce Allow bounce horizontally (@c EINA_TRUE = on, @c
19738 * EINA_FALSE = off). Default is @c EINA_FALSE.
19739 * @param v_bounce Allow bounce vertically (@c EINA_TRUE = on, @c
19740 * EINA_FALSE = off). Default is @c EINA_TRUE.
19742 * This will enable or disable the scroller bouncing effect for the
19743 * genlist. See elm_scroller_bounce_set() for details.
19745 * @see elm_scroller_bounce_set()
19746 * @see elm_genlist_bounce_get()
19750 EAPI void elm_genlist_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
19753 * Get whether the horizontal and vertical bouncing effect is enabled.
19755 * @param obj The genlist object
19756 * @param h_bounce Pointer to a bool to receive if the bounce horizontally
19758 * @param v_bounce Pointer to a bool to receive if the bounce vertically
19761 * @see elm_genlist_bounce_set()
19765 EAPI void elm_genlist_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
19768 * Enable/disable homogeneous mode.
19770 * @param obj The genlist object
19771 * @param homogeneous Assume the items within the genlist are of the
19772 * same height and width (EINA_TRUE = on, EINA_FALSE = off). Default is @c
19775 * This will enable the homogeneous mode where items are of the same
19776 * height and width so that genlist may do the lazy-loading at its
19777 * maximum (which increases the performance for scrolling the list). This
19778 * implies 'compressed' mode.
19780 * @see elm_genlist_compress_mode_set()
19781 * @see elm_genlist_homogeneous_get()
19785 EAPI void elm_genlist_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
19788 * Get whether the homogeneous mode is enabled.
19790 * @param obj The genlist object
19791 * @return Assume the items within the genlist are of the same height
19792 * and width (EINA_TRUE = on, EINA_FALSE = off)
19794 * @see elm_genlist_homogeneous_set()
19798 EAPI Eina_Bool elm_genlist_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19801 * Set the maximum number of items within an item block
19803 * @param obj The genlist object
19804 * @param n Maximum number of items within an item block. Default is 32.
19806 * This will configure the block count to tune to the target with
19807 * particular performance matrix.
19809 * A block of objects will be used to reduce the number of operations due to
19810 * many objects in the screen. It can determine the visibility, or if the
19811 * object has changed, it theme needs to be updated, etc. doing this kind of
19812 * calculation to the entire block, instead of per object.
19814 * The default value for the block count is enough for most lists, so unless
19815 * you know you will have a lot of objects visible in the screen at the same
19816 * time, don't try to change this.
19818 * @see elm_genlist_block_count_get()
19819 * @see @ref Genlist_Implementation
19823 EAPI void elm_genlist_block_count_set(Evas_Object *obj, int n) EINA_ARG_NONNULL(1);
19826 * Get the maximum number of items within an item block
19828 * @param obj The genlist object
19829 * @return Maximum number of items within an item block
19831 * @see elm_genlist_block_count_set()
19835 EAPI int elm_genlist_block_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19838 * Set the timeout in seconds for the longpress event.
19840 * @param obj The genlist object
19841 * @param timeout timeout in seconds. Default is 1.
19843 * This option will change how long it takes to send an event "longpressed"
19844 * after the mouse down signal is sent to the list. If this event occurs, no
19845 * "clicked" event will be sent.
19847 * @see elm_genlist_longpress_timeout_set()
19851 EAPI void elm_genlist_longpress_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
19854 * Get the timeout in seconds for the longpress event.
19856 * @param obj The genlist object
19857 * @return timeout in seconds
19859 * @see elm_genlist_longpress_timeout_get()
19863 EAPI double elm_genlist_longpress_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19866 * Append a new item in a given genlist widget.
19868 * @param obj The genlist object
19869 * @param itc The item class for the item
19870 * @param data The item data
19871 * @param parent The parent item, or NULL if none
19872 * @param flags Item flags
19873 * @param func Convenience function called when the item is selected
19874 * @param func_data Data passed to @p func above.
19875 * @return A handle to the item added or @c NULL if not possible
19877 * This adds the given item to the end of the list or the end of
19878 * the children list if the @p parent is given.
19880 * @see elm_genlist_item_prepend()
19881 * @see elm_genlist_item_insert_before()
19882 * @see elm_genlist_item_insert_after()
19883 * @see elm_genlist_item_del()
19887 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);
19890 * Prepend a new item in a given genlist widget.
19892 * @param obj The genlist object
19893 * @param itc The item class for the item
19894 * @param data The item data
19895 * @param parent The parent item, or NULL if none
19896 * @param flags Item flags
19897 * @param func Convenience function called when the item is selected
19898 * @param func_data Data passed to @p func above.
19899 * @return A handle to the item added or NULL if not possible
19901 * This adds an item to the beginning of the list or beginning of the
19902 * children of the parent if given.
19904 * @see elm_genlist_item_append()
19905 * @see elm_genlist_item_insert_before()
19906 * @see elm_genlist_item_insert_after()
19907 * @see elm_genlist_item_del()
19911 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);
19914 * Insert an item before another in a genlist widget
19916 * @param obj The genlist object
19917 * @param itc The item class for the item
19918 * @param data The item data
19919 * @param before The item to place this new one before.
19920 * @param flags Item flags
19921 * @param func Convenience function called when the item is selected
19922 * @param func_data Data passed to @p func above.
19923 * @return A handle to the item added or @c NULL if not possible
19925 * This inserts an item before another in the list. It will be in the
19926 * same tree level or group as the item it is inserted before.
19928 * @see elm_genlist_item_append()
19929 * @see elm_genlist_item_prepend()
19930 * @see elm_genlist_item_insert_after()
19931 * @see elm_genlist_item_del()
19935 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);
19938 * Insert an item after another in a genlist widget
19940 * @param obj The genlist object
19941 * @param itc The item class for the item
19942 * @param data The item data
19943 * @param after The item to place this new one after.
19944 * @param flags Item flags
19945 * @param func Convenience function called when the item is selected
19946 * @param func_data Data passed to @p func above.
19947 * @return A handle to the item added or @c NULL if not possible
19949 * This inserts an item after another in the list. It will be in the
19950 * same tree level or group as the item it is inserted after.
19952 * @see elm_genlist_item_append()
19953 * @see elm_genlist_item_prepend()
19954 * @see elm_genlist_item_insert_before()
19955 * @see elm_genlist_item_del()
19959 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);
19962 * Insert a new item into the sorted genlist object
19964 * @param obj The genlist object
19965 * @param itc The item class for the item
19966 * @param data The item data
19967 * @param parent The parent item, or NULL if none
19968 * @param flags Item flags
19969 * @param comp The function called for the sort
19970 * @param func Convenience function called when item selected
19971 * @param func_data Data passed to @p func above.
19972 * @return A handle to the item added or NULL if not possible
19976 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);
19977 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);
19979 /* operations to retrieve existing items */
19981 * Get the selectd item in the genlist.
19983 * @param obj The genlist object
19984 * @return The selected item, or NULL if none is selected.
19986 * This gets the selected item in the list (if multi-selection is enabled, only
19987 * the item that was first selected in the list is returned - which is not very
19988 * useful, so see elm_genlist_selected_items_get() for when multi-selection is
19991 * If no item is selected, NULL is returned.
19993 * @see elm_genlist_selected_items_get()
19997 EAPI Elm_Genlist_Item *elm_genlist_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20000 * Get a list of selected items in the genlist.
20002 * @param obj The genlist object
20003 * @return The list of selected items, or NULL if none are selected.
20005 * It returns a list of the selected items. This list pointer is only valid so
20006 * long as the selection doesn't change (no items are selected or unselected, or
20007 * unselected implicitly by deletion). The list contains Elm_Genlist_Item
20008 * pointers. The order of the items in this list is the order which they were
20009 * selected, i.e. the first item in this list is the first item that was
20010 * selected, and so on.
20012 * @note If not in multi-select mode, consider using function
20013 * elm_genlist_selected_item_get() instead.
20015 * @see elm_genlist_multi_select_set()
20016 * @see elm_genlist_selected_item_get()
20020 EAPI const Eina_List *elm_genlist_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20023 * Get the mode item style of items in the genlist
20024 * @param obj The genlist object
20025 * @return The mode item style string, or NULL if none is specified
20027 * This is a constant string and simply defines the name of the
20028 * style that will be used for mode animations. It can be
20029 * @c NULL if you don't plan to use Genlist mode. See
20030 * elm_genlist_item_mode_set() for more info.
20034 EAPI const char *elm_genlist_mode_item_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20037 * Set the mode item style of items in the genlist
20038 * @param obj The genlist object
20039 * @param style The mode item style string, or NULL if none is desired
20041 * This is a constant string and simply defines the name of the
20042 * style that will be used for mode animations. It can be
20043 * @c NULL if you don't plan to use Genlist mode. See
20044 * elm_genlist_item_mode_set() for more info.
20048 EAPI void elm_genlist_mode_item_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
20051 * Get a list of realized items in genlist
20053 * @param obj The genlist object
20054 * @return The list of realized items, nor NULL if none are realized.
20056 * This returns a list of the realized items in the genlist. The list
20057 * contains Elm_Genlist_Item pointers. The list must be freed by the
20058 * caller when done with eina_list_free(). The item pointers in the
20059 * list are only valid so long as those items are not deleted or the
20060 * genlist is not deleted.
20062 * @see elm_genlist_realized_items_update()
20066 EAPI Eina_List *elm_genlist_realized_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20069 * Get the item that is at the x, y canvas coords.
20071 * @param obj The gelinst object.
20072 * @param x The input x coordinate
20073 * @param y The input y coordinate
20074 * @param posret The position relative to the item returned here
20075 * @return The item at the coordinates or NULL if none
20077 * This returns the item at the given coordinates (which are canvas
20078 * relative, not object-relative). If an item is at that coordinate,
20079 * that item handle is returned, and if @p posret is not NULL, the
20080 * integer pointed to is set to a value of -1, 0 or 1, depending if
20081 * the coordinate is on the upper portion of that item (-1), on the
20082 * middle section (0) or on the lower part (1). If NULL is returned as
20083 * an item (no item found there), then posret may indicate -1 or 1
20084 * based if the coordinate is above or below all items respectively in
20089 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);
20092 * Get the first item in the genlist
20094 * This returns the first item in the list.
20096 * @param obj The genlist object
20097 * @return The first item, or NULL if none
20101 EAPI Elm_Genlist_Item *elm_genlist_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20104 * Get the last item in the genlist
20106 * This returns the last item in the list.
20108 * @return The last item, or NULL if none
20112 EAPI Elm_Genlist_Item *elm_genlist_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20115 * Set the scrollbar policy
20117 * @param obj The genlist object
20118 * @param policy_h Horizontal scrollbar policy.
20119 * @param policy_v Vertical scrollbar policy.
20121 * This sets the scrollbar visibility policy for the given genlist
20122 * scroller. #ELM_SMART_SCROLLER_POLICY_AUTO means the scrollbar is
20123 * made visible if it is needed, and otherwise kept hidden.
20124 * #ELM_SMART_SCROLLER_POLICY_ON turns it on all the time, and
20125 * #ELM_SMART_SCROLLER_POLICY_OFF always keeps it off. This applies
20126 * respectively for the horizontal and vertical scrollbars. Default is
20127 * #ELM_SMART_SCROLLER_POLICY_AUTO
20129 * @see elm_genlist_scroller_policy_get()
20133 EAPI void elm_genlist_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
20136 * Get the scrollbar policy
20138 * @param obj The genlist object
20139 * @param policy_h Pointer to store the horizontal scrollbar policy.
20140 * @param policy_v Pointer to store the vertical scrollbar policy.
20142 * @see elm_genlist_scroller_policy_set()
20146 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);
20149 * Get the @b next item in a genlist widget's internal list of items,
20150 * given a handle to one of those items.
20152 * @param item The genlist item to fetch next from
20153 * @return The item after @p item, or @c NULL if there's none (and
20156 * This returns the item placed after the @p item, on the container
20159 * @see elm_genlist_item_prev_get()
20163 EAPI Elm_Genlist_Item *elm_genlist_item_next_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
20166 * Get the @b previous item in a genlist widget's internal list of items,
20167 * given a handle to one of those items.
20169 * @param item The genlist item to fetch previous from
20170 * @return The item before @p item, or @c NULL if there's none (and
20173 * This returns the item placed before the @p item, on the container
20176 * @see elm_genlist_item_next_get()
20180 EAPI Elm_Genlist_Item *elm_genlist_item_prev_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
20183 * Get the genlist object's handle which contains a given genlist
20186 * @param item The item to fetch the container from
20187 * @return The genlist (parent) object
20189 * This returns the genlist object itself that an item belongs to.
20193 EAPI Evas_Object *elm_genlist_item_genlist_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
20196 * Get the parent item of the given item
20198 * @param it The item
20199 * @return The parent of the item or @c NULL if it has no parent.
20201 * This returns the item that was specified as parent of the item @p it on
20202 * elm_genlist_item_append() and insertion related functions.
20206 EAPI Elm_Genlist_Item *elm_genlist_item_parent_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
20209 * Remove all sub-items (children) of the given item
20211 * @param it The item
20213 * This removes all items that are children (and their descendants) of the
20214 * given item @p it.
20216 * @see elm_genlist_clear()
20217 * @see elm_genlist_item_del()
20221 EAPI void elm_genlist_item_subitems_clear(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
20224 * Set whether a given genlist item is selected or not
20226 * @param it The item
20227 * @param selected Use @c EINA_TRUE, to make it selected, @c
20228 * EINA_FALSE to make it unselected
20230 * This sets the selected state of an item. If multi selection is
20231 * not enabled on the containing genlist and @p selected is @c
20232 * EINA_TRUE, any other previously selected items will get
20233 * unselected in favor of this new one.
20235 * @see elm_genlist_item_selected_get()
20239 EAPI void elm_genlist_item_selected_set(Elm_Genlist_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
20242 * Get whether a given genlist item is selected or not
20244 * @param it The item
20245 * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
20247 * @see elm_genlist_item_selected_set() for more details
20251 EAPI Eina_Bool elm_genlist_item_selected_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
20254 * Sets the expanded state of an item.
20256 * @param it The item
20257 * @param expanded The expanded state (@c EINA_TRUE expanded, @c EINA_FALSE not expanded).
20259 * This function flags the item of type #ELM_GENLIST_ITEM_SUBITEMS as
20262 * The theme will respond to this change visually, and a signal "expanded" or
20263 * "contracted" will be sent from the genlist with a pointer to the item that
20264 * has been expanded/contracted.
20266 * Calling this function won't show or hide any child of this item (if it is
20267 * a parent). You must manually delete and create them on the callbacks fo
20268 * the "expanded" or "contracted" signals.
20270 * @see elm_genlist_item_expanded_get()
20274 EAPI void elm_genlist_item_expanded_set(Elm_Genlist_Item *item, Eina_Bool expanded) EINA_ARG_NONNULL(1);
20277 * Get the expanded state of an item
20279 * @param it The item
20280 * @return The expanded state
20282 * This gets the expanded state of an item.
20284 * @see elm_genlist_item_expanded_set()
20288 EAPI Eina_Bool elm_genlist_item_expanded_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
20291 * Get the depth of expanded item
20293 * @param it The genlist item object
20294 * @return The depth of expanded item
20298 EAPI int elm_genlist_item_expanded_depth_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
20301 * Set whether a given genlist item is disabled or not.
20303 * @param it The item
20304 * @param disabled Use @c EINA_TRUE, true disable it, @c EINA_FALSE
20305 * to enable it back.
20307 * A disabled item cannot be selected or unselected. It will also
20308 * change its appearance, to signal the user it's disabled.
20310 * @see elm_genlist_item_disabled_get()
20314 EAPI void elm_genlist_item_disabled_set(Elm_Genlist_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
20317 * Get whether a given genlist item is disabled or not.
20319 * @param it The item
20320 * @return @c EINA_TRUE, if it's disabled, @c EINA_FALSE otherwise
20323 * @see elm_genlist_item_disabled_set() for more details
20327 EAPI Eina_Bool elm_genlist_item_disabled_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
20330 * Sets the display only state of an item.
20332 * @param it The item
20333 * @param display_only @c EINA_TRUE if the item is display only, @c
20334 * EINA_FALSE otherwise.
20336 * A display only item cannot be selected or unselected. It is for
20337 * display only and not selecting or otherwise clicking, dragging
20338 * etc. by the user, thus finger size rules will not be applied to
20341 * It's good to set group index items to display only state.
20343 * @see elm_genlist_item_display_only_get()
20347 EAPI void elm_genlist_item_display_only_set(Elm_Genlist_Item *it, Eina_Bool display_only) EINA_ARG_NONNULL(1);
20350 * Get the display only state of an item
20352 * @param it The item
20353 * @return @c EINA_TRUE if the item is display only, @c
20354 * EINA_FALSE otherwise.
20356 * @see elm_genlist_item_display_only_set()
20360 EAPI Eina_Bool elm_genlist_item_display_only_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
20363 * Show the portion of a genlist's internal list containing a given
20364 * item, immediately.
20366 * @param it The item to display
20368 * This causes genlist to jump to the given item @p it and show it (by
20369 * immediately scrolling to that position), if it is not fully visible.
20371 * @see elm_genlist_item_bring_in()
20372 * @see elm_genlist_item_top_show()
20373 * @see elm_genlist_item_middle_show()
20377 EAPI void elm_genlist_item_show(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
20380 * Animatedly bring in, to the visible are of a genlist, a given
20383 * @param it The item to display
20385 * This causes genlist to jump to the given item @p it and show it (by
20386 * animatedly scrolling), if it is not fully visible. This may use animation
20387 * to do so and take a period of time
20389 * @see elm_genlist_item_show()
20390 * @see elm_genlist_item_top_bring_in()
20391 * @see elm_genlist_item_middle_bring_in()
20395 EAPI void elm_genlist_item_bring_in(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
20398 * Show the portion of a genlist's internal list containing a given
20399 * item, immediately.
20401 * @param it The item to display
20403 * This causes genlist to jump to the given item @p it and show it (by
20404 * immediately scrolling to that position), if it is not fully visible.
20406 * The item will be positioned at the top of the genlist viewport.
20408 * @see elm_genlist_item_show()
20409 * @see elm_genlist_item_top_bring_in()
20413 EAPI void elm_genlist_item_top_show(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
20416 * Animatedly bring in, to the visible are of a genlist, a given
20419 * @param it The item
20421 * This causes genlist to jump to the given item @p it and show it (by
20422 * animatedly scrolling), if it is not fully visible. This may use animation
20423 * to do so and take a period of time
20425 * The item will be positioned at the top of the genlist viewport.
20427 * @see elm_genlist_item_bring_in()
20428 * @see elm_genlist_item_top_show()
20432 EAPI void elm_genlist_item_top_bring_in(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
20435 * Show the portion of a genlist's internal list containing a given
20436 * item, immediately.
20438 * @param it The item to display
20440 * This causes genlist to jump to the given item @p it and show it (by
20441 * immediately scrolling to that position), if it is not fully visible.
20443 * The item will be positioned at the middle of the genlist viewport.
20445 * @see elm_genlist_item_show()
20446 * @see elm_genlist_item_middle_bring_in()
20450 EAPI void elm_genlist_item_middle_show(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
20453 * Animatedly bring in, to the visible are of a genlist, a given
20456 * @param it The item
20458 * This causes genlist to jump to the given item @p it and show it (by
20459 * animatedly scrolling), if it is not fully visible. This may use animation
20460 * to do so and take a period of time
20462 * The item will be positioned at the middle of the genlist viewport.
20464 * @see elm_genlist_item_bring_in()
20465 * @see elm_genlist_item_middle_show()
20469 EAPI void elm_genlist_item_middle_bring_in(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
20472 * Remove a genlist item from the its parent, deleting it.
20474 * @param item The item to be removed.
20475 * @return @c EINA_TRUE on success or @c EINA_FALSE, otherwise.
20477 * @see elm_genlist_clear(), to remove all items in a genlist at
20482 EAPI void elm_genlist_item_del(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
20485 * Return the data associated to a given genlist item
20487 * @param item The genlist item.
20488 * @return the data associated to this item.
20490 * This returns the @c data value passed on the
20491 * elm_genlist_item_append() and related item addition calls.
20493 * @see elm_genlist_item_append()
20494 * @see elm_genlist_item_data_set()
20498 EAPI void *elm_genlist_item_data_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
20501 * Set the data associated to a given genlist item
20503 * @param item The genlist item
20504 * @param data The new data pointer to set on it
20506 * This @b overrides the @c data value passed on the
20507 * elm_genlist_item_append() and related item addition calls. This
20508 * function @b won't call elm_genlist_item_update() automatically,
20509 * so you'd issue it afterwards if you want to hove the item
20510 * updated to reflect the that new data.
20512 * @see elm_genlist_item_data_get()
20516 EAPI void elm_genlist_item_data_set(Elm_Genlist_Item *it, const void *data) EINA_ARG_NONNULL(1);
20519 * Tells genlist to "orphan" contents fetchs by the item class
20521 * @param it The item
20523 * This instructs genlist to release references to contents in the item,
20524 * meaning that they will no longer be managed by genlist and are
20525 * floating "orphans" that can be re-used elsewhere if the user wants
20530 EAPI void elm_genlist_item_contents_orphan(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
20531 EINA_DEPRECATED EAPI void elm_genlist_item_icons_orphan(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
20534 * Get the real Evas object created to implement the view of a
20535 * given genlist item
20537 * @param item The genlist item.
20538 * @return the Evas object implementing this item's view.
20540 * This returns the actual Evas object used to implement the
20541 * specified genlist item's view. This may be @c NULL, as it may
20542 * not have been created or may have been deleted, at any time, by
20543 * the genlist. <b>Do not modify this object</b> (move, resize,
20544 * show, hide, etc.), as the genlist is controlling it. This
20545 * function is for querying, emitting custom signals or hooking
20546 * lower level callbacks for events on that object. Do not delete
20547 * this object under any circumstances.
20549 * @see elm_genlist_item_data_get()
20553 EAPI const Evas_Object *elm_genlist_item_object_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
20556 * Update the contents of an item
20558 * @param it The item
20560 * This updates an item by calling all the item class functions again
20561 * to get the contents, texts and states. Use this when the original
20562 * item data has changed and the changes are desired to be reflected.
20564 * Use elm_genlist_realized_items_update() to update all already realized
20567 * @see elm_genlist_realized_items_update()
20571 EAPI void elm_genlist_item_update(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
20574 * Promote an item to the top of the list
20576 * @param it The item
20580 EAPI void elm_genlist_item_promote(Elm_Gen_Item *it) EINA_ARG_NONNULL(1);
20583 * Demote an item to the end of the list
20585 * @param it The item
20589 EAPI void elm_genlist_item_demote(Elm_Gen_Item *it) EINA_ARG_NONNULL(1);
20592 * Update the part of an item
20594 * @param it The item
20595 * @param parts The name of item's part
20596 * @param itf The flags of item's part type
20598 * This updates an item's part by calling item's fetching functions again
20599 * to get the contents, texts and states. Use this when the original
20600 * item data has changed and the changes are desired to be reflected.
20601 * Second parts argument is used for globbing to match '*', '?', and '.'
20602 * It can be used at updating multi fields.
20604 * Use elm_genlist_realized_items_update() to update an item's all
20607 * @see elm_genlist_item_update()
20611 EAPI void elm_genlist_item_fields_update(Elm_Genlist_Item *it, const char *parts, Elm_Genlist_Item_Field_Flags itf) EINA_ARG_NONNULL(1);
20614 * Update the item class of an item
20616 * @param it The item
20617 * @param itc The item class for the item
20619 * This sets another class fo the item, changing the way that it is
20620 * displayed. After changing the item class, elm_genlist_item_update() is
20621 * called on the item @p it.
20625 EAPI void elm_genlist_item_item_class_update(Elm_Genlist_Item *it, const Elm_Genlist_Item_Class *itc) EINA_ARG_NONNULL(1, 2);
20626 EAPI const Elm_Genlist_Item_Class *elm_genlist_item_item_class_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
20629 * Set the text to be shown in a given genlist item's tooltips.
20631 * @param item The genlist item
20632 * @param text The text to set in the content
20634 * This call will setup the text to be used as tooltip to that item
20635 * (analogous to elm_object_tooltip_text_set(), but being item
20636 * tooltips with higher precedence than object tooltips). It can
20637 * have only one tooltip at a time, so any previous tooltip data
20638 * will get removed.
20640 * In order to set a content or something else as a tooltip, look at
20641 * elm_genlist_item_tooltip_content_cb_set().
20645 EAPI void elm_genlist_item_tooltip_text_set(Elm_Genlist_Item *item, const char *text) EINA_ARG_NONNULL(1);
20648 * Set the content to be shown in a given genlist item's tooltips
20650 * @param item The genlist item.
20651 * @param func The function returning the tooltip contents.
20652 * @param data What to provide to @a func as callback data/context.
20653 * @param del_cb Called when data is not needed anymore, either when
20654 * another callback replaces @p func, the tooltip is unset with
20655 * elm_genlist_item_tooltip_unset() or the owner @p item
20656 * dies. This callback receives as its first parameter the
20657 * given @p data, being @c event_info the item handle.
20659 * This call will setup the tooltip's contents to @p item
20660 * (analogous to elm_object_tooltip_content_cb_set(), but being
20661 * item tooltips with higher precedence than object tooltips). It
20662 * can have only one tooltip at a time, so any previous tooltip
20663 * content will get removed. @p func (with @p data) will be called
20664 * every time Elementary needs to show the tooltip and it should
20665 * return a valid Evas object, which will be fully managed by the
20666 * tooltip system, getting deleted when the tooltip is gone.
20668 * In order to set just a text as a tooltip, look at
20669 * elm_genlist_item_tooltip_text_set().
20673 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);
20676 * Unset a tooltip from a given genlist item
20678 * @param item genlist item to remove a previously set tooltip from.
20680 * This call removes any tooltip set on @p item. The callback
20681 * provided as @c del_cb to
20682 * elm_genlist_item_tooltip_content_cb_set() will be called to
20683 * notify it is not used anymore (and have resources cleaned, if
20686 * @see elm_genlist_item_tooltip_content_cb_set()
20690 EAPI void elm_genlist_item_tooltip_unset(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
20693 * Set a different @b style for a given genlist item's tooltip.
20695 * @param item genlist item with tooltip set
20696 * @param style the <b>theme style</b> to use on tooltips (e.g. @c
20697 * "default", @c "transparent", etc)
20699 * Tooltips can have <b>alternate styles</b> to be displayed on,
20700 * which are defined by the theme set on Elementary. This function
20701 * works analogously as elm_object_tooltip_style_set(), but here
20702 * applied only to genlist item objects. The default style for
20703 * tooltips is @c "default".
20705 * @note before you set a style you should define a tooltip with
20706 * elm_genlist_item_tooltip_content_cb_set() or
20707 * elm_genlist_item_tooltip_text_set()
20709 * @see elm_genlist_item_tooltip_style_get()
20713 EAPI void elm_genlist_item_tooltip_style_set(Elm_Genlist_Item *item, const char *style) EINA_ARG_NONNULL(1);
20716 * Get the style set a given genlist item's tooltip.
20718 * @param item genlist item with tooltip already set on.
20719 * @return style the theme style in use, which defaults to
20720 * "default". If the object does not have a tooltip set,
20721 * then @c NULL is returned.
20723 * @see elm_genlist_item_tooltip_style_set() for more details
20727 EAPI const char *elm_genlist_item_tooltip_style_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
20730 * @brief Disable size restrictions on an object's tooltip
20731 * @param item The tooltip's anchor object
20732 * @param disable If EINA_TRUE, size restrictions are disabled
20733 * @return EINA_FALSE on failure, EINA_TRUE on success
20735 * This function allows a tooltip to expand beyond its parant window's canvas.
20736 * It will instead be limited only by the size of the display.
20738 EAPI Eina_Bool elm_genlist_item_tooltip_window_mode_set(Elm_Genlist_Item *item, Eina_Bool disable);
20741 * @brief Retrieve size restriction state of an object's tooltip
20742 * @param item The tooltip's anchor object
20743 * @return If EINA_TRUE, size restrictions are disabled
20745 * This function returns whether a tooltip is allowed to expand beyond
20746 * its parant window's canvas.
20747 * It will instead be limited only by the size of the display.
20749 EAPI Eina_Bool elm_genlist_item_tooltip_window_mode_get(const Elm_Genlist_Item *item);
20752 * Set the type of mouse pointer/cursor decoration to be shown,
20753 * when the mouse pointer is over the given genlist widget item
20755 * @param item genlist item to customize cursor on
20756 * @param cursor the cursor type's name
20758 * This function works analogously as elm_object_cursor_set(), but
20759 * here the cursor's changing area is restricted to the item's
20760 * area, and not the whole widget's. Note that that item cursors
20761 * have precedence over widget cursors, so that a mouse over @p
20762 * item will always show cursor @p type.
20764 * If this function is called twice for an object, a previously set
20765 * cursor will be unset on the second call.
20767 * @see elm_object_cursor_set()
20768 * @see elm_genlist_item_cursor_get()
20769 * @see elm_genlist_item_cursor_unset()
20773 EAPI void elm_genlist_item_cursor_set(Elm_Genlist_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
20776 * Get the type of mouse pointer/cursor decoration set to be shown,
20777 * when the mouse pointer is over the given genlist widget item
20779 * @param item genlist item with custom cursor set
20780 * @return the cursor type's name or @c NULL, if no custom cursors
20781 * were set to @p item (and on errors)
20783 * @see elm_object_cursor_get()
20784 * @see elm_genlist_item_cursor_set() for more details
20785 * @see elm_genlist_item_cursor_unset()
20789 EAPI const char *elm_genlist_item_cursor_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
20792 * Unset any custom mouse pointer/cursor decoration set to be
20793 * shown, when the mouse pointer is over the given genlist widget
20794 * item, thus making it show the @b default cursor again.
20796 * @param item a genlist item
20798 * Use this call to undo any custom settings on this item's cursor
20799 * decoration, bringing it back to defaults (no custom style set).
20801 * @see elm_object_cursor_unset()
20802 * @see elm_genlist_item_cursor_set() for more details
20806 EAPI void elm_genlist_item_cursor_unset(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
20809 * Set a different @b style for a given custom cursor set for a
20812 * @param item genlist item with custom cursor set
20813 * @param style the <b>theme style</b> to use (e.g. @c "default",
20814 * @c "transparent", etc)
20816 * This function only makes sense when one is using custom mouse
20817 * cursor decorations <b>defined in a theme file</b> , which can
20818 * have, given a cursor name/type, <b>alternate styles</b> on
20819 * it. It works analogously as elm_object_cursor_style_set(), but
20820 * here applied only to genlist item objects.
20822 * @warning Before you set a cursor style you should have defined a
20823 * custom cursor previously on the item, with
20824 * elm_genlist_item_cursor_set()
20826 * @see elm_genlist_item_cursor_engine_only_set()
20827 * @see elm_genlist_item_cursor_style_get()
20831 EAPI void elm_genlist_item_cursor_style_set(Elm_Genlist_Item *item, const char *style) EINA_ARG_NONNULL(1);
20834 * Get the current @b style set for a given genlist item's custom
20837 * @param item genlist item with custom cursor set.
20838 * @return style the cursor style in use. If the object does not
20839 * have a cursor set, then @c NULL is returned.
20841 * @see elm_genlist_item_cursor_style_set() for more details
20845 EAPI const char *elm_genlist_item_cursor_style_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
20848 * Set if the (custom) cursor for a given genlist item should be
20849 * searched in its theme, also, or should only rely on the
20850 * rendering engine.
20852 * @param item item with custom (custom) cursor already set on
20853 * @param engine_only Use @c EINA_TRUE to have cursors looked for
20854 * only on those provided by the rendering engine, @c EINA_FALSE to
20855 * have them searched on the widget's theme, as well.
20857 * @note This call is of use only if you've set a custom cursor
20858 * for genlist items, with elm_genlist_item_cursor_set().
20860 * @note By default, cursors will only be looked for between those
20861 * provided by the rendering engine.
20865 EAPI void elm_genlist_item_cursor_engine_only_set(Elm_Genlist_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
20868 * Get if the (custom) cursor for a given genlist item is being
20869 * searched in its theme, also, or is only relying on the rendering
20872 * @param item a genlist item
20873 * @return @c EINA_TRUE, if cursors are being looked for only on
20874 * those provided by the rendering engine, @c EINA_FALSE if they
20875 * are being searched on the widget's theme, as well.
20877 * @see elm_genlist_item_cursor_engine_only_set(), for more details
20881 EAPI Eina_Bool elm_genlist_item_cursor_engine_only_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
20884 * Get the index of the item. It is only valid once displayed.
20886 * @param item a genlist item
20887 * @return the position inside the list of item.
20891 EAPI int elm_genlist_item_index_get(Elm_Gen_Item *it);
20894 * Update the contents of all realized items.
20896 * @param obj The genlist object.
20898 * This updates all realized items by calling all the item class functions again
20899 * to get the contents, texts and states. Use this when the original
20900 * item data has changed and the changes are desired to be reflected.
20902 * To update just one item, use elm_genlist_item_update().
20904 * @see elm_genlist_realized_items_get()
20905 * @see elm_genlist_item_update()
20909 EAPI void elm_genlist_realized_items_update(Evas_Object *obj) EINA_ARG_NONNULL(1);
20912 * Activate a genlist mode on an item
20914 * @param item The genlist item
20915 * @param mode Mode name
20916 * @param mode_set Boolean to define set or unset mode.
20918 * A genlist mode is a different way of selecting an item. Once a mode is
20919 * activated on an item, any other selected item is immediately unselected.
20920 * This feature provides an easy way of implementing a new kind of animation
20921 * for selecting an item, without having to entirely rewrite the item style
20922 * theme. However, the elm_genlist_selected_* API can't be used to get what
20923 * item is activate for a mode.
20925 * The current item style will still be used, but applying a genlist mode to
20926 * an item will select it using a different kind of animation.
20928 * The current active item for a mode can be found by
20929 * elm_genlist_mode_item_get().
20931 * The characteristics of genlist mode are:
20932 * - Only one mode can be active at any time, and for only one item.
20933 * - Genlist handles deactivating other items when one item is activated.
20934 * - A mode is defined in the genlist theme (edc), and more modes can easily
20936 * - A mode style and the genlist item style are different things. They
20937 * can be combined to provide a default style to the item, with some kind
20938 * of animation for that item when the mode is activated.
20940 * When a mode is activated on an item, a new view for that item is created.
20941 * The theme of this mode defines the animation that will be used to transit
20942 * the item from the old view to the new view. This second (new) view will be
20943 * active for that item while the mode is active on the item, and will be
20944 * destroyed after the mode is totally deactivated from that item.
20946 * @see elm_genlist_mode_get()
20947 * @see elm_genlist_mode_item_get()
20951 EAPI void elm_genlist_item_mode_set(Elm_Genlist_Item *it, const char *mode_type, Eina_Bool mode_set) EINA_ARG_NONNULL(1, 2);
20954 * Get the last (or current) genlist mode used.
20956 * @param obj The genlist object
20958 * This function just returns the name of the last used genlist mode. It will
20959 * be the current mode if it's still active.
20961 * @see elm_genlist_item_mode_set()
20962 * @see elm_genlist_mode_item_get()
20966 EAPI const char *elm_genlist_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20969 * Get active genlist mode item
20971 * @param obj The genlist object
20972 * @return The active item for that current mode. Or @c NULL if no item is
20973 * activated with any mode.
20975 * This function returns the item that was activated with a mode, by the
20976 * function elm_genlist_item_mode_set().
20978 * @see elm_genlist_item_mode_set()
20979 * @see elm_genlist_mode_get()
20983 EAPI const Elm_Genlist_Item *elm_genlist_mode_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20988 * @param obj The genlist object
20989 * @param reorder_mode The reorder mode
20990 * (EINA_TRUE = on, EINA_FALSE = off)
20994 EAPI void elm_genlist_reorder_mode_set(Evas_Object *obj, Eina_Bool reorder_mode) EINA_ARG_NONNULL(1);
20997 * Get the reorder mode
20999 * @param obj The genlist object
21000 * @return The reorder mode
21001 * (EINA_TRUE = on, EINA_FALSE = off)
21005 EAPI Eina_Bool elm_genlist_reorder_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21012 * @defgroup Check Check
21014 * @image html img/widget/check/preview-00.png
21015 * @image latex img/widget/check/preview-00.eps
21016 * @image html img/widget/check/preview-01.png
21017 * @image latex img/widget/check/preview-01.eps
21018 * @image html img/widget/check/preview-02.png
21019 * @image latex img/widget/check/preview-02.eps
21021 * @brief The check widget allows for toggling a value between true and
21024 * Check objects are a lot like radio objects in layout and functionality
21025 * except they do not work as a group, but independently and only toggle the
21026 * value of a boolean from false to true (0 or 1). elm_check_state_set() sets
21027 * the boolean state (1 for true, 0 for false), and elm_check_state_get()
21028 * returns the current state. For convenience, like the radio objects, you
21029 * can set a pointer to a boolean directly with elm_check_state_pointer_set()
21030 * for it to modify.
21032 * Signals that you can add callbacks for are:
21033 * "changed" - This is called whenever the user changes the state of one of
21034 * the check object(event_info is NULL).
21036 * Default contents parts of the check widget that you can use for are:
21037 * @li "icon" - An icon of the check
21039 * Default text parts of the check widget that you can use for are:
21040 * @li "elm.text" - Label of the check
21042 * @ref tutorial_check should give you a firm grasp of how to use this widget
21047 * @brief Add a new Check object
21049 * @param parent The parent object
21050 * @return The new object or NULL if it cannot be created
21052 EAPI Evas_Object *elm_check_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21055 * @brief Set the text label of the check object
21057 * @param obj The check object
21058 * @param label The text label string in UTF-8
21060 * @deprecated use elm_object_text_set() instead.
21062 EINA_DEPRECATED EAPI void elm_check_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
21065 * @brief Get the text label of the check object
21067 * @param obj The check object
21068 * @return The text label string in UTF-8
21070 * @deprecated use elm_object_text_get() instead.
21072 EINA_DEPRECATED EAPI const char *elm_check_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21075 * @brief Set the icon object of the check object
21077 * @param obj The check object
21078 * @param icon The icon object
21080 * Once the icon object is set, a previously set one will be deleted.
21081 * If you want to keep that old content object, use the
21082 * elm_object_content_unset() function.
21084 * @deprecated use elm_object_part_content_set() instead.
21087 EINA_DEPRECATED EAPI void elm_check_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
21090 * @brief Get the icon object of the check object
21092 * @param obj The check object
21093 * @return The icon object
21095 * @deprecated use elm_object_part_content_get() instead.
21098 EINA_DEPRECATED EAPI Evas_Object *elm_check_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21101 * @brief Unset the icon used for the check object
21103 * @param obj The check object
21104 * @return The icon object that was being used
21106 * Unparent and return the icon object which was set for this widget.
21108 * @deprecated use elm_object_part_content_unset() instead.
21111 EINA_DEPRECATED EAPI Evas_Object *elm_check_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
21114 * @brief Set the on/off state of the check object
21116 * @param obj The check object
21117 * @param state The state to use (1 == on, 0 == off)
21119 * This sets the state of the check. If set
21120 * with elm_check_state_pointer_set() the state of that variable is also
21121 * changed. Calling this @b doesn't cause the "changed" signal to be emited.
21123 EAPI void elm_check_state_set(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
21126 * @brief Get the state of the check object
21128 * @param obj The check object
21129 * @return The boolean state
21131 EAPI Eina_Bool elm_check_state_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21134 * @brief Set a convenience pointer to a boolean to change
21136 * @param obj The check object
21137 * @param statep Pointer to the boolean to modify
21139 * This sets a pointer to a boolean, that, in addition to the check objects
21140 * state will also be modified directly. To stop setting the object pointed
21141 * to simply use NULL as the @p statep parameter. If @p statep is not NULL,
21142 * then when this is called, the check objects state will also be modified to
21143 * reflect the value of the boolean @p statep points to, just like calling
21144 * elm_check_state_set().
21146 EAPI void elm_check_state_pointer_set(Evas_Object *obj, Eina_Bool *statep) EINA_ARG_NONNULL(1);
21147 EINA_DEPRECATED EAPI void elm_check_states_labels_set(Evas_Object *obj, const char *ontext, const char *offtext) EINA_ARG_NONNULL(1,2,3);
21148 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);
21155 * @defgroup Radio Radio
21157 * @image html img/widget/radio/preview-00.png
21158 * @image latex img/widget/radio/preview-00.eps
21160 * @brief Radio is a widget that allows for 1 or more options to be displayed
21161 * and have the user choose only 1 of them.
21163 * A radio object contains an indicator, an optional Label and an optional
21164 * icon object. While it's possible to have a group of only one radio they,
21165 * are normally used in groups of 2 or more. To add a radio to a group use
21166 * elm_radio_group_add(). The radio object(s) will select from one of a set
21167 * of integer values, so any value they are configuring needs to be mapped to
21168 * a set of integers. To configure what value that radio object represents,
21169 * use elm_radio_state_value_set() to set the integer it represents. To set
21170 * the value the whole group(which one is currently selected) is to indicate
21171 * use elm_radio_value_set() on any group member, and to get the groups value
21172 * use elm_radio_value_get(). For convenience the radio objects are also able
21173 * to directly set an integer(int) to the value that is selected. To specify
21174 * the pointer to this integer to modify, use elm_radio_value_pointer_set().
21175 * The radio objects will modify this directly. That implies the pointer must
21176 * point to valid memory for as long as the radio objects exist.
21178 * Signals that you can add callbacks for are:
21179 * @li changed - This is called whenever the user changes the state of one of
21180 * the radio objects within the group of radio objects that work together.
21182 * Default contents parts of the radio widget that you can use for are:
21183 * @li "icon" - An icon of the radio
21185 * @ref tutorial_radio show most of this API in action.
21190 * @brief Add a new radio to the parent
21192 * @param parent The parent object
21193 * @return The new object or NULL if it cannot be created
21195 EAPI Evas_Object *elm_radio_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21198 * @brief Set the text label of the radio object
21200 * @param obj The radio object
21201 * @param label The text label string in UTF-8
21203 * @deprecated use elm_object_text_set() instead.
21205 EINA_DEPRECATED EAPI void elm_radio_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
21208 * @brief Get the text label of the radio object
21210 * @param obj The radio object
21211 * @return The text label string in UTF-8
21213 * @deprecated use elm_object_text_set() instead.
21215 EINA_DEPRECATED EAPI const char *elm_radio_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21218 * @brief Set the icon object of the radio object
21220 * @param obj The radio object
21221 * @param icon The icon object
21223 * Once the icon object is set, a previously set one will be deleted. If you
21224 * want to keep that old content object, use the elm_radio_icon_unset()
21227 * @deprecated use elm_object_part_content_set() instead.
21230 EINA_DEPRECATED EAPI void elm_radio_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
21233 * @brief Get the icon object of the radio object
21235 * @param obj The radio object
21236 * @return The icon object
21238 * @see elm_radio_icon_set()
21240 * @deprecated use elm_object_part_content_get() instead.
21243 EINA_DEPRECATED EAPI Evas_Object *elm_radio_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21246 * @brief Unset the icon used for the radio object
21248 * @param obj The radio object
21249 * @return The icon object that was being used
21251 * Unparent and return the icon object which was set for this widget.
21253 * @see elm_radio_icon_set()
21254 * @deprecated use elm_object_part_content_unset() instead.
21257 EINA_DEPRECATED EAPI Evas_Object *elm_radio_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
21260 * @brief Add this radio to a group of other radio objects
21262 * @param obj The radio object
21263 * @param group Any object whose group the @p obj is to join.
21265 * Radio objects work in groups. Each member should have a different integer
21266 * value assigned. In order to have them work as a group, they need to know
21267 * about each other. This adds the given radio object to the group of which
21268 * the group object indicated is a member.
21270 EAPI void elm_radio_group_add(Evas_Object *obj, Evas_Object *group) EINA_ARG_NONNULL(1);
21273 * @brief Set the integer value that this radio object represents
21275 * @param obj The radio object
21276 * @param value The value to use if this radio object is selected
21278 * This sets the value of the radio.
21280 EAPI void elm_radio_state_value_set(Evas_Object *obj, int value) EINA_ARG_NONNULL(1);
21283 * @brief Get the integer value that this radio object represents
21285 * @param obj The radio object
21286 * @return The value used if this radio object is selected
21288 * This gets the value of the radio.
21290 * @see elm_radio_value_set()
21292 EAPI int elm_radio_state_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21295 * @brief Set the value of the radio.
21297 * @param obj The radio object
21298 * @param value The value to use for the group
21300 * This sets the value of the radio group and will also set the value if
21301 * pointed to, to the value supplied, but will not call any callbacks.
21303 EAPI void elm_radio_value_set(Evas_Object *obj, int value) EINA_ARG_NONNULL(1);
21306 * @brief Get the state of the radio object
21308 * @param obj The radio object
21309 * @return The integer state
21311 EAPI int elm_radio_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21314 * @brief Set a convenience pointer to a integer to change
21316 * @param obj The radio object
21317 * @param valuep Pointer to the integer to modify
21319 * This sets a pointer to a integer, that, in addition to the radio objects
21320 * state will also be modified directly. To stop setting the object pointed
21321 * to simply use NULL as the @p valuep argument. If valuep is not NULL, then
21322 * when this is called, the radio objects state will also be modified to
21323 * reflect the value of the integer valuep points to, just like calling
21324 * elm_radio_value_set().
21326 EAPI void elm_radio_value_pointer_set(Evas_Object *obj, int *valuep) EINA_ARG_NONNULL(1);
21333 * @defgroup Pager Pager
21335 * @image html img/widget/pager/preview-00.png
21336 * @image latex img/widget/pager/preview-00.eps
21338 * @brief Widget that allows flipping between one or more āpagesā
21341 * The flipping between pages of objects is animated. All content
21342 * in the pager is kept in a stack, being the last content added
21343 * (visible one) on the top of that stack.
21345 * Objects can be pushed or popped from the stack or deleted as
21346 * well. Pushes and pops will animate the widget accordingly to its
21347 * style (a pop will also delete the child object once the
21348 * animation is finished). Any object already in the pager can be
21349 * promoted to the top (from its current stacking position) through
21350 * the use of elm_pager_content_promote(). New objects are pushed
21351 * to the top with elm_pager_content_push(). When the top item is
21352 * no longer wanted, simply pop it with elm_pager_content_pop() and
21353 * it will also be deleted. If an object is no longer needed and is
21354 * not the top item, just delete it as normal. You can query which
21355 * objects are the top and bottom with
21356 * elm_pager_content_bottom_get() and elm_pager_content_top_get().
21358 * Signals that you can add callbacks for are:
21359 * - @c "show,finished" - when a new page is actually shown on the top
21360 * - @c "hide,finished" - when a previous page is hidden
21362 * Only after the first of that signals the child object is
21363 * guaranteed to be visible, as in @c evas_object_visible_get().
21365 * This widget has the following styles available:
21368 * - @c "fade_translucide"
21369 * - @c "fade_invisible"
21371 * @note These styles affect only the flipping animations on the
21372 * default theme; the appearance when not animating is unaffected
21375 * @ref tutorial_pager gives a good overview of the usage of the API.
21380 * Add a new pager to the parent
21382 * @param parent The parent object
21383 * @return The new object or NULL if it cannot be created
21387 EAPI Evas_Object *elm_pager_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21390 * @brief Push an object to the top of the pager stack (and show it).
21392 * @param obj The pager object
21393 * @param content The object to push
21395 * The object pushed becomes a child of the pager, it will be controlled and
21396 * deleted when the pager is deleted.
21398 * @note If the content is already in the stack use
21399 * elm_pager_content_promote().
21400 * @warning Using this function on @p content already in the stack results in
21401 * undefined behavior.
21403 EAPI void elm_pager_content_push(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
21406 * @brief Pop the object that is on top of the stack
21408 * @param obj The pager object
21410 * This pops the object that is on the top(visible) of the pager, makes it
21411 * disappear, then deletes the object. The object that was underneath it on
21412 * the stack will become visible.
21414 EAPI void elm_pager_content_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
21417 * @brief Moves an object already in the pager stack to the top of the stack.
21419 * @param obj The pager object
21420 * @param content The object to promote
21422 * This will take the @p content and move it to the top of the stack as
21423 * if it had been pushed there.
21425 * @note If the content isn't already in the stack use
21426 * elm_pager_content_push().
21427 * @warning Using this function on @p content not already in the stack
21428 * results in undefined behavior.
21430 EAPI void elm_pager_content_promote(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
21433 * @brief Return the object at the bottom of the pager stack
21435 * @param obj The pager object
21436 * @return The bottom object or NULL if none
21438 EAPI Evas_Object *elm_pager_content_bottom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21441 * @brief Return the object at the top of the pager stack
21443 * @param obj The pager object
21444 * @return The top object or NULL if none
21446 EAPI Evas_Object *elm_pager_content_top_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21453 * @defgroup Slideshow Slideshow
21455 * @image html img/widget/slideshow/preview-00.png
21456 * @image latex img/widget/slideshow/preview-00.eps
21458 * This widget, as the name indicates, is a pre-made image
21459 * slideshow panel, with API functions acting on (child) image
21460 * items presentation. Between those actions, are:
21461 * - advance to next/previous image
21462 * - select the style of image transition animation
21463 * - set the exhibition time for each image
21464 * - start/stop the slideshow
21466 * The transition animations are defined in the widget's theme,
21467 * consequently new animations can be added without having to
21468 * update the widget's code.
21470 * @section Slideshow_Items Slideshow items
21472 * For slideshow items, just like for @ref Genlist "genlist" ones,
21473 * the user defines a @b classes, specifying functions that will be
21474 * called on the item's creation and deletion times.
21476 * The #Elm_Slideshow_Item_Class structure contains the following
21479 * - @c func.get - When an item is displayed, this function is
21480 * called, and it's where one should create the item object, de
21481 * facto. For example, the object can be a pure Evas image object
21482 * or an Elementary @ref Photocam "photocam" widget. See
21483 * #SlideshowItemGetFunc.
21484 * - @c func.del - When an item is no more displayed, this function
21485 * is called, where the user must delete any data associated to
21486 * the item. See #SlideshowItemDelFunc.
21488 * @section Slideshow_Caching Slideshow caching
21490 * The slideshow provides facilities to have items adjacent to the
21491 * one being displayed <b>already "realized"</b> (i.e. loaded) for
21492 * you, so that the system does not have to decode image data
21493 * anymore at the time it has to actually switch images on its
21494 * viewport. The user is able to set the numbers of items to be
21495 * cached @b before and @b after the current item, in the widget's
21498 * Smart events one can add callbacks for are:
21500 * - @c "changed" - when the slideshow switches its view to a new
21501 * item. event_info parameter in callback contains the current visible item
21502 * - @c "transition,end" - when a slide transition ends. event_info parameter
21503 * in callback contains the current visible item
21505 * List of examples for the slideshow widget:
21506 * @li @ref slideshow_example
21510 * @addtogroup Slideshow
21514 typedef struct _Elm_Slideshow_Item_Class Elm_Slideshow_Item_Class; /**< Slideshow item class definition struct */
21515 typedef struct _Elm_Slideshow_Item_Class_Func Elm_Slideshow_Item_Class_Func; /**< Class functions for slideshow item classes. */
21516 typedef Evas_Object *(*SlideshowItemGetFunc) (void *data, Evas_Object *obj); /**< Image fetching class function for slideshow item classes. */
21517 typedef void (*SlideshowItemDelFunc) (void *data, Evas_Object *obj); /**< Deletion class function for slideshow item classes. */
21520 * @struct _Elm_Slideshow_Item_Class
21522 * Slideshow item class definition. See @ref Slideshow_Items for
21525 struct _Elm_Slideshow_Item_Class
21527 struct _Elm_Slideshow_Item_Class_Func
21529 SlideshowItemGetFunc get;
21530 SlideshowItemDelFunc del;
21532 }; /**< #Elm_Slideshow_Item_Class member definitions */
21535 * Add a new slideshow widget to the given parent Elementary
21536 * (container) object
21538 * @param parent The parent object
21539 * @return A new slideshow widget handle or @c NULL, on errors
21541 * This function inserts a new slideshow widget on the canvas.
21543 * @ingroup Slideshow
21545 EAPI Evas_Object *elm_slideshow_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21548 * Add (append) a new item in a given slideshow widget.
21550 * @param obj The slideshow object
21551 * @param itc The item class for the item
21552 * @param data The item's data
21553 * @return A handle to the item added or @c NULL, on errors
21555 * Add a new item to @p obj's internal list of items, appending it.
21556 * The item's class must contain the function really fetching the
21557 * image object to show for this item, which could be an Evas image
21558 * object or an Elementary photo, for example. The @p data
21559 * parameter is going to be passed to both class functions of the
21562 * @see #Elm_Slideshow_Item_Class
21563 * @see elm_slideshow_item_sorted_insert()
21564 * @see elm_object_item_data_set()
21566 * @ingroup Slideshow
21568 EAPI Elm_Object_Item *elm_slideshow_item_add(Evas_Object *obj, const Elm_Slideshow_Item_Class *itc, const void *data) EINA_ARG_NONNULL(1);
21571 * Insert a new item into the given slideshow widget, using the @p func
21572 * function to sort items (by item handles).
21574 * @param obj The slideshow object
21575 * @param itc The item class for the item
21576 * @param data The item's data
21577 * @param func The comparing function to be used to sort slideshow
21578 * items <b>by #Elm_Slideshow_Item item handles</b>
21579 * @return Returns The slideshow item handle, on success, or
21580 * @c NULL, on errors
21582 * Add a new item to @p obj's internal list of items, in a position
21583 * determined by the @p func comparing function. The item's class
21584 * must contain the function really fetching the image object to
21585 * show for this item, which could be an Evas image object or an
21586 * Elementary photo, for example. The @p data parameter is going to
21587 * be passed to both class functions of the item.
21589 * @see #Elm_Slideshow_Item_Class
21590 * @see elm_slideshow_item_add()
21592 * @ingroup Slideshow
21594 EAPI Elm_Object_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);
21597 * Display a given slideshow widget's item, programmatically.
21599 * @param it The item to display on @p obj's viewport
21601 * The change between the current item and @p item will use the
21602 * transition @p obj is set to use (@see
21603 * elm_slideshow_transition_set()).
21605 * @ingroup Slideshow
21607 EAPI void elm_slideshow_show(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
21610 * Slide to the @b next item, in a given slideshow widget
21612 * @param obj The slideshow object
21614 * The sliding animation @p obj is set to use will be the
21615 * transition effect used, after this call is issued.
21617 * @note If the end of the slideshow's internal list of items is
21618 * reached, it'll wrap around to the list's beginning, again.
21620 * @ingroup Slideshow
21622 EAPI void elm_slideshow_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
21625 * Slide to the @b previous item, in a given slideshow widget
21627 * @param obj The slideshow object
21629 * The sliding animation @p obj is set to use will be the
21630 * transition effect used, after this call is issued.
21632 * @note If the beginning of the slideshow's internal list of items
21633 * is reached, it'll wrap around to the list's end, again.
21635 * @ingroup Slideshow
21637 EAPI void elm_slideshow_previous(Evas_Object *obj) EINA_ARG_NONNULL(1);
21640 * Returns the list of sliding transition/effect names available, for a
21641 * given slideshow widget.
21643 * @param obj The slideshow object
21644 * @return The list of transitions (list of @b stringshared strings
21647 * The transitions, which come from @p obj's theme, must be an EDC
21648 * data item named @c "transitions" on the theme file, with (prefix)
21649 * names of EDC programs actually implementing them.
21651 * The available transitions for slideshows on the default theme are:
21652 * - @c "fade" - the current item fades out, while the new one
21653 * fades in to the slideshow's viewport.
21654 * - @c "black_fade" - the current item fades to black, and just
21655 * then, the new item will fade in.
21656 * - @c "horizontal" - the current item slides horizontally, until
21657 * it gets out of the slideshow's viewport, while the new item
21658 * comes from the left to take its place.
21659 * - @c "vertical" - the current item slides vertically, until it
21660 * gets out of the slideshow's viewport, while the new item comes
21661 * from the bottom to take its place.
21662 * - @c "square" - the new item starts to appear from the middle of
21663 * the current one, but with a tiny size, growing until its
21664 * target (full) size and covering the old one.
21666 * @warning The stringshared strings get no new references
21667 * exclusive to the user grabbing the list, here, so if you'd like
21668 * to use them out of this call's context, you'd better @c
21669 * eina_stringshare_ref() them.
21671 * @see elm_slideshow_transition_set()
21673 * @ingroup Slideshow
21675 EAPI const Eina_List *elm_slideshow_transitions_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21678 * Set the current slide transition/effect in use for a given
21681 * @param obj The slideshow object
21682 * @param transition The new transition's name string
21684 * If @p transition is implemented in @p obj's theme (i.e., is
21685 * contained in the list returned by
21686 * elm_slideshow_transitions_get()), this new sliding effect will
21687 * be used on the widget.
21689 * @see elm_slideshow_transitions_get() for more details
21691 * @ingroup Slideshow
21693 EAPI void elm_slideshow_transition_set(Evas_Object *obj, const char *transition) EINA_ARG_NONNULL(1);
21696 * Get the current slide transition/effect in use for a given
21699 * @param obj The slideshow object
21700 * @return The current transition's name
21702 * @see elm_slideshow_transition_set() for more details
21704 * @ingroup Slideshow
21706 EAPI const char *elm_slideshow_transition_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21709 * Set the interval between each image transition on a given
21710 * slideshow widget, <b>and start the slideshow, itself</b>
21712 * @param obj The slideshow object
21713 * @param timeout The new displaying timeout for images
21715 * After this call, the slideshow widget will start cycling its
21716 * view, sequentially and automatically, with the images of the
21717 * items it has. The time between each new image displayed is going
21718 * to be @p timeout, in @b seconds. If a different timeout was set
21719 * previously and an slideshow was in progress, it will continue
21720 * with the new time between transitions, after this call.
21722 * @note A value less than or equal to 0 on @p timeout will disable
21723 * the widget's internal timer, thus halting any slideshow which
21724 * could be happening on @p obj.
21726 * @see elm_slideshow_timeout_get()
21728 * @ingroup Slideshow
21730 EAPI void elm_slideshow_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
21733 * Get the interval set for image transitions on a given slideshow
21736 * @param obj The slideshow object
21737 * @return Returns the timeout set on it
21739 * @see elm_slideshow_timeout_set() for more details
21741 * @ingroup Slideshow
21743 EAPI double elm_slideshow_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21746 * Set if, after a slideshow is started, for a given slideshow
21747 * widget, its items should be displayed cyclically or not.
21749 * @param obj The slideshow object
21750 * @param loop Use @c EINA_TRUE to make it cycle through items or
21751 * @c EINA_FALSE for it to stop at the end of @p obj's internal
21754 * @note elm_slideshow_next() and elm_slideshow_previous() will @b
21755 * ignore what is set by this functions, i.e., they'll @b always
21756 * cycle through items. This affects only the "automatic"
21757 * slideshow, as set by elm_slideshow_timeout_set().
21759 * @see elm_slideshow_loop_get()
21761 * @ingroup Slideshow
21763 EAPI void elm_slideshow_loop_set(Evas_Object *obj, Eina_Bool loop) EINA_ARG_NONNULL(1);
21766 * Get if, after a slideshow is started, for a given slideshow
21767 * widget, its items are to be displayed cyclically or not.
21769 * @param obj The slideshow object
21770 * @return @c EINA_TRUE, if the items in @p obj will be cycled
21771 * through or @c EINA_FALSE, otherwise
21773 * @see elm_slideshow_loop_set() for more details
21775 * @ingroup Slideshow
21777 EAPI Eina_Bool elm_slideshow_loop_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21780 * Remove all items from a given slideshow widget
21782 * @param obj The slideshow object
21784 * This removes (and deletes) all items in @p obj, leaving it
21787 * @see elm_slideshow_item_del(), to remove just one item.
21789 * @ingroup Slideshow
21791 EAPI void elm_slideshow_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
21794 * Get the internal list of items in a given slideshow widget.
21796 * @param obj The slideshow object
21797 * @return The list of items (#Elm_Object_Item as data) or
21798 * @c NULL on errors.
21800 * This list is @b not to be modified in any way and must not be
21801 * freed. Use the list members with functions like
21802 * elm_slideshow_item_del(), elm_slideshow_item_data_get().
21804 * @warning This list is only valid until @p obj object's internal
21805 * items list is changed. It should be fetched again with another
21806 * call to this function when changes happen.
21808 * @ingroup Slideshow
21810 EAPI const Eina_List *elm_slideshow_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21813 * Delete a given item from a slideshow widget.
21815 * @param it The slideshow item
21817 * @ingroup Slideshow
21819 EAPI void elm_slideshow_item_del(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
21822 * Return the data associated with a given slideshow item
21824 * @param it The slideshow item
21825 * @return Returns the data associated to this item
21827 * @deprecated use elm_object_item_data_get() instead
21828 * @ingroup Slideshow
21830 EINA_DEPRECATED EAPI void *elm_slideshow_item_data_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
21833 * Returns the currently displayed item, in a given slideshow widget
21835 * @param obj The slideshow object
21836 * @return A handle to the item being displayed in @p obj or
21837 * @c NULL, if none is (and on errors)
21839 * @ingroup Slideshow
21841 EAPI Elm_Object_Item *elm_slideshow_item_current_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21844 * Get the real Evas object created to implement the view of a
21845 * given slideshow item
21847 * @param item The slideshow item.
21848 * @return the Evas object implementing this item's view.
21850 * This returns the actual Evas object used to implement the
21851 * specified slideshow item's view. This may be @c NULL, as it may
21852 * not have been created or may have been deleted, at any time, by
21853 * the slideshow. <b>Do not modify this object</b> (move, resize,
21854 * show, hide, etc.), as the slideshow is controlling it. This
21855 * function is for querying, emitting custom signals or hooking
21856 * lower level callbacks for events on that object. Do not delete
21857 * this object under any circumstances.
21859 * @see elm_slideshow_item_data_get()
21861 * @ingroup Slideshow
21863 EAPI Evas_Object* elm_slideshow_item_object_get(const Elm_Object_Item* it) EINA_ARG_NONNULL(1);
21866 * Get the the item, in a given slideshow widget, placed at
21867 * position @p nth, in its internal items list
21869 * @param obj The slideshow object
21870 * @param nth The number of the item to grab a handle to (0 being
21872 * @return The item stored in @p obj at position @p nth or @c NULL,
21873 * if there's no item with that index (and on errors)
21875 * @ingroup Slideshow
21877 EAPI Elm_Object_Item *elm_slideshow_item_nth_get(const Evas_Object *obj, unsigned int nth) EINA_ARG_NONNULL(1);
21880 * Set the current slide layout in use for a given slideshow widget
21882 * @param obj The slideshow object
21883 * @param layout The new layout's name string
21885 * If @p layout is implemented in @p obj's theme (i.e., is contained
21886 * in the list returned by elm_slideshow_layouts_get()), this new
21887 * images layout will be used on the widget.
21889 * @see elm_slideshow_layouts_get() for more details
21891 * @ingroup Slideshow
21893 EAPI void elm_slideshow_layout_set(Evas_Object *obj, const char *layout) EINA_ARG_NONNULL(1);
21896 * Get the current slide layout in use for a given slideshow widget
21898 * @param obj The slideshow object
21899 * @return The current layout's name
21901 * @see elm_slideshow_layout_set() for more details
21903 * @ingroup Slideshow
21905 EAPI const char *elm_slideshow_layout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21908 * Returns the list of @b layout names available, for a given
21909 * slideshow widget.
21911 * @param obj The slideshow object
21912 * @return The list of layouts (list of @b stringshared strings
21915 * Slideshow layouts will change how the widget is to dispose each
21916 * image item in its viewport, with regard to cropping, scaling,
21919 * The layouts, which come from @p obj's theme, must be an EDC
21920 * data item name @c "layouts" on the theme file, with (prefix)
21921 * names of EDC programs actually implementing them.
21923 * The available layouts for slideshows on the default theme are:
21924 * - @c "fullscreen" - item images with original aspect, scaled to
21925 * touch top and down slideshow borders or, if the image's heigh
21926 * is not enough, left and right slideshow borders.
21927 * - @c "not_fullscreen" - the same behavior as the @c "fullscreen"
21928 * one, but always leaving 10% of the slideshow's dimensions of
21929 * distance between the item image's borders and the slideshow
21930 * borders, for each axis.
21932 * @warning The stringshared strings get no new references
21933 * exclusive to the user grabbing the list, here, so if you'd like
21934 * to use them out of this call's context, you'd better @c
21935 * eina_stringshare_ref() them.
21937 * @see elm_slideshow_layout_set()
21939 * @ingroup Slideshow
21941 EAPI const Eina_List *elm_slideshow_layouts_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21944 * Set the number of items to cache, on a given slideshow widget,
21945 * <b>before the current item</b>
21947 * @param obj The slideshow object
21948 * @param count Number of items to cache before the current one
21950 * The default value for this property is @c 2. See
21951 * @ref Slideshow_Caching "slideshow caching" for more details.
21953 * @see elm_slideshow_cache_before_get()
21955 * @ingroup Slideshow
21957 EAPI void elm_slideshow_cache_before_set(Evas_Object *obj, int count) EINA_ARG_NONNULL(1);
21960 * Retrieve the number of items to cache, on a given slideshow widget,
21961 * <b>before the current item</b>
21963 * @param obj The slideshow object
21964 * @return The number of items set to be cached before the current one
21966 * @see elm_slideshow_cache_before_set() for more details
21968 * @ingroup Slideshow
21970 EAPI int elm_slideshow_cache_before_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21973 * Set the number of items to cache, on a given slideshow widget,
21974 * <b>after the current item</b>
21976 * @param obj The slideshow object
21977 * @param count Number of items to cache after the current one
21979 * The default value for this property is @c 2. See
21980 * @ref Slideshow_Caching "slideshow caching" for more details.
21982 * @see elm_slideshow_cache_after_get()
21984 * @ingroup Slideshow
21986 EAPI void elm_slideshow_cache_after_set(Evas_Object *obj, int count) EINA_ARG_NONNULL(1);
21989 * Retrieve the number of items to cache, on a given slideshow widget,
21990 * <b>after the current item</b>
21992 * @param obj The slideshow object
21993 * @return The number of items set to be cached after the current one
21995 * @see elm_slideshow_cache_after_set() for more details
21997 * @ingroup Slideshow
21999 EAPI int elm_slideshow_cache_after_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22002 * Get the number of items stored in a given slideshow widget
22004 * @param obj The slideshow object
22005 * @return The number of items on @p obj, at the moment of this call
22007 * @ingroup Slideshow
22009 EAPI unsigned int elm_slideshow_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22016 * @defgroup Fileselector File Selector
22018 * @image html img/widget/fileselector/preview-00.png
22019 * @image latex img/widget/fileselector/preview-00.eps
22021 * A file selector is a widget that allows a user to navigate
22022 * through a file system, reporting file selections back via its
22025 * It contains shortcut buttons for home directory (@c ~) and to
22026 * jump one directory upwards (..), as well as cancel/ok buttons to
22027 * confirm/cancel a given selection. After either one of those two
22028 * former actions, the file selector will issue its @c "done" smart
22031 * There's a text entry on it, too, showing the name of the current
22032 * selection. There's the possibility of making it editable, so it
22033 * is useful on file saving dialogs on applications, where one
22034 * gives a file name to save contents to, in a given directory in
22035 * the system. This custom file name will be reported on the @c
22036 * "done" smart callback (explained in sequence).
22038 * Finally, it has a view to display file system items into in two
22043 * If Elementary is built with support of the Ethumb thumbnailing
22044 * library, the second form of view will display preview thumbnails
22045 * of files which it supports.
22047 * Smart callbacks one can register to:
22049 * - @c "selected" - the user has clicked on a file (when not in
22050 * folders-only mode) or directory (when in folders-only mode)
22051 * - @c "directory,open" - the list has been populated with new
22052 * content (@c event_info is a pointer to the directory's
22053 * path, a @b stringshared string)
22054 * - @c "done" - the user has clicked on the "ok" or "cancel"
22055 * buttons (@c event_info is a pointer to the selection's
22056 * path, a @b stringshared string)
22058 * Here is an example on its usage:
22059 * @li @ref fileselector_example
22063 * @addtogroup Fileselector
22068 * Defines how a file selector widget is to layout its contents
22069 * (file system entries).
22071 typedef enum _Elm_Fileselector_Mode
22073 ELM_FILESELECTOR_LIST = 0, /**< layout as a list */
22074 ELM_FILESELECTOR_GRID, /**< layout as a grid */
22075 ELM_FILESELECTOR_LAST /**< sentinel (helper) value, not used */
22076 } Elm_Fileselector_Mode;
22079 * Add a new file selector widget to the given parent Elementary
22080 * (container) object
22082 * @param parent The parent object
22083 * @return a new file selector widget handle or @c NULL, on errors
22085 * This function inserts a new file selector widget on the canvas.
22087 * @ingroup Fileselector
22089 EAPI Evas_Object *elm_fileselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22092 * Enable/disable the file name entry box where the user can type
22093 * in a name for a file, in a given file selector widget
22095 * @param obj The file selector object
22096 * @param is_save @c EINA_TRUE to make the file selector a "saving
22097 * dialog", @c EINA_FALSE otherwise
22099 * Having the entry editable is useful on file saving dialogs on
22100 * applications, where one gives a file name to save contents to,
22101 * in a given directory in the system. This custom file name will
22102 * be reported on the @c "done" smart callback.
22104 * @see elm_fileselector_is_save_get()
22106 * @ingroup Fileselector
22108 EAPI void elm_fileselector_is_save_set(Evas_Object *obj, Eina_Bool is_save) EINA_ARG_NONNULL(1);
22111 * Get whether the given file selector is in "saving dialog" mode
22113 * @param obj The file selector object
22114 * @return @c EINA_TRUE, if the file selector is in "saving dialog"
22115 * mode, @c EINA_FALSE otherwise (and on errors)
22117 * @see elm_fileselector_is_save_set() for more details
22119 * @ingroup Fileselector
22121 EAPI Eina_Bool elm_fileselector_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22124 * Enable/disable folder-only view for a given file selector widget
22126 * @param obj The file selector object
22127 * @param only @c EINA_TRUE to make @p obj only display
22128 * directories, @c EINA_FALSE to make files to be displayed in it
22131 * If enabled, the widget's view will only display folder items,
22134 * @see elm_fileselector_folder_only_get()
22136 * @ingroup Fileselector
22138 EAPI void elm_fileselector_folder_only_set(Evas_Object *obj, Eina_Bool only) EINA_ARG_NONNULL(1);
22141 * Get whether folder-only view is set for a given file selector
22144 * @param obj The file selector object
22145 * @return only @c EINA_TRUE if @p obj is only displaying
22146 * directories, @c EINA_FALSE if files are being displayed in it
22147 * too (and on errors)
22149 * @see elm_fileselector_folder_only_get()
22151 * @ingroup Fileselector
22153 EAPI Eina_Bool elm_fileselector_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22156 * Enable/disable the "ok" and "cancel" buttons on a given file
22159 * @param obj The file selector object
22160 * @param only @c EINA_TRUE to show them, @c EINA_FALSE to hide.
22162 * @note A file selector without those buttons will never emit the
22163 * @c "done" smart event, and is only usable if one is just hooking
22164 * to the other two events.
22166 * @see elm_fileselector_buttons_ok_cancel_get()
22168 * @ingroup Fileselector
22170 EAPI void elm_fileselector_buttons_ok_cancel_set(Evas_Object *obj, Eina_Bool buttons) EINA_ARG_NONNULL(1);
22173 * Get whether the "ok" and "cancel" buttons on a given file
22174 * selector widget are being shown.
22176 * @param obj The file selector object
22177 * @return @c EINA_TRUE if they are being shown, @c EINA_FALSE
22178 * otherwise (and on errors)
22180 * @see elm_fileselector_buttons_ok_cancel_set() for more details
22182 * @ingroup Fileselector
22184 EAPI Eina_Bool elm_fileselector_buttons_ok_cancel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22187 * Enable/disable a tree view in the given file selector widget,
22188 * <b>if it's in @c #ELM_FILESELECTOR_LIST mode</b>
22190 * @param obj The file selector object
22191 * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
22194 * In a tree view, arrows are created on the sides of directories,
22195 * allowing them to expand in place.
22197 * @note If it's in other mode, the changes made by this function
22198 * will only be visible when one switches back to "list" mode.
22200 * @see elm_fileselector_expandable_get()
22202 * @ingroup Fileselector
22204 EAPI void elm_fileselector_expandable_set(Evas_Object *obj, Eina_Bool expand) EINA_ARG_NONNULL(1);
22207 * Get whether tree view is enabled for the given file selector
22210 * @param obj The file selector object
22211 * @return @c EINA_TRUE if @p obj is in tree view, @c EINA_FALSE
22212 * otherwise (and or errors)
22214 * @see elm_fileselector_expandable_set() for more details
22216 * @ingroup Fileselector
22218 EAPI Eina_Bool elm_fileselector_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22221 * Set, programmatically, the @b directory that a given file
22222 * selector widget will display contents from
22224 * @param obj The file selector object
22225 * @param path The path to display in @p obj
22227 * This will change the @b directory that @p obj is displaying. It
22228 * will also clear the text entry area on the @p obj object, which
22229 * displays select files' names.
22231 * @see elm_fileselector_path_get()
22233 * @ingroup Fileselector
22235 EAPI void elm_fileselector_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
22238 * Get the parent directory's path that a given file selector
22239 * widget is displaying
22241 * @param obj The file selector object
22242 * @return The (full) path of the directory the file selector is
22243 * displaying, a @b stringshared string
22245 * @see elm_fileselector_path_set()
22247 * @ingroup Fileselector
22249 EAPI const char *elm_fileselector_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22252 * Set, programmatically, the currently selected file/directory in
22253 * the given file selector widget
22255 * @param obj The file selector object
22256 * @param path The (full) path to a file or directory
22257 * @return @c EINA_TRUE on success, @c EINA_FALSE on failure. The
22258 * latter case occurs if the directory or file pointed to do not
22261 * @see elm_fileselector_selected_get()
22263 * @ingroup Fileselector
22265 EAPI Eina_Bool elm_fileselector_selected_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
22268 * Get the currently selected item's (full) path, in the given file
22271 * @param obj The file selector object
22272 * @return The absolute path of the selected item, a @b
22273 * stringshared string
22275 * @note Custom editions on @p obj object's text entry, if made,
22276 * will appear on the return string of this function, naturally.
22278 * @see elm_fileselector_selected_set() for more details
22280 * @ingroup Fileselector
22282 EAPI const char *elm_fileselector_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22285 * Set the mode in which a given file selector widget will display
22286 * (layout) file system entries in its view
22288 * @param obj The file selector object
22289 * @param mode The mode of the fileselector, being it one of
22290 * #ELM_FILESELECTOR_LIST (default) or #ELM_FILESELECTOR_GRID. The
22291 * first one, naturally, will display the files in a list. The
22292 * latter will make the widget to display its entries in a grid
22295 * @note By using elm_fileselector_expandable_set(), the user may
22296 * trigger a tree view for that list.
22298 * @note If Elementary is built with support of the Ethumb
22299 * thumbnailing library, the second form of view will display
22300 * preview thumbnails of files which it supports. You must have
22301 * elm_need_ethumb() called in your Elementary for thumbnailing to
22304 * @see elm_fileselector_expandable_set().
22305 * @see elm_fileselector_mode_get().
22307 * @ingroup Fileselector
22309 EAPI void elm_fileselector_mode_set(Evas_Object *obj, Elm_Fileselector_Mode mode) EINA_ARG_NONNULL(1);
22312 * Get the mode in which a given file selector widget is displaying
22313 * (layouting) file system entries in its view
22315 * @param obj The fileselector object
22316 * @return The mode in which the fileselector is at
22318 * @see elm_fileselector_mode_set() for more details
22320 * @ingroup Fileselector
22322 EAPI Elm_Fileselector_Mode elm_fileselector_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22329 * @defgroup Progressbar Progress bar
22331 * The progress bar is a widget for visually representing the
22332 * progress status of a given job/task.
22334 * A progress bar may be horizontal or vertical. It may display an
22335 * icon besides it, as well as primary and @b units labels. The
22336 * former is meant to label the widget as a whole, while the
22337 * latter, which is formatted with floating point values (and thus
22338 * accepts a <c>printf</c>-style format string, like <c>"%1.2f
22339 * units"</c>), is meant to label the widget's <b>progress
22340 * value</b>. Label, icon and unit strings/objects are @b optional
22341 * for progress bars.
22343 * A progress bar may be @b inverted, in which state it gets its
22344 * values inverted, with high values being on the left or top and
22345 * low values on the right or bottom, as opposed to normally have
22346 * the low values on the former and high values on the latter,
22347 * respectively, for horizontal and vertical modes.
22349 * The @b span of the progress, as set by
22350 * elm_progressbar_span_size_set(), is its length (horizontally or
22351 * vertically), unless one puts size hints on the widget to expand
22352 * on desired directions, by any container. That length will be
22353 * scaled by the object or applications scaling factor. At any
22354 * point code can query the progress bar for its value with
22355 * elm_progressbar_value_get().
22357 * Available widget styles for progress bars:
22359 * - @c "wheel" (simple style, no text, no progression, only
22360 * "pulse" effect is available)
22362 * Default contents parts of the progressbar widget that you can use for are:
22363 * @li "icon" - An icon of the progressbar
22365 * Here is an example on its usage:
22366 * @li @ref progressbar_example
22370 * Add a new progress bar widget to the given parent Elementary
22371 * (container) object
22373 * @param parent The parent object
22374 * @return a new progress bar widget handle or @c NULL, on errors
22376 * This function inserts a new progress bar widget on the canvas.
22378 * @ingroup Progressbar
22380 EAPI Evas_Object *elm_progressbar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22383 * Set whether a given progress bar widget is at "pulsing mode" or
22386 * @param obj The progress bar object
22387 * @param pulse @c EINA_TRUE to put @p obj in pulsing mode,
22388 * @c EINA_FALSE to put it back to its default one
22390 * By default, progress bars will display values from the low to
22391 * high value boundaries. There are, though, contexts in which the
22392 * state of progression of a given task is @b unknown. For those,
22393 * one can set a progress bar widget to a "pulsing state", to give
22394 * the user an idea that some computation is being held, but
22395 * without exact progress values. In the default theme it will
22396 * animate its bar with the contents filling in constantly and back
22397 * to non-filled, in a loop. To start and stop this pulsing
22398 * animation, one has to explicitly call elm_progressbar_pulse().
22400 * @see elm_progressbar_pulse_get()
22401 * @see elm_progressbar_pulse()
22403 * @ingroup Progressbar
22405 EAPI void elm_progressbar_pulse_set(Evas_Object *obj, Eina_Bool pulse) EINA_ARG_NONNULL(1);
22408 * Get whether a given progress bar widget is at "pulsing mode" or
22411 * @param obj The progress bar object
22412 * @return @c EINA_TRUE, if @p obj is in pulsing mode, @c EINA_FALSE
22413 * if it's in the default one (and on errors)
22415 * @ingroup Progressbar
22417 EAPI Eina_Bool elm_progressbar_pulse_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22420 * Start/stop a given progress bar "pulsing" animation, if its
22423 * @param obj The progress bar object
22424 * @param state @c EINA_TRUE, to @b start the pulsing animation,
22425 * @c EINA_FALSE to @b stop it
22427 * @note This call won't do anything if @p obj is not under "pulsing mode".
22429 * @see elm_progressbar_pulse_set() for more details.
22431 * @ingroup Progressbar
22433 EAPI void elm_progressbar_pulse(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
22436 * Set the progress value (in percentage) on a given progress bar
22439 * @param obj The progress bar object
22440 * @param val The progress value (@b must be between @c 0.0 and @c
22443 * Use this call to set progress bar levels.
22445 * @note If you passes a value out of the specified range for @p
22446 * val, it will be interpreted as the @b closest of the @b boundary
22447 * values in the range.
22449 * @ingroup Progressbar
22451 EAPI void elm_progressbar_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
22454 * Get the progress value (in percentage) on a given progress bar
22457 * @param obj The progress bar object
22458 * @return The value of the progressbar
22460 * @see elm_progressbar_value_set() for more details
22462 * @ingroup Progressbar
22464 EAPI double elm_progressbar_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22467 * Set the label of a given progress bar widget
22469 * @param obj The progress bar object
22470 * @param label The text label string, in UTF-8
22472 * @ingroup Progressbar
22473 * @deprecated use elm_object_text_set() instead.
22475 EINA_DEPRECATED EAPI void elm_progressbar_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
22478 * Get the label of a given progress bar widget
22480 * @param obj The progressbar object
22481 * @return The text label string, in UTF-8
22483 * @ingroup Progressbar
22484 * @deprecated use elm_object_text_set() instead.
22486 EINA_DEPRECATED EAPI const char *elm_progressbar_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22489 * Set the icon object of a given progress bar widget
22491 * @param obj The progress bar object
22492 * @param icon The icon object
22494 * Use this call to decorate @p obj with an icon next to it.
22496 * @note Once the icon object is set, a previously set one will be
22497 * deleted. If you want to keep that old content object, use the
22498 * elm_progressbar_icon_unset() function.
22500 * @see elm_progressbar_icon_get()
22501 * @deprecated use elm_object_part_content_set() instead.
22503 * @ingroup Progressbar
22505 EINA_DEPRECATED EAPI void elm_progressbar_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
22508 * Retrieve the icon object set for a given progress bar widget
22510 * @param obj The progress bar object
22511 * @return The icon object's handle, if @p obj had one set, or @c NULL,
22512 * otherwise (and on errors)
22514 * @see elm_progressbar_icon_set() for more details
22515 * @deprecated use elm_object_part_content_get() instead.
22517 * @ingroup Progressbar
22519 EINA_DEPRECATED EAPI Evas_Object *elm_progressbar_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22522 * Unset an icon set on a given progress bar widget
22524 * @param obj The progress bar object
22525 * @return The icon object that was being used, if any was set, or
22526 * @c NULL, otherwise (and on errors)
22528 * This call will unparent and return the icon object which was set
22529 * for this widget, previously, on success.
22531 * @see elm_progressbar_icon_set() for more details
22532 * @deprecated use elm_object_part_content_unset() instead.
22534 * @ingroup Progressbar
22536 EINA_DEPRECATED EAPI Evas_Object *elm_progressbar_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
22539 * Set the (exact) length of the bar region of a given progress bar
22542 * @param obj The progress bar object
22543 * @param size The length of the progress bar's bar region
22545 * This sets the minimum width (when in horizontal mode) or height
22546 * (when in vertical mode) of the actual bar area of the progress
22547 * bar @p obj. This in turn affects the object's minimum size. Use
22548 * this when you're not setting other size hints expanding on the
22549 * given direction (like weight and alignment hints) and you would
22550 * like it to have a specific size.
22552 * @note Icon, label and unit text around @p obj will require their
22553 * own space, which will make @p obj to require more the @p size,
22556 * @see elm_progressbar_span_size_get()
22558 * @ingroup Progressbar
22560 EAPI void elm_progressbar_span_size_set(Evas_Object *obj, Evas_Coord size) EINA_ARG_NONNULL(1);
22563 * Get the length set for the bar region of a given progress bar
22566 * @param obj The progress bar object
22567 * @return The length of the progress bar's bar region
22569 * If that size was not set previously, with
22570 * elm_progressbar_span_size_set(), this call will return @c 0.
22572 * @ingroup Progressbar
22574 EAPI Evas_Coord elm_progressbar_span_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22577 * Set the format string for a given progress bar widget's units
22580 * @param obj The progress bar object
22581 * @param format The format string for @p obj's units label
22583 * If @c NULL is passed on @p format, it will make @p obj's units
22584 * area to be hidden completely. If not, it'll set the <b>format
22585 * string</b> for the units label's @b text. The units label is
22586 * provided a floating point value, so the units text is up display
22587 * at most one floating point falue. Note that the units label is
22588 * optional. Use a format string such as "%1.2f meters" for
22591 * @note The default format string for a progress bar is an integer
22592 * percentage, as in @c "%.0f %%".
22594 * @see elm_progressbar_unit_format_get()
22596 * @ingroup Progressbar
22598 EAPI void elm_progressbar_unit_format_set(Evas_Object *obj, const char *format) EINA_ARG_NONNULL(1);
22601 * Retrieve the format string set for a given progress bar widget's
22604 * @param obj The progress bar object
22605 * @return The format set string for @p obj's units label or
22606 * @c NULL, if none was set (and on errors)
22608 * @see elm_progressbar_unit_format_set() for more details
22610 * @ingroup Progressbar
22612 EAPI const char *elm_progressbar_unit_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22615 * Set the orientation of a given progress bar widget
22617 * @param obj The progress bar object
22618 * @param horizontal Use @c EINA_TRUE to make @p obj to be
22619 * @b horizontal, @c EINA_FALSE to make it @b vertical
22621 * Use this function to change how your progress bar is to be
22622 * disposed: vertically or horizontally.
22624 * @see elm_progressbar_horizontal_get()
22626 * @ingroup Progressbar
22628 EAPI void elm_progressbar_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
22631 * Retrieve the orientation of a given progress bar widget
22633 * @param obj The progress bar object
22634 * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
22635 * @c EINA_FALSE if it's @b vertical (and on errors)
22637 * @see elm_progressbar_horizontal_set() for more details
22639 * @ingroup Progressbar
22641 EAPI Eina_Bool elm_progressbar_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22644 * Invert a given progress bar widget's displaying values order
22646 * @param obj The progress bar object
22647 * @param inverted Use @c EINA_TRUE to make @p obj inverted,
22648 * @c EINA_FALSE to bring it back to default, non-inverted values.
22650 * A progress bar may be @b inverted, in which state it gets its
22651 * values inverted, with high values being on the left or top and
22652 * low values on the right or bottom, as opposed to normally have
22653 * the low values on the former and high values on the latter,
22654 * respectively, for horizontal and vertical modes.
22656 * @see elm_progressbar_inverted_get()
22658 * @ingroup Progressbar
22660 EAPI void elm_progressbar_inverted_set(Evas_Object *obj, Eina_Bool inverted) EINA_ARG_NONNULL(1);
22663 * Get whether a given progress bar widget's displaying values are
22666 * @param obj The progress bar object
22667 * @return @c EINA_TRUE, if @p obj has inverted values,
22668 * @c EINA_FALSE otherwise (and on errors)
22670 * @see elm_progressbar_inverted_set() for more details
22672 * @ingroup Progressbar
22674 EAPI Eina_Bool elm_progressbar_inverted_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22677 * @defgroup Separator Separator
22679 * @brief Separator is a very thin object used to separate other objects.
22681 * A separator can be vertical or horizontal.
22683 * @ref tutorial_separator is a good example of how to use a separator.
22687 * @brief Add a separator object to @p parent
22689 * @param parent The parent object
22691 * @return The separator object, or NULL upon failure
22693 EAPI Evas_Object *elm_separator_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22695 * @brief Set the horizontal mode of a separator object
22697 * @param obj The separator object
22698 * @param horizontal If true, the separator is horizontal
22700 EAPI void elm_separator_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
22702 * @brief Get the horizontal mode of a separator object
22704 * @param obj The separator object
22705 * @return If true, the separator is horizontal
22707 * @see elm_separator_horizontal_set()
22709 EAPI Eina_Bool elm_separator_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22715 * @defgroup Spinner Spinner
22716 * @ingroup Elementary
22718 * @image html img/widget/spinner/preview-00.png
22719 * @image latex img/widget/spinner/preview-00.eps
22721 * A spinner is a widget which allows the user to increase or decrease
22722 * numeric values using arrow buttons, or edit values directly, clicking
22723 * over it and typing the new value.
22725 * By default the spinner will not wrap and has a label
22726 * of "%.0f" (just showing the integer value of the double).
22728 * A spinner has a label that is formatted with floating
22729 * point values and thus accepts a printf-style format string, like
22730 * ā%1.2f unitsā.
22732 * It also allows specific values to be replaced by pre-defined labels.
22734 * Smart callbacks one can register to:
22736 * - "changed" - Whenever the spinner value is changed.
22737 * - "delay,changed" - A short time after the value is changed by the user.
22738 * This will be called only when the user stops dragging for a very short
22739 * period or when they release their finger/mouse, so it avoids possibly
22740 * expensive reactions to the value change.
22742 * Available styles for it:
22744 * - @c "vertical": up/down buttons at the right side and text left aligned.
22746 * Here is an example on its usage:
22747 * @ref spinner_example
22751 * @addtogroup Spinner
22756 * Add a new spinner widget to the given parent Elementary
22757 * (container) object.
22759 * @param parent The parent object.
22760 * @return a new spinner widget handle or @c NULL, on errors.
22762 * This function inserts a new spinner widget on the canvas.
22767 EAPI Evas_Object *elm_spinner_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22770 * Set the format string of the displayed label.
22772 * @param obj The spinner object.
22773 * @param fmt The format string for the label display.
22775 * If @c NULL, this sets the format to "%.0f". If not it sets the format
22776 * string for the label text. The label text is provided a floating point
22777 * value, so the label text can display up to 1 floating point value.
22778 * Note that this is optional.
22780 * Use a format string such as "%1.2f meters" for example, and it will
22781 * display values like: "3.14 meters" for a value equal to 3.14159.
22783 * Default is "%0.f".
22785 * @see elm_spinner_label_format_get()
22789 EAPI void elm_spinner_label_format_set(Evas_Object *obj, const char *fmt) EINA_ARG_NONNULL(1);
22792 * Get the label format of the spinner.
22794 * @param obj The spinner object.
22795 * @return The text label format string in UTF-8.
22797 * @see elm_spinner_label_format_set() for details.
22801 EAPI const char *elm_spinner_label_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22804 * Set the minimum and maximum values for the spinner.
22806 * @param obj The spinner object.
22807 * @param min The minimum value.
22808 * @param max The maximum value.
22810 * Define the allowed range of values to be selected by the user.
22812 * If actual value is less than @p min, it will be updated to @p min. If it
22813 * is bigger then @p max, will be updated to @p max. Actual value can be
22814 * get with elm_spinner_value_get().
22816 * By default, min is equal to 0, and max is equal to 100.
22818 * @warning Maximum must be greater than minimum.
22820 * @see elm_spinner_min_max_get()
22824 EAPI void elm_spinner_min_max_set(Evas_Object *obj, double min, double max) EINA_ARG_NONNULL(1);
22827 * Get the minimum and maximum values of the spinner.
22829 * @param obj The spinner object.
22830 * @param min Pointer where to store the minimum value.
22831 * @param max Pointer where to store the maximum value.
22833 * @note If only one value is needed, the other pointer can be passed
22836 * @see elm_spinner_min_max_set() for details.
22840 EAPI void elm_spinner_min_max_get(const Evas_Object *obj, double *min, double *max) EINA_ARG_NONNULL(1);
22843 * Set the step used to increment or decrement the spinner value.
22845 * @param obj The spinner object.
22846 * @param step The step value.
22848 * This value will be incremented or decremented to the displayed value.
22849 * It will be incremented while the user keep right or top arrow pressed,
22850 * and will be decremented while the user keep left or bottom arrow pressed.
22852 * The interval to increment / decrement can be set with
22853 * elm_spinner_interval_set().
22855 * By default step value is equal to 1.
22857 * @see elm_spinner_step_get()
22861 EAPI void elm_spinner_step_set(Evas_Object *obj, double step) EINA_ARG_NONNULL(1);
22864 * Get the step used to increment or decrement the spinner value.
22866 * @param obj The spinner object.
22867 * @return The step value.
22869 * @see elm_spinner_step_get() for more details.
22873 EAPI double elm_spinner_step_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22876 * Set the value the spinner displays.
22878 * @param obj The spinner object.
22879 * @param val The value to be displayed.
22881 * Value will be presented on the label following format specified with
22882 * elm_spinner_format_set().
22884 * @warning The value must to be between min and max values. This values
22885 * are set by elm_spinner_min_max_set().
22887 * @see elm_spinner_value_get().
22888 * @see elm_spinner_format_set().
22889 * @see elm_spinner_min_max_set().
22893 EAPI void elm_spinner_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
22896 * Get the value displayed by the spinner.
22898 * @param obj The spinner object.
22899 * @return The value displayed.
22901 * @see elm_spinner_value_set() for details.
22905 EAPI double elm_spinner_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22908 * Set whether the spinner should wrap when it reaches its
22909 * minimum or maximum value.
22911 * @param obj The spinner object.
22912 * @param wrap @c EINA_TRUE to enable wrap or @c EINA_FALSE to
22915 * Disabled by default. If disabled, when the user tries to increment the
22917 * but displayed value plus step value is bigger than maximum value,
22919 * won't allow it. The same happens when the user tries to decrement it,
22920 * but the value less step is less than minimum value.
22922 * When wrap is enabled, in such situations it will allow these changes,
22923 * but will get the value that would be less than minimum and subtracts
22924 * from maximum. Or add the value that would be more than maximum to
22928 * @li min value = 10
22929 * @li max value = 50
22930 * @li step value = 20
22931 * @li displayed value = 20
22933 * When the user decrement value (using left or bottom arrow), it will
22934 * displays @c 40, because max - (min - (displayed - step)) is
22935 * @c 50 - (@c 10 - (@c 20 - @c 20)) = @c 40.
22937 * @see elm_spinner_wrap_get().
22941 EAPI void elm_spinner_wrap_set(Evas_Object *obj, Eina_Bool wrap) EINA_ARG_NONNULL(1);
22944 * Get whether the spinner should wrap when it reaches its
22945 * minimum or maximum value.
22947 * @param obj The spinner object
22948 * @return @c EINA_TRUE means wrap is enabled. @c EINA_FALSE indicates
22949 * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
22951 * @see elm_spinner_wrap_set() for details.
22955 EAPI Eina_Bool elm_spinner_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22958 * Set whether the spinner can be directly edited by the user or not.
22960 * @param obj The spinner object.
22961 * @param editable @c EINA_TRUE to allow users to edit it or @c EINA_FALSE to
22962 * don't allow users to edit it directly.
22964 * Spinner objects can have edition @b disabled, in which state they will
22965 * be changed only by arrows.
22966 * Useful for contexts
22967 * where you don't want your users to interact with it writting the value.
22969 * when using special values, the user can see real value instead
22970 * of special label on edition.
22972 * It's enabled by default.
22974 * @see elm_spinner_editable_get()
22978 EAPI void elm_spinner_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
22981 * Get whether the spinner can be directly edited by the user or not.
22983 * @param obj The spinner object.
22984 * @return @c EINA_TRUE means edition is enabled. @c EINA_FALSE indicates
22985 * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
22987 * @see elm_spinner_editable_set() for details.
22991 EAPI Eina_Bool elm_spinner_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22994 * Set a special string to display in the place of the numerical value.
22996 * @param obj The spinner object.
22997 * @param value The value to be replaced.
22998 * @param label The label to be used.
23000 * It's useful for cases when a user should select an item that is
23001 * better indicated by a label than a value. For example, weekdays or months.
23005 * sp = elm_spinner_add(win);
23006 * elm_spinner_min_max_set(sp, 1, 3);
23007 * elm_spinner_special_value_add(sp, 1, "January");
23008 * elm_spinner_special_value_add(sp, 2, "February");
23009 * elm_spinner_special_value_add(sp, 3, "March");
23010 * evas_object_show(sp);
23015 EAPI void elm_spinner_special_value_add(Evas_Object *obj, double value, const char *label) EINA_ARG_NONNULL(1);
23018 * Set the interval on time updates for an user mouse button hold
23019 * on spinner widgets' arrows.
23021 * @param obj The spinner object.
23022 * @param interval The (first) interval value in seconds.
23024 * This interval value is @b decreased while the user holds the
23025 * mouse pointer either incrementing or decrementing spinner's value.
23027 * This helps the user to get to a given value distant from the
23028 * current one easier/faster, as it will start to change quicker and
23029 * quicker on mouse button holds.
23031 * The calculation for the next change interval value, starting from
23032 * the one set with this call, is the previous interval divided by
23033 * @c 1.05, so it decreases a little bit.
23035 * The default starting interval value for automatic changes is
23038 * @see elm_spinner_interval_get()
23042 EAPI void elm_spinner_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
23045 * Get the interval on time updates for an user mouse button hold
23046 * on spinner widgets' arrows.
23048 * @param obj The spinner object.
23049 * @return The (first) interval value, in seconds, set on it.
23051 * @see elm_spinner_interval_set() for more details.
23055 EAPI double elm_spinner_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23062 * @defgroup Index Index
23064 * @image html img/widget/index/preview-00.png
23065 * @image latex img/widget/index/preview-00.eps
23067 * An index widget gives you an index for fast access to whichever
23068 * group of other UI items one might have. It's a list of text
23069 * items (usually letters, for alphabetically ordered access).
23071 * Index widgets are by default hidden and just appear when the
23072 * user clicks over it's reserved area in the canvas. In its
23073 * default theme, it's an area one @ref Fingers "finger" wide on
23074 * the right side of the index widget's container.
23076 * When items on the index are selected, smart callbacks get
23077 * called, so that its user can make other container objects to
23078 * show a given area or child object depending on the index item
23079 * selected. You'd probably be using an index together with @ref
23080 * List "lists", @ref Genlist "generic lists" or @ref Gengrid
23083 * Smart events one can add callbacks for are:
23084 * - @c "changed" - When the selected index item changes. @c
23085 * event_info is the selected item's data pointer.
23086 * - @c "delay,changed" - When the selected index item changes, but
23087 * after a small idling period. @c event_info is the selected
23088 * item's data pointer.
23089 * - @c "selected" - When the user releases a mouse button and
23090 * selects an item. @c event_info is the selected item's data
23092 * - @c "level,up" - when the user moves a finger from the first
23093 * level to the second level
23094 * - @c "level,down" - when the user moves a finger from the second
23095 * level to the first level
23097 * The @c "delay,changed" event is so that it'll wait a small time
23098 * before actually reporting those events and, moreover, just the
23099 * last event happening on those time frames will actually be
23102 * Here are some examples on its usage:
23103 * @li @ref index_example_01
23104 * @li @ref index_example_02
23108 * @addtogroup Index
23112 typedef struct _Elm_Index_Item Elm_Index_Item; /**< Opaque handle for items of Elementary index widgets */
23115 * Add a new index widget to the given parent Elementary
23116 * (container) object
23118 * @param parent The parent object
23119 * @return a new index widget handle or @c NULL, on errors
23121 * This function inserts a new index widget on the canvas.
23125 EAPI Evas_Object *elm_index_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
23128 * Set whether a given index widget is or not visible,
23131 * @param obj The index object
23132 * @param active @c EINA_TRUE to show it, @c EINA_FALSE to hide it
23134 * Not to be confused with visible as in @c evas_object_show() --
23135 * visible with regard to the widget's auto hiding feature.
23137 * @see elm_index_active_get()
23141 EAPI void elm_index_active_set(Evas_Object *obj, Eina_Bool active) EINA_ARG_NONNULL(1);
23144 * Get whether a given index widget is currently visible or not.
23146 * @param obj The index object
23147 * @return @c EINA_TRUE, if it's shown, @c EINA_FALSE otherwise
23149 * @see elm_index_active_set() for more details
23153 EAPI Eina_Bool elm_index_active_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23156 * Set the items level for a given index widget.
23158 * @param obj The index object.
23159 * @param level @c 0 or @c 1, the currently implemented levels.
23161 * @see elm_index_item_level_get()
23165 EAPI void elm_index_item_level_set(Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
23168 * Get the items level set for a given index widget.
23170 * @param obj The index object.
23171 * @return @c 0 or @c 1, which are the levels @p obj might be at.
23173 * @see elm_index_item_level_set() for more information
23177 EAPI int elm_index_item_level_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23180 * Returns the last selected item, for a given index widget.
23182 * @param obj The index object.
23183 * @return The last item @b selected on @p obj (or @c NULL, on errors).
23187 EAPI Elm_Index_Item *elm_index_item_selected_get(const Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
23190 * Append a new item on a given index widget.
23192 * @param obj The index object.
23193 * @param letter Letter under which the item should be indexed
23194 * @param item The item data to set for the index's item
23196 * Despite the most common usage of the @p letter argument is for
23197 * single char strings, one could use arbitrary strings as index
23200 * @c item will be the pointer returned back on @c "changed", @c
23201 * "delay,changed" and @c "selected" smart events.
23205 EAPI void elm_index_item_append(Evas_Object *obj, const char *letter, const void *item) EINA_ARG_NONNULL(1);
23208 * Prepend a new item on a given index widget.
23210 * @param obj The index object.
23211 * @param letter Letter under which the item should be indexed
23212 * @param item The item data to set for the index's item
23214 * Despite the most common usage of the @p letter argument is for
23215 * single char strings, one could use arbitrary strings as index
23218 * @c item will be the pointer returned back on @c "changed", @c
23219 * "delay,changed" and @c "selected" smart events.
23223 EAPI void elm_index_item_prepend(Evas_Object *obj, const char *letter, const void *item) EINA_ARG_NONNULL(1);
23226 * Append a new item, on a given index widget, <b>after the item
23227 * having @p relative as data</b>.
23229 * @param obj The index object.
23230 * @param letter Letter under which the item should be indexed
23231 * @param item The item data to set for the index's item
23232 * @param relative The index item to be the predecessor of this new one
23234 * Despite the most common usage of the @p letter argument is for
23235 * single char strings, one could use arbitrary strings as index
23238 * @c item will be the pointer returned back on @c "changed", @c
23239 * "delay,changed" and @c "selected" smart events.
23241 * @note If @p relative is @c NULL this function will behave as
23242 * elm_index_item_append().
23246 EAPI void elm_index_item_append_relative(Evas_Object *obj, const char *letter, const void *item, const Elm_Index_Item *relative) EINA_ARG_NONNULL(1);
23249 * Prepend a new item, on a given index widget, <b>after the item
23250 * having @p relative as data</b>.
23252 * @param obj The index object.
23253 * @param letter Letter under which the item should be indexed
23254 * @param item The item data to set for the index's item
23255 * @param relative The index item to be the successor of this new one
23257 * Despite the most common usage of the @p letter argument is for
23258 * single char strings, one could use arbitrary strings as index
23261 * @c item will be the pointer returned back on @c "changed", @c
23262 * "delay,changed" and @c "selected" smart events.
23264 * @note If @p relative is @c NULL this function will behave as
23265 * elm_index_item_prepend().
23269 EAPI void elm_index_item_prepend_relative(Evas_Object *obj, const char *letter, const void *item, const Elm_Index_Item *relative) EINA_ARG_NONNULL(1);
23272 * Insert a new item into the given index widget, using @p cmp_func
23273 * function to sort items (by item handles).
23275 * @param obj The index object.
23276 * @param letter Letter under which the item should be indexed
23277 * @param item The item data to set for the index's item
23278 * @param cmp_func The comparing function to be used to sort index
23279 * items <b>by #Elm_Index_Item item handles</b>
23280 * @param cmp_data_func A @b fallback function to be called for the
23281 * sorting of index items <b>by item data</b>). It will be used
23282 * when @p cmp_func returns @c 0 (equality), which means an index
23283 * item with provided item data already exists. To decide which
23284 * data item should be pointed to by the index item in question, @p
23285 * cmp_data_func will be used. If @p cmp_data_func returns a
23286 * non-negative value, the previous index item data will be
23287 * replaced by the given @p item pointer. If the previous data need
23288 * to be freed, it should be done by the @p cmp_data_func function,
23289 * because all references to it will be lost. If this function is
23290 * not provided (@c NULL is given), index items will be @b
23291 * duplicated, if @p cmp_func returns @c 0.
23293 * Despite the most common usage of the @p letter argument is for
23294 * single char strings, one could use arbitrary strings as index
23297 * @c item will be the pointer returned back on @c "changed", @c
23298 * "delay,changed" and @c "selected" smart events.
23302 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);
23305 * Remove an item from a given index widget, <b>to be referenced by
23306 * it's data value</b>.
23308 * @param obj The index object
23309 * @param item The item to be removed from @p obj
23311 * If a deletion callback is set, via elm_index_item_del_cb_set(),
23312 * that callback function will be called by this one.
23316 EAPI void elm_index_item_del(Evas_Object *obj, Elm_Index_Item *item) EINA_ARG_NONNULL(1);
23319 * Find a given index widget's item, <b>using item data</b>.
23321 * @param obj The index object
23322 * @param item The item data pointed to by the desired index item
23323 * @return The index item handle, if found, or @c NULL otherwise
23327 EAPI Elm_Index_Item *elm_index_item_find(Evas_Object *obj, const void *item) EINA_ARG_NONNULL(1);
23330 * Removes @b all items from a given index widget.
23332 * @param obj The index object.
23334 * If deletion callbacks are set, via elm_index_item_del_cb_set(),
23335 * that callback function will be called for each item in @p obj.
23339 EAPI void elm_index_item_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
23342 * Go to a given items level on a index widget
23344 * @param obj The index object
23345 * @param level The index level (one of @c 0 or @c 1)
23349 EAPI void elm_index_item_go(Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
23352 * Return the data associated with a given index widget item
23354 * @param it The index widget item handle
23355 * @return The data associated with @p it
23357 * @see elm_index_item_data_set()
23361 EAPI void *elm_index_item_data_get(const Elm_Index_Item *item) EINA_ARG_NONNULL(1);
23364 * Set the data associated with a given index widget item
23366 * @param it The index widget item handle
23367 * @param data The new data pointer to set to @p it
23369 * This sets new item data on @p it.
23371 * @warning The old data pointer won't be touched by this function, so
23372 * the user had better to free that old data himself/herself.
23376 EAPI void elm_index_item_data_set(Elm_Index_Item *it, const void *data) EINA_ARG_NONNULL(1);
23379 * Set the function to be called when a given index widget item is freed.
23381 * @param it The item to set the callback on
23382 * @param func The function to call on the item's deletion
23384 * When called, @p func will have both @c data and @c event_info
23385 * arguments with the @p it item's data value and, naturally, the
23386 * @c obj argument with a handle to the parent index widget.
23390 EAPI void elm_index_item_del_cb_set(Elm_Index_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
23393 * Get the letter (string) set on a given index widget item.
23395 * @param it The index item handle
23396 * @return The letter string set on @p it
23400 EAPI const char *elm_index_item_letter_get(const Elm_Index_Item *item) EINA_ARG_NONNULL(1);
23407 * @defgroup Photocam Photocam
23409 * @image html img/widget/photocam/preview-00.png
23410 * @image latex img/widget/photocam/preview-00.eps
23412 * This is a widget specifically for displaying high-resolution digital
23413 * camera photos giving speedy feedback (fast load), low memory footprint
23414 * and zooming and panning as well as fitting logic. It is entirely focused
23415 * on jpeg images, and takes advantage of properties of the jpeg format (via
23416 * evas loader features in the jpeg loader).
23418 * Signals that you can add callbacks for are:
23419 * @li "clicked" - This is called when a user has clicked the photo without
23421 * @li "press" - This is called when a user has pressed down on the photo.
23422 * @li "longpressed" - This is called when a user has pressed down on the
23423 * photo for a long time without dragging around.
23424 * @li "clicked,double" - This is called when a user has double-clicked the
23426 * @li "load" - Photo load begins.
23427 * @li "loaded" - This is called when the image file load is complete for the
23428 * first view (low resolution blurry version).
23429 * @li "load,detail" - Photo detailed data load begins.
23430 * @li "loaded,detail" - This is called when the image file load is complete
23431 * for the detailed image data (full resolution needed).
23432 * @li "zoom,start" - Zoom animation started.
23433 * @li "zoom,stop" - Zoom animation stopped.
23434 * @li "zoom,change" - Zoom changed when using an auto zoom mode.
23435 * @li "scroll" - the content has been scrolled (moved)
23436 * @li "scroll,anim,start" - scrolling animation has started
23437 * @li "scroll,anim,stop" - scrolling animation has stopped
23438 * @li "scroll,drag,start" - dragging the contents around has started
23439 * @li "scroll,drag,stop" - dragging the contents around has stopped
23441 * @ref tutorial_photocam shows the API in action.
23446 * @brief Types of zoom available.
23448 typedef enum _Elm_Photocam_Zoom_Mode
23450 ELM_PHOTOCAM_ZOOM_MODE_MANUAL = 0, /**< Zoom controlled normally by elm_photocam_zoom_set */
23451 ELM_PHOTOCAM_ZOOM_MODE_AUTO_FIT, /**< Zoom until photo fits in photocam */
23452 ELM_PHOTOCAM_ZOOM_MODE_AUTO_FILL, /**< Zoom until photo fills photocam */
23453 ELM_PHOTOCAM_ZOOM_MODE_AUTO_FIT_IN, /**< Unzoom until photo fits in photocam */
23454 ELM_PHOTOCAM_ZOOM_MODE_LAST
23455 } Elm_Photocam_Zoom_Mode;
23458 * @brief Add a new Photocam object
23460 * @param parent The parent object
23461 * @return The new object or NULL if it cannot be created
23463 EAPI Evas_Object *elm_photocam_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
23466 * @brief Set the photo file to be shown
23468 * @param obj The photocam object
23469 * @param file The photo file
23470 * @return The return error (see EVAS_LOAD_ERROR_NONE, EVAS_LOAD_ERROR_GENERIC etc.)
23472 * This sets (and shows) the specified file (with a relative or absolute
23473 * path) and will return a load error (same error that
23474 * evas_object_image_load_error_get() will return). The image will change and
23475 * adjust its size at this point and begin a background load process for this
23476 * photo that at some time in the future will be displayed at the full
23479 EAPI Evas_Load_Error elm_photocam_file_set(Evas_Object *obj, const char *file) EINA_ARG_NONNULL(1);
23482 * @brief Returns the path of the current image file
23484 * @param obj The photocam object
23485 * @return Returns the path
23487 * @see elm_photocam_file_set()
23489 EAPI const char *elm_photocam_file_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23492 * @brief Set the zoom level of the photo
23494 * @param obj The photocam object
23495 * @param zoom The zoom level to set
23497 * This sets the zoom level. 1 will be 1:1 pixel for pixel. 2 will be 2:1
23498 * (that is 2x2 photo pixels will display as 1 on-screen pixel). 4:1 will be
23499 * 4x4 photo pixels as 1 screen pixel, and so on. The @p zoom parameter must
23500 * be greater than 0. It is usggested to stick to powers of 2. (1, 2, 4, 8,
23503 EAPI void elm_photocam_zoom_set(Evas_Object *obj, double zoom) EINA_ARG_NONNULL(1);
23506 * @brief Get the zoom level of the photo
23508 * @param obj The photocam object
23509 * @return The current zoom level
23511 * This returns the current zoom level of the photocam object. Note that if
23512 * you set the fill mode to other than ELM_PHOTOCAM_ZOOM_MODE_MANUAL
23513 * (which is the default), the zoom level may be changed at any time by the
23514 * photocam object itself to account for photo size and photocam viewpoer
23517 * @see elm_photocam_zoom_set()
23518 * @see elm_photocam_zoom_mode_set()
23520 EAPI double elm_photocam_zoom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23523 * @brief Set the zoom mode
23525 * @param obj The photocam object
23526 * @param mode The desired mode
23528 * This sets the zoom mode to manual or one of several automatic levels.
23529 * Manual (ELM_PHOTOCAM_ZOOM_MODE_MANUAL) means that zoom is set manually by
23530 * elm_photocam_zoom_set() and will stay at that level until changed by code
23531 * or until zoom mode is changed. This is the default mode. The Automatic
23532 * modes will allow the photocam object to automatically adjust zoom mode
23533 * based on properties. ELM_PHOTOCAM_ZOOM_MODE_AUTO_FIT) will adjust zoom so
23534 * the photo fits EXACTLY inside the scroll frame with no pixels outside this
23535 * area. ELM_PHOTOCAM_ZOOM_MODE_AUTO_FILL will be similar but ensure no
23536 * pixels within the frame are left unfilled.
23538 EAPI void elm_photocam_zoom_mode_set(Evas_Object *obj, Elm_Photocam_Zoom_Mode mode) EINA_ARG_NONNULL(1);
23541 * @brief Get the zoom mode
23543 * @param obj The photocam object
23544 * @return The current zoom mode
23546 * This gets the current zoom mode of the photocam object.
23548 * @see elm_photocam_zoom_mode_set()
23550 EAPI Elm_Photocam_Zoom_Mode elm_photocam_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23553 * @brief Get the current image pixel width and height
23555 * @param obj The photocam object
23556 * @param w A pointer to the width return
23557 * @param h A pointer to the height return
23559 * This gets the current photo pixel width and height (for the original).
23560 * The size will be returned in the integers @p w and @p h that are pointed
23563 EAPI void elm_photocam_image_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
23566 * @brief Get the area of the image that is currently shown
23569 * @param x A pointer to the X-coordinate of region
23570 * @param y A pointer to the Y-coordinate of region
23571 * @param w A pointer to the width
23572 * @param h A pointer to the height
23574 * @see elm_photocam_image_region_show()
23575 * @see elm_photocam_image_region_bring_in()
23577 EAPI void elm_photocam_region_get(const Evas_Object *obj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
23580 * @brief Set the viewed portion of the image
23582 * @param obj The photocam object
23583 * @param x X-coordinate of region in image original pixels
23584 * @param y Y-coordinate of region in image original pixels
23585 * @param w Width of region in image original pixels
23586 * @param h Height of region in image original pixels
23588 * This shows the region of the image without using animation.
23590 EAPI void elm_photocam_image_region_show(Evas_Object *obj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
23593 * @brief Bring in the viewed portion of the image
23595 * @param obj The photocam object
23596 * @param x X-coordinate of region in image original pixels
23597 * @param y Y-coordinate of region in image original pixels
23598 * @param w Width of region in image original pixels
23599 * @param h Height of region in image original pixels
23601 * This shows the region of the image using animation.
23603 EAPI void elm_photocam_image_region_bring_in(Evas_Object *obj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
23606 * @brief Set the paused state for photocam
23608 * @param obj The photocam object
23609 * @param paused The pause state to set
23611 * This sets the paused state to on(EINA_TRUE) or off (EINA_FALSE) for
23612 * photocam. The default is off. This will stop zooming using animation on
23613 * zoom levels changes and change instantly. This will stop any existing
23614 * animations that are running.
23616 EAPI void elm_photocam_paused_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
23619 * @brief Get the paused state for photocam
23621 * @param obj The photocam object
23622 * @return The current paused state
23624 * This gets the current paused state for the photocam object.
23626 * @see elm_photocam_paused_set()
23628 EAPI Eina_Bool elm_photocam_paused_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23631 * @brief Get the internal low-res image used for photocam
23633 * @param obj The photocam object
23634 * @return The internal image object handle, or NULL if none exists
23636 * This gets the internal image object inside photocam. Do not modify it. It
23637 * is for inspection only, and hooking callbacks to. Nothing else. It may be
23638 * deleted at any time as well.
23640 EAPI Evas_Object *elm_photocam_internal_image_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23643 * @brief Set the photocam scrolling bouncing.
23645 * @param obj The photocam object
23646 * @param h_bounce bouncing for horizontal
23647 * @param v_bounce bouncing for vertical
23649 EAPI void elm_photocam_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
23652 * @brief Get the photocam scrolling bouncing.
23654 * @param obj The photocam object
23655 * @param h_bounce bouncing for horizontal
23656 * @param v_bounce bouncing for vertical
23658 * @see elm_photocam_bounce_set()
23660 EAPI void elm_photocam_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
23667 * @defgroup Map Map
23668 * @ingroup Elementary
23670 * @image html img/widget/map/preview-00.png
23671 * @image latex img/widget/map/preview-00.eps
23673 * This is a widget specifically for displaying a map. It uses basically
23674 * OpenStreetMap provider http://www.openstreetmap.org/,
23675 * but custom providers can be added.
23677 * It supports some basic but yet nice features:
23678 * @li zoom and scroll
23679 * @li markers with content to be displayed when user clicks over it
23680 * @li group of markers
23683 * Smart callbacks one can listen to:
23685 * - "clicked" - This is called when a user has clicked the map without
23687 * - "press" - This is called when a user has pressed down on the map.
23688 * - "longpressed" - This is called when a user has pressed down on the map
23689 * for a long time without dragging around.
23690 * - "clicked,double" - This is called when a user has double-clicked
23692 * - "load,detail" - Map detailed data load begins.
23693 * - "loaded,detail" - This is called when all currently visible parts of
23694 * the map are loaded.
23695 * - "zoom,start" - Zoom animation started.
23696 * - "zoom,stop" - Zoom animation stopped.
23697 * - "zoom,change" - Zoom changed when using an auto zoom mode.
23698 * - "scroll" - the content has been scrolled (moved).
23699 * - "scroll,anim,start" - scrolling animation has started.
23700 * - "scroll,anim,stop" - scrolling animation has stopped.
23701 * - "scroll,drag,start" - dragging the contents around has started.
23702 * - "scroll,drag,stop" - dragging the contents around has stopped.
23703 * - "downloaded" - This is called when all currently required map images
23705 * - "route,load" - This is called when route request begins.
23706 * - "route,loaded" - This is called when route request ends.
23707 * - "name,load" - This is called when name request begins.
23708 * - "name,loaded- This is called when name request ends.
23710 * Available style for map widget:
23713 * Available style for markers:
23718 * Available style for marker bubble:
23721 * List of examples:
23722 * @li @ref map_example_01
23723 * @li @ref map_example_02
23724 * @li @ref map_example_03
23733 * @enum _Elm_Map_Zoom_Mode
23734 * @typedef Elm_Map_Zoom_Mode
23736 * Set map's zoom behavior. It can be set to manual or automatic.
23738 * Default value is #ELM_MAP_ZOOM_MODE_MANUAL.
23740 * Values <b> don't </b> work as bitmask, only one can be choosen.
23742 * @note Valid sizes are 2^zoom, consequently the map may be smaller
23743 * than the scroller view.
23745 * @see elm_map_zoom_mode_set()
23746 * @see elm_map_zoom_mode_get()
23750 typedef enum _Elm_Map_Zoom_Mode
23752 ELM_MAP_ZOOM_MODE_MANUAL, /**< Zoom controlled manually by elm_map_zoom_set(). It's set by default. */
23753 ELM_MAP_ZOOM_MODE_AUTO_FIT, /**< Zoom until map fits inside the scroll frame with no pixels outside this area. */
23754 ELM_MAP_ZOOM_MODE_AUTO_FILL, /**< Zoom until map fills scroll, ensuring no pixels are left unfilled. */
23755 ELM_MAP_ZOOM_MODE_LAST
23756 } Elm_Map_Zoom_Mode;
23759 * @enum _Elm_Map_Route_Sources
23760 * @typedef Elm_Map_Route_Sources
23762 * Set route service to be used. By default used source is
23763 * #ELM_MAP_ROUTE_SOURCE_YOURS.
23765 * @see elm_map_route_source_set()
23766 * @see elm_map_route_source_get()
23770 typedef enum _Elm_Map_Route_Sources
23772 ELM_MAP_ROUTE_SOURCE_YOURS, /**< Routing service http://www.yournavigation.org/ . Set by default.*/
23773 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. */
23774 ELM_MAP_ROUTE_SOURCE_ORS, /**< Open Route Service: http://www.openrouteservice.org/ . It's not working with Map yet. */
23775 ELM_MAP_ROUTE_SOURCE_LAST
23776 } Elm_Map_Route_Sources;
23778 typedef enum _Elm_Map_Name_Sources
23780 ELM_MAP_NAME_SOURCE_NOMINATIM,
23781 ELM_MAP_NAME_SOURCE_LAST
23782 } Elm_Map_Name_Sources;
23785 * @enum _Elm_Map_Route_Type
23786 * @typedef Elm_Map_Route_Type
23788 * Set type of transport used on route.
23790 * @see elm_map_route_add()
23794 typedef enum _Elm_Map_Route_Type
23796 ELM_MAP_ROUTE_TYPE_MOTOCAR, /**< Route should consider an automobile will be used. */
23797 ELM_MAP_ROUTE_TYPE_BICYCLE, /**< Route should consider a bicycle will be used by the user. */
23798 ELM_MAP_ROUTE_TYPE_FOOT, /**< Route should consider user will be walking. */
23799 ELM_MAP_ROUTE_TYPE_LAST
23800 } Elm_Map_Route_Type;
23803 * @enum _Elm_Map_Route_Method
23804 * @typedef Elm_Map_Route_Method
23806 * Set the routing method, what should be priorized, time or distance.
23808 * @see elm_map_route_add()
23812 typedef enum _Elm_Map_Route_Method
23814 ELM_MAP_ROUTE_METHOD_FASTEST, /**< Route should priorize time. */
23815 ELM_MAP_ROUTE_METHOD_SHORTEST, /**< Route should priorize distance. */
23816 ELM_MAP_ROUTE_METHOD_LAST
23817 } Elm_Map_Route_Method;
23819 typedef enum _Elm_Map_Name_Method
23821 ELM_MAP_NAME_METHOD_SEARCH,
23822 ELM_MAP_NAME_METHOD_REVERSE,
23823 ELM_MAP_NAME_METHOD_LAST
23824 } Elm_Map_Name_Method;
23826 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(). */
23827 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(). */
23828 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(). */
23829 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(). */
23830 typedef struct _Elm_Map_Name Elm_Map_Name; /**< A handle for specific coordinates. */
23831 typedef struct _Elm_Map_Track Elm_Map_Track;
23833 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. */
23834 typedef void (*ElmMapMarkerDelFunc) (Evas_Object *obj, Elm_Map_Marker *marker, void *data, Evas_Object *o); /**< Function to delete bubble content for marker classes. */
23835 typedef Evas_Object *(*ElmMapMarkerIconGetFunc) (Evas_Object *obj, Elm_Map_Marker *marker, void *data); /**< Icon fetching class function for marker classes. */
23836 typedef Evas_Object *(*ElmMapGroupIconGetFunc) (Evas_Object *obj, void *data); /**< Icon fetching class function for markers group classes. */
23838 typedef char *(*ElmMapModuleSourceFunc) (void);
23839 typedef int (*ElmMapModuleZoomMinFunc) (void);
23840 typedef int (*ElmMapModuleZoomMaxFunc) (void);
23841 typedef char *(*ElmMapModuleUrlFunc) (Evas_Object *obj, int x, int y, int zoom);
23842 typedef int (*ElmMapModuleRouteSourceFunc) (void);
23843 typedef char *(*ElmMapModuleRouteUrlFunc) (Evas_Object *obj, char *type_name, int method, double flon, double flat, double tlon, double tlat);
23844 typedef char *(*ElmMapModuleNameUrlFunc) (Evas_Object *obj, int method, char *name, double lon, double lat);
23845 typedef Eina_Bool (*ElmMapModuleGeoIntoCoordFunc) (const Evas_Object *obj, int zoom, double lon, double lat, int size, int *x, int *y);
23846 typedef Eina_Bool (*ElmMapModuleCoordIntoGeoFunc) (const Evas_Object *obj, int zoom, int x, int y, int size, double *lon, double *lat);
23849 * Add a new map widget to the given parent Elementary (container) object.
23851 * @param parent The parent object.
23852 * @return a new map widget handle or @c NULL, on errors.
23854 * This function inserts a new map widget on the canvas.
23858 EAPI Evas_Object *elm_map_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
23861 * Set the zoom level of the map.
23863 * @param obj The map object.
23864 * @param zoom The zoom level to set.
23866 * This sets the zoom level.
23868 * It will respect limits defined by elm_map_source_zoom_min_set() and
23869 * elm_map_source_zoom_max_set().
23871 * By default these values are 0 (world map) and 18 (maximum zoom).
23873 * This function should be used when zoom mode is set to
23874 * #ELM_MAP_ZOOM_MODE_MANUAL. This is the default mode, and can be set
23875 * with elm_map_zoom_mode_set().
23877 * @see elm_map_zoom_mode_set().
23878 * @see elm_map_zoom_get().
23882 EAPI void elm_map_zoom_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
23885 * Get the zoom level of the map.
23887 * @param obj The map object.
23888 * @return The current zoom level.
23890 * This returns the current zoom level of the map object.
23892 * Note that if you set the fill mode to other than #ELM_MAP_ZOOM_MODE_MANUAL
23893 * (which is the default), the zoom level may be changed at any time by the
23894 * map object itself to account for map size and map viewport size.
23896 * @see elm_map_zoom_set() for details.
23900 EAPI int elm_map_zoom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23903 * Set the zoom mode used by the map object.
23905 * @param obj The map object.
23906 * @param mode The zoom mode of the map, being it one of
23907 * #ELM_MAP_ZOOM_MODE_MANUAL (default), #ELM_MAP_ZOOM_MODE_AUTO_FIT,
23908 * or #ELM_MAP_ZOOM_MODE_AUTO_FILL.
23910 * This sets the zoom mode to manual or one of the automatic levels.
23911 * Manual (#ELM_MAP_ZOOM_MODE_MANUAL) means that zoom is set manually by
23912 * elm_map_zoom_set() and will stay at that level until changed by code
23913 * or until zoom mode is changed. This is the default mode.
23915 * The Automatic modes will allow the map object to automatically
23916 * adjust zoom mode based on properties. #ELM_MAP_ZOOM_MODE_AUTO_FIT will
23917 * adjust zoom so the map fits inside the scroll frame with no pixels
23918 * outside this area. #ELM_MAP_ZOOM_MODE_AUTO_FILL will be similar but
23919 * ensure no pixels within the frame are left unfilled. Do not forget that
23920 * the valid sizes are 2^zoom, consequently the map may be smaller than
23921 * the scroller view.
23923 * @see elm_map_zoom_set()
23927 EAPI void elm_map_zoom_mode_set(Evas_Object *obj, Elm_Map_Zoom_Mode mode) EINA_ARG_NONNULL(1);
23930 * Get the zoom mode used by the map object.
23932 * @param obj The map object.
23933 * @return The zoom mode of the map, being it one of
23934 * #ELM_MAP_ZOOM_MODE_MANUAL (default), #ELM_MAP_ZOOM_MODE_AUTO_FIT,
23935 * or #ELM_MAP_ZOOM_MODE_AUTO_FILL.
23937 * This function returns the current zoom mode used by the map object.
23939 * @see elm_map_zoom_mode_set() for more details.
23943 EAPI Elm_Map_Zoom_Mode elm_map_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23946 * Get the current coordinates of the map.
23948 * @param obj The map object.
23949 * @param lon Pointer where to store longitude.
23950 * @param lat Pointer where to store latitude.
23952 * This gets the current center coordinates of the map object. It can be
23953 * set by elm_map_geo_region_bring_in() and elm_map_geo_region_show().
23955 * @see elm_map_geo_region_bring_in()
23956 * @see elm_map_geo_region_show()
23960 EAPI void elm_map_geo_region_get(const Evas_Object *obj, double *lon, double *lat) EINA_ARG_NONNULL(1);
23963 * Animatedly bring in given coordinates to the center of the map.
23965 * @param obj The map object.
23966 * @param lon Longitude to center at.
23967 * @param lat Latitude to center at.
23969 * This causes map to jump to the given @p lat and @p lon coordinates
23970 * and show it (by scrolling) in the center of the viewport, if it is not
23971 * already centered. This will use animation to do so and take a period
23972 * of time to complete.
23974 * @see elm_map_geo_region_show() for a function to avoid animation.
23975 * @see elm_map_geo_region_get()
23979 EAPI void elm_map_geo_region_bring_in(Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
23982 * Show the given coordinates at the center of the map, @b immediately.
23984 * @param obj The map object.
23985 * @param lon Longitude to center at.
23986 * @param lat Latitude to center at.
23988 * This causes map to @b redraw its viewport's contents to the
23989 * region contining the given @p lat and @p lon, that will be moved to the
23990 * center of the map.
23992 * @see elm_map_geo_region_bring_in() for a function to move with animation.
23993 * @see elm_map_geo_region_get()
23997 EAPI void elm_map_geo_region_show(Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
24000 * Pause or unpause the map.
24002 * @param obj The map object.
24003 * @param paused Use @c EINA_TRUE to pause the map @p obj or @c EINA_FALSE
24006 * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
24009 * The default is off.
24011 * This will stop zooming using animation, changing zoom levels will
24012 * change instantly. This will stop any existing animations that are running.
24014 * @see elm_map_paused_get()
24018 EAPI void elm_map_paused_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
24021 * Get a value whether map is paused or not.
24023 * @param obj The map object.
24024 * @return @c EINA_TRUE means map is pause. @c EINA_FALSE indicates
24025 * it is not. If @p obj is @c NULL, @c EINA_FALSE is returned.
24027 * This gets the current paused state for the map object.
24029 * @see elm_map_paused_set() for details.
24033 EAPI Eina_Bool elm_map_paused_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24036 * Set to show markers during zoom level changes or not.
24038 * @param obj The map object.
24039 * @param paused Use @c EINA_TRUE to @b not show markers or @c EINA_FALSE
24042 * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
24045 * The default is off.
24047 * This will stop zooming using animation, changing zoom levels will
24048 * change instantly. This will stop any existing animations that are running.
24050 * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
24053 * The default is off.
24055 * Enabling it will force the map to stop displaying the markers during
24056 * zoom level changes. Set to on if you have a large number of markers.
24058 * @see elm_map_paused_markers_get()
24062 EAPI void elm_map_paused_markers_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
24065 * Get a value whether markers will be displayed on zoom level changes or not
24067 * @param obj The map object.
24068 * @return @c EINA_TRUE means map @b won't display markers or @c EINA_FALSE
24069 * indicates it will. If @p obj is @c NULL, @c EINA_FALSE is returned.
24071 * This gets the current markers paused state for the map object.
24073 * @see elm_map_paused_markers_set() for details.
24077 EAPI Eina_Bool elm_map_paused_markers_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24080 * Get the information of downloading status.
24082 * @param obj The map object.
24083 * @param try_num Pointer where to store number of tiles being downloaded.
24084 * @param finish_num Pointer where to store number of tiles successfully
24087 * This gets the current downloading status for the map object, the number
24088 * of tiles being downloaded and the number of tiles already downloaded.
24092 EAPI void elm_map_utils_downloading_status_get(const Evas_Object *obj, int *try_num, int *finish_num) EINA_ARG_NONNULL(1, 2, 3);
24095 * Convert a pixel coordinate (x,y) into a geographic coordinate
24096 * (longitude, latitude).
24098 * @param obj The map object.
24099 * @param x the coordinate.
24100 * @param y the coordinate.
24101 * @param size the size in pixels of the map.
24102 * The map is a square and generally his size is : pow(2.0, zoom)*256.
24103 * @param lon Pointer where to store the longitude that correspond to x.
24104 * @param lat Pointer where to store the latitude that correspond to y.
24106 * @note Origin pixel point is the top left corner of the viewport.
24107 * Map zoom and size are taken on account.
24109 * @see elm_map_utils_convert_geo_into_coord() if you need the inverse.
24113 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);
24116 * Convert a geographic coordinate (longitude, latitude) into a pixel
24117 * coordinate (x, y).
24119 * @param obj The map object.
24120 * @param lon the longitude.
24121 * @param lat the latitude.
24122 * @param size the size in pixels of the map. The map is a square
24123 * and generally his size is : pow(2.0, zoom)*256.
24124 * @param x Pointer where to store the horizontal pixel coordinate that
24125 * correspond to the longitude.
24126 * @param y Pointer where to store the vertical pixel coordinate that
24127 * correspond to the latitude.
24129 * @note Origin pixel point is the top left corner of the viewport.
24130 * Map zoom and size are taken on account.
24132 * @see elm_map_utils_convert_coord_into_geo() if you need the inverse.
24136 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);
24139 * Convert a geographic coordinate (longitude, latitude) into a name
24142 * @param obj The map object.
24143 * @param lon the longitude.
24144 * @param lat the latitude.
24145 * @return name A #Elm_Map_Name handle for this coordinate.
24147 * To get the string for this address, elm_map_name_address_get()
24150 * @see elm_map_utils_convert_name_into_coord() if you need the inverse.
24154 EAPI Elm_Map_Name *elm_map_utils_convert_coord_into_name(const Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
24157 * Convert a name (address) into a geographic coordinate
24158 * (longitude, latitude).
24160 * @param obj The map object.
24161 * @param name The address.
24162 * @return name A #Elm_Map_Name handle for this address.
24164 * To get the longitude and latitude, elm_map_name_region_get()
24167 * @see elm_map_utils_convert_coord_into_name() if you need the inverse.
24171 EAPI Elm_Map_Name *elm_map_utils_convert_name_into_coord(const Evas_Object *obj, char *address) EINA_ARG_NONNULL(1, 2);
24174 * Convert a pixel coordinate into a rotated pixel coordinate.
24176 * @param obj The map object.
24177 * @param x horizontal coordinate of the point to rotate.
24178 * @param y vertical coordinate of the point to rotate.
24179 * @param cx rotation's center horizontal position.
24180 * @param cy rotation's center vertical position.
24181 * @param degree amount of degrees from 0.0 to 360.0 to rotate arount Z axis.
24182 * @param xx Pointer where to store rotated x.
24183 * @param yy Pointer where to store rotated y.
24187 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);
24190 * Add a new marker to the map object.
24192 * @param obj The map object.
24193 * @param lon The longitude of the marker.
24194 * @param lat The latitude of the marker.
24195 * @param clas The class, to use when marker @b isn't grouped to others.
24196 * @param clas_group The class group, to use when marker is grouped to others
24197 * @param data The data passed to the callbacks.
24199 * @return The created marker or @c NULL upon failure.
24201 * A marker will be created and shown in a specific point of the map, defined
24202 * by @p lon and @p lat.
24204 * It will be displayed using style defined by @p class when this marker
24205 * is displayed alone (not grouped). A new class can be created with
24206 * elm_map_marker_class_new().
24208 * If the marker is grouped to other markers, it will be displayed with
24209 * style defined by @p class_group. Markers with the same group are grouped
24210 * if they are close. A new group class can be created with
24211 * elm_map_marker_group_class_new().
24213 * Markers created with this method can be deleted with
24214 * elm_map_marker_remove().
24216 * A marker can have associated content to be displayed by a bubble,
24217 * when a user click over it, as well as an icon. These objects will
24218 * be fetch using class' callback functions.
24220 * @see elm_map_marker_class_new()
24221 * @see elm_map_marker_group_class_new()
24222 * @see elm_map_marker_remove()
24226 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);
24229 * Set the maximum numbers of markers' content to be displayed in a group.
24231 * @param obj The map object.
24232 * @param max The maximum numbers of items displayed in a bubble.
24234 * A bubble will be displayed when the user clicks over the group,
24235 * and will place the content of markers that belong to this group
24238 * A group can have a long list of markers, consequently the creation
24239 * of the content of the bubble can be very slow.
24241 * In order to avoid this, a maximum number of items is displayed
24244 * By default this number is 30.
24246 * Marker with the same group class are grouped if they are close.
24248 * @see elm_map_marker_add()
24252 EAPI void elm_map_max_marker_per_group_set(Evas_Object *obj, int max) EINA_ARG_NONNULL(1);
24255 * Remove a marker from the map.
24257 * @param marker The marker to remove.
24259 * @see elm_map_marker_add()
24263 EAPI void elm_map_marker_remove(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
24266 * Get the current coordinates of the marker.
24268 * @param marker marker.
24269 * @param lat Pointer where to store the marker's latitude.
24270 * @param lon Pointer where to store the marker's longitude.
24272 * These values are set when adding markers, with function
24273 * elm_map_marker_add().
24275 * @see elm_map_marker_add()
24279 EAPI void elm_map_marker_region_get(const Elm_Map_Marker *marker, double *lon, double *lat) EINA_ARG_NONNULL(1);
24282 * Animatedly bring in given marker to the center of the map.
24284 * @param marker The marker to center at.
24286 * This causes map to jump to the given @p marker's coordinates
24287 * and show it (by scrolling) in the center of the viewport, if it is not
24288 * already centered. This will use animation to do so and take a period
24289 * of time to complete.
24291 * @see elm_map_marker_show() for a function to avoid animation.
24292 * @see elm_map_marker_region_get()
24296 EAPI void elm_map_marker_bring_in(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
24299 * Show the given marker at the center of the map, @b immediately.
24301 * @param marker The marker to center at.
24303 * This causes map to @b redraw its viewport's contents to the
24304 * region contining the given @p marker's coordinates, that will be
24305 * moved to the center of the map.
24307 * @see elm_map_marker_bring_in() for a function to move with animation.
24308 * @see elm_map_markers_list_show() if more than one marker need to be
24310 * @see elm_map_marker_region_get()
24314 EAPI void elm_map_marker_show(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
24317 * Move and zoom the map to display a list of markers.
24319 * @param markers A list of #Elm_Map_Marker handles.
24321 * The map will be centered on the center point of the markers in the list.
24322 * Then the map will be zoomed in order to fit the markers using the maximum
24323 * zoom which allows display of all the markers.
24325 * @warning All the markers should belong to the same map object.
24327 * @see elm_map_marker_show() to show a single marker.
24328 * @see elm_map_marker_bring_in()
24332 EAPI void elm_map_markers_list_show(Eina_List *markers) EINA_ARG_NONNULL(1);
24335 * Get the Evas object returned by the ElmMapMarkerGetFunc callback
24337 * @param marker The marker wich content should be returned.
24338 * @return Return the evas object if it exists, else @c NULL.
24340 * To set callback function #ElmMapMarkerGetFunc for the marker class,
24341 * elm_map_marker_class_get_cb_set() should be used.
24343 * This content is what will be inside the bubble that will be displayed
24344 * when an user clicks over the marker.
24346 * This returns the actual Evas object used to be placed inside
24347 * the bubble. This may be @c NULL, as it may
24348 * not have been created or may have been deleted, at any time, by
24349 * the map. <b>Do not modify this object</b> (move, resize,
24350 * show, hide, etc.), as the map is controlling it. This
24351 * function is for querying, emitting custom signals or hooking
24352 * lower level callbacks for events on that object. Do not delete
24353 * this object under any circumstances.
24357 EAPI Evas_Object *elm_map_marker_object_get(const Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
24360 * Update the marker
24362 * @param marker The marker to be updated.
24364 * If a content is set to this marker, it will call function to delete it,
24365 * #ElmMapMarkerDelFunc, and then will fetch the content again with
24366 * #ElmMapMarkerGetFunc.
24368 * These functions are set for the marker class with
24369 * elm_map_marker_class_get_cb_set() and elm_map_marker_class_del_cb_set().
24373 EAPI void elm_map_marker_update(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
24376 * Close all the bubbles opened by the user.
24378 * @param obj The map object.
24380 * A bubble is displayed with a content fetched with #ElmMapMarkerGetFunc
24381 * when the user clicks on a marker.
24383 * This functions is set for the marker class with
24384 * elm_map_marker_class_get_cb_set().
24388 EAPI void elm_map_bubbles_close(Evas_Object *obj) EINA_ARG_NONNULL(1);
24391 * Create a new group class.
24393 * @param obj The map object.
24394 * @return Returns the new group class.
24396 * Each marker must be associated to a group class. Markers in the same
24397 * group are grouped if they are close.
24399 * The group class defines the style of the marker when a marker is grouped
24400 * to others markers. When it is alone, another class will be used.
24402 * A group class will need to be provided when creating a marker with
24403 * elm_map_marker_add().
24405 * Some properties and functions can be set by class, as:
24406 * - style, with elm_map_group_class_style_set()
24407 * - data - to be associated to the group class. It can be set using
24408 * elm_map_group_class_data_set().
24409 * - min zoom to display markers, set with
24410 * elm_map_group_class_zoom_displayed_set().
24411 * - max zoom to group markers, set using
24412 * elm_map_group_class_zoom_grouped_set().
24413 * - visibility - set if markers will be visible or not, set with
24414 * elm_map_group_class_hide_set().
24415 * - #ElmMapGroupIconGetFunc - used to fetch icon for markers group classes.
24416 * It can be set using elm_map_group_class_icon_cb_set().
24418 * @see elm_map_marker_add()
24419 * @see elm_map_group_class_style_set()
24420 * @see elm_map_group_class_data_set()
24421 * @see elm_map_group_class_zoom_displayed_set()
24422 * @see elm_map_group_class_zoom_grouped_set()
24423 * @see elm_map_group_class_hide_set()
24424 * @see elm_map_group_class_icon_cb_set()
24428 EAPI Elm_Map_Group_Class *elm_map_group_class_new(Evas_Object *obj) EINA_ARG_NONNULL(1);
24431 * Set the marker's style of a group class.
24433 * @param clas The group class.
24434 * @param style The style to be used by markers.
24436 * Each marker must be associated to a group class, and will use the style
24437 * defined by such class when grouped to other markers.
24439 * The following styles are provided by default theme:
24440 * @li @c radio - blue circle
24441 * @li @c radio2 - green circle
24444 * @see elm_map_group_class_new() for more details.
24445 * @see elm_map_marker_add()
24449 EAPI void elm_map_group_class_style_set(Elm_Map_Group_Class *clas, const char *style) EINA_ARG_NONNULL(1);
24452 * Set the icon callback function of a group class.
24454 * @param clas The group class.
24455 * @param icon_get The callback function that will return the icon.
24457 * Each marker must be associated to a group class, and it can display a
24458 * custom icon. The function @p icon_get must return this icon.
24460 * @see elm_map_group_class_new() for more details.
24461 * @see elm_map_marker_add()
24465 EAPI void elm_map_group_class_icon_cb_set(Elm_Map_Group_Class *clas, ElmMapGroupIconGetFunc icon_get) EINA_ARG_NONNULL(1);
24468 * Set the data associated to the group class.
24470 * @param clas The group class.
24471 * @param data The new user data.
24473 * This data will be passed for callback functions, like icon get callback,
24474 * that can be set with elm_map_group_class_icon_cb_set().
24476 * If a data was previously set, the object will lose the pointer for it,
24477 * so if needs to be freed, you must do it yourself.
24479 * @see elm_map_group_class_new() for more details.
24480 * @see elm_map_group_class_icon_cb_set()
24481 * @see elm_map_marker_add()
24485 EAPI void elm_map_group_class_data_set(Elm_Map_Group_Class *clas, void *data) EINA_ARG_NONNULL(1);
24488 * Set the minimum zoom from where the markers are displayed.
24490 * @param clas The group class.
24491 * @param zoom The minimum zoom.
24493 * Markers only will be displayed when the map is displayed at @p zoom
24496 * @see elm_map_group_class_new() for more details.
24497 * @see elm_map_marker_add()
24501 EAPI void elm_map_group_class_zoom_displayed_set(Elm_Map_Group_Class *clas, int zoom) EINA_ARG_NONNULL(1);
24504 * Set the zoom from where the markers are no more grouped.
24506 * @param clas The group class.
24507 * @param zoom The maximum zoom.
24509 * Markers only will be grouped when the map is displayed at
24510 * less than @p zoom.
24512 * @see elm_map_group_class_new() for more details.
24513 * @see elm_map_marker_add()
24517 EAPI void elm_map_group_class_zoom_grouped_set(Elm_Map_Group_Class *clas, int zoom) EINA_ARG_NONNULL(1);
24520 * Set if the markers associated to the group class @clas are hidden or not.
24522 * @param clas The group class.
24523 * @param hide Use @c EINA_TRUE to hide markers or @c EINA_FALSE
24526 * If @p hide is @c EINA_TRUE the markers will be hidden, but default
24531 EAPI void elm_map_group_class_hide_set(Evas_Object *obj, Elm_Map_Group_Class *clas, Eina_Bool hide) EINA_ARG_NONNULL(1, 2);
24534 * Create a new marker class.
24536 * @param obj The map object.
24537 * @return Returns the new group class.
24539 * Each marker must be associated to a class.
24541 * The marker class defines the style of the marker when a marker is
24542 * displayed alone, i.e., not grouped to to others markers. When grouped
24543 * it will use group class style.
24545 * A marker class will need to be provided when creating a marker with
24546 * elm_map_marker_add().
24548 * Some properties and functions can be set by class, as:
24549 * - style, with elm_map_marker_class_style_set()
24550 * - #ElmMapMarkerIconGetFunc - used to fetch icon for markers classes.
24551 * It can be set using elm_map_marker_class_icon_cb_set().
24552 * - #ElmMapMarkerGetFunc - used to fetch bubble content for marker classes.
24553 * Set using elm_map_marker_class_get_cb_set().
24554 * - #ElmMapMarkerDelFunc - used to delete bubble content for marker classes.
24555 * Set using elm_map_marker_class_del_cb_set().
24557 * @see elm_map_marker_add()
24558 * @see elm_map_marker_class_style_set()
24559 * @see elm_map_marker_class_icon_cb_set()
24560 * @see elm_map_marker_class_get_cb_set()
24561 * @see elm_map_marker_class_del_cb_set()
24565 EAPI Elm_Map_Marker_Class *elm_map_marker_class_new(Evas_Object *obj) EINA_ARG_NONNULL(1);
24568 * Set the marker's style of a marker class.
24570 * @param clas The marker class.
24571 * @param style The style to be used by markers.
24573 * Each marker must be associated to a marker class, and will use the style
24574 * defined by such class when alone, i.e., @b not grouped to other markers.
24576 * The following styles are provided by default theme:
24581 * @see elm_map_marker_class_new() for more details.
24582 * @see elm_map_marker_add()
24586 EAPI void elm_map_marker_class_style_set(Elm_Map_Marker_Class *clas, const char *style) EINA_ARG_NONNULL(1);
24589 * Set the icon callback function of a marker class.
24591 * @param clas The marker class.
24592 * @param icon_get The callback function that will return the icon.
24594 * Each marker must be associated to a marker class, and it can display a
24595 * custom icon. The function @p icon_get must return this icon.
24597 * @see elm_map_marker_class_new() for more details.
24598 * @see elm_map_marker_add()
24602 EAPI void elm_map_marker_class_icon_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerIconGetFunc icon_get) EINA_ARG_NONNULL(1);
24605 * Set the bubble content callback function of a marker class.
24607 * @param clas The marker class.
24608 * @param get The callback function that will return the content.
24610 * Each marker must be associated to a marker class, and it can display a
24611 * a content on a bubble that opens when the user click over the marker.
24612 * The function @p get must return this content object.
24614 * If this content will need to be deleted, elm_map_marker_class_del_cb_set()
24617 * @see elm_map_marker_class_new() for more details.
24618 * @see elm_map_marker_class_del_cb_set()
24619 * @see elm_map_marker_add()
24623 EAPI void elm_map_marker_class_get_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerGetFunc get) EINA_ARG_NONNULL(1);
24626 * Set the callback function used to delete bubble content of a marker class.
24628 * @param clas The marker class.
24629 * @param del The callback function that will delete the content.
24631 * Each marker must be associated to a marker class, and it can display a
24632 * a content on a bubble that opens when the user click over the marker.
24633 * The function to return such content can be set with
24634 * elm_map_marker_class_get_cb_set().
24636 * If this content must be freed, a callback function need to be
24637 * set for that task with this function.
24639 * If this callback is defined it will have to delete (or not) the
24640 * object inside, but if the callback is not defined the object will be
24641 * destroyed with evas_object_del().
24643 * @see elm_map_marker_class_new() for more details.
24644 * @see elm_map_marker_class_get_cb_set()
24645 * @see elm_map_marker_add()
24649 EAPI void elm_map_marker_class_del_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerDelFunc del) EINA_ARG_NONNULL(1);
24652 * Get the list of available sources.
24654 * @param obj The map object.
24655 * @return The source names list.
24657 * It will provide a list with all available sources, that can be set as
24658 * current source with elm_map_source_name_set(), or get with
24659 * elm_map_source_name_get().
24661 * Available sources:
24667 * @see elm_map_source_name_set() for more details.
24668 * @see elm_map_source_name_get()
24672 EAPI const char **elm_map_source_names_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24675 * Set the source of the map.
24677 * @param obj The map object.
24678 * @param source The source to be used.
24680 * Map widget retrieves images that composes the map from a web service.
24681 * This web service can be set with this method.
24683 * A different service can return a different maps with different
24684 * information and it can use different zoom values.
24686 * The @p source_name need to match one of the names provided by
24687 * elm_map_source_names_get().
24689 * The current source can be get using elm_map_source_name_get().
24691 * @see elm_map_source_names_get()
24692 * @see elm_map_source_name_get()
24697 EAPI void elm_map_source_name_set(Evas_Object *obj, const char *source_name) EINA_ARG_NONNULL(1);
24700 * Get the name of currently used source.
24702 * @param obj The map object.
24703 * @return Returns the name of the source in use.
24705 * @see elm_map_source_name_set() for more details.
24709 EAPI const char *elm_map_source_name_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24712 * Set the source of the route service to be used by the map.
24714 * @param obj The map object.
24715 * @param source The route service to be used, being it one of
24716 * #ELM_MAP_ROUTE_SOURCE_YOURS (default), #ELM_MAP_ROUTE_SOURCE_MONAV,
24717 * and #ELM_MAP_ROUTE_SOURCE_ORS.
24719 * Each one has its own algorithm, so the route retrieved may
24720 * differ depending on the source route. Now, only the default is working.
24722 * #ELM_MAP_ROUTE_SOURCE_YOURS is the routing service provided at
24723 * http://www.yournavigation.org/.
24725 * #ELM_MAP_ROUTE_SOURCE_MONAV, offers exact routing without heuristic
24726 * assumptions. Its routing core is based on Contraction Hierarchies.
24728 * #ELM_MAP_ROUTE_SOURCE_ORS, is provided at http://www.openrouteservice.org/
24730 * @see elm_map_route_source_get().
24734 EAPI void elm_map_route_source_set(Evas_Object *obj, Elm_Map_Route_Sources source) EINA_ARG_NONNULL(1);
24737 * Get the current route source.
24739 * @param obj The map object.
24740 * @return The source of the route service used by the map.
24742 * @see elm_map_route_source_set() for details.
24746 EAPI Elm_Map_Route_Sources elm_map_route_source_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24749 * Set the minimum zoom of the source.
24751 * @param obj The map object.
24752 * @param zoom New minimum zoom value to be used.
24754 * By default, it's 0.
24758 EAPI void elm_map_source_zoom_min_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
24761 * Get the minimum zoom of the source.
24763 * @param obj The map object.
24764 * @return Returns the minimum zoom of the source.
24766 * @see elm_map_source_zoom_min_set() for details.
24770 EAPI int elm_map_source_zoom_min_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24773 * Set the maximum zoom of the source.
24775 * @param obj The map object.
24776 * @param zoom New maximum zoom value to be used.
24778 * By default, it's 18.
24782 EAPI void elm_map_source_zoom_max_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
24785 * Get the maximum zoom of the source.
24787 * @param obj The map object.
24788 * @return Returns the maximum zoom of the source.
24790 * @see elm_map_source_zoom_min_set() for details.
24794 EAPI int elm_map_source_zoom_max_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24797 * Set the user agent used by the map object to access routing services.
24799 * @param obj The map object.
24800 * @param user_agent The user agent to be used by the map.
24802 * User agent is a client application implementing a network protocol used
24803 * in communications within a clientāserver distributed computing system
24805 * The @p user_agent identification string will transmitted in a header
24806 * field @c User-Agent.
24808 * @see elm_map_user_agent_get()
24812 EAPI void elm_map_user_agent_set(Evas_Object *obj, const char *user_agent) EINA_ARG_NONNULL(1, 2);
24815 * Get the user agent used by the map object.
24817 * @param obj The map object.
24818 * @return The user agent identification string used by the map.
24820 * @see elm_map_user_agent_set() for details.
24824 EAPI const char *elm_map_user_agent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24827 * Add a new route to the map object.
24829 * @param obj The map object.
24830 * @param type The type of transport to be considered when tracing a route.
24831 * @param method The routing method, what should be priorized.
24832 * @param flon The start longitude.
24833 * @param flat The start latitude.
24834 * @param tlon The destination longitude.
24835 * @param tlat The destination latitude.
24837 * @return The created route or @c NULL upon failure.
24839 * A route will be traced by point on coordinates (@p flat, @p flon)
24840 * to point on coordinates (@p tlat, @p tlon), using the route service
24841 * set with elm_map_route_source_set().
24843 * It will take @p type on consideration to define the route,
24844 * depending if the user will be walking or driving, the route may vary.
24845 * One of #ELM_MAP_ROUTE_TYPE_MOTOCAR, #ELM_MAP_ROUTE_TYPE_BICYCLE, or
24846 * #ELM_MAP_ROUTE_TYPE_FOOT need to be used.
24848 * Another parameter is what the route should priorize, the minor distance
24849 * or the less time to be spend on the route. So @p method should be one
24850 * of #ELM_MAP_ROUTE_METHOD_SHORTEST or #ELM_MAP_ROUTE_METHOD_FASTEST.
24852 * Routes created with this method can be deleted with
24853 * elm_map_route_remove(), colored with elm_map_route_color_set(),
24854 * and distance can be get with elm_map_route_distance_get().
24856 * @see elm_map_route_remove()
24857 * @see elm_map_route_color_set()
24858 * @see elm_map_route_distance_get()
24859 * @see elm_map_route_source_set()
24863 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);
24866 * Remove a route from the map.
24868 * @param route The route to remove.
24870 * @see elm_map_route_add()
24874 EAPI void elm_map_route_remove(Elm_Map_Route *route) EINA_ARG_NONNULL(1);
24877 * Set the route color.
24879 * @param route The route object.
24880 * @param r Red channel value, from 0 to 255.
24881 * @param g Green channel value, from 0 to 255.
24882 * @param b Blue channel value, from 0 to 255.
24883 * @param a Alpha channel value, from 0 to 255.
24885 * It uses an additive color model, so each color channel represents
24886 * how much of each primary colors must to be used. 0 represents
24887 * ausence of this color, so if all of the three are set to 0,
24888 * the color will be black.
24890 * These component values should be integers in the range 0 to 255,
24891 * (single 8-bit byte).
24893 * This sets the color used for the route. By default, it is set to
24894 * solid red (r = 255, g = 0, b = 0, a = 255).
24896 * For alpha channel, 0 represents completely transparent, and 255, opaque.
24898 * @see elm_map_route_color_get()
24902 EAPI void elm_map_route_color_set(Elm_Map_Route *route, int r, int g , int b, int a) EINA_ARG_NONNULL(1);
24905 * Get the route color.
24907 * @param route The route object.
24908 * @param r Pointer where to store the red channel value.
24909 * @param g Pointer where to store the green channel value.
24910 * @param b Pointer where to store the blue channel value.
24911 * @param a Pointer where to store the alpha channel value.
24913 * @see elm_map_route_color_set() for details.
24917 EAPI void elm_map_route_color_get(const Elm_Map_Route *route, int *r, int *g , int *b, int *a) EINA_ARG_NONNULL(1);
24920 * Get the route distance in kilometers.
24922 * @param route The route object.
24923 * @return The distance of route (unit : km).
24927 EAPI double elm_map_route_distance_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
24930 * Get the information of route nodes.
24932 * @param route The route object.
24933 * @return Returns a string with the nodes of route.
24937 EAPI const char *elm_map_route_node_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
24940 * Get the information of route waypoint.
24942 * @param route the route object.
24943 * @return Returns a string with information about waypoint of route.
24947 EAPI const char *elm_map_route_waypoint_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
24950 * Get the address of the name.
24952 * @param name The name handle.
24953 * @return Returns the address string of @p name.
24955 * This gets the coordinates of the @p name, created with one of the
24956 * conversion functions.
24958 * @see elm_map_utils_convert_name_into_coord()
24959 * @see elm_map_utils_convert_coord_into_name()
24963 EAPI const char *elm_map_name_address_get(const Elm_Map_Name *name) EINA_ARG_NONNULL(1);
24966 * Get the current coordinates of the name.
24968 * @param name The name handle.
24969 * @param lat Pointer where to store the latitude.
24970 * @param lon Pointer where to store The longitude.
24972 * This gets the coordinates of the @p name, created with one of the
24973 * conversion functions.
24975 * @see elm_map_utils_convert_name_into_coord()
24976 * @see elm_map_utils_convert_coord_into_name()
24980 EAPI void elm_map_name_region_get(const Elm_Map_Name *name, double *lon, double *lat) EINA_ARG_NONNULL(1);
24983 * Remove a name from the map.
24985 * @param name The name to remove.
24987 * Basically the struct handled by @p name will be freed, so convertions
24988 * between address and coordinates will be lost.
24990 * @see elm_map_utils_convert_name_into_coord()
24991 * @see elm_map_utils_convert_coord_into_name()
24995 EAPI void elm_map_name_remove(Elm_Map_Name *name) EINA_ARG_NONNULL(1);
25000 * @param obj The map object.
25001 * @param degree Angle from 0.0 to 360.0 to rotate arount Z axis.
25002 * @param cx Rotation's center horizontal position.
25003 * @param cy Rotation's center vertical position.
25005 * @see elm_map_rotate_get()
25009 EAPI void elm_map_rotate_set(Evas_Object *obj, double degree, Evas_Coord cx, Evas_Coord cy) EINA_ARG_NONNULL(1);
25012 * Get the rotate degree of the map
25014 * @param obj The map object
25015 * @param degree Pointer where to store degrees from 0.0 to 360.0
25016 * to rotate arount Z axis.
25017 * @param cx Pointer where to store rotation's center horizontal position.
25018 * @param cy Pointer where to store rotation's center vertical position.
25020 * @see elm_map_rotate_set() to set map rotation.
25024 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);
25027 * Enable or disable mouse wheel to be used to zoom in / out the map.
25029 * @param obj The map object.
25030 * @param disabled Use @c EINA_TRUE to disable mouse wheel or @c EINA_FALSE
25033 * Mouse wheel can be used for the user to zoom in or zoom out the map.
25035 * It's disabled by default.
25037 * @see elm_map_wheel_disabled_get()
25041 EAPI void elm_map_wheel_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
25044 * Get a value whether mouse wheel is enabled or not.
25046 * @param obj The map object.
25047 * @return @c EINA_TRUE means map is disabled. @c EINA_FALSE indicates
25048 * it is enabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
25050 * Mouse wheel can be used for the user to zoom in or zoom out the map.
25052 * @see elm_map_wheel_disabled_set() for details.
25056 EAPI Eina_Bool elm_map_wheel_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25060 * Add a track on the map
25062 * @param obj The map object.
25063 * @param emap The emap route object.
25064 * @return The route object. This is an elm object of type Route.
25066 * @see elm_route_add() for details.
25070 EAPI Evas_Object *elm_map_track_add(Evas_Object *obj, EMap_Route *emap) EINA_ARG_NONNULL(1);
25074 * Remove a track from the map
25076 * @param obj The map object.
25077 * @param route The track to remove.
25081 EAPI void elm_map_track_remove(Evas_Object *obj, Evas_Object *route) EINA_ARG_NONNULL(1);
25088 EAPI Evas_Object *elm_route_add(Evas_Object *parent);
25090 EAPI void elm_route_emap_set(Evas_Object *obj, EMap_Route *emap);
25092 EAPI double elm_route_lon_min_get(Evas_Object *obj);
25093 EAPI double elm_route_lat_min_get(Evas_Object *obj);
25094 EAPI double elm_route_lon_max_get(Evas_Object *obj);
25095 EAPI double elm_route_lat_max_get(Evas_Object *obj);
25099 * @defgroup Panel Panel
25101 * @image html img/widget/panel/preview-00.png
25102 * @image latex img/widget/panel/preview-00.eps
25104 * @brief A panel is a type of animated container that contains subobjects.
25105 * It can be expanded or contracted by clicking the button on it's edge.
25107 * Orientations are as follows:
25108 * @li ELM_PANEL_ORIENT_TOP
25109 * @li ELM_PANEL_ORIENT_LEFT
25110 * @li ELM_PANEL_ORIENT_RIGHT
25112 * Default contents parts of the panel widget that you can use for are:
25113 * @li "default" - A content of the panel
25115 * @ref tutorial_panel shows one way to use this widget.
25118 typedef enum _Elm_Panel_Orient
25120 ELM_PANEL_ORIENT_TOP, /**< Panel (dis)appears from the top */
25121 ELM_PANEL_ORIENT_BOTTOM, /**< Not implemented */
25122 ELM_PANEL_ORIENT_LEFT, /**< Panel (dis)appears from the left */
25123 ELM_PANEL_ORIENT_RIGHT, /**< Panel (dis)appears from the right */
25124 } Elm_Panel_Orient;
25127 * @brief Adds a panel object
25129 * @param parent The parent object
25131 * @return The panel object, or NULL on failure
25133 EAPI Evas_Object *elm_panel_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
25136 * @brief Sets the orientation of the panel
25138 * @param parent The parent object
25139 * @param orient The panel orientation. Can be one of the following:
25140 * @li ELM_PANEL_ORIENT_TOP
25141 * @li ELM_PANEL_ORIENT_LEFT
25142 * @li ELM_PANEL_ORIENT_RIGHT
25144 * Sets from where the panel will (dis)appear.
25146 EAPI void elm_panel_orient_set(Evas_Object *obj, Elm_Panel_Orient orient) EINA_ARG_NONNULL(1);
25149 * @brief Get the orientation of the panel.
25151 * @param obj The panel object
25152 * @return The Elm_Panel_Orient, or ELM_PANEL_ORIENT_LEFT on failure.
25154 EAPI Elm_Panel_Orient elm_panel_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25157 * @brief Set the content of the panel.
25159 * @param obj The panel object
25160 * @param content The panel content
25162 * Once the content object is set, a previously set one will be deleted.
25163 * If you want to keep that old content object, use the
25164 * elm_panel_content_unset() function.
25166 * @deprecated use elm_object_content_set() instead
25169 EINA_DEPRECATED EAPI void elm_panel_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
25172 * @brief Get the content of the panel.
25174 * @param obj The panel object
25175 * @return The content that is being used
25177 * Return the content object which is set for this widget.
25179 * @see elm_panel_content_set()
25181 * @deprecated use elm_object_content_get() instead
25184 EINA_DEPRECATED EAPI Evas_Object *elm_panel_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25187 * @brief Unset the content of the panel.
25189 * @param obj The panel object
25190 * @return The content that was being used
25192 * Unparent and return the content object which was set for this widget.
25194 * @see elm_panel_content_set()
25196 * @deprecated use elm_object_content_unset() instead
25199 EINA_DEPRECATED EAPI Evas_Object *elm_panel_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
25202 * @brief Set the state of the panel.
25204 * @param obj The panel object
25205 * @param hidden If true, the panel will run the animation to contract
25207 EAPI void elm_panel_hidden_set(Evas_Object *obj, Eina_Bool hidden) EINA_ARG_NONNULL(1);
25210 * @brief Get the state of the panel.
25212 * @param obj The panel object
25213 * @param hidden If true, the panel is in the "hide" state
25215 EAPI Eina_Bool elm_panel_hidden_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25218 * @brief Toggle the hidden state of the panel from code
25220 * @param obj The panel object
25222 EAPI void elm_panel_toggle(Evas_Object *obj) EINA_ARG_NONNULL(1);
25229 * @defgroup Panes Panes
25230 * @ingroup Elementary
25232 * @image html img/widget/panes/preview-00.png
25233 * @image latex img/widget/panes/preview-00.eps width=\textwidth
25235 * @image html img/panes.png
25236 * @image latex img/panes.eps width=\textwidth
25238 * The panes adds a dragable bar between two contents. When dragged
25239 * this bar will resize contents size.
25241 * Panes can be displayed vertically or horizontally, and contents
25242 * size proportion can be customized (homogeneous by default).
25244 * Smart callbacks one can listen to:
25245 * - "press" - The panes has been pressed (button wasn't released yet).
25246 * - "unpressed" - The panes was released after being pressed.
25247 * - "clicked" - The panes has been clicked>
25248 * - "clicked,double" - The panes has been double clicked
25250 * Available styles for it:
25253 * Default contents parts of the panes widget that you can use for are:
25254 * @li "left" - A leftside content of the panes
25255 * @li "right" - A rightside content of the panes
25257 * If panes is displayed vertically, left content will be displayed at
25260 * Here is an example on its usage:
25261 * @li @ref panes_example
25265 * @addtogroup Panes
25270 * Add a new panes widget to the given parent Elementary
25271 * (container) object.
25273 * @param parent The parent object.
25274 * @return a new panes widget handle or @c NULL, on errors.
25276 * This function inserts a new panes widget on the canvas.
25280 EAPI Evas_Object *elm_panes_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
25283 * Set the left content of the panes widget.
25285 * @param obj The panes object.
25286 * @param content The new left content object.
25288 * Once the content object is set, a previously set one will be deleted.
25289 * If you want to keep that old content object, use the
25290 * elm_panes_content_left_unset() function.
25292 * If panes is displayed vertically, left content will be displayed at
25295 * @see elm_panes_content_left_get()
25296 * @see elm_panes_content_right_set() to set content on the other side.
25298 * @deprecated use elm_object_part_content_set() instead
25302 EINA_DEPRECATED EAPI void elm_panes_content_left_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
25305 * Set the right content of the panes widget.
25307 * @param obj The panes object.
25308 * @param content The new right content object.
25310 * Once the content object is set, a previously set one will be deleted.
25311 * If you want to keep that old content object, use the
25312 * elm_panes_content_right_unset() function.
25314 * If panes is displayed vertically, left content will be displayed at
25317 * @see elm_panes_content_right_get()
25318 * @see elm_panes_content_left_set() to set content on the other side.
25320 * @deprecated use elm_object_part_content_set() instead
25324 EINA_DEPRECATED EAPI void elm_panes_content_right_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
25327 * Get the left content of the panes.
25329 * @param obj The panes object.
25330 * @return The left content object that is being used.
25332 * Return the left content object which is set for this widget.
25334 * @see elm_panes_content_left_set() for details.
25336 * @deprecated use elm_object_part_content_get() instead
25340 EINA_DEPRECATED EAPI Evas_Object *elm_panes_content_left_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25343 * Get the right content of the panes.
25345 * @param obj The panes object
25346 * @return The right content object that is being used
25348 * Return the right content object which is set for this widget.
25350 * @see elm_panes_content_right_set() for details.
25352 * @deprecated use elm_object_part_content_get() instead
25356 EINA_DEPRECATED EAPI Evas_Object *elm_panes_content_right_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25359 * Unset the left content used for the panes.
25361 * @param obj The panes object.
25362 * @return The left content object that was being used.
25364 * Unparent and return the left content object which was set for this widget.
25366 * @see elm_panes_content_left_set() for details.
25367 * @see elm_panes_content_left_get().
25369 * @deprecated use elm_object_part_content_unset() instead
25373 EINA_DEPRECATED EAPI Evas_Object *elm_panes_content_left_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
25376 * Unset the right content used for the panes.
25378 * @param obj The panes object.
25379 * @return The right content object that was being used.
25381 * Unparent and return the right content object which was set for this
25384 * @see elm_panes_content_right_set() for details.
25385 * @see elm_panes_content_right_get().
25387 * @deprecated use elm_object_part_content_unset() instead
25391 EINA_DEPRECATED EAPI Evas_Object *elm_panes_content_right_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
25394 * Get the size proportion of panes widget's left side.
25396 * @param obj The panes object.
25397 * @return float value between 0.0 and 1.0 representing size proportion
25400 * @see elm_panes_content_left_size_set() for more details.
25404 EAPI double elm_panes_content_left_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25407 * Set the size proportion of panes widget's left side.
25409 * @param obj The panes object.
25410 * @param size Value between 0.0 and 1.0 representing size proportion
25413 * By default it's homogeneous, i.e., both sides have the same size.
25415 * If something different is required, it can be set with this function.
25416 * For example, if the left content should be displayed over
25417 * 75% of the panes size, @p size should be passed as @c 0.75.
25418 * This way, right content will be resized to 25% of panes size.
25420 * If displayed vertically, left content is displayed at top, and
25421 * right content at bottom.
25423 * @note This proportion will change when user drags the panes bar.
25425 * @see elm_panes_content_left_size_get()
25429 EAPI void elm_panes_content_left_size_set(Evas_Object *obj, double size) EINA_ARG_NONNULL(1);
25432 * Set the orientation of a given panes widget.
25434 * @param obj The panes object.
25435 * @param horizontal Use @c EINA_TRUE to make @p obj to be
25436 * @b horizontal, @c EINA_FALSE to make it @b vertical.
25438 * Use this function to change how your panes is to be
25439 * disposed: vertically or horizontally.
25441 * By default it's displayed horizontally.
25443 * @see elm_panes_horizontal_get()
25447 EAPI void elm_panes_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
25450 * Retrieve the orientation of a given panes widget.
25452 * @param obj The panes object.
25453 * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
25454 * @c EINA_FALSE if it's @b vertical (and on errors).
25456 * @see elm_panes_horizontal_set() for more details.
25460 EAPI Eina_Bool elm_panes_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25461 EAPI void elm_panes_fixed_set(Evas_Object *obj, Eina_Bool fixed) EINA_ARG_NONNULL(1);
25462 EAPI Eina_Bool elm_panes_fixed_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25469 * @defgroup Flip Flip
25471 * @image html img/widget/flip/preview-00.png
25472 * @image latex img/widget/flip/preview-00.eps
25474 * This widget holds 2 content objects(Evas_Object): one on the front and one
25475 * on the back. It allows you to flip from front to back and vice-versa using
25476 * various animations.
25478 * If either the front or back contents are not set the flip will treat that
25479 * as transparent. So if you wore to set the front content but not the back,
25480 * and then call elm_flip_go() you would see whatever is below the flip.
25482 * For a list of supported animations see elm_flip_go().
25484 * Signals that you can add callbacks for are:
25485 * "animate,begin" - when a flip animation was started
25486 * "animate,done" - when a flip animation is finished
25488 * @ref tutorial_flip show how to use most of the API.
25492 typedef enum _Elm_Flip_Mode
25494 ELM_FLIP_ROTATE_Y_CENTER_AXIS,
25495 ELM_FLIP_ROTATE_X_CENTER_AXIS,
25496 ELM_FLIP_ROTATE_XZ_CENTER_AXIS,
25497 ELM_FLIP_ROTATE_YZ_CENTER_AXIS,
25498 ELM_FLIP_CUBE_LEFT,
25499 ELM_FLIP_CUBE_RIGHT,
25501 ELM_FLIP_CUBE_DOWN,
25502 ELM_FLIP_PAGE_LEFT,
25503 ELM_FLIP_PAGE_RIGHT,
25507 typedef enum _Elm_Flip_Interaction
25509 ELM_FLIP_INTERACTION_NONE,
25510 ELM_FLIP_INTERACTION_ROTATE,
25511 ELM_FLIP_INTERACTION_CUBE,
25512 ELM_FLIP_INTERACTION_PAGE
25513 } Elm_Flip_Interaction;
25514 typedef enum _Elm_Flip_Direction
25516 ELM_FLIP_DIRECTION_UP, /**< Allows interaction with the top of the widget */
25517 ELM_FLIP_DIRECTION_DOWN, /**< Allows interaction with the bottom of the widget */
25518 ELM_FLIP_DIRECTION_LEFT, /**< Allows interaction with the left portion of the widget */
25519 ELM_FLIP_DIRECTION_RIGHT /**< Allows interaction with the right portion of the widget */
25520 } Elm_Flip_Direction;
25523 * @brief Add a new flip to the parent
25525 * @param parent The parent object
25526 * @return The new object or NULL if it cannot be created
25528 EAPI Evas_Object *elm_flip_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
25531 * @brief Set the front content of the flip widget.
25533 * @param obj The flip object
25534 * @param content The new front content object
25536 * Once the content object is set, a previously set one will be deleted.
25537 * If you want to keep that old content object, use the
25538 * elm_flip_content_front_unset() function.
25540 EAPI void elm_flip_content_front_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
25543 * @brief Set the back content of the flip widget.
25545 * @param obj The flip object
25546 * @param content The new back content object
25548 * Once the content object is set, a previously set one will be deleted.
25549 * If you want to keep that old content object, use the
25550 * elm_flip_content_back_unset() function.
25552 EAPI void elm_flip_content_back_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
25555 * @brief Get the front content used for the flip
25557 * @param obj The flip object
25558 * @return The front content object that is being used
25560 * Return the front content object which is set for this widget.
25562 EAPI Evas_Object *elm_flip_content_front_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25565 * @brief Get the back content used for the flip
25567 * @param obj The flip object
25568 * @return The back content object that is being used
25570 * Return the back content object which is set for this widget.
25572 EAPI Evas_Object *elm_flip_content_back_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25575 * @brief Unset the front content used for the flip
25577 * @param obj The flip object
25578 * @return The front content object that was being used
25580 * Unparent and return the front content object which was set for this widget.
25582 EAPI Evas_Object *elm_flip_content_front_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
25585 * @brief Unset the back content used for the flip
25587 * @param obj The flip object
25588 * @return The back content object that was being used
25590 * Unparent and return the back content object which was set for this widget.
25592 EAPI Evas_Object *elm_flip_content_back_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
25595 * @brief Get flip front visibility state
25597 * @param obj The flip objct
25598 * @return EINA_TRUE if front front is showing, EINA_FALSE if the back is
25601 EAPI Eina_Bool elm_flip_front_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25604 * @brief Set flip perspective
25606 * @param obj The flip object
25607 * @param foc The coordinate to set the focus on
25608 * @param x The X coordinate
25609 * @param y The Y coordinate
25611 * @warning This function currently does nothing.
25613 EAPI void elm_flip_perspective_set(Evas_Object *obj, Evas_Coord foc, Evas_Coord x, Evas_Coord y) EINA_ARG_NONNULL(1);
25616 * @brief Runs the flip animation
25618 * @param obj The flip object
25619 * @param mode The mode type
25621 * Flips the front and back contents using the @p mode animation. This
25622 * efectively hides the currently visible content and shows the hidden one.
25624 * There a number of possible animations to use for the flipping:
25625 * @li ELM_FLIP_ROTATE_X_CENTER_AXIS - Rotate the currently visible content
25626 * around a horizontal axis in the middle of its height, the other content
25627 * is shown as the other side of the flip.
25628 * @li ELM_FLIP_ROTATE_Y_CENTER_AXIS - Rotate the currently visible content
25629 * around a vertical axis in the middle of its width, the other content is
25630 * shown as the other side of the flip.
25631 * @li ELM_FLIP_ROTATE_XZ_CENTER_AXIS - Rotate the currently visible content
25632 * around a diagonal axis in the middle of its width, the other content is
25633 * shown as the other side of the flip.
25634 * @li ELM_FLIP_ROTATE_YZ_CENTER_AXIS - Rotate the currently visible content
25635 * around a diagonal axis in the middle of its height, the other content is
25636 * shown as the other side of the flip.
25637 * @li ELM_FLIP_CUBE_LEFT - Rotate the currently visible content to the left
25638 * as if the flip was a cube, the other content is show as the right face of
25640 * @li ELM_FLIP_CUBE_RIGHT - Rotate the currently visible content to the
25641 * right as if the flip was a cube, the other content is show as the left
25642 * face of the cube.
25643 * @li ELM_FLIP_CUBE_UP - Rotate the currently visible content up as if the
25644 * flip was a cube, the other content is show as the bottom face of the cube.
25645 * @li ELM_FLIP_CUBE_DOWN - Rotate the currently visible content down as if
25646 * the flip was a cube, the other content is show as the upper face of the
25648 * @li ELM_FLIP_PAGE_LEFT - Move the currently visible content to the left as
25649 * if the flip was a book, the other content is shown as the page below that.
25650 * @li ELM_FLIP_PAGE_RIGHT - Move the currently visible content to the right
25651 * as if the flip was a book, the other content is shown as the page below
25653 * @li ELM_FLIP_PAGE_UP - Move the currently visible content up as if the
25654 * flip was a book, the other content is shown as the page below that.
25655 * @li ELM_FLIP_PAGE_DOWN - Move the currently visible content down as if the
25656 * flip was a book, the other content is shown as the page below that.
25658 * @image html elm_flip.png
25659 * @image latex elm_flip.eps width=\textwidth
25661 EAPI void elm_flip_go(Evas_Object *obj, Elm_Flip_Mode mode) EINA_ARG_NONNULL(1);
25664 * @brief Set the interactive flip mode
25666 * @param obj The flip object
25667 * @param mode The interactive flip mode to use
25669 * This sets if the flip should be interactive (allow user to click and
25670 * drag a side of the flip to reveal the back page and cause it to flip).
25671 * By default a flip is not interactive. You may also need to set which
25672 * sides of the flip are "active" for flipping and how much space they use
25673 * (a minimum of a finger size) with elm_flip_interacton_direction_enabled_set()
25674 * and elm_flip_interacton_direction_hitsize_set()
25676 * The four avilable mode of interaction are:
25677 * @li ELM_FLIP_INTERACTION_NONE - No interaction is allowed
25678 * @li ELM_FLIP_INTERACTION_ROTATE - Interaction will cause rotate animation
25679 * @li ELM_FLIP_INTERACTION_CUBE - Interaction will cause cube animation
25680 * @li ELM_FLIP_INTERACTION_PAGE - Interaction will cause page animation
25682 * @note ELM_FLIP_INTERACTION_ROTATE won't cause
25683 * ELM_FLIP_ROTATE_XZ_CENTER_AXIS or ELM_FLIP_ROTATE_YZ_CENTER_AXIS to
25684 * happen, those can only be acheived with elm_flip_go();
25686 EAPI void elm_flip_interaction_set(Evas_Object *obj, Elm_Flip_Interaction mode);
25689 * @brief Get the interactive flip mode
25691 * @param obj The flip object
25692 * @return The interactive flip mode
25694 * Returns the interactive flip mode set by elm_flip_interaction_set()
25696 EAPI Elm_Flip_Interaction elm_flip_interaction_get(const Evas_Object *obj);
25699 * @brief Set which directions of the flip respond to interactive flip
25701 * @param obj The flip object
25702 * @param dir The direction to change
25703 * @param enabled If that direction is enabled or not
25705 * By default all directions are disabled, so you may want to enable the
25706 * desired directions for flipping if you need interactive flipping. You must
25707 * call this function once for each direction that should be enabled.
25709 * @see elm_flip_interaction_set()
25711 EAPI void elm_flip_interacton_direction_enabled_set(Evas_Object *obj, Elm_Flip_Direction dir, Eina_Bool enabled);
25714 * @brief Get the enabled state of that flip direction
25716 * @param obj The flip object
25717 * @param dir The direction to check
25718 * @return If that direction is enabled or not
25720 * Gets the enabled state set by elm_flip_interacton_direction_enabled_set()
25722 * @see elm_flip_interaction_set()
25724 EAPI Eina_Bool elm_flip_interacton_direction_enabled_get(Evas_Object *obj, Elm_Flip_Direction dir);
25727 * @brief Set the amount of the flip that is sensitive to interactive flip
25729 * @param obj The flip object
25730 * @param dir The direction to modify
25731 * @param hitsize The amount of that dimension (0.0 to 1.0) to use
25733 * Set the amount of the flip that is sensitive to interactive flip, with 0
25734 * representing no area in the flip and 1 representing the entire flip. There
25735 * is however a consideration to be made in that the area will never be
25736 * smaller than the finger size set(as set in your Elementary configuration).
25738 * @see elm_flip_interaction_set()
25740 EAPI void elm_flip_interacton_direction_hitsize_set(Evas_Object *obj, Elm_Flip_Direction dir, double hitsize);
25743 * @brief Get the amount of the flip that is sensitive to interactive flip
25745 * @param obj The flip object
25746 * @param dir The direction to check
25747 * @return The size set for that direction
25749 * Returns the amount os sensitive area set by
25750 * elm_flip_interacton_direction_hitsize_set().
25752 EAPI double elm_flip_interacton_direction_hitsize_get(Evas_Object *obj, Elm_Flip_Direction dir);
25758 /* scrolledentry */
25759 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
25760 EINA_DEPRECATED EAPI void elm_scrolled_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line) EINA_ARG_NONNULL(1);
25761 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_single_line_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25762 EINA_DEPRECATED EAPI void elm_scrolled_entry_password_set(Evas_Object *obj, Eina_Bool password) EINA_ARG_NONNULL(1);
25763 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_password_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25764 EINA_DEPRECATED EAPI void elm_scrolled_entry_entry_set(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
25765 EINA_DEPRECATED EAPI const char *elm_scrolled_entry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25766 EINA_DEPRECATED EAPI void elm_scrolled_entry_entry_append(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
25767 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_is_empty(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25768 EINA_DEPRECATED EAPI const char *elm_scrolled_entry_selection_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25769 EINA_DEPRECATED EAPI void elm_scrolled_entry_entry_insert(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
25770 EINA_DEPRECATED EAPI void elm_scrolled_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
25771 EINA_DEPRECATED EAPI void elm_scrolled_entry_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
25772 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25773 EINA_DEPRECATED EAPI void elm_scrolled_entry_select_none(Evas_Object *obj) EINA_ARG_NONNULL(1);
25774 EINA_DEPRECATED EAPI void elm_scrolled_entry_select_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
25775 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
25776 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
25777 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_up(Evas_Object *obj) EINA_ARG_NONNULL(1);
25778 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_down(Evas_Object *obj) EINA_ARG_NONNULL(1);
25779 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
25780 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
25781 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_line_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
25782 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_line_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
25783 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_selection_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
25784 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_selection_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
25785 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_is_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25786 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_is_visible_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25787 EINA_DEPRECATED EAPI const char *elm_scrolled_entry_cursor_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25788 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_pos_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
25789 EINA_DEPRECATED EAPI int elm_scrolled_entry_cursor_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25790 EINA_DEPRECATED EAPI void elm_scrolled_entry_selection_cut(Evas_Object *obj) EINA_ARG_NONNULL(1);
25791 EINA_DEPRECATED EAPI void elm_scrolled_entry_selection_copy(Evas_Object *obj) EINA_ARG_NONNULL(1);
25792 EINA_DEPRECATED EAPI void elm_scrolled_entry_selection_paste(Evas_Object *obj) EINA_ARG_NONNULL(1);
25793 EINA_DEPRECATED EAPI void elm_scrolled_entry_context_menu_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
25794 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);
25795 EINA_DEPRECATED EAPI void elm_scrolled_entry_context_menu_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
25796 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_context_menu_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25797 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);
25798 EINA_DEPRECATED EAPI void elm_scrolled_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
25799 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);
25800 EINA_DEPRECATED EAPI void elm_scrolled_entry_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1, 2);
25801 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25802 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
25803 EINA_DEPRECATED EAPI void elm_scrolled_entry_icon_visible_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
25804 EINA_DEPRECATED EAPI void elm_scrolled_entry_end_set(Evas_Object *obj, Evas_Object *end) EINA_ARG_NONNULL(1, 2);
25805 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_end_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25806 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_end_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
25807 EINA_DEPRECATED EAPI void elm_scrolled_entry_end_visible_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
25808 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);
25809 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);
25810 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);
25811 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);
25812 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);
25813 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);
25814 EINA_DEPRECATED EAPI void elm_scrolled_entry_file_set(Evas_Object *obj, const char *file, Elm_Text_Format format) EINA_ARG_NONNULL(1);
25815 EINA_DEPRECATED EAPI void elm_scrolled_entry_file_get(const Evas_Object *obj, const char **file, Elm_Text_Format *format) EINA_ARG_NONNULL(1);
25816 EINA_DEPRECATED EAPI void elm_scrolled_entry_file_save(Evas_Object *obj) EINA_ARG_NONNULL(1);
25817 EINA_DEPRECATED EAPI void elm_scrolled_entry_autosave_set(Evas_Object *obj, Eina_Bool autosave) EINA_ARG_NONNULL(1);
25818 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_autosave_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25819 EINA_DEPRECATED EAPI void elm_scrolled_entry_cnp_textonly_set(Evas_Object *obj, Eina_Bool textonly) EINA_ARG_NONNULL(1);
25820 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cnp_textonly_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
25823 * @defgroup Conformant Conformant
25824 * @ingroup Elementary
25826 * @image html img/widget/conformant/preview-00.png
25827 * @image latex img/widget/conformant/preview-00.eps width=\textwidth
25829 * @image html img/conformant.png
25830 * @image latex img/conformant.eps width=\textwidth
25832 * The aim is to provide a widget that can be used in elementary apps to
25833 * account for space taken up by the indicator, virtual keypad & softkey
25834 * windows when running the illume2 module of E17.
25836 * So conformant content will be sized and positioned considering the
25837 * space required for such stuff, and when they popup, as a keyboard
25838 * shows when an entry is selected, conformant content won't change.
25840 * Available styles for it:
25843 * Default contents parts of the conformant widget that you can use for are:
25844 * @li "default" - A content of the conformant
25846 * See how to use this widget in this example:
25847 * @ref conformant_example
25851 * @addtogroup Conformant
25856 * Add a new conformant widget to the given parent Elementary
25857 * (container) object.
25859 * @param parent The parent object.
25860 * @return A new conformant widget handle or @c NULL, on errors.
25862 * This function inserts a new conformant widget on the canvas.
25864 * @ingroup Conformant
25866 EAPI Evas_Object *elm_conformant_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
25869 * Set the content of the conformant widget.
25871 * @param obj The conformant object.
25872 * @param content The content to be displayed by the conformant.
25874 * Content will be sized and positioned considering the space required
25875 * to display a virtual keyboard. So it won't fill all the conformant
25876 * size. This way is possible to be sure that content won't resize
25877 * or be re-positioned after the keyboard is displayed.
25879 * Once the content object is set, a previously set one will be deleted.
25880 * If you want to keep that old content object, use the
25881 * elm_object_content_unset() function.
25883 * @see elm_object_content_unset()
25884 * @see elm_object_content_get()
25886 * @deprecated use elm_object_content_set() instead
25888 * @ingroup Conformant
25890 EINA_DEPRECATED EAPI void elm_conformant_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
25893 * Get the content of the conformant widget.
25895 * @param obj The conformant object.
25896 * @return The content that is being used.
25898 * Return the content object which is set for this widget.
25899 * It won't be unparent from conformant. For that, use
25900 * elm_object_content_unset().
25902 * @see elm_object_content_set().
25903 * @see elm_object_content_unset()
25905 * @deprecated use elm_object_content_get() instead
25907 * @ingroup Conformant
25909 EINA_DEPRECATED EAPI Evas_Object *elm_conformant_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25912 * Unset the content of the conformant widget.
25914 * @param obj The conformant object.
25915 * @return The content that was being used.
25917 * Unparent and return the content object which was set for this widget.
25919 * @see elm_object_content_set().
25921 * @deprecated use elm_object_content_unset() instead
25923 * @ingroup Conformant
25925 EINA_DEPRECATED EAPI Evas_Object *elm_conformant_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
25928 * Returns the Evas_Object that represents the content area.
25930 * @param obj The conformant object.
25931 * @return The content area of the widget.
25933 * @ingroup Conformant
25935 EAPI Evas_Object *elm_conformant_content_area_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25942 * @defgroup Mapbuf Mapbuf
25943 * @ingroup Elementary
25945 * @image html img/widget/mapbuf/preview-00.png
25946 * @image latex img/widget/mapbuf/preview-00.eps width=\textwidth
25948 * This holds one content object and uses an Evas Map of transformation
25949 * points to be later used with this content. So the content will be
25950 * moved, resized, etc as a single image. So it will improve performance
25951 * when you have a complex interafce, with a lot of elements, and will
25952 * need to resize or move it frequently (the content object and its
25955 * Default contents parts of the mapbuf widget that you can use for are:
25956 * @li "default" - A content of the mapbuf
25958 * To enable map, elm_mapbuf_enabled_set() should be used.
25960 * See how to use this widget in this example:
25961 * @ref mapbuf_example
25965 * @addtogroup Mapbuf
25970 * Add a new mapbuf widget to the given parent Elementary
25971 * (container) object.
25973 * @param parent The parent object.
25974 * @return A new mapbuf widget handle or @c NULL, on errors.
25976 * This function inserts a new mapbuf widget on the canvas.
25980 EAPI Evas_Object *elm_mapbuf_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
25983 * Set the content of the mapbuf.
25985 * @param obj The mapbuf object.
25986 * @param content The content that will be filled in this mapbuf object.
25988 * Once the content object is set, a previously set one will be deleted.
25989 * If you want to keep that old content object, use the
25990 * elm_mapbuf_content_unset() function.
25992 * To enable map, elm_mapbuf_enabled_set() should be used.
25994 * @deprecated use elm_object_content_set() instead
25998 EINA_DEPRECATED EAPI void elm_mapbuf_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
26001 * Get the content of the mapbuf.
26003 * @param obj The mapbuf object.
26004 * @return The content that is being used.
26006 * Return the content object which is set for this widget.
26008 * @see elm_mapbuf_content_set() for details.
26010 * @deprecated use elm_object_content_get() instead
26014 EINA_DEPRECATED EAPI Evas_Object *elm_mapbuf_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26017 * Unset the content of the mapbuf.
26019 * @param obj The mapbuf object.
26020 * @return The content that was being used.
26022 * Unparent and return the content object which was set for this widget.
26024 * @see elm_mapbuf_content_set() for details.
26026 * @deprecated use elm_object_content_unset() instead
26030 EINA_DEPRECATED EAPI Evas_Object *elm_mapbuf_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
26033 * Enable or disable the map.
26035 * @param obj The mapbuf object.
26036 * @param enabled @c EINA_TRUE to enable map or @c EINA_FALSE to disable it.
26038 * This enables the map that is set or disables it. On enable, the object
26039 * geometry will be saved, and the new geometry will change (position and
26040 * size) to reflect the map geometry set.
26042 * Also, when enabled, alpha and smooth states will be used, so if the
26043 * content isn't solid, alpha should be enabled, for example, otherwise
26044 * a black retangle will fill the content.
26046 * When disabled, the stored map will be freed and geometry prior to
26047 * enabling the map will be restored.
26049 * It's disabled by default.
26051 * @see elm_mapbuf_alpha_set()
26052 * @see elm_mapbuf_smooth_set()
26056 EAPI void elm_mapbuf_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
26059 * Get a value whether map is enabled or not.
26061 * @param obj The mapbuf object.
26062 * @return @c EINA_TRUE means map is enabled. @c EINA_FALSE indicates
26063 * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
26065 * @see elm_mapbuf_enabled_set() for details.
26069 EAPI Eina_Bool elm_mapbuf_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26072 * Enable or disable smooth map rendering.
26074 * @param obj The mapbuf object.
26075 * @param smooth @c EINA_TRUE to enable smooth map rendering or @c EINA_FALSE
26078 * This sets smoothing for map rendering. If the object is a type that has
26079 * its own smoothing settings, then both the smooth settings for this object
26080 * and the map must be turned off.
26082 * By default smooth maps are enabled.
26086 EAPI void elm_mapbuf_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
26089 * Get a value whether smooth map rendering is enabled or not.
26091 * @param obj The mapbuf object.
26092 * @return @c EINA_TRUE means smooth map rendering is enabled. @c EINA_FALSE
26093 * indicates it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
26095 * @see elm_mapbuf_smooth_set() for details.
26099 EAPI Eina_Bool elm_mapbuf_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26102 * Set or unset alpha flag for map rendering.
26104 * @param obj The mapbuf object.
26105 * @param alpha @c EINA_TRUE to enable alpha blending or @c EINA_FALSE
26108 * This sets alpha flag for map rendering. If the object is a type that has
26109 * its own alpha settings, then this will take precedence. Only image objects
26110 * have this currently. It stops alpha blending of the map area, and is
26111 * useful if you know the object and/or all sub-objects is 100% solid.
26113 * Alpha is enabled by default.
26117 EAPI void elm_mapbuf_alpha_set(Evas_Object *obj, Eina_Bool alpha) EINA_ARG_NONNULL(1);
26120 * Get a value whether alpha blending is enabled or not.
26122 * @param obj The mapbuf object.
26123 * @return @c EINA_TRUE means alpha blending is enabled. @c EINA_FALSE
26124 * indicates it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
26126 * @see elm_mapbuf_alpha_set() for details.
26130 EAPI Eina_Bool elm_mapbuf_alpha_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26137 * @defgroup Flipselector Flip Selector
26139 * @image html img/widget/flipselector/preview-00.png
26140 * @image latex img/widget/flipselector/preview-00.eps
26142 * A flip selector is a widget to show a set of @b text items, one
26143 * at a time, with the same sheet switching style as the @ref Clock
26144 * "clock" widget, when one changes the current displaying sheet
26145 * (thus, the "flip" in the name).
26147 * User clicks to flip sheets which are @b held for some time will
26148 * make the flip selector to flip continuosly and automatically for
26149 * the user. The interval between flips will keep growing in time,
26150 * so that it helps the user to reach an item which is distant from
26151 * the current selection.
26153 * Smart callbacks one can register to:
26154 * - @c "selected" - when the widget's selected text item is changed
26155 * - @c "overflowed" - when the widget's current selection is changed
26156 * from the first item in its list to the last
26157 * - @c "underflowed" - when the widget's current selection is changed
26158 * from the last item in its list to the first
26160 * Available styles for it:
26163 * To set/get the label of the flipselector item, you can use
26164 * elm_object_item_text_set/get APIs.
26165 * Once the text is set, a previously set one will be deleted.
26167 * Here is an example on its usage:
26168 * @li @ref flipselector_example
26172 * @addtogroup Flipselector
26177 * Add a new flip selector widget to the given parent Elementary
26178 * (container) widget
26180 * @param parent The parent object
26181 * @return a new flip selector widget handle or @c NULL, on errors
26183 * This function inserts a new flip selector widget on the canvas.
26185 * @ingroup Flipselector
26187 EAPI Evas_Object *elm_flipselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
26190 * Programmatically select the next item of a flip selector widget
26192 * @param obj The flipselector object
26194 * @note The selection will be animated. Also, if it reaches the
26195 * end of its list of member items, it will continue with the first
26198 * @ingroup Flipselector
26200 EAPI void elm_flipselector_flip_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
26203 * Programmatically select the previous item of a flip selector
26206 * @param obj The flipselector object
26208 * @note The selection will be animated. Also, if it reaches the
26209 * beginning of its list of member items, it will continue with the
26210 * last one backwards.
26212 * @ingroup Flipselector
26214 EAPI void elm_flipselector_flip_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
26217 * Append a (text) item to a flip selector widget
26219 * @param obj The flipselector object
26220 * @param label The (text) label of the new item
26221 * @param func Convenience callback function to take place when
26223 * @param data Data passed to @p func, above
26224 * @return A handle to the item added or @c NULL, on errors
26226 * The widget's list of labels to show will be appended with the
26227 * given value. If the user wishes so, a callback function pointer
26228 * can be passed, which will get called when this same item is
26231 * @note The current selection @b won't be modified by appending an
26232 * element to the list.
26234 * @note The maximum length of the text label is going to be
26235 * determined <b>by the widget's theme</b>. Strings larger than
26236 * that value are going to be @b truncated.
26238 * @ingroup Flipselector
26240 EAPI Elm_Object_Item *elm_flipselector_item_append(Evas_Object *obj, const char *label, Evas_Smart_Cb func, void *data) EINA_ARG_NONNULL(1);
26243 * Prepend a (text) item to a flip selector widget
26245 * @param obj The flipselector object
26246 * @param label The (text) label of the new item
26247 * @param func Convenience callback function to take place when
26249 * @param data Data passed to @p func, above
26250 * @return A handle to the item added or @c NULL, on errors
26252 * The widget's list of labels to show will be prepended with the
26253 * given value. If the user wishes so, a callback function pointer
26254 * can be passed, which will get called when this same item is
26257 * @note The current selection @b won't be modified by prepending
26258 * an element to the list.
26260 * @note The maximum length of the text label is going to be
26261 * determined <b>by the widget's theme</b>. Strings larger than
26262 * that value are going to be @b truncated.
26264 * @ingroup Flipselector
26266 EAPI Elm_Object_Item *elm_flipselector_item_prepend(Evas_Object *obj, const char *label, Evas_Smart_Cb func, void *data) EINA_ARG_NONNULL(1);
26269 * Get the internal list of items in a given flip selector widget.
26271 * @param obj The flipselector object
26272 * @return The list of items (#Elm_Object_Item as data) or
26273 * @c NULL on errors.
26275 * This list is @b not to be modified in any way and must not be
26276 * freed. Use the list members with functions like
26277 * elm_object_item_text_set(),
26278 * elm_object_item_text_get(),
26279 * elm_flipselector_item_del(),
26280 * elm_flipselector_item_selected_get(),
26281 * elm_flipselector_item_selected_set().
26283 * @warning This list is only valid until @p obj object's internal
26284 * items list is changed. It should be fetched again with another
26285 * call to this function when changes happen.
26287 * @ingroup Flipselector
26289 EAPI const Eina_List *elm_flipselector_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26292 * Get the first item in the given flip selector widget's list of
26295 * @param obj The flipselector object
26296 * @return The first item or @c NULL, if it has no items (and on
26299 * @see elm_flipselector_item_append()
26300 * @see elm_flipselector_last_item_get()
26302 * @ingroup Flipselector
26304 EAPI Elm_Object_Item *elm_flipselector_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26307 * Get the last item in the given flip selector widget's list of
26310 * @param obj The flipselector object
26311 * @return The last item or @c NULL, if it has no items (and on
26314 * @see elm_flipselector_item_prepend()
26315 * @see elm_flipselector_first_item_get()
26317 * @ingroup Flipselector
26319 EAPI Elm_Object_Item *elm_flipselector_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26322 * Get the currently selected item in a flip selector widget.
26324 * @param obj The flipselector object
26325 * @return The selected item or @c NULL, if the widget has no items
26328 * @ingroup Flipselector
26330 EAPI Elm_Object_Item *elm_flipselector_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26333 * Set whether a given flip selector widget's item should be the
26334 * currently selected one.
26336 * @param it The flip selector item
26337 * @param selected @c EINA_TRUE to select it, @c EINA_FALSE to unselect.
26339 * This sets whether @p item is or not the selected (thus, under
26340 * display) one. If @p item is different than one under display,
26341 * the latter will be unselected. If the @p item is set to be
26342 * unselected, on the other hand, the @b first item in the widget's
26343 * internal members list will be the new selected one.
26345 * @see elm_flipselector_item_selected_get()
26347 * @ingroup Flipselector
26349 EAPI void elm_flipselector_item_selected_set(Elm_Object_Item *it, Eina_Bool selected) EINA_ARG_NONNULL(1);
26352 * Get whether a given flip selector widget's item is the currently
26355 * @param it The flip selector item
26356 * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
26359 * @see elm_flipselector_item_selected_set()
26361 * @ingroup Flipselector
26363 EAPI Eina_Bool elm_flipselector_item_selected_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26366 * Delete a given item from a flip selector widget.
26368 * @param it The item to delete
26370 * @ingroup Flipselector
26372 EAPI void elm_flipselector_item_del(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26375 * Get the label of a given flip selector widget's item.
26377 * @param it The item to get label from
26378 * @return The text label of @p item or @c NULL, on errors
26380 * @see elm_object_item_text_set()
26382 * @deprecated see elm_object_item_text_get() instead
26383 * @ingroup Flipselector
26385 EINA_DEPRECATED EAPI const char *elm_flipselector_item_label_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26388 * Set the label of a given flip selector widget's item.
26390 * @param it The item to set label on
26391 * @param label The text label string, in UTF-8 encoding
26393 * @see elm_object_item_text_get()
26395 * @deprecated see elm_object_item_text_set() instead
26396 * @ingroup Flipselector
26398 EINA_DEPRECATED EAPI void elm_flipselector_item_label_set(Elm_Object_Item *it, const char *label) EINA_ARG_NONNULL(1);
26401 * Gets the item before @p item in a flip selector widget's
26402 * internal list of items.
26404 * @param it The item to fetch previous from
26405 * @return The item before the @p item, in its parent's list. If
26406 * there is no previous item for @p item or there's an
26407 * error, @c NULL is returned.
26409 * @see elm_flipselector_item_next_get()
26411 * @ingroup Flipselector
26413 EAPI Elm_Object_Item *elm_flipselector_item_prev_get(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26416 * Gets the item after @p item in a flip selector widget's
26417 * internal list of items.
26419 * @param it The item to fetch next from
26420 * @return The item after the @p item, in its parent's list. If
26421 * there is no next item for @p item or there's an
26422 * error, @c NULL is returned.
26424 * @see elm_flipselector_item_next_get()
26426 * @ingroup Flipselector
26428 EAPI Elm_Object_Item *elm_flipselector_item_next_get(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26431 * Set the interval on time updates for an user mouse button hold
26432 * on a flip selector widget.
26434 * @param obj The flip selector object
26435 * @param interval The (first) interval value in seconds
26437 * This interval value is @b decreased while the user holds the
26438 * mouse pointer either flipping up or flipping doww a given flip
26441 * This helps the user to get to a given item distant from the
26442 * current one easier/faster, as it will start to flip quicker and
26443 * quicker on mouse button holds.
26445 * The calculation for the next flip interval value, starting from
26446 * the one set with this call, is the previous interval divided by
26447 * 1.05, so it decreases a little bit.
26449 * The default starting interval value for automatic flips is
26452 * @see elm_flipselector_interval_get()
26454 * @ingroup Flipselector
26456 EAPI void elm_flipselector_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
26459 * Get the interval on time updates for an user mouse button hold
26460 * on a flip selector widget.
26462 * @param obj The flip selector object
26463 * @return The (first) interval value, in seconds, set on it
26465 * @see elm_flipselector_interval_set() for more details
26467 * @ingroup Flipselector
26469 EAPI double elm_flipselector_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26475 * @addtogroup Calendar
26480 * @enum _Elm_Calendar_Mark_Repeat
26481 * @typedef Elm_Calendar_Mark_Repeat
26483 * Event periodicity, used to define if a mark should be repeated
26484 * @b beyond event's day. It's set when a mark is added.
26486 * So, for a mark added to 13th May with periodicity set to WEEKLY,
26487 * there will be marks every week after this date. Marks will be displayed
26488 * at 13th, 20th, 27th, 3rd June ...
26490 * Values don't work as bitmask, only one can be choosen.
26492 * @see elm_calendar_mark_add()
26494 * @ingroup Calendar
26496 typedef enum _Elm_Calendar_Mark_Repeat
26498 ELM_CALENDAR_UNIQUE, /**< Default value. Marks will be displayed only on event day. */
26499 ELM_CALENDAR_DAILY, /**< Marks will be displayed everyday after event day (inclusive). */
26500 ELM_CALENDAR_WEEKLY, /**< Marks will be displayed every week after event day (inclusive) - i.e. each seven days. */
26501 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*/
26502 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. */
26503 } Elm_Calendar_Mark_Repeat;
26505 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(). */
26508 * Add a new calendar widget to the given parent Elementary
26509 * (container) object.
26511 * @param parent The parent object.
26512 * @return a new calendar widget handle or @c NULL, on errors.
26514 * This function inserts a new calendar widget on the canvas.
26516 * @ref calendar_example_01
26518 * @ingroup Calendar
26520 EAPI Evas_Object *elm_calendar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
26523 * Get weekdays names displayed by the calendar.
26525 * @param obj The calendar object.
26526 * @return Array of seven strings to be used as weekday names.
26528 * By default, weekdays abbreviations get from system are displayed:
26529 * E.g. for an en_US locale: "Sun, Mon, Tue, Wed, Thu, Fri, Sat"
26530 * The first string is related to Sunday, the second to Monday...
26532 * @see elm_calendar_weekdays_name_set()
26534 * @ref calendar_example_05
26536 * @ingroup Calendar
26538 EAPI const char **elm_calendar_weekdays_names_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26541 * Set weekdays names to be displayed by the calendar.
26543 * @param obj The calendar object.
26544 * @param weekdays Array of seven strings to be used as weekday names.
26545 * @warning It must have 7 elements, or it will access invalid memory.
26546 * @warning The strings must be NULL terminated ('@\0').
26548 * By default, weekdays abbreviations get from system are displayed:
26549 * E.g. for an en_US locale: "Sun, Mon, Tue, Wed, Thu, Fri, Sat"
26551 * The first string should be related to Sunday, the second to Monday...
26553 * The usage should be like this:
26555 * const char *weekdays[] =
26557 * "Sunday", "Monday", "Tuesday", "Wednesday",
26558 * "Thursday", "Friday", "Saturday"
26560 * elm_calendar_weekdays_names_set(calendar, weekdays);
26563 * @see elm_calendar_weekdays_name_get()
26565 * @ref calendar_example_02
26567 * @ingroup Calendar
26569 EAPI void elm_calendar_weekdays_names_set(Evas_Object *obj, const char *weekdays[]) EINA_ARG_NONNULL(1, 2);
26572 * Set the minimum and maximum values for the year
26574 * @param obj The calendar object
26575 * @param min The minimum year, greater than 1901;
26576 * @param max The maximum year;
26578 * Maximum must be greater than minimum, except if you don't wan't to set
26580 * Default values are 1902 and -1.
26582 * If the maximum year is a negative value, it will be limited depending
26583 * on the platform architecture (year 2037 for 32 bits);
26585 * @see elm_calendar_min_max_year_get()
26587 * @ref calendar_example_03
26589 * @ingroup Calendar
26591 EAPI void elm_calendar_min_max_year_set(Evas_Object *obj, int min, int max) EINA_ARG_NONNULL(1);
26594 * Get the minimum and maximum values for the year
26596 * @param obj The calendar object.
26597 * @param min The minimum year.
26598 * @param max The maximum year.
26600 * Default values are 1902 and -1.
26602 * @see elm_calendar_min_max_year_get() for more details.
26604 * @ref calendar_example_05
26606 * @ingroup Calendar
26608 EAPI void elm_calendar_min_max_year_get(const Evas_Object *obj, int *min, int *max) EINA_ARG_NONNULL(1);
26611 * Enable or disable day selection
26613 * @param obj The calendar object.
26614 * @param enabled @c EINA_TRUE to enable selection or @c EINA_FALSE to
26617 * Enabled by default. If disabled, the user still can select months,
26618 * but not days. Selected days are highlighted on calendar.
26619 * It should be used if you won't need such selection for the widget usage.
26621 * When a day is selected, or month is changed, smart callbacks for
26622 * signal "changed" will be called.
26624 * @see elm_calendar_day_selection_enable_get()
26626 * @ref calendar_example_04
26628 * @ingroup Calendar
26630 EAPI void elm_calendar_day_selection_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
26633 * Get a value whether day selection is enabled or not.
26635 * @see elm_calendar_day_selection_enable_set() for details.
26637 * @param obj The calendar object.
26638 * @return EINA_TRUE means day selection is enabled. EINA_FALSE indicates
26639 * it's disabled. If @p obj is NULL, EINA_FALSE is returned.
26641 * @ref calendar_example_05
26643 * @ingroup Calendar
26645 EAPI Eina_Bool elm_calendar_day_selection_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26649 * Set selected date to be highlighted on calendar.
26651 * @param obj The calendar object.
26652 * @param selected_time A @b tm struct to represent the selected date.
26654 * Set the selected date, changing the displayed month if needed.
26655 * Selected date changes when the user goes to next/previous month or
26656 * select a day pressing over it on calendar.
26658 * @see elm_calendar_selected_time_get()
26660 * @ref calendar_example_04
26662 * @ingroup Calendar
26664 EAPI void elm_calendar_selected_time_set(Evas_Object *obj, struct tm *selected_time) EINA_ARG_NONNULL(1);
26667 * Get selected date.
26669 * @param obj The calendar object
26670 * @param selected_time A @b tm struct to point to selected date
26671 * @return EINA_FALSE means an error ocurred and returned time shouldn't
26674 * Get date selected by the user or set by function
26675 * elm_calendar_selected_time_set().
26676 * Selected date changes when the user goes to next/previous month or
26677 * select a day pressing over it on calendar.
26679 * @see elm_calendar_selected_time_get()
26681 * @ref calendar_example_05
26683 * @ingroup Calendar
26685 EAPI Eina_Bool elm_calendar_selected_time_get(const Evas_Object *obj, struct tm *selected_time) EINA_ARG_NONNULL(1, 2);
26688 * Set a function to format the string that will be used to display
26691 * @param obj The calendar object
26692 * @param format_function Function to set the month-year string given
26693 * the selected date
26695 * By default it uses strftime with "%B %Y" format string.
26696 * It should allocate the memory that will be used by the string,
26697 * that will be freed by the widget after usage.
26698 * A pointer to the string and a pointer to the time struct will be provided.
26703 * _format_month_year(struct tm *selected_time)
26706 * if (!strftime(buf, sizeof(buf), "%B %Y", selected_time)) return NULL;
26707 * return strdup(buf);
26710 * elm_calendar_format_function_set(calendar, _format_month_year);
26713 * @ref calendar_example_02
26715 * @ingroup Calendar
26717 EAPI void elm_calendar_format_function_set(Evas_Object *obj, char * (*format_function) (struct tm *stime)) EINA_ARG_NONNULL(1);
26720 * Add a new mark to the calendar
26722 * @param obj The calendar object
26723 * @param mark_type A string used to define the type of mark. It will be
26724 * emitted to the theme, that should display a related modification on these
26725 * days representation.
26726 * @param mark_time A time struct to represent the date of inclusion of the
26727 * mark. For marks that repeats it will just be displayed after the inclusion
26728 * date in the calendar.
26729 * @param repeat Repeat the event following this periodicity. Can be a unique
26730 * mark (that don't repeat), daily, weekly, monthly or annually.
26731 * @return The created mark or @p NULL upon failure.
26733 * Add a mark that will be drawn in the calendar respecting the insertion
26734 * time and periodicity. It will emit the type as signal to the widget theme.
26735 * Default theme supports "holiday" and "checked", but it can be extended.
26737 * It won't immediately update the calendar, drawing the marks.
26738 * For this, call elm_calendar_marks_draw(). However, when user selects
26739 * next or previous month calendar forces marks drawn.
26741 * Marks created with this method can be deleted with
26742 * elm_calendar_mark_del().
26746 * struct tm selected_time;
26747 * time_t current_time;
26749 * current_time = time(NULL) + 5 * 84600;
26750 * localtime_r(¤t_time, &selected_time);
26751 * elm_calendar_mark_add(cal, "holiday", selected_time,
26752 * ELM_CALENDAR_ANNUALLY);
26754 * current_time = time(NULL) + 1 * 84600;
26755 * localtime_r(¤t_time, &selected_time);
26756 * elm_calendar_mark_add(cal, "checked", selected_time, ELM_CALENDAR_UNIQUE);
26758 * elm_calendar_marks_draw(cal);
26761 * @see elm_calendar_marks_draw()
26762 * @see elm_calendar_mark_del()
26764 * @ref calendar_example_06
26766 * @ingroup Calendar
26768 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);
26771 * Delete mark from the calendar.
26773 * @param mark The mark to be deleted.
26775 * If deleting all calendar marks is required, elm_calendar_marks_clear()
26776 * should be used instead of getting marks list and deleting each one.
26778 * @see elm_calendar_mark_add()
26780 * @ref calendar_example_06
26782 * @ingroup Calendar
26784 EAPI void elm_calendar_mark_del(Elm_Calendar_Mark *mark) EINA_ARG_NONNULL(1);
26787 * Remove all calendar's marks
26789 * @param obj The calendar object.
26791 * @see elm_calendar_mark_add()
26792 * @see elm_calendar_mark_del()
26794 * @ingroup Calendar
26796 EAPI void elm_calendar_marks_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
26799 * Get a list of all the calendar marks.
26801 * @param obj The calendar object.
26802 * @return An @c Eina_List of calendar marks objects, or @c NULL on failure.
26804 * @see elm_calendar_mark_add()
26805 * @see elm_calendar_mark_del()
26806 * @see elm_calendar_marks_clear()
26808 * @ingroup Calendar
26810 EAPI const Eina_List *elm_calendar_marks_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26813 * Draw calendar marks.
26815 * @param obj The calendar object.
26817 * Should be used after adding, removing or clearing marks.
26818 * It will go through the entire marks list updating the calendar.
26819 * If lots of marks will be added, add all the marks and then call
26822 * When the month is changed, i.e. user selects next or previous month,
26823 * marks will be drawed.
26825 * @see elm_calendar_mark_add()
26826 * @see elm_calendar_mark_del()
26827 * @see elm_calendar_marks_clear()
26829 * @ref calendar_example_06
26831 * @ingroup Calendar
26833 EAPI void elm_calendar_marks_draw(Evas_Object *obj) EINA_ARG_NONNULL(1);
26836 * Set a day text color to the same that represents Saturdays.
26838 * @param obj The calendar object.
26839 * @param pos The text position. Position is the cell counter, from left
26840 * to right, up to down. It starts on 0 and ends on 41.
26842 * @deprecated use elm_calendar_mark_add() instead like:
26845 * struct tm t = { 0, 0, 12, 6, 0, 0, 6, 6, -1 };
26846 * elm_calendar_mark_add(obj, "sat", &t, ELM_CALENDAR_WEEKLY);
26849 * @see elm_calendar_mark_add()
26851 * @ingroup Calendar
26853 EINA_DEPRECATED EAPI void elm_calendar_text_saturday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
26856 * Set a day text color to the same that represents Sundays.
26858 * @param obj The calendar object.
26859 * @param pos The text position. Position is the cell counter, from left
26860 * to right, up to down. It starts on 0 and ends on 41.
26862 * @deprecated use elm_calendar_mark_add() instead like:
26865 * struct tm t = { 0, 0, 12, 7, 0, 0, 0, 0, -1 };
26866 * elm_calendar_mark_add(obj, "sat", &t, ELM_CALENDAR_WEEKLY);
26869 * @see elm_calendar_mark_add()
26871 * @ingroup Calendar
26873 EINA_DEPRECATED EAPI void elm_calendar_text_sunday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
26876 * Set a day text color to the same that represents Weekdays.
26878 * @param obj The calendar object
26879 * @param pos The text position. Position is the cell counter, from left
26880 * to right, up to down. It starts on 0 and ends on 41.
26882 * @deprecated use elm_calendar_mark_add() instead like:
26885 * struct tm t = { 0, 0, 12, 1, 0, 0, 0, 0, -1 };
26887 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // monday
26888 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
26889 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // tuesday
26890 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
26891 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // wednesday
26892 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
26893 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // thursday
26894 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
26895 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // friday
26898 * @see elm_calendar_mark_add()
26900 * @ingroup Calendar
26902 EINA_DEPRECATED EAPI void elm_calendar_text_weekday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
26905 * Set the interval on time updates for an user mouse button hold
26906 * on calendar widgets' month selection.
26908 * @param obj The calendar object
26909 * @param interval The (first) interval value in seconds
26911 * This interval value is @b decreased while the user holds the
26912 * mouse pointer either selecting next or previous month.
26914 * This helps the user to get to a given month distant from the
26915 * current one easier/faster, as it will start to change quicker and
26916 * quicker on mouse button holds.
26918 * The calculation for the next change interval value, starting from
26919 * the one set with this call, is the previous interval divided by
26920 * 1.05, so it decreases a little bit.
26922 * The default starting interval value for automatic changes is
26925 * @see elm_calendar_interval_get()
26927 * @ingroup Calendar
26929 EAPI void elm_calendar_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
26932 * Get the interval on time updates for an user mouse button hold
26933 * on calendar widgets' month selection.
26935 * @param obj The calendar object
26936 * @return The (first) interval value, in seconds, set on it
26938 * @see elm_calendar_interval_set() for more details
26940 * @ingroup Calendar
26942 EAPI double elm_calendar_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26949 * @defgroup Diskselector Diskselector
26950 * @ingroup Elementary
26952 * @image html img/widget/diskselector/preview-00.png
26953 * @image latex img/widget/diskselector/preview-00.eps
26955 * A diskselector is a kind of list widget. It scrolls horizontally,
26956 * and can contain label and icon objects. Three items are displayed
26957 * with the selected one in the middle.
26959 * It can act like a circular list with round mode and labels can be
26960 * reduced for a defined length for side items.
26962 * Smart callbacks one can listen to:
26963 * - "selected" - when item is selected, i.e. scroller stops.
26965 * Available styles for it:
26968 * List of examples:
26969 * @li @ref diskselector_example_01
26970 * @li @ref diskselector_example_02
26974 * @addtogroup Diskselector
26978 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(). */
26981 * Add a new diskselector widget to the given parent Elementary
26982 * (container) object.
26984 * @param parent The parent object.
26985 * @return a new diskselector widget handle or @c NULL, on errors.
26987 * This function inserts a new diskselector widget on the canvas.
26989 * @ingroup Diskselector
26991 EAPI Evas_Object *elm_diskselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
26994 * Enable or disable round mode.
26996 * @param obj The diskselector object.
26997 * @param round @c EINA_TRUE to enable round mode or @c EINA_FALSE to
27000 * Disabled by default. If round mode is enabled the items list will
27001 * work like a circle list, so when the user reaches the last item,
27002 * the first one will popup.
27004 * @see elm_diskselector_round_get()
27006 * @ingroup Diskselector
27008 EAPI void elm_diskselector_round_set(Evas_Object *obj, Eina_Bool round) EINA_ARG_NONNULL(1);
27011 * Get a value whether round mode is enabled or not.
27013 * @see elm_diskselector_round_set() for details.
27015 * @param obj The diskselector object.
27016 * @return @c EINA_TRUE means round mode is enabled. @c EINA_FALSE indicates
27017 * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
27019 * @ingroup Diskselector
27021 EAPI Eina_Bool elm_diskselector_round_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
27024 * Get the side labels max length.
27026 * @deprecated use elm_diskselector_side_label_length_get() instead:
27028 * @param obj The diskselector object.
27029 * @return The max length defined for side labels, or 0 if not a valid
27032 * @ingroup Diskselector
27034 EINA_DEPRECATED EAPI int elm_diskselector_side_label_lenght_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
27037 * Set the side labels max length.
27039 * @deprecated use elm_diskselector_side_label_length_set() instead:
27041 * @param obj The diskselector object.
27042 * @param len The max length defined for side labels.
27044 * @ingroup Diskselector
27046 EINA_DEPRECATED EAPI void elm_diskselector_side_label_lenght_set(Evas_Object *obj, int len) EINA_ARG_NONNULL(1);
27049 * Get the side labels max length.
27051 * @see elm_diskselector_side_label_length_set() for details.
27053 * @param obj The diskselector object.
27054 * @return The max length defined for side labels, or 0 if not a valid
27057 * @ingroup Diskselector
27059 EAPI int elm_diskselector_side_label_length_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
27062 * Set the side labels max length.
27064 * @param obj The diskselector object.
27065 * @param len The max length defined for side labels.
27067 * Length is the number of characters of items' label that will be
27068 * visible when it's set on side positions. It will just crop
27069 * the string after defined size. E.g.:
27071 * An item with label "January" would be displayed on side position as
27072 * "Jan" if max length is set to 3, or "Janu", if this property
27075 * When it's selected, the entire label will be displayed, except for
27076 * width restrictions. In this case label will be cropped and "..."
27077 * will be concatenated.
27079 * Default side label max length is 3.
27081 * This property will be applyed over all items, included before or
27082 * later this function call.
27084 * @ingroup Diskselector
27086 EAPI void elm_diskselector_side_label_length_set(Evas_Object *obj, int len) EINA_ARG_NONNULL(1);
27089 * Set the number of items to be displayed.
27091 * @param obj The diskselector object.
27092 * @param num The number of items the diskselector will display.
27094 * Default value is 3, and also it's the minimun. If @p num is less
27095 * than 3, it will be set to 3.
27097 * Also, it can be set on theme, using data item @c display_item_num
27098 * on group "elm/diskselector/item/X", where X is style set.
27101 * group { name: "elm/diskselector/item/X";
27103 * item: "display_item_num" "5";
27106 * @ingroup Diskselector
27108 EAPI void elm_diskselector_display_item_num_set(Evas_Object *obj, int num) EINA_ARG_NONNULL(1);
27111 * Get the number of items in the diskselector object.
27113 * @param obj The diskselector object.
27115 * @ingroup Diskselector
27117 EAPI int elm_diskselector_display_item_num_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
27120 * Set bouncing behaviour when the scrolled content reaches an edge.
27122 * Tell the internal scroller object whether it should bounce or not
27123 * when it reaches the respective edges for each axis.
27125 * @param obj The diskselector object.
27126 * @param h_bounce Whether to bounce or not in the horizontal axis.
27127 * @param v_bounce Whether to bounce or not in the vertical axis.
27129 * @see elm_scroller_bounce_set()
27131 * @ingroup Diskselector
27133 EAPI void elm_diskselector_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
27136 * Get the bouncing behaviour of the internal scroller.
27138 * Get whether the internal scroller should bounce when the edge of each
27139 * axis is reached scrolling.
27141 * @param obj The diskselector object.
27142 * @param h_bounce Pointer where to store the bounce state of the horizontal
27144 * @param v_bounce Pointer where to store the bounce state of the vertical
27147 * @see elm_scroller_bounce_get()
27148 * @see elm_diskselector_bounce_set()
27150 * @ingroup Diskselector
27152 EAPI void elm_diskselector_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
27155 * Get the scrollbar policy.
27157 * @see elm_diskselector_scroller_policy_get() for details.
27159 * @param obj The diskselector object.
27160 * @param policy_h Pointer where to store horizontal scrollbar policy.
27161 * @param policy_v Pointer where to store vertical scrollbar policy.
27163 * @ingroup Diskselector
27165 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);
27168 * Set the scrollbar policy.
27170 * @param obj The diskselector object.
27171 * @param policy_h Horizontal scrollbar policy.
27172 * @param policy_v Vertical scrollbar policy.
27174 * This sets the scrollbar visibility policy for the given scroller.
27175 * #ELM_SCROLLER_POLICY_AUTO means the scrollbar is made visible if it
27176 * is needed, and otherwise kept hidden. #ELM_SCROLLER_POLICY_ON turns
27177 * it on all the time, and #ELM_SCROLLER_POLICY_OFF always keeps it off.
27178 * This applies respectively for the horizontal and vertical scrollbars.
27180 * The both are disabled by default, i.e., are set to
27181 * #ELM_SCROLLER_POLICY_OFF.
27183 * @ingroup Diskselector
27185 EAPI void elm_diskselector_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
27188 * Remove all diskselector's items.
27190 * @param obj The diskselector object.
27192 * @see elm_diskselector_item_del()
27193 * @see elm_diskselector_item_append()
27195 * @ingroup Diskselector
27197 EAPI void elm_diskselector_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
27200 * Get a list of all the diskselector items.
27202 * @param obj The diskselector object.
27203 * @return An @c Eina_List of diskselector items, #Elm_Diskselector_Item,
27204 * or @c NULL on failure.
27206 * @see elm_diskselector_item_append()
27207 * @see elm_diskselector_item_del()
27208 * @see elm_diskselector_clear()
27210 * @ingroup Diskselector
27212 EAPI const Eina_List *elm_diskselector_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
27215 * Appends a new item to the diskselector object.
27217 * @param obj The diskselector object.
27218 * @param label The label of the diskselector item.
27219 * @param icon The icon object to use at left side of the item. An
27220 * icon can be any Evas object, but usually it is an icon created
27221 * with elm_icon_add().
27222 * @param func The function to call when the item is selected.
27223 * @param data The data to associate with the item for related callbacks.
27225 * @return The created item or @c NULL upon failure.
27227 * A new item will be created and appended to the diskselector, i.e., will
27228 * be set as last item. Also, if there is no selected item, it will
27229 * be selected. This will always happens for the first appended item.
27231 * If no icon is set, label will be centered on item position, otherwise
27232 * the icon will be placed at left of the label, that will be shifted
27235 * Items created with this method can be deleted with
27236 * elm_diskselector_item_del().
27238 * Associated @p data can be properly freed when item is deleted if a
27239 * callback function is set with elm_diskselector_item_del_cb_set().
27241 * If a function is passed as argument, it will be called everytime this item
27242 * is selected, i.e., the user stops the diskselector with this
27243 * item on center position. If such function isn't needed, just passing
27244 * @c NULL as @p func is enough. The same should be done for @p data.
27246 * Simple example (with no function callback or data associated):
27248 * disk = elm_diskselector_add(win);
27249 * ic = elm_icon_add(win);
27250 * elm_icon_file_set(ic, "path/to/image", NULL);
27251 * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
27252 * elm_diskselector_item_append(disk, "label", ic, NULL, NULL);
27255 * @see elm_diskselector_item_del()
27256 * @see elm_diskselector_item_del_cb_set()
27257 * @see elm_diskselector_clear()
27258 * @see elm_icon_add()
27260 * @ingroup Diskselector
27262 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);
27266 * Delete them item from the diskselector.
27268 * @param it The item of diskselector to be deleted.
27270 * If deleting all diskselector items is required, elm_diskselector_clear()
27271 * should be used instead of getting items list and deleting each one.
27273 * @see elm_diskselector_clear()
27274 * @see elm_diskselector_item_append()
27275 * @see elm_diskselector_item_del_cb_set()
27277 * @ingroup Diskselector
27279 EAPI void elm_diskselector_item_del(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
27282 * Set the function called when a diskselector item is freed.
27284 * @param it The item to set the callback on
27285 * @param func The function called
27287 * If there is a @p func, then it will be called prior item's memory release.
27288 * That will be called with the following arguments:
27290 * @li item's Evas object;
27293 * This way, a data associated to a diskselector item could be properly
27296 * @ingroup Diskselector
27298 EAPI void elm_diskselector_item_del_cb_set(Elm_Diskselector_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
27301 * Get the data associated to the item.
27303 * @param it The diskselector item
27304 * @return The data associated to @p it
27306 * The return value is a pointer to data associated to @p item when it was
27307 * created, with function elm_diskselector_item_append(). If no data
27308 * was passed as argument, it will return @c NULL.
27310 * @see elm_diskselector_item_append()
27312 * @ingroup Diskselector
27314 EAPI void *elm_diskselector_item_data_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
27317 * Set the icon associated to the item.
27319 * @param it The diskselector item
27320 * @param icon The icon object to associate with @p it
27322 * The icon object to use at left side of the item. An
27323 * icon can be any Evas object, but usually it is an icon created
27324 * with elm_icon_add().
27326 * Once the icon object is set, a previously set one will be deleted.
27327 * @warning Setting the same icon for two items will cause the icon to
27328 * dissapear from the first item.
27330 * If an icon was passed as argument on item creation, with function
27331 * elm_diskselector_item_append(), it will be already
27332 * associated to the item.
27334 * @see elm_diskselector_item_append()
27335 * @see elm_diskselector_item_icon_get()
27337 * @ingroup Diskselector
27339 EAPI void elm_diskselector_item_icon_set(Elm_Diskselector_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
27342 * Get the icon associated to the item.
27344 * @param it The diskselector item
27345 * @return The icon associated to @p it
27347 * The return value is a pointer to the icon associated to @p item when it was
27348 * created, with function elm_diskselector_item_append(), or later
27349 * with function elm_diskselector_item_icon_set. If no icon
27350 * was passed as argument, it will return @c NULL.
27352 * @see elm_diskselector_item_append()
27353 * @see elm_diskselector_item_icon_set()
27355 * @ingroup Diskselector
27357 EAPI Evas_Object *elm_diskselector_item_icon_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
27360 * Set the label of item.
27362 * @param it The item of diskselector.
27363 * @param label The label of item.
27365 * The label to be displayed by the item.
27367 * If no icon is set, label will be centered on item position, otherwise
27368 * the icon will be placed at left of the label, that will be shifted
27371 * An item with label "January" would be displayed on side position as
27372 * "Jan" if max length is set to 3 with function
27373 * elm_diskselector_side_label_lenght_set(), or "Janu", if this property
27376 * When this @p item is selected, the entire label will be displayed,
27377 * except for width restrictions.
27378 * In this case label will be cropped and "..." will be concatenated,
27379 * but only for display purposes. It will keep the entire string, so
27380 * if diskselector is resized the remaining characters will be displayed.
27382 * If a label was passed as argument on item creation, with function
27383 * elm_diskselector_item_append(), it will be already
27384 * displayed by the item.
27386 * @see elm_diskselector_side_label_lenght_set()
27387 * @see elm_diskselector_item_label_get()
27388 * @see elm_diskselector_item_append()
27390 * @ingroup Diskselector
27392 EAPI void elm_diskselector_item_label_set(Elm_Diskselector_Item *item, const char *label) EINA_ARG_NONNULL(1);
27395 * Get the label of item.
27397 * @param it The item of diskselector.
27398 * @return The label of item.
27400 * The return value is a pointer to the label associated to @p item when it was
27401 * created, with function elm_diskselector_item_append(), or later
27402 * with function elm_diskselector_item_label_set. If no label
27403 * was passed as argument, it will return @c NULL.
27405 * @see elm_diskselector_item_label_set() for more details.
27406 * @see elm_diskselector_item_append()
27408 * @ingroup Diskselector
27410 EAPI const char *elm_diskselector_item_label_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
27413 * Get the selected item.
27415 * @param obj The diskselector object.
27416 * @return The selected diskselector item.
27418 * The selected item can be unselected with function
27419 * elm_diskselector_item_selected_set(), and the first item of
27420 * diskselector will be selected.
27422 * The selected item always will be centered on diskselector, with
27423 * full label displayed, i.e., max lenght set to side labels won't
27424 * apply on the selected item. More details on
27425 * elm_diskselector_side_label_length_set().
27427 * @ingroup Diskselector
27429 EAPI Elm_Diskselector_Item *elm_diskselector_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
27432 * Set the selected state of an item.
27434 * @param it The diskselector item
27435 * @param selected The selected state
27437 * This sets the selected state of the given item @p it.
27438 * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
27440 * If a new item is selected the previosly selected will be unselected.
27441 * Previoulsy selected item can be get with function
27442 * elm_diskselector_selected_item_get().
27444 * If the item @p it is unselected, the first item of diskselector will
27447 * Selected items will be visible on center position of diskselector.
27448 * So if it was on another position before selected, or was invisible,
27449 * diskselector will animate items until the selected item reaches center
27452 * @see elm_diskselector_item_selected_get()
27453 * @see elm_diskselector_selected_item_get()
27455 * @ingroup Diskselector
27457 EAPI void elm_diskselector_item_selected_set(Elm_Diskselector_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
27460 * Get whether the @p item is selected or not.
27462 * @param it The diskselector item.
27463 * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
27464 * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
27466 * @see elm_diskselector_selected_item_set() for details.
27467 * @see elm_diskselector_item_selected_get()
27469 * @ingroup Diskselector
27471 EAPI Eina_Bool elm_diskselector_item_selected_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
27474 * Get the first item of the diskselector.
27476 * @param obj The diskselector object.
27477 * @return The first item, or @c NULL if none.
27479 * The list of items follows append order. So it will return the first
27480 * item appended to the widget that wasn't deleted.
27482 * @see elm_diskselector_item_append()
27483 * @see elm_diskselector_items_get()
27485 * @ingroup Diskselector
27487 EAPI Elm_Diskselector_Item *elm_diskselector_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
27490 * Get the last item of the diskselector.
27492 * @param obj The diskselector object.
27493 * @return The last item, or @c NULL if none.
27495 * The list of items follows append order. So it will return last first
27496 * item appended to the widget that wasn't deleted.
27498 * @see elm_diskselector_item_append()
27499 * @see elm_diskselector_items_get()
27501 * @ingroup Diskselector
27503 EAPI Elm_Diskselector_Item *elm_diskselector_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
27506 * Get the item before @p item in diskselector.
27508 * @param it The diskselector item.
27509 * @return The item before @p item, or @c NULL if none or on failure.
27511 * The list of items follows append order. So it will return item appended
27512 * just before @p item and that wasn't deleted.
27514 * If it is the first item, @c NULL will be returned.
27515 * First item can be get by elm_diskselector_first_item_get().
27517 * @see elm_diskselector_item_append()
27518 * @see elm_diskselector_items_get()
27520 * @ingroup Diskselector
27522 EAPI Elm_Diskselector_Item *elm_diskselector_item_prev_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
27525 * Get the item after @p item in diskselector.
27527 * @param it The diskselector item.
27528 * @return The item after @p item, or @c NULL if none or on failure.
27530 * The list of items follows append order. So it will return item appended
27531 * just after @p item and that wasn't deleted.
27533 * If it is the last item, @c NULL will be returned.
27534 * Last item can be get by elm_diskselector_last_item_get().
27536 * @see elm_diskselector_item_append()
27537 * @see elm_diskselector_items_get()
27539 * @ingroup Diskselector
27541 EAPI Elm_Diskselector_Item *elm_diskselector_item_next_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
27544 * Set the text to be shown in the diskselector item.
27546 * @param item Target item
27547 * @param text The text to set in the content
27549 * Setup the text as tooltip to object. The item can have only one tooltip,
27550 * so any previous tooltip data is removed.
27552 * @see elm_object_tooltip_text_set() for more details.
27554 * @ingroup Diskselector
27556 EAPI void elm_diskselector_item_tooltip_text_set(Elm_Diskselector_Item *item, const char *text) EINA_ARG_NONNULL(1);
27559 * Set the content to be shown in the tooltip item.
27561 * Setup the tooltip to item. The item can have only one tooltip,
27562 * so any previous tooltip data is removed. @p func(with @p data) will
27563 * be called every time that need show the tooltip and it should
27564 * return a valid Evas_Object. This object is then managed fully by
27565 * tooltip system and is deleted when the tooltip is gone.
27567 * @param item the diskselector item being attached a tooltip.
27568 * @param func the function used to create the tooltip contents.
27569 * @param data what to provide to @a func as callback data/context.
27570 * @param del_cb called when data is not needed anymore, either when
27571 * another callback replaces @p func, the tooltip is unset with
27572 * elm_diskselector_item_tooltip_unset() or the owner @a item
27573 * dies. This callback receives as the first parameter the
27574 * given @a data, and @c event_info is the item.
27576 * @see elm_object_tooltip_content_cb_set() for more details.
27578 * @ingroup Diskselector
27580 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);
27583 * Unset tooltip from item.
27585 * @param item diskselector item to remove previously set tooltip.
27587 * Remove tooltip from item. The callback provided as del_cb to
27588 * elm_diskselector_item_tooltip_content_cb_set() will be called to notify
27589 * it is not used anymore.
27591 * @see elm_object_tooltip_unset() for more details.
27592 * @see elm_diskselector_item_tooltip_content_cb_set()
27594 * @ingroup Diskselector
27596 EAPI void elm_diskselector_item_tooltip_unset(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
27599 * Sets a different style for this item tooltip.
27601 * @note before you set a style you should define a tooltip with
27602 * elm_diskselector_item_tooltip_content_cb_set() or
27603 * elm_diskselector_item_tooltip_text_set()
27605 * @param item diskselector item with tooltip already set.
27606 * @param style the theme style to use (default, transparent, ...)
27608 * @see elm_object_tooltip_style_set() for more details.
27610 * @ingroup Diskselector
27612 EAPI void elm_diskselector_item_tooltip_style_set(Elm_Diskselector_Item *item, const char *style) EINA_ARG_NONNULL(1);
27615 * Get the style for this item tooltip.
27617 * @param item diskselector item with tooltip already set.
27618 * @return style the theme style in use, defaults to "default". If the
27619 * object does not have a tooltip set, then NULL is returned.
27621 * @see elm_object_tooltip_style_get() for more details.
27622 * @see elm_diskselector_item_tooltip_style_set()
27624 * @ingroup Diskselector
27626 EAPI const char *elm_diskselector_item_tooltip_style_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
27629 * Set the cursor to be shown when mouse is over the diskselector item
27631 * @param item Target item
27632 * @param cursor the cursor name to be used.
27634 * @see elm_object_cursor_set() for more details.
27636 * @ingroup Diskselector
27638 EAPI void elm_diskselector_item_cursor_set(Elm_Diskselector_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
27641 * Get the cursor to be shown when mouse is over the diskselector item
27643 * @param item diskselector item with cursor already set.
27644 * @return the cursor name.
27646 * @see elm_object_cursor_get() for more details.
27647 * @see elm_diskselector_cursor_set()
27649 * @ingroup Diskselector
27651 EAPI const char *elm_diskselector_item_cursor_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
27654 * Unset the cursor to be shown when mouse is over the diskselector item
27656 * @param item Target item
27658 * @see elm_object_cursor_unset() for more details.
27659 * @see elm_diskselector_cursor_set()
27661 * @ingroup Diskselector
27663 EAPI void elm_diskselector_item_cursor_unset(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
27666 * Sets a different style for this item cursor.
27668 * @note before you set a style you should define a cursor with
27669 * elm_diskselector_item_cursor_set()
27671 * @param item diskselector item with cursor already set.
27672 * @param style the theme style to use (default, transparent, ...)
27674 * @see elm_object_cursor_style_set() for more details.
27676 * @ingroup Diskselector
27678 EAPI void elm_diskselector_item_cursor_style_set(Elm_Diskselector_Item *item, const char *style) EINA_ARG_NONNULL(1);
27681 * Get the style for this item cursor.
27683 * @param item diskselector item with cursor already set.
27684 * @return style the theme style in use, defaults to "default". If the
27685 * object does not have a cursor set, then @c NULL is returned.
27687 * @see elm_object_cursor_style_get() for more details.
27688 * @see elm_diskselector_item_cursor_style_set()
27690 * @ingroup Diskselector
27692 EAPI const char *elm_diskselector_item_cursor_style_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
27696 * Set if the cursor set should be searched on the theme or should use
27697 * the provided by the engine, only.
27699 * @note before you set if should look on theme you should define a cursor
27700 * with elm_diskselector_item_cursor_set().
27701 * By default it will only look for cursors provided by the engine.
27703 * @param item widget item with cursor already set.
27704 * @param engine_only boolean to define if cursors set with
27705 * elm_diskselector_item_cursor_set() should be searched only
27706 * between cursors provided by the engine or searched on widget's
27709 * @see elm_object_cursor_engine_only_set() for more details.
27711 * @ingroup Diskselector
27713 EAPI void elm_diskselector_item_cursor_engine_only_set(Elm_Diskselector_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
27716 * Get the cursor engine only usage for this item cursor.
27718 * @param item widget item with cursor already set.
27719 * @return engine_only boolean to define it cursors should be looked only
27720 * between the provided by the engine or searched on widget's theme as well.
27721 * If the item does not have a cursor set, then @c EINA_FALSE is returned.
27723 * @see elm_object_cursor_engine_only_get() for more details.
27724 * @see elm_diskselector_item_cursor_engine_only_set()
27726 * @ingroup Diskselector
27728 EAPI Eina_Bool elm_diskselector_item_cursor_engine_only_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
27735 * @defgroup Colorselector Colorselector
27739 * @image html img/widget/colorselector/preview-00.png
27740 * @image latex img/widget/colorselector/preview-00.eps
27742 * @brief Widget for user to select a color.
27744 * Signals that you can add callbacks for are:
27745 * "changed" - When the color value changes(event_info is NULL).
27747 * See @ref tutorial_colorselector.
27750 * @brief Add a new colorselector to the parent
27752 * @param parent The parent object
27753 * @return The new object or NULL if it cannot be created
27755 * @ingroup Colorselector
27757 EAPI Evas_Object *elm_colorselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
27759 * Set a color for the colorselector
27761 * @param obj Colorselector object
27762 * @param r r-value of color
27763 * @param g g-value of color
27764 * @param b b-value of color
27765 * @param a a-value of color
27767 * @ingroup Colorselector
27769 EAPI void elm_colorselector_color_set(Evas_Object *obj, int r, int g , int b, int a) EINA_ARG_NONNULL(1);
27771 * Get a color from the colorselector
27773 * @param obj Colorselector object
27774 * @param r integer pointer for r-value of color
27775 * @param g integer pointer for g-value of color
27776 * @param b integer pointer for b-value of color
27777 * @param a integer pointer for a-value of color
27779 * @ingroup Colorselector
27781 EAPI void elm_colorselector_color_get(const Evas_Object *obj, int *r, int *g , int *b, int *a) EINA_ARG_NONNULL(1);
27787 * @defgroup Ctxpopup Ctxpopup
27789 * @image html img/widget/ctxpopup/preview-00.png
27790 * @image latex img/widget/ctxpopup/preview-00.eps
27792 * @brief Context popup widet.
27794 * A ctxpopup is a widget that, when shown, pops up a list of items.
27795 * It automatically chooses an area inside its parent object's view
27796 * (set via elm_ctxpopup_add() and elm_ctxpopup_hover_parent_set()) to
27797 * optimally fit into it. In the default theme, it will also point an
27798 * arrow to it's top left position at the time one shows it. Ctxpopup
27799 * items have a label and/or an icon. It is intended for a small
27800 * number of items (hence the use of list, not genlist).
27802 * @note Ctxpopup is a especialization of @ref Hover.
27804 * Signals that you can add callbacks for are:
27805 * "dismissed" - the ctxpopup was dismissed
27807 * Default contents parts of the ctxpopup widget that you can use for are:
27808 * @li "default" - A content of the ctxpopup
27810 * Default contents parts of the ctxpopup items that you can use for are:
27811 * @li "icon" - An icon in the title area
27813 * Default text parts of the ctxpopup items that you can use for are:
27814 * @li "default" - Title label in the title area
27816 * @ref tutorial_ctxpopup shows the usage of a good deal of the API.
27821 * @addtogroup Ctxpopup
27825 typedef enum _Elm_Ctxpopup_Direction
27827 ELM_CTXPOPUP_DIRECTION_DOWN, /**< ctxpopup show appear below clicked
27829 ELM_CTXPOPUP_DIRECTION_RIGHT, /**< ctxpopup show appear to the right of
27830 the clicked area */
27831 ELM_CTXPOPUP_DIRECTION_LEFT, /**< ctxpopup show appear to the left of
27832 the clicked area */
27833 ELM_CTXPOPUP_DIRECTION_UP, /**< ctxpopup show appear above the clicked
27835 ELM_CTXPOPUP_DIRECTION_UNKNOWN, /**< ctxpopup does not determine it's direction yet*/
27836 } Elm_Ctxpopup_Direction;
27839 * @brief Add a new Ctxpopup object to the parent.
27841 * @param parent Parent object
27842 * @return New object or @c NULL, if it cannot be created
27844 * @ingroup Ctxpopup
27846 EAPI Evas_Object *elm_ctxpopup_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
27849 * @brief Set the Ctxpopup's parent
27851 * @param obj The ctxpopup object
27852 * @param area The parent to use
27854 * Set the parent object.
27856 * @note elm_ctxpopup_add() will automatically call this function
27857 * with its @c parent argument.
27859 * @see elm_ctxpopup_add()
27860 * @see elm_hover_parent_set()
27862 * @ingroup Ctxpopup
27864 EAPI void elm_ctxpopup_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1, 2);
27867 * @brief Get the Ctxpopup's parent
27869 * @param obj The ctxpopup object
27871 * @see elm_ctxpopup_hover_parent_set() for more information
27873 * @ingroup Ctxpopup
27875 EAPI Evas_Object *elm_ctxpopup_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
27878 * @brief Clear all items in the given ctxpopup object.
27880 * @param obj Ctxpopup object
27882 * @ingroup Ctxpopup
27884 EAPI void elm_ctxpopup_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
27887 * @brief Change the ctxpopup's orientation to horizontal or vertical.
27889 * @param obj Ctxpopup object
27890 * @param horizontal @c EINA_TRUE for horizontal mode, @c EINA_FALSE for vertical
27892 * @ingroup Ctxpopup
27894 EAPI void elm_ctxpopup_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
27897 * @brief Get the value of current ctxpopup object's orientation.
27899 * @param obj Ctxpopup object
27900 * @return @c EINA_TRUE for horizontal mode, @c EINA_FALSE for vertical mode (or errors)
27902 * @see elm_ctxpopup_horizontal_set()
27904 * @ingroup Ctxpopup
27906 EAPI Eina_Bool elm_ctxpopup_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
27909 * @brief Add a new item to a ctxpopup object.
27911 * @param obj Ctxpopup object
27912 * @param icon Icon to be set on new item
27913 * @param label The Label of the new item
27914 * @param func Convenience function called when item selected
27915 * @param data Data passed to @p func
27916 * @return A handle to the item added or @c NULL, on errors
27918 * @warning Ctxpopup can't hold both an item list and a content at the same
27919 * time. When an item is added, any previous content will be removed.
27921 * @see elm_ctxpopup_content_set()
27923 * @ingroup Ctxpopup
27925 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);
27928 * @brief Delete the given item in a ctxpopup object.
27930 * @param it Ctxpopup item to be deleted
27932 * @see elm_ctxpopup_item_append()
27934 * @ingroup Ctxpopup
27936 EAPI void elm_ctxpopup_item_del(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
27939 * @brief Set the ctxpopup item's state as disabled or enabled.
27941 * @param it Ctxpopup item to be enabled/disabled
27942 * @param disabled @c EINA_TRUE to disable it, @c EINA_FALSE to enable it
27944 * When disabled the item is greyed out to indicate it's state.
27945 * @deprecated use elm_object_item_disabled_set() instead
27947 * @ingroup Ctxpopup
27949 EINA_DEPRECATED EAPI void elm_ctxpopup_item_disabled_set(Elm_Object_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1);
27952 * @brief Get the ctxpopup item's disabled/enabled state.
27954 * @param it Ctxpopup item to be enabled/disabled
27955 * @return disabled @c EINA_TRUE, if disabled, @c EINA_FALSE otherwise
27957 * @see elm_ctxpopup_item_disabled_set()
27958 * @deprecated use elm_object_item_disabled_get() instead
27960 * @ingroup Ctxpopup
27962 EAPI Eina_Bool elm_ctxpopup_item_disabled_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
27965 * @brief Get the icon object for the given ctxpopup item.
27967 * @param it Ctxpopup item
27968 * @return icon object or @c NULL, if the item does not have icon or an error
27971 * @see elm_ctxpopup_item_append()
27972 * @see elm_ctxpopup_item_icon_set()
27974 * @deprecated use elm_object_item_part_content_get() instead
27976 * @ingroup Ctxpopup
27978 EINA_DEPRECATED EAPI Evas_Object *elm_ctxpopup_item_icon_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
27981 * @brief Sets the side icon associated with the ctxpopup item
27983 * @param it Ctxpopup item
27984 * @param icon Icon object to be set
27986 * Once the icon object is set, a previously set one will be deleted.
27987 * @warning Setting the same icon for two items will cause the icon to
27988 * dissapear from the first item.
27990 * @see elm_ctxpopup_item_append()
27992 * @deprecated use elm_object_item_part_content_set() instead
27994 * @ingroup Ctxpopup
27996 EINA_DEPRECATED EAPI void elm_ctxpopup_item_icon_set(Elm_Object_Item *it, Evas_Object *icon) EINA_ARG_NONNULL(1);
27999 * @brief Get the label for the given ctxpopup item.
28001 * @param it Ctxpopup item
28002 * @return label string or @c NULL, if the item does not have label or an
28005 * @see elm_ctxpopup_item_append()
28006 * @see elm_ctxpopup_item_label_set()
28008 * @deprecated use elm_object_item_text_get() instead
28010 * @ingroup Ctxpopup
28012 EINA_DEPRECATED EAPI const char *elm_ctxpopup_item_label_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
28015 * @brief (Re)set the label on the given ctxpopup item.
28017 * @param it Ctxpopup item
28018 * @param label String to set as label
28020 * @deprecated use elm_object_item_text_set() instead
28022 * @ingroup Ctxpopup
28024 EINA_DEPRECATED EAPI void elm_ctxpopup_item_label_set(Elm_Object_Item *it, const char *label) EINA_ARG_NONNULL(1);
28027 * @brief Set an elm widget as the content of the ctxpopup.
28029 * @param obj Ctxpopup object
28030 * @param content Content to be swallowed
28032 * If the content object is already set, a previous one will bedeleted. If
28033 * you want to keep that old content object, use the
28034 * elm_ctxpopup_content_unset() function.
28036 * @warning Ctxpopup can't hold both a item list and a content at the same
28037 * time. When a content is set, any previous items will be removed.
28039 * @deprecated use elm_object_content_set() instead
28041 * @ingroup Ctxpopup
28043 EINA_DEPRECATED EAPI void elm_ctxpopup_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1, 2);
28046 * @brief Unset the ctxpopup content
28048 * @param obj Ctxpopup object
28049 * @return The content that was being used
28051 * Unparent and return the content object which was set for this widget.
28053 * @deprecated use elm_object_content_unset()
28055 * @see elm_ctxpopup_content_set()
28057 * @deprecated use elm_object_content_unset() instead
28059 * @ingroup Ctxpopup
28061 EINA_DEPRECATED EAPI Evas_Object *elm_ctxpopup_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
28064 * @brief Set the direction priority of a ctxpopup.
28066 * @param obj Ctxpopup object
28067 * @param first 1st priority of direction
28068 * @param second 2nd priority of direction
28069 * @param third 3th priority of direction
28070 * @param fourth 4th priority of direction
28072 * This functions gives a chance to user to set the priority of ctxpopup
28073 * showing direction. This doesn't guarantee the ctxpopup will appear in the
28074 * requested direction.
28076 * @see Elm_Ctxpopup_Direction
28078 * @ingroup Ctxpopup
28080 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);
28083 * @brief Get the direction priority of a ctxpopup.
28085 * @param obj Ctxpopup object
28086 * @param first 1st priority of direction to be returned
28087 * @param second 2nd priority of direction to be returned
28088 * @param third 3th priority of direction to be returned
28089 * @param fourth 4th priority of direction to be returned
28091 * @see elm_ctxpopup_direction_priority_set() for more information.
28093 * @ingroup Ctxpopup
28095 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);
28098 * @brief Get the current direction of a ctxpopup.
28100 * @param obj Ctxpopup object
28101 * @return current direction of a ctxpopup
28103 * @warning Once the ctxpopup showed up, the direction would be determined
28105 * @ingroup Ctxpopup
28107 EAPI Elm_Ctxpopup_Direction elm_ctxpopup_direction_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
28116 * @defgroup Transit Transit
28117 * @ingroup Elementary
28119 * Transit is designed to apply various animated transition effects to @c
28120 * Evas_Object, such like translation, rotation, etc. For using these
28121 * effects, create an @ref Elm_Transit and add the desired transition effects.
28123 * Once the effects are added into transit, they will be automatically
28124 * managed (their callback will be called until the duration is ended, and
28125 * they will be deleted on completion).
28129 * Elm_Transit *trans = elm_transit_add();
28130 * elm_transit_object_add(trans, obj);
28131 * elm_transit_effect_translation_add(trans, 0, 0, 280, 280
28132 * elm_transit_duration_set(transit, 1);
28133 * elm_transit_auto_reverse_set(transit, EINA_TRUE);
28134 * elm_transit_tween_mode_set(transit, ELM_TRANSIT_TWEEN_MODE_DECELERATE);
28135 * elm_transit_repeat_times_set(transit, 3);
28138 * Some transition effects are used to change the properties of objects. They
28140 * @li @ref elm_transit_effect_translation_add
28141 * @li @ref elm_transit_effect_color_add
28142 * @li @ref elm_transit_effect_rotation_add
28143 * @li @ref elm_transit_effect_wipe_add
28144 * @li @ref elm_transit_effect_zoom_add
28145 * @li @ref elm_transit_effect_resizing_add
28147 * Other transition effects are used to make one object disappear and another
28148 * object appear on its old place. These effects are:
28150 * @li @ref elm_transit_effect_flip_add
28151 * @li @ref elm_transit_effect_resizable_flip_add
28152 * @li @ref elm_transit_effect_fade_add
28153 * @li @ref elm_transit_effect_blend_add
28155 * It's also possible to make a transition chain with @ref
28156 * elm_transit_chain_transit_add.
28158 * @warning We strongly recommend to use elm_transit just when edje can not do
28159 * the trick. Edje has more advantage than Elm_Transit, it has more flexibility and
28160 * animations can be manipulated inside the theme.
28162 * List of examples:
28163 * @li @ref transit_example_01_explained
28164 * @li @ref transit_example_02_explained
28165 * @li @ref transit_example_03_c
28166 * @li @ref transit_example_04_c
28172 * @enum Elm_Transit_Tween_Mode
28174 * The type of acceleration used in the transition.
28178 ELM_TRANSIT_TWEEN_MODE_LINEAR, /**< Constant speed */
28179 ELM_TRANSIT_TWEEN_MODE_SINUSOIDAL, /**< Starts slow, increase speed
28180 over time, then decrease again
28182 ELM_TRANSIT_TWEEN_MODE_DECELERATE, /**< Starts fast and decrease
28184 ELM_TRANSIT_TWEEN_MODE_ACCELERATE /**< Starts slow and increase speed
28186 } Elm_Transit_Tween_Mode;
28189 * @enum Elm_Transit_Effect_Flip_Axis
28191 * The axis where flip effect should be applied.
28195 ELM_TRANSIT_EFFECT_FLIP_AXIS_X, /**< Flip on X axis */
28196 ELM_TRANSIT_EFFECT_FLIP_AXIS_Y /**< Flip on Y axis */
28197 } Elm_Transit_Effect_Flip_Axis;
28200 * @enum Elm_Transit_Effect_Wipe_Dir
28202 * The direction where the wipe effect should occur.
28206 ELM_TRANSIT_EFFECT_WIPE_DIR_LEFT, /**< Wipe to the left */
28207 ELM_TRANSIT_EFFECT_WIPE_DIR_RIGHT, /**< Wipe to the right */
28208 ELM_TRANSIT_EFFECT_WIPE_DIR_UP, /**< Wipe up */
28209 ELM_TRANSIT_EFFECT_WIPE_DIR_DOWN /**< Wipe down */
28210 } Elm_Transit_Effect_Wipe_Dir;
28212 /** @enum Elm_Transit_Effect_Wipe_Type
28214 * Whether the wipe effect should show or hide the object.
28218 ELM_TRANSIT_EFFECT_WIPE_TYPE_HIDE, /**< Hide the object during the
28220 ELM_TRANSIT_EFFECT_WIPE_TYPE_SHOW /**< Show the object during the
28222 } Elm_Transit_Effect_Wipe_Type;
28225 * @typedef Elm_Transit
28227 * The Transit created with elm_transit_add(). This type has the information
28228 * about the objects which the transition will be applied, and the
28229 * transition effects that will be used. It also contains info about
28230 * duration, number of repetitions, auto-reverse, etc.
28232 typedef struct _Elm_Transit Elm_Transit;
28233 typedef void Elm_Transit_Effect;
28236 * @typedef Elm_Transit_Effect_Transition_Cb
28238 * Transition callback called for this effect on each transition iteration.
28240 typedef void (*Elm_Transit_Effect_Transition_Cb) (Elm_Transit_Effect *effect, Elm_Transit *transit, double progress);
28243 * Elm_Transit_Effect_End_Cb
28245 * Transition callback called for this effect when the transition is over.
28247 typedef void (*Elm_Transit_Effect_End_Cb) (Elm_Transit_Effect *effect, Elm_Transit *transit);
28250 * Elm_Transit_Del_Cb
28252 * A callback called when the transit is deleted.
28254 typedef void (*Elm_Transit_Del_Cb) (void *data, Elm_Transit *transit);
28259 * @note Is not necessary to delete the transit object, it will be deleted at
28260 * the end of its operation.
28261 * @note The transit will start playing when the program enter in the main loop, is not
28262 * necessary to give a start to the transit.
28264 * @return The transit object.
28268 EAPI Elm_Transit *elm_transit_add(void);
28271 * Stops the animation and delete the @p transit object.
28273 * Call this function if you wants to stop the animation before the duration
28274 * time. Make sure the @p transit object is still alive with
28275 * elm_transit_del_cb_set() function.
28276 * All added effects will be deleted, calling its repective data_free_cb
28277 * functions. The function setted by elm_transit_del_cb_set() will be called.
28279 * @see elm_transit_del_cb_set()
28281 * @param transit The transit object to be deleted.
28284 * @warning Just call this function if you are sure the transit is alive.
28286 EAPI void elm_transit_del(Elm_Transit *transit) EINA_ARG_NONNULL(1);
28289 * Add a new effect to the transit.
28291 * @note The cb function and the data are the key to the effect. If you try to
28292 * add an already added effect, nothing is done.
28293 * @note After the first addition of an effect in @p transit, if its
28294 * effect list become empty again, the @p transit will be killed by
28295 * elm_transit_del(transit) function.
28299 * Elm_Transit *transit = elm_transit_add();
28300 * elm_transit_effect_add(transit,
28301 * elm_transit_effect_blend_op,
28302 * elm_transit_effect_blend_context_new(),
28303 * elm_transit_effect_blend_context_free);
28306 * @param transit The transit object.
28307 * @param transition_cb The operation function. It is called when the
28308 * animation begins, it is the function that actually performs the animation.
28309 * It is called with the @p data, @p transit and the time progression of the
28310 * animation (a double value between 0.0 and 1.0).
28311 * @param effect The context data of the effect.
28312 * @param end_cb The function to free the context data, it will be called
28313 * at the end of the effect, it must finalize the animation and free the
28317 * @warning The transit free the context data at the and of the transition with
28318 * the data_free_cb function, do not use the context data in another transit.
28320 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);
28323 * Delete an added effect.
28325 * This function will remove the effect from the @p transit, calling the
28326 * data_free_cb to free the @p data.
28328 * @see elm_transit_effect_add()
28330 * @note If the effect is not found, nothing is done.
28331 * @note If the effect list become empty, this function will call
28332 * elm_transit_del(transit), that is, it will kill the @p transit.
28334 * @param transit The transit object.
28335 * @param transition_cb The operation function.
28336 * @param effect The context data of the effect.
28340 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);
28343 * Add new object to apply the effects.
28345 * @note After the first addition of an object in @p transit, if its
28346 * object list become empty again, the @p transit will be killed by
28347 * elm_transit_del(transit) function.
28348 * @note If the @p obj belongs to another transit, the @p obj will be
28349 * removed from it and it will only belong to the @p transit. If the old
28350 * transit stays without objects, it will die.
28351 * @note When you add an object into the @p transit, its state from
28352 * evas_object_pass_events_get(obj) is saved, and it is applied when the
28353 * transit ends, if you change this state whith evas_object_pass_events_set()
28354 * after add the object, this state will change again when @p transit stops to
28357 * @param transit The transit object.
28358 * @param obj Object to be animated.
28361 * @warning It is not allowed to add a new object after transit begins to go.
28363 EAPI void elm_transit_object_add(Elm_Transit *transit, Evas_Object *obj) EINA_ARG_NONNULL(1, 2);
28366 * Removes an added object from the transit.
28368 * @note If the @p obj is not in the @p transit, nothing is done.
28369 * @note If the list become empty, this function will call
28370 * elm_transit_del(transit), that is, it will kill the @p transit.
28372 * @param transit The transit object.
28373 * @param obj Object to be removed from @p transit.
28376 * @warning It is not allowed to remove objects after transit begins to go.
28378 EAPI void elm_transit_object_remove(Elm_Transit *transit, Evas_Object *obj) EINA_ARG_NONNULL(1, 2);
28381 * Get the objects of the transit.
28383 * @param transit The transit object.
28384 * @return a Eina_List with the objects from the transit.
28388 EAPI const Eina_List *elm_transit_objects_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
28391 * Enable/disable keeping up the objects states.
28392 * If it is not kept, the objects states will be reset when transition ends.
28394 * @note @p transit can not be NULL.
28395 * @note One state includes geometry, color, map data.
28397 * @param transit The transit object.
28398 * @param state_keep Keeping or Non Keeping.
28402 EAPI void elm_transit_objects_final_state_keep_set(Elm_Transit *transit, Eina_Bool state_keep) EINA_ARG_NONNULL(1);
28405 * Get a value whether the objects states will be reset or not.
28407 * @note @p transit can not be NULL
28409 * @see elm_transit_objects_final_state_keep_set()
28411 * @param transit The transit object.
28412 * @return EINA_TRUE means the states of the objects will be reset.
28413 * If @p transit is NULL, EINA_FALSE is returned
28417 EAPI Eina_Bool elm_transit_objects_final_state_keep_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
28420 * Set the event enabled when transit is operating.
28422 * If @p enabled is EINA_TRUE, the objects of the transit will receives
28423 * events from mouse and keyboard during the animation.
28424 * @note When you add an object with elm_transit_object_add(), its state from
28425 * evas_object_pass_events_get(obj) is saved, and it is applied when the
28426 * transit ends, if you change this state with evas_object_pass_events_set()
28427 * after adding the object, this state will change again when @p transit stops
28430 * @param transit The transit object.
28431 * @param enabled Events are received when enabled is @c EINA_TRUE, and
28432 * ignored otherwise.
28436 EAPI void elm_transit_event_enabled_set(Elm_Transit *transit, Eina_Bool enabled) EINA_ARG_NONNULL(1);
28439 * Get the value of event enabled status.
28441 * @see elm_transit_event_enabled_set()
28443 * @param transit The Transit object
28444 * @return EINA_TRUE, when event is enabled. If @p transit is NULL
28445 * EINA_FALSE is returned
28449 EAPI Eina_Bool elm_transit_event_enabled_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
28452 * Set the user-callback function when the transit is deleted.
28454 * @note Using this function twice will overwrite the first function setted.
28455 * @note the @p transit object will be deleted after call @p cb function.
28457 * @param transit The transit object.
28458 * @param cb Callback function pointer. This function will be called before
28459 * the deletion of the transit.
28460 * @param data Callback funtion user data. It is the @p op parameter.
28464 EAPI void elm_transit_del_cb_set(Elm_Transit *transit, Elm_Transit_Del_Cb cb, void *data) EINA_ARG_NONNULL(1);
28467 * Set reverse effect automatically.
28469 * If auto reverse is setted, after running the effects with the progress
28470 * parameter from 0 to 1, it will call the effecs again with the progress
28471 * from 1 to 0. The transit will last for a time iqual to (2 * duration * repeat),
28472 * where the duration was setted with the function elm_transit_add and
28473 * the repeat with the function elm_transit_repeat_times_set().
28475 * @param transit The transit object.
28476 * @param reverse EINA_TRUE means the auto_reverse is on.
28480 EAPI void elm_transit_auto_reverse_set(Elm_Transit *transit, Eina_Bool reverse) EINA_ARG_NONNULL(1);
28483 * Get if the auto reverse is on.
28485 * @see elm_transit_auto_reverse_set()
28487 * @param transit The transit object.
28488 * @return EINA_TRUE means auto reverse is on. If @p transit is NULL
28489 * EINA_FALSE is returned
28493 EAPI Eina_Bool elm_transit_auto_reverse_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
28496 * Set the transit repeat count. Effect will be repeated by repeat count.
28498 * This function sets the number of repetition the transit will run after
28499 * the first one, that is, if @p repeat is 1, the transit will run 2 times.
28500 * If the @p repeat is a negative number, it will repeat infinite times.
28502 * @note If this function is called during the transit execution, the transit
28503 * will run @p repeat times, ignoring the times it already performed.
28505 * @param transit The transit object
28506 * @param repeat Repeat count
28510 EAPI void elm_transit_repeat_times_set(Elm_Transit *transit, int repeat) EINA_ARG_NONNULL(1);
28513 * Get the transit repeat count.
28515 * @see elm_transit_repeat_times_set()
28517 * @param transit The Transit object.
28518 * @return The repeat count. If @p transit is NULL
28523 EAPI int elm_transit_repeat_times_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
28526 * Set the transit animation acceleration type.
28528 * This function sets the tween mode of the transit that can be:
28529 * ELM_TRANSIT_TWEEN_MODE_LINEAR - The default mode.
28530 * ELM_TRANSIT_TWEEN_MODE_SINUSOIDAL - Starts in accelerate mode and ends decelerating.
28531 * ELM_TRANSIT_TWEEN_MODE_DECELERATE - The animation will be slowed over time.
28532 * ELM_TRANSIT_TWEEN_MODE_ACCELERATE - The animation will accelerate over time.
28534 * @param transit The transit object.
28535 * @param tween_mode The tween type.
28539 EAPI void elm_transit_tween_mode_set(Elm_Transit *transit, Elm_Transit_Tween_Mode tween_mode) EINA_ARG_NONNULL(1);
28542 * Get the transit animation acceleration type.
28544 * @note @p transit can not be NULL
28546 * @param transit The transit object.
28547 * @return The tween type. If @p transit is NULL
28548 * ELM_TRANSIT_TWEEN_MODE_LINEAR is returned.
28552 EAPI Elm_Transit_Tween_Mode elm_transit_tween_mode_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
28555 * Set the transit animation time
28557 * @note @p transit can not be NULL
28559 * @param transit The transit object.
28560 * @param duration The animation time.
28564 EAPI void elm_transit_duration_set(Elm_Transit *transit, double duration) EINA_ARG_NONNULL(1);
28567 * Get the transit animation time
28569 * @note @p transit can not be NULL
28571 * @param transit The transit object.
28573 * @return The transit animation time.
28577 EAPI double elm_transit_duration_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
28580 * Starts the transition.
28581 * Once this API is called, the transit begins to measure the time.
28583 * @note @p transit can not be NULL
28585 * @param transit The transit object.
28589 EAPI void elm_transit_go(Elm_Transit *transit) EINA_ARG_NONNULL(1);
28592 * Pause/Resume the transition.
28594 * If you call elm_transit_go again, the transit will be started from the
28595 * beginning, and will be unpaused.
28597 * @note @p transit can not be NULL
28599 * @param transit The transit object.
28600 * @param paused Whether the transition should be paused or not.
28604 EAPI void elm_transit_paused_set(Elm_Transit *transit, Eina_Bool paused) EINA_ARG_NONNULL(1);
28607 * Get the value of paused status.
28609 * @see elm_transit_paused_set()
28611 * @note @p transit can not be NULL
28613 * @param transit The transit object.
28614 * @return EINA_TRUE means transition is paused. If @p transit is NULL
28615 * EINA_FALSE is returned
28619 EAPI Eina_Bool elm_transit_paused_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
28622 * Get the time progression of the animation (a double value between 0.0 and 1.0).
28624 * The value returned is a fraction (current time / total time). It
28625 * represents the progression position relative to the total.
28627 * @note @p transit can not be NULL
28629 * @param transit The transit object.
28631 * @return The time progression value. If @p transit is NULL
28636 EAPI double elm_transit_progress_value_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
28639 * Makes the chain relationship between two transits.
28641 * @note @p transit can not be NULL. Transit would have multiple chain transits.
28642 * @note @p chain_transit can not be NULL. Chain transits could be chained to the only one transit.
28644 * @param transit The transit object.
28645 * @param chain_transit The chain transit object. This transit will be operated
28646 * after transit is done.
28648 * This function adds @p chain_transit transition to a chain after the @p
28649 * transit, and will be started as soon as @p transit ends. See @ref
28650 * transit_example_02_explained for a full example.
28654 EAPI void elm_transit_chain_transit_add(Elm_Transit *transit, Elm_Transit *chain_transit) EINA_ARG_NONNULL(1, 2);
28657 * Cut off the chain relationship between two transits.
28659 * @note @p transit can not be NULL. Transit would have the chain relationship with @p chain transit.
28660 * @note @p chain_transit can not be NULL. Chain transits should be chained to the @p transit.
28662 * @param transit The transit object.
28663 * @param chain_transit The chain transit object.
28665 * This function remove the @p chain_transit transition from the @p transit.
28669 EAPI void elm_transit_chain_transit_del(Elm_Transit *transit, Elm_Transit *chain_transit) EINA_ARG_NONNULL(1,2);
28672 * Get the current chain transit list.
28674 * @note @p transit can not be NULL.
28676 * @param transit The transit object.
28677 * @return chain transit list.
28681 EAPI Eina_List *elm_transit_chain_transits_get(const Elm_Transit *transit);
28684 * Add the Resizing Effect to Elm_Transit.
28686 * @note This API is one of the facades. It creates resizing effect context
28687 * and add it's required APIs to elm_transit_effect_add.
28689 * @see elm_transit_effect_add()
28691 * @param transit Transit object.
28692 * @param from_w Object width size when effect begins.
28693 * @param from_h Object height size when effect begins.
28694 * @param to_w Object width size when effect ends.
28695 * @param to_h Object height size when effect ends.
28696 * @return Resizing effect context data.
28700 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);
28703 * Add the Translation Effect to Elm_Transit.
28705 * @note This API is one of the facades. It creates translation effect context
28706 * and add it's required APIs to elm_transit_effect_add.
28708 * @see elm_transit_effect_add()
28710 * @param transit Transit object.
28711 * @param from_dx X Position variation when effect begins.
28712 * @param from_dy Y Position variation when effect begins.
28713 * @param to_dx X Position variation when effect ends.
28714 * @param to_dy Y Position variation when effect ends.
28715 * @return Translation effect context data.
28718 * @warning It is highly recommended just create a transit with this effect when
28719 * the window that the objects of the transit belongs has already been created.
28720 * This is because this effect needs the geometry information about the objects,
28721 * and if the window was not created yet, it can get a wrong information.
28723 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);
28726 * Add the Zoom Effect to Elm_Transit.
28728 * @note This API is one of the facades. It creates zoom effect context
28729 * and add it's required APIs to elm_transit_effect_add.
28731 * @see elm_transit_effect_add()
28733 * @param transit Transit object.
28734 * @param from_rate Scale rate when effect begins (1 is current rate).
28735 * @param to_rate Scale rate when effect ends.
28736 * @return Zoom effect context data.
28739 * @warning It is highly recommended just create a transit with this effect when
28740 * the window that the objects of the transit belongs has already been created.
28741 * This is because this effect needs the geometry information about the objects,
28742 * and if the window was not created yet, it can get a wrong information.
28744 EAPI Elm_Transit_Effect *elm_transit_effect_zoom_add(Elm_Transit *transit, float from_rate, float to_rate);
28747 * Add the Flip Effect to Elm_Transit.
28749 * @note This API is one of the facades. It creates flip effect context
28750 * and add it's required APIs to elm_transit_effect_add.
28751 * @note This effect is applied to each pair of objects in the order they are listed
28752 * in the transit list of objects. The first object in the pair will be the
28753 * "front" object and the second will be the "back" object.
28755 * @see elm_transit_effect_add()
28757 * @param transit Transit object.
28758 * @param axis Flipping Axis(X or Y).
28759 * @param cw Flipping Direction. EINA_TRUE is clock-wise.
28760 * @return Flip effect context data.
28763 * @warning It is highly recommended just create a transit with this effect when
28764 * the window that the objects of the transit belongs has already been created.
28765 * This is because this effect needs the geometry information about the objects,
28766 * and if the window was not created yet, it can get a wrong information.
28768 EAPI Elm_Transit_Effect *elm_transit_effect_flip_add(Elm_Transit *transit, Elm_Transit_Effect_Flip_Axis axis, Eina_Bool cw);
28771 * Add the Resizable Flip Effect to Elm_Transit.
28773 * @note This API is one of the facades. It creates resizable flip effect context
28774 * and add it's required APIs to elm_transit_effect_add.
28775 * @note This effect is applied to each pair of objects in the order they are listed
28776 * in the transit list of objects. The first object in the pair will be the
28777 * "front" object and the second will be the "back" object.
28779 * @see elm_transit_effect_add()
28781 * @param transit Transit object.
28782 * @param axis Flipping Axis(X or Y).
28783 * @param cw Flipping Direction. EINA_TRUE is clock-wise.
28784 * @return Resizable flip effect context data.
28787 * @warning It is highly recommended just create a transit with this effect when
28788 * the window that the objects of the transit belongs has already been created.
28789 * This is because this effect needs the geometry information about the objects,
28790 * and if the window was not created yet, it can get a wrong information.
28792 EAPI Elm_Transit_Effect *elm_transit_effect_resizable_flip_add(Elm_Transit *transit, Elm_Transit_Effect_Flip_Axis axis, Eina_Bool cw);
28795 * Add the Wipe Effect to Elm_Transit.
28797 * @note This API is one of the facades. It creates wipe effect context
28798 * and add it's required APIs to elm_transit_effect_add.
28800 * @see elm_transit_effect_add()
28802 * @param transit Transit object.
28803 * @param type Wipe type. Hide or show.
28804 * @param dir Wipe Direction.
28805 * @return Wipe effect context data.
28808 * @warning It is highly recommended just create a transit with this effect when
28809 * the window that the objects of the transit belongs has already been created.
28810 * This is because this effect needs the geometry information about the objects,
28811 * and if the window was not created yet, it can get a wrong information.
28813 EAPI Elm_Transit_Effect *elm_transit_effect_wipe_add(Elm_Transit *transit, Elm_Transit_Effect_Wipe_Type type, Elm_Transit_Effect_Wipe_Dir dir);
28816 * Add the Color Effect to Elm_Transit.
28818 * @note This API is one of the facades. It creates color effect context
28819 * and add it's required APIs to elm_transit_effect_add.
28821 * @see elm_transit_effect_add()
28823 * @param transit Transit object.
28824 * @param from_r RGB R when effect begins.
28825 * @param from_g RGB G when effect begins.
28826 * @param from_b RGB B when effect begins.
28827 * @param from_a RGB A when effect begins.
28828 * @param to_r RGB R when effect ends.
28829 * @param to_g RGB G when effect ends.
28830 * @param to_b RGB B when effect ends.
28831 * @param to_a RGB A when effect ends.
28832 * @return Color effect context data.
28836 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);
28839 * Add the Fade Effect to Elm_Transit.
28841 * @note This API is one of the facades. It creates fade effect context
28842 * and add it's required APIs to elm_transit_effect_add.
28843 * @note This effect is applied to each pair of objects in the order they are listed
28844 * in the transit list of objects. The first object in the pair will be the
28845 * "before" object and the second will be the "after" object.
28847 * @see elm_transit_effect_add()
28849 * @param transit Transit object.
28850 * @return Fade effect context data.
28853 * @warning It is highly recommended just create a transit with this effect when
28854 * the window that the objects of the transit belongs has already been created.
28855 * This is because this effect needs the color information about the objects,
28856 * and if the window was not created yet, it can get a wrong information.
28858 EAPI Elm_Transit_Effect *elm_transit_effect_fade_add(Elm_Transit *transit);
28861 * Add the Blend Effect to Elm_Transit.
28863 * @note This API is one of the facades. It creates blend effect context
28864 * and add it's required APIs to elm_transit_effect_add.
28865 * @note This effect is applied to each pair of objects in the order they are listed
28866 * in the transit list of objects. The first object in the pair will be the
28867 * "before" object and the second will be the "after" object.
28869 * @see elm_transit_effect_add()
28871 * @param transit Transit object.
28872 * @return Blend effect context data.
28875 * @warning It is highly recommended just create a transit with this effect when
28876 * the window that the objects of the transit belongs has already been created.
28877 * This is because this effect needs the color information about the objects,
28878 * and if the window was not created yet, it can get a wrong information.
28880 EAPI Elm_Transit_Effect *elm_transit_effect_blend_add(Elm_Transit *transit);
28883 * Add the Rotation Effect to Elm_Transit.
28885 * @note This API is one of the facades. It creates rotation effect context
28886 * and add it's required APIs to elm_transit_effect_add.
28888 * @see elm_transit_effect_add()
28890 * @param transit Transit object.
28891 * @param from_degree Degree when effect begins.
28892 * @param to_degree Degree when effect is ends.
28893 * @return Rotation effect context data.
28896 * @warning It is highly recommended just create a transit with this effect when
28897 * the window that the objects of the transit belongs has already been created.
28898 * This is because this effect needs the geometry information about the objects,
28899 * and if the window was not created yet, it can get a wrong information.
28901 EAPI Elm_Transit_Effect *elm_transit_effect_rotation_add(Elm_Transit *transit, float from_degree, float to_degree);
28904 * Add the ImageAnimation Effect to Elm_Transit.
28906 * @note This API is one of the facades. It creates image animation effect context
28907 * and add it's required APIs to elm_transit_effect_add.
28908 * The @p images parameter is a list images paths. This list and
28909 * its contents will be deleted at the end of the effect by
28910 * elm_transit_effect_image_animation_context_free() function.
28914 * char buf[PATH_MAX];
28915 * Eina_List *images = NULL;
28916 * Elm_Transit *transi = elm_transit_add();
28918 * snprintf(buf, sizeof(buf), "%s/images/icon_11.png", PACKAGE_DATA_DIR);
28919 * images = eina_list_append(images, eina_stringshare_add(buf));
28921 * snprintf(buf, sizeof(buf), "%s/images/logo_small.png", PACKAGE_DATA_DIR);
28922 * images = eina_list_append(images, eina_stringshare_add(buf));
28923 * elm_transit_effect_image_animation_add(transi, images);
28927 * @see elm_transit_effect_add()
28929 * @param transit Transit object.
28930 * @param images Eina_List of images file paths. This list and
28931 * its contents will be deleted at the end of the effect by
28932 * elm_transit_effect_image_animation_context_free() function.
28933 * @return Image Animation effect context data.
28937 EAPI Elm_Transit_Effect *elm_transit_effect_image_animation_add(Elm_Transit *transit, Eina_List *images);
28942 typedef struct _Elm_Store Elm_Store;
28943 typedef struct _Elm_Store_Filesystem Elm_Store_Filesystem;
28944 typedef struct _Elm_Store_Item Elm_Store_Item;
28945 typedef struct _Elm_Store_Item_Filesystem Elm_Store_Item_Filesystem;
28946 typedef struct _Elm_Store_Item_Info Elm_Store_Item_Info;
28947 typedef struct _Elm_Store_Item_Info_Filesystem Elm_Store_Item_Info_Filesystem;
28948 typedef struct _Elm_Store_Item_Mapping Elm_Store_Item_Mapping;
28949 typedef struct _Elm_Store_Item_Mapping_Empty Elm_Store_Item_Mapping_Empty;
28950 typedef struct _Elm_Store_Item_Mapping_Icon Elm_Store_Item_Mapping_Icon;
28951 typedef struct _Elm_Store_Item_Mapping_Photo Elm_Store_Item_Mapping_Photo;
28952 typedef struct _Elm_Store_Item_Mapping_Custom Elm_Store_Item_Mapping_Custom;
28954 typedef Eina_Bool (*Elm_Store_Item_List_Cb) (void *data, Elm_Store_Item_Info *info);
28955 typedef void (*Elm_Store_Item_Fetch_Cb) (void *data, Elm_Store_Item *sti);
28956 typedef void (*Elm_Store_Item_Unfetch_Cb) (void *data, Elm_Store_Item *sti);
28957 typedef void *(*Elm_Store_Item_Mapping_Cb) (void *data, Elm_Store_Item *sti, const char *part);
28961 ELM_STORE_ITEM_MAPPING_NONE = 0,
28962 ELM_STORE_ITEM_MAPPING_LABEL, // const char * -> label
28963 ELM_STORE_ITEM_MAPPING_STATE, // Eina_Bool -> state
28964 ELM_STORE_ITEM_MAPPING_ICON, // char * -> icon path
28965 ELM_STORE_ITEM_MAPPING_PHOTO, // char * -> photo path
28966 ELM_STORE_ITEM_MAPPING_CUSTOM, // item->custom(it->data, it, part) -> void * (-> any)
28967 // can add more here as needed by common apps
28968 ELM_STORE_ITEM_MAPPING_LAST
28969 } Elm_Store_Item_Mapping_Type;
28971 struct _Elm_Store_Item_Mapping_Icon
28973 // FIXME: allow edje file icons
28975 Elm_Icon_Lookup_Order lookup_order;
28976 Eina_Bool standard_name : 1;
28977 Eina_Bool no_scale : 1;
28978 Eina_Bool smooth : 1;
28979 Eina_Bool scale_up : 1;
28980 Eina_Bool scale_down : 1;
28983 struct _Elm_Store_Item_Mapping_Empty
28988 struct _Elm_Store_Item_Mapping_Photo
28993 struct _Elm_Store_Item_Mapping_Custom
28995 Elm_Store_Item_Mapping_Cb func;
28998 struct _Elm_Store_Item_Mapping
29000 Elm_Store_Item_Mapping_Type type;
29005 Elm_Store_Item_Mapping_Empty empty;
29006 Elm_Store_Item_Mapping_Icon icon;
29007 Elm_Store_Item_Mapping_Photo photo;
29008 Elm_Store_Item_Mapping_Custom custom;
29009 // add more types here
29013 struct _Elm_Store_Item_Info
29015 Elm_Genlist_Item_Class *item_class;
29016 const Elm_Store_Item_Mapping *mapping;
29021 struct _Elm_Store_Item_Info_Filesystem
29023 Elm_Store_Item_Info base;
29027 #define ELM_STORE_ITEM_MAPPING_END { ELM_STORE_ITEM_MAPPING_NONE, NULL, 0, { .empty = { EINA_TRUE } } }
29028 #define ELM_STORE_ITEM_MAPPING_OFFSET(st, it) offsetof(st, it)
29030 EAPI void elm_store_free(Elm_Store *st);
29032 EAPI Elm_Store *elm_store_filesystem_new(void);
29033 EAPI void elm_store_filesystem_directory_set(Elm_Store *st, const char *dir) EINA_ARG_NONNULL(1);
29034 EAPI const char *elm_store_filesystem_directory_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
29035 EAPI const char *elm_store_item_filesystem_path_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
29037 EAPI void elm_store_target_genlist_set(Elm_Store *st, Evas_Object *obj) EINA_ARG_NONNULL(1);
29039 EAPI void elm_store_cache_set(Elm_Store *st, int max) EINA_ARG_NONNULL(1);
29040 EAPI int elm_store_cache_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
29041 EAPI void elm_store_list_func_set(Elm_Store *st, Elm_Store_Item_List_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
29042 EAPI void elm_store_fetch_func_set(Elm_Store *st, Elm_Store_Item_Fetch_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
29043 EAPI void elm_store_fetch_thread_set(Elm_Store *st, Eina_Bool use_thread) EINA_ARG_NONNULL(1);
29044 EAPI Eina_Bool elm_store_fetch_thread_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
29046 EAPI void elm_store_unfetch_func_set(Elm_Store *st, Elm_Store_Item_Unfetch_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
29047 EAPI void elm_store_sorted_set(Elm_Store *st, Eina_Bool sorted) EINA_ARG_NONNULL(1);
29048 EAPI Eina_Bool elm_store_sorted_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
29049 EAPI void elm_store_item_data_set(Elm_Store_Item *sti, void *data) EINA_ARG_NONNULL(1);
29050 EAPI void *elm_store_item_data_get(Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
29051 EAPI const Elm_Store *elm_store_item_store_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
29052 EAPI const Elm_Genlist_Item *elm_store_item_genlist_item_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
29055 * @defgroup SegmentControl SegmentControl
29056 * @ingroup Elementary
29058 * @image html img/widget/segment_control/preview-00.png
29059 * @image latex img/widget/segment_control/preview-00.eps width=\textwidth
29061 * @image html img/segment_control.png
29062 * @image latex img/segment_control.eps width=\textwidth
29064 * Segment control widget is a horizontal control made of multiple segment
29065 * items, each segment item functioning similar to discrete two state button.
29066 * A segment control groups the items together and provides compact
29067 * single button with multiple equal size segments.
29069 * Segment item size is determined by base widget
29070 * size and the number of items added.
29071 * Only one segment item can be at selected state. A segment item can display
29072 * combination of Text and any Evas_Object like Images or other widget.
29074 * Smart callbacks one can listen to:
29075 * - "changed" - When the user clicks on a segment item which is not
29076 * previously selected and get selected. The event_info parameter is the
29077 * segment item pointer.
29079 * Available styles for it:
29082 * Here is an example on its usage:
29083 * @li @ref segment_control_example
29087 * @addtogroup SegmentControl
29091 typedef struct _Elm_Segment_Item Elm_Segment_Item; /**< Item handle for a segment control widget. */
29094 * Add a new segment control widget to the given parent Elementary
29095 * (container) object.
29097 * @param parent The parent object.
29098 * @return a new segment control widget handle or @c NULL, on errors.
29100 * This function inserts a new segment control widget on the canvas.
29102 * @ingroup SegmentControl
29104 EAPI Evas_Object *elm_segment_control_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
29107 * Append a new item to the segment control object.
29109 * @param obj The segment control object.
29110 * @param icon The icon object to use for the left side of the item. An
29111 * icon can be any Evas object, but usually it is an icon created
29112 * with elm_icon_add().
29113 * @param label The label of the item.
29114 * Note that, NULL is different from empty string "".
29115 * @return The created item or @c NULL upon failure.
29117 * A new item will be created and appended to the segment control, i.e., will
29118 * be set as @b last item.
29120 * If it should be inserted at another position,
29121 * elm_segment_control_item_insert_at() should be used instead.
29123 * Items created with this function can be deleted with function
29124 * elm_segment_control_item_del() or elm_segment_control_item_del_at().
29126 * @note @p label set to @c NULL is different from empty string "".
29128 * only has icon, it will be displayed bigger and centered. If it has
29129 * icon and label, even that an empty string, icon will be smaller and
29130 * positioned at left.
29134 * sc = elm_segment_control_add(win);
29135 * ic = elm_icon_add(win);
29136 * elm_icon_file_set(ic, "path/to/image", NULL);
29137 * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
29138 * elm_segment_control_item_add(sc, ic, "label");
29139 * evas_object_show(sc);
29142 * @see elm_segment_control_item_insert_at()
29143 * @see elm_segment_control_item_del()
29145 * @ingroup SegmentControl
29147 EAPI Elm_Segment_Item *elm_segment_control_item_add(Evas_Object *obj, Evas_Object *icon, const char *label) EINA_ARG_NONNULL(1);
29150 * Insert a new item to the segment control object at specified position.
29152 * @param obj The segment control object.
29153 * @param icon The icon object to use for the left side of the item. An
29154 * icon can be any Evas object, but usually it is an icon created
29155 * with elm_icon_add().
29156 * @param label The label of the item.
29157 * @param index Item position. Value should be between 0 and items count.
29158 * @return The created item or @c NULL upon failure.
29160 * Index values must be between @c 0, when item will be prepended to
29161 * segment control, and items count, that can be get with
29162 * elm_segment_control_item_count_get(), case when item will be appended
29163 * to segment control, just like elm_segment_control_item_add().
29165 * Items created with this function can be deleted with function
29166 * elm_segment_control_item_del() or elm_segment_control_item_del_at().
29168 * @note @p label set to @c NULL is different from empty string "".
29170 * only has icon, it will be displayed bigger and centered. If it has
29171 * icon and label, even that an empty string, icon will be smaller and
29172 * positioned at left.
29174 * @see elm_segment_control_item_add()
29175 * @see elm_segment_control_item_count_get()
29176 * @see elm_segment_control_item_del()
29178 * @ingroup SegmentControl
29180 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);
29183 * Remove a segment control item from its parent, deleting it.
29185 * @param it The item to be removed.
29187 * Items can be added with elm_segment_control_item_add() or
29188 * elm_segment_control_item_insert_at().
29190 * @ingroup SegmentControl
29192 EAPI void elm_segment_control_item_del(Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
29195 * Remove a segment control item at given index from its parent,
29198 * @param obj The segment control object.
29199 * @param index The position of the segment control item to be deleted.
29201 * Items can be added with elm_segment_control_item_add() or
29202 * elm_segment_control_item_insert_at().
29204 * @ingroup SegmentControl
29206 EAPI void elm_segment_control_item_del_at(Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
29209 * Get the Segment items count from segment control.
29211 * @param obj The segment control object.
29212 * @return Segment items count.
29214 * It will just return the number of items added to segment control @p obj.
29216 * @ingroup SegmentControl
29218 EAPI int elm_segment_control_item_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
29221 * Get the item placed at specified index.
29223 * @param obj The segment control object.
29224 * @param index The index of the segment item.
29225 * @return The segment control item or @c NULL on failure.
29227 * Index is the position of an item in segment control widget. Its
29228 * range is from @c 0 to <tt> count - 1 </tt>.
29229 * Count is the number of items, that can be get with
29230 * elm_segment_control_item_count_get().
29232 * @ingroup SegmentControl
29234 EAPI Elm_Segment_Item *elm_segment_control_item_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
29237 * Get the label of item.
29239 * @param obj The segment control object.
29240 * @param index The index of the segment item.
29241 * @return The label of the item at @p index.
29243 * The return value is a pointer to the label associated to the item when
29244 * it was created, with function elm_segment_control_item_add(), or later
29245 * with function elm_segment_control_item_label_set. If no label
29246 * was passed as argument, it will return @c NULL.
29248 * @see elm_segment_control_item_label_set() for more details.
29249 * @see elm_segment_control_item_add()
29251 * @ingroup SegmentControl
29253 EAPI const char *elm_segment_control_item_label_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
29256 * Set the label of item.
29258 * @param it The item of segment control.
29259 * @param text The label of item.
29261 * The label to be displayed by the item.
29262 * Label will be at right of the icon (if set).
29264 * If a label was passed as argument on item creation, with function
29265 * elm_control_segment_item_add(), it will be already
29266 * displayed by the item.
29268 * @see elm_segment_control_item_label_get()
29269 * @see elm_segment_control_item_add()
29271 * @ingroup SegmentControl
29273 EAPI void elm_segment_control_item_label_set(Elm_Segment_Item* it, const char* label) EINA_ARG_NONNULL(1);
29276 * Get the icon associated to the item.
29278 * @param obj The segment control object.
29279 * @param index The index of the segment item.
29280 * @return The left side icon associated to the item at @p index.
29282 * The return value is a pointer to the icon associated to the item when
29283 * it was created, with function elm_segment_control_item_add(), or later
29284 * with function elm_segment_control_item_icon_set(). If no icon
29285 * was passed as argument, it will return @c NULL.
29287 * @see elm_segment_control_item_add()
29288 * @see elm_segment_control_item_icon_set()
29290 * @ingroup SegmentControl
29292 EAPI Evas_Object *elm_segment_control_item_icon_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
29295 * Set the icon associated to the item.
29297 * @param it The segment control item.
29298 * @param icon The icon object to associate with @p it.
29300 * The icon object to use at left side of the item. An
29301 * icon can be any Evas object, but usually it is an icon created
29302 * with elm_icon_add().
29304 * Once the icon object is set, a previously set one will be deleted.
29305 * @warning Setting the same icon for two items will cause the icon to
29306 * dissapear from the first item.
29308 * If an icon was passed as argument on item creation, with function
29309 * elm_segment_control_item_add(), it will be already
29310 * associated to the item.
29312 * @see elm_segment_control_item_add()
29313 * @see elm_segment_control_item_icon_get()
29315 * @ingroup SegmentControl
29317 EAPI void elm_segment_control_item_icon_set(Elm_Segment_Item *it, Evas_Object *icon) EINA_ARG_NONNULL(1);
29320 * Get the index of an item.
29322 * @param it The segment control item.
29323 * @return The position of item in segment control widget.
29325 * Index is the position of an item in segment control widget. Its
29326 * range is from @c 0 to <tt> count - 1 </tt>.
29327 * Count is the number of items, that can be get with
29328 * elm_segment_control_item_count_get().
29330 * @ingroup SegmentControl
29332 EAPI int elm_segment_control_item_index_get(const Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
29335 * Get the base object of the item.
29337 * @param it The segment control item.
29338 * @return The base object associated with @p it.
29340 * Base object is the @c Evas_Object that represents that item.
29342 * @ingroup SegmentControl
29344 EAPI Evas_Object *elm_segment_control_item_object_get(const Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
29347 * Get the selected item.
29349 * @param obj The segment control object.
29350 * @return The selected item or @c NULL if none of segment items is
29353 * The selected item can be unselected with function
29354 * elm_segment_control_item_selected_set().
29356 * The selected item always will be highlighted on segment control.
29358 * @ingroup SegmentControl
29360 EAPI Elm_Segment_Item *elm_segment_control_item_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
29363 * Set the selected state of an item.
29365 * @param it The segment control item
29366 * @param select The selected state
29368 * This sets the selected state of the given item @p it.
29369 * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
29371 * If a new item is selected the previosly selected will be unselected.
29372 * Previoulsy selected item can be get with function
29373 * elm_segment_control_item_selected_get().
29375 * The selected item always will be highlighted on segment control.
29377 * @see elm_segment_control_item_selected_get()
29379 * @ingroup SegmentControl
29381 EAPI void elm_segment_control_item_selected_set(Elm_Segment_Item *it, Eina_Bool select) EINA_ARG_NONNULL(1);
29388 * @defgroup Grid Grid
29390 * The grid is a grid layout widget that lays out a series of children as a
29391 * fixed "grid" of widgets using a given percentage of the grid width and
29392 * height each using the child object.
29394 * The Grid uses a "Virtual resolution" that is stretched to fill the grid
29395 * widgets size itself. The default is 100 x 100, so that means the
29396 * position and sizes of children will effectively be percentages (0 to 100)
29397 * of the width or height of the grid widget
29403 * Add a new grid to the parent
29405 * @param parent The parent object
29406 * @return The new object or NULL if it cannot be created
29410 EAPI Evas_Object *elm_grid_add(Evas_Object *parent);
29413 * Set the virtual size of the grid
29415 * @param obj The grid object
29416 * @param w The virtual width of the grid
29417 * @param h The virtual height of the grid
29421 EAPI void elm_grid_size_set(Evas_Object *obj, int w, int h);
29424 * Get the virtual size of the grid
29426 * @param obj The grid object
29427 * @param w Pointer to integer to store the virtual width of the grid
29428 * @param h Pointer to integer to store the virtual height of the grid
29432 EAPI void elm_grid_size_get(Evas_Object *obj, int *w, int *h);
29435 * Pack child at given position and size
29437 * @param obj The grid object
29438 * @param subobj The child to pack
29439 * @param x The virtual x coord at which to pack it
29440 * @param y The virtual y coord at which to pack it
29441 * @param w The virtual width at which to pack it
29442 * @param h The virtual height at which to pack it
29446 EAPI void elm_grid_pack(Evas_Object *obj, Evas_Object *subobj, int x, int y, int w, int h);
29449 * Unpack a child from a grid object
29451 * @param obj The grid object
29452 * @param subobj The child to unpack
29456 EAPI void elm_grid_unpack(Evas_Object *obj, Evas_Object *subobj);
29459 * Faster way to remove all child objects from a grid object.
29461 * @param obj The grid object
29462 * @param clear If true, it will delete just removed children
29466 EAPI void elm_grid_clear(Evas_Object *obj, Eina_Bool clear);
29469 * Set packing of an existing child at to position and size
29471 * @param subobj The child to set packing of
29472 * @param x The virtual x coord at which to pack it
29473 * @param y The virtual y coord at which to pack it
29474 * @param w The virtual width at which to pack it
29475 * @param h The virtual height at which to pack it
29479 EAPI void elm_grid_pack_set(Evas_Object *subobj, int x, int y, int w, int h);
29482 * get packing of a child
29484 * @param subobj The child to query
29485 * @param x Pointer to integer to store the virtual x coord
29486 * @param y Pointer to integer to store the virtual y coord
29487 * @param w Pointer to integer to store the virtual width
29488 * @param h Pointer to integer to store the virtual height
29492 EAPI void elm_grid_pack_get(Evas_Object *subobj, int *x, int *y, int *w, int *h);
29498 EAPI Evas_Object *elm_factory_add(Evas_Object *parent);
29499 EINA_DEPRECATED EAPI void elm_factory_content_set(Evas_Object *obj, Evas_Object *content);
29500 EINA_DEPRECATED EAPI Evas_Object *elm_factory_content_get(const Evas_Object *obj);
29501 EAPI void elm_factory_maxmin_mode_set(Evas_Object *obj, Eina_Bool enabled);
29502 EAPI Eina_Bool elm_factory_maxmin_mode_get(const Evas_Object *obj);
29503 EAPI void elm_factory_maxmin_reset_set(Evas_Object *obj);
29506 * @defgroup Video Video
29508 * @addtogroup Video
29511 * Elementary comes with two object that help design application that need
29512 * to display video. The main one, Elm_Video, display a video by using Emotion.
29513 * It does embedded the video inside an Edje object, so you can do some
29514 * animation depending on the video state change. It does also implement a
29515 * ressource management policy to remove this burden from the application writer.
29517 * The second one, Elm_Player is a video player that need to be linked with and Elm_Video.
29518 * It take care of updating its content according to Emotion event and provide a
29519 * way to theme itself. It also does automatically raise the priority of the
29520 * linked Elm_Video so it will use the video decoder if available. It also does
29521 * activate the remember function on the linked Elm_Video object.
29523 * Signals that you can add callback for are :
29525 * "forward,clicked" - the user clicked the forward button.
29526 * "info,clicked" - the user clicked the info button.
29527 * "next,clicked" - the user clicked the next button.
29528 * "pause,clicked" - the user clicked the pause button.
29529 * "play,clicked" - the user clicked the play button.
29530 * "prev,clicked" - the user clicked the prev button.
29531 * "rewind,clicked" - the user clicked the rewind button.
29532 * "stop,clicked" - the user clicked the stop button.
29534 * Default contents parts of the player widget that you can use for are:
29535 * @li "video" - A video of the player
29540 * @brief Add a new Elm_Player object to the given parent Elementary (container) object.
29542 * @param parent The parent object
29543 * @return a new player widget handle or @c NULL, on errors.
29545 * This function inserts a new player widget on the canvas.
29547 * @see elm_object_part_content_set()
29551 EAPI Evas_Object *elm_player_add(Evas_Object *parent);
29554 * @brief Link a Elm_Payer with an Elm_Video object.
29556 * @param player the Elm_Player object.
29557 * @param video The Elm_Video object.
29559 * This mean that action on the player widget will affect the
29560 * video object and the state of the video will be reflected in
29561 * the player itself.
29563 * @see elm_player_add()
29564 * @see elm_video_add()
29565 * @deprecated use elm_object_part_content_set() instead
29569 EINA_DEPRECATED EAPI void elm_player_video_set(Evas_Object *player, Evas_Object *video);
29572 * @brief Add a new Elm_Video object to the given parent Elementary (container) object.
29574 * @param parent The parent object
29575 * @return a new video widget handle or @c NULL, on errors.
29577 * This function inserts a new video widget on the canvas.
29579 * @seeelm_video_file_set()
29580 * @see elm_video_uri_set()
29584 EAPI Evas_Object *elm_video_add(Evas_Object *parent);
29587 * @brief Define the file that will be the video source.
29589 * @param video The video object to define the file for.
29590 * @param filename The file to target.
29592 * This function will explicitly define a filename as a source
29593 * for the video of the Elm_Video object.
29595 * @see elm_video_uri_set()
29596 * @see elm_video_add()
29597 * @see elm_player_add()
29601 EAPI void elm_video_file_set(Evas_Object *video, const char *filename);
29604 * @brief Define the uri that will be the video source.
29606 * @param video The video object to define the file for.
29607 * @param uri The uri to target.
29609 * This function will define an uri as a source for the video of the
29610 * Elm_Video object. URI could be remote source of video, like http:// or local source
29611 * like for example WebCam who are most of the time v4l2:// (but that depend and
29612 * you should use Emotion API to request and list the available Webcam on your system).
29614 * @see elm_video_file_set()
29615 * @see elm_video_add()
29616 * @see elm_player_add()
29620 EAPI void elm_video_uri_set(Evas_Object *video, const char *uri);
29623 * @brief Get the underlying Emotion object.
29625 * @param video The video object to proceed the request on.
29626 * @return the underlying Emotion object.
29630 EAPI Evas_Object *elm_video_emotion_get(const Evas_Object *video);
29633 * @brief Start to play the video
29635 * @param video The video object to proceed the request on.
29637 * Start to play the video and cancel all suspend state.
29641 EAPI void elm_video_play(Evas_Object *video);
29644 * @brief Pause the video
29646 * @param video The video object to proceed the request on.
29648 * Pause the video and start a timer to trigger suspend mode.
29652 EAPI void elm_video_pause(Evas_Object *video);
29655 * @brief Stop the video
29657 * @param video The video object to proceed the request on.
29659 * Stop the video and put the emotion in deep sleep mode.
29663 EAPI void elm_video_stop(Evas_Object *video);
29666 * @brief Is the video actually playing.
29668 * @param video The video object to proceed the request on.
29669 * @return EINA_TRUE if the video is actually playing.
29671 * You should consider watching event on the object instead of polling
29672 * the object state.
29676 EAPI Eina_Bool elm_video_is_playing(const Evas_Object *video);
29679 * @brief Is it possible to seek inside the video.
29681 * @param video The video object to proceed the request on.
29682 * @return EINA_TRUE if is possible to seek inside the video.
29686 EAPI Eina_Bool elm_video_is_seekable(const Evas_Object *video);
29689 * @brief Is the audio muted.
29691 * @param video The video object to proceed the request on.
29692 * @return EINA_TRUE if the audio is muted.
29696 EAPI Eina_Bool elm_video_audio_mute_get(const Evas_Object *video);
29699 * @brief Change the mute state of the Elm_Video object.
29701 * @param video The video object to proceed the request on.
29702 * @param mute The new mute state.
29706 EAPI void elm_video_audio_mute_set(Evas_Object *video, Eina_Bool mute);
29709 * @brief Get the audio level of the current video.
29711 * @param video The video object to proceed the request on.
29712 * @return the current audio level.
29716 EAPI double elm_video_audio_level_get(const Evas_Object *video);
29719 * @brief Set the audio level of anElm_Video object.
29721 * @param video The video object to proceed the request on.
29722 * @param volume The new audio volume.
29726 EAPI void elm_video_audio_level_set(Evas_Object *video, double volume);
29728 EAPI double elm_video_play_position_get(const Evas_Object *video);
29729 EAPI void elm_video_play_position_set(Evas_Object *video, double position);
29730 EAPI double elm_video_play_length_get(const Evas_Object *video);
29731 EAPI void elm_video_remember_position_set(Evas_Object *video, Eina_Bool remember);
29732 EAPI Eina_Bool elm_video_remember_position_get(const Evas_Object *video);
29733 EAPI const char *elm_video_title_get(const Evas_Object *video);
29739 * @defgroup Naviframe Naviframe
29740 * @ingroup Elementary
29742 * @brief Naviframe is a kind of view manager for the applications.
29744 * Naviframe provides functions to switch different pages with stack
29745 * mechanism. It means if one page(item) needs to be changed to the new one,
29746 * then naviframe would push the new page to it's internal stack. Of course,
29747 * it can be back to the previous page by popping the top page. Naviframe
29748 * provides some transition effect while the pages are switching (same as
29751 * Since each item could keep the different styles, users could keep the
29752 * same look & feel for the pages or different styles for the items in it's
29755 * Signals that you can add callback for are:
29756 * @li "transition,finished" - When the transition is finished in changing
29758 * @li "title,clicked" - User clicked title area
29760 * Default contents parts of the naviframe items that you can use for are:
29761 * @li "default" - A main content of the page
29762 * @li "icon" - An icon in the title area
29763 * @li "prev_btn" - A button to go to the previous page
29764 * @li "next_btn" - A button to go to the next page
29766 * Default text parts of the naviframe items that you can use for are:
29767 * @li "default" - Title label in the title area
29768 * @li "subtitle" - Sub-title label in the title area
29770 * Supported elm_object common APIs.
29771 * @li elm_object_signal_emit
29773 * Supported elm_object_item common APIs.
29774 * @li elm_object_item_text_set
29775 * @li elm_object_item_part_text_set
29776 * @li elm_object_item_text_get
29777 * @li elm_object_item_part_text_get
29778 * @li elm_object_item_content_set
29779 * @li elm_object_item_part_content_set
29780 * @li elm_object_item_content_get
29781 * @li elm_object_item_part_content_get
29782 * @li elm_object_item_content_unset
29783 * @li elm_object_item_part_content_unset
29784 * @li elm_object_item_signal_emit
29786 * @ref tutorial_naviframe gives a good overview of the usage of the API.
29790 * @addtogroup Naviframe
29795 * @brief Add a new Naviframe object to the parent.
29797 * @param parent Parent object
29798 * @return New object or @c NULL, if it cannot be created
29800 * @ingroup Naviframe
29802 EAPI Evas_Object *elm_naviframe_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
29805 * @brief Push a new item to the top of the naviframe stack (and show it).
29807 * @param obj The naviframe object
29808 * @param title_label The label in the title area. The name of the title
29809 * label part is "elm.text.title"
29810 * @param prev_btn The button to go to the previous item. If it is NULL,
29811 * then naviframe will create a back button automatically. The name of
29812 * the prev_btn part is "elm.swallow.prev_btn"
29813 * @param next_btn The button to go to the next item. Or It could be just an
29814 * extra function button. The name of the next_btn part is
29815 * "elm.swallow.next_btn"
29816 * @param content The main content object. The name of content part is
29817 * "elm.swallow.content"
29818 * @param item_style The current item style name. @c NULL would be default.
29819 * @return The created item or @c NULL upon failure.
29821 * The item pushed becomes one page of the naviframe, this item will be
29822 * deleted when it is popped.
29824 * @see also elm_naviframe_item_style_set()
29825 * @see also elm_naviframe_item_insert_before()
29826 * @see also elm_naviframe_item_insert_after()
29828 * The following styles are available for this item:
29831 * @ingroup Naviframe
29833 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);
29836 * @brief Insert a new item into the naviframe before item @p before.
29838 * @param before The naviframe item to insert before.
29839 * @param title_label The label in the title area. The name of the title
29840 * label part is "elm.text.title"
29841 * @param prev_btn The button to go to the previous item. If it is NULL,
29842 * then naviframe will create a back button automatically. The name of
29843 * the prev_btn part is "elm.swallow.prev_btn"
29844 * @param next_btn The button to go to the next item. Or It could be just an
29845 * extra function button. The name of the next_btn part is
29846 * "elm.swallow.next_btn"
29847 * @param content The main content object. The name of content part is
29848 * "elm.swallow.content"
29849 * @param item_style The current item style name. @c NULL would be default.
29850 * @return The created item or @c NULL upon failure.
29852 * The item is inserted into the naviframe straight away without any
29853 * transition operations. This item will be deleted when it is popped.
29855 * @see also elm_naviframe_item_style_set()
29856 * @see also elm_naviframe_item_push()
29857 * @see also elm_naviframe_item_insert_after()
29859 * The following styles are available for this item:
29862 * @ingroup Naviframe
29864 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);
29867 * @brief Insert a new item into the naviframe after item @p after.
29869 * @param after The naviframe item to insert after.
29870 * @param title_label The label in the title area. The name of the title
29871 * label part is "elm.text.title"
29872 * @param prev_btn The button to go to the previous item. If it is NULL,
29873 * then naviframe will create a back button automatically. The name of
29874 * the prev_btn part is "elm.swallow.prev_btn"
29875 * @param next_btn The button to go to the next item. Or It could be just an
29876 * extra function button. The name of the next_btn part is
29877 * "elm.swallow.next_btn"
29878 * @param content The main content object. The name of content part is
29879 * "elm.swallow.content"
29880 * @param item_style The current item style name. @c NULL would be default.
29881 * @return The created item or @c NULL upon failure.
29883 * The item is inserted into the naviframe straight away without any
29884 * transition operations. This item will be deleted when it is popped.
29886 * @see also elm_naviframe_item_style_set()
29887 * @see also elm_naviframe_item_push()
29888 * @see also elm_naviframe_item_insert_before()
29890 * The following styles are available for this item:
29893 * @ingroup Naviframe
29895 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);
29898 * @brief Pop an item that is on top of the stack
29900 * @param obj The naviframe object
29901 * @return @c NULL or the content object(if the
29902 * elm_naviframe_content_preserve_on_pop_get is true).
29904 * This pops an item that is on the top(visible) of the naviframe, makes it
29905 * disappear, then deletes the item. The item that was underneath it on the
29906 * stack will become visible.
29908 * @see also elm_naviframe_content_preserve_on_pop_get()
29910 * @ingroup Naviframe
29912 EAPI Evas_Object *elm_naviframe_item_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
29915 * @brief Pop the items between the top and the above one on the given item.
29917 * @param it The naviframe item
29919 * @ingroup Naviframe
29921 EAPI void elm_naviframe_item_pop_to(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
29924 * Promote an item already in the naviframe stack to the top of the stack
29926 * @param it The naviframe item
29928 * This will take the indicated item and promote it to the top of the stack
29929 * as if it had been pushed there. The item must already be inside the
29930 * naviframe stack to work.
29933 EAPI void elm_naviframe_item_promote(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
29936 * @brief Delete the given item instantly.
29938 * @param it The naviframe item
29940 * This just deletes the given item from the naviframe item list instantly.
29941 * So this would not emit any signals for view transitions but just change
29942 * the current view if the given item is a top one.
29944 * @ingroup Naviframe
29946 EAPI void elm_naviframe_item_del(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
29949 * @brief preserve the content objects when items are popped.
29951 * @param obj The naviframe object
29952 * @param preserve Enable the preserve mode if EINA_TRUE, disable otherwise
29954 * @see also elm_naviframe_content_preserve_on_pop_get()
29956 * @ingroup Naviframe
29958 EAPI void elm_naviframe_content_preserve_on_pop_set(Evas_Object *obj, Eina_Bool preserve) EINA_ARG_NONNULL(1);
29961 * @brief Get a value whether preserve mode is enabled or not.
29963 * @param obj The naviframe object
29964 * @return If @c EINA_TRUE, preserve mode is enabled
29966 * @see also elm_naviframe_content_preserve_on_pop_set()
29968 * @ingroup Naviframe
29970 EAPI Eina_Bool elm_naviframe_content_preserve_on_pop_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
29973 * @brief Get a top item on the naviframe stack
29975 * @param obj The naviframe object
29976 * @return The top item on the naviframe stack or @c NULL, if the stack is
29979 * @ingroup Naviframe
29981 EAPI Elm_Object_Item *elm_naviframe_top_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
29984 * @brief Get a bottom item on the naviframe stack
29986 * @param obj The naviframe object
29987 * @return The bottom item on the naviframe stack or @c NULL, if the stack is
29990 * @ingroup Naviframe
29992 EAPI Elm_Object_Item *elm_naviframe_bottom_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
29995 * @brief Set an item style
29997 * @param obj The naviframe item
29998 * @param item_style The current item style name. @c NULL would be default
30000 * The following styles are available for this item:
30003 * @see also elm_naviframe_item_style_get()
30005 * @ingroup Naviframe
30007 EAPI void elm_naviframe_item_style_set(Elm_Object_Item *it, const char *item_style) EINA_ARG_NONNULL(1);
30010 * @brief Get an item style
30012 * @param obj The naviframe item
30013 * @return The current item style name
30015 * @see also elm_naviframe_item_style_set()
30017 * @ingroup Naviframe
30019 EAPI const char *elm_naviframe_item_style_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
30022 * @brief Show/Hide the title area
30024 * @param it The naviframe item
30025 * @param visible If @c EINA_TRUE, title area will be visible, hidden
30028 * When the title area is invisible, then the controls would be hidden so as * to expand the content area to full-size.
30030 * @see also elm_naviframe_item_title_visible_get()
30032 * @ingroup Naviframe
30034 EAPI void elm_naviframe_item_title_visible_set(Elm_Object_Item *it, Eina_Bool visible) EINA_ARG_NONNULL(1);
30037 * @brief Get a value whether title area is visible or not.
30039 * @param it The naviframe item
30040 * @return If @c EINA_TRUE, title area is visible
30042 * @see also elm_naviframe_item_title_visible_set()
30044 * @ingroup Naviframe
30046 EAPI Eina_Bool elm_naviframe_item_title_visible_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
30049 * @brief Set creating prev button automatically or not
30051 * @param obj The naviframe object
30052 * @param auto_pushed If @c EINA_TRUE, the previous button(back button) will
30053 * be created internally when you pass the @c NULL to the prev_btn
30054 * parameter in elm_naviframe_item_push
30056 * @see also elm_naviframe_item_push()
30058 * @ingroup Naviframe
30060 EAPI void elm_naviframe_prev_btn_auto_pushed_set(Evas_Object *obj, Eina_Bool auto_pushed) EINA_ARG_NONNULL(1);
30063 * @brief Get a value whether prev button(back button) will be auto pushed or
30066 * @param obj The naviframe object
30067 * @return If @c EINA_TRUE, prev button will be auto pushed.
30069 * @see also elm_naviframe_item_push()
30070 * elm_naviframe_prev_btn_auto_pushed_set()
30072 * @ingroup Naviframe
30074 EAPI Eina_Bool elm_naviframe_prev_btn_auto_pushed_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
30077 * @brief Get a list of all the naviframe items.
30079 * @param obj The naviframe object
30080 * @return An Eina_Inlist* of naviframe items, #Elm_Object_Item,
30081 * or @c NULL on failure.
30083 * @ingroup Naviframe
30085 EAPI Eina_Inlist *elm_naviframe_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
30088 * @brief Set the event enabled when pushing/popping items
30090 * If @c enabled is EINA_TRUE, the contents of the naviframe item will
30091 * receives events from mouse and keyboard during view changing such as
30094 * @param obj The naviframe object
30095 * @param enabled Events are received when enabled is @c EINA_TRUE, and
30096 * ignored otherwise.
30098 * @warning Events will be blocked by calling evas_object_freeze_events_set()
30099 * internally. So don't call the API whiling pushing/popping items.
30101 * @see elm_naviframe_event_enabled_get()
30102 * @see evas_object_freeze_events_set()
30104 * @ingroup Naviframe
30106 EAPI void elm_naviframe_event_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
30109 * @brief Get the value of event enabled status.
30111 * @param obj The naviframe object
30112 * @return EINA_TRUE, when event is enabled
30114 * @see elm_naviframe_event_enabled_set()
30116 * @ingroup Naviframe
30118 EAPI Eina_Bool elm_naviframe_event_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
30125 * @defgroup Multibuttonentry Multibuttonentry
30127 * A Multibuttonentry is a widget to allow a user enter text and manage it as a number of buttons
30128 * Each text button is inserted by pressing the "return" key. If there is no space in the current row,
30129 * a new button is added to the next row. When a text button is pressed, it will become focused.
30130 * Backspace removes the focus.
30131 * When the Multibuttonentry loses focus items longer than 1 lines are shrunk to one line.
30133 * Smart callbacks one can register:
30134 * - @c "item,selected" - when item is selected. May be called on backspace key.
30135 * - @c "item,added" - when a new multibuttonentry item is added.
30136 * - @c "item,deleted" - when a multibuttonentry item is deleted.
30137 * - @c "item,clicked" - selected item of multibuttonentry is clicked.
30138 * - @c "clicked" - when multibuttonentry is clicked.
30139 * - @c "focused" - when multibuttonentry is focused.
30140 * - @c "unfocused" - when multibuttonentry is unfocused.
30141 * - @c "expanded" - when multibuttonentry is expanded.
30142 * - @c "shrank" - when multibuttonentry is shrank.
30143 * - @c "shrank,state,changed" - when shrink mode state of multibuttonentry is changed.
30145 * Here is an example on its usage:
30146 * @li @ref multibuttonentry_example
30150 * @addtogroup Multibuttonentry
30154 typedef struct _Multibuttonentry_Item Elm_Multibuttonentry_Item;
30155 typedef Eina_Bool (*Elm_Multibuttonentry_Item_Filter_callback) (Evas_Object *obj, const char *item_label, void *item_data, void *data);
30158 * @brief Add a new multibuttonentry to the parent
30160 * @param parent The parent object
30161 * @return The new object or NULL if it cannot be created
30164 EAPI Evas_Object *elm_multibuttonentry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
30169 * @param obj The multibuttonentry object
30170 * @return The label, or NULL if none
30173 EAPI const char *elm_multibuttonentry_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
30178 * @param obj The multibuttonentry object
30179 * @param label The text label string
30182 EAPI void elm_multibuttonentry_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
30185 * Get the entry of the multibuttonentry object
30187 * @param obj The multibuttonentry object
30188 * @return The entry object, or NULL if none
30191 EAPI Evas_Object *elm_multibuttonentry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
30194 * Get the guide text
30196 * @param obj The multibuttonentry object
30197 * @return The guide text, or NULL if none
30200 EAPI const char * elm_multibuttonentry_guide_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
30203 * Set the guide text
30205 * @param obj The multibuttonentry object
30206 * @param label The guide text string
30209 EAPI void elm_multibuttonentry_guide_text_set(Evas_Object *obj, const char *guidetext) EINA_ARG_NONNULL(1);
30212 * Get the value of shrink_mode state.
30214 * @param obj The multibuttonentry object
30215 * @param the value of shrink mode state.
30218 EAPI int elm_multibuttonentry_shrink_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
30221 * Set/Unset the multibuttonentry to shrink mode state of single line
30223 * @param obj The multibuttonentry object
30224 * @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.
30227 EAPI void elm_multibuttonentry_shrink_mode_set(Evas_Object *obj, int shrink) EINA_ARG_NONNULL(1);
30230 * Prepend a new item to the multibuttonentry
30232 * @param obj The multibuttonentry object
30233 * @param label The label of new item
30234 * @param data The ponter to the data to be attached
30235 * @return A handle to the item added or NULL if not possible
30238 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_prepend(Evas_Object *obj, const char *label, void *data) EINA_ARG_NONNULL(1);
30241 * Append a new item to the multibuttonentry
30243 * @param obj The multibuttonentry object
30244 * @param label The label of new item
30245 * @param data The ponter to the data to be attached
30246 * @return A handle to the item added or NULL if not possible
30249 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_append(Evas_Object *obj, const char *label, void *data) EINA_ARG_NONNULL(1);
30252 * Add a new item to the multibuttonentry before the indicated object
30255 * @param obj The multibuttonentry object
30256 * @param before The item before which to add it
30257 * @param label The label of new item
30258 * @param data The ponter to the data to be attached
30259 * @return A handle to the item added or NULL if not possible
30262 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);
30265 * Add a new item to the multibuttonentry after the indicated object
30267 * @param obj The multibuttonentry object
30268 * @param after The item after which to add it
30269 * @param label The label of new item
30270 * @param data The ponter to the data to be attached
30271 * @return A handle to the item added or NULL if not possible
30274 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);
30277 * Get a list of items in the multibuttonentry
30279 * @param obj The multibuttonentry object
30280 * @return The list of items, or NULL if none
30283 EAPI const Eina_List *elm_multibuttonentry_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
30286 * Get the first item in the multibuttonentry
30288 * @param obj The multibuttonentry object
30289 * @return The first item, or NULL if none
30292 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
30295 * Get the last item in the multibuttonentry
30297 * @param obj The multibuttonentry object
30298 * @return The last item, or NULL if none
30301 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
30304 * Get the selected item in the multibuttonentry
30306 * @param obj The multibuttonentry object
30307 * @return The selected item, or NULL if none
30310 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
30313 * Set the selected state of an item
30315 * @param item The item
30316 * @param selected if it's EINA_TRUE, select the item otherwise, unselect the item
30319 EAPI void elm_multibuttonentry_item_select(Elm_Multibuttonentry_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
30322 * unselect all items.
30324 * @param obj The multibuttonentry object
30327 EAPI void elm_multibuttonentry_item_unselect_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
30330 * Delete a given item
30332 * @param item The item
30335 EAPI void elm_multibuttonentry_item_del(Elm_Multibuttonentry_Item *item) EINA_ARG_NONNULL(1);
30338 * Remove all items in the multibuttonentry.
30340 * @param obj The multibuttonentry object
30343 EAPI void elm_multibuttonentry_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
30346 * Get the label of a given item
30348 * @param item The item
30349 * @return The label of a given item, or NULL if none
30352 EAPI const char *elm_multibuttonentry_item_label_get(const Elm_Multibuttonentry_Item *item) EINA_ARG_NONNULL(1);
30355 * Set the label of a given item
30357 * @param item The item
30358 * @param label The text label string
30361 EAPI void elm_multibuttonentry_item_label_set(Elm_Multibuttonentry_Item *item, const char *str) EINA_ARG_NONNULL(1);
30364 * Get the previous item in the multibuttonentry
30366 * @param item The item
30367 * @return The item before the item @p item
30370 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_prev_get(const Elm_Multibuttonentry_Item *item) EINA_ARG_NONNULL(1);
30373 * Get the next item in the multibuttonentry
30375 * @param item The item
30376 * @return The item after the item @p item
30379 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_next_get(const Elm_Multibuttonentry_Item *item) EINA_ARG_NONNULL(1);
30382 * Append a item filter function for text inserted in the Multibuttonentry
30384 * Append the given callback to the list. This functions will be called
30385 * whenever any text is inserted into the Multibuttonentry, with the text to be inserted
30386 * as a parameter. The callback function is free to alter the text in any way
30387 * it wants, but it must remember to free the given pointer and update it.
30388 * If the new text is to be discarded, the function can free it and set it text
30389 * parameter to NULL. This will also prevent any following filters from being
30392 * @param obj The multibuttonentryentry object
30393 * @param func The function to use as item filter
30394 * @param data User data to pass to @p func
30397 EAPI void elm_multibuttonentry_item_filter_append(Evas_Object *obj, Elm_Multibuttonentry_Item_Filter_callback func, void *data) EINA_ARG_NONNULL(1);
30400 * Prepend a filter function for text inserted in the Multibuttentry
30402 * Prepend the given callback to the list. See elm_multibuttonentry_item_filter_append()
30403 * for more information
30405 * @param obj The multibuttonentry object
30406 * @param func The function to use as text filter
30407 * @param data User data to pass to @p func
30410 EAPI void elm_multibuttonentry_item_filter_prepend(Evas_Object *obj, Elm_Multibuttonentry_Item_Filter_callback func, void *data) EINA_ARG_NONNULL(1);
30413 * Remove a filter from the list
30415 * Removes the given callback from the filter list. See elm_multibuttonentry_item_filter_append()
30416 * for more information.
30418 * @param obj The multibuttonentry object
30419 * @param func The filter function to remove
30420 * @param data The user data passed when adding the function
30423 EAPI void elm_multibuttonentry_item_filter_remove(Evas_Object *obj, Elm_Multibuttonentry_Item_Filter_callback func, void *data) EINA_ARG_NONNULL(1);
30430 * @addtogroup CopyPaste
30434 typedef struct _Elm_Selection_Data Elm_Selection_Data;
30435 typedef Eina_Bool (*Elm_Drop_Cb) (void *d, Evas_Object *o, Elm_Selection_Data *data);
30437 typedef enum _Elm_Sel_Type
30439 ELM_SEL_TYPE_PRIMARY,
30440 ELM_SEL_TYPE_SECONDARY,
30441 ELM_SEL_TYPE_CLIPBOARD,
30447 typedef enum _Elm_Sel_Format
30449 /** Targets: for matching every atom requesting */
30450 ELM_SEL_FORMAT_TARGETS = -1,
30451 /** they come from outside of elm */
30452 ELM_SEL_FORMAT_NONE = 0x0,
30453 /** Plain unformated text: Used for things that don't want rich markup */
30454 ELM_SEL_FORMAT_TEXT = 0x01,
30455 /** Edje textblock markup, including inline images */
30456 ELM_SEL_FORMAT_MARKUP = 0x02,
30458 ELM_SEL_FORMAT_IMAGE = 0x04,
30460 ELM_SEL_FORMAT_VCARD = 0x08,
30461 /** Raw HTMLish things for widgets that want that stuff (hello webkit!) */
30462 ELM_SEL_FORMAT_HTML = 0x10,
30467 struct _Elm_Selection_Data
30470 Elm_Sel_Format format;
30476 * @brief Set a data of a widget to copy and paste.
30478 * Append the given callback to the list. This functions will be called
30481 * @param selection selection type for copying and pasting
30482 * @param widget The source widget pointer
30483 * @param format Type of selection format
30484 * @param buf The pointer of data source
30485 * @return If EINA_TRUE, setting data is success.
30487 * @ingroup CopyPaste
30491 EAPI Eina_Bool elm_cnp_selection_set(Elm_Sel_Type selection, Evas_Object *widget, Elm_Sel_Format format, const void *buf, size_t buflen);
30494 * @brief Retrive the data from the widget which is set for copying and pasting.
30496 * Getting the data from the widget which is set for copying and pasting.
30497 * Mainly the widget is elm_entry. If then @p datacb and @p udata are
30498 * can be NULL. If not, @p datacb and @p udata are used for retriving data.
30500 * @see also elm_cnp_selection_set()
30502 * @param selection selection type for copying and pasting
30503 * @param widget The source widget pointer
30504 * @param datacb The user data callback if the target widget isn't elm_entry
30505 * @param udata The user data pointer for @p datacb
30506 * @return If EINA_TRUE, getting data is success.
30508 * @ingroup CopyPaste
30512 EAPI Eina_Bool elm_cnp_selection_get(Elm_Sel_Type selection, Elm_Sel_Format format, Evas_Object *widget, Elm_Drop_Cb datacb, void *udata);
30515 * @brief Clear the data in the widget which is set for copying and pasting.
30517 * Clear the data in the widget. Normally this function isn't need to call.
30519 * @see also elm_cnp_selection_set()
30521 * @param selection selection type for copying and pasting
30522 * @param widget The source widget pointer
30523 * @return If EINA_TRUE, clearing data is success.
30525 * @ingroup CopyPaste
30529 EAPI Eina_Bool elm_cnp_selection_clear(Elm_Sel_Type selection, Evas_Object *widget);