3 * vim:ts=8:sw=3:sts=3:expandtab:cino=>5n-3f0^-2{2(0W1st0
8 @brief Elementary Widget Library
13 @image html elementary.png
17 @section intro What is Elementary?
19 This is a VERY SIMPLE toolkit. It is not meant for writing extensive desktop
20 applications (yet). Small simple ones with simple needs.
22 It is meant to make the programmers work almost brainless but give them lots
25 @li @ref Start - Go here to quickly get started with writing Apps
27 @section organization Organization
29 One can divide Elemementary into three main groups:
30 @li @ref infralist - These are modules that deal with Elementary as a whole.
31 @li @ref widgetslist - These are the widgets you'll compose your UI out of.
32 @li @ref containerslist - These are the containers which hold the widgets.
34 @section license License
36 LGPL v2 (see COPYING in the base of Elementary's source). This applies to
37 all files in the source tree.
39 @section ack Acknowledgements
40 There is a lot that goes into making a widget set, and they don't happen out of
41 nothing. It's like trying to make everyone everywhere happy, regardless of age,
42 gender, race or nationality - and that is really tough. So thanks to people and
43 organisations behind this, as listed in the @ref authors page.
48 * @defgroup Start Getting Started
50 * To write an Elementary app, you can get started with the following:
53 #include <Elementary.h>
55 elm_main(int argc, char **argv)
57 // create window(s) here and do any application init
58 elm_run(); // run main loop
59 elm_shutdown(); // after mainloop finishes running, shutdown
60 return 0; // exit 0 for exit code
65 * To use autotools (which helps in many ways in the long run, like being able
66 * to immediately create releases of your software directly from your tree
67 * and ensure everything needed to build it is there) you will need a
68 * configure.ac, Makefile.am and autogen.sh file.
73 AC_INIT(myapp, 0.0.0, myname@mydomain.com)
75 AC_CONFIG_SRCDIR(configure.ac)
76 AM_CONFIG_HEADER(config.h)
78 AM_INIT_AUTOMAKE(1.6 dist-bzip2)
79 PKG_CHECK_MODULES([ELEMENTARY], elementary)
86 AUTOMAKE_OPTIONS = 1.4 foreign
87 MAINTAINERCLEANFILES = Makefile.in aclocal.m4 config.h.in configure depcomp install-sh missing
89 INCLUDES = -I$(top_srcdir)
93 myapp_SOURCES = main.c
94 myapp_LDADD = @ELEMENTARY_LIBS@
95 myapp_CFLAGS = @ELEMENTARY_CFLAGS@
102 echo "Running aclocal..." ; aclocal $ACLOCAL_FLAGS || exit 1
103 echo "Running autoheader..." ; autoheader || exit 1
104 echo "Running autoconf..." ; autoconf || exit 1
105 echo "Running automake..." ; automake --add-missing --copy --gnu || exit 1
109 * To generate all the things needed to bootstrap just run:
115 * This will generate Makefile.in's, the confgure script and everything else.
116 * After this it works like all normal autotools projects:
123 * Note sudo was assumed to get root permissions, as this would install in
124 * /usr/local which is system-owned. Use any way you like to gain root, or
125 * specify a different prefix with configure:
128 ./confiugre --prefix=$HOME/mysoftware
131 * Also remember that autotools buys you some useful commands like:
136 * This uninstalls the software after it was installed with "make install".
137 * It is very useful to clear up what you built if you wish to clean the
144 * This firstly checks if your build tree is "clean" and ready for
145 * distribution. It also builds a tarball (myapp-0.0.0.tar.gz) that is
146 * ready to upload and distribute to the world, that contains the generated
147 * Makefile.in's and configure script. The users do not need to run
148 * autogen.sh - just configure and on. They don't need autotools installed.
149 * This tarball also builds cleanly, has all the sources it needs to build
150 * included (that is sources for your application, not libraries it depends
151 * on like Elementary). It builds cleanly in a buildroot and does not
152 * contain any files that are temporarily generated like binaries and other
153 * build-generated files, so the tarball is clean, and no need to worry
154 * about cleaning up your tree before packaging.
160 * This cleans up all build files (binaries, objects etc.) from the tree.
166 * This cleans out all files from the build and from configure's output too.
169 make maintainer-clean
172 * This deletes all the files autogen.sh will produce so the tree is clean
173 * to be put into a revision-control system (like CVS, SVN or GIT for example).
175 * There is a more advanced way of making use of the quicklaunch infrastructure
176 * in Elementary (which will not be covered here due to its more advanced
179 * Now let's actually create an interactive "Hello World" gui that you can
180 * click the ok button to exit. It's more code because this now does something
181 * much more significant, but it's still very simple:
184 #include <Elementary.h>
187 on_done(void *data, Evas_Object *obj, void *event_info)
189 // quit the mainloop (elm_run function will return)
194 elm_main(int argc, char **argv)
196 Evas_Object *win, *bg, *box, *lab, *btn;
198 // new window - do the usual and give it a name (hello) and title (Hello)
199 win = elm_win_util_standard_add("hello", "Hello");
200 // when the user clicks "close" on a window there is a request to delete
201 evas_object_smart_callback_add(win, "delete,request", on_done, NULL);
203 // add a box object - default is vertical. a box holds children in a row,
204 // either horizontally or vertically. nothing more.
205 box = elm_box_add(win);
206 // make the box hotizontal
207 elm_box_horizontal_set(box, EINA_TRUE);
208 // add object as a resize object for the window (controls window minimum
209 // size as well as gets resized if window is resized)
210 elm_win_resize_object_add(win, box);
211 evas_object_show(box);
213 // add a label widget, set the text and put it in the pad frame
214 lab = elm_label_add(win);
215 // set default text of the label
216 elm_object_text_set(lab, "Hello out there world!");
217 // pack the label at the end of the box
218 elm_box_pack_end(box, lab);
219 evas_object_show(lab);
222 btn = elm_button_add(win);
223 // set default text of button to "OK"
224 elm_object_text_set(btn, "OK");
225 // pack the button at the end of the box
226 elm_box_pack_end(box, btn);
227 evas_object_show(btn);
228 // call on_done when button is clicked
229 evas_object_smart_callback_add(btn, "clicked", on_done, NULL);
231 // now we are done, show the window
232 evas_object_show(win);
234 // run the mainloop and process events and callbacks
244 @page authors Authors
245 @author Carsten Haitzler <raster@@rasterman.com>
246 @author Gustavo Sverzut Barbieri <barbieri@@profusion.mobi>
247 @author Cedric Bail <cedric.bail@@free.fr>
248 @author Vincent Torri <vtorri@@univ-evry.fr>
249 @author Daniel Kolesa <quaker66@@gmail.com>
250 @author Jaime Thomas <avi.thomas@@gmail.com>
251 @author Swisscom - http://www.swisscom.ch/
252 @author Christopher Michael <devilhorns@@comcast.net>
253 @author Marco Trevisan (TreviƱo) <mail@@3v1n0.net>
254 @author Michael Bouchaud <michael.bouchaud@@gmail.com>
255 @author Jonathan Atton (Watchwolf) <jonathan.atton@@gmail.com>
256 @author Brian Wang <brian.wang.0721@@gmail.com>
257 @author Mike Blumenkrantz (discomfitor/zmike) <michael.blumenkrantz@@gmail.com>
258 @author Samsung Electronics <tbd>
259 @author Samsung SAIT <tbd>
260 @author Brett Nash <nash@@nash.id.au>
261 @author Bruno Dilly <bdilly@@profusion.mobi>
262 @author Rafael Fonseca <rfonseca@@profusion.mobi>
263 @author Chuneon Park <hermet@@hermet.pe.kr>
264 @author Woohyun Jung <wh0705.jung@@samsung.com>
265 @author Jaehwan Kim <jae.hwan.kim@@samsung.com>
266 @author Wonguk Jeong <wonguk.jeong@@samsung.com>
267 @author Leandro A. F. Pereira <leandro@@profusion.mobi>
268 @author Helen Fornazier <helen.fornazier@@profusion.mobi>
269 @author Gustavo Lima Chaves <glima@@profusion.mobi>
270 @author Fabiano FidĆŖncio <fidencio@@profusion.mobi>
271 @author Tiago FalcĆ£o <tiago@@profusion.mobi>
272 @author Otavio Pontes <otavio@@profusion.mobi>
273 @author Viktor Kojouharov <vkojouharov@@gmail.com>
274 @author Daniel Juyung Seo (SeoZ) <juyung.seo@@samsung.com> <seojuyung2@@gmail.com>
275 @author Sangho Park <sangho.g.park@@samsung.com> <gouache95@@gmail.com>
276 @author Rajeev Ranjan (Rajeev) <rajeev.r@@samsung.com> <rajeev.jnnce@@gmail.com>
277 @author Seunggyun Kim <sgyun.kim@@samsung.com> <tmdrbs@@gmail.com>
278 @author Sohyun Kim <anna1014.kim@@samsung.com> <sohyun.anna@@gmail.com>
279 @author Jihoon Kim <jihoon48.kim@@samsung.com>
280 @author Jeonghyun Yun (arosis) <jh0506.yun@@samsung.com>
281 @author Tom Hacohen <tom@@stosb.com>
282 @author Aharon Hillel <a.hillel@@partner.samsung.com>
283 @author Jonathan Atton (Watchwolf) <jonathan.atton@@gmail.com>
284 @author Shinwoo Kim <kimcinoo@@gmail.com>
285 @author Govindaraju SM <govi.sm@@samsung.com> <govism@@gmail.com>
286 @author Prince Kumar Dubey <prince.dubey@@samsung.com> <prince.dubey@@gmail.com>
287 @author Sung W. Park <sungwoo@@gmail.com>
288 @author Thierry el Borgi <thierry@@substantiel.fr>
289 @author Shilpa Singh <shilpa.singh@@samsung.com> <shilpasingh.o@@gmail.com>
290 @author Chanwook Jung <joey.jung@@samsung.com>
291 @author Hyoyoung Chang <hyoyoung.chang@@samsung.com>
292 @author Guillaume "Kuri" Friloux <guillaume.friloux@@asp64.com>
293 @author Kim Yunhan <spbear@@gmail.com>
294 @author Bluezery <ohpowel@@gmail.com>
295 @author Nicolas Aguirre <aguirre.nicolas@@gmail.com>
296 @author Sanjeev BA <iamsanjeev@@gmail.com>
298 Please contact <enlightenment-devel@lists.sourceforge.net> to get in
299 contact with the developers and maintainers.
307 * @brief Elementary's API
312 @ELM_UNIX_DEF@ ELM_UNIX
313 @ELM_WIN32_DEF@ ELM_WIN32
314 @ELM_WINCE_DEF@ ELM_WINCE
315 @ELM_EDBUS_DEF@ ELM_EDBUS
316 @ELM_EFREET_DEF@ ELM_EFREET
317 @ELM_ETHUMB_DEF@ ELM_ETHUMB
318 @ELM_WEB_DEF@ ELM_WEB
319 @ELM_EMAP_DEF@ ELM_EMAP
320 @ELM_DEBUG_DEF@ ELM_DEBUG
321 @ELM_ALLOCA_H_DEF@ ELM_ALLOCA_H
322 @ELM_LIBINTL_H_DEF@ ELM_LIBINTL_H
323 @ELM_DIRENT_H_DEF@ ELM_DIRENT_H
325 /* Standard headers for standard system calls etc. */
330 #include <sys/types.h>
331 #include <sys/stat.h>
332 #include <sys/time.h>
333 #include <sys/param.h>
347 # ifdef ELM_LIBINTL_H
348 # include <libintl.h>
359 #if defined (ELM_WIN32) || defined (ELM_WINCE)
362 # define alloca _alloca
371 // disabled - evas 1.1 won't have this.
372 //#include <Evas_GL.h>
374 #include <Ecore_Evas.h>
375 #include <Ecore_File.h>
376 @ELEMENTARY_ECORE_IMF_INC@
377 @ELEMENTARY_ECORE_CON_INC@
386 # include <Efreet_Mime.h>
387 # include <Efreet_Trash.h>
391 # include <Ethumb_Client.h>
403 # ifdef ELEMENTARY_BUILD
405 # define EAPI __declspec(dllexport)
408 # endif /* ! DLL_EXPORT */
410 # define EAPI __declspec(dllimport)
411 # endif /* ! EFL_EVAS_BUILD */
415 # define EAPI __attribute__ ((visibility("default")))
422 #endif /* ! _WIN32 */
427 # define EAPI_MAIN EAPI
430 /* allow usage from c++ */
435 #define ELM_VERSION_MAJOR @VMAJ@
436 #define ELM_VERSION_MINOR @VMIN@
438 typedef struct _Elm_Version
446 EAPI extern Elm_Version *elm_version;
449 #define ELM_RECTS_INTERSECT(x, y, w, h, xx, yy, ww, hh) (((x) < ((xx) + (ww))) && ((y) < ((yy) + (hh))) && (((x) + (w)) > (xx)) && (((y) + (h)) > (yy)))
450 #define ELM_PI 3.14159265358979323846
453 * @defgroup General General
455 * @brief General Elementary API. Functions that don't relate to
456 * Elementary objects specifically.
458 * Here are documented functions which init/shutdown the library,
459 * that apply to generic Elementary objects, that deal with
460 * configuration, et cetera.
462 * @ref general_functions_example_page "This" example contemplates
463 * some of these functions.
467 * @addtogroup General
472 * Defines couple of standard Evas_Object layers to be used
473 * with evas_object_layer_set().
475 * @note whenever extending with new values, try to keep some padding
476 * to siblings so there is room for further extensions.
478 typedef enum _Elm_Object_Layer
480 ELM_OBJECT_LAYER_BACKGROUND = EVAS_LAYER_MIN + 64, /**< where to place backgrounds */
481 ELM_OBJECT_LAYER_DEFAULT = 0, /**< Evas_Object default layer (and thus for Elementary) */
482 ELM_OBJECT_LAYER_FOCUS = EVAS_LAYER_MAX - 128, /**< where focus object visualization is */
483 ELM_OBJECT_LAYER_TOOLTIP = EVAS_LAYER_MAX - 64, /**< where to show tooltips */
484 ELM_OBJECT_LAYER_CURSOR = EVAS_LAYER_MAX - 32, /**< where to show cursors */
485 ELM_OBJECT_LAYER_LAST /**< last layer known by Elementary */
488 /**************************************************************************/
489 EAPI extern int ELM_ECORE_EVENT_ETHUMB_CONNECT;
492 * Emitted when the application has reconfigured elementary settings due
493 * to an external configuration tool asking it to.
495 EAPI extern int ELM_EVENT_CONFIG_ALL_CHANGED;
498 * Emitted when any Elementary's policy value is changed.
500 EAPI extern int ELM_EVENT_POLICY_CHANGED;
503 * @typedef Elm_Event_Policy_Changed
505 * Data on the event when an Elementary policy has changed
507 typedef struct _Elm_Event_Policy_Changed Elm_Event_Policy_Changed;
510 * @struct _Elm_Event_Policy_Changed
512 * Data on the event when an Elementary policy has changed
514 struct _Elm_Event_Policy_Changed
516 unsigned int policy; /**< the policy identifier */
517 int new_value; /**< value the policy had before the change */
518 int old_value; /**< new value the policy got */
522 * Policy identifiers.
524 typedef enum _Elm_Policy
526 ELM_POLICY_QUIT, /**< under which circumstances the application
527 * should quit automatically. @see
531 } Elm_Policy; /**< Elementary policy identifiers/groups enumeration. @see elm_policy_set()
534 typedef enum _Elm_Policy_Quit
536 ELM_POLICY_QUIT_NONE = 0, /**< never quit the application
538 ELM_POLICY_QUIT_LAST_WINDOW_CLOSED /**< quit when the
540 * window is closed */
541 } Elm_Policy_Quit; /**< Possible values for the #ELM_POLICY_QUIT policy */
543 typedef enum _Elm_Focus_Direction
547 } Elm_Focus_Direction;
549 typedef enum _Elm_Text_Format
551 ELM_TEXT_FORMAT_PLAIN_UTF8,
552 ELM_TEXT_FORMAT_MARKUP_UTF8
556 * Line wrapping types.
558 typedef enum _Elm_Wrap_Type
560 ELM_WRAP_NONE = 0, /**< No wrap - value is zero */
561 ELM_WRAP_CHAR, /**< Char wrap - wrap between characters */
562 ELM_WRAP_WORD, /**< Word wrap - wrap in allowed wrapping points (as defined in the unicode standard) */
563 ELM_WRAP_MIXED, /**< Mixed wrap - Word wrap, and if that fails, char wrap. */
569 ELM_INPUT_PANEL_LAYOUT_NORMAL, /**< Default layout */
570 ELM_INPUT_PANEL_LAYOUT_NUMBER, /**< Number layout */
571 ELM_INPUT_PANEL_LAYOUT_EMAIL, /**< Email layout */
572 ELM_INPUT_PANEL_LAYOUT_URL, /**< URL layout */
573 ELM_INPUT_PANEL_LAYOUT_PHONENUMBER, /**< Phone Number layout */
574 ELM_INPUT_PANEL_LAYOUT_IP, /**< IP layout */
575 ELM_INPUT_PANEL_LAYOUT_MONTH, /**< Month layout */
576 ELM_INPUT_PANEL_LAYOUT_NUMBERONLY, /**< Number Only layout */
577 ELM_INPUT_PANEL_LAYOUT_INVALID
578 } Elm_Input_Panel_Layout;
582 ELM_AUTOCAPITAL_TYPE_NONE,
583 ELM_AUTOCAPITAL_TYPE_WORD,
584 ELM_AUTOCAPITAL_TYPE_SENTENCE,
585 ELM_AUTOCAPITAL_TYPE_ALLCHARACTER,
586 } Elm_Autocapital_Type;
589 * @typedef Elm_Object_Item
590 * An Elementary Object item handle.
593 typedef struct _Elm_Object_Item Elm_Object_Item;
597 * Called back when a widget's tooltip is activated and needs content.
598 * @param data user-data given to elm_object_tooltip_content_cb_set()
599 * @param obj owner widget.
600 * @param tooltip The tooltip object (affix content to this!)
602 typedef Evas_Object *(*Elm_Tooltip_Content_Cb) (void *data, Evas_Object *obj, Evas_Object *tooltip);
605 * Called back when a widget's item tooltip is activated and needs content.
606 * @param data user-data given to elm_object_tooltip_content_cb_set()
607 * @param obj owner widget.
608 * @param tooltip The tooltip object (affix content to this!)
609 * @param item context dependent item. As an example, if tooltip was
610 * set on Elm_List_Item, then it is of this type.
612 typedef Evas_Object *(*Elm_Tooltip_Item_Content_Cb) (void *data, Evas_Object *obj, Evas_Object *tooltip, void *item);
614 typedef Eina_Bool (*Elm_Event_Cb) (void *data, Evas_Object *obj, Evas_Object *src, Evas_Callback_Type type, void *event_info); /**< Function prototype definition for callbacks on input events happening on Elementary widgets. @a data will receive the user data pointer passed to elm_object_event_callback_add(). @a src will be a pointer to the widget on which the input event took place. @a type will get the type of this event and @a event_info, the struct with details on this event. */
616 #ifndef ELM_LIB_QUICKLAUNCH
617 #define ELM_MAIN() int main(int argc, char **argv) {elm_init(argc, argv); return elm_main(argc, argv);} /**< macro to be used after the elm_main() function */
619 #define ELM_MAIN() int main(int argc, char **argv) {return elm_quicklaunch_fallback(argc, argv);} /**< macro to be used after the elm_main() function */
622 /**************************************************************************/
626 * Initialize Elementary
628 * @param[in] argc System's argument count value
629 * @param[in] argv System's pointer to array of argument strings
630 * @return The init counter value.
632 * This function initializes Elementary and increments a counter of
633 * the number of calls to it. It returns the new counter's value.
635 * @warning This call is exported only for use by the @c ELM_MAIN()
636 * macro. There is no need to use this if you use this macro (which
637 * is highly advisable). An elm_main() should contain the entry
638 * point code for your application, having the same prototype as
639 * elm_init(), and @b not being static (putting the @c EAPI symbol
640 * in front of its type declaration is advisable). The @c
641 * ELM_MAIN() call should be placed just after it.
644 * @dontinclude bg_example_01.c
648 * See the full @ref bg_example_01_c "example".
650 * @see elm_shutdown().
653 EAPI int elm_init(int argc, char **argv);
656 * Shut down Elementary
658 * @return The init counter value.
660 * This should be called at the end of your application, just
661 * before it ceases to do any more processing. This will clean up
662 * any permanent resources your application may have allocated via
663 * Elementary that would otherwise persist.
665 * @see elm_init() for an example
669 EAPI int elm_shutdown(void);
672 * Run Elementary's main loop
674 * This call should be issued just after all initialization is
675 * completed. This function will not return until elm_exit() is
676 * called. It will keep looping, running the main
677 * (event/processing) loop for Elementary.
679 * @see elm_init() for an example
683 EAPI void elm_run(void);
686 * Exit Elementary's main loop
688 * If this call is issued, it will flag the main loop to cease
689 * processing and return back to its parent function (usually your
690 * elm_main() function).
692 * @see elm_init() for an example. There, just after a request to
693 * close the window comes, the main loop will be left.
695 * @note By using the appropriate #ELM_POLICY_QUIT on your Elementary
696 * applications, you'll be able to get this function called automatically for you.
700 EAPI void elm_exit(void);
703 * Provide information in order to make Elementary determine the @b
704 * run time location of the software in question, so other data files
705 * such as images, sound files, executable utilities, libraries,
706 * modules and locale files can be found.
708 * @param mainfunc This is your application's main function name,
709 * whose binary's location is to be found. Providing @c NULL
710 * will make Elementary not to use it
711 * @param dom This will be used as the application's "domain", in the
712 * form of a prefix to any environment variables that may
713 * override prefix detection and the directory name, inside the
714 * standard share or data directories, where the software's
715 * data files will be looked for.
716 * @param checkfile This is an (optional) magic file's path to check
717 * for existence (and it must be located in the data directory,
718 * under the share directory provided above). Its presence will
719 * help determine the prefix found was correct. Pass @c NULL if
720 * the check is not to be done.
722 * This function allows one to re-locate the application somewhere
723 * else after compilation, if the developer wishes for easier
724 * distribution of pre-compiled binaries.
726 * The prefix system is designed to locate where the given software is
727 * installed (under a common path prefix) at run time and then report
728 * specific locations of this prefix and common directories inside
729 * this prefix like the binary, library, data and locale directories,
730 * through the @c elm_app_*_get() family of functions.
732 * Call elm_app_info_set() early on before you change working
733 * directory or anything about @c argv[0], so it gets accurate
736 * It will then try and trace back which file @p mainfunc comes from,
737 * if provided, to determine the application's prefix directory.
739 * The @p dom parameter provides a string prefix to prepend before
740 * environment variables, allowing a fallback to @b specific
741 * environment variables to locate the software. You would most
742 * probably provide a lowercase string there, because it will also
743 * serve as directory domain, explained next. For environment
744 * variables purposes, this string is made uppercase. For example if
745 * @c "myapp" is provided as the prefix, then the program would expect
746 * @c "MYAPP_PREFIX" as a master environment variable to specify the
747 * exact install prefix for the software, or more specific environment
748 * variables like @c "MYAPP_BIN_DIR", @c "MYAPP_LIB_DIR", @c
749 * "MYAPP_DATA_DIR" and @c "MYAPP_LOCALE_DIR", which could be set by
750 * the user or scripts before launching. If not provided (@c NULL),
751 * environment variables will not be used to override compiled-in
752 * defaults or auto detections.
754 * The @p dom string also provides a subdirectory inside the system
755 * shared data directory for data files. For example, if the system
756 * directory is @c /usr/local/share, then this directory name is
757 * appended, creating @c /usr/local/share/myapp, if it @p was @c
758 * "myapp". It is expected that the application installs data files in
761 * The @p checkfile is a file name or path of something inside the
762 * share or data directory to be used to test that the prefix
763 * detection worked. For example, your app will install a wallpaper
764 * image as @c /usr/local/share/myapp/images/wallpaper.jpg and so to
765 * check that this worked, provide @c "images/wallpaper.jpg" as the @p
768 * @see elm_app_compile_bin_dir_set()
769 * @see elm_app_compile_lib_dir_set()
770 * @see elm_app_compile_data_dir_set()
771 * @see elm_app_compile_locale_set()
772 * @see elm_app_prefix_dir_get()
773 * @see elm_app_bin_dir_get()
774 * @see elm_app_lib_dir_get()
775 * @see elm_app_data_dir_get()
776 * @see elm_app_locale_dir_get()
778 EAPI void elm_app_info_set(void *mainfunc, const char *dom, const char *checkfile);
781 * Provide information on the @b fallback application's binaries
782 * directory, in scenarios where they get overriden by
783 * elm_app_info_set().
785 * @param dir The path to the default binaries directory (compile time
788 * @note Elementary will as well use this path to determine actual
789 * names of binaries' directory paths, maybe changing it to be @c
790 * something/local/bin instead of @c something/bin, only, for
793 * @warning You should call this function @b before
794 * elm_app_info_set().
796 EAPI void elm_app_compile_bin_dir_set(const char *dir);
799 * Provide information on the @b fallback application's libraries
800 * directory, on scenarios where they get overriden by
801 * elm_app_info_set().
803 * @param dir The path to the default libraries directory (compile
806 * @note Elementary will as well use this path to determine actual
807 * names of libraries' directory paths, maybe changing it to be @c
808 * something/lib32 or @c something/lib64 instead of @c something/lib,
811 * @warning You should call this function @b before
812 * elm_app_info_set().
814 EAPI void elm_app_compile_lib_dir_set(const char *dir);
817 * Provide information on the @b fallback application's data
818 * directory, on scenarios where they get overriden by
819 * elm_app_info_set().
821 * @param dir The path to the default data directory (compile time
824 * @note Elementary will as well use this path to determine actual
825 * names of data directory paths, maybe changing it to be @c
826 * something/local/share instead of @c something/share, only, for
829 * @warning You should call this function @b before
830 * elm_app_info_set().
832 EAPI void elm_app_compile_data_dir_set(const char *dir);
835 * Provide information on the @b fallback application's locale
836 * directory, on scenarios where they get overriden by
837 * elm_app_info_set().
839 * @param dir The path to the default locale directory (compile time
842 * @warning You should call this function @b before
843 * elm_app_info_set().
845 EAPI void elm_app_compile_locale_set(const char *dir);
848 * Retrieve the application's run time prefix directory, as set by
849 * elm_app_info_set() and the way (environment) the application was
852 * @return The directory prefix the application is actually using.
854 EAPI const char *elm_app_prefix_dir_get(void);
857 * Retrieve the application's run time binaries prefix directory, as
858 * set by elm_app_info_set() and the way (environment) the application
861 * @return The binaries directory prefix the application is actually
864 EAPI const char *elm_app_bin_dir_get(void);
867 * Retrieve the application's run time libraries prefix directory, as
868 * set by elm_app_info_set() and the way (environment) the application
871 * @return The libraries directory prefix the application is actually
874 EAPI const char *elm_app_lib_dir_get(void);
877 * Retrieve the application's run time data prefix directory, as
878 * set by elm_app_info_set() and the way (environment) the application
881 * @return The data directory prefix the application is actually
884 EAPI const char *elm_app_data_dir_get(void);
887 * Retrieve the application's run time locale prefix directory, as
888 * set by elm_app_info_set() and the way (environment) the application
891 * @return The locale directory prefix the application is actually
894 EAPI const char *elm_app_locale_dir_get(void);
896 EAPI void elm_quicklaunch_mode_set(Eina_Bool ql_on);
897 EAPI Eina_Bool elm_quicklaunch_mode_get(void);
898 EAPI int elm_quicklaunch_init(int argc, char **argv);
899 EAPI int elm_quicklaunch_sub_init(int argc, char **argv);
900 EAPI int elm_quicklaunch_sub_shutdown(void);
901 EAPI int elm_quicklaunch_shutdown(void);
902 EAPI void elm_quicklaunch_seed(void);
903 EAPI Eina_Bool elm_quicklaunch_prepare(int argc, char **argv);
904 EAPI Eina_Bool elm_quicklaunch_fork(int argc, char **argv, char *cwd, void (postfork_func) (void *data), void *postfork_data);
905 EAPI void elm_quicklaunch_cleanup(void);
906 EAPI int elm_quicklaunch_fallback(int argc, char **argv);
907 EAPI char *elm_quicklaunch_exe_path_get(const char *exe);
909 EAPI Eina_Bool elm_need_efreet(void);
910 EAPI Eina_Bool elm_need_e_dbus(void);
913 * This must be called before any other function that deals with
914 * elm_thumb objects or ethumb_client instances.
918 EAPI Eina_Bool elm_need_ethumb(void);
921 * This must be called before any other function that deals with
922 * elm_web objects or ewk_view instances.
926 EAPI Eina_Bool elm_need_web(void);
929 * Set a new policy's value (for a given policy group/identifier).
931 * @param policy policy identifier, as in @ref Elm_Policy.
932 * @param value policy value, which depends on the identifier
934 * @return @c EINA_TRUE on success or @c EINA_FALSE, on error.
936 * Elementary policies define applications' behavior,
937 * somehow. These behaviors are divided in policy groups (see
938 * #Elm_Policy enumeration). This call will emit the Ecore event
939 * #ELM_EVENT_POLICY_CHANGED, which can be hooked at with
940 * handlers. An #Elm_Event_Policy_Changed struct will be passed,
943 * @note Currently, we have only one policy identifier/group
944 * (#ELM_POLICY_QUIT), which has two possible values.
948 EAPI Eina_Bool elm_policy_set(unsigned int policy, int value);
951 * Gets the policy value for given policy identifier.
953 * @param policy policy identifier, as in #Elm_Policy.
954 * @return The currently set policy value, for that
955 * identifier. Will be @c 0 if @p policy passed is invalid.
959 EAPI int elm_policy_get(unsigned int policy);
962 * Change the language of the current application
964 * The @p lang passed must be the full name of the locale to use, for
965 * example "en_US.utf8" or "es_ES@euro".
967 * Changing language with this function will make Elementary run through
968 * all its widgets, translating strings set with
969 * elm_object_domain_translatable_text_part_set(). This way, an entire
970 * UI can have its language changed without having to restart the program.
972 * For more complex cases, like having formatted strings that need
973 * translation, widgets will also emit a "language,changed" signal that
974 * the user can listen to to manually translate the text.
976 * @param lang Language to set, must be the full name of the locale
980 EAPI void elm_language_set(const char *lang);
983 * Set a label of an object
985 * @param obj The Elementary object
986 * @param part The text part name to set (NULL for the default label)
987 * @param label The new text of the label
989 * @note Elementary objects may have many labels (e.g. Action Slider)
990 * @deprecated Use elm_object_part_text_set() instead.
993 EINA_DEPRECATED EAPI void elm_object_text_part_set(Evas_Object *obj, const char *part, const char *label);
996 * Set a label of an object
998 * @param obj The Elementary object
999 * @param part The text part name to set (NULL for the default label)
1000 * @param label The new text of the label
1002 * @note Elementary objects may have many labels (e.g. Action Slider)
1006 EAPI void elm_object_part_text_set(Evas_Object *obj, const char *part, const char *label);
1008 #define elm_object_text_set(obj, label) elm_object_part_text_set((obj), NULL, (label))
1011 * Get a label of an object
1013 * @param obj The Elementary object
1014 * @param part The text part name to get (NULL for the default label)
1015 * @return text of the label or NULL for any error
1017 * @note Elementary objects may have many labels (e.g. Action Slider)
1018 * @deprecated Use elm_object_part_text_get() instead.
1021 EINA_DEPRECATED EAPI const char *elm_object_text_part_get(const Evas_Object *obj, const char *part);
1024 * Get a label of an object
1026 * @param obj The Elementary object
1027 * @param part The text part name to get (NULL for the default label)
1028 * @return text of the label or NULL for any error
1030 * @note Elementary objects may have many labels (e.g. Action Slider)
1034 EAPI const char *elm_object_part_text_get(const Evas_Object *obj, const char *part);
1036 #define elm_object_text_get(obj) elm_object_part_text_get((obj), NULL)
1039 * Set the text for an objects' part, marking it as translatable.
1041 * The string to set as @p text must be the original one. Do not pass the
1042 * return of @c gettext() here. Elementary will translate the string
1043 * internally and set it on the object using elm_object_part_text_set(),
1044 * also storing the original string so that it can be automatically
1045 * translated when the language is changed with elm_language_set().
1047 * The @p domain will be stored along to find the translation in the
1048 * correct catalog. It can be NULL, in which case it will use whatever
1049 * domain was set by the application with @c textdomain(). This is useful
1050 * in case you are building a library on top of Elementary that will have
1051 * its own translatable strings, that should not be mixed with those of
1052 * programs using the library.
1054 * @param obj The object containing the text part
1055 * @param part The name of the part to set
1056 * @param domain The translation domain to use
1057 * @param text The original, non-translated text to set
1061 EAPI void elm_object_domain_translatable_text_part_set(Evas_Object *obj, const char *part, const char *domain, const char *text);
1063 #define elm_object_domain_translatable_text_set(obj, domain, text) elm_object_domain_translatable_text_part_set((obj), NULL, (domain), (text))
1065 #define elm_object_translatable_text_set(obj, text) elm_object_domain_translatable_text_part_set((obj), NULL, NULL, (text))
1068 * Gets the original string set as translatable for an object
1070 * When setting translated strings, the function elm_object_part_text_get()
1071 * will return the translation returned by @c gettext(). To get the
1072 * original string use this function.
1074 * @param obj The object
1075 * @param part The name of the part that was set
1077 * @return The original, untranslated string
1081 EAPI const char *elm_object_translatable_text_part_get(const Evas_Object *obj, const char *part);
1083 #define elm_object_translatable_text_get(obj) elm_object_translatable_text_part_get((obj), NULL)
1086 * Set a content of an object
1088 * @param obj The Elementary object
1089 * @param part The content part name to set (NULL for the default content)
1090 * @param content The new content of the object
1092 * @note Elementary objects may have many contents
1093 * @deprecated Use elm_object_part_content_set instead.
1096 EINA_DEPRECATED EAPI void elm_object_content_part_set(Evas_Object *obj, const char *part, Evas_Object *content);
1099 * Set a content of an object
1101 * @param obj The Elementary object
1102 * @param part The content part name to set (NULL for the default content)
1103 * @param content The new content of the object
1105 * @note Elementary objects may have many contents
1109 EAPI void elm_object_part_content_set(Evas_Object *obj, const char *part, Evas_Object *content);
1111 #define elm_object_content_set(obj, content) elm_object_part_content_set((obj), NULL, (content))
1114 * Get a content of an object
1116 * @param obj The Elementary object
1117 * @param item The content part name to get (NULL for the default content)
1118 * @return content of the object or NULL for any error
1120 * @note Elementary objects may have many contents
1121 * @deprecated Use elm_object_part_content_get instead.
1124 EINA_DEPRECATED EAPI Evas_Object *elm_object_content_part_get(const Evas_Object *obj, const char *part);
1127 * Get a content of an object
1129 * @param obj The Elementary object
1130 * @param item The content part name to get (NULL for the default content)
1131 * @return content of the object or NULL for any error
1133 * @note Elementary objects may have many contents
1137 EAPI Evas_Object *elm_object_part_content_get(const Evas_Object *obj, const char *part);
1139 #define elm_object_content_get(obj) elm_object_part_content_get((obj), NULL)
1142 * Unset a content of an object
1144 * @param obj The Elementary object
1145 * @param item The content part name to unset (NULL for the default content)
1147 * @note Elementary objects may have many contents
1148 * @deprecated Use elm_object_part_content_unset instead.
1151 EINA_DEPRECATED EAPI Evas_Object *elm_object_content_part_unset(Evas_Object *obj, const char *part);
1154 * Unset a content of an object
1156 * @param obj The Elementary object
1157 * @param item The content part name to unset (NULL for the default content)
1159 * @note Elementary objects may have many contents
1163 EAPI Evas_Object *elm_object_part_content_unset(Evas_Object *obj, const char *part);
1165 #define elm_object_content_unset(obj) elm_object_part_content_unset((obj), NULL)
1168 * Set the text to read out when in accessibility mode
1170 * @param obj The object which is to be described
1171 * @param txt The text that describes the widget to people with poor or no vision
1175 EAPI void elm_object_access_info_set(Evas_Object *obj, const char *txt);
1178 * Get the widget object's handle which contains a given item
1180 * @param item The Elementary object item
1181 * @return The widget object
1183 * @note This returns the widget object itself that an item belongs to.
1187 EAPI Evas_Object *elm_object_item_object_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
1190 * Set a content of an object item
1192 * @param it The Elementary object item
1193 * @param part The content part name to set (NULL for the default content)
1194 * @param content The new content of the object item
1196 * @note Elementary object items may have many contents
1197 * @deprecated Use elm_object_item_part_content_set instead.
1200 EINA_DEPRECATED EAPI void elm_object_item_content_part_set(Elm_Object_Item *it, const char *part, Evas_Object *content);
1203 * Set a content of an object item
1205 * @param it The Elementary object item
1206 * @param part The content part name to set (NULL for the default content)
1207 * @param content The new content of the object item
1209 * @note Elementary object items may have many contents
1213 EAPI void elm_object_item_part_content_set(Elm_Object_Item *it, const char *part, Evas_Object *content);
1215 #define elm_object_item_content_set(it, content) elm_object_item_part_content_set((it), NULL, (content))
1218 * Get a content of an object item
1220 * @param it The Elementary object item
1221 * @param part The content part name to unset (NULL for the default content)
1222 * @return content of the object item or NULL for any error
1224 * @note Elementary object items may have many contents
1225 * @deprecated Use elm_object_item_part_content_get instead.
1228 EAPI Evas_Object *elm_object_item_content_part_get(const Elm_Object_Item *it, const char *part);
1231 * Get a content of an object item
1233 * @param it The Elementary object item
1234 * @param part The content part name to unset (NULL for the default content)
1235 * @return content of the object item or NULL for any error
1237 * @note Elementary object items may have many contents
1241 EAPI Evas_Object *elm_object_item_part_content_get(const Elm_Object_Item *it, const char *part);
1243 #define elm_object_item_content_get(it) elm_object_item_part_content_get((it), NULL)
1246 * Unset a content of an object item
1248 * @param it The Elementary object item
1249 * @param part The content part name to unset (NULL for the default content)
1251 * @note Elementary object items may have many contents
1252 * @deprecated Use elm_object_item_part_content_unset instead.
1255 EINA_DEPRECATED EAPI Evas_Object *elm_object_item_content_part_unset(Elm_Object_Item *it, const char *part);
1258 * Unset a content of an object item
1260 * @param it The Elementary object item
1261 * @param part The content part name to unset (NULL for the default content)
1263 * @note Elementary object items may have many contents
1267 EAPI Evas_Object *elm_object_item_part_content_unset(Elm_Object_Item *it, const char *part);
1269 #define elm_object_item_content_unset(it) elm_object_item_part_content_unset((it), NULL)
1272 * Set a label of an object item
1274 * @param it The Elementary object item
1275 * @param part The text part name to set (NULL for the default label)
1276 * @param label The new text of the label
1278 * @note Elementary object items may have many labels
1279 * @deprecated Use elm_object_item_part_text_set instead.
1282 EINA_DEPRECATED EAPI void elm_object_item_text_part_set(Elm_Object_Item *it, const char *part, const char *label);
1285 * Set a label of an object item
1287 * @param it The Elementary object item
1288 * @param part The text part name to set (NULL for the default label)
1289 * @param label The new text of the label
1291 * @note Elementary object items may have many labels
1295 EAPI void elm_object_item_part_text_set(Elm_Object_Item *it, const char *part, const char *label);
1297 #define elm_object_item_text_set(it, label) elm_object_item_part_text_set((it), NULL, (label))
1300 * Get a label of an object item
1302 * @param it The Elementary object item
1303 * @param part The text part name to get (NULL for the default label)
1304 * @return text of the label or NULL for any error
1306 * @note Elementary object items may have many labels
1307 * @deprecated Use elm_object_item_part_text_get instead.
1310 EINA_DEPRECATED EAPI const char *elm_object_item_text_part_get(const Elm_Object_Item *it, const char *part);
1312 * Get a label of an object item
1314 * @param it The Elementary object item
1315 * @param part The text part name to get (NULL for the default label)
1316 * @return text of the label or NULL for any error
1318 * @note Elementary object items may have many labels
1322 EAPI const char *elm_object_item_part_text_get(const Elm_Object_Item *it, const char *part);
1324 #define elm_object_item_text_get(it) elm_object_item_part_text_get((it), NULL)
1327 * Set the text to read out when in accessibility mode
1329 * @param it The object item which is to be described
1330 * @param txt The text that describes the widget to people with poor or no vision
1334 EAPI void elm_object_item_access_info_set(Elm_Object_Item *it, const char *txt);
1337 * Get the data associated with an object item
1338 * @param it The Elementary object item
1339 * @return The data associated with @p it
1343 EAPI void *elm_object_item_data_get(const Elm_Object_Item *it);
1346 * Set the data associated with an object item
1347 * @param it The Elementary object item
1348 * @param data The data to be associated with @p it
1352 EAPI void elm_object_item_data_set(Elm_Object_Item *it, void *data);
1355 * Send a signal to the edje object of the widget item.
1357 * This function sends a signal to the edje object of the obj item. An
1358 * edje program can respond to a signal by specifying matching
1359 * 'signal' and 'source' fields.
1361 * @param it The Elementary object item
1362 * @param emission The signal's name.
1363 * @param source The signal's source.
1366 EAPI void elm_object_item_signal_emit(Elm_Object_Item *it, const char *emission, const char *source) EINA_ARG_NONNULL(1);
1369 * Set the disabled state of an widget item.
1371 * @param obj The Elementary object item
1372 * @param disabled The state to put in in: @c EINA_TRUE for
1373 * disabled, @c EINA_FALSE for enabled
1375 * Elementary object item can be @b disabled, in which state they won't
1376 * receive input and, in general, will be themed differently from
1377 * their normal state, usually greyed out. Useful for contexts
1378 * where you don't want your users to interact with some of the
1379 * parts of you interface.
1381 * This sets the state for the widget item, either disabling it or
1386 EAPI void elm_object_item_disabled_set(Elm_Object_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1);
1389 * Get the disabled state of an widget item.
1391 * @param obj The Elementary object
1392 * @return @c EINA_TRUE, if the widget item is disabled, @c EINA_FALSE
1393 * if it's enabled (or on errors)
1395 * This gets the state of the widget, which might be enabled or disabled.
1399 EAPI Eina_Bool elm_object_item_disabled_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
1406 * @defgroup Caches Caches
1408 * These are functions which let one fine-tune some cache values for
1409 * Elementary applications, thus allowing for performance adjustments.
1415 * @brief Flush all caches.
1417 * Frees all data that was in cache and is not currently being used to reduce
1418 * memory usage. This frees Edje's, Evas' and Eet's cache. This is equivalent
1419 * to calling all of the following functions:
1420 * @li edje_file_cache_flush()
1421 * @li edje_collection_cache_flush()
1422 * @li eet_clearcache()
1423 * @li evas_image_cache_flush()
1424 * @li evas_font_cache_flush()
1425 * @li evas_render_dump()
1426 * @note Evas caches are flushed for every canvas associated with a window.
1430 EAPI void elm_all_flush(void);
1433 * Get the configured cache flush interval time
1435 * This gets the globally configured cache flush interval time, in
1438 * @return The cache flush interval time
1441 * @see elm_all_flush()
1443 EAPI int elm_cache_flush_interval_get(void);
1446 * Set the configured cache flush interval time
1448 * This sets the globally configured cache flush interval time, in ticks
1450 * @param size The cache flush interval time
1453 * @see elm_all_flush()
1455 EAPI void elm_cache_flush_interval_set(int size);
1458 * Set the configured cache flush interval time for all applications on the
1461 * This sets the globally configured cache flush interval time -- in ticks
1462 * -- for all applications on the display.
1464 * @param size The cache flush interval time
1467 EAPI void elm_cache_flush_interval_all_set(int size);
1470 * Get the configured cache flush enabled state
1472 * This gets the globally configured cache flush state - if it is enabled
1473 * or not. When cache flushing is enabled, elementary will regularly
1474 * (see elm_cache_flush_interval_get() ) flush caches and dump data out of
1475 * memory and allow usage to re-seed caches and data in memory where it
1476 * can do so. An idle application will thus minimise its memory usage as
1477 * data will be freed from memory and not be re-loaded as it is idle and
1478 * not rendering or doing anything graphically right now.
1480 * @return The cache flush state
1483 * @see elm_all_flush()
1485 EAPI Eina_Bool elm_cache_flush_enabled_get(void);
1488 * Set the configured cache flush enabled state
1490 * This sets the globally configured cache flush enabled state.
1492 * @param size The cache flush enabled state
1495 * @see elm_all_flush()
1497 EAPI void elm_cache_flush_enabled_set(Eina_Bool enabled);
1500 * Set the configured cache flush enabled state for all applications on the
1503 * This sets the globally configured cache flush enabled state for all
1504 * applications on the display.
1506 * @param size The cache flush enabled state
1509 EAPI void elm_cache_flush_enabled_all_set(Eina_Bool enabled);
1512 * Get the configured font cache size
1514 * This gets the globally configured font cache size, in bytes.
1516 * @return The font cache size
1519 EAPI int elm_font_cache_get(void);
1522 * Set the configured font cache size
1524 * This sets the globally configured font cache size, in bytes
1526 * @param size The font cache size
1529 EAPI void elm_font_cache_set(int size);
1532 * Set the configured font cache size for all applications on the
1535 * This sets the globally configured font cache size -- in bytes
1536 * -- for all applications on the display.
1538 * @param size The font cache size
1541 EAPI void elm_font_cache_all_set(int size);
1544 * Get the configured image cache size
1546 * This gets the globally configured image cache size, in bytes
1548 * @return The image cache size
1551 EAPI int elm_image_cache_get(void);
1554 * Set the configured image cache size
1556 * This sets the globally configured image cache size, in bytes
1558 * @param size The image cache size
1561 EAPI void elm_image_cache_set(int size);
1564 * Set the configured image cache size for all applications on the
1567 * This sets the globally configured image cache size -- in bytes
1568 * -- for all applications on the display.
1570 * @param size The image cache size
1573 EAPI void elm_image_cache_all_set(int size);
1576 * Get the configured edje file cache size.
1578 * This gets the globally configured edje file cache size, in number
1581 * @return The edje file cache size
1584 EAPI int elm_edje_file_cache_get(void);
1587 * Set the configured edje file cache size
1589 * This sets the globally configured edje file cache size, in number
1592 * @param size The edje file cache size
1595 EAPI void elm_edje_file_cache_set(int size);
1598 * Set the configured edje file cache size for all applications on the
1601 * This sets the globally configured edje file cache size -- in number
1602 * of files -- for all applications on the display.
1604 * @param size The edje file cache size
1607 EAPI void elm_edje_file_cache_all_set(int size);
1610 * Get the configured edje collections (groups) cache size.
1612 * This gets the globally configured edje collections cache size, in
1613 * number of collections.
1615 * @return The edje collections cache size
1618 EAPI int elm_edje_collection_cache_get(void);
1621 * Set the configured edje collections (groups) cache size
1623 * This sets the globally configured edje collections cache size, in
1624 * number of collections.
1626 * @param size The edje collections cache size
1629 EAPI void elm_edje_collection_cache_set(int size);
1632 * Set the configured edje collections (groups) cache size for all
1633 * applications on the display
1635 * This sets the globally configured edje collections cache size -- in
1636 * number of collections -- for all applications on the display.
1638 * @param size The edje collections cache size
1641 EAPI void elm_edje_collection_cache_all_set(int size);
1648 * @defgroup Scaling Widget Scaling
1650 * Different widgets can be scaled independently. These functions
1651 * allow you to manipulate this scaling on a per-widget basis. The
1652 * object and all its children get their scaling factors multiplied
1653 * by the scale factor set. This is multiplicative, in that if a
1654 * child also has a scale size set it is in turn multiplied by its
1655 * parent's scale size. @c 1.0 means ādon't scaleā, @c 2.0 is
1656 * double size, @c 0.5 is half, etc.
1658 * @ref general_functions_example_page "This" example contemplates
1659 * some of these functions.
1663 * Get the global scaling factor
1665 * This gets the globally configured scaling factor that is applied to all
1668 * @return The scaling factor
1671 EAPI double elm_scale_get(void);
1674 * Set the global scaling factor
1676 * This sets the globally configured scaling factor that is applied to all
1679 * @param scale The scaling factor to set
1682 EAPI void elm_scale_set(double scale);
1685 * Set the global scaling factor for all applications on the display
1687 * This sets the globally configured scaling factor that is applied to all
1688 * objects for all applications.
1689 * @param scale The scaling factor to set
1692 EAPI void elm_scale_all_set(double scale);
1695 * Set the scaling factor for a given Elementary object
1697 * @param obj The Elementary to operate on
1698 * @param scale Scale factor (from @c 0.0 up, with @c 1.0 meaning
1703 EAPI void elm_object_scale_set(Evas_Object *obj, double scale) EINA_ARG_NONNULL(1);
1706 * Get the scaling factor for a given Elementary object
1708 * @param obj The object
1709 * @return The scaling factor set by elm_object_scale_set()
1713 EAPI double elm_object_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1716 * @defgroup Password_last_show Password last input show
1718 * Last show feature of password mode enables user to view
1719 * the last input entered for few seconds before masking it.
1720 * These functions allow to set this feature in password mode
1721 * of entry widget and also allow to manipulate the duration
1722 * for which the input has to be visible.
1728 * Get show last setting of password mode.
1730 * This gets the show last input setting of password mode which might be
1731 * enabled or disabled.
1733 * @return @c EINA_TRUE, if the last input show setting is enabled, @c EINA_FALSE
1735 * @ingroup Password_last_show
1737 EAPI Eina_Bool elm_password_show_last_get(void);
1740 * Set show last setting in password mode.
1742 * This enables or disables show last setting of password mode.
1744 * @param password_show_last If EINA_TRUE enable's last input show in password mode.
1745 * @see elm_password_show_last_timeout_set()
1746 * @ingroup Password_last_show
1748 EAPI void elm_password_show_last_set(Eina_Bool password_show_last);
1751 * Get's the timeout value in last show password mode.
1753 * This gets the time out value for which the last input entered in password
1754 * mode will be visible.
1756 * @return The timeout value of last show password mode.
1757 * @ingroup Password_last_show
1759 EAPI double elm_password_show_last_timeout_get(void);
1762 * Set's the timeout value in last show password mode.
1764 * This sets the time out value for which the last input entered in password
1765 * mode will be visible.
1767 * @param password_show_last_timeout The timeout value.
1768 * @see elm_password_show_last_set()
1769 * @ingroup Password_last_show
1771 EAPI void elm_password_show_last_timeout_set(double password_show_last_timeout);
1778 * @defgroup UI-Mirroring Selective Widget mirroring
1780 * These functions allow you to set ui-mirroring on specific
1781 * widgets or the whole interface. Widgets can be in one of two
1782 * modes, automatic and manual. Automatic means they'll be changed
1783 * according to the system mirroring mode and manual means only
1784 * explicit changes will matter. You are not supposed to change
1785 * mirroring state of a widget set to automatic, will mostly work,
1786 * but the behavior is not really defined.
1791 EAPI Eina_Bool elm_mirrored_get(void);
1792 EAPI void elm_mirrored_set(Eina_Bool mirrored);
1795 * Get the system mirrored mode. This determines the default mirrored mode
1798 * @return EINA_TRUE if mirrored is set, EINA_FALSE otherwise
1800 EAPI Eina_Bool elm_object_mirrored_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1803 * Set the system mirrored mode. This determines the default mirrored mode
1806 * @param mirrored EINA_TRUE to set mirrored mode, EINA_FALSE to unset it.
1808 EAPI void elm_object_mirrored_set(Evas_Object *obj, Eina_Bool mirrored) EINA_ARG_NONNULL(1);
1811 * Returns the widget's mirrored mode setting.
1813 * @param obj The widget.
1814 * @return mirrored mode setting of the object.
1817 EAPI Eina_Bool elm_object_mirrored_automatic_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1820 * Sets the widget's mirrored mode setting.
1821 * When widget in automatic mode, it follows the system mirrored mode set by
1822 * elm_mirrored_set().
1823 * @param obj The widget.
1824 * @param automatic EINA_TRUE for auto mirrored mode. EINA_FALSE for manual.
1826 EAPI void elm_object_mirrored_automatic_set(Evas_Object *obj, Eina_Bool automatic) EINA_ARG_NONNULL(1);
1833 * Set the style to use by a widget
1835 * Sets the style name that will define the appearance of a widget. Styles
1836 * vary from widget to widget and may also be defined by other themes
1837 * by means of extensions and overlays.
1839 * @param obj The Elementary widget to style
1840 * @param style The style name to use
1842 * @see elm_theme_extension_add()
1843 * @see elm_theme_extension_del()
1844 * @see elm_theme_overlay_add()
1845 * @see elm_theme_overlay_del()
1849 EAPI void elm_object_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
1851 * Get the style used by the widget
1853 * This gets the style being used for that widget. Note that the string
1854 * pointer is only valid as longas the object is valid and the style doesn't
1857 * @param obj The Elementary widget to query for its style
1858 * @return The style name used
1860 * @see elm_object_style_set()
1864 EAPI const char *elm_object_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1867 * @defgroup Styles Styles
1869 * Widgets can have different styles of look. These generic API's
1870 * set styles of widgets, if they support them (and if the theme(s)
1873 * @ref general_functions_example_page "This" example contemplates
1874 * some of these functions.
1878 * Set the disabled state of an Elementary object.
1880 * @param obj The Elementary object to operate on
1881 * @param disabled The state to put in in: @c EINA_TRUE for
1882 * disabled, @c EINA_FALSE for enabled
1884 * Elementary objects can be @b disabled, in which state they won't
1885 * receive input and, in general, will be themed differently from
1886 * their normal state, usually greyed out. Useful for contexts
1887 * where you don't want your users to interact with some of the
1888 * parts of you interface.
1890 * This sets the state for the widget, either disabling it or
1895 EAPI void elm_object_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
1898 * Get the disabled state of an Elementary object.
1900 * @param obj The Elementary object to operate on
1901 * @return @c EINA_TRUE, if the widget is disabled, @c EINA_FALSE
1902 * if it's enabled (or on errors)
1904 * This gets the state of the widget, which might be enabled or disabled.
1908 EAPI Eina_Bool elm_object_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1911 * @defgroup WidgetNavigation Widget Tree Navigation.
1913 * How to check if an Evas Object is an Elementary widget? How to
1914 * get the first elementary widget that is parent of the given
1915 * object? These are all covered in widget tree navigation.
1917 * @ref general_functions_example_page "This" example contemplates
1918 * some of these functions.
1922 * Check if the given Evas Object is an Elementary widget.
1924 * @param obj the object to query.
1925 * @return @c EINA_TRUE if it is an elementary widget variant,
1926 * @c EINA_FALSE otherwise
1927 * @ingroup WidgetNavigation
1929 EAPI Eina_Bool elm_object_widget_check(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1932 * Get the first parent of the given object that is an Elementary
1935 * @param obj the Elementary object to query parent from.
1936 * @return the parent object that is an Elementary widget, or @c
1937 * NULL, if it was not found.
1939 * Use this to query for an object's parent widget.
1941 * @note Most of Elementary users wouldn't be mixing non-Elementary
1942 * smart objects in the objects tree of an application, as this is
1943 * an advanced usage of Elementary with Evas. So, except for the
1944 * application's window, which is the root of that tree, all other
1945 * objects would have valid Elementary widget parents.
1947 * @ingroup WidgetNavigation
1949 EAPI Evas_Object *elm_object_parent_widget_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1952 * Get the top level parent of an Elementary widget.
1954 * @param obj The object to query.
1955 * @return The top level Elementary widget, or @c NULL if parent cannot be
1957 * @ingroup WidgetNavigation
1959 EAPI Evas_Object *elm_object_top_widget_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1962 * Get the string that represents this Elementary widget.
1964 * @note Elementary is weird and exposes itself as a single
1965 * Evas_Object_Smart_Class of type "elm_widget", so
1966 * evas_object_type_get() always return that, making debug and
1967 * language bindings hard. This function tries to mitigate this
1968 * problem, but the solution is to change Elementary to use
1969 * proper inheritance.
1971 * @param obj the object to query.
1972 * @return Elementary widget name, or @c NULL if not a valid widget.
1973 * @ingroup WidgetNavigation
1975 EAPI const char *elm_object_widget_type_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1978 * @defgroup Config Elementary Config
1980 * Elementary configuration is formed by a set options bounded to a
1981 * given @ref Profile profile, like @ref Theme theme, @ref Fingers
1982 * "finger size", etc. These are functions with which one syncronizes
1983 * changes made to those values to the configuration storing files, de
1984 * facto. You most probably don't want to use the functions in this
1985 * group unlees you're writing an elementary configuration manager.
1991 * Save back Elementary's configuration, so that it will persist on
1994 * @return @c EINA_TRUE, when sucessful. @c EINA_FALSE, otherwise.
1997 * This function will take effect -- thus, do I/O -- immediately. Use
1998 * it when you want to apply all configuration changes at once. The
1999 * current configuration set will get saved onto the current profile
2000 * configuration file.
2003 EAPI Eina_Bool elm_config_save(void);
2006 * Reload Elementary's configuration, bounded to current selected
2009 * @return @c EINA_TRUE, when sucessful. @c EINA_FALSE, otherwise.
2012 * Useful when you want to force reloading of configuration values for
2013 * a profile. If one removes user custom configuration directories,
2014 * for example, it will force a reload with system values instead.
2017 EAPI void elm_config_reload(void);
2024 * @defgroup Profile Elementary Profile
2026 * Profiles are pre-set options that affect the whole look-and-feel of
2027 * Elementary-based applications. There are, for example, profiles
2028 * aimed at desktop computer applications and others aimed at mobile,
2029 * touchscreen-based ones. You most probably don't want to use the
2030 * functions in this group unlees you're writing an elementary
2031 * configuration manager.
2037 * Get Elementary's profile in use.
2039 * This gets the global profile that is applied to all Elementary
2042 * @return The profile's name
2045 EAPI const char *elm_profile_current_get(void);
2048 * Get an Elementary's profile directory path in the filesystem. One
2049 * may want to fetch a system profile's dir or an user one (fetched
2052 * @param profile The profile's name
2053 * @param is_user Whether to lookup for an user profile (@c EINA_TRUE)
2054 * or a system one (@c EINA_FALSE)
2055 * @return The profile's directory path.
2058 * @note You must free it with elm_profile_dir_free().
2060 EAPI const char *elm_profile_dir_get(const char *profile, Eina_Bool is_user);
2063 * Free an Elementary's profile directory path, as returned by
2064 * elm_profile_dir_get().
2066 * @param p_dir The profile's path
2070 EAPI void elm_profile_dir_free(const char *p_dir);
2073 * Get Elementary's list of available profiles.
2075 * @return The profiles list. List node data are the profile name
2079 * @note One must free this list, after usage, with the function
2080 * elm_profile_list_free().
2082 EAPI Eina_List *elm_profile_list_get(void);
2085 * Free Elementary's list of available profiles.
2087 * @param l The profiles list, as returned by elm_profile_list_get().
2091 EAPI void elm_profile_list_free(Eina_List *l);
2094 * Set Elementary's profile.
2096 * This sets the global profile that is applied to Elementary
2097 * applications. Just the process the call comes from will be
2100 * @param profile The profile's name
2104 EAPI void elm_profile_set(const char *profile);
2107 * Set Elementary's profile.
2109 * This sets the global profile that is applied to all Elementary
2110 * applications. All running Elementary windows will be affected.
2112 * @param profile The profile's name
2116 EAPI void elm_profile_all_set(const char *profile);
2123 * @defgroup Engine Elementary Engine
2125 * These are functions setting and querying which rendering engine
2126 * Elementary will use for drawing its windows' pixels.
2128 * The following are the available engines:
2129 * @li "software_x11"
2132 * @li "software_16_x11"
2133 * @li "software_8_x11"
2136 * @li "software_gdi"
2137 * @li "software_16_wince_gdi"
2139 * @li "software_16_sdl"
2143 * @li "opengl_cocoa"
2150 * @brief Get Elementary's rendering engine in use.
2152 * @return The rendering engine's name
2153 * @note there's no need to free the returned string, here.
2155 * This gets the global rendering engine that is applied to all Elementary
2158 * @see elm_engine_set()
2160 EAPI const char *elm_engine_current_get(void);
2163 * @brief Set Elementary's rendering engine for use.
2165 * @param engine The rendering engine's name
2167 * This sets global rendering engine that is applied to all Elementary
2168 * applications. Note that it will take effect only to Elementary windows
2169 * created after this is called.
2171 * @see elm_win_add()
2173 EAPI void elm_engine_set(const char *engine);
2180 * @defgroup Fonts Elementary Fonts
2182 * These are functions dealing with font rendering, selection and the
2183 * like for Elementary applications. One might fetch which system
2184 * fonts are there to use and set custom fonts for individual classes
2185 * of UI items containing text (text classes).
2190 typedef struct _Elm_Text_Class
2196 typedef struct _Elm_Font_Overlay
2198 const char *text_class;
2200 Evas_Font_Size size;
2203 typedef struct _Elm_Font_Properties
2207 } Elm_Font_Properties;
2210 * Get Elementary's list of supported text classes.
2212 * @return The text classes list, with @c Elm_Text_Class blobs as data.
2215 * Release the list with elm_text_classes_list_free().
2217 EAPI const Eina_List *elm_text_classes_list_get(void);
2220 * Free Elementary's list of supported text classes.
2224 * @see elm_text_classes_list_get().
2226 EAPI void elm_text_classes_list_free(const Eina_List *list);
2229 * Get Elementary's list of font overlays, set with
2230 * elm_font_overlay_set().
2232 * @return The font overlays list, with @c Elm_Font_Overlay blobs as
2237 * For each text class, one can set a <b>font overlay</b> for it,
2238 * overriding the default font properties for that class coming from
2239 * the theme in use. There is no need to free this list.
2241 * @see elm_font_overlay_set() and elm_font_overlay_unset().
2243 EAPI const Eina_List *elm_font_overlay_list_get(void);
2246 * Set a font overlay for a given Elementary text class.
2248 * @param text_class Text class name
2249 * @param font Font name and style string
2250 * @param size Font size
2254 * @p font has to be in the format returned by
2255 * elm_font_fontconfig_name_get(). @see elm_font_overlay_list_get()
2256 * and elm_font_overlay_unset().
2258 EAPI void elm_font_overlay_set(const char *text_class, const char *font, Evas_Font_Size size);
2261 * Unset a font overlay for a given Elementary text class.
2263 * @param text_class Text class name
2267 * This will bring back text elements belonging to text class
2268 * @p text_class back to their default font settings.
2270 EAPI void elm_font_overlay_unset(const char *text_class);
2273 * Apply the changes made with elm_font_overlay_set() and
2274 * elm_font_overlay_unset() on the current Elementary window.
2278 * This applies all font overlays set to all objects in the UI.
2280 EAPI void elm_font_overlay_apply(void);
2283 * Apply the changes made with elm_font_overlay_set() and
2284 * elm_font_overlay_unset() on all Elementary application windows.
2288 * This applies all font overlays set to all objects in the UI.
2290 EAPI void elm_font_overlay_all_apply(void);
2293 * Translate a font (family) name string in fontconfig's font names
2294 * syntax into an @c Elm_Font_Properties struct.
2296 * @param font The font name and styles string
2297 * @return the font properties struct
2301 * @note The reverse translation can be achived with
2302 * elm_font_fontconfig_name_get(), for one style only (single font
2303 * instance, not family).
2305 EAPI Elm_Font_Properties *elm_font_properties_get(const char *font) EINA_ARG_NONNULL(1);
2308 * Free font properties return by elm_font_properties_get().
2310 * @param efp the font properties struct
2314 EAPI void elm_font_properties_free(Elm_Font_Properties *efp) EINA_ARG_NONNULL(1);
2317 * Translate a font name, bound to a style, into fontconfig's font names
2320 * @param name The font (family) name
2321 * @param style The given style (may be @c NULL)
2323 * @return the font name and style string
2327 * @note The reverse translation can be achived with
2328 * elm_font_properties_get(), for one style only (single font
2329 * instance, not family).
2331 EAPI const char *elm_font_fontconfig_name_get(const char *name, const char *style) EINA_ARG_NONNULL(1);
2334 * Free the font string return by elm_font_fontconfig_name_get().
2336 * @param efp the font properties struct
2340 EAPI void elm_font_fontconfig_name_free(const char *name) EINA_ARG_NONNULL(1);
2343 * Create a font hash table of available system fonts.
2345 * One must call it with @p list being the return value of
2346 * evas_font_available_list(). The hash will be indexed by font
2347 * (family) names, being its values @c Elm_Font_Properties blobs.
2349 * @param list The list of available system fonts, as returned by
2350 * evas_font_available_list().
2351 * @return the font hash.
2355 * @note The user is supposed to get it populated at least with 3
2356 * default font families (Sans, Serif, Monospace), which should be
2357 * present on most systems.
2359 EAPI Eina_Hash *elm_font_available_hash_add(Eina_List *list);
2362 * Free the hash return by elm_font_available_hash_add().
2364 * @param hash the hash to be freed.
2368 EAPI void elm_font_available_hash_del(Eina_Hash *hash);
2375 * @defgroup Fingers Fingers
2377 * Elementary is designed to be finger-friendly for touchscreens,
2378 * and so in addition to scaling for display resolution, it can
2379 * also scale based on finger "resolution" (or size). You can then
2380 * customize the granularity of the areas meant to receive clicks
2383 * Different profiles may have pre-set values for finger sizes.
2385 * @ref general_functions_example_page "This" example contemplates
2386 * some of these functions.
2392 * Get the configured "finger size"
2394 * @return The finger size
2396 * This gets the globally configured finger size, <b>in pixels</b>
2400 EAPI Evas_Coord elm_finger_size_get(void);
2403 * Set the configured finger size
2405 * This sets the globally configured finger size in pixels
2407 * @param size The finger size
2410 EAPI void elm_finger_size_set(Evas_Coord size);
2413 * Set the configured finger size for all applications on the display
2415 * This sets the globally configured finger size in pixels for all
2416 * applications on the display
2418 * @param size The finger size
2421 EAPI void elm_finger_size_all_set(Evas_Coord size);
2428 * @defgroup Focus Focus
2430 * An Elementary application has, at all times, one (and only one)
2431 * @b focused object. This is what determines where the input
2432 * events go to within the application's window. Also, focused
2433 * objects can be decorated differently, in order to signal to the
2434 * user where the input is, at a given moment.
2436 * Elementary applications also have the concept of <b>focus
2437 * chain</b>: one can cycle through all the windows' focusable
2438 * objects by input (tab key) or programmatically. The default
2439 * focus chain for an application is the one define by the order in
2440 * which the widgets where added in code. One will cycle through
2441 * top level widgets, and, for each one containg sub-objects, cycle
2442 * through them all, before returning to the level
2443 * above. Elementary also allows one to set @b custom focus chains
2444 * for their applications.
2446 * Besides the focused decoration a widget may exhibit, when it
2447 * gets focus, Elementary has a @b global focus highlight object
2448 * that can be enabled for a window. If one chooses to do so, this
2449 * extra highlight effect will surround the current focused object,
2452 * @note Some Elementary widgets are @b unfocusable, after
2453 * creation, by their very nature: they are not meant to be
2454 * interacted with input events, but are there just for visual
2457 * @ref general_functions_example_page "This" example contemplates
2458 * some of these functions.
2462 * Get the enable status of the focus highlight
2464 * This gets whether the highlight on focused objects is enabled or not
2467 EAPI Eina_Bool elm_focus_highlight_enabled_get(void);
2470 * Set the enable status of the focus highlight
2472 * Set whether to show or not the highlight on focused objects
2473 * @param enable Enable highlight if EINA_TRUE, disable otherwise
2476 EAPI void elm_focus_highlight_enabled_set(Eina_Bool enable);
2479 * Get the enable status of the highlight animation
2481 * Get whether the focus highlight, if enabled, will animate its switch from
2482 * one object to the next
2485 EAPI Eina_Bool elm_focus_highlight_animate_get(void);
2488 * Set the enable status of the highlight animation
2490 * Set whether the focus highlight, if enabled, will animate its switch from
2491 * one object to the next
2492 * @param animate Enable animation if EINA_TRUE, disable otherwise
2495 EAPI void elm_focus_highlight_animate_set(Eina_Bool animate);
2498 * Get the whether an Elementary object has the focus or not.
2500 * @param obj The Elementary object to get the information from
2501 * @return @c EINA_TRUE, if the object is focused, @c EINA_FALSE if
2502 * not (and on errors).
2504 * @see elm_object_focus_set()
2508 EAPI Eina_Bool elm_object_focus_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2511 * Set/unset focus to a given Elementary object.
2513 * @param obj The Elementary object to operate on.
2514 * @param enable @c EINA_TRUE Set focus to a given object,
2515 * @c EINA_FALSE Unset focus to a given object.
2517 * @note When you set focus to this object, if it can handle focus, will
2518 * take the focus away from the one who had it previously and will, for
2519 * now on, be the one receiving input events. Unsetting focus will remove
2520 * the focus from @p obj, passing it back to the previous element in the
2523 * @see elm_object_focus_get(), elm_object_focus_custom_chain_get()
2527 EAPI void elm_object_focus_set(Evas_Object *obj, Eina_Bool focus) EINA_ARG_NONNULL(1);
2530 * Make a given Elementary object the focused one.
2532 * @param obj The Elementary object to make focused.
2534 * @note This object, if it can handle focus, will take the focus
2535 * away from the one who had it previously and will, for now on, be
2536 * the one receiving input events.
2538 * @see elm_object_focus_get()
2539 * @deprecated use elm_object_focus_set() instead.
2543 EINA_DEPRECATED EAPI void elm_object_focus(Evas_Object *obj) EINA_ARG_NONNULL(1);
2546 * Remove the focus from an Elementary object
2548 * @param obj The Elementary to take focus from
2550 * This removes the focus from @p obj, passing it back to the
2551 * previous element in the focus chain list.
2553 * @see elm_object_focus() and elm_object_focus_custom_chain_get()
2554 * @deprecated use elm_object_focus_set() instead.
2558 EINA_DEPRECATED EAPI void elm_object_unfocus(Evas_Object *obj) EINA_ARG_NONNULL(1);
2561 * Set the ability for an Element object to be focused
2563 * @param obj The Elementary object to operate on
2564 * @param enable @c EINA_TRUE if the object can be focused, @c
2565 * EINA_FALSE if not (and on errors)
2567 * This sets whether the object @p obj is able to take focus or
2568 * not. Unfocusable objects do nothing when programmatically
2569 * focused, being the nearest focusable parent object the one
2570 * really getting focus. Also, when they receive mouse input, they
2571 * will get the event, but not take away the focus from where it
2576 EAPI void elm_object_focus_allow_set(Evas_Object *obj, Eina_Bool enable) EINA_ARG_NONNULL(1);
2579 * Get whether an Elementary object is focusable or not
2581 * @param obj The Elementary object to operate on
2582 * @return @c EINA_TRUE if the object is allowed to be focused, @c
2583 * EINA_FALSE if not (and on errors)
2585 * @note Objects which are meant to be interacted with by input
2586 * events are created able to be focused, by default. All the
2591 EAPI Eina_Bool elm_object_focus_allow_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2594 * Set custom focus chain.
2596 * This function overwrites any previous custom focus chain within
2597 * the list of objects. The previous list will be deleted and this list
2598 * will be managed by elementary. After it is set, don't modify it.
2600 * @note On focus cycle, only will be evaluated children of this container.
2602 * @param obj The container object
2603 * @param objs Chain of objects to pass focus
2606 EAPI void elm_object_focus_custom_chain_set(Evas_Object *obj, Eina_List *objs) EINA_ARG_NONNULL(1);
2609 * Unset a custom focus chain on a given Elementary widget
2611 * @param obj The container object to remove focus chain from
2613 * Any focus chain previously set on @p obj (for its child objects)
2614 * is removed entirely after this call.
2618 EAPI void elm_object_focus_custom_chain_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
2621 * Get custom focus chain
2623 * @param obj The container object
2626 EAPI const Eina_List *elm_object_focus_custom_chain_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2629 * Append object to custom focus chain.
2631 * @note If relative_child equal to NULL or not in custom chain, the object
2632 * will be added in end.
2634 * @note On focus cycle, only will be evaluated children of this container.
2636 * @param obj The container object
2637 * @param child The child to be added in custom chain
2638 * @param relative_child The relative object to position the child
2641 EAPI void elm_object_focus_custom_chain_append(Evas_Object *obj, Evas_Object *child, Evas_Object *relative_child) EINA_ARG_NONNULL(1, 2);
2644 * Prepend object to custom focus chain.
2646 * @note If relative_child equal to NULL or not in custom chain, the object
2647 * will be added in begin.
2649 * @note On focus cycle, only will be evaluated children of this container.
2651 * @param obj The container object
2652 * @param child The child to be added in custom chain
2653 * @param relative_child The relative object to position the child
2656 EAPI void elm_object_focus_custom_chain_prepend(Evas_Object *obj, Evas_Object *child, Evas_Object *relative_child) EINA_ARG_NONNULL(1, 2);
2659 * Give focus to next object in object tree.
2661 * Give focus to next object in focus chain of one object sub-tree.
2662 * If the last object of chain already have focus, the focus will go to the
2663 * first object of chain.
2665 * @param obj The object root of sub-tree
2666 * @param dir Direction to cycle the focus
2670 EAPI void elm_object_focus_cycle(Evas_Object *obj, Elm_Focus_Direction dir) EINA_ARG_NONNULL(1);
2673 * Give focus to near object in one direction.
2675 * Give focus to near object in direction of one object.
2676 * If none focusable object in given direction, the focus will not change.
2678 * @param obj The reference object
2679 * @param x Horizontal component of direction to focus
2680 * @param y Vertical component of direction to focus
2684 EAPI void elm_object_focus_direction_go(Evas_Object *obj, int x, int y) EINA_ARG_NONNULL(1);
2687 * Make the elementary object and its children to be unfocusable
2690 * @param obj The Elementary object to operate on
2691 * @param tree_unfocusable @c EINA_TRUE for unfocusable,
2692 * @c EINA_FALSE for focusable.
2694 * This sets whether the object @p obj and its children objects
2695 * are able to take focus or not. If the tree is set as unfocusable,
2696 * newest focused object which is not in this tree will get focus.
2697 * This API can be helpful for an object to be deleted.
2698 * When an object will be deleted soon, it and its children may not
2699 * want to get focus (by focus reverting or by other focus controls).
2700 * Then, just use this API before deleting.
2702 * @see elm_object_tree_unfocusable_get()
2706 EAPI void elm_object_tree_unfocusable_set(Evas_Object *obj, Eina_Bool tree_unfocusable) EINA_ARG_NONNULL(1);
2709 * Get whether an Elementary object and its children are unfocusable or not.
2711 * @param obj The Elementary object to get the information from
2712 * @return @c EINA_TRUE, if the tree is unfocussable,
2713 * @c EINA_FALSE if not (and on errors).
2715 * @see elm_object_tree_unfocusable_set()
2719 EAPI Eina_Bool elm_object_tree_unfocusable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2722 * @defgroup Scrolling Scrolling
2724 * These are functions setting how scrollable views in Elementary
2725 * widgets should behave on user interaction.
2731 * Get whether scrollers should bounce when they reach their
2732 * viewport's edge during a scroll.
2734 * @return the thumb scroll bouncing state
2736 * This is the default behavior for touch screens, in general.
2737 * @ingroup Scrolling
2739 EAPI Eina_Bool elm_scroll_bounce_enabled_get(void);
2742 * Set whether scrollers should bounce when they reach their
2743 * viewport's edge during a scroll.
2745 * @param enabled the thumb scroll bouncing state
2747 * @see elm_thumbscroll_bounce_enabled_get()
2748 * @ingroup Scrolling
2750 EAPI void elm_scroll_bounce_enabled_set(Eina_Bool enabled);
2753 * Set whether scrollers should bounce when they reach their
2754 * viewport's edge during a scroll, for all Elementary application
2757 * @param enabled the thumb scroll bouncing state
2759 * @see elm_thumbscroll_bounce_enabled_get()
2760 * @ingroup Scrolling
2762 EAPI void elm_scroll_bounce_enabled_all_set(Eina_Bool enabled);
2765 * Get the amount of inertia a scroller will impose at bounce
2768 * @return the thumb scroll bounce friction
2770 * @ingroup Scrolling
2772 EAPI double elm_scroll_bounce_friction_get(void);
2775 * Set the amount of inertia a scroller will impose at bounce
2778 * @param friction the thumb scroll bounce friction
2780 * @see elm_thumbscroll_bounce_friction_get()
2781 * @ingroup Scrolling
2783 EAPI void elm_scroll_bounce_friction_set(double friction);
2786 * Set the amount of inertia a scroller will impose at bounce
2787 * animations, for all Elementary application windows.
2789 * @param friction the thumb scroll bounce friction
2791 * @see elm_thumbscroll_bounce_friction_get()
2792 * @ingroup Scrolling
2794 EAPI void elm_scroll_bounce_friction_all_set(double friction);
2797 * Get the amount of inertia a <b>paged</b> scroller will impose at
2798 * page fitting animations.
2800 * @return the page scroll friction
2802 * @ingroup Scrolling
2804 EAPI double elm_scroll_page_scroll_friction_get(void);
2807 * Set the amount of inertia a <b>paged</b> scroller will impose at
2808 * page fitting animations.
2810 * @param friction the page scroll friction
2812 * @see elm_thumbscroll_page_scroll_friction_get()
2813 * @ingroup Scrolling
2815 EAPI void elm_scroll_page_scroll_friction_set(double friction);
2818 * Set the amount of inertia a <b>paged</b> scroller will impose at
2819 * page fitting animations, for all Elementary application windows.
2821 * @param friction the page scroll friction
2823 * @see elm_thumbscroll_page_scroll_friction_get()
2824 * @ingroup Scrolling
2826 EAPI void elm_scroll_page_scroll_friction_all_set(double friction);
2829 * Get the amount of inertia a scroller will impose at region bring
2832 * @return the bring in scroll friction
2834 * @ingroup Scrolling
2836 EAPI double elm_scroll_bring_in_scroll_friction_get(void);
2839 * Set the amount of inertia a scroller will impose at region bring
2842 * @param friction the bring in scroll friction
2844 * @see elm_thumbscroll_bring_in_scroll_friction_get()
2845 * @ingroup Scrolling
2847 EAPI void elm_scroll_bring_in_scroll_friction_set(double friction);
2850 * Set the amount of inertia a scroller will impose at region bring
2851 * animations, for all Elementary application windows.
2853 * @param friction the bring in scroll friction
2855 * @see elm_thumbscroll_bring_in_scroll_friction_get()
2856 * @ingroup Scrolling
2858 EAPI void elm_scroll_bring_in_scroll_friction_all_set(double friction);
2861 * Get the amount of inertia scrollers will impose at animations
2862 * triggered by Elementary widgets' zooming API.
2864 * @return the zoom friction
2866 * @ingroup Scrolling
2868 EAPI double elm_scroll_zoom_friction_get(void);
2871 * Set the amount of inertia scrollers will impose at animations
2872 * triggered by Elementary widgets' zooming API.
2874 * @param friction the zoom friction
2876 * @see elm_thumbscroll_zoom_friction_get()
2877 * @ingroup Scrolling
2879 EAPI void elm_scroll_zoom_friction_set(double friction);
2882 * Set the amount of inertia scrollers will impose at animations
2883 * triggered by Elementary widgets' zooming API, for all Elementary
2884 * application windows.
2886 * @param friction the zoom friction
2888 * @see elm_thumbscroll_zoom_friction_get()
2889 * @ingroup Scrolling
2891 EAPI void elm_scroll_zoom_friction_all_set(double friction);
2894 * Get whether scrollers should be draggable from any point in their
2897 * @return the thumb scroll state
2899 * @note This is the default behavior for touch screens, in general.
2900 * @note All other functions namespaced with "thumbscroll" will only
2901 * have effect if this mode is enabled.
2903 * @ingroup Scrolling
2905 EAPI Eina_Bool elm_scroll_thumbscroll_enabled_get(void);
2908 * Set whether scrollers should be draggable from any point in their
2911 * @param enabled the thumb scroll state
2913 * @see elm_thumbscroll_enabled_get()
2914 * @ingroup Scrolling
2916 EAPI void elm_scroll_thumbscroll_enabled_set(Eina_Bool enabled);
2919 * Set whether scrollers should be draggable from any point in their
2920 * views, for all Elementary application windows.
2922 * @param enabled the thumb scroll state
2924 * @see elm_thumbscroll_enabled_get()
2925 * @ingroup Scrolling
2927 EAPI void elm_scroll_thumbscroll_enabled_all_set(Eina_Bool enabled);
2930 * Get the number of pixels one should travel while dragging a
2931 * scroller's view to actually trigger scrolling.
2933 * @return the thumb scroll threshould
2935 * One would use higher values for touch screens, in general, because
2936 * of their inherent imprecision.
2937 * @ingroup Scrolling
2939 EAPI unsigned int elm_scroll_thumbscroll_threshold_get(void);
2942 * Set the number of pixels one should travel while dragging a
2943 * scroller's view to actually trigger scrolling.
2945 * @param threshold the thumb scroll threshould
2947 * @see elm_thumbscroll_threshould_get()
2948 * @ingroup Scrolling
2950 EAPI void elm_scroll_thumbscroll_threshold_set(unsigned int threshold);
2953 * Set the number of pixels one should travel while dragging a
2954 * scroller's view to actually trigger scrolling, for all Elementary
2955 * application windows.
2957 * @param threshold the thumb scroll threshould
2959 * @see elm_thumbscroll_threshould_get()
2960 * @ingroup Scrolling
2962 EAPI void elm_scroll_thumbscroll_threshold_all_set(unsigned int threshold);
2965 * Get the minimum speed of mouse cursor movement which will trigger
2966 * list self scrolling animation after a mouse up event
2969 * @return the thumb scroll momentum threshould
2971 * @ingroup Scrolling
2973 EAPI double elm_scroll_thumbscroll_momentum_threshold_get(void);
2976 * Set the minimum speed of mouse cursor movement which will trigger
2977 * list self scrolling animation after a mouse up event
2980 * @param threshold the thumb scroll momentum threshould
2982 * @see elm_thumbscroll_momentum_threshould_get()
2983 * @ingroup Scrolling
2985 EAPI void elm_scroll_thumbscroll_momentum_threshold_set(double threshold);
2988 * Set the minimum speed of mouse cursor movement which will trigger
2989 * list self scrolling animation after a mouse up event
2990 * (pixels/second), for all Elementary application windows.
2992 * @param threshold the thumb scroll momentum threshould
2994 * @see elm_thumbscroll_momentum_threshould_get()
2995 * @ingroup Scrolling
2997 EAPI void elm_scroll_thumbscroll_momentum_threshold_all_set(double threshold);
3000 * Get the amount of inertia a scroller will impose at self scrolling
3003 * @return the thumb scroll friction
3005 * @ingroup Scrolling
3007 EAPI double elm_scroll_thumbscroll_friction_get(void);
3010 * Set the amount of inertia a scroller will impose at self scrolling
3013 * @param friction the thumb scroll friction
3015 * @see elm_thumbscroll_friction_get()
3016 * @ingroup Scrolling
3018 EAPI void elm_scroll_thumbscroll_friction_set(double friction);
3021 * Set the amount of inertia a scroller will impose at self scrolling
3022 * animations, for all Elementary application windows.
3024 * @param friction the thumb scroll friction
3026 * @see elm_thumbscroll_friction_get()
3027 * @ingroup Scrolling
3029 EAPI void elm_scroll_thumbscroll_friction_all_set(double friction);
3032 * Get the amount of lag between your actual mouse cursor dragging
3033 * movement and a scroller's view movement itself, while pushing it
3034 * into bounce state manually.
3036 * @return the thumb scroll border friction
3038 * @ingroup Scrolling
3040 EAPI double elm_scroll_thumbscroll_border_friction_get(void);
3043 * Set the amount of lag between your actual mouse cursor dragging
3044 * movement and a scroller's view movement itself, while pushing it
3045 * into bounce state manually.
3047 * @param friction the thumb scroll border friction. @c 0.0 for
3048 * perfect synchrony between two movements, @c 1.0 for maximum
3051 * @see elm_thumbscroll_border_friction_get()
3052 * @note parameter value will get bound to 0.0 - 1.0 interval, always
3054 * @ingroup Scrolling
3056 EAPI void elm_scroll_thumbscroll_border_friction_set(double friction);
3059 * Set the amount of lag between your actual mouse cursor dragging
3060 * movement and a scroller's view movement itself, while pushing it
3061 * into bounce state manually, for all Elementary application windows.
3063 * @param friction the thumb scroll border friction. @c 0.0 for
3064 * perfect synchrony between two movements, @c 1.0 for maximum
3067 * @see elm_thumbscroll_border_friction_get()
3068 * @note parameter value will get bound to 0.0 - 1.0 interval, always
3070 * @ingroup Scrolling
3072 EAPI void elm_scroll_thumbscroll_border_friction_all_set(double friction);
3075 * Get the sensitivity amount which is be multiplied by the length of
3078 * @return the thumb scroll sensitivity friction
3080 * @ingroup Scrolling
3082 EAPI double elm_scroll_thumbscroll_sensitivity_friction_get(void);
3085 * Set the sensitivity amount which is be multiplied by the length of
3088 * @param friction the thumb scroll sensitivity friction. @c 0.1 for
3089 * minimun sensitivity, @c 1.0 for maximum sensitivity. 0.25
3092 * @see elm_thumbscroll_sensitivity_friction_get()
3093 * @note parameter value will get bound to 0.1 - 1.0 interval, always
3095 * @ingroup Scrolling
3097 EAPI void elm_scroll_thumbscroll_sensitivity_friction_set(double friction);
3100 * Set the sensitivity amount which is be multiplied by the length of
3101 * mouse dragging, for all Elementary application windows.
3103 * @param friction the thumb scroll sensitivity friction. @c 0.1 for
3104 * minimun sensitivity, @c 1.0 for maximum sensitivity. 0.25
3107 * @see elm_thumbscroll_sensitivity_friction_get()
3108 * @note parameter value will get bound to 0.1 - 1.0 interval, always
3110 * @ingroup Scrolling
3112 EAPI void elm_scroll_thumbscroll_sensitivity_friction_all_set(double friction);
3119 * @defgroup Scrollhints Scrollhints
3121 * Objects when inside a scroller can scroll, but this may not always be
3122 * desirable in certain situations. This allows an object to hint to itself
3123 * and parents to "not scroll" in one of 2 ways. If any child object of a
3124 * scroller has pushed a scroll freeze or hold then it affects all parent
3125 * scrollers until all children have released them.
3127 * 1. To hold on scrolling. This means just flicking and dragging may no
3128 * longer scroll, but pressing/dragging near an edge of the scroller will
3129 * still scroll. This is automatically used by the entry object when
3132 * 2. To totally freeze scrolling. This means it stops. until
3139 * Push the scroll hold by 1
3141 * This increments the scroll hold count by one. If it is more than 0 it will
3142 * take effect on the parents of the indicated object.
3144 * @param obj The object
3145 * @ingroup Scrollhints
3147 EAPI void elm_object_scroll_hold_push(Evas_Object *obj) EINA_ARG_NONNULL(1);
3150 * Pop the scroll hold by 1
3152 * This decrements the scroll hold count by one. If it is more than 0 it will
3153 * take effect on the parents of the indicated object.
3155 * @param obj The object
3156 * @ingroup Scrollhints
3158 EAPI void elm_object_scroll_hold_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
3161 * Push the scroll freeze by 1
3163 * This increments the scroll freeze count by one. If it is more
3164 * than 0 it will take effect on the parents of the indicated
3167 * @param obj The object
3168 * @ingroup Scrollhints
3170 EAPI void elm_object_scroll_freeze_push(Evas_Object *obj) EINA_ARG_NONNULL(1);
3173 * Pop the scroll freeze by 1
3175 * This decrements the scroll freeze count by one. If it is more
3176 * than 0 it will take effect on the parents of the indicated
3179 * @param obj The object
3180 * @ingroup Scrollhints
3182 EAPI void elm_object_scroll_freeze_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
3185 * Lock the scrolling of the given widget (and thus all parents)
3187 * This locks the given object from scrolling in the X axis (and implicitly
3188 * also locks all parent scrollers too from doing the same).
3190 * @param obj The object
3191 * @param lock The lock state (1 == locked, 0 == unlocked)
3192 * @ingroup Scrollhints
3194 EAPI void elm_object_scroll_lock_x_set(Evas_Object *obj, Eina_Bool lock) EINA_ARG_NONNULL(1);
3197 * Lock the scrolling of the given widget (and thus all parents)
3199 * This locks the given object from scrolling in the Y axis (and implicitly
3200 * also locks all parent scrollers too from doing the same).
3202 * @param obj The object
3203 * @param lock The lock state (1 == locked, 0 == unlocked)
3204 * @ingroup Scrollhints
3206 EAPI void elm_object_scroll_lock_y_set(Evas_Object *obj, Eina_Bool lock) EINA_ARG_NONNULL(1);
3209 * Get the scrolling lock of the given widget
3211 * This gets the lock for X axis scrolling.
3213 * @param obj The object
3214 * @ingroup Scrollhints
3216 EAPI Eina_Bool elm_object_scroll_lock_x_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3219 * Get the scrolling lock of the given widget
3221 * This gets the lock for X axis scrolling.
3223 * @param obj The object
3224 * @ingroup Scrollhints
3226 EAPI Eina_Bool elm_object_scroll_lock_y_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3233 * Send a signal to the widget edje object.
3235 * This function sends a signal to the edje object of the obj. An
3236 * edje program can respond to a signal by specifying matching
3237 * 'signal' and 'source' fields.
3239 * @param obj The object
3240 * @param emission The signal's name.
3241 * @param source The signal's source.
3244 EAPI void elm_object_signal_emit(Evas_Object *obj, const char *emission, const char *source) EINA_ARG_NONNULL(1);
3247 * Add a callback for a signal emitted by widget edje object.
3249 * This function connects a callback function to a signal emitted by the
3250 * edje object of the obj.
3251 * Globs can occur in either the emission or source name.
3253 * @param obj The object
3254 * @param emission The signal's name.
3255 * @param source The signal's source.
3256 * @param func The callback function to be executed when the signal is
3258 * @param data A pointer to data to pass in to the callback function.
3261 EAPI void elm_object_signal_callback_add(Evas_Object *obj, const char *emission, const char *source, Edje_Signal_Cb func, void *data) EINA_ARG_NONNULL(1, 4);
3264 * Remove a signal-triggered callback from a widget edje object.
3266 * This function removes a callback, previoulsy attached to a
3267 * signal emitted by the edje object of the obj. The parameters
3268 * emission, source and func must match exactly those passed to a
3269 * previous call to elm_object_signal_callback_add(). The data
3270 * pointer that was passed to this call will be returned.
3272 * @param obj The object
3273 * @param emission The signal's name.
3274 * @param source The signal's source.
3275 * @param func The callback function to be executed when the signal is
3277 * @return The data pointer
3280 EAPI void *elm_object_signal_callback_del(Evas_Object *obj, const char *emission, const char *source, Edje_Signal_Cb func) EINA_ARG_NONNULL(1, 4);
3283 * Add a callback for input events (key up, key down, mouse wheel)
3284 * on a given Elementary widget
3286 * @param obj The widget to add an event callback on
3287 * @param func The callback function to be executed when the event
3289 * @param data Data to pass in to @p func
3291 * Every widget in an Elementary interface set to receive focus,
3292 * with elm_object_focus_allow_set(), will propagate @b all of its
3293 * key up, key down and mouse wheel input events up to its parent
3294 * object, and so on. All of the focusable ones in this chain which
3295 * had an event callback set, with this call, will be able to treat
3296 * those events. There are two ways of making the propagation of
3297 * these event upwards in the tree of widgets to @b cease:
3298 * - Just return @c EINA_TRUE on @p func. @c EINA_FALSE will mean
3299 * the event was @b not processed, so the propagation will go on.
3300 * - The @c event_info pointer passed to @p func will contain the
3301 * event's structure and, if you OR its @c event_flags inner
3302 * value to @c EVAS_EVENT_FLAG_ON_HOLD, you're telling Elementary
3303 * one has already handled it, thus killing the event's
3306 * @note Your event callback will be issued on those events taking
3307 * place only if no other child widget of @obj has consumed the
3310 * @note Not to be confused with @c
3311 * evas_object_event_callback_add(), which will add event callbacks
3312 * per type on general Evas objects (no event propagation
3313 * infrastructure taken in account).
3315 * @note Not to be confused with @c
3316 * elm_object_signal_callback_add(), which will add callbacks to @b
3317 * signals coming from a widget's theme, not input events.
3319 * @note Not to be confused with @c
3320 * edje_object_signal_callback_add(), which does the same as
3321 * elm_object_signal_callback_add(), but directly on an Edje
3324 * @note Not to be confused with @c
3325 * evas_object_smart_callback_add(), which adds callbacks to smart
3326 * objects' <b>smart events</b>, and not input events.
3328 * @see elm_object_event_callback_del()
3332 EAPI void elm_object_event_callback_add(Evas_Object *obj, Elm_Event_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
3335 * Remove an event callback from a widget.
3337 * This function removes a callback, previoulsy attached to event emission
3339 * The parameters func and data must match exactly those passed to
3340 * a previous call to elm_object_event_callback_add(). The data pointer that
3341 * was passed to this call will be returned.
3343 * @param obj The object
3344 * @param func The callback function to be executed when the event is
3346 * @param data Data to pass in to the callback function.
3347 * @return The data pointer
3350 EAPI void *elm_object_event_callback_del(Evas_Object *obj, Elm_Event_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
3353 * Adjust size of an element for finger usage.
3355 * @param times_w How many fingers should fit horizontally
3356 * @param w Pointer to the width size to adjust
3357 * @param times_h How many fingers should fit vertically
3358 * @param h Pointer to the height size to adjust
3360 * This takes width and height sizes (in pixels) as input and a
3361 * size multiple (which is how many fingers you want to place
3362 * within the area, being "finger" the size set by
3363 * elm_finger_size_set()), and adjusts the size to be large enough
3364 * to accommodate the resulting size -- if it doesn't already
3365 * accommodate it. On return the @p w and @p h sizes pointed to by
3366 * these parameters will be modified, on those conditions.
3368 * @note This is kind of a low level Elementary call, most useful
3369 * on size evaluation times for widgets. An external user wouldn't
3370 * be calling, most of the time.
3374 EAPI void elm_coords_finger_size_adjust(int times_w, Evas_Coord *w, int times_h, Evas_Coord *h);
3377 * Get the duration for occuring long press event.
3379 * @return Timeout for long press event
3380 * @ingroup Longpress
3382 EAPI double elm_longpress_timeout_get(void);
3385 * Set the duration for occuring long press event.
3387 * @param lonpress_timeout Timeout for long press event
3388 * @ingroup Longpress
3390 EAPI void elm_longpress_timeout_set(double longpress_timeout);
3393 * @defgroup Debug Debug
3394 * don't use it unless you are sure
3400 * Print Tree object hierarchy in stdout
3402 * @param obj The root object
3405 EAPI void elm_object_tree_dump(const Evas_Object *top);
3408 * Print Elm Objects tree hierarchy in file as dot(graphviz) syntax.
3410 * @param obj The root object
3411 * @param file The path of output file
3414 EAPI void elm_object_tree_dot_dump(const Evas_Object *top, const char *file);
3421 * @defgroup Theme Theme
3423 * Elementary uses Edje to theme its widgets, naturally. But for the most
3424 * part this is hidden behind a simpler interface that lets the user set
3425 * extensions and choose the style of widgets in a much easier way.
3427 * Instead of thinking in terms of paths to Edje files and their groups
3428 * each time you want to change the appearance of a widget, Elementary
3429 * works so you can add any theme file with extensions or replace the
3430 * main theme at one point in the application, and then just set the style
3431 * of widgets with elm_object_style_set() and related functions. Elementary
3432 * will then look in its list of themes for a matching group and apply it,
3433 * and when the theme changes midway through the application, all widgets
3434 * will be updated accordingly.
3436 * There are three concepts you need to know to understand how Elementary
3437 * theming works: default theme, extensions and overlays.
3439 * Default theme, obviously enough, is the one that provides the default
3440 * look of all widgets. End users can change the theme used by Elementary
3441 * by setting the @c ELM_THEME environment variable before running an
3442 * application, or globally for all programs using the @c elementary_config
3443 * utility. Applications can change the default theme using elm_theme_set(),
3444 * but this can go against the user wishes, so it's not an adviced practice.
3446 * Ideally, applications should find everything they need in the already
3447 * provided theme, but there may be occasions when that's not enough and
3448 * custom styles are required to correctly express the idea. For this
3449 * cases, Elementary has extensions.
3451 * Extensions allow the application developer to write styles of its own
3452 * to apply to some widgets. This requires knowledge of how each widget
3453 * is themed, as extensions will always replace the entire group used by
3454 * the widget, so important signals and parts need to be there for the
3455 * object to behave properly (see documentation of Edje for details).
3456 * Once the theme for the extension is done, the application needs to add
3457 * it to the list of themes Elementary will look into, using
3458 * elm_theme_extension_add(), and set the style of the desired widgets as
3459 * he would normally with elm_object_style_set().
3461 * Overlays, on the other hand, can replace the look of all widgets by
3462 * overriding the default style. Like extensions, it's up to the application
3463 * developer to write the theme for the widgets it wants, the difference
3464 * being that when looking for the theme, Elementary will check first the
3465 * list of overlays, then the set theme and lastly the list of extensions,
3466 * so with overlays it's possible to replace the default view and every
3467 * widget will be affected. This is very much alike to setting the whole
3468 * theme for the application and will probably clash with the end user
3469 * options, not to mention the risk of ending up with not matching styles
3470 * across the program. Unless there's a very special reason to use them,
3471 * overlays should be avoided for the resons exposed before.
3473 * All these theme lists are handled by ::Elm_Theme instances. Elementary
3474 * keeps one default internally and every function that receives one of
3475 * these can be called with NULL to refer to this default (except for
3476 * elm_theme_free()). It's possible to create a new instance of a
3477 * ::Elm_Theme to set other theme for a specific widget (and all of its
3478 * children), but this is as discouraged, if not even more so, than using
3479 * overlays. Don't use this unless you really know what you are doing.
3481 * But to be less negative about things, you can look at the following
3483 * @li @ref theme_example_01 "Using extensions"
3484 * @li @ref theme_example_02 "Using overlays"
3489 * @typedef Elm_Theme
3491 * Opaque handler for the list of themes Elementary looks for when
3492 * rendering widgets.
3494 * Stay out of this unless you really know what you are doing. For most
3495 * cases, sticking to the default is all a developer needs.
3497 typedef struct _Elm_Theme Elm_Theme;
3500 * Create a new specific theme
3502 * This creates an empty specific theme that only uses the default theme. A
3503 * specific theme has its own private set of extensions and overlays too
3504 * (which are empty by default). Specific themes do not fall back to themes
3505 * of parent objects. They are not intended for this use. Use styles, overlays
3506 * and extensions when needed, but avoid specific themes unless there is no
3507 * other way (example: you want to have a preview of a new theme you are
3508 * selecting in a "theme selector" window. The preview is inside a scroller
3509 * and should display what the theme you selected will look like, but not
3510 * actually apply it yet. The child of the scroller will have a specific
3511 * theme set to show this preview before the user decides to apply it to all
3514 EAPI Elm_Theme *elm_theme_new(void);
3516 * Free a specific theme
3518 * @param th The theme to free
3520 * This frees a theme created with elm_theme_new().
3522 EAPI void elm_theme_free(Elm_Theme *th);
3524 * Copy the theme fom the source to the destination theme
3526 * @param th The source theme to copy from
3527 * @param thdst The destination theme to copy data to
3529 * This makes a one-time static copy of all the theme config, extensions
3530 * and overlays from @p th to @p thdst. If @p th references a theme, then
3531 * @p thdst is also set to reference it, with all the theme settings,
3532 * overlays and extensions that @p th had.
3534 EAPI void elm_theme_copy(Elm_Theme *th, Elm_Theme *thdst);
3536 * Tell the source theme to reference the ref theme
3538 * @param th The theme that will do the referencing
3539 * @param thref The theme that is the reference source
3541 * This clears @p th to be empty and then sets it to refer to @p thref
3542 * so @p th acts as an override to @p thref, but where its overrides
3543 * don't apply, it will fall through to @p thref for configuration.
3545 EAPI void elm_theme_ref_set(Elm_Theme *th, Elm_Theme *thref);
3547 * Return the theme referred to
3549 * @param th The theme to get the reference from
3550 * @return The referenced theme handle
3552 * This gets the theme set as the reference theme by elm_theme_ref_set().
3553 * If no theme is set as a reference, NULL is returned.
3555 EAPI Elm_Theme *elm_theme_ref_get(Elm_Theme *th);
3557 * Return the default theme
3559 * @return The default theme handle
3561 * This returns the internal default theme setup handle that all widgets
3562 * use implicitly unless a specific theme is set. This is also often use
3563 * as a shorthand of NULL.
3565 EAPI Elm_Theme *elm_theme_default_get(void);
3567 * Prepends a theme overlay to the list of overlays
3569 * @param th The theme to add to, or if NULL, the default theme
3570 * @param item The Edje file path to be used
3572 * Use this if your application needs to provide some custom overlay theme
3573 * (An Edje file that replaces some default styles of widgets) where adding
3574 * new styles, or changing system theme configuration is not possible. Do
3575 * NOT use this instead of a proper system theme configuration. Use proper
3576 * configuration files, profiles, environment variables etc. to set a theme
3577 * so that the theme can be altered by simple confiugration by a user. Using
3578 * this call to achieve that effect is abusing the API and will create lots
3581 * @see elm_theme_extension_add()
3583 EAPI void elm_theme_overlay_add(Elm_Theme *th, const char *item);
3585 * Delete a theme overlay from the list of overlays
3587 * @param th The theme to delete from, or if NULL, the default theme
3588 * @param item The name of the theme overlay
3590 * @see elm_theme_overlay_add()
3592 EAPI void elm_theme_overlay_del(Elm_Theme *th, const char *item);
3594 * Appends a theme extension to the list of extensions.
3596 * @param th The theme to add to, or if NULL, the default theme
3597 * @param item The Edje file path to be used
3599 * This is intended when an application needs more styles of widgets or new
3600 * widget themes that the default does not provide (or may not provide). The
3601 * application has "extended" usage by coming up with new custom style names
3602 * for widgets for specific uses, but as these are not "standard", they are
3603 * not guaranteed to be provided by a default theme. This means the
3604 * application is required to provide these extra elements itself in specific
3605 * Edje files. This call adds one of those Edje files to the theme search
3606 * path to be search after the default theme. The use of this call is
3607 * encouraged when default styles do not meet the needs of the application.
3608 * Use this call instead of elm_theme_overlay_add() for almost all cases.
3610 * @see elm_object_style_set()
3612 EAPI void elm_theme_extension_add(Elm_Theme *th, const char *item);
3614 * Deletes a theme extension from the list of extensions.
3616 * @param th The theme to delete from, or if NULL, the default theme
3617 * @param item The name of the theme extension
3619 * @see elm_theme_extension_add()
3621 EAPI void elm_theme_extension_del(Elm_Theme *th, const char *item);
3623 * Set the theme search order for the given theme
3625 * @param th The theme to set the search order, or if NULL, the default theme
3626 * @param theme Theme search string
3628 * This sets the search string for the theme in path-notation from first
3629 * theme to search, to last, delimited by the : character. Example:
3631 * "shiny:/path/to/file.edj:default"
3633 * See the ELM_THEME environment variable for more information.
3635 * @see elm_theme_get()
3636 * @see elm_theme_list_get()
3638 EAPI void elm_theme_set(Elm_Theme *th, const char *theme);
3640 * Return the theme search order
3642 * @param th The theme to get the search order, or if NULL, the default theme
3643 * @return The internal search order path
3645 * This function returns a colon separated string of theme elements as
3646 * returned by elm_theme_list_get().
3648 * @see elm_theme_set()
3649 * @see elm_theme_list_get()
3651 EAPI const char *elm_theme_get(Elm_Theme *th);
3653 * Return a list of theme elements to be used in a theme.
3655 * @param th Theme to get the list of theme elements from.
3656 * @return The internal list of theme elements
3658 * This returns the internal list of theme elements (will only be valid as
3659 * long as the theme is not modified by elm_theme_set() or theme is not
3660 * freed by elm_theme_free(). This is a list of strings which must not be
3661 * altered as they are also internal. If @p th is NULL, then the default
3662 * theme element list is returned.
3664 * A theme element can consist of a full or relative path to a .edj file,
3665 * or a name, without extension, for a theme to be searched in the known
3666 * theme paths for Elemementary.
3668 * @see elm_theme_set()
3669 * @see elm_theme_get()
3671 EAPI const Eina_List *elm_theme_list_get(const Elm_Theme *th);
3673 * Return the full patrh for a theme element
3675 * @param f The theme element name
3676 * @param in_search_path Pointer to a boolean to indicate if item is in the search path or not
3677 * @return The full path to the file found.
3679 * This returns a string you should free with free() on success, NULL on
3680 * failure. This will search for the given theme element, and if it is a
3681 * full or relative path element or a simple searchable name. The returned
3682 * path is the full path to the file, if searched, and the file exists, or it
3683 * is simply the full path given in the element or a resolved path if
3684 * relative to home. The @p in_search_path boolean pointed to is set to
3685 * EINA_TRUE if the file was a searchable file andis in the search path,
3686 * and EINA_FALSE otherwise.
3688 EAPI char *elm_theme_list_item_path_get(const char *f, Eina_Bool *in_search_path);
3690 * Flush the current theme.
3692 * @param th Theme to flush
3694 * This flushes caches that let elementary know where to find theme elements
3695 * in the given theme. If @p th is NULL, then the default theme is flushed.
3696 * Call this function if source theme data has changed in such a way as to
3697 * make any caches Elementary kept invalid.
3699 EAPI void elm_theme_flush(Elm_Theme *th);
3701 * This flushes all themes (default and specific ones).
3703 * This will flush all themes in the current application context, by calling
3704 * elm_theme_flush() on each of them.
3706 EAPI void elm_theme_full_flush(void);
3708 * Set the theme for all elementary using applications on the current display
3710 * @param theme The name of the theme to use. Format same as the ELM_THEME
3711 * environment variable.
3713 EAPI void elm_theme_all_set(const char *theme);
3715 * Return a list of theme elements in the theme search path
3717 * @return A list of strings that are the theme element names.
3719 * This lists all available theme files in the standard Elementary search path
3720 * for theme elements, and returns them in alphabetical order as theme
3721 * element names in a list of strings. Free this with
3722 * elm_theme_name_available_list_free() when you are done with the list.
3724 EAPI Eina_List *elm_theme_name_available_list_new(void);
3726 * Free the list returned by elm_theme_name_available_list_new()
3728 * This frees the list of themes returned by
3729 * elm_theme_name_available_list_new(). Once freed the list should no longer
3730 * be used. a new list mys be created.
3732 EAPI void elm_theme_name_available_list_free(Eina_List *list);
3734 * Set a specific theme to be used for this object and its children
3736 * @param obj The object to set the theme on
3737 * @param th The theme to set
3739 * This sets a specific theme that will be used for the given object and any
3740 * child objects it has. If @p th is NULL then the theme to be used is
3741 * cleared and the object will inherit its theme from its parent (which
3742 * ultimately will use the default theme if no specific themes are set).
3744 * Use special themes with great care as this will annoy users and make
3745 * configuration difficult. Avoid any custom themes at all if it can be
3748 EAPI void elm_object_theme_set(Evas_Object *obj, Elm_Theme *th) EINA_ARG_NONNULL(1);
3750 * Get the specific theme to be used
3752 * @param obj The object to get the specific theme from
3753 * @return The specifc theme set.
3755 * This will return a specific theme set, or NULL if no specific theme is
3756 * set on that object. It will not return inherited themes from parents, only
3757 * the specific theme set for that specific object. See elm_object_theme_set()
3758 * for more information.
3760 EAPI Elm_Theme *elm_object_theme_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3763 * Get a data item from a theme
3765 * @param th The theme, or NULL for default theme
3766 * @param key The data key to search with
3767 * @return The data value, or NULL on failure
3769 * This function is used to return data items from edc in @p th, an overlay, or an extension.
3770 * It works the same way as edje_file_data_get() except that the return is stringshared.
3772 EAPI const char *elm_theme_data_get(Elm_Theme *th, const char *key) EINA_ARG_NONNULL(2);
3778 /** @defgroup Win Win
3780 * @image html img/widget/win/preview-00.png
3781 * @image latex img/widget/win/preview-00.eps
3783 * The window class of Elementary. Contains functions to manipulate
3784 * windows. The Evas engine used to render the window contents is specified
3785 * in the system or user elementary config files (whichever is found last),
3786 * and can be overridden with the ELM_ENGINE environment variable for
3787 * testing. Engines that may be supported (depending on Evas and Ecore-Evas
3788 * compilation setup and modules actually installed at runtime) are (listed
3789 * in order of best supported and most likely to be complete and work to
3792 * @li "x11", "x", "software-x11", "software_x11" (Software rendering in X11)
3793 * @li "gl", "opengl", "opengl-x11", "opengl_x11" (OpenGL or OpenGL-ES2
3795 * @li "shot:..." (Virtual screenshot renderer - renders to output file and
3797 * @li "fb", "software-fb", "software_fb" (Linux framebuffer direct software
3799 * @li "sdl", "software-sdl", "software_sdl" (SDL software rendering to SDL
3801 * @li "gl-sdl", "gl_sdl", "opengl-sdl", "opengl_sdl" (OpenGL or OpenGL-ES2
3802 * rendering using SDL as the buffer)
3803 * @li "gdi", "software-gdi", "software_gdi" (Windows WIN32 rendering via
3804 * GDI with software)
3805 * @li "dfb", "directfb" (Rendering to a DirectFB window)
3806 * @li "x11-8", "x8", "software-8-x11", "software_8_x11" (Rendering in
3807 * grayscale using dedicated 8bit software engine in X11)
3808 * @li "x11-16", "x16", "software-16-x11", "software_16_x11" (Rendering in
3809 * X11 using 16bit software engine)
3810 * @li "wince-gdi", "software-16-wince-gdi", "software_16_wince_gdi"
3811 * (Windows CE rendering via GDI with 16bit software renderer)
3812 * @li "sdl-16", "software-16-sdl", "software_16_sdl" (Rendering to SDL
3813 * buffer with 16bit software renderer)
3814 * @li "ews" (rendering to EWS - Ecore + Evas Single Process Windowing System)
3815 * @li "gl-cocoa", "gl_cocoa", "opengl-cocoa", "opengl_cocoa" (OpenGL rendering in Cocoa)
3816 * @li "psl1ght" (PS3 rendering using PSL1GHT)
3818 * All engines use a simple string to select the engine to render, EXCEPT
3819 * the "shot" engine. This actually encodes the output of the virtual
3820 * screenshot and how long to delay in the engine string. The engine string
3821 * is encoded in the following way:
3823 * "shot:[delay=XX][:][repeat=DDD][:][file=XX]"
3825 * Where options are separated by a ":" char if more than one option is
3826 * given, with delay, if provided being the first option and file the last
3827 * (order is important). The delay specifies how long to wait after the
3828 * window is shown before doing the virtual "in memory" rendering and then
3829 * save the output to the file specified by the file option (and then exit).
3830 * If no delay is given, the default is 0.5 seconds. If no file is given the
3831 * default output file is "out.png". Repeat option is for continous
3832 * capturing screenshots. Repeat range is from 1 to 999 and filename is
3833 * fixed to "out001.png" Some examples of using the shot engine:
3835 * ELM_ENGINE="shot:delay=1.0:repeat=5:file=elm_test.png" elementary_test
3836 * ELM_ENGINE="shot:delay=1.0:file=elm_test.png" elementary_test
3837 * ELM_ENGINE="shot:file=elm_test2.png" elementary_test
3838 * ELM_ENGINE="shot:delay=2.0" elementary_test
3839 * ELM_ENGINE="shot:" elementary_test
3841 * Signals that you can add callbacks for are:
3843 * @li "delete,request": the user requested to close the window. See
3844 * elm_win_autodel_set().
3845 * @li "focus,in": window got focus
3846 * @li "focus,out": window lost focus
3847 * @li "moved": window that holds the canvas was moved
3850 * @li @ref win_example_01
3855 * Defines the types of window that can be created
3857 * These are hints set on the window so that a running Window Manager knows
3858 * how the window should be handled and/or what kind of decorations it
3861 * Currently, only the X11 backed engines use them.
3863 typedef enum _Elm_Win_Type
3865 ELM_WIN_BASIC, /**< A normal window. Indicates a normal, top-level
3866 window. Almost every window will be created with this
3868 ELM_WIN_DIALOG_BASIC, /**< Used for simple dialog windows/ */
3869 ELM_WIN_DESKTOP, /**< For special desktop windows, like a background
3870 window holding desktop icons. */
3871 ELM_WIN_DOCK, /**< The window is used as a dock or panel. Usually would
3872 be kept on top of any other window by the Window
3874 ELM_WIN_TOOLBAR, /**< The window is used to hold a floating toolbar, or
3876 ELM_WIN_MENU, /**< Similar to #ELM_WIN_TOOLBAR. */
3877 ELM_WIN_UTILITY, /**< A persistent utility window, like a toolbox or
3879 ELM_WIN_SPLASH, /**< Splash window for a starting up application. */
3880 ELM_WIN_DROPDOWN_MENU, /**< The window is a dropdown menu, as when an
3881 entry in a menubar is clicked. Typically used
3882 with elm_win_override_set(). This hint exists
3883 for completion only, as the EFL way of
3884 implementing a menu would not normally use a
3885 separate window for its contents. */
3886 ELM_WIN_POPUP_MENU, /**< Like #ELM_WIN_DROPDOWN_MENU, but for the menu
3887 triggered by right-clicking an object. */
3888 ELM_WIN_TOOLTIP, /**< The window is a tooltip. A short piece of
3889 explanatory text that typically appear after the
3890 mouse cursor hovers over an object for a while.
3891 Typically used with elm_win_override_set() and also
3892 not very commonly used in the EFL. */
3893 ELM_WIN_NOTIFICATION, /**< A notification window, like a warning about
3894 battery life or a new E-Mail received. */
3895 ELM_WIN_COMBO, /**< A window holding the contents of a combo box. Not
3896 usually used in the EFL. */
3897 ELM_WIN_DND, /**< Used to indicate the window is a representation of an
3898 object being dragged across different windows, or even
3899 applications. Typically used with
3900 elm_win_override_set(). */
3901 ELM_WIN_INLINED_IMAGE, /**< The window is rendered onto an image
3902 buffer. No actual window is created for this
3903 type, instead the window and all of its
3904 contents will be rendered to an image buffer.
3905 This allows to have children window inside a
3906 parent one just like any other object would
3907 be, and do other things like applying @c
3908 Evas_Map effects to it. This is the only type
3909 of window that requires the @c parent
3910 parameter of elm_win_add() to be a valid @c
3915 * The differents layouts that can be requested for the virtual keyboard.
3917 * When the application window is being managed by Illume, it may request
3918 * any of the following layouts for the virtual keyboard.
3920 typedef enum _Elm_Win_Keyboard_Mode
3922 ELM_WIN_KEYBOARD_UNKNOWN, /**< Unknown keyboard state */
3923 ELM_WIN_KEYBOARD_OFF, /**< Request to deactivate the keyboard */
3924 ELM_WIN_KEYBOARD_ON, /**< Enable keyboard with default layout */
3925 ELM_WIN_KEYBOARD_ALPHA, /**< Alpha (a-z) keyboard layout */
3926 ELM_WIN_KEYBOARD_NUMERIC, /**< Numeric keyboard layout */
3927 ELM_WIN_KEYBOARD_PIN, /**< PIN keyboard layout */
3928 ELM_WIN_KEYBOARD_PHONE_NUMBER, /**< Phone keyboard layout */
3929 ELM_WIN_KEYBOARD_HEX, /**< Hexadecimal numeric keyboard layout */
3930 ELM_WIN_KEYBOARD_TERMINAL, /**< Full (QUERTY) keyboard layout */
3931 ELM_WIN_KEYBOARD_PASSWORD, /**< Password keyboard layout */
3932 ELM_WIN_KEYBOARD_IP, /**< IP keyboard layout */
3933 ELM_WIN_KEYBOARD_HOST, /**< Host keyboard layout */
3934 ELM_WIN_KEYBOARD_FILE, /**< File keyboard layout */
3935 ELM_WIN_KEYBOARD_URL, /**< URL keyboard layout */
3936 ELM_WIN_KEYBOARD_KEYPAD, /**< Keypad layout */
3937 ELM_WIN_KEYBOARD_J2ME /**< J2ME keyboard layout */
3938 } Elm_Win_Keyboard_Mode;
3941 * Available commands that can be sent to the Illume manager.
3943 * When running under an Illume session, a window may send commands to the
3944 * Illume manager to perform different actions.
3946 typedef enum _Elm_Illume_Command
3948 ELM_ILLUME_COMMAND_FOCUS_BACK, /**< Reverts focus to the previous
3950 ELM_ILLUME_COMMAND_FOCUS_FORWARD, /**< Sends focus to the next window\
3952 ELM_ILLUME_COMMAND_FOCUS_HOME, /**< Hides all windows to show the Home
3954 ELM_ILLUME_COMMAND_CLOSE /**< Closes the currently active window */
3955 } Elm_Illume_Command;
3958 * Adds a window object. If this is the first window created, pass NULL as
3961 * @param parent Parent object to add the window to, or NULL
3962 * @param name The name of the window
3963 * @param type The window type, one of #Elm_Win_Type.
3965 * The @p parent paramter can be @c NULL for every window @p type except
3966 * #ELM_WIN_INLINED_IMAGE, which needs a parent to retrieve the canvas on
3967 * which the image object will be created.
3969 * @return The created object, or NULL on failure
3971 EAPI Evas_Object *elm_win_add(Evas_Object *parent, const char *name, Elm_Win_Type type);
3973 * Adds a window object with standard setup
3975 * @param name The name of the window
3976 * @param title The title for the window
3978 * This creates a window like elm_win_add() but also puts in a standard
3979 * background with elm_bg_add(), as well as setting the window title to
3980 * @p title. The window type created is of type ELM_WIN_BASIC, with NULL
3981 * as the parent widget.
3983 * @return The created object, or NULL on failure
3985 * @see elm_win_add()
3987 EAPI Evas_Object *elm_win_util_standard_add(const char *name, const char *title);
3989 * Add @p subobj as a resize object of window @p obj.
3992 * Setting an object as a resize object of the window means that the
3993 * @p subobj child's size and position will be controlled by the window
3994 * directly. That is, the object will be resized to match the window size
3995 * and should never be moved or resized manually by the developer.
3997 * In addition, resize objects of the window control what the minimum size
3998 * of it will be, as well as whether it can or not be resized by the user.
4000 * For the end user to be able to resize a window by dragging the handles
4001 * or borders provided by the Window Manager, or using any other similar
4002 * mechanism, all of the resize objects in the window should have their
4003 * evas_object_size_hint_weight_set() set to EVAS_HINT_EXPAND.
4005 * Also notice that the window can get resized to the current size of the
4006 * object if the EVAS_HINT_EXPAND is set @b after the call to
4007 * elm_win_resize_object_add(). So if the object should get resized to the
4008 * size of the window, set this hint @b before adding it as a resize object
4009 * (this happens because the size of the window and the object are evaluated
4010 * as soon as the object is added to the window).
4012 * @param obj The window object
4013 * @param subobj The resize object to add
4015 EAPI void elm_win_resize_object_add(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
4017 * Delete @p subobj as a resize object of window @p obj.
4019 * This function removes the object @p subobj from the resize objects of
4020 * the window @p obj. It will not delete the object itself, which will be
4021 * left unmanaged and should be deleted by the developer, manually handled
4022 * or set as child of some other container.
4024 * @param obj The window object
4025 * @param subobj The resize object to add
4027 EAPI void elm_win_resize_object_del(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
4029 * Set the title of the window
4031 * @param obj The window object
4032 * @param title The title to set
4034 EAPI void elm_win_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
4036 * Get the title of the window
4038 * The returned string is an internal one and should not be freed or
4039 * modified. It will also be rendered invalid if a new title is set or if
4040 * the window is destroyed.
4042 * @param obj The window object
4045 EAPI const char *elm_win_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4047 * Set the window's autodel state.
4049 * When closing the window in any way outside of the program control, like
4050 * pressing the X button in the titlebar or using a command from the
4051 * Window Manager, a "delete,request" signal is emitted to indicate that
4052 * this event occurred and the developer can take any action, which may
4053 * include, or not, destroying the window object.
4055 * When the @p autodel parameter is set, the window will be automatically
4056 * destroyed when this event occurs, after the signal is emitted.
4057 * If @p autodel is @c EINA_FALSE, then the window will not be destroyed
4058 * and is up to the program to do so when it's required.
4060 * @param obj The window object
4061 * @param autodel If true, the window will automatically delete itself when
4064 EAPI void elm_win_autodel_set(Evas_Object *obj, Eina_Bool autodel) EINA_ARG_NONNULL(1);
4066 * Get the window's autodel state.
4068 * @param obj The window object
4069 * @return If the window will automatically delete itself when closed
4071 * @see elm_win_autodel_set()
4073 EAPI Eina_Bool elm_win_autodel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4075 * Activate a window object.
4077 * This function sends a request to the Window Manager to activate the
4078 * window pointed by @p obj. If honored by the WM, the window will receive
4079 * the keyboard focus.
4081 * @note This is just a request that a Window Manager may ignore, so calling
4082 * this function does not ensure in any way that the window will be the
4083 * active one after it.
4085 * @param obj The window object
4087 EAPI void elm_win_activate(Evas_Object *obj) EINA_ARG_NONNULL(1);
4089 * Lower a window object.
4091 * Places the window pointed by @p obj at the bottom of the stack, so that
4092 * no other window is covered by it.
4094 * If elm_win_override_set() is not set, the Window Manager may ignore this
4097 * @param obj The window object
4099 EAPI void elm_win_lower(Evas_Object *obj) EINA_ARG_NONNULL(1);
4101 * Raise a window object.
4103 * Places the window pointed by @p obj at the top of the stack, so that it's
4104 * not covered by any other window.
4106 * If elm_win_override_set() is not set, the Window Manager may ignore this
4109 * @param obj The window object
4111 EAPI void elm_win_raise(Evas_Object *obj) EINA_ARG_NONNULL(1);
4113 * Set the borderless state of a window.
4115 * This function requests the Window Manager to not draw any decoration
4116 * around the window.
4118 * @param obj The window object
4119 * @param borderless If true, the window is borderless
4121 EAPI void elm_win_borderless_set(Evas_Object *obj, Eina_Bool borderless) EINA_ARG_NONNULL(1);
4123 * Get the borderless state of a window.
4125 * @param obj The window object
4126 * @return If true, the window is borderless
4128 EAPI Eina_Bool elm_win_borderless_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4130 * Set the shaped state of a window.
4132 * Shaped windows, when supported, will render the parts of the window that
4133 * has no content, transparent.
4135 * If @p shaped is EINA_FALSE, then it is strongly adviced to have some
4136 * background object or cover the entire window in any other way, or the
4137 * parts of the canvas that have no data will show framebuffer artifacts.
4139 * @param obj The window object
4140 * @param shaped If true, the window is shaped
4142 * @see elm_win_alpha_set()
4144 EAPI void elm_win_shaped_set(Evas_Object *obj, Eina_Bool shaped) EINA_ARG_NONNULL(1);
4146 * Get the shaped state of a window.
4148 * @param obj The window object
4149 * @return If true, the window is shaped
4151 * @see elm_win_shaped_set()
4153 EAPI Eina_Bool elm_win_shaped_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4155 * Set the alpha channel state of a window.
4157 * If @p alpha is EINA_TRUE, the alpha channel of the canvas will be enabled
4158 * possibly making parts of the window completely or partially transparent.
4159 * This is also subject to the underlying system supporting it, like for
4160 * example, running under a compositing manager. If no compositing is
4161 * available, enabling this option will instead fallback to using shaped
4162 * windows, with elm_win_shaped_set().
4164 * @param obj The window object
4165 * @param alpha If true, the window has an alpha channel
4167 * @see elm_win_alpha_set()
4169 EAPI void elm_win_alpha_set(Evas_Object *obj, Eina_Bool alpha) EINA_ARG_NONNULL(1);
4171 * Get the transparency state of a window.
4173 * @param obj The window object
4174 * @return If true, the window is transparent
4176 * @see elm_win_transparent_set()
4178 EAPI Eina_Bool elm_win_transparent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4180 * Set the transparency state of a window.
4182 * Use elm_win_alpha_set() instead.
4184 * @param obj The window object
4185 * @param transparent If true, the window is transparent
4187 * @see elm_win_alpha_set()
4189 EAPI void elm_win_transparent_set(Evas_Object *obj, Eina_Bool transparent) EINA_ARG_NONNULL(1);
4191 * Get the alpha channel state of a window.
4193 * @param obj The window object
4194 * @return If true, the window has an alpha channel
4196 EAPI Eina_Bool elm_win_alpha_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4198 * Set the override state of a window.
4200 * A window with @p override set to EINA_TRUE will not be managed by the
4201 * Window Manager. This means that no decorations of any kind will be shown
4202 * for it, moving and resizing must be handled by the application, as well
4203 * as the window visibility.
4205 * This should not be used for normal windows, and even for not so normal
4206 * ones, it should only be used when there's a good reason and with a lot
4207 * of care. Mishandling override windows may result situations that
4208 * disrupt the normal workflow of the end user.
4210 * @param obj The window object
4211 * @param override If true, the window is overridden
4213 EAPI void elm_win_override_set(Evas_Object *obj, Eina_Bool override) EINA_ARG_NONNULL(1);
4215 * Get the override state of a window.
4217 * @param obj The window object
4218 * @return If true, the window is overridden
4220 * @see elm_win_override_set()
4222 EAPI Eina_Bool elm_win_override_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4224 * Set the fullscreen state of a window.
4226 * @param obj The window object
4227 * @param fullscreen If true, the window is fullscreen
4229 EAPI void elm_win_fullscreen_set(Evas_Object *obj, Eina_Bool fullscreen) EINA_ARG_NONNULL(1);
4231 * Get the fullscreen state of a window.
4233 * @param obj The window object
4234 * @return If true, the window is fullscreen
4236 EAPI Eina_Bool elm_win_fullscreen_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4238 * Set the maximized state of a window.
4240 * @param obj The window object
4241 * @param maximized If true, the window is maximized
4243 EAPI void elm_win_maximized_set(Evas_Object *obj, Eina_Bool maximized) EINA_ARG_NONNULL(1);
4245 * Get the maximized state of a window.
4247 * @param obj The window object
4248 * @return If true, the window is maximized
4250 EAPI Eina_Bool elm_win_maximized_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4252 * Set the iconified state of a window.
4254 * @param obj The window object
4255 * @param iconified If true, the window is iconified
4257 EAPI void elm_win_iconified_set(Evas_Object *obj, Eina_Bool iconified) EINA_ARG_NONNULL(1);
4259 * Get the iconified state of a window.
4261 * @param obj The window object
4262 * @return If true, the window is iconified
4264 EAPI Eina_Bool elm_win_iconified_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4266 * Set the layer of the window.
4268 * What this means exactly will depend on the underlying engine used.
4270 * In the case of X11 backed engines, the value in @p layer has the
4271 * following meanings:
4272 * @li < 3: The window will be placed below all others.
4273 * @li > 5: The window will be placed above all others.
4274 * @li other: The window will be placed in the default layer.
4276 * @param obj The window object
4277 * @param layer The layer of the window
4279 EAPI void elm_win_layer_set(Evas_Object *obj, int layer) EINA_ARG_NONNULL(1);
4281 * Get the layer of the window.
4283 * @param obj The window object
4284 * @return The layer of the window
4286 * @see elm_win_layer_set()
4288 EAPI int elm_win_layer_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4290 * Set the rotation of the window.
4292 * Most engines only work with multiples of 90.
4294 * This function is used to set the orientation of the window @p obj to
4295 * match that of the screen. The window itself will be resized to adjust
4296 * to the new geometry of its contents. If you want to keep the window size,
4297 * see elm_win_rotation_with_resize_set().
4299 * @param obj The window object
4300 * @param rotation The rotation of the window, in degrees (0-360),
4301 * counter-clockwise.
4303 EAPI void elm_win_rotation_set(Evas_Object *obj, int rotation) EINA_ARG_NONNULL(1);
4305 * Rotates the window and resizes it.
4307 * Like elm_win_rotation_set(), but it also resizes the window's contents so
4308 * that they fit inside the current window geometry.
4310 * @param obj The window object
4311 * @param layer The rotation of the window in degrees (0-360),
4312 * counter-clockwise.
4314 EAPI void elm_win_rotation_with_resize_set(Evas_Object *obj, int rotation) EINA_ARG_NONNULL(1);
4316 * Get the rotation of the window.
4318 * @param obj The window object
4319 * @return The rotation of the window in degrees (0-360)
4321 * @see elm_win_rotation_set()
4322 * @see elm_win_rotation_with_resize_set()
4324 EAPI int elm_win_rotation_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4326 * Set the sticky state of the window.
4328 * Hints the Window Manager that the window in @p obj should be left fixed
4329 * at its position even when the virtual desktop it's on moves or changes.
4331 * @param obj The window object
4332 * @param sticky If true, the window's sticky state is enabled
4334 EAPI void elm_win_sticky_set(Evas_Object *obj, Eina_Bool sticky) EINA_ARG_NONNULL(1);
4336 * Get the sticky state of the window.
4338 * @param obj The window object
4339 * @return If true, the window's sticky state is enabled
4341 * @see elm_win_sticky_set()
4343 EAPI Eina_Bool elm_win_sticky_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4345 * Set if this window is an illume conformant window
4347 * @param obj The window object
4348 * @param conformant The conformant flag (1 = conformant, 0 = non-conformant)
4350 EAPI void elm_win_conformant_set(Evas_Object *obj, Eina_Bool conformant) EINA_ARG_NONNULL(1);
4352 * Get if this window is an illume conformant window
4354 * @param obj The window object
4355 * @return A boolean if this window is illume conformant or not
4357 EAPI Eina_Bool elm_win_conformant_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4359 * Set a window to be an illume quickpanel window
4361 * By default window objects are not quickpanel windows.
4363 * @param obj The window object
4364 * @param quickpanel The quickpanel flag (1 = quickpanel, 0 = normal window)
4366 EAPI void elm_win_quickpanel_set(Evas_Object *obj, Eina_Bool quickpanel) EINA_ARG_NONNULL(1);
4368 * Get if this window is a quickpanel or not
4370 * @param obj The window object
4371 * @return A boolean if this window is a quickpanel or not
4373 EAPI Eina_Bool elm_win_quickpanel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4375 * Set the major priority of a quickpanel window
4377 * @param obj The window object
4378 * @param priority The major priority for this quickpanel
4380 EAPI void elm_win_quickpanel_priority_major_set(Evas_Object *obj, int priority) EINA_ARG_NONNULL(1);
4382 * Get the major priority of a quickpanel window
4384 * @param obj The window object
4385 * @return The major priority of this quickpanel
4387 EAPI int elm_win_quickpanel_priority_major_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4389 * Set the minor priority of a quickpanel window
4391 * @param obj The window object
4392 * @param priority The minor priority for this quickpanel
4394 EAPI void elm_win_quickpanel_priority_minor_set(Evas_Object *obj, int priority) EINA_ARG_NONNULL(1);
4396 * Get the minor priority of a quickpanel window
4398 * @param obj The window object
4399 * @return The minor priority of this quickpanel
4401 EAPI int elm_win_quickpanel_priority_minor_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4403 * Set which zone this quickpanel should appear in
4405 * @param obj The window object
4406 * @param zone The requested zone for this quickpanel
4408 EAPI void elm_win_quickpanel_zone_set(Evas_Object *obj, int zone) EINA_ARG_NONNULL(1);
4410 * Get which zone this quickpanel should appear in
4412 * @param obj The window object
4413 * @return The requested zone for this quickpanel
4415 EAPI int elm_win_quickpanel_zone_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4417 * Set the window to be skipped by keyboard focus
4419 * This sets the window to be skipped by normal keyboard input. This means
4420 * a window manager will be asked to not focus this window as well as omit
4421 * it from things like the taskbar, pager, "alt-tab" list etc. etc.
4423 * Call this and enable it on a window BEFORE you show it for the first time,
4424 * otherwise it may have no effect.
4426 * Use this for windows that have only output information or might only be
4427 * interacted with by the mouse or fingers, and never for typing input.
4428 * Be careful that this may have side-effects like making the window
4429 * non-accessible in some cases unless the window is specially handled. Use
4432 * @param obj The window object
4433 * @param skip The skip flag state (EINA_TRUE if it is to be skipped)
4435 EAPI void elm_win_prop_focus_skip_set(Evas_Object *obj, Eina_Bool skip) EINA_ARG_NONNULL(1);
4437 * Send a command to the windowing environment
4439 * This is intended to work in touchscreen or small screen device
4440 * environments where there is a more simplistic window management policy in
4441 * place. This uses the window object indicated to select which part of the
4442 * environment to control (the part that this window lives in), and provides
4443 * a command and an optional parameter structure (use NULL for this if not
4446 * @param obj The window object that lives in the environment to control
4447 * @param command The command to send
4448 * @param params Optional parameters for the command
4450 EAPI void elm_win_illume_command_send(Evas_Object *obj, Elm_Illume_Command command, void *params) EINA_ARG_NONNULL(1);
4452 * Get the inlined image object handle
4454 * When you create a window with elm_win_add() of type ELM_WIN_INLINED_IMAGE,
4455 * then the window is in fact an evas image object inlined in the parent
4456 * canvas. You can get this object (be careful to not manipulate it as it
4457 * is under control of elementary), and use it to do things like get pixel
4458 * data, save the image to a file, etc.
4460 * @param obj The window object to get the inlined image from
4461 * @return The inlined image object, or NULL if none exists
4463 EAPI Evas_Object *elm_win_inlined_image_object_get(Evas_Object *obj);
4465 * Determine whether a window has focus
4466 * @param obj The window to query
4467 * @return EINA_TRUE if the window exists and has focus, else EINA_FALSE
4469 EAPI Eina_Bool elm_win_focus_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4471 * Get screen geometry details for the screen that a window is on
4472 * @param obj The window to query
4473 * @param x where to return the horizontal offset value. May be NULL.
4474 * @param y where to return the vertical offset value. May be NULL.
4475 * @param w where to return the width value. May be NULL.
4476 * @param h where to return the height value. May be NULL.
4478 EAPI void elm_win_screen_size_get(const Evas_Object *obj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
4480 * Set the enabled status for the focus highlight in a window
4482 * This function will enable or disable the focus highlight only for the
4483 * given window, regardless of the global setting for it
4485 * @param obj The window where to enable the highlight
4486 * @param enabled The enabled value for the highlight
4488 EAPI void elm_win_focus_highlight_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
4490 * Get the enabled value of the focus highlight for this window
4492 * @param obj The window in which to check if the focus highlight is enabled
4494 * @return EINA_TRUE if enabled, EINA_FALSE otherwise
4496 EAPI Eina_Bool elm_win_focus_highlight_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4498 * Set the style for the focus highlight on this window
4500 * Sets the style to use for theming the highlight of focused objects on
4501 * the given window. If @p style is NULL, the default will be used.
4503 * @param obj The window where to set the style
4504 * @param style The style to set
4506 EAPI void elm_win_focus_highlight_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
4508 * Get the style set for the focus highlight object
4510 * Gets the style set for this windows highilght object, or NULL if none
4513 * @param obj The window to retrieve the highlights style from
4515 * @return The style set or NULL if none was. Default is used in that case.
4517 EAPI const char *elm_win_focus_highlight_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4519 * ecore_x_icccm_hints_set -> accepts_focus (add to ecore_evas)
4520 * ecore_x_icccm_hints_set -> window_group (add to ecore_evas)
4521 * ecore_x_icccm_size_pos_hints_set -> request_pos (add to ecore_evas)
4522 * ecore_x_icccm_client_leader_set -> l (add to ecore_evas)
4523 * ecore_x_icccm_window_role_set -> role (add to ecore_evas)
4524 * ecore_x_icccm_transient_for_set -> forwin (add to ecore_evas)
4525 * ecore_x_netwm_window_type_set -> type (add to ecore_evas)
4527 * (add to ecore_x) set netwm argb icon! (add to ecore_evas)
4528 * (blank mouse, private mouse obj, defaultmouse)
4532 * Sets the keyboard mode of the window.
4534 * @param obj The window object
4535 * @param mode The mode to set, one of #Elm_Win_Keyboard_Mode
4537 EAPI void elm_win_keyboard_mode_set(Evas_Object *obj, Elm_Win_Keyboard_Mode mode) EINA_ARG_NONNULL(1);
4539 * Gets the keyboard mode of the window.
4541 * @param obj The window object
4542 * @return The mode, one of #Elm_Win_Keyboard_Mode
4544 EAPI Elm_Win_Keyboard_Mode elm_win_keyboard_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4546 * Sets whether the window is a keyboard.
4548 * @param obj The window object
4549 * @param is_keyboard If true, the window is a virtual keyboard
4551 EAPI void elm_win_keyboard_win_set(Evas_Object *obj, Eina_Bool is_keyboard) EINA_ARG_NONNULL(1);
4553 * Gets whether the window is a keyboard.
4555 * @param obj The window object
4556 * @return If the window is a virtual keyboard
4558 EAPI Eina_Bool elm_win_keyboard_win_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4561 * Get the screen position of a window.
4563 * @param obj The window object
4564 * @param x The int to store the x coordinate to
4565 * @param y The int to store the y coordinate to
4567 EAPI void elm_win_screen_position_get(const Evas_Object *obj, int *x, int *y) EINA_ARG_NONNULL(1);
4573 * @defgroup Inwin Inwin
4575 * @image html img/widget/inwin/preview-00.png
4576 * @image latex img/widget/inwin/preview-00.eps
4577 * @image html img/widget/inwin/preview-01.png
4578 * @image latex img/widget/inwin/preview-01.eps
4579 * @image html img/widget/inwin/preview-02.png
4580 * @image latex img/widget/inwin/preview-02.eps
4582 * An inwin is a window inside a window that is useful for a quick popup.
4583 * It does not hover.
4585 * It works by creating an object that will occupy the entire window, so it
4586 * must be created using an @ref Win "elm_win" as parent only. The inwin
4587 * object can be hidden or restacked below every other object if it's
4588 * needed to show what's behind it without destroying it. If this is done,
4589 * the elm_win_inwin_activate() function can be used to bring it back to
4590 * full visibility again.
4592 * There are three styles available in the default theme. These are:
4593 * @li default: The inwin is sized to take over most of the window it's
4595 * @li minimal: The size of the inwin will be the minimum necessary to show
4597 * @li minimal_vertical: Horizontally, the inwin takes as much space as
4598 * possible, but it's sized vertically the most it needs to fit its\
4601 * Some examples of Inwin can be found in the following:
4602 * @li @ref inwin_example_01
4607 * Adds an inwin to the current window
4609 * The @p obj used as parent @b MUST be an @ref Win "Elementary Window".
4610 * Never call this function with anything other than the top-most window
4611 * as its parameter, unless you are fond of undefined behavior.
4613 * After creating the object, the widget will set itself as resize object
4614 * for the window with elm_win_resize_object_add(), so when shown it will
4615 * appear to cover almost the entire window (how much of it depends on its
4616 * content and the style used). It must not be added into other container
4617 * objects and it needs not be moved or resized manually.
4619 * @param parent The parent object
4620 * @return The new object or NULL if it cannot be created
4622 EAPI Evas_Object *elm_win_inwin_add(Evas_Object *obj) EINA_ARG_NONNULL(1);
4624 * Activates an inwin object, ensuring its visibility
4626 * This function will make sure that the inwin @p obj is completely visible
4627 * by calling evas_object_show() and evas_object_raise() on it, to bring it
4628 * to the front. It also sets the keyboard focus to it, which will be passed
4631 * The object's theme will also receive the signal "elm,action,show" with
4634 * @param obj The inwin to activate
4636 EAPI void elm_win_inwin_activate(Evas_Object *obj) EINA_ARG_NONNULL(1);
4638 * Set the content of an inwin object.
4640 * Once the content object is set, a previously set one will be deleted.
4641 * If you want to keep that old content object, use the
4642 * elm_win_inwin_content_unset() function.
4644 * @param obj The inwin object
4645 * @param content The object to set as content
4647 EAPI void elm_win_inwin_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
4649 * Get the content of an inwin object.
4651 * Return the content object which is set for this widget.
4653 * The returned object is valid as long as the inwin is still alive and no
4654 * other content is set on it. Deleting the object will notify the inwin
4655 * about it and this one will be left empty.
4657 * If you need to remove an inwin's content to be reused somewhere else,
4658 * see elm_win_inwin_content_unset().
4660 * @param obj The inwin object
4661 * @return The content that is being used
4663 EAPI Evas_Object *elm_win_inwin_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4665 * Unset the content of an inwin object.
4667 * Unparent and return the content object which was set for this widget.
4669 * @param obj The inwin object
4670 * @return The content that was being used
4672 EAPI Evas_Object *elm_win_inwin_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4676 /* X specific calls - won't work on non-x engines (return 0) */
4679 * Get the Ecore_X_Window of an Evas_Object
4681 * @param obj The object
4683 * @return The Ecore_X_Window of @p obj
4687 EAPI Ecore_X_Window elm_win_xwindow_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4689 /* smart callbacks called:
4690 * "delete,request" - the user requested to delete the window
4691 * "focus,in" - window got focus
4692 * "focus,out" - window lost focus
4693 * "moved" - window that holds the canvas was moved
4699 * @image html img/widget/bg/preview-00.png
4700 * @image latex img/widget/bg/preview-00.eps
4702 * @brief Background object, used for setting a solid color, image or Edje
4703 * group as background to a window or any container object.
4705 * The bg object is used for setting a solid background to a window or
4706 * packing into any container object. It works just like an image, but has
4707 * some properties useful to a background, like setting it to tiled,
4708 * centered, scaled or stretched.
4710 * Default contents parts of the bg widget that you can use for are:
4711 * @li "overlay" - overlay of the bg
4713 * Here is some sample code using it:
4714 * @li @ref bg_01_example_page
4715 * @li @ref bg_02_example_page
4716 * @li @ref bg_03_example_page
4720 typedef enum _Elm_Bg_Option
4722 ELM_BG_OPTION_CENTER, /**< center the background */
4723 ELM_BG_OPTION_SCALE, /**< scale the background retaining aspect ratio */
4724 ELM_BG_OPTION_STRETCH, /**< stretch the background to fill */
4725 ELM_BG_OPTION_TILE /**< tile background at its original size */
4729 * Add a new background to the parent
4731 * @param parent The parent object
4732 * @return The new object or NULL if it cannot be created
4736 EAPI Evas_Object *elm_bg_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4739 * Set the file (image or edje) used for the background
4741 * @param obj The bg object
4742 * @param file The file path
4743 * @param group Optional key (group in Edje) within the file
4745 * This sets the image file used in the background object. The image (or edje)
4746 * will be stretched (retaining aspect if its an image file) to completely fill
4747 * the bg object. This may mean some parts are not visible.
4749 * @note Once the image of @p obj is set, a previously set one will be deleted,
4750 * even if @p file is NULL.
4754 EAPI void elm_bg_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1);
4757 * Get the file (image or edje) used for the background
4759 * @param obj The bg object
4760 * @param file The file path
4761 * @param group Optional key (group in Edje) within the file
4765 EAPI void elm_bg_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
4768 * Set the option used for the background image
4770 * @param obj The bg object
4771 * @param option The desired background option (TILE, SCALE)
4773 * This sets the option used for manipulating the display of the background
4774 * image. The image can be tiled or scaled.
4778 EAPI void elm_bg_option_set(Evas_Object *obj, Elm_Bg_Option option) EINA_ARG_NONNULL(1);
4781 * Get the option used for the background image
4783 * @param obj The bg object
4784 * @return The desired background option (CENTER, SCALE, STRETCH or TILE)
4788 EAPI Elm_Bg_Option elm_bg_option_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4790 * Set the option used for the background color
4792 * @param obj The bg object
4797 * This sets the color used for the background rectangle. Its range goes
4802 EAPI void elm_bg_color_set(Evas_Object *obj, int r, int g, int b) EINA_ARG_NONNULL(1);
4804 * Get the option used for the background color
4806 * @param obj The bg object
4813 EAPI void elm_bg_color_get(const Evas_Object *obj, int *r, int *g, int *b) EINA_ARG_NONNULL(1);
4816 * Set the overlay object used for the background object.
4818 * @param obj The bg object
4819 * @param overlay The overlay object
4821 * This provides a way for elm_bg to have an 'overlay' that will be on top
4822 * of the bg. Once the over object is set, a previously set one will be
4823 * deleted, even if you set the new one to NULL. If you want to keep that
4824 * old content object, use the elm_bg_overlay_unset() function.
4826 * @deprecated use elm_object_part_content_set() instead
4831 EINA_DEPRECATED EAPI void elm_bg_overlay_set(Evas_Object *obj, Evas_Object *overlay) EINA_ARG_NONNULL(1);
4834 * Get the overlay object used for the background object.
4836 * @param obj The bg object
4837 * @return The content that is being used
4839 * Return the content object which is set for this widget
4841 * @deprecated use elm_object_part_content_get() instead
4845 EINA_DEPRECATED EAPI Evas_Object *elm_bg_overlay_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4848 * Get the overlay object used for the background object.
4850 * @param obj The bg object
4851 * @return The content that was being used
4853 * Unparent and return the overlay object which was set for this widget
4855 * @deprecated use elm_object_part_content_unset() instead
4859 EINA_DEPRECATED EAPI Evas_Object *elm_bg_overlay_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4862 * Set the size of the pixmap representation of the image.
4864 * This option just makes sense if an image is going to be set in the bg.
4866 * @param obj The bg object
4867 * @param w The new width of the image pixmap representation.
4868 * @param h The new height of the image pixmap representation.
4870 * This function sets a new size for pixmap representation of the given bg
4871 * image. It allows the image to be loaded already in the specified size,
4872 * reducing the memory usage and load time when loading a big image with load
4873 * size set to a smaller size.
4875 * NOTE: this is just a hint, the real size of the pixmap may differ
4876 * depending on the type of image being loaded, being bigger than requested.
4880 EAPI void elm_bg_load_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
4881 /* smart callbacks called:
4885 * @defgroup Icon Icon
4887 * @image html img/widget/icon/preview-00.png
4888 * @image latex img/widget/icon/preview-00.eps
4890 * An object that provides standard icon images (delete, edit, arrows, etc.)
4891 * or a custom file (PNG, JPG, EDJE, etc.) used for an icon.
4893 * The icon image requested can be in the elementary theme, or in the
4894 * freedesktop.org paths. It's possible to set the order of preference from
4895 * where the image will be used.
4897 * This API is very similar to @ref Image, but with ready to use images.
4899 * Default images provided by the theme are described below.
4901 * The first list contains icons that were first intended to be used in
4902 * toolbars, but can be used in many other places too:
4918 * Now some icons that were designed to be used in menus (but again, you can
4919 * use them anywhere else):
4924 * @li menu/arrow_down
4925 * @li menu/arrow_left
4926 * @li menu/arrow_right
4935 * And here we have some media player specific icons:
4936 * @li media_player/forward
4937 * @li media_player/info
4938 * @li media_player/next
4939 * @li media_player/pause
4940 * @li media_player/play
4941 * @li media_player/prev
4942 * @li media_player/rewind
4943 * @li media_player/stop
4945 * Signals that you can add callbacks for are:
4947 * "clicked" - This is called when a user has clicked the icon
4949 * An example of usage for this API follows:
4950 * @li @ref tutorial_icon
4958 typedef enum _Elm_Icon_Type
4965 * @enum _Elm_Icon_Lookup_Order
4966 * @typedef Elm_Icon_Lookup_Order
4968 * Lookup order used by elm_icon_standard_set(). Should look for icons in the
4969 * theme, FDO paths, or both?
4973 typedef enum _Elm_Icon_Lookup_Order
4975 ELM_ICON_LOOKUP_FDO_THEME, /**< icon look up order: freedesktop, theme */
4976 ELM_ICON_LOOKUP_THEME_FDO, /**< icon look up order: theme, freedesktop */
4977 ELM_ICON_LOOKUP_FDO, /**< icon look up order: freedesktop */
4978 ELM_ICON_LOOKUP_THEME /**< icon look up order: theme */
4979 } Elm_Icon_Lookup_Order;
4982 * Add a new icon object to the parent.
4984 * @param parent The parent object
4985 * @return The new object or NULL if it cannot be created
4987 * @see elm_icon_file_set()
4991 EAPI Evas_Object *elm_icon_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4993 * Set the file that will be used as icon.
4995 * @param obj The icon object
4996 * @param file The path to file that will be used as icon image
4997 * @param group The group that the icon belongs to an edje file
4999 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
5001 * @note The icon image set by this function can be changed by
5002 * elm_icon_standard_set().
5004 * @see elm_icon_file_get()
5008 EAPI Eina_Bool elm_icon_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
5010 * Set a location in memory to be used as an icon
5012 * @param obj The icon object
5013 * @param img The binary data that will be used as an image
5014 * @param size The size of binary data @p img
5015 * @param format Optional format of @p img to pass to the image loader
5016 * @param key Optional key of @p img to pass to the image loader (eg. if @p img is an edje file)
5018 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
5020 * @note The icon image set by this function can be changed by
5021 * elm_icon_standard_set().
5025 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);
5027 * Get the file that will be used as icon.
5029 * @param obj The icon object
5030 * @param file The path to file that will be used as the icon image
5031 * @param group The group that the icon belongs to, in edje file
5033 * @see elm_icon_file_set()
5037 EAPI void elm_icon_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
5038 EAPI void elm_icon_thumb_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
5040 * Set the icon by icon standards names.
5042 * @param obj The icon object
5043 * @param name The icon name
5045 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
5047 * For example, freedesktop.org defines standard icon names such as "home",
5048 * "network", etc. There can be different icon sets to match those icon
5049 * keys. The @p name given as parameter is one of these "keys", and will be
5050 * used to look in the freedesktop.org paths and elementary theme. One can
5051 * change the lookup order with elm_icon_order_lookup_set().
5053 * If name is not found in any of the expected locations and it is the
5054 * absolute path of an image file, this image will be used.
5056 * @note The icon image set by this function can be changed by
5057 * elm_icon_file_set().
5059 * @see elm_icon_standard_get()
5060 * @see elm_icon_file_set()
5064 EAPI Eina_Bool elm_icon_standard_set(Evas_Object *obj, const char *name) EINA_ARG_NONNULL(1);
5066 * Get the icon name set by icon standard names.
5068 * @param obj The icon object
5069 * @return The icon name
5071 * If the icon image was set using elm_icon_file_set() instead of
5072 * elm_icon_standard_set(), then this function will return @c NULL.
5074 * @see elm_icon_standard_set()
5078 EAPI const char *elm_icon_standard_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5080 * Set the smooth scaling for an icon object.
5082 * @param obj The icon object
5083 * @param smooth @c EINA_TRUE if smooth scaling should be used, @c EINA_FALSE
5084 * otherwise. Default is @c EINA_TRUE.
5086 * Set the scaling algorithm to be used when scaling the icon image. Smooth
5087 * scaling provides a better resulting image, but is slower.
5089 * The smooth scaling should be disabled when making animations that change
5090 * the icon size, since they will be faster. Animations that don't require
5091 * resizing of the icon can keep the smooth scaling enabled (even if the icon
5092 * is already scaled, since the scaled icon image will be cached).
5094 * @see elm_icon_smooth_get()
5098 EAPI void elm_icon_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
5100 * Get whether smooth scaling is enabled for an icon object.
5102 * @param obj The icon object
5103 * @return @c EINA_TRUE if smooth scaling is enabled, @c EINA_FALSE otherwise.
5105 * @see elm_icon_smooth_set()
5109 EAPI Eina_Bool elm_icon_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5111 * Disable scaling of this object.
5113 * @param obj The icon object.
5114 * @param no_scale @c EINA_TRUE if the object is not scalable, @c EINA_FALSE
5115 * otherwise. Default is @c EINA_FALSE.
5117 * This function disables scaling of the icon object through the function
5118 * elm_object_scale_set(). However, this does not affect the object
5119 * size/resize in any way. For that effect, take a look at
5120 * elm_icon_scale_set().
5122 * @see elm_icon_no_scale_get()
5123 * @see elm_icon_scale_set()
5124 * @see elm_object_scale_set()
5128 EAPI void elm_icon_no_scale_set(Evas_Object *obj, Eina_Bool no_scale) EINA_ARG_NONNULL(1);
5130 * Get whether scaling is disabled on the object.
5132 * @param obj The icon object
5133 * @return @c EINA_TRUE if scaling is disabled, @c EINA_FALSE otherwise
5135 * @see elm_icon_no_scale_set()
5139 EAPI Eina_Bool elm_icon_no_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5141 * Set if the object is (up/down) resizable.
5143 * @param obj The icon object
5144 * @param scale_up A bool to set if the object is resizable up. Default is
5146 * @param scale_down A bool to set if the object is resizable down. Default
5149 * This function limits the icon object resize ability. If @p scale_up is set to
5150 * @c EINA_FALSE, the object can't have its height or width resized to a value
5151 * higher than the original icon size. Same is valid for @p scale_down.
5153 * @see elm_icon_scale_get()
5157 EAPI void elm_icon_scale_set(Evas_Object *obj, Eina_Bool scale_up, Eina_Bool scale_down) EINA_ARG_NONNULL(1);
5159 * Get if the object is (up/down) resizable.
5161 * @param obj The icon object
5162 * @param scale_up A bool to set if the object is resizable up
5163 * @param scale_down A bool to set if the object is resizable down
5165 * @see elm_icon_scale_set()
5169 EAPI void elm_icon_scale_get(const Evas_Object *obj, Eina_Bool *scale_up, Eina_Bool *scale_down) EINA_ARG_NONNULL(1);
5171 * Get the object's image size
5173 * @param obj The icon object
5174 * @param w A pointer to store the width in
5175 * @param h A pointer to store the height in
5179 EAPI void elm_icon_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
5181 * Set if the icon fill the entire object area.
5183 * @param obj The icon object
5184 * @param fill_outside @c EINA_TRUE if the object is filled outside,
5185 * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
5187 * When the icon object is resized to a different aspect ratio from the
5188 * original icon image, the icon image will still keep its aspect. This flag
5189 * tells how the image should fill the object's area. They are: keep the
5190 * entire icon inside the limits of height and width of the object (@p
5191 * fill_outside is @c EINA_FALSE) or let the extra width or height go outside
5192 * of the object, and the icon will fill the entire object (@p fill_outside
5195 * @note Unlike @ref Image, there's no option in icon to set the aspect ratio
5196 * retain property to false. Thus, the icon image will always keep its
5197 * original aspect ratio.
5199 * @see elm_icon_fill_outside_get()
5200 * @see elm_image_fill_outside_set()
5204 EAPI void elm_icon_fill_outside_set(Evas_Object *obj, Eina_Bool fill_outside) EINA_ARG_NONNULL(1);
5206 * Get if the object is filled outside.
5208 * @param obj The icon object
5209 * @return @c EINA_TRUE if the object is filled outside, @c EINA_FALSE otherwise.
5211 * @see elm_icon_fill_outside_set()
5215 EAPI Eina_Bool elm_icon_fill_outside_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5217 * Set the prescale size for the icon.
5219 * @param obj The icon object
5220 * @param size The prescale size. This value is used for both width and
5223 * This function sets a new size for pixmap representation of the given
5224 * icon. It allows the icon to be loaded already in the specified size,
5225 * reducing the memory usage and load time when loading a big icon with load
5226 * size set to a smaller size.
5228 * It's equivalent to the elm_bg_load_size_set() function for bg.
5230 * @note this is just a hint, the real size of the pixmap may differ
5231 * depending on the type of icon being loaded, being bigger than requested.
5233 * @see elm_icon_prescale_get()
5234 * @see elm_bg_load_size_set()
5238 EAPI void elm_icon_prescale_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
5240 * Get the prescale size for the icon.
5242 * @param obj The icon object
5243 * @return The prescale size
5245 * @see elm_icon_prescale_set()
5249 EAPI int elm_icon_prescale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5251 * Gets the image object of the icon. DO NOT MODIFY THIS.
5253 * @param obj The icon object
5254 * @return The internal icon object
5258 EAPI Evas_Object *elm_icon_object_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
5260 * Sets the icon lookup order used by elm_icon_standard_set().
5262 * @param obj The icon object
5263 * @param order The icon lookup order (can be one of
5264 * ELM_ICON_LOOKUP_FDO_THEME, ELM_ICON_LOOKUP_THEME_FDO, ELM_ICON_LOOKUP_FDO
5265 * or ELM_ICON_LOOKUP_THEME)
5267 * @see elm_icon_order_lookup_get()
5268 * @see Elm_Icon_Lookup_Order
5272 EAPI void elm_icon_order_lookup_set(Evas_Object *obj, Elm_Icon_Lookup_Order order) EINA_ARG_NONNULL(1);
5274 * Gets the icon lookup order.
5276 * @param obj The icon object
5277 * @return The icon lookup order
5279 * @see elm_icon_order_lookup_set()
5280 * @see Elm_Icon_Lookup_Order
5284 EAPI Elm_Icon_Lookup_Order elm_icon_order_lookup_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5286 * Enable or disable preloading of the icon
5288 * @param obj The icon object
5289 * @param disable If EINA_TRUE, preloading will be disabled
5292 EAPI void elm_icon_preload_set(Evas_Object *obj, Eina_Bool disable) EINA_ARG_NONNULL(1);
5294 * Get if the icon supports animation or not.
5296 * @param obj The icon object
5297 * @return @c EINA_TRUE if the icon supports animation,
5298 * @c EINA_FALSE otherwise.
5300 * Return if this elm icon's image can be animated. Currently Evas only
5301 * supports gif animation. If the return value is EINA_FALSE, other
5302 * elm_icon_animated_XXX APIs won't work.
5305 EAPI Eina_Bool elm_icon_animated_available_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5307 * Set animation mode of the icon.
5309 * @param obj The icon object
5310 * @param anim @c EINA_TRUE if the object do animation job,
5311 * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
5313 * Since the default animation mode is set to EINA_FALSE,
5314 * the icon is shown without animation.
5315 * This might be desirable when the application developer wants to show
5316 * a snapshot of the animated icon.
5317 * Set it to EINA_TRUE when the icon needs to be animated.
5320 EAPI void elm_icon_animated_set(Evas_Object *obj, Eina_Bool animated) EINA_ARG_NONNULL(1);
5322 * Get animation mode of the icon.
5324 * @param obj The icon object
5325 * @return The animation mode of the icon object
5326 * @see elm_icon_animated_set
5329 EAPI Eina_Bool elm_icon_animated_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5331 * Set animation play mode of the icon.
5333 * @param obj The icon object
5334 * @param play @c EINA_TRUE the object play animation images,
5335 * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
5337 * To play elm icon's animation, set play to EINA_TURE.
5338 * For example, you make gif player using this set/get API and click event.
5340 * 1. Click event occurs
5341 * 2. Check play flag using elm_icon_animaged_play_get
5342 * 3. If elm icon was playing, set play to EINA_FALSE.
5343 * Then animation will be stopped and vice versa
5346 EAPI void elm_icon_animated_play_set(Evas_Object *obj, Eina_Bool play) EINA_ARG_NONNULL(1);
5348 * Get animation play mode of the icon.
5350 * @param obj The icon object
5351 * @return The play mode of the icon object
5353 * @see elm_icon_animated_play_get
5356 EAPI Eina_Bool elm_icon_animated_play_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5363 * @defgroup Image Image
5365 * @image html img/widget/image/preview-00.png
5366 * @image latex img/widget/image/preview-00.eps
5369 * An object that allows one to load an image file to it. It can be used
5370 * anywhere like any other elementary widget.
5372 * This widget provides most of the functionality provided from @ref Bg or @ref
5373 * Icon, but with a slightly different API (use the one that fits better your
5376 * The features not provided by those two other image widgets are:
5377 * @li allowing to get the basic @c Evas_Object with elm_image_object_get();
5378 * @li change the object orientation with elm_image_orient_set();
5379 * @li and turning the image editable with elm_image_editable_set().
5381 * Signals that you can add callbacks for are:
5383 * @li @c "clicked" - This is called when a user has clicked the image
5385 * An example of usage for this API follows:
5386 * @li @ref tutorial_image
5395 * @enum _Elm_Image_Orient
5396 * @typedef Elm_Image_Orient
5398 * Possible orientation options for elm_image_orient_set().
5400 * @image html elm_image_orient_set.png
5401 * @image latex elm_image_orient_set.eps width=\textwidth
5405 typedef enum _Elm_Image_Orient
5407 ELM_IMAGE_ORIENT_NONE, /**< no orientation change */
5408 ELM_IMAGE_ROTATE_90_CW, /**< rotate 90 degrees clockwise */
5409 ELM_IMAGE_ROTATE_180_CW, /**< rotate 180 degrees clockwise */
5410 ELM_IMAGE_ROTATE_90_CCW, /**< rotate 90 degrees counter-clockwise (i.e. 270 degrees clockwise) */
5411 ELM_IMAGE_FLIP_HORIZONTAL, /**< flip image horizontally */
5412 ELM_IMAGE_FLIP_VERTICAL, /**< flip image vertically */
5413 ELM_IMAGE_FLIP_TRANSPOSE, /**< flip the image along the y = (side - x) line*/
5414 ELM_IMAGE_FLIP_TRANSVERSE /**< flip the image along the y = x line */
5418 * Add a new image to the parent.
5420 * @param parent The parent object
5421 * @return The new object or NULL if it cannot be created
5423 * @see elm_image_file_set()
5427 EAPI Evas_Object *elm_image_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5429 * Set the file that will be used as image.
5431 * @param obj The image object
5432 * @param file The path to file that will be used as image
5433 * @param group The group that the image belongs in edje file (if it's an
5436 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
5438 * @see elm_image_file_get()
5442 EAPI Eina_Bool elm_image_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
5444 * Get the file that will be used as image.
5446 * @param obj The image object
5447 * @param file The path to file
5448 * @param group The group that the image belongs in edje file
5450 * @see elm_image_file_set()
5454 EAPI void elm_image_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
5456 * Set the smooth effect for an image.
5458 * @param obj The image object
5459 * @param smooth @c EINA_TRUE if smooth scaling should be used, @c EINA_FALSE
5460 * otherwise. Default is @c EINA_TRUE.
5462 * Set the scaling algorithm to be used when scaling the image. Smooth
5463 * scaling provides a better resulting image, but is slower.
5465 * The smooth scaling should be disabled when making animations that change
5466 * the image size, since it will be faster. Animations that don't require
5467 * resizing of the image can keep the smooth scaling enabled (even if the
5468 * image is already scaled, since the scaled image will be cached).
5470 * @see elm_image_smooth_get()
5474 EAPI void elm_image_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
5476 * Get the smooth effect for an image.
5478 * @param obj The image object
5479 * @return @c EINA_TRUE if smooth scaling is enabled, @c EINA_FALSE otherwise.
5481 * @see elm_image_smooth_get()
5485 EAPI Eina_Bool elm_image_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5488 * Gets the current size of the image.
5490 * @param obj The image object.
5491 * @param w Pointer to store width, or NULL.
5492 * @param h Pointer to store height, or NULL.
5494 * This is the real size of the image, not the size of the object.
5496 * On error, neither w or h will be written.
5500 EAPI void elm_image_object_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
5502 * Disable scaling of this object.
5504 * @param obj The image object.
5505 * @param no_scale @c EINA_TRUE if the object is not scalable, @c EINA_FALSE
5506 * otherwise. Default is @c EINA_FALSE.
5508 * This function disables scaling of the elm_image widget through the
5509 * function elm_object_scale_set(). However, this does not affect the widget
5510 * size/resize in any way. For that effect, take a look at
5511 * elm_image_scale_set().
5513 * @see elm_image_no_scale_get()
5514 * @see elm_image_scale_set()
5515 * @see elm_object_scale_set()
5519 EAPI void elm_image_no_scale_set(Evas_Object *obj, Eina_Bool no_scale) EINA_ARG_NONNULL(1);
5521 * Get whether scaling is disabled on the object.
5523 * @param obj The image object
5524 * @return @c EINA_TRUE if scaling is disabled, @c EINA_FALSE otherwise
5526 * @see elm_image_no_scale_set()
5530 EAPI Eina_Bool elm_image_no_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5532 * Set if the object is (up/down) resizable.
5534 * @param obj The image object
5535 * @param scale_up A bool to set if the object is resizable up. Default is
5537 * @param scale_down A bool to set if the object is resizable down. Default
5540 * This function limits the image resize ability. If @p scale_up is set to
5541 * @c EINA_FALSE, the object can't have its height or width resized to a value
5542 * higher than the original image size. Same is valid for @p scale_down.
5544 * @see elm_image_scale_get()
5548 EAPI void elm_image_scale_set(Evas_Object *obj, Eina_Bool scale_up, Eina_Bool scale_down) EINA_ARG_NONNULL(1);
5550 * Get if the object is (up/down) resizable.
5552 * @param obj The image object
5553 * @param scale_up A bool to set if the object is resizable up
5554 * @param scale_down A bool to set if the object is resizable down
5556 * @see elm_image_scale_set()
5560 EAPI void elm_image_scale_get(const Evas_Object *obj, Eina_Bool *scale_up, Eina_Bool *scale_down) EINA_ARG_NONNULL(1);
5562 * Set if the image fills the entire object area, when keeping the aspect ratio.
5564 * @param obj The image object
5565 * @param fill_outside @c EINA_TRUE if the object is filled outside,
5566 * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
5568 * When the image should keep its aspect ratio even if resized to another
5569 * aspect ratio, there are two possibilities to resize it: keep the entire
5570 * image inside the limits of height and width of the object (@p fill_outside
5571 * is @c EINA_FALSE) or let the extra width or height go outside of the object,
5572 * and the image will fill the entire object (@p fill_outside is @c EINA_TRUE).
5574 * @note This option will have no effect if
5575 * elm_image_aspect_ratio_retained_set() is set to @c EINA_FALSE.
5577 * @see elm_image_fill_outside_get()
5578 * @see elm_image_aspect_ratio_retained_set()
5582 EAPI void elm_image_fill_outside_set(Evas_Object *obj, Eina_Bool fill_outside) EINA_ARG_NONNULL(1);
5584 * Get if the object is filled outside
5586 * @param obj The image object
5587 * @return @c EINA_TRUE if the object is filled outside, @c EINA_FALSE otherwise.
5589 * @see elm_image_fill_outside_set()
5593 EAPI Eina_Bool elm_image_fill_outside_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5595 * Set the prescale size for the image
5597 * @param obj The image object
5598 * @param size The prescale size. This value is used for both width and
5601 * This function sets a new size for pixmap representation of the given
5602 * image. It allows the image to be loaded already in the specified size,
5603 * reducing the memory usage and load time when loading a big image with load
5604 * size set to a smaller size.
5606 * It's equivalent to the elm_bg_load_size_set() function for bg.
5608 * @note this is just a hint, the real size of the pixmap may differ
5609 * depending on the type of image being loaded, being bigger than requested.
5611 * @see elm_image_prescale_get()
5612 * @see elm_bg_load_size_set()
5616 EAPI void elm_image_prescale_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
5618 * Get the prescale size for the image
5620 * @param obj The image object
5621 * @return The prescale size
5623 * @see elm_image_prescale_set()
5627 EAPI int elm_image_prescale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5629 * Set the image orientation.
5631 * @param obj The image object
5632 * @param orient The image orientation @ref Elm_Image_Orient
5633 * Default is #ELM_IMAGE_ORIENT_NONE.
5635 * This function allows to rotate or flip the given image.
5637 * @see elm_image_orient_get()
5638 * @see @ref Elm_Image_Orient
5642 EAPI void elm_image_orient_set(Evas_Object *obj, Elm_Image_Orient orient) EINA_ARG_NONNULL(1);
5644 * Get the image orientation.
5646 * @param obj The image object
5647 * @return The image orientation @ref Elm_Image_Orient
5649 * @see elm_image_orient_set()
5650 * @see @ref Elm_Image_Orient
5654 EAPI Elm_Image_Orient elm_image_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5656 * Make the image 'editable'.
5658 * @param obj Image object.
5659 * @param set Turn on or off editability. Default is @c EINA_FALSE.
5661 * This means the image is a valid drag target for drag and drop, and can be
5662 * cut or pasted too.
5666 EAPI void elm_image_editable_set(Evas_Object *obj, Eina_Bool set) EINA_ARG_NONNULL(1);
5668 * Check if the image 'editable'.
5670 * @param obj Image object.
5671 * @return Editability.
5673 * A return value of EINA_TRUE means the image is a valid drag target
5674 * for drag and drop, and can be cut or pasted too.
5678 EAPI Eina_Bool elm_image_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5680 * Get the basic Evas_Image object from this object (widget).
5682 * @param obj The image object to get the inlined image from
5683 * @return The inlined image object, or NULL if none exists
5685 * This function allows one to get the underlying @c Evas_Object of type
5686 * Image from this elementary widget. It can be useful to do things like get
5687 * the pixel data, save the image to a file, etc.
5689 * @note Be careful to not manipulate it, as it is under control of
5694 EAPI Evas_Object *elm_image_object_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5696 * Set whether the original aspect ratio of the image should be kept on resize.
5698 * @param obj The image object.
5699 * @param retained @c EINA_TRUE if the image should retain the aspect,
5700 * @c EINA_FALSE otherwise.
5702 * The original aspect ratio (width / height) of the image is usually
5703 * distorted to match the object's size. Enabling this option will retain
5704 * this original aspect, and the way that the image is fit into the object's
5705 * area depends on the option set by elm_image_fill_outside_set().
5707 * @see elm_image_aspect_ratio_retained_get()
5708 * @see elm_image_fill_outside_set()
5712 EAPI void elm_image_aspect_ratio_retained_set(Evas_Object *obj, Eina_Bool retained) EINA_ARG_NONNULL(1);
5714 * Get if the object retains the original aspect ratio.
5716 * @param obj The image object.
5717 * @return @c EINA_TRUE if the object keeps the original aspect, @c EINA_FALSE
5722 EAPI Eina_Bool elm_image_aspect_ratio_retained_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5732 * @image html img/widget/box/preview-00.png
5733 * @image latex img/widget/box/preview-00.eps width=\textwidth
5735 * @image html img/box.png
5736 * @image latex img/box.eps width=\textwidth
5738 * A box arranges objects in a linear fashion, governed by a layout function
5739 * that defines the details of this arrangement.
5741 * By default, the box will use an internal function to set the layout to
5742 * a single row, either vertical or horizontal. This layout is affected
5743 * by a number of parameters, such as the homogeneous flag set by
5744 * elm_box_homogeneous_set(), the values given by elm_box_padding_set() and
5745 * elm_box_align_set() and the hints set to each object in the box.
5747 * For this default layout, it's possible to change the orientation with
5748 * elm_box_horizontal_set(). The box will start in the vertical orientation,
5749 * placing its elements ordered from top to bottom. When horizontal is set,
5750 * the order will go from left to right. If the box is set to be
5751 * homogeneous, every object in it will be assigned the same space, that
5752 * of the largest object. Padding can be used to set some spacing between
5753 * the cell given to each object. The alignment of the box, set with
5754 * elm_box_align_set(), determines how the bounding box of all the elements
5755 * will be placed within the space given to the box widget itself.
5757 * The size hints of each object also affect how they are placed and sized
5758 * within the box. evas_object_size_hint_min_set() will give the minimum
5759 * size the object can have, and the box will use it as the basis for all
5760 * latter calculations. Elementary widgets set their own minimum size as
5761 * needed, so there's rarely any need to use it manually.
5763 * evas_object_size_hint_weight_set(), when not in homogeneous mode, is
5764 * used to tell whether the object will be allocated the minimum size it
5765 * needs or if the space given to it should be expanded. It's important
5766 * to realize that expanding the size given to the object is not the same
5767 * thing as resizing the object. It could very well end being a small
5768 * widget floating in a much larger empty space. If not set, the weight
5769 * for objects will normally be 0.0 for both axis, meaning the widget will
5770 * not be expanded. To take as much space possible, set the weight to
5771 * EVAS_HINT_EXPAND (defined to 1.0) for the desired axis to expand.
5773 * Besides how much space each object is allocated, it's possible to control
5774 * how the widget will be placed within that space using
5775 * evas_object_size_hint_align_set(). By default, this value will be 0.5
5776 * for both axis, meaning the object will be centered, but any value from
5777 * 0.0 (left or top, for the @c x and @c y axis, respectively) to 1.0
5778 * (right or bottom) can be used. The special value EVAS_HINT_FILL, which
5779 * is -1.0, means the object will be resized to fill the entire space it
5782 * In addition, customized functions to define the layout can be set, which
5783 * allow the application developer to organize the objects within the box
5784 * in any number of ways.
5786 * The special elm_box_layout_transition() function can be used
5787 * to switch from one layout to another, animating the motion of the
5788 * children of the box.
5790 * @note Objects should not be added to box objects using _add() calls.
5792 * Some examples on how to use boxes follow:
5793 * @li @ref box_example_01
5794 * @li @ref box_example_02
5799 * @typedef Elm_Box_Transition
5801 * Opaque handler containing the parameters to perform an animated
5802 * transition of the layout the box uses.
5804 * @see elm_box_transition_new()
5805 * @see elm_box_layout_set()
5806 * @see elm_box_layout_transition()
5808 typedef struct _Elm_Box_Transition Elm_Box_Transition;
5811 * Add a new box to the parent
5813 * By default, the box will be in vertical mode and non-homogeneous.
5815 * @param parent The parent object
5816 * @return The new object or NULL if it cannot be created
5818 EAPI Evas_Object *elm_box_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5820 * Set the horizontal orientation
5822 * By default, box object arranges their contents vertically from top to
5824 * By calling this function with @p horizontal as EINA_TRUE, the box will
5825 * become horizontal, arranging contents from left to right.
5827 * @note This flag is ignored if a custom layout function is set.
5829 * @param obj The box object
5830 * @param horizontal The horizontal flag (EINA_TRUE = horizontal,
5831 * EINA_FALSE = vertical)
5833 EAPI void elm_box_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
5835 * Get the horizontal orientation
5837 * @param obj The box object
5838 * @return EINA_TRUE if the box is set to horizontal mode, EINA_FALSE otherwise
5840 EAPI Eina_Bool elm_box_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5842 * Set the box to arrange its children homogeneously
5844 * If enabled, homogeneous layout makes all items the same size, according
5845 * to the size of the largest of its children.
5847 * @note This flag is ignored if a custom layout function is set.
5849 * @param obj The box object
5850 * @param homogeneous The homogeneous flag
5852 EAPI void elm_box_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
5854 * Get whether the box is using homogeneous mode or not
5856 * @param obj The box object
5857 * @return EINA_TRUE if it's homogeneous, EINA_FALSE otherwise
5859 EAPI Eina_Bool elm_box_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5861 * Add an object to the beginning of the pack list
5863 * Pack @p subobj into the box @p obj, placing it first in the list of
5864 * children objects. The actual position the object will get on screen
5865 * depends on the layout used. If no custom layout is set, it will be at
5866 * the top or left, depending if the box is vertical or horizontal,
5869 * @param obj The box object
5870 * @param subobj The object to add to the box
5872 * @see elm_box_pack_end()
5873 * @see elm_box_pack_before()
5874 * @see elm_box_pack_after()
5875 * @see elm_box_unpack()
5876 * @see elm_box_unpack_all()
5877 * @see elm_box_clear()
5879 EAPI void elm_box_pack_start(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
5881 * Add an object at the end of the pack list
5883 * Pack @p subobj into the box @p obj, placing it last in the list of
5884 * children objects. The actual position the object will get on screen
5885 * depends on the layout used. If no custom layout is set, it will be at
5886 * the bottom or right, depending if the box is vertical or horizontal,
5889 * @param obj The box object
5890 * @param subobj The object to add to the box
5892 * @see elm_box_pack_start()
5893 * @see elm_box_pack_before()
5894 * @see elm_box_pack_after()
5895 * @see elm_box_unpack()
5896 * @see elm_box_unpack_all()
5897 * @see elm_box_clear()
5899 EAPI void elm_box_pack_end(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
5901 * Adds an object to the box before the indicated object
5903 * This will add the @p subobj to the box indicated before the object
5904 * indicated with @p before. If @p before is not already in the box, results
5905 * are undefined. Before means either to the left of the indicated object or
5906 * above it depending on orientation.
5908 * @param obj The box object
5909 * @param subobj The object to add to the box
5910 * @param before The object before which to add it
5912 * @see elm_box_pack_start()
5913 * @see elm_box_pack_end()
5914 * @see elm_box_pack_after()
5915 * @see elm_box_unpack()
5916 * @see elm_box_unpack_all()
5917 * @see elm_box_clear()
5919 EAPI void elm_box_pack_before(Evas_Object *obj, Evas_Object *subobj, Evas_Object *before) EINA_ARG_NONNULL(1);
5921 * Adds an object to the box after the indicated object
5923 * This will add the @p subobj to the box indicated after the object
5924 * indicated with @p after. If @p after is not already in the box, results
5925 * are undefined. After means either to the right of the indicated object or
5926 * below it depending on orientation.
5928 * @param obj The box object
5929 * @param subobj The object to add to the box
5930 * @param after The object after which to add it
5932 * @see elm_box_pack_start()
5933 * @see elm_box_pack_end()
5934 * @see elm_box_pack_before()
5935 * @see elm_box_unpack()
5936 * @see elm_box_unpack_all()
5937 * @see elm_box_clear()
5939 EAPI void elm_box_pack_after(Evas_Object *obj, Evas_Object *subobj, Evas_Object *after) EINA_ARG_NONNULL(1);
5941 * Clear the box of all children
5943 * Remove all the elements contained by the box, deleting the respective
5946 * @param obj The box object
5948 * @see elm_box_unpack()
5949 * @see elm_box_unpack_all()
5951 EAPI void elm_box_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
5955 * Remove the object given by @p subobj from the box @p obj without
5958 * @param obj The box object
5960 * @see elm_box_unpack_all()
5961 * @see elm_box_clear()
5963 EAPI void elm_box_unpack(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
5965 * Remove all items from the box, without deleting them
5967 * Clear the box from all children, but don't delete the respective objects.
5968 * If no other references of the box children exist, the objects will never
5969 * be deleted, and thus the application will leak the memory. Make sure
5970 * when using this function that you hold a reference to all the objects
5971 * in the box @p obj.
5973 * @param obj The box object
5975 * @see elm_box_clear()
5976 * @see elm_box_unpack()
5978 EAPI void elm_box_unpack_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
5980 * Retrieve a list of the objects packed into the box
5982 * Returns a new @c Eina_List with a pointer to @c Evas_Object in its nodes.
5983 * The order of the list corresponds to the packing order the box uses.
5985 * You must free this list with eina_list_free() once you are done with it.
5987 * @param obj The box object
5989 EAPI const Eina_List *elm_box_children_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5991 * Set the space (padding) between the box's elements.
5993 * Extra space in pixels that will be added between a box child and its
5994 * neighbors after its containing cell has been calculated. This padding
5995 * is set for all elements in the box, besides any possible padding that
5996 * individual elements may have through their size hints.
5998 * @param obj The box object
5999 * @param horizontal The horizontal space between elements
6000 * @param vertical The vertical space between elements
6002 EAPI void elm_box_padding_set(Evas_Object *obj, Evas_Coord horizontal, Evas_Coord vertical) EINA_ARG_NONNULL(1);
6004 * Get the space (padding) between the box's elements.
6006 * @param obj The box object
6007 * @param horizontal The horizontal space between elements
6008 * @param vertical The vertical space between elements
6010 * @see elm_box_padding_set()
6012 EAPI void elm_box_padding_get(const Evas_Object *obj, Evas_Coord *horizontal, Evas_Coord *vertical) EINA_ARG_NONNULL(1);
6014 * Set the alignment of the whole bouding box of contents.
6016 * Sets how the bounding box containing all the elements of the box, after
6017 * their sizes and position has been calculated, will be aligned within
6018 * the space given for the whole box widget.
6020 * @param obj The box object
6021 * @param horizontal The horizontal alignment of elements
6022 * @param vertical The vertical alignment of elements
6024 EAPI void elm_box_align_set(Evas_Object *obj, double horizontal, double vertical) EINA_ARG_NONNULL(1);
6026 * Get the alignment of the whole bouding box of contents.
6028 * @param obj The box object
6029 * @param horizontal The horizontal alignment of elements
6030 * @param vertical The vertical alignment of elements
6032 * @see elm_box_align_set()
6034 EAPI void elm_box_align_get(const Evas_Object *obj, double *horizontal, double *vertical) EINA_ARG_NONNULL(1);
6037 * Force the box to recalculate its children packing.
6039 * If any children was added or removed, box will not calculate the
6040 * values immediately rather leaving it to the next main loop
6041 * iteration. While this is great as it would save lots of
6042 * recalculation, whenever you need to get the position of a just
6043 * added item you must force recalculate before doing so.
6045 * @param obj The box object.
6047 EAPI void elm_box_recalculate(Evas_Object *obj);
6050 * Set the layout defining function to be used by the box
6052 * Whenever anything changes that requires the box in @p obj to recalculate
6053 * the size and position of its elements, the function @p cb will be called
6054 * to determine what the layout of the children will be.
6056 * Once a custom function is set, everything about the children layout
6057 * is defined by it. The flags set by elm_box_horizontal_set() and
6058 * elm_box_homogeneous_set() no longer have any meaning, and the values
6059 * given by elm_box_padding_set() and elm_box_align_set() are up to this
6060 * layout function to decide if they are used and how. These last two
6061 * will be found in the @c priv parameter, of type @c Evas_Object_Box_Data,
6062 * passed to @p cb. The @c Evas_Object the function receives is not the
6063 * Elementary widget, but the internal Evas Box it uses, so none of the
6064 * functions described here can be used on it.
6066 * Any of the layout functions in @c Evas can be used here, as well as the
6067 * special elm_box_layout_transition().
6069 * The final @p data argument received by @p cb is the same @p data passed
6070 * here, and the @p free_data function will be called to free it
6071 * whenever the box is destroyed or another layout function is set.
6073 * Setting @p cb to NULL will revert back to the default layout function.
6075 * @param obj The box object
6076 * @param cb The callback function used for layout
6077 * @param data Data that will be passed to layout function
6078 * @param free_data Function called to free @p data
6080 * @see elm_box_layout_transition()
6082 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);
6084 * Special layout function that animates the transition from one layout to another
6086 * Normally, when switching the layout function for a box, this will be
6087 * reflected immediately on screen on the next render, but it's also
6088 * possible to do this through an animated transition.
6090 * This is done by creating an ::Elm_Box_Transition and setting the box
6091 * layout to this function.
6095 * Elm_Box_Transition *t = elm_box_transition_new(1.0,
6096 * evas_object_box_layout_vertical, // start
6097 * NULL, // data for initial layout
6098 * NULL, // free function for initial data
6099 * evas_object_box_layout_horizontal, // end
6100 * NULL, // data for final layout
6101 * NULL, // free function for final data
6102 * anim_end, // will be called when animation ends
6103 * NULL); // data for anim_end function\
6104 * elm_box_layout_set(box, elm_box_layout_transition, t,
6105 * elm_box_transition_free);
6108 * @note This function can only be used with elm_box_layout_set(). Calling
6109 * it directly will not have the expected results.
6111 * @see elm_box_transition_new
6112 * @see elm_box_transition_free
6113 * @see elm_box_layout_set
6115 EAPI void elm_box_layout_transition(Evas_Object *obj, Evas_Object_Box_Data *priv, void *data);
6117 * Create a new ::Elm_Box_Transition to animate the switch of layouts
6119 * If you want to animate the change from one layout to another, you need
6120 * to set the layout function of the box to elm_box_layout_transition(),
6121 * passing as user data to it an instance of ::Elm_Box_Transition with the
6122 * necessary information to perform this animation. The free function to
6123 * set for the layout is elm_box_transition_free().
6125 * The parameters to create an ::Elm_Box_Transition sum up to how long
6126 * will it be, in seconds, a layout function to describe the initial point,
6127 * another for the final position of the children and one function to be
6128 * called when the whole animation ends. This last function is useful to
6129 * set the definitive layout for the box, usually the same as the end
6130 * layout for the animation, but could be used to start another transition.
6132 * @param start_layout The layout function that will be used to start the animation
6133 * @param start_layout_data The data to be passed the @p start_layout function
6134 * @param start_layout_free_data Function to free @p start_layout_data
6135 * @param end_layout The layout function that will be used to end the animation
6136 * @param end_layout_free_data The data to be passed the @p end_layout function
6137 * @param end_layout_free_data Function to free @p end_layout_data
6138 * @param transition_end_cb Callback function called when animation ends
6139 * @param transition_end_data Data to be passed to @p transition_end_cb
6140 * @return An instance of ::Elm_Box_Transition
6142 * @see elm_box_transition_new
6143 * @see elm_box_layout_transition
6145 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);
6147 * Free a Elm_Box_Transition instance created with elm_box_transition_new().
6149 * This function is mostly useful as the @c free_data parameter in
6150 * elm_box_layout_set() when elm_box_layout_transition().
6152 * @param data The Elm_Box_Transition instance to be freed.
6154 * @see elm_box_transition_new
6155 * @see elm_box_layout_transition
6157 EAPI void elm_box_transition_free(void *data);
6164 * @defgroup Button Button
6166 * @image html img/widget/button/preview-00.png
6167 * @image latex img/widget/button/preview-00.eps
6168 * @image html img/widget/button/preview-01.png
6169 * @image latex img/widget/button/preview-01.eps
6170 * @image html img/widget/button/preview-02.png
6171 * @image latex img/widget/button/preview-02.eps
6173 * This is a push-button. Press it and run some function. It can contain
6174 * a simple label and icon object and it also has an autorepeat feature.
6176 * This widgets emits the following signals:
6177 * @li "clicked": the user clicked the button (press/release).
6178 * @li "repeated": the user pressed the button without releasing it.
6179 * @li "pressed": button was pressed.
6180 * @li "unpressed": button was released after being pressed.
6181 * In all three cases, the @c event parameter of the callback will be
6184 * Also, defined in the default theme, the button has the following styles
6186 * @li default: a normal button.
6187 * @li anchor: Like default, but the button fades away when the mouse is not
6188 * over it, leaving only the text or icon.
6189 * @li hoversel_vertical: Internally used by @ref Hoversel to give a
6190 * continuous look across its options.
6191 * @li hoversel_vertical_entry: Another internal for @ref Hoversel.
6193 * Default contents parts of the button widget that you can use for are:
6194 * @li "icon" - An icon of the button
6196 * Default text parts of the button widget that you can use for are:
6197 * @li "default" - Label of the button
6199 * Follow through a complete example @ref button_example_01 "here".
6203 * Add a new button to the parent's canvas
6205 * @param parent The parent object
6206 * @return The new object or NULL if it cannot be created
6208 EAPI Evas_Object *elm_button_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6210 * Set the label used in the button
6212 * The passed @p label can be NULL to clean any existing text in it and
6213 * leave the button as an icon only object.
6215 * @param obj The button object
6216 * @param label The text will be written on the button
6217 * @deprecated use elm_object_text_set() instead.
6219 EINA_DEPRECATED EAPI void elm_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
6221 * Get the label set for the button
6223 * The string returned is an internal pointer and should not be freed or
6224 * altered. It will also become invalid when the button is destroyed.
6225 * The string returned, if not NULL, is a stringshare, so if you need to
6226 * keep it around even after the button is destroyed, you can use
6227 * eina_stringshare_ref().
6229 * @param obj The button object
6230 * @return The text set to the label, or NULL if nothing is set
6231 * @deprecated use elm_object_text_set() instead.
6233 EINA_DEPRECATED EAPI const char *elm_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6235 * Set the icon used for the button
6237 * Setting a new icon will delete any other that was previously set, making
6238 * any reference to them invalid. If you need to maintain the previous
6239 * object alive, unset it first with elm_button_icon_unset().
6241 * @param obj The button object
6242 * @param icon The icon object for the button
6243 * @deprecated use elm_object_part_content_set() instead.
6245 EINA_DEPRECATED EAPI void elm_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
6247 * Get the icon used for the button
6249 * Return the icon object which is set for this widget. If the button is
6250 * destroyed or another icon is set, the returned object will be deleted
6251 * and any reference to it will be invalid.
6253 * @param obj The button object
6254 * @return The icon object that is being used
6256 * @deprecated use elm_object_part_content_get() instead
6258 EINA_DEPRECATED EAPI Evas_Object *elm_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6260 * Remove the icon set without deleting it and return the object
6262 * This function drops the reference the button holds of the icon object
6263 * and returns this last object. It is used in case you want to remove any
6264 * icon, or set another one, without deleting the actual object. The button
6265 * will be left without an icon set.
6267 * @param obj The button object
6268 * @return The icon object that was being used
6269 * @deprecated use elm_object_part_content_unset() instead.
6271 EINA_DEPRECATED EAPI Evas_Object *elm_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6273 * Turn on/off the autorepeat event generated when the button is kept pressed
6275 * When off, no autorepeat is performed and buttons emit a normal @c clicked
6276 * signal when they are clicked.
6278 * When on, keeping a button pressed will continuously emit a @c repeated
6279 * signal until the button is released. The time it takes until it starts
6280 * emitting the signal is given by
6281 * elm_button_autorepeat_initial_timeout_set(), and the time between each
6282 * new emission by elm_button_autorepeat_gap_timeout_set().
6284 * @param obj The button object
6285 * @param on A bool to turn on/off the event
6287 EAPI void elm_button_autorepeat_set(Evas_Object *obj, Eina_Bool on) EINA_ARG_NONNULL(1);
6289 * Get whether the autorepeat feature is enabled
6291 * @param obj The button object
6292 * @return EINA_TRUE if autorepeat is on, EINA_FALSE otherwise
6294 * @see elm_button_autorepeat_set()
6296 EAPI Eina_Bool elm_button_autorepeat_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6298 * Set the initial timeout before the autorepeat event is generated
6300 * Sets the timeout, in seconds, since the button is pressed until the
6301 * first @c repeated signal is emitted. If @p t is 0.0 or less, there
6302 * won't be any delay and the even will be fired the moment the button is
6305 * @param obj The button object
6306 * @param t Timeout in seconds
6308 * @see elm_button_autorepeat_set()
6309 * @see elm_button_autorepeat_gap_timeout_set()
6311 EAPI void elm_button_autorepeat_initial_timeout_set(Evas_Object *obj, double t) EINA_ARG_NONNULL(1);
6313 * Get the initial timeout before the autorepeat event is generated
6315 * @param obj The button object
6316 * @return Timeout in seconds
6318 * @see elm_button_autorepeat_initial_timeout_set()
6320 EAPI double elm_button_autorepeat_initial_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6322 * Set the interval between each generated autorepeat event
6324 * After the first @c repeated event is fired, all subsequent ones will
6325 * follow after a delay of @p t seconds for each.
6327 * @param obj The button object
6328 * @param t Interval in seconds
6330 * @see elm_button_autorepeat_initial_timeout_set()
6332 EAPI void elm_button_autorepeat_gap_timeout_set(Evas_Object *obj, double t) EINA_ARG_NONNULL(1);
6334 * Get the interval between each generated autorepeat event
6336 * @param obj The button object
6337 * @return Interval in seconds
6339 EAPI double elm_button_autorepeat_gap_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6345 * @defgroup File_Selector_Button File Selector Button
6347 * @image html img/widget/fileselector_button/preview-00.png
6348 * @image latex img/widget/fileselector_button/preview-00.eps
6349 * @image html img/widget/fileselector_button/preview-01.png
6350 * @image latex img/widget/fileselector_button/preview-01.eps
6351 * @image html img/widget/fileselector_button/preview-02.png
6352 * @image latex img/widget/fileselector_button/preview-02.eps
6354 * This is a button that, when clicked, creates an Elementary
6355 * window (or inner window) <b> with a @ref Fileselector "file
6356 * selector widget" within</b>. When a file is chosen, the (inner)
6357 * window is closed and the button emits a signal having the
6358 * selected file as it's @c event_info.
6360 * This widget encapsulates operations on its internal file
6361 * selector on its own API. There is less control over its file
6362 * selector than that one would have instatiating one directly.
6364 * The following styles are available for this button:
6367 * @li @c "hoversel_vertical"
6368 * @li @c "hoversel_vertical_entry"
6370 * Smart callbacks one can register to:
6371 * - @c "file,chosen" - the user has selected a path, whose string
6372 * pointer comes as the @c event_info data (a stringshared
6375 * Here is an example on its usage:
6376 * @li @ref fileselector_button_example
6378 * @see @ref File_Selector_Entry for a similar widget.
6383 * Add a new file selector button widget to the given parent
6384 * Elementary (container) object
6386 * @param parent The parent object
6387 * @return a new file selector button widget handle or @c NULL, on
6390 EAPI Evas_Object *elm_fileselector_button_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6393 * Set the label for a given file selector button widget
6395 * @param obj The file selector button widget
6396 * @param label The text label to be displayed on @p obj
6398 * @deprecated use elm_object_text_set() instead.
6400 EINA_DEPRECATED EAPI void elm_fileselector_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
6403 * Get the label set for a given file selector button widget
6405 * @param obj The file selector button widget
6406 * @return The button label
6408 * @deprecated use elm_object_text_set() instead.
6410 EINA_DEPRECATED EAPI const char *elm_fileselector_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6413 * Set the icon on a given file selector button widget
6415 * @param obj The file selector button widget
6416 * @param icon The icon object for the button
6418 * Once the icon object is set, a previously set one will be
6419 * deleted. If you want to keep the latter, use the
6420 * elm_fileselector_button_icon_unset() function.
6422 * @see elm_fileselector_button_icon_get()
6424 EAPI void elm_fileselector_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
6427 * Get the icon set for a given file selector button widget
6429 * @param obj The file selector button widget
6430 * @return The icon object currently set on @p obj or @c NULL, if
6433 * @see elm_fileselector_button_icon_set()
6435 EAPI Evas_Object *elm_fileselector_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6438 * Unset the icon used in a given file selector button widget
6440 * @param obj The file selector button widget
6441 * @return The icon object that was being used on @p obj or @c
6444 * Unparent and return the icon object which was set for this
6447 * @see elm_fileselector_button_icon_set()
6449 EAPI Evas_Object *elm_fileselector_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6452 * Set the title for a given file selector button widget's window
6454 * @param obj The file selector button widget
6455 * @param title The title string
6457 * This will change the window's title, when the file selector pops
6458 * out after a click on the button. Those windows have the default
6459 * (unlocalized) value of @c "Select a file" as titles.
6461 * @note It will only take any effect if the file selector
6462 * button widget is @b not under "inwin mode".
6464 * @see elm_fileselector_button_window_title_get()
6466 EAPI void elm_fileselector_button_window_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
6469 * Get the title set for a given file selector button widget's
6472 * @param obj The file selector button widget
6473 * @return Title of the file selector button's window
6475 * @see elm_fileselector_button_window_title_get() for more details
6477 EAPI const char *elm_fileselector_button_window_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6480 * Set the size of a given file selector button widget's window,
6481 * holding the file selector itself.
6483 * @param obj The file selector button widget
6484 * @param width The window's width
6485 * @param height The window's height
6487 * @note it will only take any effect if the file selector button
6488 * widget is @b not under "inwin mode". The default size for the
6489 * window (when applicable) is 400x400 pixels.
6491 * @see elm_fileselector_button_window_size_get()
6493 EAPI void elm_fileselector_button_window_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
6496 * Get the size of a given file selector button widget's window,
6497 * holding the file selector itself.
6499 * @param obj The file selector button widget
6500 * @param width Pointer into which to store the width value
6501 * @param height Pointer into which to store the height value
6503 * @note Use @c NULL pointers on the size values you're not
6504 * interested in: they'll be ignored by the function.
6506 * @see elm_fileselector_button_window_size_set(), for more details
6508 EAPI void elm_fileselector_button_window_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
6511 * Set the initial file system path for a given file selector
6514 * @param obj The file selector button widget
6515 * @param path The path string
6517 * It must be a <b>directory</b> path, which will have the contents
6518 * displayed initially in the file selector's view, when invoked
6519 * from @p obj. The default initial path is the @c "HOME"
6520 * environment variable's value.
6522 * @see elm_fileselector_button_path_get()
6524 EAPI void elm_fileselector_button_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
6527 * Get the initial file system path set for a given file selector
6530 * @param obj The file selector button widget
6531 * @return path The path string
6533 * @see elm_fileselector_button_path_set() for more details
6535 EAPI const char *elm_fileselector_button_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6538 * Enable/disable a tree view in the given file selector button
6539 * widget's internal file selector
6541 * @param obj The file selector button widget
6542 * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
6545 * This has the same effect as elm_fileselector_expandable_set(),
6546 * but now applied to a file selector button's internal file
6549 * @note There's no way to put a file selector button's internal
6550 * file selector in "grid mode", as one may do with "pure" file
6553 * @see elm_fileselector_expandable_get()
6555 EAPI void elm_fileselector_button_expandable_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6558 * Get whether tree view is enabled for the given file selector
6559 * button widget's internal file selector
6561 * @param obj The file selector button widget
6562 * @return @c EINA_TRUE if @p obj widget's internal file selector
6563 * is in tree view, @c EINA_FALSE otherwise (and or errors)
6565 * @see elm_fileselector_expandable_set() for more details
6567 EAPI Eina_Bool elm_fileselector_button_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6570 * Set whether a given file selector button widget's internal file
6571 * selector is to display folders only or the directory contents,
6574 * @param obj The file selector button widget
6575 * @param only @c EINA_TRUE to make @p obj widget's internal file
6576 * selector only display directories, @c EINA_FALSE to make files
6577 * to be displayed in it too
6579 * This has the same effect as elm_fileselector_folder_only_set(),
6580 * but now applied to a file selector button's internal file
6583 * @see elm_fileselector_folder_only_get()
6585 EAPI void elm_fileselector_button_folder_only_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6588 * Get whether a given file selector button widget's internal file
6589 * selector is displaying folders only or the directory contents,
6592 * @param obj The file selector button widget
6593 * @return @c EINA_TRUE if @p obj widget's internal file
6594 * selector is only displaying directories, @c EINA_FALSE if files
6595 * are being displayed in it too (and on errors)
6597 * @see elm_fileselector_button_folder_only_set() for more details
6599 EAPI Eina_Bool elm_fileselector_button_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6602 * Enable/disable the file name entry box where the user can type
6603 * in a name for a file, in a given file selector button widget's
6604 * internal file selector.
6606 * @param obj The file selector button widget
6607 * @param is_save @c EINA_TRUE to make @p obj widget's internal
6608 * file selector a "saving dialog", @c EINA_FALSE otherwise
6610 * This has the same effect as elm_fileselector_is_save_set(),
6611 * but now applied to a file selector button's internal file
6614 * @see elm_fileselector_is_save_get()
6616 EAPI void elm_fileselector_button_is_save_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6619 * Get whether the given file selector button widget's internal
6620 * file selector is in "saving dialog" mode
6622 * @param obj The file selector button widget
6623 * @return @c EINA_TRUE, if @p obj widget's internal file selector
6624 * is in "saving dialog" mode, @c EINA_FALSE otherwise (and on
6627 * @see elm_fileselector_button_is_save_set() for more details
6629 EAPI Eina_Bool elm_fileselector_button_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6632 * Set whether a given file selector button widget's internal file
6633 * selector will raise an Elementary "inner window", instead of a
6634 * dedicated Elementary window. By default, it won't.
6636 * @param obj The file selector button widget
6637 * @param value @c EINA_TRUE to make it use an inner window, @c
6638 * EINA_TRUE to make it use a dedicated window
6640 * @see elm_win_inwin_add() for more information on inner windows
6641 * @see elm_fileselector_button_inwin_mode_get()
6643 EAPI void elm_fileselector_button_inwin_mode_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6646 * Get whether a given file selector button widget's internal file
6647 * selector will raise an Elementary "inner window", instead of a
6648 * dedicated Elementary window.
6650 * @param obj The file selector button widget
6651 * @return @c EINA_TRUE if will use an inner window, @c EINA_TRUE
6652 * if it will use a dedicated window
6654 * @see elm_fileselector_button_inwin_mode_set() for more details
6656 EAPI Eina_Bool elm_fileselector_button_inwin_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6663 * @defgroup File_Selector_Entry File Selector Entry
6665 * @image html img/widget/fileselector_entry/preview-00.png
6666 * @image latex img/widget/fileselector_entry/preview-00.eps
6668 * This is an entry made to be filled with or display a <b>file
6669 * system path string</b>. Besides the entry itself, the widget has
6670 * a @ref File_Selector_Button "file selector button" on its side,
6671 * which will raise an internal @ref Fileselector "file selector widget",
6672 * when clicked, for path selection aided by file system
6675 * This file selector may appear in an Elementary window or in an
6676 * inner window. When a file is chosen from it, the (inner) window
6677 * is closed and the selected file's path string is exposed both as
6678 * an smart event and as the new text on the entry.
6680 * This widget encapsulates operations on its internal file
6681 * selector on its own API. There is less control over its file
6682 * selector than that one would have instatiating one directly.
6684 * Smart callbacks one can register to:
6685 * - @c "changed" - The text within the entry was changed
6686 * - @c "activated" - The entry has had editing finished and
6687 * changes are to be "committed"
6688 * - @c "press" - The entry has been clicked
6689 * - @c "longpressed" - The entry has been clicked (and held) for a
6691 * - @c "clicked" - The entry has been clicked
6692 * - @c "clicked,double" - The entry has been double clicked
6693 * - @c "focused" - The entry has received focus
6694 * - @c "unfocused" - The entry has lost focus
6695 * - @c "selection,paste" - A paste action has occurred on the
6697 * - @c "selection,copy" - A copy action has occurred on the entry
6698 * - @c "selection,cut" - A cut action has occurred on the entry
6699 * - @c "unpressed" - The file selector entry's button was released
6700 * after being pressed.
6701 * - @c "file,chosen" - The user has selected a path via the file
6702 * selector entry's internal file selector, whose string pointer
6703 * comes as the @c event_info data (a stringshared string)
6705 * Here is an example on its usage:
6706 * @li @ref fileselector_entry_example
6708 * @see @ref File_Selector_Button for a similar widget.
6713 * Add a new file selector entry widget to the given parent
6714 * Elementary (container) object
6716 * @param parent The parent object
6717 * @return a new file selector entry widget handle or @c NULL, on
6720 EAPI Evas_Object *elm_fileselector_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6723 * Set the label for a given file selector entry widget's button
6725 * @param obj The file selector entry widget
6726 * @param label The text label to be displayed on @p obj widget's
6729 * @deprecated use elm_object_text_set() instead.
6731 EINA_DEPRECATED EAPI void elm_fileselector_entry_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
6734 * Get the label set for a given file selector entry widget's button
6736 * @param obj The file selector entry widget
6737 * @return The widget button's label
6739 * @deprecated use elm_object_text_set() instead.
6741 EINA_DEPRECATED EAPI const char *elm_fileselector_entry_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6744 * Set the icon on a given file selector entry widget's button
6746 * @param obj The file selector entry widget
6747 * @param icon The icon object for the entry's button
6749 * Once the icon object is set, a previously set one will be
6750 * deleted. If you want to keep the latter, use the
6751 * elm_fileselector_entry_button_icon_unset() function.
6753 * @see elm_fileselector_entry_button_icon_get()
6755 EAPI void elm_fileselector_entry_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
6758 * Get the icon set for a given file selector entry widget's button
6760 * @param obj The file selector entry widget
6761 * @return The icon object currently set on @p obj widget's button
6762 * or @c NULL, if none is
6764 * @see elm_fileselector_entry_button_icon_set()
6766 EAPI Evas_Object *elm_fileselector_entry_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6769 * Unset the icon used in a given file selector entry widget's
6772 * @param obj The file selector entry widget
6773 * @return The icon object that was being used on @p obj widget's
6774 * button or @c NULL, on errors
6776 * Unparent and return the icon object which was set for this
6779 * @see elm_fileselector_entry_button_icon_set()
6781 EAPI Evas_Object *elm_fileselector_entry_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6784 * Set the title for a given file selector entry widget's window
6786 * @param obj The file selector entry widget
6787 * @param title The title string
6789 * This will change the window's title, when the file selector pops
6790 * out after a click on the entry's button. Those windows have the
6791 * default (unlocalized) value of @c "Select a file" as titles.
6793 * @note It will only take any effect if the file selector
6794 * entry widget is @b not under "inwin mode".
6796 * @see elm_fileselector_entry_window_title_get()
6798 EAPI void elm_fileselector_entry_window_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
6801 * Get the title set for a given file selector entry widget's
6804 * @param obj The file selector entry widget
6805 * @return Title of the file selector entry's window
6807 * @see elm_fileselector_entry_window_title_get() for more details
6809 EAPI const char *elm_fileselector_entry_window_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6812 * Set the size of a given file selector entry widget's window,
6813 * holding the file selector itself.
6815 * @param obj The file selector entry widget
6816 * @param width The window's width
6817 * @param height The window's height
6819 * @note it will only take any effect if the file selector entry
6820 * widget is @b not under "inwin mode". The default size for the
6821 * window (when applicable) is 400x400 pixels.
6823 * @see elm_fileselector_entry_window_size_get()
6825 EAPI void elm_fileselector_entry_window_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
6828 * Get the size of a given file selector entry widget's window,
6829 * holding the file selector itself.
6831 * @param obj The file selector entry widget
6832 * @param width Pointer into which to store the width value
6833 * @param height Pointer into which to store the height value
6835 * @note Use @c NULL pointers on the size values you're not
6836 * interested in: they'll be ignored by the function.
6838 * @see elm_fileselector_entry_window_size_set(), for more details
6840 EAPI void elm_fileselector_entry_window_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
6843 * Set the initial file system path and the entry's path string for
6844 * a given file selector entry widget
6846 * @param obj The file selector entry widget
6847 * @param path The path string
6849 * It must be a <b>directory</b> path, which will have the contents
6850 * displayed initially in the file selector's view, when invoked
6851 * from @p obj. The default initial path is the @c "HOME"
6852 * environment variable's value.
6854 * @see elm_fileselector_entry_path_get()
6856 EAPI void elm_fileselector_entry_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
6859 * Get the entry's path string for a given file selector entry
6862 * @param obj The file selector entry widget
6863 * @return path The path string
6865 * @see elm_fileselector_entry_path_set() for more details
6867 EAPI const char *elm_fileselector_entry_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6870 * Enable/disable a tree view in the given file selector entry
6871 * widget's internal file selector
6873 * @param obj The file selector entry widget
6874 * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
6877 * This has the same effect as elm_fileselector_expandable_set(),
6878 * but now applied to a file selector entry's internal file
6881 * @note There's no way to put a file selector entry's internal
6882 * file selector in "grid mode", as one may do with "pure" file
6885 * @see elm_fileselector_expandable_get()
6887 EAPI void elm_fileselector_entry_expandable_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6890 * Get whether tree view is enabled for the given file selector
6891 * entry widget's internal file selector
6893 * @param obj The file selector entry widget
6894 * @return @c EINA_TRUE if @p obj widget's internal file selector
6895 * is in tree view, @c EINA_FALSE otherwise (and or errors)
6897 * @see elm_fileselector_expandable_set() for more details
6899 EAPI Eina_Bool elm_fileselector_entry_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6902 * Set whether a given file selector entry widget's internal file
6903 * selector is to display folders only or the directory contents,
6906 * @param obj The file selector entry widget
6907 * @param only @c EINA_TRUE to make @p obj widget's internal file
6908 * selector only display directories, @c EINA_FALSE to make files
6909 * to be displayed in it too
6911 * This has the same effect as elm_fileselector_folder_only_set(),
6912 * but now applied to a file selector entry's internal file
6915 * @see elm_fileselector_folder_only_get()
6917 EAPI void elm_fileselector_entry_folder_only_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6920 * Get whether a given file selector entry widget's internal file
6921 * selector is displaying folders only or the directory contents,
6924 * @param obj The file selector entry widget
6925 * @return @c EINA_TRUE if @p obj widget's internal file
6926 * selector is only displaying directories, @c EINA_FALSE if files
6927 * are being displayed in it too (and on errors)
6929 * @see elm_fileselector_entry_folder_only_set() for more details
6931 EAPI Eina_Bool elm_fileselector_entry_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6934 * Enable/disable the file name entry box where the user can type
6935 * in a name for a file, in a given file selector entry widget's
6936 * internal file selector.
6938 * @param obj The file selector entry widget
6939 * @param is_save @c EINA_TRUE to make @p obj widget's internal
6940 * file selector a "saving dialog", @c EINA_FALSE otherwise
6942 * This has the same effect as elm_fileselector_is_save_set(),
6943 * but now applied to a file selector entry's internal file
6946 * @see elm_fileselector_is_save_get()
6948 EAPI void elm_fileselector_entry_is_save_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6951 * Get whether the given file selector entry widget's internal
6952 * file selector is in "saving dialog" mode
6954 * @param obj The file selector entry widget
6955 * @return @c EINA_TRUE, if @p obj widget's internal file selector
6956 * is in "saving dialog" mode, @c EINA_FALSE otherwise (and on
6959 * @see elm_fileselector_entry_is_save_set() for more details
6961 EAPI Eina_Bool elm_fileselector_entry_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6964 * Set whether a given file selector entry widget's internal file
6965 * selector will raise an Elementary "inner window", instead of a
6966 * dedicated Elementary window. By default, it won't.
6968 * @param obj The file selector entry widget
6969 * @param value @c EINA_TRUE to make it use an inner window, @c
6970 * EINA_TRUE to make it use a dedicated window
6972 * @see elm_win_inwin_add() for more information on inner windows
6973 * @see elm_fileselector_entry_inwin_mode_get()
6975 EAPI void elm_fileselector_entry_inwin_mode_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6978 * Get whether a given file selector entry widget's internal file
6979 * selector will raise an Elementary "inner window", instead of a
6980 * dedicated Elementary window.
6982 * @param obj The file selector entry widget
6983 * @return @c EINA_TRUE if will use an inner window, @c EINA_TRUE
6984 * if it will use a dedicated window
6986 * @see elm_fileselector_entry_inwin_mode_set() for more details
6988 EAPI Eina_Bool elm_fileselector_entry_inwin_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6991 * Set the initial file system path for a given file selector entry
6994 * @param obj The file selector entry widget
6995 * @param path The path string
6997 * It must be a <b>directory</b> path, which will have the contents
6998 * displayed initially in the file selector's view, when invoked
6999 * from @p obj. The default initial path is the @c "HOME"
7000 * environment variable's value.
7002 * @see elm_fileselector_entry_path_get()
7004 EAPI void elm_fileselector_entry_selected_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
7007 * Get the parent directory's path to the latest file selection on
7008 * a given filer selector entry widget
7010 * @param obj The file selector object
7011 * @return The (full) path of the directory of the last selection
7012 * on @p obj widget, a @b stringshared string
7014 * @see elm_fileselector_entry_path_set()
7016 EAPI const char *elm_fileselector_entry_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7023 * @defgroup Scroller Scroller
7025 * A scroller holds a single object and "scrolls it around". This means that
7026 * it allows the user to use a scrollbar (or a finger) to drag the viewable
7027 * region around, allowing to move through a much larger object that is
7028 * contained in the scroller. The scroller will always have a small minimum
7029 * size by default as it won't be limited by the contents of the scroller.
7031 * Signals that you can add callbacks for are:
7032 * @li "edge,left" - the left edge of the content has been reached
7033 * @li "edge,right" - the right edge of the content has been reached
7034 * @li "edge,top" - the top edge of the content has been reached
7035 * @li "edge,bottom" - the bottom edge of the content has been reached
7036 * @li "scroll" - the content has been scrolled (moved)
7037 * @li "scroll,anim,start" - scrolling animation has started
7038 * @li "scroll,anim,stop" - scrolling animation has stopped
7039 * @li "scroll,drag,start" - dragging the contents around has started
7040 * @li "scroll,drag,stop" - dragging the contents around has stopped
7041 * @note The "scroll,anim,*" and "scroll,drag,*" signals are only emitted by
7044 * @note When Elemementary is in embedded mode the scrollbars will not be
7045 * dragable, they appear merely as indicators of how much has been scrolled.
7046 * @note When Elementary is in desktop mode the thumbscroll(a.k.a.
7047 * fingerscroll) won't work.
7049 * Default contents parts of the scroller widget that you can use for are:
7050 * @li "default" - A content of the scroller
7052 * In @ref tutorial_scroller you'll find an example of how to use most of
7057 * @brief Type that controls when scrollbars should appear.
7059 * @see elm_scroller_policy_set()
7061 typedef enum _Elm_Scroller_Policy
7063 ELM_SCROLLER_POLICY_AUTO = 0, /**< Show scrollbars as needed */
7064 ELM_SCROLLER_POLICY_ON, /**< Always show scrollbars */
7065 ELM_SCROLLER_POLICY_OFF, /**< Never show scrollbars */
7066 ELM_SCROLLER_POLICY_LAST
7067 } Elm_Scroller_Policy;
7069 * @brief Add a new scroller to the parent
7071 * @param parent The parent object
7072 * @return The new object or NULL if it cannot be created
7074 EAPI Evas_Object *elm_scroller_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7076 * @brief Set the content of the scroller widget (the object to be scrolled around).
7078 * @param obj The scroller object
7079 * @param content The new content object
7081 * Once the content object is set, a previously set one will be deleted.
7082 * If you want to keep that old content object, use the
7083 * elm_scroller_content_unset() function.
7084 * @deprecated use elm_object_content_set() instead
7086 EINA_DEPRECATED EAPI void elm_scroller_content_set(Evas_Object *obj, Evas_Object *child) EINA_ARG_NONNULL(1);
7088 * @brief Get the content of the scroller widget
7090 * @param obj The slider object
7091 * @return The content that is being used
7093 * Return the content object which is set for this widget
7095 * @see elm_scroller_content_set()
7096 * @deprecated use elm_object_content_get() instead.
7098 EINA_DEPRECATED EAPI Evas_Object *elm_scroller_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7100 * @brief Unset the content of the scroller widget
7102 * @param obj The slider object
7103 * @return The content that was being used
7105 * Unparent and return the content object which was set for this widget
7107 * @see elm_scroller_content_set()
7108 * @deprecated use elm_object_content_unset() instead.
7110 EINA_DEPRECATED EAPI Evas_Object *elm_scroller_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
7112 * @brief Set custom theme elements for the scroller
7114 * @param obj The scroller object
7115 * @param widget The widget name to use (default is "scroller")
7116 * @param base The base name to use (default is "base")
7118 EAPI void elm_scroller_custom_widget_base_theme_set(Evas_Object *obj, const char *widget, const char *base) EINA_ARG_NONNULL(1, 2, 3);
7120 * @brief Make the scroller minimum size limited to the minimum size of the content
7122 * @param obj The scroller object
7123 * @param w Enable limiting minimum size horizontally
7124 * @param h Enable limiting minimum size vertically
7126 * By default the scroller will be as small as its design allows,
7127 * irrespective of its content. This will make the scroller minimum size the
7128 * right size horizontally and/or vertically to perfectly fit its content in
7131 EAPI void elm_scroller_content_min_limit(Evas_Object *obj, Eina_Bool w, Eina_Bool h) EINA_ARG_NONNULL(1);
7133 * @brief Show a specific virtual region within the scroller content object
7135 * @param obj The scroller object
7136 * @param x X coordinate of the region
7137 * @param y Y coordinate of the region
7138 * @param w Width of the region
7139 * @param h Height of the region
7141 * This will ensure all (or part if it does not fit) of the designated
7142 * region in the virtual content object (0, 0 starting at the top-left of the
7143 * virtual content object) is shown within the scroller.
7145 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);
7147 * @brief Set the scrollbar visibility policy
7149 * @param obj The scroller object
7150 * @param policy_h Horizontal scrollbar policy
7151 * @param policy_v Vertical scrollbar policy
7153 * This sets the scrollbar visibility policy for the given scroller.
7154 * ELM_SCROLLER_POLICY_AUTO means the scrollbar is made visible if it is
7155 * needed, and otherwise kept hidden. ELM_SCROLLER_POLICY_ON turns it on all
7156 * the time, and ELM_SCROLLER_POLICY_OFF always keeps it off. This applies
7157 * respectively for the horizontal and vertical scrollbars.
7159 EAPI void elm_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
7161 * @brief Gets scrollbar visibility policy
7163 * @param obj The scroller object
7164 * @param policy_h Horizontal scrollbar policy
7165 * @param policy_v Vertical scrollbar policy
7167 * @see elm_scroller_policy_set()
7169 EAPI void elm_scroller_policy_get(const Evas_Object *obj, Elm_Scroller_Policy *policy_h, Elm_Scroller_Policy *policy_v) EINA_ARG_NONNULL(1);
7171 * @brief Get the currently visible content region
7173 * @param obj The scroller object
7174 * @param x X coordinate of the region
7175 * @param y Y coordinate of the region
7176 * @param w Width of the region
7177 * @param h Height of the region
7179 * This gets the current region in the content object that is visible through
7180 * the scroller. The region co-ordinates are returned in the @p x, @p y, @p
7181 * w, @p h values pointed to.
7183 * @note All coordinates are relative to the content.
7185 * @see elm_scroller_region_show()
7187 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);
7189 * @brief Get the size of the content object
7191 * @param obj The scroller object
7192 * @param w Width of the content object.
7193 * @param h Height of the content object.
7195 * This gets the size of the content object of the scroller.
7197 EAPI void elm_scroller_child_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
7199 * @brief Set bouncing behavior
7201 * @param obj The scroller object
7202 * @param h_bounce Allow bounce horizontally
7203 * @param v_bounce Allow bounce vertically
7205 * When scrolling, the scroller may "bounce" when reaching an edge of the
7206 * content object. This is a visual way to indicate the end has been reached.
7207 * This is enabled by default for both axis. This API will set if it is enabled
7208 * for the given axis with the boolean parameters for each axis.
7210 EAPI void elm_scroller_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
7212 * @brief Get the bounce behaviour
7214 * @param obj The Scroller object
7215 * @param h_bounce Will the scroller bounce horizontally or not
7216 * @param v_bounce Will the scroller bounce vertically or not
7218 * @see elm_scroller_bounce_set()
7220 EAPI void elm_scroller_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
7222 * @brief Set scroll page size relative to viewport size.
7224 * @param obj The scroller object
7225 * @param h_pagerel The horizontal page relative size
7226 * @param v_pagerel The vertical page relative size
7228 * The scroller is capable of limiting scrolling by the user to "pages". That
7229 * is to jump by and only show a "whole page" at a time as if the continuous
7230 * area of the scroller content is split into page sized pieces. This sets
7231 * the size of a page relative to the viewport of the scroller. 1.0 is "1
7232 * viewport" is size (horizontally or vertically). 0.0 turns it off in that
7233 * axis. This is mutually exclusive with page size
7234 * (see elm_scroller_page_size_set() for more information). Likewise 0.5
7235 * is "half a viewport". Sane usable values are normally between 0.0 and 1.0
7236 * including 1.0. If you only want 1 axis to be page "limited", use 0.0 for
7239 EAPI void elm_scroller_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel) EINA_ARG_NONNULL(1);
7241 * @brief Set scroll page size.
7243 * @param obj The scroller object
7244 * @param h_pagesize The horizontal page size
7245 * @param v_pagesize The vertical page size
7247 * This sets the page size to an absolute fixed value, with 0 turning it off
7250 * @see elm_scroller_page_relative_set()
7252 EAPI void elm_scroller_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize) EINA_ARG_NONNULL(1);
7254 * @brief Get scroll current page number.
7256 * @param obj The scroller object
7257 * @param h_pagenumber The horizontal page number
7258 * @param v_pagenumber The vertical page number
7260 * The page number starts from 0. 0 is the first page.
7261 * Current page means the page which meets the top-left of the viewport.
7262 * If there are two or more pages in the viewport, it returns the number of the page
7263 * which meets the top-left of the viewport.
7265 * @see elm_scroller_last_page_get()
7266 * @see elm_scroller_page_show()
7267 * @see elm_scroller_page_brint_in()
7269 EAPI void elm_scroller_current_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber) EINA_ARG_NONNULL(1);
7271 * @brief Get scroll last page number.
7273 * @param obj The scroller object
7274 * @param h_pagenumber The horizontal page number
7275 * @param v_pagenumber The vertical page number
7277 * The page number starts from 0. 0 is the first page.
7278 * This returns the last page number among the pages.
7280 * @see elm_scroller_current_page_get()
7281 * @see elm_scroller_page_show()
7282 * @see elm_scroller_page_brint_in()
7284 EAPI void elm_scroller_last_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber) EINA_ARG_NONNULL(1);
7286 * Show a specific virtual region within the scroller content object by page number.
7288 * @param obj The scroller object
7289 * @param h_pagenumber The horizontal page number
7290 * @param v_pagenumber The vertical page number
7292 * 0, 0 of the indicated page is located at the top-left of the viewport.
7293 * This will jump to the page directly without animation.
7298 * sc = elm_scroller_add(win);
7299 * elm_scroller_content_set(sc, content);
7300 * elm_scroller_page_relative_set(sc, 1, 0);
7301 * elm_scroller_current_page_get(sc, &h_page, &v_page);
7302 * elm_scroller_page_show(sc, h_page + 1, v_page);
7305 * @see elm_scroller_page_bring_in()
7307 EAPI void elm_scroller_page_show(Evas_Object *obj, int h_pagenumber, int v_pagenumber) EINA_ARG_NONNULL(1);
7309 * Show a specific virtual region within the scroller content object by page number.
7311 * @param obj The scroller object
7312 * @param h_pagenumber The horizontal page number
7313 * @param v_pagenumber The vertical page number
7315 * 0, 0 of the indicated page is located at the top-left of the viewport.
7316 * This will slide to the page with animation.
7321 * sc = elm_scroller_add(win);
7322 * elm_scroller_content_set(sc, content);
7323 * elm_scroller_page_relative_set(sc, 1, 0);
7324 * elm_scroller_last_page_get(sc, &h_page, &v_page);
7325 * elm_scroller_page_bring_in(sc, h_page, v_page);
7328 * @see elm_scroller_page_show()
7330 EAPI void elm_scroller_page_bring_in(Evas_Object *obj, int h_pagenumber, int v_pagenumber) EINA_ARG_NONNULL(1);
7332 * @brief Show a specific virtual region within the scroller content object.
7334 * @param obj The scroller object
7335 * @param x X coordinate of the region
7336 * @param y Y coordinate of the region
7337 * @param w Width of the region
7338 * @param h Height of the region
7340 * This will ensure all (or part if it does not fit) of the designated
7341 * region in the virtual content object (0, 0 starting at the top-left of the
7342 * virtual content object) is shown within the scroller. Unlike
7343 * elm_scroller_region_show(), this allow the scroller to "smoothly slide"
7344 * to this location (if configuration in general calls for transitions). It
7345 * may not jump immediately to the new location and make take a while and
7346 * show other content along the way.
7348 * @see elm_scroller_region_show()
7350 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);
7352 * @brief Set event propagation on a scroller
7354 * @param obj The scroller object
7355 * @param propagation If propagation is enabled or not
7357 * This enables or disabled event propagation from the scroller content to
7358 * the scroller and its parent. By default event propagation is disabled.
7360 EAPI void elm_scroller_propagate_events_set(Evas_Object *obj, Eina_Bool propagation) EINA_ARG_NONNULL(1);
7362 * @brief Get event propagation for a scroller
7364 * @param obj The scroller object
7365 * @return The propagation state
7367 * This gets the event propagation for a scroller.
7369 * @see elm_scroller_propagate_events_set()
7371 EAPI Eina_Bool elm_scroller_propagate_events_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7373 * @brief Set scrolling gravity on a scroller
7375 * @param obj The scroller object
7376 * @param x The scrolling horizontal gravity
7377 * @param y The scrolling vertical gravity
7379 * The gravity, defines how the scroller will adjust its view
7380 * when the size of the scroller contents increase.
7382 * The scroller will adjust the view to glue itself as follows.
7384 * x=0.0, for showing the left most region of the content.
7385 * x=1.0, for showing the right most region of the content.
7386 * y=0.0, for showing the bottom most region of the content.
7387 * y=1.0, for showing the top most region of the content.
7389 * Default values for x and y are 0.0
7391 EAPI void elm_scroller_gravity_set(Evas_Object *obj, double x, double y) EINA_ARG_NONNULL(1);
7393 * @brief Get scrolling gravity values for a scroller
7395 * @param obj The scroller object
7396 * @param x The scrolling horizontal gravity
7397 * @param y The scrolling vertical gravity
7399 * This gets gravity values for a scroller.
7401 * @see elm_scroller_gravity_set()
7404 EAPI void elm_scroller_gravity_get(const Evas_Object *obj, double *x, double *y) EINA_ARG_NONNULL(1);
7410 * @defgroup Label Label
7412 * @image html img/widget/label/preview-00.png
7413 * @image latex img/widget/label/preview-00.eps
7415 * @brief Widget to display text, with simple html-like markup.
7417 * The Label widget @b doesn't allow text to overflow its boundaries, if the
7418 * text doesn't fit the geometry of the label it will be ellipsized or be
7419 * cut. Elementary provides several styles for this widget:
7420 * @li default - No animation
7421 * @li marker - Centers the text in the label and make it bold by default
7422 * @li slide_long - The entire text appears from the right of the screen and
7423 * slides until it disappears in the left of the screen(reappering on the
7425 * @li slide_short - The text appears in the left of the label and slides to
7426 * the right to show the overflow. When all of the text has been shown the
7427 * position is reset.
7428 * @li slide_bounce - The text appears in the left of the label and slides to
7429 * the right to show the overflow. When all of the text has been shown the
7430 * animation reverses, moving the text to the left.
7432 * Custom themes can of course invent new markup tags and style them any way
7435 * The following signals may be emitted by the label widget:
7436 * @li "language,changed": The program's language changed.
7438 * See @ref tutorial_label for a demonstration of how to use a label widget.
7442 * @brief Add a new label to the parent
7444 * @param parent The parent object
7445 * @return The new object or NULL if it cannot be created
7447 EAPI Evas_Object *elm_label_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7449 * @brief Set the label on the label object
7451 * @param obj The label object
7452 * @param label The label will be used on the label object
7453 * @deprecated See elm_object_text_set()
7455 EINA_DEPRECATED EAPI void elm_label_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1); /* deprecated, use elm_object_text_set instead */
7457 * @brief Get the label used on the label object
7459 * @param obj The label object
7460 * @return The string inside the label
7461 * @deprecated See elm_object_text_get()
7463 EINA_DEPRECATED EAPI const char *elm_label_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1); /* deprecated, use elm_object_text_get instead */
7465 * @brief Set the wrapping behavior of the label
7467 * @param obj The label object
7468 * @param wrap To wrap text or not
7470 * By default no wrapping is done. Possible values for @p wrap are:
7471 * @li ELM_WRAP_NONE - No wrapping
7472 * @li ELM_WRAP_CHAR - wrap between characters
7473 * @li ELM_WRAP_WORD - wrap between words
7474 * @li ELM_WRAP_MIXED - Word wrap, and if that fails, char wrap
7476 EAPI void elm_label_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
7478 * @brief Get the wrapping behavior of the label
7480 * @param obj The label object
7483 * @see elm_label_line_wrap_set()
7485 EAPI Elm_Wrap_Type elm_label_line_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7487 * @brief Set wrap width of the label
7489 * @param obj The label object
7490 * @param w The wrap width in pixels at a minimum where words need to wrap
7492 * This function sets the maximum width size hint of the label.
7494 * @warning This is only relevant if the label is inside a container.
7496 EAPI void elm_label_wrap_width_set(Evas_Object *obj, Evas_Coord w) EINA_ARG_NONNULL(1);
7498 * @brief Get wrap width of the label
7500 * @param obj The label object
7501 * @return The wrap width in pixels at a minimum where words need to wrap
7503 * @see elm_label_wrap_width_set()
7505 EAPI Evas_Coord elm_label_wrap_width_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7507 * @brief Set wrap height of the label
7509 * @param obj The label object
7510 * @param h The wrap height in pixels at a minimum where words need to wrap
7512 * This function sets the maximum height size hint of the label.
7514 * @warning This is only relevant if the label is inside a container.
7516 EAPI void elm_label_wrap_height_set(Evas_Object *obj, Evas_Coord h) EINA_ARG_NONNULL(1);
7518 * @brief get wrap width of the label
7520 * @param obj The label object
7521 * @return The wrap height in pixels at a minimum where words need to wrap
7523 EAPI Evas_Coord elm_label_wrap_height_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7525 * @brief Set the font size on the label object.
7527 * @param obj The label object
7528 * @param size font size
7530 * @warning NEVER use this. It is for hyper-special cases only. use styles
7531 * instead. e.g. "default", "marker", "slide_long" etc.
7533 EAPI void elm_label_fontsize_set(Evas_Object *obj, int fontsize) EINA_ARG_NONNULL(1);
7535 * @brief Set the text color on the label object
7537 * @param obj The label object
7538 * @param r Red property background color of The label object
7539 * @param g Green property background color of The label object
7540 * @param b Blue property background color of The label object
7541 * @param a Alpha property background color of The label object
7543 * @warning NEVER use this. It is for hyper-special cases only. use styles
7544 * instead. e.g. "default", "marker", "slide_long" etc.
7546 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);
7548 * @brief Set the text align on the label object
7550 * @param obj The label object
7551 * @param align align mode ("left", "center", "right")
7553 * @warning NEVER use this. It is for hyper-special cases only. use styles
7554 * instead. e.g. "default", "marker", "slide_long" etc.
7556 EAPI void elm_label_text_align_set(Evas_Object *obj, const char *alignmode) EINA_ARG_NONNULL(1);
7558 * @brief Set background color of the label
7560 * @param obj The label object
7561 * @param r Red property background color of The label object
7562 * @param g Green property background color of The label object
7563 * @param b Blue property background color of The label object
7564 * @param a Alpha property background alpha of The label object
7566 * @warning NEVER use this. It is for hyper-special cases only. use styles
7567 * instead. e.g. "default", "marker", "slide_long" etc.
7569 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);
7571 * @brief Set the ellipsis behavior of the label
7573 * @param obj The label object
7574 * @param ellipsis To ellipsis text or not
7576 * If set to true and the text doesn't fit in the label an ellipsis("...")
7577 * will be shown at the end of the widget.
7579 * @warning This doesn't work with slide(elm_label_slide_set()) or if the
7580 * choosen wrap method was ELM_WRAP_WORD.
7582 EAPI void elm_label_ellipsis_set(Evas_Object *obj, Eina_Bool ellipsis) EINA_ARG_NONNULL(1);
7584 * @brief Set the text slide of the label
7586 * @param obj The label object
7587 * @param slide To start slide or stop
7589 * If set to true, the text of the label will slide/scroll through the length of
7592 * @warning This only works with the themes "slide_short", "slide_long" and
7595 EAPI void elm_label_slide_set(Evas_Object *obj, Eina_Bool slide) EINA_ARG_NONNULL(1);
7597 * @brief Get the text slide mode of the label
7599 * @param obj The label object
7600 * @return slide slide mode value
7602 * @see elm_label_slide_set()
7604 EAPI Eina_Bool elm_label_slide_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
7606 * @brief Set the slide duration(speed) of the label
7608 * @param obj The label object
7609 * @return The duration in seconds in moving text from slide begin position
7610 * to slide end position
7612 EAPI void elm_label_slide_duration_set(Evas_Object *obj, double duration) EINA_ARG_NONNULL(1);
7614 * @brief Get the slide duration(speed) of the label
7616 * @param obj The label object
7617 * @return The duration time in moving text from slide begin position to slide end position
7619 * @see elm_label_slide_duration_set()
7621 EAPI double elm_label_slide_duration_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
7627 * @defgroup Toggle Toggle
7629 * @image html img/widget/toggle/preview-00.png
7630 * @image latex img/widget/toggle/preview-00.eps
7632 * @brief A toggle is a slider which can be used to toggle between
7633 * two values. It has two states: on and off.
7635 * This widget is deprecated. Please use elm_check_add() instead using the
7636 * toggle style like:
7639 * obj = elm_check_add(parent);
7640 * elm_object_style_set(obj, "toggle");
7641 * elm_object_part_text_set(obj, "on", "ON");
7642 * elm_object_part_text_set(obj, "off", "OFF");
7645 * Signals that you can add callbacks for are:
7646 * @li "changed" - Whenever the toggle value has been changed. Is not called
7647 * until the toggle is released by the cursor (assuming it
7648 * has been triggered by the cursor in the first place).
7650 * Default contents parts of the toggle widget that you can use for are:
7651 * @li "icon" - An icon of the toggle
7653 * Default text parts of the toggle widget that you can use for are:
7654 * @li "elm.text" - Label of the toggle
7656 * @ref tutorial_toggle show how to use a toggle.
7660 * @brief Add a toggle to @p parent.
7662 * @param parent The parent object
7664 * @return The toggle object
7666 EINA_DEPRECATED EAPI Evas_Object *elm_toggle_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7668 * @brief Sets the label to be displayed with the toggle.
7670 * @param obj The toggle object
7671 * @param label The label to be displayed
7673 * @deprecated use elm_object_text_set() instead.
7675 EINA_DEPRECATED EAPI void elm_toggle_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
7677 * @brief Gets the label of the toggle
7679 * @param obj toggle object
7680 * @return The label of the toggle
7682 * @deprecated use elm_object_text_get() instead.
7684 EINA_DEPRECATED EAPI const char *elm_toggle_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7686 * @brief Set the icon used for the toggle
7688 * @param obj The toggle object
7689 * @param icon The icon object for the button
7691 * Once the icon object is set, a previously set one will be deleted
7692 * If you want to keep that old content object, use the
7693 * elm_toggle_icon_unset() function.
7695 * @deprecated use elm_object_part_content_set() instead.
7697 EINA_DEPRECATED EAPI void elm_toggle_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
7699 * @brief Get the icon used for the toggle
7701 * @param obj The toggle object
7702 * @return The icon object that is being used
7704 * Return the icon object which is set for this widget.
7706 * @see elm_toggle_icon_set()
7708 * @deprecated use elm_object_part_content_get() instead.
7710 EINA_DEPRECATED EAPI Evas_Object *elm_toggle_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7712 * @brief Unset the icon used for the toggle
7714 * @param obj The toggle object
7715 * @return The icon object that was being used
7717 * Unparent and return the icon object which was set for this widget.
7719 * @see elm_toggle_icon_set()
7721 * @deprecated use elm_object_part_content_unset() instead.
7723 EINA_DEPRECATED EAPI Evas_Object *elm_toggle_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
7725 * @brief Sets the labels to be associated with the on and off states of the toggle.
7727 * @param obj The toggle object
7728 * @param onlabel The label displayed when the toggle is in the "on" state
7729 * @param offlabel The label displayed when the toggle is in the "off" state
7731 * @deprecated use elm_object_part_text_set() for "on" and "off" parts
7734 EINA_DEPRECATED EAPI void elm_toggle_states_labels_set(Evas_Object *obj, const char *onlabel, const char *offlabel) EINA_ARG_NONNULL(1);
7736 * @brief Gets the labels associated with the on and off states of the
7739 * @param obj The toggle object
7740 * @param onlabel A char** to place the onlabel of @p obj into
7741 * @param offlabel A char** to place the offlabel of @p obj into
7743 * @deprecated use elm_object_part_text_get() for "on" and "off" parts
7746 EINA_DEPRECATED EAPI void elm_toggle_states_labels_get(const Evas_Object *obj, const char **onlabel, const char **offlabel) EINA_ARG_NONNULL(1);
7748 * @brief Sets the state of the toggle to @p state.
7750 * @param obj The toggle object
7751 * @param state The state of @p obj
7753 * @deprecated use elm_check_state_set() instead.
7755 EINA_DEPRECATED EAPI void elm_toggle_state_set(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
7757 * @brief Gets the state of the toggle to @p state.
7759 * @param obj The toggle object
7760 * @return The state of @p obj
7762 * @deprecated use elm_check_state_get() instead.
7764 EINA_DEPRECATED EAPI Eina_Bool elm_toggle_state_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7766 * @brief Sets the state pointer of the toggle to @p statep.
7768 * @param obj The toggle object
7769 * @param statep The state pointer of @p obj
7771 * @deprecated use elm_check_state_pointer_set() instead.
7773 EINA_DEPRECATED EAPI void elm_toggle_state_pointer_set(Evas_Object *obj, Eina_Bool *statep) EINA_ARG_NONNULL(1);
7779 * @defgroup Frame Frame
7781 * @image html img/widget/frame/preview-00.png
7782 * @image latex img/widget/frame/preview-00.eps
7784 * @brief Frame is a widget that holds some content and has a title.
7786 * The default look is a frame with a title, but Frame supports multple
7794 * @li outdent_bottom
7796 * Of all this styles only default shows the title. Frame emits no signals.
7798 * Default contents parts of the frame widget that you can use for are:
7799 * @li "default" - A content of the frame
7801 * Default text parts of the frame widget that you can use for are:
7802 * @li "elm.text" - Label of the frame
7804 * For a detailed example see the @ref tutorial_frame.
7809 * @brief Add a new frame to the parent
7811 * @param parent The parent object
7812 * @return The new object or NULL if it cannot be created
7814 EAPI Evas_Object *elm_frame_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7816 * @brief Set the frame label
7818 * @param obj The frame object
7819 * @param label The label of this frame object
7821 * @deprecated use elm_object_text_set() instead.
7823 EINA_DEPRECATED EAPI void elm_frame_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
7825 * @brief Get the frame label
7827 * @param obj The frame object
7829 * @return The label of this frame objet or NULL if unable to get frame
7831 * @deprecated use elm_object_text_get() instead.
7833 EINA_DEPRECATED EAPI const char *elm_frame_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7835 * @brief Set the content of the frame widget
7837 * Once the content object is set, a previously set one will be deleted.
7838 * If you want to keep that old content object, use the
7839 * elm_frame_content_unset() function.
7841 * @param obj The frame object
7842 * @param content The content will be filled in this frame object
7844 * @deprecated use elm_object_content_set() instead.
7846 EINA_DEPRECATED EAPI void elm_frame_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
7848 * @brief Get the content of the frame widget
7850 * Return the content object which is set for this widget
7852 * @param obj The frame object
7853 * @return The content that is being used
7855 * @deprecated use elm_object_content_get() instead.
7857 EINA_DEPRECATED EAPI Evas_Object *elm_frame_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7859 * @brief Unset the content of the frame widget
7861 * Unparent and return the content object which was set for this widget
7863 * @param obj The frame object
7864 * @return The content that was being used
7866 * @deprecated use elm_object_content_unset() instead.
7868 EINA_DEPRECATED EAPI Evas_Object *elm_frame_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
7874 * @defgroup Table Table
7876 * A container widget to arrange other widgets in a table where items can
7877 * also span multiple columns or rows - even overlap (and then be raised or
7878 * lowered accordingly to adjust stacking if they do overlap).
7880 * For a Table widget the row/column count is not fixed.
7881 * The table widget adjusts itself when subobjects are added to it dynamically.
7883 * The followin are examples of how to use a table:
7884 * @li @ref tutorial_table_01
7885 * @li @ref tutorial_table_02
7890 * @brief Add a new table to the parent
7892 * @param parent The parent object
7893 * @return The new object or NULL if it cannot be created
7895 EAPI Evas_Object *elm_table_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7897 * @brief Set the homogeneous layout in the table
7899 * @param obj The layout object
7900 * @param homogeneous A boolean to set if the layout is homogeneous in the
7901 * table (EINA_TRUE = homogeneous, EINA_FALSE = no homogeneous)
7903 EAPI void elm_table_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
7905 * @brief Get the current table homogeneous mode.
7907 * @param obj The table object
7908 * @return A boolean to indicating if the layout is homogeneous in the table
7909 * (EINA_TRUE = homogeneous, EINA_FALSE = no homogeneous)
7911 EAPI Eina_Bool elm_table_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7913 * @brief Set padding between cells.
7915 * @param obj The layout object.
7916 * @param horizontal set the horizontal padding.
7917 * @param vertical set the vertical padding.
7919 * Default value is 0.
7921 EAPI void elm_table_padding_set(Evas_Object *obj, Evas_Coord horizontal, Evas_Coord vertical) EINA_ARG_NONNULL(1);
7923 * @brief Get padding between cells.
7925 * @param obj The layout object.
7926 * @param horizontal set the horizontal padding.
7927 * @param vertical set the vertical padding.
7929 EAPI void elm_table_padding_get(const Evas_Object *obj, Evas_Coord *horizontal, Evas_Coord *vertical) EINA_ARG_NONNULL(1);
7931 * @brief Add a subobject on the table with the coordinates passed
7933 * @param obj The table object
7934 * @param subobj The subobject to be added to the table
7935 * @param x Row number
7936 * @param y Column number
7940 * @note All positioning inside the table is relative to rows and columns, so
7941 * a value of 0 for x and y, means the top left cell of the table, and a
7942 * value of 1 for w and h means @p subobj only takes that 1 cell.
7944 EAPI void elm_table_pack(Evas_Object *obj, Evas_Object *subobj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
7946 * @brief Remove child from table.
7948 * @param obj The table object
7949 * @param subobj The subobject
7951 EAPI void elm_table_unpack(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
7953 * @brief Faster way to remove all child objects from a table object.
7955 * @param obj The table object
7956 * @param clear If true, will delete children, else just remove from table.
7958 EAPI void elm_table_clear(Evas_Object *obj, Eina_Bool clear) EINA_ARG_NONNULL(1);
7960 * @brief Set the packing location of an existing child of the table
7962 * @param subobj The subobject to be modified in the table
7963 * @param x Row number
7964 * @param y Column number
7968 * Modifies the position of an object already in the table.
7970 * @note All positioning inside the table is relative to rows and columns, so
7971 * a value of 0 for x and y, means the top left cell of the table, and a
7972 * value of 1 for w and h means @p subobj only takes that 1 cell.
7974 EAPI void elm_table_pack_set(Evas_Object *subobj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
7976 * @brief Get the packing location of an existing child of the table
7978 * @param subobj The subobject to be modified in the table
7979 * @param x Row number
7980 * @param y Column number
7984 * @see elm_table_pack_set()
7986 EAPI void elm_table_pack_get(Evas_Object *subobj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
7991 /* TEMPORARY: DOCS WILL BE FILLED IN WITH CNP/SED */
7992 typedef struct Elm_Gen_Item Elm_Gen_Item;
7993 typedef struct _Elm_Gen_Item_Class Elm_Gen_Item_Class;
7994 typedef struct _Elm_Gen_Item_Class_Func Elm_Gen_Item_Class_Func; /**< Class functions for gen item classes. */
7995 typedef char *(*Elm_Gen_Item_Label_Get_Cb) (void *data, Evas_Object *obj, const char *part); /**< Label fetching class function for gen item classes. */
7996 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. */
7997 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. */
7998 typedef void (*Elm_Gen_Item_Del_Cb) (void *data, Evas_Object *obj); /**< Deletion class function for gen item classes. */
7999 struct _Elm_Gen_Item_Class
8001 const char *item_style;
8002 struct _Elm_Gen_Item_Class_Func
8004 Elm_Gen_Item_Label_Get_Cb label_get;
8005 Elm_Gen_Item_Content_Get_Cb content_get;
8006 Elm_Gen_Item_State_Get_Cb state_get;
8007 Elm_Gen_Item_Del_Cb del;
8010 EINA_DEPRECATED EAPI void elm_gen_clear(Evas_Object *obj);
8011 EINA_DEPRECATED EAPI void elm_gen_item_selected_set(Elm_Gen_Item *it, Eina_Bool selected);
8012 EINA_DEPRECATED EAPI Eina_Bool elm_gen_item_selected_get(const Elm_Gen_Item *it);
8013 EINA_DEPRECATED EAPI void elm_gen_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select);
8014 EINA_DEPRECATED EAPI Eina_Bool elm_gen_always_select_mode_get(const Evas_Object *obj);
8015 EINA_DEPRECATED EAPI void elm_gen_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select);
8016 EINA_DEPRECATED EAPI Eina_Bool elm_gen_no_select_mode_get(const Evas_Object *obj);
8017 EINA_DEPRECATED EAPI void elm_gen_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce);
8018 EINA_DEPRECATED EAPI void elm_gen_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce);
8019 EINA_DEPRECATED EAPI void elm_gen_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel);
8020 EINA_DEPRECATED EAPI void elm_gen_page_relative_get(const Evas_Object *obj, double *h_pagerel, double *v_pagerel);
8022 EINA_DEPRECATED EAPI void elm_gen_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize);
8023 EINA_DEPRECATED EAPI void elm_gen_current_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber);
8024 EINA_DEPRECATED EAPI void elm_gen_last_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber);
8025 EINA_DEPRECATED EAPI void elm_gen_page_show(const Evas_Object *obj, int h_pagenumber, int v_pagenumber);
8026 EINA_DEPRECATED EAPI void elm_gen_page_bring_in(const Evas_Object *obj, int h_pagenumber, int v_pagenumber);
8027 EINA_DEPRECATED EAPI Elm_Gen_Item *elm_gen_first_item_get(const Evas_Object *obj);
8028 EINA_DEPRECATED EAPI Elm_Gen_Item *elm_gen_last_item_get(const Evas_Object *obj);
8029 EINA_DEPRECATED EAPI Elm_Gen_Item *elm_gen_item_next_get(const Elm_Gen_Item *it);
8030 EINA_DEPRECATED EAPI Elm_Gen_Item *elm_gen_item_prev_get(const Elm_Gen_Item *it);
8031 EINA_DEPRECATED EAPI Evas_Object *elm_gen_item_widget_get(const Elm_Gen_Item *it);
8034 * @defgroup Gengrid Gengrid (Generic grid)
8036 * This widget aims to position objects in a grid layout while
8037 * actually creating and rendering only the visible ones, using the
8038 * same idea as the @ref Genlist "genlist": the user defines a @b
8039 * class for each item, specifying functions that will be called at
8040 * object creation, deletion, etc. When those items are selected by
8041 * the user, a callback function is issued. Users may interact with
8042 * a gengrid via the mouse (by clicking on items to select them and
8043 * clicking on the grid's viewport and swiping to pan the whole
8044 * view) or via the keyboard, navigating through item with the
8047 * @section Gengrid_Layouts Gengrid layouts
8049 * Gengrid may layout its items in one of two possible layouts:
8053 * When in "horizontal mode", items will be placed in @b columns,
8054 * from top to bottom and, when the space for a column is filled,
8055 * another one is started on the right, thus expanding the grid
8056 * horizontally, making for horizontal scrolling. When in "vertical
8057 * mode" , though, items will be placed in @b rows, from left to
8058 * right and, when the space for a row is filled, another one is
8059 * started below, thus expanding the grid vertically (and making
8060 * for vertical scrolling).
8062 * @section Gengrid_Items Gengrid items
8064 * An item in a gengrid can have 0 or more text labels (they can be
8065 * regular text or textblock Evas objects - that's up to the style
8066 * to determine), 0 or more icons (which are simply objects
8067 * swallowed into the gengrid item's theming Edje object) and 0 or
8068 * more <b>boolean states</b>, which have the behavior left to the
8069 * user to define. The Edje part names for each of these properties
8070 * will be looked up, in the theme file for the gengrid, under the
8071 * Edje (string) data items named @c "labels", @c "icons" and @c
8072 * "states", respectively. For each of those properties, if more
8073 * than one part is provided, they must have names listed separated
8074 * by spaces in the data fields. For the default gengrid item
8075 * theme, we have @b one label part (@c "elm.text"), @b two icon
8076 * parts (@c "elm.swalllow.icon" and @c "elm.swallow.end") and @b
8079 * A gengrid item may be at one of several styles. Elementary
8080 * provides one by default - "default", but this can be extended by
8081 * system or application custom themes/overlays/extensions (see
8082 * @ref Theme "themes" for more details).
8084 * @section Gengrid_Item_Class Gengrid item classes
8086 * In order to have the ability to add and delete items on the fly,
8087 * gengrid implements a class (callback) system where the
8088 * application provides a structure with information about that
8089 * type of item (gengrid may contain multiple different items with
8090 * different classes, states and styles). Gengrid will call the
8091 * functions in this struct (methods) when an item is "realized"
8092 * (i.e., created dynamically, while the user is scrolling the
8093 * grid). All objects will simply be deleted when no longer needed
8094 * with evas_object_del(). The #Elm_GenGrid_Item_Class structure
8095 * contains the following members:
8096 * - @c item_style - This is a constant string and simply defines
8097 * the name of the item style. It @b must be specified and the
8098 * default should be @c "default".
8099 * - @c func.label_get - This function is called when an item
8100 * object is actually created. The @c data parameter will point to
8101 * the same data passed to elm_gengrid_item_append() and related
8102 * item creation functions. The @c obj parameter is the gengrid
8103 * object itself, while the @c part one is the name string of one
8104 * of the existing text parts in the Edje group implementing the
8105 * item's theme. This function @b must return a strdup'()ed string,
8106 * as the caller will free() it when done. See
8107 * #Elm_Gengrid_Item_Label_Get_Cb.
8108 * - @c func.content_get - This function is called when an item object
8109 * is actually created. The @c data parameter will point to the
8110 * same data passed to elm_gengrid_item_append() and related item
8111 * creation functions. The @c obj parameter is the gengrid object
8112 * itself, while the @c part one is the name string of one of the
8113 * existing (content) swallow parts in the Edje group implementing the
8114 * item's theme. It must return @c NULL, when no content is desired,
8115 * or a valid object handle, otherwise. The object will be deleted
8116 * by the gengrid on its deletion or when the item is "unrealized".
8117 * See #Elm_Gengrid_Item_Content_Get_Cb.
8118 * - @c func.state_get - This function is called when an item
8119 * object is actually created. The @c data parameter will point to
8120 * the same data passed to elm_gengrid_item_append() and related
8121 * item creation functions. The @c obj parameter is the gengrid
8122 * object itself, while the @c part one is the name string of one
8123 * of the state parts in the Edje group implementing the item's
8124 * theme. Return @c EINA_FALSE for false/off or @c EINA_TRUE for
8125 * true/on. Gengrids will emit a signal to its theming Edje object
8126 * with @c "elm,state,XXX,active" and @c "elm" as "emission" and
8127 * "source" arguments, respectively, when the state is true (the
8128 * default is false), where @c XXX is the name of the (state) part.
8129 * See #Elm_Gengrid_Item_State_Get_Cb.
8130 * - @c func.del - This is called when elm_gengrid_item_del() is
8131 * called on an item or elm_gengrid_clear() is called on the
8132 * gengrid. This is intended for use when gengrid items are
8133 * deleted, so any data attached to the item (e.g. its data
8134 * parameter on creation) can be deleted. See #Elm_Gengrid_Item_Del_Cb.
8136 * @section Gengrid_Usage_Hints Usage hints
8138 * If the user wants to have multiple items selected at the same
8139 * time, elm_gengrid_multi_select_set() will permit it. If the
8140 * gengrid is single-selection only (the default), then
8141 * elm_gengrid_select_item_get() will return the selected item or
8142 * @c NULL, if none is selected. If the gengrid is under
8143 * multi-selection, then elm_gengrid_selected_items_get() will
8144 * return a list (that is only valid as long as no items are
8145 * modified (added, deleted, selected or unselected) of child items
8148 * If an item changes (internal (boolean) state, label or content
8149 * changes), then use elm_gengrid_item_update() to have gengrid
8150 * update the item with the new state. A gengrid will re-"realize"
8151 * the item, thus calling the functions in the
8152 * #Elm_Gengrid_Item_Class set for that item.
8154 * To programmatically (un)select an item, use
8155 * elm_gengrid_item_selected_set(). To get its selected state use
8156 * elm_gengrid_item_selected_get(). To make an item disabled
8157 * (unable to be selected and appear differently) use
8158 * elm_gengrid_item_disabled_set() to set this and
8159 * elm_gengrid_item_disabled_get() to get the disabled state.
8161 * Grid cells will only have their selection smart callbacks called
8162 * when firstly getting selected. Any further clicks will do
8163 * nothing, unless you enable the "always select mode", with
8164 * elm_gengrid_always_select_mode_set(), thus making every click to
8165 * issue selection callbacks. elm_gengrid_no_select_mode_set() will
8166 * turn off the ability to select items entirely in the widget and
8167 * they will neither appear selected nor call the selection smart
8170 * Remember that you can create new styles and add your own theme
8171 * augmentation per application with elm_theme_extension_add(). If
8172 * you absolutely must have a specific style that overrides any
8173 * theme the user or system sets up you can use
8174 * elm_theme_overlay_add() to add such a file.
8176 * @section Gengrid_Smart_Events Gengrid smart events
8178 * Smart events that you can add callbacks for are:
8179 * - @c "activated" - The user has double-clicked or pressed
8180 * (enter|return|spacebar) on an item. The @c event_info parameter
8181 * is the gengrid item that was activated.
8182 * - @c "clicked,double" - The user has double-clicked an item.
8183 * The @c event_info parameter is the gengrid item that was double-clicked.
8184 * - @c "longpressed" - This is called when the item is pressed for a certain
8185 * amount of time. By default it's 1 second.
8186 * - @c "selected" - The user has made an item selected. The
8187 * @c event_info parameter is the gengrid item that was selected.
8188 * - @c "unselected" - The user has made an item unselected. The
8189 * @c event_info parameter is the gengrid item that was unselected.
8190 * - @c "realized" - This is called when the item in the gengrid
8191 * has its implementing Evas object instantiated, de facto. @c
8192 * event_info is the gengrid item that was created. The object
8193 * may be deleted at any time, so it is highly advised to the
8194 * caller @b not to use the object pointer returned from
8195 * elm_gengrid_item_object_get(), because it may point to freed
8197 * - @c "unrealized" - This is called when the implementing Evas
8198 * object for this item is deleted. @c event_info is the gengrid
8199 * item that was deleted.
8200 * - @c "changed" - Called when an item is added, removed, resized
8201 * or moved and when the gengrid is resized or gets "horizontal"
8203 * - @c "scroll,anim,start" - This is called when scrolling animation has
8205 * - @c "scroll,anim,stop" - This is called when scrolling animation has
8207 * - @c "drag,start,up" - Called when the item in the gengrid has
8208 * been dragged (not scrolled) up.
8209 * - @c "drag,start,down" - Called when the item in the gengrid has
8210 * been dragged (not scrolled) down.
8211 * - @c "drag,start,left" - Called when the item in the gengrid has
8212 * been dragged (not scrolled) left.
8213 * - @c "drag,start,right" - Called when the item in the gengrid has
8214 * been dragged (not scrolled) right.
8215 * - @c "drag,stop" - Called when the item in the gengrid has
8216 * stopped being dragged.
8217 * - @c "drag" - Called when the item in the gengrid is being
8219 * - @c "scroll" - called when the content has been scrolled
8221 * - @c "scroll,drag,start" - called when dragging the content has
8223 * - @c "scroll,drag,stop" - called when dragging the content has
8225 * - @c "edge,top" - This is called when the gengrid is scrolled until
8227 * - @c "edge,bottom" - This is called when the gengrid is scrolled
8228 * until the bottom edge.
8229 * - @c "edge,left" - This is called when the gengrid is scrolled
8230 * until the left edge.
8231 * - @c "edge,right" - This is called when the gengrid is scrolled
8232 * until the right edge.
8234 * List of gengrid examples:
8235 * @li @ref gengrid_example
8239 * @addtogroup Gengrid
8243 typedef struct _Elm_Gengrid_Item_Class Elm_Gengrid_Item_Class; /**< Gengrid item class definition structs */
8244 #define Elm_Gengrid_Item_Class Elm_Gen_Item_Class
8245 typedef struct _Elm_Gengrid_Item Elm_Gengrid_Item; /**< Gengrid item handles */
8246 #define Elm_Gengrid_Item Elm_Gen_Item /**< Item of Elm_Genlist. Sub-type of Elm_Widget_Item */
8247 typedef struct _Elm_Gengrid_Item_Class_Func Elm_Gengrid_Item_Class_Func; /**< Class functions for gengrid item classes. */
8249 * Label fetching class function for Elm_Gen_Item_Class.
8250 * @param data The data passed in the item creation function
8251 * @param obj The base widget object
8252 * @param part The part name of the swallow
8253 * @return The allocated (NOT stringshared) string to set as the label
8255 typedef char *(*Elm_Gengrid_Item_Label_Get_Cb) (void *data, Evas_Object *obj, const char *part);
8257 * Content (swallowed object) fetching class function for Elm_Gen_Item_Class.
8258 * @param data The data passed in the item creation function
8259 * @param obj The base widget object
8260 * @param part The part name of the swallow
8261 * @return The content object to swallow
8263 typedef Evas_Object *(*Elm_Gengrid_Item_Content_Get_Cb) (void *data, Evas_Object *obj, const char *part);
8265 * State fetching class function for Elm_Gen_Item_Class.
8266 * @param data The data passed in the item creation function
8267 * @param obj The base widget object
8268 * @param part The part name of the swallow
8269 * @return The hell if I know
8271 typedef Eina_Bool (*Elm_Gengrid_Item_State_Get_Cb) (void *data, Evas_Object *obj, const char *part);
8273 * Deletion class function for Elm_Gen_Item_Class.
8274 * @param data The data passed in the item creation function
8275 * @param obj The base widget object
8277 typedef void (*Elm_Gengrid_Item_Del_Cb) (void *data, Evas_Object *obj);
8280 * @struct _Elm_Gengrid_Item_Class
8282 * Gengrid item class definition. See @ref Gengrid_Item_Class for
8285 struct _Elm_Gengrid_Item_Class
8287 const char *item_style;
8288 struct _Elm_Gengrid_Item_Class_Func
8290 Elm_Gengrid_Item_Label_Get_Cb label_get;
8291 Elm_Gengrid_Item_Content_Get_Cb content_get;
8292 Elm_Gengrid_Item_State_Get_Cb state_get;
8293 Elm_Gengrid_Item_Del_Cb del;
8295 }; /**< #Elm_Gengrid_Item_Class member definitions */
8296 #define Elm_Gengrid_Item_Class_Func Elm_Gen_Item_Class_Func
8298 * Add a new gengrid widget to the given parent Elementary
8299 * (container) object
8301 * @param parent The parent object
8302 * @return a new gengrid widget handle or @c NULL, on errors
8304 * This function inserts a new gengrid widget on the canvas.
8306 * @see elm_gengrid_item_size_set()
8307 * @see elm_gengrid_group_item_size_set()
8308 * @see elm_gengrid_horizontal_set()
8309 * @see elm_gengrid_item_append()
8310 * @see elm_gengrid_item_del()
8311 * @see elm_gengrid_clear()
8315 EAPI Evas_Object *elm_gengrid_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
8318 * Set the size for the items of a given gengrid widget
8320 * @param obj The gengrid object.
8321 * @param w The items' width.
8322 * @param h The items' height;
8324 * A gengrid, after creation, has still no information on the size
8325 * to give to each of its cells. So, you most probably will end up
8326 * with squares one @ref Fingers "finger" wide, the default
8327 * size. Use this function to force a custom size for you items,
8328 * making them as big as you wish.
8330 * @see elm_gengrid_item_size_get()
8334 EAPI void elm_gengrid_item_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
8337 * Get the size set for the items of a given gengrid widget
8339 * @param obj The gengrid object.
8340 * @param w Pointer to a variable where to store the items' width.
8341 * @param h Pointer to a variable where to store the items' height.
8343 * @note Use @c NULL pointers on the size values you're not
8344 * interested in: they'll be ignored by the function.
8346 * @see elm_gengrid_item_size_get() for more details
8350 EAPI void elm_gengrid_item_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
8353 * Set the size for the group items of a given gengrid widget
8355 * @param obj The gengrid object.
8356 * @param w The group items' width.
8357 * @param h The group items' height;
8359 * A gengrid, after creation, has still no information on the size
8360 * to give to each of its cells. So, you most probably will end up
8361 * with squares one @ref Fingers "finger" wide, the default
8362 * size. Use this function to force a custom size for you group items,
8363 * making them as big as you wish.
8365 * @see elm_gengrid_group_item_size_get()
8369 EAPI void elm_gengrid_group_item_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
8372 * Get the size set for the group items of a given gengrid widget
8374 * @param obj The gengrid object.
8375 * @param w Pointer to a variable where to store the group items' width.
8376 * @param h Pointer to a variable where to store the group items' height.
8378 * @note Use @c NULL pointers on the size values you're not
8379 * interested in: they'll be ignored by the function.
8381 * @see elm_gengrid_group_item_size_get() for more details
8385 EAPI void elm_gengrid_group_item_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
8388 * Set the items grid's alignment within a given gengrid widget
8390 * @param obj The gengrid object.
8391 * @param align_x Alignment in the horizontal axis (0 <= align_x <= 1).
8392 * @param align_y Alignment in the vertical axis (0 <= align_y <= 1).
8394 * This sets the alignment of the whole grid of items of a gengrid
8395 * within its given viewport. By default, those values are both
8396 * 0.5, meaning that the gengrid will have its items grid placed
8397 * exactly in the middle of its viewport.
8399 * @note If given alignment values are out of the cited ranges,
8400 * they'll be changed to the nearest boundary values on the valid
8403 * @see elm_gengrid_align_get()
8407 EAPI void elm_gengrid_align_set(Evas_Object *obj, double align_x, double align_y) EINA_ARG_NONNULL(1);
8410 * Get the items grid's alignment values within a given gengrid
8413 * @param obj The gengrid object.
8414 * @param align_x Pointer to a variable where to store the
8415 * horizontal alignment.
8416 * @param align_y Pointer to a variable where to store the vertical
8419 * @note Use @c NULL pointers on the alignment values you're not
8420 * interested in: they'll be ignored by the function.
8422 * @see elm_gengrid_align_set() for more details
8426 EAPI void elm_gengrid_align_get(const Evas_Object *obj, double *align_x, double *align_y) EINA_ARG_NONNULL(1);
8429 * Set whether a given gengrid widget is or not able have items
8432 * @param obj The gengrid object
8433 * @param reorder_mode Use @c EINA_TRUE to turn reoderding on,
8434 * @c EINA_FALSE to turn it off
8436 * If a gengrid is set to allow reordering, a click held for more
8437 * than 0.5 over a given item will highlight it specially,
8438 * signalling the gengrid has entered the reordering state. From
8439 * that time on, the user will be able to, while still holding the
8440 * mouse button down, move the item freely in the gengrid's
8441 * viewport, replacing to said item to the locations it goes to.
8442 * The replacements will be animated and, whenever the user
8443 * releases the mouse button, the item being replaced gets a new
8444 * definitive place in the grid.
8446 * @see elm_gengrid_reorder_mode_get()
8450 EAPI void elm_gengrid_reorder_mode_set(Evas_Object *obj, Eina_Bool reorder_mode) EINA_ARG_NONNULL(1);
8453 * Get whether a given gengrid widget is or not able have items
8456 * @param obj The gengrid object
8457 * @return @c EINA_TRUE, if reoderding is on, @c EINA_FALSE if it's
8460 * @see elm_gengrid_reorder_mode_set() for more details
8464 EAPI Eina_Bool elm_gengrid_reorder_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8467 * Append a new item in a given gengrid widget.
8469 * @param obj The gengrid object.
8470 * @param gic The item class for the item.
8471 * @param data The item data.
8472 * @param func Convenience function called when the item is
8474 * @param func_data Data to be passed to @p func.
8475 * @return A handle to the item added or @c NULL, on errors.
8477 * This adds an item to the beginning of the gengrid.
8479 * @see elm_gengrid_item_prepend()
8480 * @see elm_gengrid_item_insert_before()
8481 * @see elm_gengrid_item_insert_after()
8482 * @see elm_gengrid_item_del()
8486 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);
8489 * Prepend a new item in a given gengrid widget.
8491 * @param obj The gengrid object.
8492 * @param gic The item class for the item.
8493 * @param data The item data.
8494 * @param func Convenience function called when the item is
8496 * @param func_data Data to be passed to @p func.
8497 * @return A handle to the item added or @c NULL, on errors.
8499 * This adds an item to the end of the gengrid.
8501 * @see elm_gengrid_item_append()
8502 * @see elm_gengrid_item_insert_before()
8503 * @see elm_gengrid_item_insert_after()
8504 * @see elm_gengrid_item_del()
8508 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);
8511 * Insert an item before another in a gengrid widget
8513 * @param obj The gengrid object.
8514 * @param gic The item class for the item.
8515 * @param data The item data.
8516 * @param relative The item to place this new one before.
8517 * @param func Convenience function called when the item is
8519 * @param func_data Data to be passed to @p func.
8520 * @return A handle to the item added or @c NULL, on errors.
8522 * This inserts an item before another in the gengrid.
8524 * @see elm_gengrid_item_append()
8525 * @see elm_gengrid_item_prepend()
8526 * @see elm_gengrid_item_insert_after()
8527 * @see elm_gengrid_item_del()
8531 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);
8534 * Insert an item after another in a gengrid widget
8536 * @param obj The gengrid object.
8537 * @param gic The item class for the item.
8538 * @param data The item data.
8539 * @param relative The item to place this new one after.
8540 * @param func Convenience function called when the item is
8542 * @param func_data Data to be passed to @p func.
8543 * @return A handle to the item added or @c NULL, on errors.
8545 * This inserts an item after another in the gengrid.
8547 * @see elm_gengrid_item_append()
8548 * @see elm_gengrid_item_prepend()
8549 * @see elm_gengrid_item_insert_after()
8550 * @see elm_gengrid_item_del()
8554 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);
8557 * Insert an item in a gengrid widget using a user-defined sort function.
8559 * @param obj The gengrid object.
8560 * @param gic The item class for the item.
8561 * @param data The item data.
8562 * @param comp User defined comparison function that defines the sort order based on
8563 * Elm_Gen_Item and its data param.
8564 * @param func Convenience function called when the item is selected.
8565 * @param func_data Data to be passed to @p func.
8566 * @return A handle to the item added or @c NULL, on errors.
8568 * This inserts an item in the gengrid based on user defined comparison function.
8570 * @see elm_gengrid_item_append()
8571 * @see elm_gengrid_item_prepend()
8572 * @see elm_gengrid_item_insert_after()
8573 * @see elm_gengrid_item_del()
8574 * @see elm_gengrid_item_direct_sorted_insert()
8578 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);
8581 * Insert an item in a gengrid widget using a user-defined sort function.
8583 * @param obj The gengrid object.
8584 * @param gic The item class for the item.
8585 * @param data The item data.
8586 * @param comp User defined comparison function that defines the sort order based on
8588 * @param func Convenience function called when the item is selected.
8589 * @param func_data Data to be passed to @p func.
8590 * @return A handle to the item added or @c NULL, on errors.
8592 * This inserts an item in the gengrid based on user defined comparison function.
8594 * @see elm_gengrid_item_append()
8595 * @see elm_gengrid_item_prepend()
8596 * @see elm_gengrid_item_insert_after()
8597 * @see elm_gengrid_item_del()
8598 * @see elm_gengrid_item_sorted_insert()
8602 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);
8605 * Set whether items on a given gengrid widget are to get their
8606 * selection callbacks issued for @b every subsequent selection
8607 * click on them or just for the first click.
8609 * @param obj The gengrid object
8610 * @param always_select @c EINA_TRUE to make items "always
8611 * selected", @c EINA_FALSE, otherwise
8613 * By default, grid items will only call their selection callback
8614 * function when firstly getting selected, any subsequent further
8615 * clicks will do nothing. With this call, you make those
8616 * subsequent clicks also to issue the selection callbacks.
8618 * @note <b>Double clicks</b> will @b always be reported on items.
8620 * @see elm_gengrid_always_select_mode_get()
8624 EAPI void elm_gengrid_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
8627 * Get whether items on a given gengrid widget have their selection
8628 * callbacks issued for @b every subsequent selection click on them
8629 * or just for the first click.
8631 * @param obj The gengrid object.
8632 * @return @c EINA_TRUE if the gengrid items are "always selected",
8633 * @c EINA_FALSE, otherwise
8635 * @see elm_gengrid_always_select_mode_set() for more details
8639 EAPI Eina_Bool elm_gengrid_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8642 * Set whether items on a given gengrid widget can be selected or not.
8644 * @param obj The gengrid object
8645 * @param no_select @c EINA_TRUE to make items selectable,
8646 * @c EINA_FALSE otherwise
8648 * This will make items in @p obj selectable or not. In the latter
8649 * case, any user interaction on the gengrid items will neither make
8650 * them appear selected nor them call their selection callback
8653 * @see elm_gengrid_no_select_mode_get()
8657 EAPI void elm_gengrid_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
8660 * Get whether items on a given gengrid widget can be selected or
8663 * @param obj The gengrid object
8664 * @return @c EINA_TRUE, if items are selectable, @c EINA_FALSE
8667 * @see elm_gengrid_no_select_mode_set() for more details
8671 EAPI Eina_Bool elm_gengrid_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8674 * Enable or disable multi-selection in a given gengrid widget
8676 * @param obj The gengrid object.
8677 * @param multi @c EINA_TRUE, to enable multi-selection,
8678 * @c EINA_FALSE to disable it.
8680 * Multi-selection is the ability to have @b more than one
8681 * item selected, on a given gengrid, simultaneously. When it is
8682 * enabled, a sequence of clicks on different items will make them
8683 * all selected, progressively. A click on an already selected item
8684 * will unselect it. If interacting via the keyboard,
8685 * multi-selection is enabled while holding the "Shift" key.
8687 * @note By default, multi-selection is @b disabled on gengrids
8689 * @see elm_gengrid_multi_select_get()
8693 EAPI void elm_gengrid_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
8696 * Get whether multi-selection is enabled or disabled for a given
8699 * @param obj The gengrid object.
8700 * @return @c EINA_TRUE, if multi-selection is enabled, @c
8701 * EINA_FALSE otherwise
8703 * @see elm_gengrid_multi_select_set() for more details
8707 EAPI Eina_Bool elm_gengrid_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8710 * Enable or disable bouncing effect for a given gengrid widget
8712 * @param obj The gengrid object
8713 * @param h_bounce @c EINA_TRUE, to enable @b horizontal bouncing,
8714 * @c EINA_FALSE to disable it
8715 * @param v_bounce @c EINA_TRUE, to enable @b vertical bouncing,
8716 * @c EINA_FALSE to disable it
8718 * The bouncing effect occurs whenever one reaches the gengrid's
8719 * edge's while panning it -- it will scroll past its limits a
8720 * little bit and return to the edge again, in a animated for,
8723 * @note By default, gengrids have bouncing enabled on both axis
8725 * @see elm_gengrid_bounce_get()
8729 EAPI void elm_gengrid_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
8732 * Get whether bouncing effects are enabled or disabled, for a
8733 * given gengrid widget, on each axis
8735 * @param obj The gengrid object
8736 * @param h_bounce Pointer to a variable where to store the
8737 * horizontal bouncing flag.
8738 * @param v_bounce Pointer to a variable where to store the
8739 * vertical bouncing flag.
8741 * @see elm_gengrid_bounce_set() for more details
8745 EAPI void elm_gengrid_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
8748 * Set a given gengrid widget's scrolling page size, relative to
8749 * its viewport size.
8751 * @param obj The gengrid object
8752 * @param h_pagerel The horizontal page (relative) size
8753 * @param v_pagerel The vertical page (relative) size
8755 * The gengrid's scroller is capable of binding scrolling by the
8756 * user to "pages". It means that, while scrolling and, specially
8757 * after releasing the mouse button, the grid will @b snap to the
8758 * nearest displaying page's area. When page sizes are set, the
8759 * grid's continuous content area is split into (equal) page sized
8762 * This function sets the size of a page <b>relatively to the
8763 * viewport dimensions</b> of the gengrid, for each axis. A value
8764 * @c 1.0 means "the exact viewport's size", in that axis, while @c
8765 * 0.0 turns paging off in that axis. Likewise, @c 0.5 means "half
8766 * a viewport". Sane usable values are, than, between @c 0.0 and @c
8767 * 1.0. Values beyond those will make it behave behave
8768 * inconsistently. If you only want one axis to snap to pages, use
8769 * the value @c 0.0 for the other one.
8771 * There is a function setting page size values in @b absolute
8772 * values, too -- elm_gengrid_page_size_set(). Naturally, its use
8773 * is mutually exclusive to this one.
8775 * @see elm_gengrid_page_relative_get()
8779 EAPI void elm_gengrid_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel) EINA_ARG_NONNULL(1);
8782 * Get a given gengrid widget's scrolling page size, relative to
8783 * its viewport size.
8785 * @param obj The gengrid object
8786 * @param h_pagerel Pointer to a variable where to store the
8787 * horizontal page (relative) size
8788 * @param v_pagerel Pointer to a variable where to store the
8789 * vertical page (relative) size
8791 * @see elm_gengrid_page_relative_set() for more details
8795 EAPI void elm_gengrid_page_relative_get(const Evas_Object *obj, double *h_pagerel, double *v_pagerel) EINA_ARG_NONNULL(1);
8798 * Set a given gengrid widget's scrolling page size
8800 * @param obj The gengrid object
8801 * @param h_pagerel The horizontal page size, in pixels
8802 * @param v_pagerel The vertical page size, in pixels
8804 * The gengrid's scroller is capable of binding scrolling by the
8805 * user to "pages". It means that, while scrolling and, specially
8806 * after releasing the mouse button, the grid will @b snap to the
8807 * nearest displaying page's area. When page sizes are set, the
8808 * grid's continuous content area is split into (equal) page sized
8811 * This function sets the size of a page of the gengrid, in pixels,
8812 * for each axis. Sane usable values are, between @c 0 and the
8813 * dimensions of @p obj, for each axis. Values beyond those will
8814 * make it behave behave inconsistently. If you only want one axis
8815 * to snap to pages, use the value @c 0 for the other one.
8817 * There is a function setting page size values in @b relative
8818 * values, too -- elm_gengrid_page_relative_set(). Naturally, its
8819 * use is mutually exclusive to this one.
8823 EAPI void elm_gengrid_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize) EINA_ARG_NONNULL(1);
8826 * @brief Get gengrid current page number.
8828 * @param obj The gengrid object
8829 * @param h_pagenumber The horizontal page number
8830 * @param v_pagenumber The vertical page number
8832 * The page number starts from 0. 0 is the first page.
8833 * Current page means the page which meet the top-left of the viewport.
8834 * If there are two or more pages in the viewport, it returns the number of page
8835 * which meet the top-left of the viewport.
8837 * @see elm_gengrid_last_page_get()
8838 * @see elm_gengrid_page_show()
8839 * @see elm_gengrid_page_brint_in()
8841 EAPI void elm_gengrid_current_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber) EINA_ARG_NONNULL(1);
8844 * @brief Get scroll last page number.
8846 * @param obj The gengrid object
8847 * @param h_pagenumber The horizontal page number
8848 * @param v_pagenumber The vertical page number
8850 * The page number starts from 0. 0 is the first page.
8851 * This returns the last page number among the pages.
8853 * @see elm_gengrid_current_page_get()
8854 * @see elm_gengrid_page_show()
8855 * @see elm_gengrid_page_brint_in()
8857 EAPI void elm_gengrid_last_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber) EINA_ARG_NONNULL(1);
8860 * Show a specific virtual region within the gengrid content object by page number.
8862 * @param obj The gengrid object
8863 * @param h_pagenumber The horizontal page number
8864 * @param v_pagenumber The vertical page number
8866 * 0, 0 of the indicated page is located at the top-left of the viewport.
8867 * This will jump to the page directly without animation.
8872 * sc = elm_gengrid_add(win);
8873 * elm_gengrid_content_set(sc, content);
8874 * elm_gengrid_page_relative_set(sc, 1, 0);
8875 * elm_gengrid_current_page_get(sc, &h_page, &v_page);
8876 * elm_gengrid_page_show(sc, h_page + 1, v_page);
8879 * @see elm_gengrid_page_bring_in()
8881 EAPI void elm_gengrid_page_show(const Evas_Object *obj, int h_pagenumber, int v_pagenumber) EINA_ARG_NONNULL(1);
8884 * Show a specific virtual region within the gengrid content object by page number.
8886 * @param obj The gengrid object
8887 * @param h_pagenumber The horizontal page number
8888 * @param v_pagenumber The vertical page number
8890 * 0, 0 of the indicated page is located at the top-left of the viewport.
8891 * This will slide to the page with animation.
8896 * sc = elm_gengrid_add(win);
8897 * elm_gengrid_content_set(sc, content);
8898 * elm_gengrid_page_relative_set(sc, 1, 0);
8899 * elm_gengrid_last_page_get(sc, &h_page, &v_page);
8900 * elm_gengrid_page_bring_in(sc, h_page, v_page);
8903 * @see elm_gengrid_page_show()
8905 EAPI void elm_gengrid_page_bring_in(const Evas_Object *obj, int h_pagenumber, int v_pagenumber) EINA_ARG_NONNULL(1);
8908 * Set the direction in which a given gengrid widget will expand while
8909 * placing its items.
8911 * @param obj The gengrid object.
8912 * @param setting @c EINA_TRUE to make the gengrid expand
8913 * horizontally, @c EINA_FALSE to expand vertically.
8915 * When in "horizontal mode" (@c EINA_TRUE), items will be placed
8916 * in @b columns, from top to bottom and, when the space for a
8917 * column is filled, another one is started on the right, thus
8918 * expanding the grid horizontally. When in "vertical mode"
8919 * (@c EINA_FALSE), though, items will be placed in @b rows, from left
8920 * to right and, when the space for a row is filled, another one is
8921 * started below, thus expanding the grid vertically.
8923 * @see elm_gengrid_horizontal_get()
8927 EAPI void elm_gengrid_horizontal_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
8930 * Get for what direction a given gengrid widget will expand while
8931 * placing its items.
8933 * @param obj The gengrid object.
8934 * @return @c EINA_TRUE, if @p obj is set to expand horizontally,
8935 * @c EINA_FALSE if it's set to expand vertically.
8937 * @see elm_gengrid_horizontal_set() for more detais
8941 EAPI Eina_Bool elm_gengrid_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8944 * Get the first item in a given gengrid widget
8946 * @param obj The gengrid object
8947 * @return The first item's handle or @c NULL, if there are no
8948 * items in @p obj (and on errors)
8950 * This returns the first item in the @p obj's internal list of
8953 * @see elm_gengrid_last_item_get()
8957 EAPI Elm_Gengrid_Item *elm_gengrid_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8960 * Get the last item in a given gengrid widget
8962 * @param obj The gengrid object
8963 * @return The last item's handle or @c NULL, if there are no
8964 * items in @p obj (and on errors)
8966 * This returns the last item in the @p obj's internal list of
8969 * @see elm_gengrid_first_item_get()
8973 EAPI Elm_Gengrid_Item *elm_gengrid_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8976 * Get the @b next item in a gengrid widget's internal list of items,
8977 * given a handle to one of those items.
8979 * @param item The gengrid item to fetch next from
8980 * @return The item after @p item, or @c NULL if there's none (and
8983 * This returns the item placed after the @p item, on the container
8986 * @see elm_gengrid_item_prev_get()
8990 EAPI Elm_Gengrid_Item *elm_gengrid_item_next_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8993 * Get the @b previous item in a gengrid widget's internal list of items,
8994 * given a handle to one of those items.
8996 * @param item The gengrid item to fetch previous from
8997 * @return The item before @p item, or @c NULL if there's none (and
9000 * This returns the item placed before the @p item, on the container
9003 * @see elm_gengrid_item_next_get()
9007 EAPI Elm_Gengrid_Item *elm_gengrid_item_prev_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9010 * Get the gengrid object's handle which contains a given gengrid
9013 * @param item The item to fetch the container from
9014 * @return The gengrid (parent) object
9016 * This returns the gengrid object itself that an item belongs to.
9020 EAPI Evas_Object *elm_gengrid_item_gengrid_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9023 * Remove a gengrid item from its parent, deleting it.
9025 * @param item The item to be removed.
9026 * @return @c EINA_TRUE on success or @c EINA_FALSE, otherwise.
9028 * @see elm_gengrid_clear(), to remove all items in a gengrid at
9033 EAPI void elm_gengrid_item_del(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9036 * Update the contents of a given gengrid item
9038 * @param item The gengrid item
9040 * This updates an item by calling all the item class functions
9041 * again to get the contents, labels and states. Use this when the
9042 * original item data has changed and you want the changes to be
9047 EAPI void elm_gengrid_item_update(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9050 * Get the Gengrid Item class for the given Gengrid Item.
9052 * @param item The gengrid item
9054 * This returns the Gengrid_Item_Class for the given item. It can be used to examine
9055 * the function pointers and item_style.
9059 EAPI const Elm_Gengrid_Item_Class *elm_gengrid_item_item_class_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9062 * Get the Gengrid Item class for the given Gengrid Item.
9064 * This sets the Gengrid_Item_Class for the given item. It can be used to examine
9065 * the function pointers and item_style.
9067 * @param item The gengrid item
9068 * @param gic The gengrid item class describing the function pointers and the item style.
9072 EAPI void elm_gengrid_item_item_class_set(Elm_Gengrid_Item *item, const Elm_Gengrid_Item_Class *gic) EINA_ARG_NONNULL(1, 2);
9075 * Return the data associated to a given gengrid item
9077 * @param item The gengrid item.
9078 * @return the data associated with this item.
9080 * This returns the @c data value passed on the
9081 * elm_gengrid_item_append() and related item addition calls.
9083 * @see elm_gengrid_item_append()
9084 * @see elm_gengrid_item_data_set()
9088 EAPI void *elm_gengrid_item_data_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9091 * Set the data associated with a given gengrid item
9093 * @param item The gengrid item
9094 * @param data The data pointer to set on it
9096 * This @b overrides the @c data value passed on the
9097 * elm_gengrid_item_append() and related item addition calls. This
9098 * function @b won't call elm_gengrid_item_update() automatically,
9099 * so you'd issue it afterwards if you want to have the item
9100 * updated to reflect the new data.
9102 * @see elm_gengrid_item_data_get()
9103 * @see elm_gengrid_item_update()
9107 EAPI void elm_gengrid_item_data_set(Elm_Gengrid_Item *item, const void *data) EINA_ARG_NONNULL(1);
9110 * Get a given gengrid item's position, relative to the whole
9111 * gengrid's grid area.
9113 * @param item The Gengrid item.
9114 * @param x Pointer to variable to store the item's <b>row number</b>.
9115 * @param y Pointer to variable to store the item's <b>column number</b>.
9117 * This returns the "logical" position of the item within the
9118 * gengrid. For example, @c (0, 1) would stand for first row,
9123 EAPI void elm_gengrid_item_pos_get(const Elm_Gengrid_Item *item, unsigned int *x, unsigned int *y) EINA_ARG_NONNULL(1);
9126 * Set whether a given gengrid item is selected or not
9128 * @param item The gengrid item
9129 * @param selected Use @c EINA_TRUE, to make it selected, @c
9130 * EINA_FALSE to make it unselected
9132 * This sets the selected state of an item. If multi-selection is
9133 * not enabled on the containing gengrid and @p selected is @c
9134 * EINA_TRUE, any other previously selected items will get
9135 * unselected in favor of this new one.
9137 * @see elm_gengrid_item_selected_get()
9141 EAPI void elm_gengrid_item_selected_set(Elm_Gengrid_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
9144 * Get whether a given gengrid item is selected or not
9146 * @param item The gengrid item
9147 * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
9149 * This API returns EINA_TRUE for all the items selected in multi-select mode as well.
9151 * @see elm_gengrid_item_selected_set() for more details
9155 EAPI Eina_Bool elm_gengrid_item_selected_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9158 * Get the real Evas object created to implement the view of a
9159 * given gengrid item
9161 * @param item The gengrid item.
9162 * @return the Evas object implementing this item's view.
9164 * This returns the actual Evas object used to implement the
9165 * specified gengrid item's view. This may be @c NULL, as it may
9166 * not have been created or may have been deleted, at any time, by
9167 * the gengrid. <b>Do not modify this object</b> (move, resize,
9168 * show, hide, etc.), as the gengrid is controlling it. This
9169 * function is for querying, emitting custom signals or hooking
9170 * lower level callbacks for events on that object. Do not delete
9171 * this object under any circumstances.
9173 * @see elm_gengrid_item_data_get()
9177 EAPI const Evas_Object *elm_gengrid_item_object_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9180 * Show the portion of a gengrid's internal grid containing a given
9181 * item, @b immediately.
9183 * @param item The item to display
9185 * This causes gengrid to @b redraw its viewport's contents to the
9186 * region contining the given @p item item, if it is not fully
9189 * @see elm_gengrid_item_bring_in()
9193 EAPI void elm_gengrid_item_show(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9196 * Animatedly bring in, to the visible area of a gengrid, a given
9199 * @param item The gengrid item to display
9201 * This causes gengrid to jump to the given @p item and show
9202 * it (by scrolling), if it is not fully visible. This will use
9203 * animation to do so and take a period of time to complete.
9205 * @see elm_gengrid_item_show()
9209 EAPI void elm_gengrid_item_bring_in(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9212 * Set whether a given gengrid item is disabled or not.
9214 * @param item The gengrid item
9215 * @param disabled Use @c EINA_TRUE, true disable it, @c EINA_FALSE
9216 * to enable it back.
9218 * A disabled item cannot be selected or unselected. It will also
9219 * change its appearance, to signal the user it's disabled.
9221 * @see elm_gengrid_item_disabled_get()
9225 EAPI void elm_gengrid_item_disabled_set(Elm_Gengrid_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
9228 * Get whether a given gengrid item is disabled or not.
9230 * @param item The gengrid item
9231 * @return @c EINA_TRUE, if it's disabled, @c EINA_FALSE otherwise
9234 * @see elm_gengrid_item_disabled_set() for more details
9238 EAPI Eina_Bool elm_gengrid_item_disabled_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9241 * Set the text to be shown in a given gengrid item's tooltips.
9243 * @param item The gengrid item
9244 * @param text The text to set in the content
9246 * This call will setup the text to be used as tooltip to that item
9247 * (analogous to elm_object_tooltip_text_set(), but being item
9248 * tooltips with higher precedence than object tooltips). It can
9249 * have only one tooltip at a time, so any previous tooltip data
9254 EAPI void elm_gengrid_item_tooltip_text_set(Elm_Gengrid_Item *item, const char *text) EINA_ARG_NONNULL(1);
9257 * Set the content to be shown in a given gengrid item's tooltip
9259 * @param item The gengrid item.
9260 * @param func The function returning the tooltip contents.
9261 * @param data What to provide to @a func as callback data/context.
9262 * @param del_cb Called when data is not needed anymore, either when
9263 * another callback replaces @p func, the tooltip is unset with
9264 * elm_gengrid_item_tooltip_unset() or the owner @p item
9265 * dies. This callback receives as its first parameter the
9266 * given @p data, being @c event_info the item handle.
9268 * This call will setup the tooltip's contents to @p item
9269 * (analogous to elm_object_tooltip_content_cb_set(), but being
9270 * item tooltips with higher precedence than object tooltips). It
9271 * can have only one tooltip at a time, so any previous tooltip
9272 * content will get removed. @p func (with @p data) will be called
9273 * every time Elementary needs to show the tooltip and it should
9274 * return a valid Evas object, which will be fully managed by the
9275 * tooltip system, getting deleted when the tooltip is gone.
9279 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);
9282 * Unset a tooltip from a given gengrid item
9284 * @param item gengrid item to remove a previously set tooltip from.
9286 * This call removes any tooltip set on @p item. The callback
9287 * provided as @c del_cb to
9288 * elm_gengrid_item_tooltip_content_cb_set() will be called to
9289 * notify it is not used anymore (and have resources cleaned, if
9292 * @see elm_gengrid_item_tooltip_content_cb_set()
9296 EAPI void elm_gengrid_item_tooltip_unset(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9299 * Set a different @b style for a given gengrid item's tooltip.
9301 * @param item gengrid item with tooltip set
9302 * @param style the <b>theme style</b> to use on tooltips (e.g. @c
9303 * "default", @c "transparent", etc)
9305 * Tooltips can have <b>alternate styles</b> to be displayed on,
9306 * which are defined by the theme set on Elementary. This function
9307 * works analogously as elm_object_tooltip_style_set(), but here
9308 * applied only to gengrid item objects. The default style for
9309 * tooltips is @c "default".
9311 * @note before you set a style you should define a tooltip with
9312 * elm_gengrid_item_tooltip_content_cb_set() or
9313 * elm_gengrid_item_tooltip_text_set()
9315 * @see elm_gengrid_item_tooltip_style_get()
9319 EAPI void elm_gengrid_item_tooltip_style_set(Elm_Gengrid_Item *item, const char *style) EINA_ARG_NONNULL(1);
9322 * Get the style set a given gengrid item's tooltip.
9324 * @param item gengrid item with tooltip already set on.
9325 * @return style the theme style in use, which defaults to
9326 * "default". If the object does not have a tooltip set,
9327 * then @c NULL is returned.
9329 * @see elm_gengrid_item_tooltip_style_set() for more details
9333 EAPI const char *elm_gengrid_item_tooltip_style_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9335 * @brief Disable size restrictions on an object's tooltip
9336 * @param item The tooltip's anchor object
9337 * @param disable If EINA_TRUE, size restrictions are disabled
9338 * @return EINA_FALSE on failure, EINA_TRUE on success
9340 * This function allows a tooltip to expand beyond its parant window's canvas.
9341 * It will instead be limited only by the size of the display.
9343 EAPI Eina_Bool elm_gengrid_item_tooltip_size_restrict_disable(Elm_Gengrid_Item *item, Eina_Bool disable);
9345 * @brief Retrieve size restriction state of an object's tooltip
9346 * @param item The tooltip's anchor object
9347 * @return If EINA_TRUE, size restrictions are disabled
9349 * This function returns whether a tooltip is allowed to expand beyond
9350 * its parant window's canvas.
9351 * It will instead be limited only by the size of the display.
9353 EAPI Eina_Bool elm_gengrid_item_tooltip_size_restrict_disabled_get(const Elm_Gengrid_Item *item);
9355 * Set the type of mouse pointer/cursor decoration to be shown,
9356 * when the mouse pointer is over the given gengrid widget item
9358 * @param item gengrid item to customize cursor on
9359 * @param cursor the cursor type's name
9361 * This function works analogously as elm_object_cursor_set(), but
9362 * here the cursor's changing area is restricted to the item's
9363 * area, and not the whole widget's. Note that that item cursors
9364 * have precedence over widget cursors, so that a mouse over @p
9365 * item will always show cursor @p type.
9367 * If this function is called twice for an object, a previously set
9368 * cursor will be unset on the second call.
9370 * @see elm_object_cursor_set()
9371 * @see elm_gengrid_item_cursor_get()
9372 * @see elm_gengrid_item_cursor_unset()
9376 EAPI void elm_gengrid_item_cursor_set(Elm_Gengrid_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
9379 * Get the type of mouse pointer/cursor decoration set to be shown,
9380 * when the mouse pointer is over the given gengrid widget item
9382 * @param item gengrid item with custom cursor set
9383 * @return the cursor type's name or @c NULL, if no custom cursors
9384 * were set to @p item (and on errors)
9386 * @see elm_object_cursor_get()
9387 * @see elm_gengrid_item_cursor_set() for more details
9388 * @see elm_gengrid_item_cursor_unset()
9392 EAPI const char *elm_gengrid_item_cursor_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9395 * Unset any custom mouse pointer/cursor decoration set to be
9396 * shown, when the mouse pointer is over the given gengrid widget
9397 * item, thus making it show the @b default cursor again.
9399 * @param item a gengrid item
9401 * Use this call to undo any custom settings on this item's cursor
9402 * decoration, bringing it back to defaults (no custom style set).
9404 * @see elm_object_cursor_unset()
9405 * @see elm_gengrid_item_cursor_set() for more details
9409 EAPI void elm_gengrid_item_cursor_unset(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9412 * Set a different @b style for a given custom cursor set for a
9415 * @param item gengrid item with custom cursor set
9416 * @param style the <b>theme style</b> to use (e.g. @c "default",
9417 * @c "transparent", etc)
9419 * This function only makes sense when one is using custom mouse
9420 * cursor decorations <b>defined in a theme file</b> , which can
9421 * have, given a cursor name/type, <b>alternate styles</b> on
9422 * it. It works analogously as elm_object_cursor_style_set(), but
9423 * here applied only to gengrid item objects.
9425 * @warning Before you set a cursor style you should have defined a
9426 * custom cursor previously on the item, with
9427 * elm_gengrid_item_cursor_set()
9429 * @see elm_gengrid_item_cursor_engine_only_set()
9430 * @see elm_gengrid_item_cursor_style_get()
9434 EAPI void elm_gengrid_item_cursor_style_set(Elm_Gengrid_Item *item, const char *style) EINA_ARG_NONNULL(1);
9437 * Get the current @b style set for a given gengrid item's custom
9440 * @param item gengrid item with custom cursor set.
9441 * @return style the cursor style in use. If the object does not
9442 * have a cursor set, then @c NULL is returned.
9444 * @see elm_gengrid_item_cursor_style_set() for more details
9448 EAPI const char *elm_gengrid_item_cursor_style_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9451 * Set if the (custom) cursor for a given gengrid item should be
9452 * searched in its theme, also, or should only rely on the
9455 * @param item item with custom (custom) cursor already set on
9456 * @param engine_only Use @c EINA_TRUE to have cursors looked for
9457 * only on those provided by the rendering engine, @c EINA_FALSE to
9458 * have them searched on the widget's theme, as well.
9460 * @note This call is of use only if you've set a custom cursor
9461 * for gengrid items, with elm_gengrid_item_cursor_set().
9463 * @note By default, cursors will only be looked for between those
9464 * provided by the rendering engine.
9468 EAPI void elm_gengrid_item_cursor_engine_only_set(Elm_Gengrid_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
9471 * Get if the (custom) cursor for a given gengrid item is being
9472 * searched in its theme, also, or is only relying on the rendering
9475 * @param item a gengrid item
9476 * @return @c EINA_TRUE, if cursors are being looked for only on
9477 * those provided by the rendering engine, @c EINA_FALSE if they
9478 * are being searched on the widget's theme, as well.
9480 * @see elm_gengrid_item_cursor_engine_only_set(), for more details
9484 EAPI Eina_Bool elm_gengrid_item_cursor_engine_only_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9487 * Remove all items from a given gengrid widget
9489 * @param obj The gengrid object.
9491 * This removes (and deletes) all items in @p obj, leaving it
9494 * @see elm_gengrid_item_del(), to remove just one item.
9498 EAPI void elm_gengrid_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
9501 * Get the selected item in a given gengrid widget
9503 * @param obj The gengrid object.
9504 * @return The selected item's handleor @c NULL, if none is
9505 * selected at the moment (and on errors)
9507 * This returns the selected item in @p obj. If multi selection is
9508 * enabled on @p obj (@see elm_gengrid_multi_select_set()), only
9509 * the first item in the list is selected, which might not be very
9510 * useful. For that case, see elm_gengrid_selected_items_get().
9514 EAPI Elm_Gengrid_Item *elm_gengrid_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9517 * Get <b>a list</b> of selected items in a given gengrid
9519 * @param obj The gengrid object.
9520 * @return The list of selected items or @c NULL, if none is
9521 * selected at the moment (and on errors)
9523 * This returns a list of the selected items, in the order that
9524 * they appear in the grid. This list is only valid as long as no
9525 * more items are selected or unselected (or unselected implictly
9526 * by deletion). The list contains #Elm_Gengrid_Item pointers as
9529 * @see elm_gengrid_selected_item_get()
9533 EAPI const Eina_List *elm_gengrid_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9540 * @defgroup Clock Clock
9542 * @image html img/widget/clock/preview-00.png
9543 * @image latex img/widget/clock/preview-00.eps
9545 * This is a @b digital clock widget. In its default theme, it has a
9546 * vintage "flipping numbers clock" appearance, which will animate
9547 * sheets of individual algarisms individually as time goes by.
9549 * A newly created clock will fetch system's time (already
9550 * considering local time adjustments) to start with, and will tick
9551 * accondingly. It may or may not show seconds.
9553 * Clocks have an @b edition mode. When in it, the sheets will
9554 * display extra arrow indications on the top and bottom and the
9555 * user may click on them to raise or lower the time values. After
9556 * it's told to exit edition mode, it will keep ticking with that
9557 * new time set (it keeps the difference from local time).
9559 * Also, when under edition mode, user clicks on the cited arrows
9560 * which are @b held for some time will make the clock to flip the
9561 * sheet, thus editing the time, continuosly and automatically for
9562 * the user. The interval between sheet flips will keep growing in
9563 * time, so that it helps the user to reach a time which is distant
9566 * The time display is, by default, in military mode (24h), but an
9567 * am/pm indicator may be optionally shown, too, when it will
9570 * Smart callbacks one can register to:
9571 * - "changed" - the clock's user changed the time
9573 * Here is an example on its usage:
9574 * @li @ref clock_example
9583 * Identifiers for which clock digits should be editable, when a
9584 * clock widget is in edition mode. Values may be ORed together to
9585 * make a mask, naturally.
9587 * @see elm_clock_edit_set()
9588 * @see elm_clock_digit_edit_set()
9590 typedef enum _Elm_Clock_Digedit
9592 ELM_CLOCK_NONE = 0, /**< Default value. Means that all digits are editable, when in edition mode. */
9593 ELM_CLOCK_HOUR_DECIMAL = 1 << 0, /**< Decimal algarism of hours value should be editable */
9594 ELM_CLOCK_HOUR_UNIT = 1 << 1, /**< Unit algarism of hours value should be editable */
9595 ELM_CLOCK_MIN_DECIMAL = 1 << 2, /**< Decimal algarism of minutes value should be editable */
9596 ELM_CLOCK_MIN_UNIT = 1 << 3, /**< Unit algarism of minutes value should be editable */
9597 ELM_CLOCK_SEC_DECIMAL = 1 << 4, /**< Decimal algarism of seconds value should be editable */
9598 ELM_CLOCK_SEC_UNIT = 1 << 5, /**< Unit algarism of seconds value should be editable */
9599 ELM_CLOCK_ALL = (1 << 6) - 1 /**< All digits should be editable */
9600 } Elm_Clock_Digedit;
9603 * Add a new clock widget to the given parent Elementary
9604 * (container) object
9606 * @param parent The parent object
9607 * @return a new clock widget handle or @c NULL, on errors
9609 * This function inserts a new clock widget on the canvas.
9613 EAPI Evas_Object *elm_clock_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
9616 * Set a clock widget's time, programmatically
9618 * @param obj The clock widget object
9619 * @param hrs The hours to set
9620 * @param min The minutes to set
9621 * @param sec The secondes to set
9623 * This function updates the time that is showed by the clock
9626 * Values @b must be set within the following ranges:
9627 * - 0 - 23, for hours
9628 * - 0 - 59, for minutes
9629 * - 0 - 59, for seconds,
9631 * even if the clock is not in "military" mode.
9633 * @warning The behavior for values set out of those ranges is @b
9638 EAPI void elm_clock_time_set(Evas_Object *obj, int hrs, int min, int sec) EINA_ARG_NONNULL(1);
9641 * Get a clock widget's time values
9643 * @param obj The clock object
9644 * @param[out] hrs Pointer to the variable to get the hours value
9645 * @param[out] min Pointer to the variable to get the minutes value
9646 * @param[out] sec Pointer to the variable to get the seconds value
9648 * This function gets the time set for @p obj, returning
9649 * it on the variables passed as the arguments to function
9651 * @note Use @c NULL pointers on the time values you're not
9652 * interested in: they'll be ignored by the function.
9656 EAPI void elm_clock_time_get(const Evas_Object *obj, int *hrs, int *min, int *sec) EINA_ARG_NONNULL(1);
9659 * Set whether a given clock widget is under <b>edition mode</b> or
9660 * under (default) displaying-only mode.
9662 * @param obj The clock object
9663 * @param edit @c EINA_TRUE to put it in edition, @c EINA_FALSE to
9664 * put it back to "displaying only" mode
9666 * This function makes a clock's time to be editable or not <b>by
9667 * user interaction</b>. When in edition mode, clocks @b stop
9668 * ticking, until one brings them back to canonical mode. The
9669 * elm_clock_digit_edit_set() function will influence which digits
9670 * of the clock will be editable. By default, all of them will be
9671 * (#ELM_CLOCK_NONE).
9673 * @note am/pm sheets, if being shown, will @b always be editable
9674 * under edition mode.
9676 * @see elm_clock_edit_get()
9680 EAPI void elm_clock_edit_set(Evas_Object *obj, Eina_Bool edit) EINA_ARG_NONNULL(1);
9683 * Retrieve whether a given clock widget is under <b>edition
9684 * mode</b> or under (default) displaying-only mode.
9686 * @param obj The clock object
9687 * @param edit @c EINA_TRUE, if it's in edition mode, @c EINA_FALSE
9690 * This function retrieves whether the clock's time can be edited
9691 * or not by user interaction.
9693 * @see elm_clock_edit_set() for more details
9697 EAPI Eina_Bool elm_clock_edit_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9700 * Set what digits of the given clock widget should be editable
9701 * when in edition mode.
9703 * @param obj The clock object
9704 * @param digedit Bit mask indicating the digits to be editable
9705 * (values in #Elm_Clock_Digedit).
9707 * If the @p digedit param is #ELM_CLOCK_NONE, editing will be
9708 * disabled on @p obj (same effect as elm_clock_edit_set(), with @c
9711 * @see elm_clock_digit_edit_get()
9715 EAPI void elm_clock_digit_edit_set(Evas_Object *obj, Elm_Clock_Digedit digedit) EINA_ARG_NONNULL(1);
9718 * Retrieve what digits of the given clock widget should be
9719 * editable when in edition mode.
9721 * @param obj The clock object
9722 * @return Bit mask indicating the digits to be editable
9723 * (values in #Elm_Clock_Digedit).
9725 * @see elm_clock_digit_edit_set() for more details
9729 EAPI Elm_Clock_Digedit elm_clock_digit_edit_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9732 * Set if the given clock widget must show hours in military or
9735 * @param obj The clock object
9736 * @param am_pm @c EINA_TRUE to put it in am/pm mode, @c EINA_FALSE
9739 * This function sets if the clock must show hours in military or
9740 * am/pm mode. In some countries like Brazil the military mode
9741 * (00-24h-format) is used, in opposition to the USA, where the
9742 * am/pm mode is more commonly used.
9744 * @see elm_clock_show_am_pm_get()
9748 EAPI void elm_clock_show_am_pm_set(Evas_Object *obj, Eina_Bool am_pm) EINA_ARG_NONNULL(1);
9751 * Get if the given clock widget shows hours in military or am/pm
9754 * @param obj The clock object
9755 * @return @c EINA_TRUE, if in am/pm mode, @c EINA_FALSE if in
9758 * This function gets if the clock shows hours in military or am/pm
9761 * @see elm_clock_show_am_pm_set() for more details
9765 EAPI Eina_Bool elm_clock_show_am_pm_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9768 * Set if the given clock widget must show time with seconds or not
9770 * @param obj The clock object
9771 * @param seconds @c EINA_TRUE to show seconds, @c EINA_FALSE otherwise
9773 * This function sets if the given clock must show or not elapsed
9774 * seconds. By default, they are @b not shown.
9776 * @see elm_clock_show_seconds_get()
9780 EAPI void elm_clock_show_seconds_set(Evas_Object *obj, Eina_Bool seconds) EINA_ARG_NONNULL(1);
9783 * Get whether the given clock widget is showing time with seconds
9786 * @param obj The clock object
9787 * @return @c EINA_TRUE if it's showing seconds, @c EINA_FALSE otherwise
9789 * This function gets whether @p obj is showing or not the elapsed
9792 * @see elm_clock_show_seconds_set()
9796 EAPI Eina_Bool elm_clock_show_seconds_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9799 * Set the interval on time updates for an user mouse button hold
9800 * on clock widgets' time edition.
9802 * @param obj The clock object
9803 * @param interval The (first) interval value in seconds
9805 * This interval value is @b decreased while the user holds the
9806 * mouse pointer either incrementing or decrementing a given the
9807 * clock digit's value.
9809 * This helps the user to get to a given time distant from the
9810 * current one easier/faster, as it will start to flip quicker and
9811 * quicker on mouse button holds.
9813 * The calculation for the next flip interval value, starting from
9814 * the one set with this call, is the previous interval divided by
9815 * 1.05, so it decreases a little bit.
9817 * The default starting interval value for automatic flips is
9820 * @see elm_clock_interval_get()
9824 EAPI void elm_clock_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
9827 * Get the interval on time updates for an user mouse button hold
9828 * on clock widgets' time edition.
9830 * @param obj The clock object
9831 * @return The (first) interval value, in seconds, set on it
9833 * @see elm_clock_interval_set() for more details
9837 EAPI double elm_clock_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9844 * @defgroup Layout Layout
9846 * @image html img/widget/layout/preview-00.png
9847 * @image latex img/widget/layout/preview-00.eps width=\textwidth
9849 * @image html img/layout-predefined.png
9850 * @image latex img/layout-predefined.eps width=\textwidth
9852 * This is a container widget that takes a standard Edje design file and
9853 * wraps it very thinly in a widget.
9855 * An Edje design (theme) file has a very wide range of possibilities to
9856 * describe the behavior of elements added to the Layout. Check out the Edje
9857 * documentation and the EDC reference to get more information about what can
9858 * be done with Edje.
9860 * Just like @ref List, @ref Box, and other container widgets, any
9861 * object added to the Layout will become its child, meaning that it will be
9862 * deleted if the Layout is deleted, move if the Layout is moved, and so on.
9864 * The Layout widget can contain as many Contents, Boxes or Tables as
9865 * described in its theme file. For instance, objects can be added to
9866 * different Tables by specifying the respective Table part names. The same
9867 * is valid for Content and Box.
9869 * The objects added as child of the Layout will behave as described in the
9870 * part description where they were added. There are 3 possible types of
9871 * parts where a child can be added:
9873 * @section secContent Content (SWALLOW part)
9875 * Only one object can be added to the @c SWALLOW part (but you still can
9876 * have many @c SWALLOW parts and one object on each of them). Use the @c
9877 * elm_object_content_set/get/unset functions to set, retrieve and unset
9878 * objects as content of the @c SWALLOW. After being set to this part, the
9879 * object size, position, visibility, clipping and other description
9880 * properties will be totally controlled by the description of the given part
9881 * (inside the Edje theme file).
9883 * One can use @c evas_object_size_hint_* functions on the child to have some
9884 * kind of control over its behavior, but the resulting behavior will still
9885 * depend heavily on the @c SWALLOW part description.
9887 * The Edje theme also can change the part description, based on signals or
9888 * scripts running inside the theme. This change can also be animated. All of
9889 * this will affect the child object set as content accordingly. The object
9890 * size will be changed if the part size is changed, it will animate move if
9891 * the part is moving, and so on.
9893 * The following picture demonstrates a Layout widget with a child object
9894 * added to its @c SWALLOW:
9896 * @image html layout_swallow.png
9897 * @image latex layout_swallow.eps width=\textwidth
9899 * @section secBox Box (BOX part)
9901 * An Edje @c BOX part is very similar to the Elementary @ref Box widget. It
9902 * allows one to add objects to the box and have them distributed along its
9903 * area, accordingly to the specified @a layout property (now by @a layout we
9904 * mean the chosen layouting design of the Box, not the Layout widget
9907 * A similar effect for having a box with its position, size and other things
9908 * controlled by the Layout theme would be to create an Elementary @ref Box
9909 * widget and add it as a Content in the @c SWALLOW part.
9911 * The main difference of using the Layout Box is that its behavior, the box
9912 * properties like layouting format, padding, align, etc. will be all
9913 * controlled by the theme. This means, for example, that a signal could be
9914 * sent to the Layout theme (with elm_object_signal_emit()) and the theme
9915 * handled the signal by changing the box padding, or align, or both. Using
9916 * the Elementary @ref Box widget is not necessarily harder or easier, it
9917 * just depends on the circunstances and requirements.
9919 * The Layout Box can be used through the @c elm_layout_box_* set of
9922 * The following picture demonstrates a Layout widget with many child objects
9923 * added to its @c BOX part:
9925 * @image html layout_box.png
9926 * @image latex layout_box.eps width=\textwidth
9928 * @section secTable Table (TABLE part)
9930 * Just like the @ref secBox, the Layout Table is very similar to the
9931 * Elementary @ref Table widget. It allows one to add objects to the Table
9932 * specifying the row and column where the object should be added, and any
9933 * column or row span if necessary.
9935 * Again, we could have this design by adding a @ref Table widget to the @c
9936 * SWALLOW part using elm_object_part_content_set(). The same difference happens
9937 * here when choosing to use the Layout Table (a @c TABLE part) instead of
9938 * the @ref Table plus @c SWALLOW part. It's just a matter of convenience.
9940 * The Layout Table can be used through the @c elm_layout_table_* set of
9943 * The following picture demonstrates a Layout widget with many child objects
9944 * added to its @c TABLE part:
9946 * @image html layout_table.png
9947 * @image latex layout_table.eps width=\textwidth
9949 * @section secPredef Predefined Layouts
9951 * Another interesting thing about the Layout widget is that it offers some
9952 * predefined themes that come with the default Elementary theme. These
9953 * themes can be set by the call elm_layout_theme_set(), and provide some
9954 * basic functionality depending on the theme used.
9956 * Most of them already send some signals, some already provide a toolbar or
9957 * back and next buttons.
9959 * These are available predefined theme layouts. All of them have class = @c
9960 * layout, group = @c application, and style = one of the following options:
9962 * @li @c toolbar-content - application with toolbar and main content area
9963 * @li @c toolbar-content-back - application with toolbar and main content
9964 * area with a back button and title area
9965 * @li @c toolbar-content-back-next - application with toolbar and main
9966 * content area with a back and next buttons and title area
9967 * @li @c content-back - application with a main content area with a back
9968 * button and title area
9969 * @li @c content-back-next - application with a main content area with a
9970 * back and next buttons and title area
9971 * @li @c toolbar-vbox - application with toolbar and main content area as a
9973 * @li @c toolbar-table - application with toolbar and main content area as a
9976 * @section secExamples Examples
9978 * Some examples of the Layout widget can be found here:
9979 * @li @ref layout_example_01
9980 * @li @ref layout_example_02
9981 * @li @ref layout_example_03
9982 * @li @ref layout_example_edc
9987 * Add a new layout to the parent
9989 * @param parent The parent object
9990 * @return The new object or NULL if it cannot be created
9992 * @see elm_layout_file_set()
9993 * @see elm_layout_theme_set()
9997 EAPI Evas_Object *elm_layout_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
9999 * Set the file that will be used as layout
10001 * @param obj The layout object
10002 * @param file The path to file (edj) that will be used as layout
10003 * @param group The group that the layout belongs in edje file
10005 * @return (1 = success, 0 = error)
10009 EAPI Eina_Bool elm_layout_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1);
10011 * Set the edje group from the elementary theme that will be used as layout
10013 * @param obj The layout object
10014 * @param clas the clas of the group
10015 * @param group the group
10016 * @param style the style to used
10018 * @return (1 = success, 0 = error)
10022 EAPI Eina_Bool elm_layout_theme_set(Evas_Object *obj, const char *clas, const char *group, const char *style) EINA_ARG_NONNULL(1);
10024 * Set the layout content.
10026 * @param obj The layout object
10027 * @param swallow The swallow part name in the edje file
10028 * @param content The child that will be added in this layout object
10030 * Once the content object is set, a previously set one will be deleted.
10031 * If you want to keep that old content object, use the
10032 * elm_object_part_content_unset() function.
10034 * @note In an Edje theme, the part used as a content container is called @c
10035 * SWALLOW. This is why the parameter name is called @p swallow, but it is
10036 * expected to be a part name just like the second parameter of
10037 * elm_layout_box_append().
10039 * @see elm_layout_box_append()
10040 * @see elm_object_part_content_get()
10041 * @see elm_object_part_content_unset()
10043 * @deprecated use elm_object_part_content_set() instead
10047 EINA_DEPRECATED EAPI void elm_layout_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content) EINA_ARG_NONNULL(1);
10049 * Get the child object in the given content part.
10051 * @param obj The layout object
10052 * @param swallow The SWALLOW part to get its content
10054 * @return The swallowed object or NULL if none or an error occurred
10056 * @deprecated use elm_object_part_content_get() instead
10060 EINA_DEPRECATED EAPI Evas_Object *elm_layout_content_get(const Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
10062 * Unset the layout content.
10064 * @param obj The layout object
10065 * @param swallow The swallow part name in the edje file
10066 * @return The content that was being used
10068 * Unparent and return the content object which was set for this part.
10070 * @deprecated use elm_object_part_content_unset() instead
10074 EINA_DEPRECATED EAPI Evas_Object *elm_layout_content_unset(Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
10076 * Set the text of the given part
10078 * @param obj The layout object
10079 * @param part The TEXT part where to set the text
10080 * @param text The text to set
10083 * @deprecated use elm_object_part_text_set() instead.
10085 EINA_DEPRECATED EAPI void elm_layout_text_set(Evas_Object *obj, const char *part, const char *text) EINA_ARG_NONNULL(1);
10087 * Get the text set in the given part
10089 * @param obj The layout object
10090 * @param part The TEXT part to retrieve the text off
10092 * @return The text set in @p part
10095 * @deprecated use elm_object_part_text_get() instead.
10097 EINA_DEPRECATED EAPI const char *elm_layout_text_get(const Evas_Object *obj, const char *part) EINA_ARG_NONNULL(1);
10099 * Append child to layout box part.
10101 * @param obj the layout object
10102 * @param part the box part to which the object will be appended.
10103 * @param child the child object to append to box.
10105 * Once the object is appended, it will become child of the layout. Its
10106 * lifetime will be bound to the layout, whenever the layout dies the child
10107 * will be deleted automatically. One should use elm_layout_box_remove() to
10108 * make this layout forget about the object.
10110 * @see elm_layout_box_prepend()
10111 * @see elm_layout_box_insert_before()
10112 * @see elm_layout_box_insert_at()
10113 * @see elm_layout_box_remove()
10117 EAPI void elm_layout_box_append(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1);
10119 * Prepend child to layout box part.
10121 * @param obj the layout object
10122 * @param part the box part to prepend.
10123 * @param child the child object to prepend to box.
10125 * Once the object is prepended, it will become child of the layout. Its
10126 * lifetime will be bound to the layout, whenever the layout dies the child
10127 * will be deleted automatically. One should use elm_layout_box_remove() to
10128 * make this layout forget about the object.
10130 * @see elm_layout_box_append()
10131 * @see elm_layout_box_insert_before()
10132 * @see elm_layout_box_insert_at()
10133 * @see elm_layout_box_remove()
10137 EAPI void elm_layout_box_prepend(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1);
10139 * Insert child to layout box part before a reference object.
10141 * @param obj the layout object
10142 * @param part the box part to insert.
10143 * @param child the child object to insert into box.
10144 * @param reference another reference object to insert before in box.
10146 * Once the object is inserted, it will become child of the layout. Its
10147 * lifetime will be bound to the layout, whenever the layout dies the child
10148 * will be deleted automatically. One should use elm_layout_box_remove() to
10149 * make this layout forget about the object.
10151 * @see elm_layout_box_append()
10152 * @see elm_layout_box_prepend()
10153 * @see elm_layout_box_insert_before()
10154 * @see elm_layout_box_remove()
10158 EAPI void elm_layout_box_insert_before(Evas_Object *obj, const char *part, Evas_Object *child, const Evas_Object *reference) EINA_ARG_NONNULL(1);
10160 * Insert child to layout box part at a given position.
10162 * @param obj the layout object
10163 * @param part the box part to insert.
10164 * @param child the child object to insert into box.
10165 * @param pos the numeric position >=0 to insert the child.
10167 * Once the object is inserted, it will become child of the layout. Its
10168 * lifetime will be bound to the layout, whenever the layout dies the child
10169 * will be deleted automatically. One should use elm_layout_box_remove() to
10170 * make this layout forget about the object.
10172 * @see elm_layout_box_append()
10173 * @see elm_layout_box_prepend()
10174 * @see elm_layout_box_insert_before()
10175 * @see elm_layout_box_remove()
10179 EAPI void elm_layout_box_insert_at(Evas_Object *obj, const char *part, Evas_Object *child, unsigned int pos) EINA_ARG_NONNULL(1);
10181 * Remove a child of the given part box.
10183 * @param obj The layout object
10184 * @param part The box part name to remove child.
10185 * @param child The object to remove from box.
10186 * @return The object that was being used, or NULL if not found.
10188 * The object will be removed from the box part and its lifetime will
10189 * not be handled by the layout anymore. This is equivalent to
10190 * elm_object_part_content_unset() for box.
10192 * @see elm_layout_box_append()
10193 * @see elm_layout_box_remove_all()
10197 EAPI Evas_Object *elm_layout_box_remove(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1, 2, 3);
10199 * Remove all children of the given part box.
10201 * @param obj The layout object
10202 * @param part The box part name to remove child.
10203 * @param clear If EINA_TRUE, then all objects will be deleted as
10204 * well, otherwise they will just be removed and will be
10205 * dangling on the canvas.
10207 * The objects will be removed from the box part and their lifetime will
10208 * not be handled by the layout anymore. This is equivalent to
10209 * elm_layout_box_remove() for all box children.
10211 * @see elm_layout_box_append()
10212 * @see elm_layout_box_remove()
10216 EAPI void elm_layout_box_remove_all(Evas_Object *obj, const char *part, Eina_Bool clear) EINA_ARG_NONNULL(1, 2);
10218 * Insert child to layout table part.
10220 * @param obj the layout object
10221 * @param part the box part to pack child.
10222 * @param child_obj the child object to pack into table.
10223 * @param col the column to which the child should be added. (>= 0)
10224 * @param row the row to which the child should be added. (>= 0)
10225 * @param colspan how many columns should be used to store this object. (>=
10227 * @param rowspan how many rows should be used to store this object. (>= 1)
10229 * Once the object is inserted, it will become child of the table. Its
10230 * lifetime will be bound to the layout, and whenever the layout dies the
10231 * child will be deleted automatically. One should use
10232 * elm_layout_table_remove() to make this layout forget about the object.
10234 * If @p colspan or @p rowspan are bigger than 1, that object will occupy
10235 * more space than a single cell. For instance, the following code:
10237 * elm_layout_table_pack(layout, "table_part", child, 0, 1, 3, 1);
10240 * Would result in an object being added like the following picture:
10242 * @image html layout_colspan.png
10243 * @image latex layout_colspan.eps width=\textwidth
10245 * @see elm_layout_table_unpack()
10246 * @see elm_layout_table_clear()
10250 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);
10252 * Unpack (remove) a child of the given part table.
10254 * @param obj The layout object
10255 * @param part The table part name to remove child.
10256 * @param child_obj The object to remove from table.
10257 * @return The object that was being used, or NULL if not found.
10259 * The object will be unpacked from the table part and its lifetime
10260 * will not be handled by the layout anymore. This is equivalent to
10261 * elm_object_part_content_unset() for table.
10263 * @see elm_layout_table_pack()
10264 * @see elm_layout_table_clear()
10268 EAPI Evas_Object *elm_layout_table_unpack(Evas_Object *obj, const char *part, Evas_Object *child_obj) EINA_ARG_NONNULL(1, 2, 3);
10270 * Remove all the child objects of the given part table.
10272 * @param obj The layout object
10273 * @param part The table part name to remove child.
10274 * @param clear If EINA_TRUE, then all objects will be deleted as
10275 * well, otherwise they will just be removed and will be
10276 * dangling on the canvas.
10278 * The objects will be removed from the table part and their lifetime will
10279 * not be handled by the layout anymore. This is equivalent to
10280 * elm_layout_table_unpack() for all table children.
10282 * @see elm_layout_table_pack()
10283 * @see elm_layout_table_unpack()
10287 EAPI void elm_layout_table_clear(Evas_Object *obj, const char *part, Eina_Bool clear) EINA_ARG_NONNULL(1, 2);
10289 * Get the edje layout
10291 * @param obj The layout object
10293 * @return A Evas_Object with the edje layout settings loaded
10294 * with function elm_layout_file_set
10296 * This returns the edje object. It is not expected to be used to then
10297 * swallow objects via edje_object_part_swallow() for example. Use
10298 * elm_object_part_content_set() instead so child object handling and sizing is
10301 * @note This function should only be used if you really need to call some
10302 * low level Edje function on this edje object. All the common stuff (setting
10303 * text, emitting signals, hooking callbacks to signals, etc.) can be done
10304 * with proper elementary functions.
10306 * @see elm_object_signal_callback_add()
10307 * @see elm_object_signal_emit()
10308 * @see elm_object_part_text_set()
10309 * @see elm_object_part_content_set()
10310 * @see elm_layout_box_append()
10311 * @see elm_layout_table_pack()
10312 * @see elm_layout_data_get()
10316 EAPI Evas_Object *elm_layout_edje_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10318 * Get the edje data from the given layout
10320 * @param obj The layout object
10321 * @param key The data key
10323 * @return The edje data string
10325 * This function fetches data specified inside the edje theme of this layout.
10326 * This function return NULL if data is not found.
10328 * In EDC this comes from a data block within the group block that @p
10329 * obj was loaded from. E.g.
10336 * item: "key1" "value1";
10337 * item: "key2" "value2";
10345 EAPI const char *elm_layout_data_get(const Evas_Object *obj, const char *key) EINA_ARG_NONNULL(1, 2);
10349 * @param obj The layout object
10351 * Manually forces a sizing re-evaluation. This is useful when the minimum
10352 * size required by the edje theme of this layout has changed. The change on
10353 * the minimum size required by the edje theme is not immediately reported to
10354 * the elementary layout, so one needs to call this function in order to tell
10355 * the widget (layout) that it needs to reevaluate its own size.
10357 * The minimum size of the theme is calculated based on minimum size of
10358 * parts, the size of elements inside containers like box and table, etc. All
10359 * of this can change due to state changes, and that's when this function
10360 * should be called.
10362 * Also note that a standard signal of "size,eval" "elm" emitted from the
10363 * edje object will cause this to happen too.
10367 EAPI void elm_layout_sizing_eval(Evas_Object *obj) EINA_ARG_NONNULL(1);
10370 * Sets a specific cursor for an edje part.
10372 * @param obj The layout object.
10373 * @param part_name a part from loaded edje group.
10374 * @param cursor cursor name to use, see Elementary_Cursor.h
10376 * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
10377 * part not exists or it has "mouse_events: 0".
10381 EAPI Eina_Bool elm_layout_part_cursor_set(Evas_Object *obj, const char *part_name, const char *cursor) EINA_ARG_NONNULL(1, 2);
10384 * Get the cursor to be shown when mouse is over an edje part
10386 * @param obj The layout object.
10387 * @param part_name a part from loaded edje group.
10388 * @return the cursor name.
10392 EAPI const char *elm_layout_part_cursor_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
10395 * Unsets a cursor previously set with elm_layout_part_cursor_set().
10397 * @param obj The layout object.
10398 * @param part_name a part from loaded edje group, that had a cursor set
10399 * with elm_layout_part_cursor_set().
10403 EAPI void elm_layout_part_cursor_unset(Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
10406 * Sets a specific cursor style for an edje part.
10408 * @param obj The layout object.
10409 * @param part_name a part from loaded edje group.
10410 * @param style the theme style to use (default, transparent, ...)
10412 * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
10413 * part not exists or it did not had a cursor set.
10417 EAPI Eina_Bool elm_layout_part_cursor_style_set(Evas_Object *obj, const char *part_name, const char *style) EINA_ARG_NONNULL(1, 2);
10420 * Gets a specific cursor style for an edje part.
10422 * @param obj The layout object.
10423 * @param part_name a part from loaded edje group.
10425 * @return the theme style in use, defaults to "default". If the
10426 * object does not have a cursor set, then NULL is returned.
10430 EAPI const char *elm_layout_part_cursor_style_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
10433 * Sets if the cursor set should be searched on the theme or should use
10434 * the provided by the engine, only.
10436 * @note before you set if should look on theme you should define a
10437 * cursor with elm_layout_part_cursor_set(). By default it will only
10438 * look for cursors provided by the engine.
10440 * @param obj The layout object.
10441 * @param part_name a part from loaded edje group.
10442 * @param engine_only if cursors should be just provided by the engine (EINA_TRUE)
10443 * or should also search on widget's theme as well (EINA_FALSE)
10445 * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
10446 * part not exists or it did not had a cursor set.
10450 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);
10453 * Gets a specific cursor engine_only for an edje part.
10455 * @param obj The layout object.
10456 * @param part_name a part from loaded edje group.
10458 * @return whenever the cursor is just provided by engine or also from theme.
10462 EAPI Eina_Bool elm_layout_part_cursor_engine_only_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
10465 * @def elm_layout_icon_set
10466 * Convenience macro to set the icon object in a layout that follows the
10467 * Elementary naming convention for its parts.
10471 #define elm_layout_icon_set(_ly, _obj) \
10474 elm_object_part_content_set((_ly), "elm.swallow.icon", (_obj)); \
10475 if ((_obj)) sig = "elm,state,icon,visible"; \
10476 else sig = "elm,state,icon,hidden"; \
10477 elm_object_signal_emit((_ly), sig, "elm"); \
10481 * @def elm_layout_icon_get
10482 * Convienience macro to get the icon object from a layout that follows the
10483 * Elementary naming convention for its parts.
10487 #define elm_layout_icon_get(_ly) \
10488 elm_object_part_content_get((_ly), "elm.swallow.icon")
10491 * @def elm_layout_end_set
10492 * Convienience macro to set the end object in a layout that follows the
10493 * Elementary naming convention for its parts.
10497 #define elm_layout_end_set(_ly, _obj) \
10500 elm_object_part_content_set((_ly), "elm.swallow.end", (_obj)); \
10501 if ((_obj)) sig = "elm,state,end,visible"; \
10502 else sig = "elm,state,end,hidden"; \
10503 elm_object_signal_emit((_ly), sig, "elm"); \
10507 * @def elm_layout_end_get
10508 * Convienience macro to get the end object in a layout that follows the
10509 * Elementary naming convention for its parts.
10513 #define elm_layout_end_get(_ly) \
10514 elm_object_part_content_get((_ly), "elm.swallow.end")
10517 * @def elm_layout_label_set
10518 * Convienience macro to set the label in a layout that follows the
10519 * Elementary naming convention for its parts.
10522 * @deprecated use elm_object_text_set() instead.
10524 #define elm_layout_label_set(_ly, _txt) \
10525 elm_layout_text_set((_ly), "elm.text", (_txt))
10528 * @def elm_layout_label_get
10529 * Convenience macro to get the label in a layout that follows the
10530 * Elementary naming convention for its parts.
10533 * @deprecated use elm_object_text_set() instead.
10535 #define elm_layout_label_get(_ly) \
10536 elm_layout_text_get((_ly), "elm.text")
10538 /* smart callbacks called:
10539 * "theme,changed" - when elm theme is changed.
10543 * @defgroup Notify Notify
10545 * @image html img/widget/notify/preview-00.png
10546 * @image latex img/widget/notify/preview-00.eps
10548 * Display a container in a particular region of the parent(top, bottom,
10549 * etc). A timeout can be set to automatically hide the notify. This is so
10550 * that, after an evas_object_show() on a notify object, if a timeout was set
10551 * on it, it will @b automatically get hidden after that time.
10553 * Signals that you can add callbacks for are:
10554 * @li "timeout" - when timeout happens on notify and it's hidden
10555 * @li "block,clicked" - when a click outside of the notify happens
10557 * Default contents parts of the notify widget that you can use for are:
10558 * @li "default" - A content of the notify
10560 * @ref tutorial_notify show usage of the API.
10565 * @brief Possible orient values for notify.
10567 * This values should be used in conjunction to elm_notify_orient_set() to
10568 * set the position in which the notify should appear(relative to its parent)
10569 * and in conjunction with elm_notify_orient_get() to know where the notify
10572 typedef enum _Elm_Notify_Orient
10574 ELM_NOTIFY_ORIENT_TOP, /**< Notify should appear in the top of parent, default */
10575 ELM_NOTIFY_ORIENT_CENTER, /**< Notify should appear in the center of parent */
10576 ELM_NOTIFY_ORIENT_BOTTOM, /**< Notify should appear in the bottom of parent */
10577 ELM_NOTIFY_ORIENT_LEFT, /**< Notify should appear in the left of parent */
10578 ELM_NOTIFY_ORIENT_RIGHT, /**< Notify should appear in the right of parent */
10579 ELM_NOTIFY_ORIENT_TOP_LEFT, /**< Notify should appear in the top left of parent */
10580 ELM_NOTIFY_ORIENT_TOP_RIGHT, /**< Notify should appear in the top right of parent */
10581 ELM_NOTIFY_ORIENT_BOTTOM_LEFT, /**< Notify should appear in the bottom left of parent */
10582 ELM_NOTIFY_ORIENT_BOTTOM_RIGHT, /**< Notify should appear in the bottom right of parent */
10583 ELM_NOTIFY_ORIENT_LAST /**< Sentinel value, @b don't use */
10584 } Elm_Notify_Orient;
10586 * @brief Add a new notify to the parent
10588 * @param parent The parent object
10589 * @return The new object or NULL if it cannot be created
10591 EAPI Evas_Object *elm_notify_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10593 * @brief Set the content of the notify widget
10595 * @param obj The notify object
10596 * @param content The content will be filled in this notify object
10598 * Once the content object is set, a previously set one will be deleted. If
10599 * you want to keep that old content object, use the
10600 * elm_notify_content_unset() function.
10602 * @deprecated use elm_object_content_set() instead
10605 EINA_DEPRECATED EAPI void elm_notify_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
10607 * @brief Unset the content of the notify widget
10609 * @param obj The notify object
10610 * @return The content that was being used
10612 * Unparent and return the content object which was set for this widget
10614 * @see elm_notify_content_set()
10615 * @deprecated use elm_object_content_unset() instead
10618 EINA_DEPRECATED EAPI Evas_Object *elm_notify_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
10620 * @brief Return the content of the notify widget
10622 * @param obj The notify object
10623 * @return The content that is being used
10625 * @see elm_notify_content_set()
10626 * @deprecated use elm_object_content_get() instead
10629 EINA_DEPRECATED EAPI Evas_Object *elm_notify_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10631 * @brief Set the notify parent
10633 * @param obj The notify object
10634 * @param content The new parent
10636 * Once the parent object is set, a previously set one will be disconnected
10639 EAPI void elm_notify_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
10641 * @brief Get the notify parent
10643 * @param obj The notify object
10644 * @return The parent
10646 * @see elm_notify_parent_set()
10648 EAPI Evas_Object *elm_notify_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10650 * @brief Set the orientation
10652 * @param obj The notify object
10653 * @param orient The new orientation
10655 * Sets the position in which the notify will appear in its parent.
10657 * @see @ref Elm_Notify_Orient for possible values.
10659 EAPI void elm_notify_orient_set(Evas_Object *obj, Elm_Notify_Orient orient) EINA_ARG_NONNULL(1);
10661 * @brief Return the orientation
10662 * @param obj The notify object
10663 * @return The orientation of the notification
10665 * @see elm_notify_orient_set()
10666 * @see Elm_Notify_Orient
10668 EAPI Elm_Notify_Orient elm_notify_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10670 * @brief Set the time interval after which the notify window is going to be
10673 * @param obj The notify object
10674 * @param time The timeout in seconds
10676 * This function sets a timeout and starts the timer controlling when the
10677 * notify is hidden. Since calling evas_object_show() on a notify restarts
10678 * the timer controlling when the notify is hidden, setting this before the
10679 * notify is shown will in effect mean starting the timer when the notify is
10682 * @note Set a value <= 0.0 to disable a running timer.
10684 * @note If the value > 0.0 and the notify is previously visible, the
10685 * timer will be started with this value, canceling any running timer.
10687 EAPI void elm_notify_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
10689 * @brief Return the timeout value (in seconds)
10690 * @param obj the notify object
10692 * @see elm_notify_timeout_set()
10694 EAPI double elm_notify_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10696 * @brief Sets whether events should be passed to by a click outside
10699 * @param obj The notify object
10700 * @param repeats EINA_TRUE Events are repeats, else no
10702 * When true if the user clicks outside the window the events will be caught
10703 * by the others widgets, else the events are blocked.
10705 * @note The default value is EINA_TRUE.
10707 EAPI void elm_notify_repeat_events_set(Evas_Object *obj, Eina_Bool repeat) EINA_ARG_NONNULL(1);
10709 * @brief Return true if events are repeat below the notify object
10710 * @param obj the notify object
10712 * @see elm_notify_repeat_events_set()
10714 EAPI Eina_Bool elm_notify_repeat_events_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10720 * @defgroup Hover Hover
10722 * @image html img/widget/hover/preview-00.png
10723 * @image latex img/widget/hover/preview-00.eps
10725 * A Hover object will hover over its @p parent object at the @p target
10726 * location. Anything in the background will be given a darker coloring to
10727 * indicate that the hover object is on top (at the default theme). When the
10728 * hover is clicked it is dismissed(hidden), if the contents of the hover are
10729 * clicked that @b doesn't cause the hover to be dismissed.
10731 * A Hover object has two parents. One parent that owns it during creation
10732 * and the other parent being the one over which the hover object spans.
10735 * @note The hover object will take up the entire space of @p target
10738 * Elementary has the following styles for the hover widget:
10742 * @li hoversel_vertical
10744 * The following are the available position for content:
10756 * Signals that you can add callbacks for are:
10757 * @li "clicked" - the user clicked the empty space in the hover to dismiss
10758 * @li "smart,changed" - a content object placed under the "smart"
10759 * policy was replaced to a new slot direction.
10761 * See @ref tutorial_hover for more information.
10765 typedef enum _Elm_Hover_Axis
10767 ELM_HOVER_AXIS_NONE, /**< ELM_HOVER_AXIS_NONE -- no prefered orientation */
10768 ELM_HOVER_AXIS_HORIZONTAL, /**< ELM_HOVER_AXIS_HORIZONTAL -- horizontal */
10769 ELM_HOVER_AXIS_VERTICAL, /**< ELM_HOVER_AXIS_VERTICAL -- vertical */
10770 ELM_HOVER_AXIS_BOTH /**< ELM_HOVER_AXIS_BOTH -- both */
10773 * @brief Adds a hover object to @p parent
10775 * @param parent The parent object
10776 * @return The hover object or NULL if one could not be created
10778 EAPI Evas_Object *elm_hover_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10780 * @brief Sets the target object for the hover.
10782 * @param obj The hover object
10783 * @param target The object to center the hover onto.
10785 * This function will cause the hover to be centered on the target object.
10787 EAPI void elm_hover_target_set(Evas_Object *obj, Evas_Object *target) EINA_ARG_NONNULL(1);
10789 * @brief Gets the target object for the hover.
10791 * @param obj The hover object
10792 * @return The target object for the hover.
10794 * @see elm_hover_target_set()
10796 EAPI Evas_Object *elm_hover_target_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10798 * @brief Sets the parent object for the hover.
10800 * @param obj The hover object
10801 * @param parent The object to locate the hover over.
10803 * This function will cause the hover to take up the entire space that the
10804 * parent object fills.
10806 EAPI void elm_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
10808 * @brief Gets the parent object for the hover.
10810 * @param obj The hover object
10811 * @return The parent object to locate the hover over.
10813 * @see elm_hover_parent_set()
10815 EAPI Evas_Object *elm_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10817 * @brief Sets the content of the hover object and the direction in which it
10820 * @param obj The hover object
10821 * @param swallow The direction that the object will be displayed
10822 * at. Accepted values are "left", "top-left", "top", "top-right",
10823 * "right", "bottom-right", "bottom", "bottom-left", "middle" and
10825 * @param content The content to place at @p swallow
10827 * Once the content object is set for a given direction, a previously
10828 * set one (on the same direction) will be deleted. If you want to
10829 * keep that old content object, use the elm_hover_content_unset()
10832 * All directions may have contents at the same time, except for
10833 * "smart". This is a special placement hint and its use case
10834 * independs of the calculations coming from
10835 * elm_hover_best_content_location_get(). Its use is for cases when
10836 * one desires only one hover content, but with a dynamic special
10837 * placement within the hover area. The content's geometry, whenever
10838 * it changes, will be used to decide on a best location, not
10839 * extrapolating the hover's parent object view to show it in (still
10840 * being the hover's target determinant of its medium part -- move and
10841 * resize it to simulate finger sizes, for example). If one of the
10842 * directions other than "smart" are used, a previously content set
10843 * using it will be deleted, and vice-versa.
10845 EAPI void elm_hover_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content) EINA_ARG_NONNULL(1);
10847 * @brief Get the content of the hover object, in a given direction.
10849 * Return the content object which was set for this widget in the
10850 * @p swallow direction.
10852 * @param obj The hover object
10853 * @param swallow The direction that the object was display at.
10854 * @return The content that was being used
10856 * @see elm_hover_content_set()
10858 EAPI Evas_Object *elm_hover_content_get(const Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
10860 * @brief Unset the content of the hover object, in a given direction.
10862 * Unparent and return the content object set at @p swallow direction.
10864 * @param obj The hover object
10865 * @param swallow The direction that the object was display at.
10866 * @return The content that was being used.
10868 * @see elm_hover_content_set()
10870 EAPI Evas_Object *elm_hover_content_unset(Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
10872 * @brief Returns the best swallow location for content in the hover.
10874 * @param obj The hover object
10875 * @param pref_axis The preferred orientation axis for the hover object to use
10876 * @return The edje location to place content into the hover or @c
10879 * Best is defined here as the location at which there is the most available
10882 * @p pref_axis may be one of
10883 * - @c ELM_HOVER_AXIS_NONE -- no prefered orientation
10884 * - @c ELM_HOVER_AXIS_HORIZONTAL -- horizontal
10885 * - @c ELM_HOVER_AXIS_VERTICAL -- vertical
10886 * - @c ELM_HOVER_AXIS_BOTH -- both
10888 * If ELM_HOVER_AXIS_HORIZONTAL is choosen the returned position will
10889 * nescessarily be along the horizontal axis("left" or "right"). If
10890 * ELM_HOVER_AXIS_VERTICAL is choosen the returned position will nescessarily
10891 * be along the vertical axis("top" or "bottom"). Chossing
10892 * ELM_HOVER_AXIS_BOTH or ELM_HOVER_AXIS_NONE has the same effect and the
10893 * returned position may be in either axis.
10895 * @see elm_hover_content_set()
10897 EAPI const char *elm_hover_best_content_location_get(const Evas_Object *obj, Elm_Hover_Axis pref_axis) EINA_ARG_NONNULL(1);
10904 * @defgroup Entry Entry
10906 * @image html img/widget/entry/preview-00.png
10907 * @image latex img/widget/entry/preview-00.eps width=\textwidth
10908 * @image html img/widget/entry/preview-01.png
10909 * @image latex img/widget/entry/preview-01.eps width=\textwidth
10910 * @image html img/widget/entry/preview-02.png
10911 * @image latex img/widget/entry/preview-02.eps width=\textwidth
10912 * @image html img/widget/entry/preview-03.png
10913 * @image latex img/widget/entry/preview-03.eps width=\textwidth
10915 * An entry is a convenience widget which shows a box that the user can
10916 * enter text into. Entries by default don't scroll, so they grow to
10917 * accomodate the entire text, resizing the parent window as needed. This
10918 * can be changed with the elm_entry_scrollable_set() function.
10920 * They can also be single line or multi line (the default) and when set
10921 * to multi line mode they support text wrapping in any of the modes
10922 * indicated by #Elm_Wrap_Type.
10924 * Other features include password mode, filtering of inserted text with
10925 * elm_entry_text_filter_append() and related functions, inline "items" and
10926 * formatted markup text.
10928 * @section entry-markup Formatted text
10930 * The markup tags supported by the Entry are defined by the theme, but
10931 * even when writing new themes or extensions it's a good idea to stick to
10932 * a sane default, to maintain coherency and avoid application breakages.
10933 * Currently defined by the default theme are the following tags:
10934 * @li \<br\>: Inserts a line break.
10935 * @li \<ps\>: Inserts a paragraph separator. This is preferred over line
10937 * @li \<tab\>: Inserts a tab.
10938 * @li \<em\>...\</em\>: Emphasis. Sets the @em oblique style for the
10940 * @li \<b\>...\</b\>: Sets the @b bold style for the enclosed text.
10941 * @li \<link\>...\</link\>: Underlines the enclosed text.
10942 * @li \<hilight\>...\</hilight\>: Hilights the enclosed text.
10944 * @section entry-special Special markups
10946 * Besides those used to format text, entries support two special markup
10947 * tags used to insert clickable portions of text or items inlined within
10950 * @subsection entry-anchors Anchors
10952 * Anchors are similar to HTML anchors. Text can be surrounded by \<a\> and
10953 * \</a\> tags and an event will be generated when this text is clicked,
10957 * This text is outside <a href=anc-01>but this one is an anchor</a>
10960 * The @c href attribute in the opening tag gives the name that will be
10961 * used to identify the anchor and it can be any valid utf8 string.
10963 * When an anchor is clicked, an @c "anchor,clicked" signal is emitted with
10964 * an #Elm_Entry_Anchor_Info in the @c event_info parameter for the
10965 * callback function. The same applies for "anchor,in" (mouse in), "anchor,out"
10966 * (mouse out), "anchor,down" (mouse down), and "anchor,up" (mouse up) events on
10969 * @subsection entry-items Items
10971 * Inlined in the text, any other @c Evas_Object can be inserted by using
10972 * \<item\> tags this way:
10975 * <item size=16x16 vsize=full href=emoticon/haha></item>
10978 * Just like with anchors, the @c href identifies each item, but these need,
10979 * in addition, to indicate their size, which is done using any one of
10980 * @c size, @c absize or @c relsize attributes. These attributes take their
10981 * value in the WxH format, where W is the width and H the height of the
10984 * @li absize: Absolute pixel size for the item. Whatever value is set will
10985 * be the item's size regardless of any scale value the object may have
10986 * been set to. The final line height will be adjusted to fit larger items.
10987 * @li size: Similar to @c absize, but it's adjusted to the scale value set
10989 * @li relsize: Size is adjusted for the item to fit within the current
10992 * Besides their size, items are specificed a @c vsize value that affects
10993 * how their final size and position are calculated. The possible values
10995 * @li ascent: Item will be placed within the line's baseline and its
10996 * ascent. That is, the height between the line where all characters are
10997 * positioned and the highest point in the line. For @c size and @c absize
10998 * items, the descent value will be added to the total line height to make
10999 * them fit. @c relsize items will be adjusted to fit within this space.
11000 * @li full: Items will be placed between the descent and ascent, or the
11001 * lowest point in the line and its highest.
11003 * The next image shows different configurations of items and how
11004 * the previously mentioned options affect their sizes. In all cases,
11005 * the green line indicates the ascent, blue for the baseline and red for
11008 * @image html entry_item.png
11009 * @image latex entry_item.eps width=\textwidth
11011 * And another one to show how size differs from absize. In the first one,
11012 * the scale value is set to 1.0, while the second one is using one of 2.0.
11014 * @image html entry_item_scale.png
11015 * @image latex entry_item_scale.eps width=\textwidth
11017 * After the size for an item is calculated, the entry will request an
11018 * object to place in its space. For this, the functions set with
11019 * elm_entry_item_provider_append() and related functions will be called
11020 * in order until one of them returns a @c non-NULL value. If no providers
11021 * are available, or all of them return @c NULL, then the entry falls back
11022 * to one of the internal defaults, provided the name matches with one of
11025 * All of the following are currently supported:
11028 * - emoticon/angry-shout
11029 * - emoticon/crazy-laugh
11030 * - emoticon/evil-laugh
11032 * - emoticon/goggle-smile
11033 * - emoticon/grumpy
11034 * - emoticon/grumpy-smile
11035 * - emoticon/guilty
11036 * - emoticon/guilty-smile
11038 * - emoticon/half-smile
11039 * - emoticon/happy-panting
11041 * - emoticon/indifferent
11043 * - emoticon/knowing-grin
11045 * - emoticon/little-bit-sorry
11046 * - emoticon/love-lots
11048 * - emoticon/minimal-smile
11049 * - emoticon/not-happy
11050 * - emoticon/not-impressed
11052 * - emoticon/opensmile
11055 * - emoticon/squint-laugh
11056 * - emoticon/surprised
11057 * - emoticon/suspicious
11058 * - emoticon/tongue-dangling
11059 * - emoticon/tongue-poke
11061 * - emoticon/unhappy
11062 * - emoticon/very-sorry
11065 * - emoticon/worried
11068 * Alternatively, an item may reference an image by its path, using
11069 * the URI form @c file:///path/to/an/image.png and the entry will then
11070 * use that image for the item.
11072 * @section entry-files Loading and saving files
11074 * Entries have convinience functions to load text from a file and save
11075 * changes back to it after a short delay. The automatic saving is enabled
11076 * by default, but can be disabled with elm_entry_autosave_set() and files
11077 * can be loaded directly as plain text or have any markup in them
11078 * recognized. See elm_entry_file_set() for more details.
11080 * @section entry-signals Emitted signals
11082 * This widget emits the following signals:
11084 * @li "changed": The text within the entry was changed.
11085 * @li "changed,user": The text within the entry was changed because of user interaction.
11086 * @li "activated": The enter key was pressed on a single line entry.
11087 * @li "press": A mouse button has been pressed on the entry.
11088 * @li "longpressed": A mouse button has been pressed and held for a couple
11090 * @li "clicked": The entry has been clicked (mouse press and release).
11091 * @li "clicked,double": The entry has been double clicked.
11092 * @li "clicked,triple": The entry has been triple clicked.
11093 * @li "focused": The entry has received focus.
11094 * @li "unfocused": The entry has lost focus.
11095 * @li "selection,paste": A paste of the clipboard contents was requested.
11096 * @li "selection,copy": A copy of the selected text into the clipboard was
11098 * @li "selection,cut": A cut of the selected text into the clipboard was
11100 * @li "selection,start": A selection has begun and no previous selection
11102 * @li "selection,changed": The current selection has changed.
11103 * @li "selection,cleared": The current selection has been cleared.
11104 * @li "cursor,changed": The cursor has changed position.
11105 * @li "anchor,clicked": An anchor has been clicked. The event_info
11106 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
11107 * @li "anchor,in": Mouse cursor has moved into an anchor. The event_info
11108 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
11109 * @li "anchor,out": Mouse cursor has moved out of an anchor. The event_info
11110 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
11111 * @li "anchor,up": Mouse button has been unpressed on an anchor. The event_info
11112 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
11113 * @li "anchor,down": Mouse button has been pressed on an anchor. The event_info
11114 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
11115 * @li "preedit,changed": The preedit string has changed.
11116 * @li "language,changed": Program language changed.
11118 * @section entry-examples
11120 * An overview of the Entry API can be seen in @ref entry_example_01
11125 * @typedef Elm_Entry_Anchor_Info
11127 * The info sent in the callback for the "anchor,clicked" signals emitted
11130 typedef struct _Elm_Entry_Anchor_Info Elm_Entry_Anchor_Info;
11132 * @struct _Elm_Entry_Anchor_Info
11134 * The info sent in the callback for the "anchor,clicked" signals emitted
11137 struct _Elm_Entry_Anchor_Info
11139 const char *name; /**< The name of the anchor, as stated in its href */
11140 int button; /**< The mouse button used to click on it */
11141 Evas_Coord x, /**< Anchor geometry, relative to canvas */
11142 y, /**< Anchor geometry, relative to canvas */
11143 w, /**< Anchor geometry, relative to canvas */
11144 h; /**< Anchor geometry, relative to canvas */
11147 * @typedef Elm_Entry_Filter_Cb
11148 * This callback type is used by entry filters to modify text.
11149 * @param data The data specified as the last param when adding the filter
11150 * @param entry The entry object
11151 * @param text A pointer to the location of the text being filtered. This data can be modified,
11152 * but any additional allocations must be managed by the user.
11153 * @see elm_entry_text_filter_append
11154 * @see elm_entry_text_filter_prepend
11156 typedef void (*Elm_Entry_Filter_Cb)(void *data, Evas_Object *entry, char **text);
11159 * @typedef Elm_Entry_Change_Info
11160 * This corresponds to Edje_Entry_Change_Info. Includes information about
11161 * a change in the entry.
11163 typedef Edje_Entry_Change_Info Elm_Entry_Change_Info;
11167 * This adds an entry to @p parent object.
11169 * By default, entries are:
11173 * @li autosave is enabled
11175 * @param parent The parent object
11176 * @return The new object or NULL if it cannot be created
11178 EAPI Evas_Object *elm_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
11180 * Sets the entry to single line mode.
11182 * In single line mode, entries don't ever wrap when the text reaches the
11183 * edge, and instead they keep growing horizontally. Pressing the @c Enter
11184 * key will generate an @c "activate" event instead of adding a new line.
11186 * When @p single_line is @c EINA_FALSE, line wrapping takes effect again
11187 * and pressing enter will break the text into a different line
11188 * without generating any events.
11190 * @param obj The entry object
11191 * @param single_line If true, the text in the entry
11192 * will be on a single line.
11194 EAPI void elm_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line) EINA_ARG_NONNULL(1);
11196 * Gets whether the entry is set to be single line.
11198 * @param obj The entry object
11199 * @return single_line If true, the text in the entry is set to display
11200 * on a single line.
11202 * @see elm_entry_single_line_set()
11204 EAPI Eina_Bool elm_entry_single_line_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11206 * Sets the entry to password mode.
11208 * In password mode, entries are implicitly single line and the display of
11209 * any text in them is replaced with asterisks (*).
11211 * @param obj The entry object
11212 * @param password If true, password mode is enabled.
11214 EAPI void elm_entry_password_set(Evas_Object *obj, Eina_Bool password) EINA_ARG_NONNULL(1);
11216 * Gets whether the entry is set to password mode.
11218 * @param obj The entry object
11219 * @return If true, the entry is set to display all characters
11220 * as asterisks (*).
11222 * @see elm_entry_password_set()
11224 EAPI Eina_Bool elm_entry_password_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11226 * This sets the text displayed within the entry to @p entry.
11228 * @param obj The entry object
11229 * @param entry The text to be displayed
11231 * @deprecated Use elm_object_text_set() instead.
11232 * @note Using this function bypasses text filters
11234 EAPI void elm_entry_entry_set(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
11236 * This returns the text currently shown in object @p entry.
11237 * See also elm_entry_entry_set().
11239 * @param obj The entry object
11240 * @return The currently displayed text or NULL on failure
11242 * @deprecated Use elm_object_text_get() instead.
11244 EAPI const char *elm_entry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11246 * Appends @p entry to the text of the entry.
11248 * Adds the text in @p entry to the end of any text already present in the
11251 * The appended text is subject to any filters set for the widget.
11253 * @param obj The entry object
11254 * @param entry The text to be displayed
11256 * @see elm_entry_text_filter_append()
11258 EAPI void elm_entry_entry_append(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
11260 * Gets whether the entry is empty.
11262 * Empty means no text at all. If there are any markup tags, like an item
11263 * tag for which no provider finds anything, and no text is displayed, this
11264 * function still returns EINA_FALSE.
11266 * @param obj The entry object
11267 * @return EINA_TRUE if the entry is empty, EINA_FALSE otherwise.
11269 EAPI Eina_Bool elm_entry_is_empty(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11271 * Gets any selected text within the entry.
11273 * If there's any selected text in the entry, this function returns it as
11274 * a string in markup format. NULL is returned if no selection exists or
11275 * if an error occurred.
11277 * The returned value points to an internal string and should not be freed
11278 * or modified in any way. If the @p entry object is deleted or its
11279 * contents are changed, the returned pointer should be considered invalid.
11281 * @param obj The entry object
11282 * @return The selected text within the entry or NULL on failure
11284 EAPI const char *elm_entry_selection_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11286 * Returns the actual textblock object of the entry.
11288 * This function exposes the internal textblock object that actually
11289 * contains and draws the text. This should be used for low-level
11290 * manipulations that are otherwise not possible.
11292 * Changing the textblock directly from here will not notify edje/elm to
11293 * recalculate the textblock size automatically, so any modifications
11294 * done to the textblock returned by this function should be followed by
11295 * a call to elm_entry_calc_force().
11297 * The return value is marked as const as an additional warning.
11298 * One should not use the returned object with any of the generic evas
11299 * functions (geometry_get/resize/move and etc), but only with the textblock
11300 * functions; The former will either not work at all, or break the correct
11303 * IMPORTANT: Many functions may change (i.e delete and create a new one)
11304 * the internal textblock object. Do NOT cache the returned object, and try
11305 * not to mix calls on this object with regular elm_entry calls (which may
11306 * change the internal textblock object). This applies to all cursors
11307 * returned from textblock calls, and all the other derivative values.
11309 * @param obj The entry object
11310 * @return The textblock object.
11312 EAPI const Evas_Object *elm_entry_textblock_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11314 * Forces calculation of the entry size and text layouting.
11316 * This should be used after modifying the textblock object directly. See
11317 * elm_entry_textblock_get() for more information.
11319 * @param obj The entry object
11321 * @see elm_entry_textblock_get()
11323 EAPI void elm_entry_calc_force(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11325 * Inserts the given text into the entry at the current cursor position.
11327 * This inserts text at the cursor position as if it was typed
11328 * by the user (note that this also allows markup which a user
11329 * can't just "type" as it would be converted to escaped text, so this
11330 * call can be used to insert things like emoticon items or bold push/pop
11331 * tags, other font and color change tags etc.)
11333 * If any selection exists, it will be replaced by the inserted text.
11335 * The inserted text is subject to any filters set for the widget.
11337 * @param obj The entry object
11338 * @param entry The text to insert
11340 * @see elm_entry_text_filter_append()
11342 EAPI void elm_entry_entry_insert(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
11344 * Set the line wrap type to use on multi-line entries.
11346 * Sets the wrap type used by the entry to any of the specified in
11347 * #Elm_Wrap_Type. This tells how the text will be implicitly cut into a new
11348 * line (without inserting a line break or paragraph separator) when it
11349 * reaches the far edge of the widget.
11351 * Note that this only makes sense for multi-line entries. A widget set
11352 * to be single line will never wrap.
11354 * @param obj The entry object
11355 * @param wrap The wrap mode to use. See #Elm_Wrap_Type for details on them
11357 EAPI void elm_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
11359 * Gets the wrap mode the entry was set to use.
11361 * @param obj The entry object
11362 * @return Wrap type
11364 * @see also elm_entry_line_wrap_set()
11366 EAPI Elm_Wrap_Type elm_entry_line_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11368 * Sets if the entry is to be editable or not.
11370 * By default, entries are editable and when focused, any text input by the
11371 * user will be inserted at the current cursor position. But calling this
11372 * function with @p editable as EINA_FALSE will prevent the user from
11373 * inputting text into the entry.
11375 * The only way to change the text of a non-editable entry is to use
11376 * elm_object_text_set(), elm_entry_entry_insert() and other related
11379 * @param obj The entry object
11380 * @param editable If EINA_TRUE, user input will be inserted in the entry,
11381 * if not, the entry is read-only and no user input is allowed.
11383 EAPI void elm_entry_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
11385 * Gets whether the entry is editable or not.
11387 * @param obj The entry object
11388 * @return If true, the entry is editable by the user.
11389 * If false, it is not editable by the user
11391 * @see elm_entry_editable_set()
11393 EAPI Eina_Bool elm_entry_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11395 * This drops any existing text selection within the entry.
11397 * @param obj The entry object
11399 EAPI void elm_entry_select_none(Evas_Object *obj) EINA_ARG_NONNULL(1);
11401 * This selects all text within the entry.
11403 * @param obj The entry object
11405 EAPI void elm_entry_select_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
11407 * This moves the cursor one place to the right within the entry.
11409 * @param obj The entry object
11410 * @return EINA_TRUE upon success, EINA_FALSE upon failure
11412 EAPI Eina_Bool elm_entry_cursor_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
11414 * This moves the cursor one place to the left within the entry.
11416 * @param obj The entry object
11417 * @return EINA_TRUE upon success, EINA_FALSE upon failure
11419 EAPI Eina_Bool elm_entry_cursor_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
11421 * This moves the cursor one line up within the entry.
11423 * @param obj The entry object
11424 * @return EINA_TRUE upon success, EINA_FALSE upon failure
11426 EAPI Eina_Bool elm_entry_cursor_up(Evas_Object *obj) EINA_ARG_NONNULL(1);
11428 * This moves the cursor one line down within the entry.
11430 * @param obj The entry object
11431 * @return EINA_TRUE upon success, EINA_FALSE upon failure
11433 EAPI Eina_Bool elm_entry_cursor_down(Evas_Object *obj) EINA_ARG_NONNULL(1);
11435 * This moves the cursor to the beginning of the entry.
11437 * @param obj The entry object
11439 EAPI void elm_entry_cursor_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
11441 * This moves the cursor to the end of the entry.
11443 * @param obj The entry object
11445 EAPI void elm_entry_cursor_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
11447 * This moves the cursor to the beginning of the current line.
11449 * @param obj The entry object
11451 EAPI void elm_entry_cursor_line_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
11453 * This moves the cursor to the end of the current line.
11455 * @param obj The entry object
11457 EAPI void elm_entry_cursor_line_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
11459 * This begins a selection within the entry as though
11460 * the user were holding down the mouse button to make a selection.
11462 * @param obj The entry object
11464 EAPI void elm_entry_cursor_selection_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
11466 * This ends a selection within the entry as though
11467 * the user had just released the mouse button while making a selection.
11469 * @param obj The entry object
11471 EAPI void elm_entry_cursor_selection_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
11473 * Gets whether a format node exists at the current cursor position.
11475 * A format node is anything that defines how the text is rendered. It can
11476 * be a visible format node, such as a line break or a paragraph separator,
11477 * or an invisible one, such as bold begin or end tag.
11478 * This function returns whether any format node exists at the current
11481 * @param obj The entry object
11482 * @return EINA_TRUE if the current cursor position contains a format node,
11483 * EINA_FALSE otherwise.
11485 * @see elm_entry_cursor_is_visible_format_get()
11487 EAPI Eina_Bool elm_entry_cursor_is_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11489 * Gets if the current cursor position holds a visible format node.
11491 * @param obj The entry object
11492 * @return EINA_TRUE if the current cursor is a visible format, EINA_FALSE
11493 * if it's an invisible one or no format exists.
11495 * @see elm_entry_cursor_is_format_get()
11497 EAPI Eina_Bool elm_entry_cursor_is_visible_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11499 * Gets the character pointed by the cursor at its current position.
11501 * This function returns a string with the utf8 character stored at the
11502 * current cursor position.
11503 * Only the text is returned, any format that may exist will not be part
11504 * of the return value.
11506 * @param obj The entry object
11507 * @return The text pointed by the cursors.
11509 EAPI const char *elm_entry_cursor_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11511 * This function returns the geometry of the cursor.
11513 * It's useful if you want to draw something on the cursor (or where it is),
11514 * or for example in the case of scrolled entry where you want to show the
11517 * @param obj The entry object
11518 * @param x returned geometry
11519 * @param y returned geometry
11520 * @param w returned geometry
11521 * @param h returned geometry
11522 * @return EINA_TRUE upon success, EINA_FALSE upon failure
11524 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);
11526 * Sets the cursor position in the entry to the given value
11528 * The value in @p pos is the index of the character position within the
11529 * contents of the string as returned by elm_entry_cursor_pos_get().
11531 * @param obj The entry object
11532 * @param pos The position of the cursor
11534 EAPI void elm_entry_cursor_pos_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
11536 * Retrieves the current position of the cursor in the entry
11538 * @param obj The entry object
11539 * @return The cursor position
11541 EAPI int elm_entry_cursor_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11543 * This executes a "cut" action on the selected text in the entry.
11545 * @param obj The entry object
11547 EAPI void elm_entry_selection_cut(Evas_Object *obj) EINA_ARG_NONNULL(1);
11549 * This executes a "copy" action on the selected text in the entry.
11551 * @param obj The entry object
11553 EAPI void elm_entry_selection_copy(Evas_Object *obj) EINA_ARG_NONNULL(1);
11555 * This executes a "paste" action in the entry.
11557 * @param obj The entry object
11559 EAPI void elm_entry_selection_paste(Evas_Object *obj) EINA_ARG_NONNULL(1);
11561 * This clears and frees the items in a entry's contextual (longpress)
11564 * @param obj The entry object
11566 * @see elm_entry_context_menu_item_add()
11568 EAPI void elm_entry_context_menu_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
11570 * This adds an item to the entry's contextual menu.
11572 * A longpress on an entry will make the contextual menu show up, if this
11573 * hasn't been disabled with elm_entry_context_menu_disabled_set().
11574 * By default, this menu provides a few options like enabling selection mode,
11575 * which is useful on embedded devices that need to be explicit about it,
11576 * and when a selection exists it also shows the copy and cut actions.
11578 * With this function, developers can add other options to this menu to
11579 * perform any action they deem necessary.
11581 * @param obj The entry object
11582 * @param label The item's text label
11583 * @param icon_file The item's icon file
11584 * @param icon_type The item's icon type
11585 * @param func The callback to execute when the item is clicked
11586 * @param data The data to associate with the item for related functions
11588 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);
11590 * This disables the entry's contextual (longpress) menu.
11592 * @param obj The entry object
11593 * @param disabled If true, the menu is disabled
11595 EAPI void elm_entry_context_menu_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
11597 * This returns whether the entry's contextual (longpress) menu is
11600 * @param obj The entry object
11601 * @return If true, the menu is disabled
11603 EAPI Eina_Bool elm_entry_context_menu_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11605 * This appends a custom item provider to the list for that entry
11607 * This appends the given callback. The list is walked from beginning to end
11608 * with each function called given the item href string in the text. If the
11609 * function returns an object handle other than NULL (it should create an
11610 * object to do this), then this object is used to replace that item. If
11611 * not the next provider is called until one provides an item object, or the
11612 * default provider in entry does.
11614 * @param obj The entry object
11615 * @param func The function called to provide the item object
11616 * @param data The data passed to @p func
11618 * @see @ref entry-items
11620 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);
11622 * This prepends a custom item provider to the list for that entry
11624 * This prepends the given callback. See elm_entry_item_provider_append() for
11627 * @param obj The entry object
11628 * @param func The function called to provide the item object
11629 * @param data The data passed to @p func
11631 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);
11633 * This removes a custom item provider to the list for that entry
11635 * This removes the given callback. See elm_entry_item_provider_append() for
11638 * @param obj The entry object
11639 * @param func The function called to provide the item object
11640 * @param data The data passed to @p func
11642 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);
11644 * Append a filter function for text inserted in the entry
11646 * Append the given callback to the list. This functions will be called
11647 * whenever any text is inserted into the entry, with the text to be inserted
11648 * as a parameter. The callback function is free to alter the text in any way
11649 * it wants, but it must remember to free the given pointer and update it.
11650 * If the new text is to be discarded, the function can free it and set its
11651 * text parameter to NULL. This will also prevent any following filters from
11654 * @param obj The entry object
11655 * @param func The function to use as text filter
11656 * @param data User data to pass to @p func
11658 EAPI void elm_entry_text_filter_append(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
11660 * Prepend a filter function for text insdrted in the entry
11662 * Prepend the given callback to the list. See elm_entry_text_filter_append()
11663 * for more information
11665 * @param obj The entry object
11666 * @param func The function to use as text filter
11667 * @param data User data to pass to @p func
11669 EAPI void elm_entry_text_filter_prepend(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
11671 * Remove a filter from the list
11673 * Removes the given callback from the filter list. See
11674 * elm_entry_text_filter_append() for more information.
11676 * @param obj The entry object
11677 * @param func The filter function to remove
11678 * @param data The user data passed when adding the function
11680 EAPI void elm_entry_text_filter_remove(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
11682 * This converts a markup (HTML-like) string into UTF-8.
11684 * The returned string is a malloc'ed buffer and it should be freed when
11685 * not needed anymore.
11687 * @param s The string (in markup) to be converted
11688 * @return The converted string (in UTF-8). It should be freed.
11690 EAPI char *elm_entry_markup_to_utf8(const char *s) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
11692 * This converts a UTF-8 string into markup (HTML-like).
11694 * The returned string is a malloc'ed buffer and it should be freed when
11695 * not needed anymore.
11697 * @param s The string (in UTF-8) to be converted
11698 * @return The converted string (in markup). It should be freed.
11700 EAPI char *elm_entry_utf8_to_markup(const char *s) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
11702 * This sets the file (and implicitly loads it) for the text to display and
11703 * then edit. All changes are written back to the file after a short delay if
11704 * the entry object is set to autosave (which is the default).
11706 * If the entry had any other file set previously, any changes made to it
11707 * will be saved if the autosave feature is enabled, otherwise, the file
11708 * will be silently discarded and any non-saved changes will be lost.
11710 * @param obj The entry object
11711 * @param file The path to the file to load and save
11712 * @param format The file format
11714 EAPI void elm_entry_file_set(Evas_Object *obj, const char *file, Elm_Text_Format format) EINA_ARG_NONNULL(1);
11716 * Gets the file being edited by the entry.
11718 * This function can be used to retrieve any file set on the entry for
11719 * edition, along with the format used to load and save it.
11721 * @param obj The entry object
11722 * @param file The path to the file to load and save
11723 * @param format The file format
11725 EAPI void elm_entry_file_get(const Evas_Object *obj, const char **file, Elm_Text_Format *format) EINA_ARG_NONNULL(1);
11727 * This function writes any changes made to the file set with
11728 * elm_entry_file_set()
11730 * @param obj The entry object
11732 EAPI void elm_entry_file_save(Evas_Object *obj) EINA_ARG_NONNULL(1);
11734 * This sets the entry object to 'autosave' the loaded text file or not.
11736 * @param obj The entry object
11737 * @param autosave Autosave the loaded file or not
11739 * @see elm_entry_file_set()
11741 EAPI void elm_entry_autosave_set(Evas_Object *obj, Eina_Bool autosave) EINA_ARG_NONNULL(1);
11743 * This gets the entry object's 'autosave' status.
11745 * @param obj The entry object
11746 * @return Autosave the loaded file or not
11748 * @see elm_entry_file_set()
11750 EAPI Eina_Bool elm_entry_autosave_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11752 * Control pasting of text and images for the widget.
11754 * Normally the entry allows both text and images to be pasted. By setting
11755 * textonly to be true, this prevents images from being pasted.
11757 * Note this only changes the behaviour of text.
11759 * @param obj The entry object
11760 * @param textonly paste mode - EINA_TRUE is text only, EINA_FALSE is
11761 * text+image+other.
11763 EAPI void elm_entry_cnp_textonly_set(Evas_Object *obj, Eina_Bool textonly) EINA_ARG_NONNULL(1);
11765 * Getting elm_entry text paste/drop mode.
11767 * In textonly mode, only text may be pasted or dropped into the widget.
11769 * @param obj The entry object
11770 * @return If the widget only accepts text from pastes.
11772 EAPI Eina_Bool elm_entry_cnp_textonly_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11774 * Enable or disable scrolling in entry
11776 * Normally the entry is not scrollable unless you enable it with this call.
11778 * @param obj The entry object
11779 * @param scroll EINA_TRUE if it is to be scrollable, EINA_FALSE otherwise
11781 EAPI void elm_entry_scrollable_set(Evas_Object *obj, Eina_Bool scroll);
11783 * Get the scrollable state of the entry
11785 * Normally the entry is not scrollable. This gets the scrollable state
11786 * of the entry. See elm_entry_scrollable_set() for more information.
11788 * @param obj The entry object
11789 * @return The scrollable state
11791 EAPI Eina_Bool elm_entry_scrollable_get(const Evas_Object *obj);
11793 * This sets a widget to be displayed to the left of a scrolled entry.
11795 * @param obj The scrolled entry object
11796 * @param icon The widget to display on the left side of the scrolled
11799 * @note A previously set widget will be destroyed.
11800 * @note If the object being set does not have minimum size hints set,
11801 * it won't get properly displayed.
11803 * @see elm_entry_end_set()
11805 EAPI void elm_entry_icon_set(Evas_Object *obj, Evas_Object *icon);
11807 * Gets the leftmost widget of the scrolled entry. This object is
11808 * owned by the scrolled entry and should not be modified.
11810 * @param obj The scrolled entry object
11811 * @return the left widget inside the scroller
11813 EAPI Evas_Object *elm_entry_icon_get(const Evas_Object *obj);
11815 * Unset the leftmost widget of the scrolled entry, unparenting and
11818 * @param obj The scrolled entry object
11819 * @return the previously set icon sub-object of this entry, on
11822 * @see elm_entry_icon_set()
11824 EAPI Evas_Object *elm_entry_icon_unset(Evas_Object *obj);
11826 * Sets the visibility of the left-side widget of the scrolled entry,
11827 * set by elm_entry_icon_set().
11829 * @param obj The scrolled entry object
11830 * @param setting EINA_TRUE if the object should be displayed,
11831 * EINA_FALSE if not.
11833 EAPI void elm_entry_icon_visible_set(Evas_Object *obj, Eina_Bool setting);
11835 * This sets a widget to be displayed to the end of a scrolled entry.
11837 * @param obj The scrolled entry object
11838 * @param end The widget to display on the right side of the scrolled
11841 * @note A previously set widget will be destroyed.
11842 * @note If the object being set does not have minimum size hints set,
11843 * it won't get properly displayed.
11845 * @see elm_entry_icon_set
11847 EAPI void elm_entry_end_set(Evas_Object *obj, Evas_Object *end);
11849 * Gets the endmost widget of the scrolled entry. This object is owned
11850 * by the scrolled entry and should not be modified.
11852 * @param obj The scrolled entry object
11853 * @return the right widget inside the scroller
11855 EAPI Evas_Object *elm_entry_end_get(const Evas_Object *obj);
11857 * Unset the endmost widget of the scrolled entry, unparenting and
11860 * @param obj The scrolled entry object
11861 * @return the previously set icon sub-object of this entry, on
11864 * @see elm_entry_icon_set()
11866 EAPI Evas_Object *elm_entry_end_unset(Evas_Object *obj);
11868 * Sets the visibility of the end widget of the scrolled entry, set by
11869 * elm_entry_end_set().
11871 * @param obj The scrolled entry object
11872 * @param setting EINA_TRUE if the object should be displayed,
11873 * EINA_FALSE if not.
11875 EAPI void elm_entry_end_visible_set(Evas_Object *obj, Eina_Bool setting);
11877 * This sets the scrolled entry's scrollbar policy (ie. enabling/disabling
11880 * Setting an entry to single-line mode with elm_entry_single_line_set()
11881 * will automatically disable the display of scrollbars when the entry
11882 * moves inside its scroller.
11884 * @param obj The scrolled entry object
11885 * @param h The horizontal scrollbar policy to apply
11886 * @param v The vertical scrollbar policy to apply
11888 EAPI void elm_entry_scrollbar_policy_set(Evas_Object *obj, Elm_Scroller_Policy h, Elm_Scroller_Policy v);
11890 * This enables/disables bouncing within the entry.
11892 * This function sets whether the entry will bounce when scrolling reaches
11893 * the end of the contained entry.
11895 * @param obj The scrolled entry object
11896 * @param h The horizontal bounce state
11897 * @param v The vertical bounce state
11899 EAPI void elm_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce);
11901 * Get the bounce mode
11903 * @param obj The Entry object
11904 * @param h_bounce Allow bounce horizontally
11905 * @param v_bounce Allow bounce vertically
11907 EAPI void elm_entry_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce);
11909 /* pre-made filters for entries */
11911 * @typedef Elm_Entry_Filter_Limit_Size
11913 * Data for the elm_entry_filter_limit_size() entry filter.
11915 typedef struct _Elm_Entry_Filter_Limit_Size Elm_Entry_Filter_Limit_Size;
11917 * @struct _Elm_Entry_Filter_Limit_Size
11919 * Data for the elm_entry_filter_limit_size() entry filter.
11921 struct _Elm_Entry_Filter_Limit_Size
11923 int max_char_count; /**< The maximum number of characters allowed. */
11924 int max_byte_count; /**< The maximum number of bytes allowed*/
11927 * Filter inserted text based on user defined character and byte limits
11929 * Add this filter to an entry to limit the characters that it will accept
11930 * based the the contents of the provided #Elm_Entry_Filter_Limit_Size.
11931 * The funtion works on the UTF-8 representation of the string, converting
11932 * it from the set markup, thus not accounting for any format in it.
11934 * The user must create an #Elm_Entry_Filter_Limit_Size structure and pass
11935 * it as data when setting the filter. In it, it's possible to set limits
11936 * by character count or bytes (any of them is disabled if 0), and both can
11937 * be set at the same time. In that case, it first checks for characters,
11940 * The function will cut the inserted text in order to allow only the first
11941 * number of characters that are still allowed. The cut is made in
11942 * characters, even when limiting by bytes, in order to always contain
11943 * valid ones and avoid half unicode characters making it in.
11945 * This filter, like any others, does not apply when setting the entry text
11946 * directly with elm_object_text_set() (or the deprecated
11947 * elm_entry_entry_set()).
11949 EAPI void elm_entry_filter_limit_size(void *data, Evas_Object *entry, char **text) EINA_ARG_NONNULL(1, 2, 3);
11951 * @typedef Elm_Entry_Filter_Accept_Set
11953 * Data for the elm_entry_filter_accept_set() entry filter.
11955 typedef struct _Elm_Entry_Filter_Accept_Set Elm_Entry_Filter_Accept_Set;
11957 * @struct _Elm_Entry_Filter_Accept_Set
11959 * Data for the elm_entry_filter_accept_set() entry filter.
11961 struct _Elm_Entry_Filter_Accept_Set
11963 const char *accepted; /**< Set of characters accepted in the entry. */
11964 const char *rejected; /**< Set of characters rejected from the entry. */
11967 * Filter inserted text based on accepted or rejected sets of characters
11969 * Add this filter to an entry to restrict the set of accepted characters
11970 * based on the sets in the provided #Elm_Entry_Filter_Accept_Set.
11971 * This structure contains both accepted and rejected sets, but they are
11972 * mutually exclusive.
11974 * The @c accepted set takes preference, so if it is set, the filter will
11975 * only work based on the accepted characters, ignoring anything in the
11976 * @c rejected value. If @c accepted is @c NULL, then @c rejected is used.
11978 * In both cases, the function filters by matching utf8 characters to the
11979 * raw markup text, so it can be used to remove formatting tags.
11981 * This filter, like any others, does not apply when setting the entry text
11982 * directly with elm_object_text_set() (or the deprecated
11983 * elm_entry_entry_set()).
11985 EAPI void elm_entry_filter_accept_set(void *data, Evas_Object *entry, char **text) EINA_ARG_NONNULL(1, 3);
11987 * Set the input panel layout of the entry
11989 * @param obj The entry object
11990 * @param layout layout type
11992 EAPI void elm_entry_input_panel_layout_set(Evas_Object *obj, Elm_Input_Panel_Layout layout) EINA_ARG_NONNULL(1);
11994 * Get the input panel layout of the entry
11996 * @param obj The entry object
11997 * @return layout type
11999 * @see elm_entry_input_panel_layout_set
12001 EAPI Elm_Input_Panel_Layout elm_entry_input_panel_layout_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
12003 * Set the autocapitalization type on the immodule.
12005 * @param obj The entry object
12006 * @param autocapital_type The type of autocapitalization
12008 EAPI void elm_entry_autocapital_type_set(Evas_Object *obj, Elm_Autocapital_Type autocapital_type) EINA_ARG_NONNULL(1);
12010 * Retrieve the autocapitalization type on the immodule.
12012 * @param obj The entry object
12013 * @return autocapitalization type
12015 EAPI Elm_Autocapital_Type elm_entry_autocapital_type_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
12017 * Sets the attribute to show the input panel automatically.
12019 * @param obj The entry object
12020 * @param enabled If true, the input panel is appeared when entry is clicked or has a focus
12022 EAPI void elm_entry_input_panel_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
12024 * Retrieve the attribute to show the input panel automatically.
12026 * @param obj The entry object
12027 * @return EINA_TRUE if input panel will be appeared when the entry is clicked or has a focus, EINA_FALSE otherwise
12029 EAPI Eina_Bool elm_entry_input_panel_enabled_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
12035 /* composite widgets - these basically put together basic widgets above
12036 * in convenient packages that do more than basic stuff */
12040 * @defgroup Anchorview Anchorview
12042 * @image html img/widget/anchorview/preview-00.png
12043 * @image latex img/widget/anchorview/preview-00.eps
12045 * Anchorview is for displaying text that contains markup with anchors
12046 * like <c>\<a href=1234\>something\</\></c> in it.
12048 * Besides being styled differently, the anchorview widget provides the
12049 * necessary functionality so that clicking on these anchors brings up a
12050 * popup with user defined content such as "call", "add to contacts" or
12051 * "open web page". This popup is provided using the @ref Hover widget.
12053 * This widget is very similar to @ref Anchorblock, so refer to that
12054 * widget for an example. The only difference Anchorview has is that the
12055 * widget is already provided with scrolling functionality, so if the
12056 * text set to it is too large to fit in the given space, it will scroll,
12057 * whereas the @ref Anchorblock widget will keep growing to ensure all the
12058 * text can be displayed.
12060 * This widget emits the following signals:
12061 * @li "anchor,clicked": will be called when an anchor is clicked. The
12062 * @p event_info parameter on the callback will be a pointer of type
12063 * ::Elm_Entry_Anchorview_Info.
12065 * See @ref Anchorblock for an example on how to use both of them.
12074 * @typedef Elm_Entry_Anchorview_Info
12076 * The info sent in the callback for "anchor,clicked" signals emitted by
12077 * the Anchorview widget.
12079 typedef struct _Elm_Entry_Anchorview_Info Elm_Entry_Anchorview_Info;
12081 * @struct _Elm_Entry_Anchorview_Info
12083 * The info sent in the callback for "anchor,clicked" signals emitted by
12084 * the Anchorview widget.
12086 struct _Elm_Entry_Anchorview_Info
12088 const char *name; /**< Name of the anchor, as indicated in its href
12090 int button; /**< The mouse button used to click on it */
12091 Evas_Object *hover; /**< The hover object to use for the popup */
12093 Evas_Coord x, y, w, h;
12094 } anchor, /**< Geometry selection of text used as anchor */
12095 hover_parent; /**< Geometry of the object used as parent by the
12097 Eina_Bool hover_left : 1; /**< Hint indicating if there's space
12098 for content on the left side of
12099 the hover. Before calling the
12100 callback, the widget will make the
12101 necessary calculations to check
12102 which sides are fit to be set with
12103 content, based on the position the
12104 hover is activated and its distance
12105 to the edges of its parent object
12107 Eina_Bool hover_right : 1; /**< Hint indicating content fits on
12108 the right side of the hover.
12109 See @ref hover_left */
12110 Eina_Bool hover_top : 1; /**< Hint indicating content fits on top
12111 of the hover. See @ref hover_left */
12112 Eina_Bool hover_bottom : 1; /**< Hint indicating content fits
12113 below the hover. See @ref
12117 * Add a new Anchorview object
12119 * @param parent The parent object
12120 * @return The new object or NULL if it cannot be created
12122 EAPI Evas_Object *elm_anchorview_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12124 * Set the text to show in the anchorview
12126 * Sets the text of the anchorview to @p text. This text can include markup
12127 * format tags, including <c>\<a href=anchorname\></c> to begin a segment of
12128 * text that will be specially styled and react to click events, ended with
12129 * either of \</a\> or \</\>. When clicked, the anchor will emit an
12130 * "anchor,clicked" signal that you can attach a callback to with
12131 * evas_object_smart_callback_add(). The name of the anchor given in the
12132 * event info struct will be the one set in the href attribute, in this
12133 * case, anchorname.
12135 * Other markup can be used to style the text in different ways, but it's
12136 * up to the style defined in the theme which tags do what.
12137 * @deprecated use elm_object_text_set() instead.
12139 EINA_DEPRECATED EAPI void elm_anchorview_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1);
12141 * Get the markup text set for the anchorview
12143 * Retrieves the text set on the anchorview, with markup tags included.
12145 * @param obj The anchorview object
12146 * @return The markup text set or @c NULL if nothing was set or an error
12148 * @deprecated use elm_object_text_set() instead.
12150 EINA_DEPRECATED EAPI const char *elm_anchorview_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12152 * Set the parent of the hover popup
12154 * Sets the parent object to use by the hover created by the anchorview
12155 * when an anchor is clicked. See @ref Hover for more details on this.
12156 * If no parent is set, the same anchorview object will be used.
12158 * @param obj The anchorview object
12159 * @param parent The object to use as parent for the hover
12161 EAPI void elm_anchorview_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
12163 * Get the parent of the hover popup
12165 * Get the object used as parent for the hover created by the anchorview
12166 * widget. See @ref Hover for more details on this.
12168 * @param obj The anchorview object
12169 * @return The object used as parent for the hover, NULL if none is set.
12171 EAPI Evas_Object *elm_anchorview_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12173 * Set the style that the hover should use
12175 * When creating the popup hover, anchorview will request that it's
12176 * themed according to @p style.
12178 * @param obj The anchorview object
12179 * @param style The style to use for the underlying hover
12181 * @see elm_object_style_set()
12183 EAPI void elm_anchorview_hover_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
12185 * Get the style that the hover should use
12187 * Get the style the hover created by anchorview will use.
12189 * @param obj The anchorview object
12190 * @return The style to use by the hover. NULL means the default is used.
12192 * @see elm_object_style_set()
12194 EAPI const char *elm_anchorview_hover_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12196 * Ends the hover popup in the anchorview
12198 * When an anchor is clicked, the anchorview widget will create a hover
12199 * object to use as a popup with user provided content. This function
12200 * terminates this popup, returning the anchorview to its normal state.
12202 * @param obj The anchorview object
12204 EAPI void elm_anchorview_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
12206 * Set bouncing behaviour when the scrolled content reaches an edge
12208 * Tell the internal scroller object whether it should bounce or not
12209 * when it reaches the respective edges for each axis.
12211 * @param obj The anchorview object
12212 * @param h_bounce Whether to bounce or not in the horizontal axis
12213 * @param v_bounce Whether to bounce or not in the vertical axis
12215 * @see elm_scroller_bounce_set()
12217 EAPI void elm_anchorview_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
12219 * Get the set bouncing behaviour of the internal scroller
12221 * Get whether the internal scroller should bounce when the edge of each
12222 * axis is reached scrolling.
12224 * @param obj The anchorview object
12225 * @param h_bounce Pointer where to store the bounce state of the horizontal
12227 * @param v_bounce Pointer where to store the bounce state of the vertical
12230 * @see elm_scroller_bounce_get()
12232 EAPI void elm_anchorview_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
12234 * Appends a custom item provider to the given anchorview
12236 * Appends the given function to the list of items providers. This list is
12237 * called, one function at a time, with the given @p data pointer, the
12238 * anchorview object and, in the @p item parameter, the item name as
12239 * referenced in its href string. Following functions in the list will be
12240 * called in order until one of them returns something different to NULL,
12241 * which should be an Evas_Object which will be used in place of the item
12244 * Items in the markup text take the form \<item relsize=16x16 vsize=full
12245 * href=item/name\>\</item\>
12247 * @param obj The anchorview object
12248 * @param func The function to add to the list of providers
12249 * @param data User data that will be passed to the callback function
12251 * @see elm_entry_item_provider_append()
12253 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);
12255 * Prepend a custom item provider to the given anchorview
12257 * Like elm_anchorview_item_provider_append(), but it adds the function
12258 * @p func to the beginning of the list, instead of the end.
12260 * @param obj The anchorview object
12261 * @param func The function to add to the list of providers
12262 * @param data User data that will be passed to the callback function
12264 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);
12266 * Remove a custom item provider from the list of the given anchorview
12268 * Removes the function and data pairing that matches @p func and @p data.
12269 * That is, unless the same function and same user data are given, the
12270 * function will not be removed from the list. This allows us to add the
12271 * same callback several times, with different @p data pointers and be
12272 * able to remove them later without conflicts.
12274 * @param obj The anchorview object
12275 * @param func The function to remove from the list
12276 * @param data The data matching the function to remove from the list
12278 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);
12285 * @defgroup Anchorblock Anchorblock
12287 * @image html img/widget/anchorblock/preview-00.png
12288 * @image latex img/widget/anchorblock/preview-00.eps
12290 * Anchorblock is for displaying text that contains markup with anchors
12291 * like <c>\<a href=1234\>something\</\></c> in it.
12293 * Besides being styled differently, the anchorblock widget provides the
12294 * necessary functionality so that clicking on these anchors brings up a
12295 * popup with user defined content such as "call", "add to contacts" or
12296 * "open web page". This popup is provided using the @ref Hover widget.
12298 * This widget emits the following signals:
12299 * @li "anchor,clicked": will be called when an anchor is clicked. The
12300 * @p event_info parameter on the callback will be a pointer of type
12301 * ::Elm_Entry_Anchorblock_Info.
12307 * Since examples are usually better than plain words, we might as well
12308 * try @ref tutorial_anchorblock_example "one".
12311 * @addtogroup Anchorblock
12315 * @typedef Elm_Entry_Anchorblock_Info
12317 * The info sent in the callback for "anchor,clicked" signals emitted by
12318 * the Anchorblock widget.
12320 typedef struct _Elm_Entry_Anchorblock_Info Elm_Entry_Anchorblock_Info;
12322 * @struct _Elm_Entry_Anchorblock_Info
12324 * The info sent in the callback for "anchor,clicked" signals emitted by
12325 * the Anchorblock widget.
12327 struct _Elm_Entry_Anchorblock_Info
12329 const char *name; /**< Name of the anchor, as indicated in its href
12331 int button; /**< The mouse button used to click on it */
12332 Evas_Object *hover; /**< The hover object to use for the popup */
12334 Evas_Coord x, y, w, h;
12335 } anchor, /**< Geometry selection of text used as anchor */
12336 hover_parent; /**< Geometry of the object used as parent by the
12338 Eina_Bool hover_left : 1; /**< Hint indicating if there's space
12339 for content on the left side of
12340 the hover. Before calling the
12341 callback, the widget will make the
12342 necessary calculations to check
12343 which sides are fit to be set with
12344 content, based on the position the
12345 hover is activated and its distance
12346 to the edges of its parent object
12348 Eina_Bool hover_right : 1; /**< Hint indicating content fits on
12349 the right side of the hover.
12350 See @ref hover_left */
12351 Eina_Bool hover_top : 1; /**< Hint indicating content fits on top
12352 of the hover. See @ref hover_left */
12353 Eina_Bool hover_bottom : 1; /**< Hint indicating content fits
12354 below the hover. See @ref
12358 * Add a new Anchorblock object
12360 * @param parent The parent object
12361 * @return The new object or NULL if it cannot be created
12363 EAPI Evas_Object *elm_anchorblock_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12365 * Set the text to show in the anchorblock
12367 * Sets the text of the anchorblock to @p text. This text can include markup
12368 * format tags, including <c>\<a href=anchorname\></a></c> to begin a segment
12369 * of text that will be specially styled and react to click events, ended
12370 * with either of \</a\> or \</\>. When clicked, the anchor will emit an
12371 * "anchor,clicked" signal that you can attach a callback to with
12372 * evas_object_smart_callback_add(). The name of the anchor given in the
12373 * event info struct will be the one set in the href attribute, in this
12374 * case, anchorname.
12376 * Other markup can be used to style the text in different ways, but it's
12377 * up to the style defined in the theme which tags do what.
12378 * @deprecated use elm_object_text_set() instead.
12380 EINA_DEPRECATED EAPI void elm_anchorblock_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1);
12382 * Get the markup text set for the anchorblock
12384 * Retrieves the text set on the anchorblock, with markup tags included.
12386 * @param obj The anchorblock object
12387 * @return The markup text set or @c NULL if nothing was set or an error
12389 * @deprecated use elm_object_text_set() instead.
12391 EINA_DEPRECATED EAPI const char *elm_anchorblock_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12393 * Set the parent of the hover popup
12395 * Sets the parent object to use by the hover created by the anchorblock
12396 * when an anchor is clicked. See @ref Hover for more details on this.
12398 * @param obj The anchorblock object
12399 * @param parent The object to use as parent for the hover
12401 EAPI void elm_anchorblock_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
12403 * Get the parent of the hover popup
12405 * Get the object used as parent for the hover created by the anchorblock
12406 * widget. See @ref Hover for more details on this.
12407 * If no parent is set, the same anchorblock object will be used.
12409 * @param obj The anchorblock object
12410 * @return The object used as parent for the hover, NULL if none is set.
12412 EAPI Evas_Object *elm_anchorblock_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12414 * Set the style that the hover should use
12416 * When creating the popup hover, anchorblock will request that it's
12417 * themed according to @p style.
12419 * @param obj The anchorblock object
12420 * @param style The style to use for the underlying hover
12422 * @see elm_object_style_set()
12424 EAPI void elm_anchorblock_hover_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
12426 * Get the style that the hover should use
12428 * Get the style, the hover created by anchorblock will use.
12430 * @param obj The anchorblock object
12431 * @return The style to use by the hover. NULL means the default is used.
12433 * @see elm_object_style_set()
12435 EAPI const char *elm_anchorblock_hover_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12437 * Ends the hover popup in the anchorblock
12439 * When an anchor is clicked, the anchorblock widget will create a hover
12440 * object to use as a popup with user provided content. This function
12441 * terminates this popup, returning the anchorblock to its normal state.
12443 * @param obj The anchorblock object
12445 EAPI void elm_anchorblock_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
12447 * Appends a custom item provider to the given anchorblock
12449 * Appends the given function to the list of items providers. This list is
12450 * called, one function at a time, with the given @p data pointer, the
12451 * anchorblock object and, in the @p item parameter, the item name as
12452 * referenced in its href string. Following functions in the list will be
12453 * called in order until one of them returns something different to NULL,
12454 * which should be an Evas_Object which will be used in place of the item
12457 * Items in the markup text take the form \<item relsize=16x16 vsize=full
12458 * href=item/name\>\</item\>
12460 * @param obj The anchorblock object
12461 * @param func The function to add to the list of providers
12462 * @param data User data that will be passed to the callback function
12464 * @see elm_entry_item_provider_append()
12466 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);
12468 * Prepend a custom item provider to the given anchorblock
12470 * Like elm_anchorblock_item_provider_append(), but it adds the function
12471 * @p func to the beginning of the list, instead of the end.
12473 * @param obj The anchorblock object
12474 * @param func The function to add to the list of providers
12475 * @param data User data that will be passed to the callback function
12477 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);
12479 * Remove a custom item provider from the list of the given anchorblock
12481 * Removes the function and data pairing that matches @p func and @p data.
12482 * That is, unless the same function and same user data are given, the
12483 * function will not be removed from the list. This allows us to add the
12484 * same callback several times, with different @p data pointers and be
12485 * able to remove them later without conflicts.
12487 * @param obj The anchorblock object
12488 * @param func The function to remove from the list
12489 * @param data The data matching the function to remove from the list
12491 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);
12497 * @defgroup Bubble Bubble
12499 * @image html img/widget/bubble/preview-00.png
12500 * @image latex img/widget/bubble/preview-00.eps
12501 * @image html img/widget/bubble/preview-01.png
12502 * @image latex img/widget/bubble/preview-01.eps
12503 * @image html img/widget/bubble/preview-02.png
12504 * @image latex img/widget/bubble/preview-02.eps
12506 * @brief The Bubble is a widget to show text similar to how speech is
12507 * represented in comics.
12509 * The bubble widget contains 5 important visual elements:
12510 * @li The frame is a rectangle with rounded edjes and an "arrow".
12511 * @li The @p icon is an image to which the frame's arrow points to.
12512 * @li The @p label is a text which appears to the right of the icon if the
12513 * corner is "top_left" or "bottom_left" and is right aligned to the frame
12515 * @li The @p info is a text which appears to the right of the label. Info's
12516 * font is of a ligther color than label.
12517 * @li The @p content is an evas object that is shown inside the frame.
12519 * The position of the arrow, icon, label and info depends on which corner is
12520 * selected. The four available corners are:
12521 * @li "top_left" - Default
12523 * @li "bottom_left"
12524 * @li "bottom_right"
12526 * Signals that you can add callbacks for are:
12527 * @li "clicked" - This is called when a user has clicked the bubble.
12529 * Default contents parts of the bubble that you can use for are:
12530 * @li "default" - A content of the bubble
12531 * @li "icon" - An icon of the bubble
12533 * Default text parts of the button widget that you can use for are:
12534 * @li NULL - Label of the bubble
12536 * For an example of using a buble see @ref bubble_01_example_page "this".
12542 * Add a new bubble to the parent
12544 * @param parent The parent object
12545 * @return The new object or NULL if it cannot be created
12547 * This function adds a text bubble to the given parent evas object.
12549 EAPI Evas_Object *elm_bubble_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12551 * Set the label of the bubble
12553 * @param obj The bubble object
12554 * @param label The string to set in the label
12556 * This function sets the title of the bubble. Where this appears depends on
12557 * the selected corner.
12558 * @deprecated use elm_object_text_set() instead.
12560 EINA_DEPRECATED EAPI void elm_bubble_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
12562 * Get the label of the bubble
12564 * @param obj The bubble object
12565 * @return The string of set in the label
12567 * This function gets the title of the bubble.
12568 * @deprecated use elm_object_text_get() instead.
12570 EINA_DEPRECATED EAPI const char *elm_bubble_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12572 * Set the info of the bubble
12574 * @param obj The bubble object
12575 * @param info The given info about the bubble
12577 * This function sets the info of the bubble. Where this appears depends on
12578 * the selected corner.
12579 * @deprecated use elm_object_part_text_set() instead. (with "info" as the parameter).
12581 EINA_DEPRECATED EAPI void elm_bubble_info_set(Evas_Object *obj, const char *info) EINA_ARG_NONNULL(1);
12583 * Get the info of the bubble
12585 * @param obj The bubble object
12587 * @return The "info" string of the bubble
12589 * This function gets the info text.
12590 * @deprecated use elm_object_part_text_get() instead. (with "info" as the parameter).
12592 EINA_DEPRECATED EAPI const char *elm_bubble_info_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12594 * Set the content to be shown in the bubble
12596 * Once the content object is set, a previously set one will be deleted.
12597 * If you want to keep the old content object, use the
12598 * elm_bubble_content_unset() function.
12600 * @param obj The bubble object
12601 * @param content The given content of the bubble
12603 * This function sets the content shown on the middle of the bubble.
12605 * @deprecated use elm_object_content_set() instead
12608 EINA_DEPRECATED EAPI void elm_bubble_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
12610 * Get the content shown in the bubble
12612 * Return the content object which is set for this widget.
12614 * @param obj The bubble object
12615 * @return The content that is being used
12617 * @deprecated use elm_object_content_get() instead
12620 EINA_DEPRECATED EAPI Evas_Object *elm_bubble_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12622 * Unset the content shown in the bubble
12624 * Unparent and return the content object which was set for this widget.
12626 * @param obj The bubble object
12627 * @return The content that was being used
12629 * @deprecated use elm_object_content_unset() instead
12632 EINA_DEPRECATED EAPI Evas_Object *elm_bubble_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
12634 * Set the icon of the bubble
12636 * Once the icon object is set, a previously set one will be deleted.
12637 * If you want to keep the old content object, use the
12638 * elm_icon_content_unset() function.
12640 * @param obj The bubble object
12641 * @param icon The given icon for the bubble
12643 * @deprecated use elm_object_part_content_set() instead
12646 EINA_DEPRECATED EAPI void elm_bubble_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
12648 * Get the icon of the bubble
12650 * @param obj The bubble object
12651 * @return The icon for the bubble
12653 * This function gets the icon shown on the top left of bubble.
12655 * @deprecated use elm_object_part_content_get() instead
12658 EINA_DEPRECATED EAPI Evas_Object *elm_bubble_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12660 * Unset the icon of the bubble
12662 * Unparent and return the icon object which was set for this widget.
12664 * @param obj The bubble object
12665 * @return The icon that was being used
12667 * @deprecated use elm_object_part_content_unset() instead
12670 EINA_DEPRECATED EAPI Evas_Object *elm_bubble_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
12672 * Set the corner of the bubble
12674 * @param obj The bubble object.
12675 * @param corner The given corner for the bubble.
12677 * This function sets the corner of the bubble. The corner will be used to
12678 * determine where the arrow in the frame points to and where label, icon and
12681 * Possible values for corner are:
12682 * @li "top_left" - Default
12684 * @li "bottom_left"
12685 * @li "bottom_right"
12687 EAPI void elm_bubble_corner_set(Evas_Object *obj, const char *corner) EINA_ARG_NONNULL(1, 2);
12689 * Get the corner of the bubble
12691 * @param obj The bubble object.
12692 * @return The given corner for the bubble.
12694 * This function gets the selected corner of the bubble.
12696 EAPI const char *elm_bubble_corner_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12702 * @defgroup Photo Photo
12704 * For displaying the photo of a person (contact). Simple, yet
12705 * with a very specific purpose.
12707 * Signals that you can add callbacks for are:
12709 * "clicked" - This is called when a user has clicked the photo
12710 * "drag,start" - Someone started dragging the image out of the object
12711 * "drag,end" - Dragged item was dropped (somewhere)
12717 * Add a new photo to the parent
12719 * @param parent The parent object
12720 * @return The new object or NULL if it cannot be created
12724 EAPI Evas_Object *elm_photo_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12727 * Set the file that will be used as photo
12729 * @param obj The photo object
12730 * @param file The path to file that will be used as photo
12732 * @return (1 = success, 0 = error)
12736 EAPI Eina_Bool elm_photo_file_set(Evas_Object *obj, const char *file) EINA_ARG_NONNULL(1);
12739 * Set the file that will be used as thumbnail in the photo.
12741 * @param obj The photo object.
12742 * @param file The path to file that will be used as thumb.
12743 * @param group The key used in case of an EET file.
12747 EAPI void elm_photo_thumb_set(const Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
12750 * Set the size that will be used on the photo
12752 * @param obj The photo object
12753 * @param size The size that the photo will be
12757 EAPI void elm_photo_size_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
12760 * Set if the photo should be completely visible or not.
12762 * @param obj The photo object
12763 * @param fill if true the photo will be completely visible
12767 EAPI void elm_photo_fill_inside_set(Evas_Object *obj, Eina_Bool fill) EINA_ARG_NONNULL(1);
12770 * Set editability of the photo.
12772 * An editable photo can be dragged to or from, and can be cut or
12773 * pasted too. Note that pasting an image or dropping an item on
12774 * the image will delete the existing content.
12776 * @param obj The photo object.
12777 * @param set To set of clear editablity.
12779 EAPI void elm_photo_editable_set(Evas_Object *obj, Eina_Bool set) EINA_ARG_NONNULL(1);
12785 /* gesture layer */
12787 * @defgroup Elm_Gesture_Layer Gesture Layer
12788 * Gesture Layer Usage:
12790 * Use Gesture Layer to detect gestures.
12791 * The advantage is that you don't have to implement
12792 * gesture detection, just set callbacks of gesture state.
12793 * By using gesture layer we make standard interface.
12795 * In order to use Gesture Layer you start with @ref elm_gesture_layer_add
12796 * with a parent object parameter.
12797 * Next 'activate' gesture layer with a @ref elm_gesture_layer_attach
12798 * call. Usually with same object as target (2nd parameter).
12800 * Now you need to tell gesture layer what gestures you follow.
12801 * This is done with @ref elm_gesture_layer_cb_set call.
12802 * By setting the callback you actually saying to gesture layer:
12803 * I would like to know when the gesture @ref Elm_Gesture_Types
12804 * switches to state @ref Elm_Gesture_State.
12806 * Next, you need to implement the actual action that follows the input
12807 * in your callback.
12809 * Note that if you like to stop being reported about a gesture, just set
12810 * all callbacks referring this gesture to NULL.
12811 * (again with @ref elm_gesture_layer_cb_set)
12813 * The information reported by gesture layer to your callback is depending
12814 * on @ref Elm_Gesture_Types:
12815 * @ref Elm_Gesture_Taps_Info is the info reported for tap gestures:
12816 * @ref ELM_GESTURE_N_TAPS, @ref ELM_GESTURE_N_LONG_TAPS,
12817 * @ref ELM_GESTURE_N_DOUBLE_TAPS, @ref ELM_GESTURE_N_TRIPLE_TAPS.
12819 * @ref Elm_Gesture_Momentum_Info is info reported for momentum gestures:
12820 * @ref ELM_GESTURE_MOMENTUM.
12822 * @ref Elm_Gesture_Line_Info is the info reported for line gestures:
12823 * (this also contains @ref Elm_Gesture_Momentum_Info internal structure)
12824 * @ref ELM_GESTURE_N_LINES, @ref ELM_GESTURE_N_FLICKS.
12825 * Note that we consider a flick as a line-gesture that should be completed
12826 * in flick-time-limit as defined in @ref Config.
12828 * @ref Elm_Gesture_Zoom_Info is the info reported for @ref ELM_GESTURE_ZOOM gesture.
12830 * @ref Elm_Gesture_Rotate_Info is the info reported for @ref ELM_GESTURE_ROTATE gesture.
12833 * Gesture Layer Tweaks:
12835 * Note that line, flick, gestures can start without the need to remove fingers from surface.
12836 * When user fingers rests on same-spot gesture is ended and starts again when fingers moved.
12838 * Setting glayer_continues_enable to false in @ref Config will change this behavior
12839 * so gesture starts when user touches (a *DOWN event) touch-surface
12840 * and ends when no fingers touches surface (a *UP event).
12844 * @enum _Elm_Gesture_Types
12845 * Enum of supported gesture types.
12846 * @ingroup Elm_Gesture_Layer
12848 enum _Elm_Gesture_Types
12850 ELM_GESTURE_FIRST = 0,
12852 ELM_GESTURE_N_TAPS, /**< N fingers single taps */
12853 ELM_GESTURE_N_LONG_TAPS, /**< N fingers single long-taps */
12854 ELM_GESTURE_N_DOUBLE_TAPS, /**< N fingers double-single taps */
12855 ELM_GESTURE_N_TRIPLE_TAPS, /**< N fingers triple-single taps */
12857 ELM_GESTURE_MOMENTUM, /**< Reports momentum in the dircetion of move */
12859 ELM_GESTURE_N_LINES, /**< N fingers line gesture */
12860 ELM_GESTURE_N_FLICKS, /**< N fingers flick gesture */
12862 ELM_GESTURE_ZOOM, /**< Zoom */
12863 ELM_GESTURE_ROTATE, /**< Rotate */
12869 * @typedef Elm_Gesture_Types
12870 * gesture types enum
12871 * @ingroup Elm_Gesture_Layer
12873 typedef enum _Elm_Gesture_Types Elm_Gesture_Types;
12876 * @enum _Elm_Gesture_State
12877 * Enum of gesture states.
12878 * @ingroup Elm_Gesture_Layer
12880 enum _Elm_Gesture_State
12882 ELM_GESTURE_STATE_UNDEFINED = -1, /**< Gesture not STARTed */
12883 ELM_GESTURE_STATE_START, /**< Gesture STARTed */
12884 ELM_GESTURE_STATE_MOVE, /**< Gesture is ongoing */
12885 ELM_GESTURE_STATE_END, /**< Gesture completed */
12886 ELM_GESTURE_STATE_ABORT /**< Onging gesture was ABORTed */
12890 * @typedef Elm_Gesture_State
12891 * gesture states enum
12892 * @ingroup Elm_Gesture_Layer
12894 typedef enum _Elm_Gesture_State Elm_Gesture_State;
12897 * @struct _Elm_Gesture_Taps_Info
12898 * Struct holds taps info for user
12899 * @ingroup Elm_Gesture_Layer
12901 struct _Elm_Gesture_Taps_Info
12903 Evas_Coord x, y; /**< Holds center point between fingers */
12904 unsigned int n; /**< Number of fingers tapped */
12905 unsigned int timestamp; /**< event timestamp */
12909 * @typedef Elm_Gesture_Taps_Info
12910 * holds taps info for user
12911 * @ingroup Elm_Gesture_Layer
12913 typedef struct _Elm_Gesture_Taps_Info Elm_Gesture_Taps_Info;
12916 * @struct _Elm_Gesture_Momentum_Info
12917 * Struct holds momentum info for user
12918 * x1 and y1 are not necessarily in sync
12919 * x1 holds x value of x direction starting point
12920 * and same holds for y1.
12921 * This is noticeable when doing V-shape movement
12922 * @ingroup Elm_Gesture_Layer
12924 struct _Elm_Gesture_Momentum_Info
12925 { /* Report line ends, timestamps, and momentum computed */
12926 Evas_Coord x1; /**< Final-swipe direction starting point on X */
12927 Evas_Coord y1; /**< Final-swipe direction starting point on Y */
12928 Evas_Coord x2; /**< Final-swipe direction ending point on X */
12929 Evas_Coord y2; /**< Final-swipe direction ending point on Y */
12931 unsigned int tx; /**< Timestamp of start of final x-swipe */
12932 unsigned int ty; /**< Timestamp of start of final y-swipe */
12934 Evas_Coord mx; /**< Momentum on X */
12935 Evas_Coord my; /**< Momentum on Y */
12937 unsigned int n; /**< Number of fingers */
12941 * @typedef Elm_Gesture_Momentum_Info
12942 * holds momentum info for user
12943 * @ingroup Elm_Gesture_Layer
12945 typedef struct _Elm_Gesture_Momentum_Info Elm_Gesture_Momentum_Info;
12948 * @struct _Elm_Gesture_Line_Info
12949 * Struct holds line info for user
12950 * @ingroup Elm_Gesture_Layer
12952 struct _Elm_Gesture_Line_Info
12953 { /* Report line ends, timestamps, and momentum computed */
12954 Elm_Gesture_Momentum_Info momentum; /**< Line momentum info */
12955 double angle; /**< Angle (direction) of lines */
12959 * @typedef Elm_Gesture_Line_Info
12960 * Holds line info for user
12961 * @ingroup Elm_Gesture_Layer
12963 typedef struct _Elm_Gesture_Line_Info Elm_Gesture_Line_Info;
12966 * @struct _Elm_Gesture_Zoom_Info
12967 * Struct holds zoom info for user
12968 * @ingroup Elm_Gesture_Layer
12970 struct _Elm_Gesture_Zoom_Info
12972 Evas_Coord x, y; /**< Holds zoom center point reported to user */
12973 Evas_Coord radius; /**< Holds radius between fingers reported to user */
12974 double zoom; /**< Zoom value: 1.0 means no zoom */
12975 double momentum; /**< Zoom momentum: zoom growth per second (NOT YET SUPPORTED) */
12979 * @typedef Elm_Gesture_Zoom_Info
12980 * Holds zoom info for user
12981 * @ingroup Elm_Gesture_Layer
12983 typedef struct _Elm_Gesture_Zoom_Info Elm_Gesture_Zoom_Info;
12986 * @struct _Elm_Gesture_Rotate_Info
12987 * Struct holds rotation info for user
12988 * @ingroup Elm_Gesture_Layer
12990 struct _Elm_Gesture_Rotate_Info
12992 Evas_Coord x, y; /**< Holds zoom center point reported to user */
12993 Evas_Coord radius; /**< Holds radius between fingers reported to user */
12994 double base_angle; /**< Holds start-angle */
12995 double angle; /**< Rotation value: 0.0 means no rotation */
12996 double momentum; /**< Rotation momentum: rotation done per second (NOT YET SUPPORTED) */
13000 * @typedef Elm_Gesture_Rotate_Info
13001 * Holds rotation info for user
13002 * @ingroup Elm_Gesture_Layer
13004 typedef struct _Elm_Gesture_Rotate_Info Elm_Gesture_Rotate_Info;
13007 * @typedef Elm_Gesture_Event_Cb
13008 * User callback used to stream gesture info from gesture layer
13009 * @param data user data
13010 * @param event_info gesture report info
13011 * Returns a flag field to be applied on the causing event.
13012 * You should probably return EVAS_EVENT_FLAG_ON_HOLD if your widget acted
13013 * upon the event, in an irreversible way.
13015 * @ingroup Elm_Gesture_Layer
13017 typedef Evas_Event_Flags (*Elm_Gesture_Event_Cb) (void *data, void *event_info);
13020 * Use function to set callbacks to be notified about
13021 * change of state of gesture.
13022 * When a user registers a callback with this function
13023 * this means this gesture has to be tested.
13025 * When ALL callbacks for a gesture are set to NULL
13026 * it means user isn't interested in gesture-state
13027 * and it will not be tested.
13029 * @param obj Pointer to gesture-layer.
13030 * @param idx The gesture you would like to track its state.
13031 * @param cb callback function pointer.
13032 * @param cb_type what event this callback tracks: START, MOVE, END, ABORT.
13033 * @param data user info to be sent to callback (usually, Smart Data)
13035 * @ingroup Elm_Gesture_Layer
13037 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);
13040 * Call this function to get repeat-events settings.
13042 * @param obj Pointer to gesture-layer.
13044 * @return repeat events settings.
13045 * @see elm_gesture_layer_hold_events_set()
13046 * @ingroup Elm_Gesture_Layer
13048 EAPI Eina_Bool elm_gesture_layer_hold_events_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
13051 * This function called in order to make gesture-layer repeat events.
13052 * Set this of you like to get the raw events only if gestures were not detected.
13053 * Clear this if you like gesture layer to fwd events as testing gestures.
13055 * @param obj Pointer to gesture-layer.
13056 * @param r Repeat: TRUE/FALSE
13058 * @ingroup Elm_Gesture_Layer
13060 EAPI void elm_gesture_layer_hold_events_set(Evas_Object *obj, Eina_Bool r) EINA_ARG_NONNULL(1);
13063 * This function sets step-value for zoom action.
13064 * Set step to any positive value.
13065 * Cancel step setting by setting to 0.0
13067 * @param obj Pointer to gesture-layer.
13068 * @param s new zoom step value.
13070 * @ingroup Elm_Gesture_Layer
13072 EAPI void elm_gesture_layer_zoom_step_set(Evas_Object *obj, double s) EINA_ARG_NONNULL(1);
13075 * This function sets step-value for rotate action.
13076 * Set step to any positive value.
13077 * Cancel step setting by setting to 0.0
13079 * @param obj Pointer to gesture-layer.
13080 * @param s new roatate step value.
13082 * @ingroup Elm_Gesture_Layer
13084 EAPI void elm_gesture_layer_rotate_step_set(Evas_Object *obj, double s) EINA_ARG_NONNULL(1);
13087 * This function called to attach gesture-layer to an Evas_Object.
13088 * @param obj Pointer to gesture-layer.
13089 * @param t Pointer to underlying object (AKA Target)
13091 * @return TRUE, FALSE on success, failure.
13093 * @ingroup Elm_Gesture_Layer
13095 EAPI Eina_Bool elm_gesture_layer_attach(Evas_Object *obj, Evas_Object *t) EINA_ARG_NONNULL(1, 2);
13098 * Call this function to construct a new gesture-layer object.
13099 * This does not activate the gesture layer. You have to
13100 * call elm_gesture_layer_attach in order to 'activate' gesture-layer.
13102 * @param parent the parent object.
13104 * @return Pointer to new gesture-layer object.
13106 * @ingroup Elm_Gesture_Layer
13108 EAPI Evas_Object *elm_gesture_layer_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
13111 * @defgroup Thumb Thumb
13113 * @image html img/widget/thumb/preview-00.png
13114 * @image latex img/widget/thumb/preview-00.eps
13116 * A thumb object is used for displaying the thumbnail of an image or video.
13117 * You must have compiled Elementary with Ethumb_Client support and the DBus
13118 * service must be present and auto-activated in order to have thumbnails to
13121 * Once the thumbnail object becomes visible, it will check if there is a
13122 * previously generated thumbnail image for the file set on it. If not, it
13123 * will start generating this thumbnail.
13125 * Different config settings will cause different thumbnails to be generated
13126 * even on the same file.
13128 * Generated thumbnails are stored under @c $HOME/.thumbnails/. Check the
13129 * Ethumb documentation to change this path, and to see other configuration
13132 * Signals that you can add callbacks for are:
13134 * - "clicked" - This is called when a user has clicked the thumb without dragging
13136 * - "clicked,double" - This is called when a user has double-clicked the thumb.
13137 * - "press" - This is called when a user has pressed down the thumb.
13138 * - "generate,start" - The thumbnail generation started.
13139 * - "generate,stop" - The generation process stopped.
13140 * - "generate,error" - The generation failed.
13141 * - "load,error" - The thumbnail image loading failed.
13143 * available styles:
13147 * An example of use of thumbnail:
13149 * - @ref thumb_example_01
13153 * @addtogroup Thumb
13158 * @enum _Elm_Thumb_Animation_Setting
13159 * @typedef Elm_Thumb_Animation_Setting
13161 * Used to set if a video thumbnail is animating or not.
13165 typedef enum _Elm_Thumb_Animation_Setting
13167 ELM_THUMB_ANIMATION_START = 0, /**< Play animation once */
13168 ELM_THUMB_ANIMATION_LOOP, /**< Keep playing animation until stop is requested */
13169 ELM_THUMB_ANIMATION_STOP, /**< Stop playing the animation */
13170 ELM_THUMB_ANIMATION_LAST
13171 } Elm_Thumb_Animation_Setting;
13174 * Add a new thumb object to the parent.
13176 * @param parent The parent object.
13177 * @return The new object or NULL if it cannot be created.
13179 * @see elm_thumb_file_set()
13180 * @see elm_thumb_ethumb_client_get()
13184 EAPI Evas_Object *elm_thumb_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
13186 * Reload thumbnail if it was generated before.
13188 * @param obj The thumb object to reload
13190 * This is useful if the ethumb client configuration changed, like its
13191 * size, aspect or any other property one set in the handle returned
13192 * by elm_thumb_ethumb_client_get().
13194 * If the options didn't change, the thumbnail won't be generated again, but
13195 * the old one will still be used.
13197 * @see elm_thumb_file_set()
13201 EAPI void elm_thumb_reload(Evas_Object *obj) EINA_ARG_NONNULL(1);
13203 * Set the file that will be used as thumbnail.
13205 * @param obj The thumb object.
13206 * @param file The path to file that will be used as thumb.
13207 * @param key The key used in case of an EET file.
13209 * The file can be an image or a video (in that case, acceptable extensions are:
13210 * avi, mp4, ogv, mov, mpg and wmv). To start the video animation, use the
13211 * function elm_thumb_animate().
13213 * @see elm_thumb_file_get()
13214 * @see elm_thumb_reload()
13215 * @see elm_thumb_animate()
13219 EAPI void elm_thumb_file_set(Evas_Object *obj, const char *file, const char *key) EINA_ARG_NONNULL(1);
13221 * Get the image or video path and key used to generate the thumbnail.
13223 * @param obj The thumb object.
13224 * @param file Pointer to filename.
13225 * @param key Pointer to key.
13227 * @see elm_thumb_file_set()
13228 * @see elm_thumb_path_get()
13232 EAPI void elm_thumb_file_get(const Evas_Object *obj, const char **file, const char **key) EINA_ARG_NONNULL(1);
13234 * Get the path and key to the image or video generated by ethumb.
13236 * One just need to make sure that the thumbnail was generated before getting
13237 * its path; otherwise, the path will be NULL. One way to do that is by asking
13238 * for the path when/after the "generate,stop" smart callback is called.
13240 * @param obj The thumb object.
13241 * @param file Pointer to thumb path.
13242 * @param key Pointer to thumb key.
13244 * @see elm_thumb_file_get()
13248 EAPI void elm_thumb_path_get(const Evas_Object *obj, const char **file, const char **key) EINA_ARG_NONNULL(1);
13250 * Set the animation state for the thumb object. If its content is an animated
13251 * video, you may start/stop the animation or tell it to play continuously and
13254 * @param obj The thumb object.
13255 * @param setting The animation setting.
13257 * @see elm_thumb_file_set()
13261 EAPI void elm_thumb_animate_set(Evas_Object *obj, Elm_Thumb_Animation_Setting s) EINA_ARG_NONNULL(1);
13263 * Get the animation state for the thumb object.
13265 * @param obj The thumb object.
13266 * @return getting The animation setting or @c ELM_THUMB_ANIMATION_LAST,
13269 * @see elm_thumb_animate_set()
13273 EAPI Elm_Thumb_Animation_Setting elm_thumb_animate_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13275 * Get the ethumb_client handle so custom configuration can be made.
13277 * @return Ethumb_Client instance or NULL.
13279 * This must be called before the objects are created to be sure no object is
13280 * visible and no generation started.
13282 * Example of usage:
13285 * #include <Elementary.h>
13286 * #ifndef ELM_LIB_QUICKLAUNCH
13288 * elm_main(int argc, char **argv)
13290 * Ethumb_Client *client;
13292 * elm_need_ethumb();
13296 * client = elm_thumb_ethumb_client_get();
13299 * ERR("could not get ethumb_client");
13302 * ethumb_client_size_set(client, 100, 100);
13303 * ethumb_client_crop_align_set(client, 0.5, 0.5);
13306 * // Create elm_thumb objects here
13316 * @note There's only one client handle for Ethumb, so once a configuration
13317 * change is done to it, any other request for thumbnails (for any thumbnail
13318 * object) will use that configuration. Thus, this configuration is global.
13322 EAPI void *elm_thumb_ethumb_client_get(void);
13324 * Get the ethumb_client connection state.
13326 * @return EINA_TRUE if the client is connected to the server or EINA_FALSE
13329 EAPI Eina_Bool elm_thumb_ethumb_client_connected(void);
13331 * Make the thumbnail 'editable'.
13333 * @param obj Thumb object.
13334 * @param set Turn on or off editability. Default is @c EINA_FALSE.
13336 * This means the thumbnail is a valid drag target for drag and drop, and can be
13337 * cut or pasted too.
13339 * @see elm_thumb_editable_get()
13343 EAPI Eina_Bool elm_thumb_editable_set(Evas_Object *obj, Eina_Bool edit) EINA_ARG_NONNULL(1);
13345 * Make the thumbnail 'editable'.
13347 * @param obj Thumb object.
13348 * @return Editability.
13350 * This means the thumbnail is a valid drag target for drag and drop, and can be
13351 * cut or pasted too.
13353 * @see elm_thumb_editable_set()
13357 EAPI Eina_Bool elm_thumb_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13364 * @defgroup Web Web
13366 * @image html img/widget/web/preview-00.png
13367 * @image latex img/widget/web/preview-00.eps
13369 * A web object is used for displaying web pages (HTML/CSS/JS)
13370 * using WebKit-EFL. You must have compiled Elementary with
13373 * Signals that you can add callbacks for are:
13374 * @li "download,request": A file download has been requested. Event info is
13375 * a pointer to a Elm_Web_Download
13376 * @li "editorclient,contents,changed": Editor client's contents changed
13377 * @li "editorclient,selection,changed": Editor client's selection changed
13378 * @li "frame,created": A new frame was created. Event info is an
13379 * Evas_Object which can be handled with WebKit's ewk_frame API
13380 * @li "icon,received": An icon was received by the main frame
13381 * @li "inputmethod,changed": Input method changed. Event info is an
13382 * Eina_Bool indicating whether it's enabled or not
13383 * @li "js,windowobject,clear": JS window object has been cleared
13384 * @li "link,hover,in": Mouse cursor is hovering over a link. Event info
13385 * is a char *link[2], where the first string contains the URL the link
13386 * points to, and the second one the title of the link
13387 * @li "link,hover,out": Mouse cursor left the link
13388 * @li "load,document,finished": Loading of a document finished. Event info
13389 * is the frame that finished loading
13390 * @li "load,error": Load failed. Event info is a pointer to
13391 * Elm_Web_Frame_Load_Error
13392 * @li "load,finished": Load finished. Event info is NULL on success, on
13393 * error it's a pointer to Elm_Web_Frame_Load_Error
13394 * @li "load,newwindow,show": A new window was created and is ready to be
13396 * @li "load,progress": Overall load progress. Event info is a pointer to
13397 * a double containing a value between 0.0 and 1.0
13398 * @li "load,provisional": Started provisional load
13399 * @li "load,started": Loading of a document started
13400 * @li "menubar,visible,get": Queries if the menubar is visible. Event info
13401 * is a pointer to Eina_Bool where the callback should set EINA_TRUE if
13402 * the menubar is visible, or EINA_FALSE in case it's not
13403 * @li "menubar,visible,set": Informs menubar visibility. Event info is
13404 * an Eina_Bool indicating the visibility
13405 * @li "popup,created": A dropdown widget was activated, requesting its
13406 * popup menu to be created. Event info is a pointer to Elm_Web_Menu
13407 * @li "popup,willdelete": The web object is ready to destroy the popup
13408 * object created. Event info is a pointer to Elm_Web_Menu
13409 * @li "ready": Page is fully loaded
13410 * @li "scrollbars,visible,get": Queries visibility of scrollbars. Event
13411 * info is a pointer to Eina_Bool where the visibility state should be set
13412 * @li "scrollbars,visible,set": Informs scrollbars visibility. Event info
13413 * is an Eina_Bool with the visibility state set
13414 * @li "statusbar,text,set": Text of the statusbar changed. Even info is
13415 * a string with the new text
13416 * @li "statusbar,visible,get": Queries visibility of the status bar.
13417 * Event info is a pointer to Eina_Bool where the visibility state should be
13419 * @li "statusbar,visible,set": Informs statusbar visibility. Event info is
13420 * an Eina_Bool with the visibility value
13421 * @li "title,changed": Title of the main frame changed. Event info is a
13422 * string with the new title
13423 * @li "toolbars,visible,get": Queries visibility of toolbars. Event info
13424 * is a pointer to Eina_Bool where the visibility state should be set
13425 * @li "toolbars,visible,set": Informs the visibility of toolbars. Event
13426 * info is an Eina_Bool with the visibility state
13427 * @li "tooltip,text,set": Show and set text of a tooltip. Event info is
13428 * a string with the text to show
13429 * @li "uri,changed": URI of the main frame changed. Event info is a string
13431 * @li "view,resized": The web object internal's view changed sized
13432 * @li "windows,close,request": A JavaScript request to close the current
13433 * window was requested
13434 * @li "zoom,animated,end": Animated zoom finished
13436 * available styles:
13439 * An example of use of web:
13441 * - @ref web_example_01 TBD
13450 * Structure used to report load errors.
13452 * Load errors are reported as signal by elm_web. All the strings are
13453 * temporary references and should @b not be used after the signal
13454 * callback returns. If it's required, make copies with strdup() or
13455 * eina_stringshare_add() (they are not even guaranteed to be
13456 * stringshared, so must use eina_stringshare_add() and not
13457 * eina_stringshare_ref()).
13459 typedef struct _Elm_Web_Frame_Load_Error Elm_Web_Frame_Load_Error;
13461 * Structure used to report load errors.
13463 * Load errors are reported as signal by elm_web. All the strings are
13464 * temporary references and should @b not be used after the signal
13465 * callback returns. If it's required, make copies with strdup() or
13466 * eina_stringshare_add() (they are not even guaranteed to be
13467 * stringshared, so must use eina_stringshare_add() and not
13468 * eina_stringshare_ref()).
13470 struct _Elm_Web_Frame_Load_Error
13472 int code; /**< Numeric error code */
13473 Eina_Bool is_cancellation; /**< Error produced by cancelling a request */
13474 const char *domain; /**< Error domain name */
13475 const char *description; /**< Error description (already localized) */
13476 const char *failing_url; /**< The URL that failed to load */
13477 Evas_Object *frame; /**< Frame object that produced the error */
13481 * The possibles types that the items in a menu can be
13483 typedef enum _Elm_Web_Menu_Item_Type
13485 ELM_WEB_MENU_SEPARATOR,
13486 ELM_WEB_MENU_GROUP,
13487 ELM_WEB_MENU_OPTION
13488 } Elm_Web_Menu_Item_Type;
13491 * Structure describing the items in a menu
13493 typedef struct _Elm_Web_Menu_Item Elm_Web_Menu_Item;
13495 * Structure describing the items in a menu
13497 struct _Elm_Web_Menu_Item
13499 const char *text; /**< The text for the item */
13500 Elm_Web_Menu_Item_Type type; /**< The type of the item */
13504 * Structure describing the menu of a popup
13506 * This structure will be passed as the @c event_info for the "popup,create"
13507 * signal, which is emitted when a dropdown menu is opened. Users wanting
13508 * to handle these popups by themselves should listen to this signal and
13509 * set the @c handled property of the struct to @c EINA_TRUE. Leaving this
13510 * property as @c EINA_FALSE means that the user will not handle the popup
13511 * and the default implementation will be used.
13513 * When the popup is ready to be dismissed, a "popup,willdelete" signal
13514 * will be emitted to notify the user that it can destroy any objects and
13515 * free all data related to it.
13517 * @see elm_web_popup_selected_set()
13518 * @see elm_web_popup_destroy()
13520 typedef struct _Elm_Web_Menu Elm_Web_Menu;
13522 * Structure describing the menu of a popup
13524 * This structure will be passed as the @c event_info for the "popup,create"
13525 * signal, which is emitted when a dropdown menu is opened. Users wanting
13526 * to handle these popups by themselves should listen to this signal and
13527 * set the @c handled property of the struct to @c EINA_TRUE. Leaving this
13528 * property as @c EINA_FALSE means that the user will not handle the popup
13529 * and the default implementation will be used.
13531 * When the popup is ready to be dismissed, a "popup,willdelete" signal
13532 * will be emitted to notify the user that it can destroy any objects and
13533 * free all data related to it.
13535 * @see elm_web_popup_selected_set()
13536 * @see elm_web_popup_destroy()
13538 struct _Elm_Web_Menu
13540 Eina_List *items; /**< List of #Elm_Web_Menu_Item */
13541 int x; /**< The X position of the popup, relative to the elm_web object */
13542 int y; /**< The Y position of the popup, relative to the elm_web object */
13543 int width; /**< Width of the popup menu */
13544 int height; /**< Height of the popup menu */
13546 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. */
13549 typedef struct _Elm_Web_Download Elm_Web_Download;
13550 struct _Elm_Web_Download
13556 * Types of zoom available.
13558 typedef enum _Elm_Web_Zoom_Mode
13560 ELM_WEB_ZOOM_MODE_MANUAL = 0, /**< Zoom controlled normally by elm_web_zoom_set */
13561 ELM_WEB_ZOOM_MODE_AUTO_FIT, /**< Zoom until content fits in web object */
13562 ELM_WEB_ZOOM_MODE_AUTO_FILL, /**< Zoom until content fills web object */
13563 ELM_WEB_ZOOM_MODE_LAST
13564 } Elm_Web_Zoom_Mode;
13566 * Opaque handler containing the features (such as statusbar, menubar, etc)
13567 * that are to be set on a newly requested window.
13569 typedef struct _Elm_Web_Window_Features Elm_Web_Window_Features;
13571 * Callback type for the create_window hook.
13573 * The function parameters are:
13574 * @li @p data User data pointer set when setting the hook function
13575 * @li @p obj The elm_web object requesting the new window
13576 * @li @p js Set to @c EINA_TRUE if the request was originated from
13577 * JavaScript. @c EINA_FALSE otherwise.
13578 * @li @p window_features A pointer of #Elm_Web_Window_Features indicating
13579 * the features requested for the new window.
13581 * The returned value of the function should be the @c elm_web widget where
13582 * the request will be loaded. That is, if a new window or tab is created,
13583 * the elm_web widget in it should be returned, and @b NOT the window
13585 * Returning @c NULL should cancel the request.
13587 * @see elm_web_window_create_hook_set()
13589 typedef Evas_Object *(*Elm_Web_Window_Open)(void *data, Evas_Object *obj, Eina_Bool js, const Elm_Web_Window_Features *window_features);
13591 * Callback type for the JS alert hook.
13593 * The function parameters are:
13594 * @li @p data User data pointer set when setting the hook function
13595 * @li @p obj The elm_web object requesting the new window
13596 * @li @p message The message to show in the alert dialog
13598 * The function should return the object representing the alert dialog.
13599 * Elm_Web will run a second main loop to handle the dialog and normal
13600 * flow of the application will be restored when the object is deleted, so
13601 * the user should handle the popup properly in order to delete the object
13602 * when the action is finished.
13603 * If the function returns @c NULL the popup will be ignored.
13605 * @see elm_web_dialog_alert_hook_set()
13607 typedef Evas_Object *(*Elm_Web_Dialog_Alert)(void *data, Evas_Object *obj, const char *message);
13609 * Callback type for the JS confirm hook.
13611 * The function parameters are:
13612 * @li @p data User data pointer set when setting the hook function
13613 * @li @p obj The elm_web object requesting the new window
13614 * @li @p message The message to show in the confirm dialog
13615 * @li @p ret Pointer where to store the user selection. @c EINA_TRUE if
13616 * the user selected @c Ok, @c EINA_FALSE otherwise.
13618 * The function should return the object representing the confirm dialog.
13619 * Elm_Web will run a second main loop to handle the dialog and normal
13620 * flow of the application will be restored when the object is deleted, so
13621 * the user should handle the popup properly in order to delete the object
13622 * when the action is finished.
13623 * If the function returns @c NULL the popup will be ignored.
13625 * @see elm_web_dialog_confirm_hook_set()
13627 typedef Evas_Object *(*Elm_Web_Dialog_Confirm)(void *data, Evas_Object *obj, const char *message, Eina_Bool *ret);
13629 * Callback type for the JS prompt hook.
13631 * The function parameters are:
13632 * @li @p data User data pointer set when setting the hook function
13633 * @li @p obj The elm_web object requesting the new window
13634 * @li @p message The message to show in the prompt dialog
13635 * @li @p def_value The default value to present the user in the entry
13636 * @li @p value Pointer where to store the value given by the user. Must
13637 * be a malloc'ed string or @c NULL if the user cancelled the popup.
13638 * @li @p ret Pointer where to store the user selection. @c EINA_TRUE if
13639 * the user selected @c Ok, @c EINA_FALSE otherwise.
13641 * The function should return the object representing the prompt dialog.
13642 * Elm_Web will run a second main loop to handle the dialog and normal
13643 * flow of the application will be restored when the object is deleted, so
13644 * the user should handle the popup properly in order to delete the object
13645 * when the action is finished.
13646 * If the function returns @c NULL the popup will be ignored.
13648 * @see elm_web_dialog_prompt_hook_set()
13650 typedef Evas_Object *(*Elm_Web_Dialog_Prompt)(void *data, Evas_Object *obj, const char *message, const char *def_value, char **value, Eina_Bool *ret);
13652 * Callback type for the JS file selector hook.
13654 * The function parameters are:
13655 * @li @p data User data pointer set when setting the hook function
13656 * @li @p obj The elm_web object requesting the new window
13657 * @li @p allows_multiple @c EINA_TRUE if multiple files can be selected.
13658 * @li @p accept_types Mime types accepted
13659 * @li @p selected Pointer where to store the list of malloc'ed strings
13660 * containing the path to each file selected. Must be @c NULL if the file
13661 * dialog is cancelled
13662 * @li @p ret Pointer where to store the user selection. @c EINA_TRUE if
13663 * the user selected @c Ok, @c EINA_FALSE otherwise.
13665 * The function should return the object representing the file selector
13667 * Elm_Web will run a second main loop to handle the dialog and normal
13668 * flow of the application will be restored when the object is deleted, so
13669 * the user should handle the popup properly in order to delete the object
13670 * when the action is finished.
13671 * If the function returns @c NULL the popup will be ignored.
13673 * @see elm_web_dialog_file selector_hook_set()
13675 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);
13677 * Callback type for the JS console message hook.
13679 * When a console message is added from JavaScript, any set function to the
13680 * console message hook will be called for the user to handle. There is no
13681 * default implementation of this hook.
13683 * The function parameters are:
13684 * @li @p data User data pointer set when setting the hook function
13685 * @li @p obj The elm_web object that originated the message
13686 * @li @p message The message sent
13687 * @li @p line_number The line number
13688 * @li @p source_id Source id
13690 * @see elm_web_console_message_hook_set()
13692 typedef void (*Elm_Web_Console_Message)(void *data, Evas_Object *obj, const char *message, unsigned int line_number, const char *source_id);
13694 * Add a new web object to the parent.
13696 * @param parent The parent object.
13697 * @return The new object or NULL if it cannot be created.
13699 * @see elm_web_uri_set()
13700 * @see elm_web_webkit_view_get()
13702 EAPI Evas_Object *elm_web_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
13705 * Get internal ewk_view object from web object.
13707 * Elementary may not provide some low level features of EWebKit,
13708 * instead of cluttering the API with proxy methods we opted to
13709 * return the internal reference. Be careful using it as it may
13710 * interfere with elm_web behavior.
13712 * @param obj The web object.
13713 * @return The internal ewk_view object or NULL if it does not
13714 * exist. (Failure to create or Elementary compiled without
13717 * @see elm_web_add()
13719 EAPI Evas_Object *elm_web_webkit_view_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13722 * Sets the function to call when a new window is requested
13724 * This hook will be called when a request to create a new window is
13725 * issued from the web page loaded.
13726 * There is no default implementation for this feature, so leaving this
13727 * unset or passing @c NULL in @p func will prevent new windows from
13730 * @param obj The web object where to set the hook function
13731 * @param func The hook function to be called when a window is requested
13732 * @param data User data
13734 EAPI void elm_web_window_create_hook_set(Evas_Object *obj, Elm_Web_Window_Open func, void *data);
13736 * Sets the function to call when an alert dialog
13738 * This hook will be called when a JavaScript alert dialog is requested.
13739 * If no function is set or @c NULL is passed in @p func, the default
13740 * implementation will take place.
13742 * @param obj The web object where to set the hook function
13743 * @param func The callback function to be used
13744 * @param data User data
13746 * @see elm_web_inwin_mode_set()
13748 EAPI void elm_web_dialog_alert_hook_set(Evas_Object *obj, Elm_Web_Dialog_Alert func, void *data);
13750 * Sets the function to call when an confirm dialog
13752 * This hook will be called when a JavaScript confirm dialog is requested.
13753 * If no function is set or @c NULL is passed in @p func, the default
13754 * implementation will take place.
13756 * @param obj The web object where to set the hook function
13757 * @param func The callback function to be used
13758 * @param data User data
13760 * @see elm_web_inwin_mode_set()
13762 EAPI void elm_web_dialog_confirm_hook_set(Evas_Object *obj, Elm_Web_Dialog_Confirm func, void *data);
13764 * Sets the function to call when an prompt dialog
13766 * This hook will be called when a JavaScript prompt dialog is requested.
13767 * If no function is set or @c NULL is passed in @p func, the default
13768 * implementation will take place.
13770 * @param obj The web object where to set the hook function
13771 * @param func The callback function to be used
13772 * @param data User data
13774 * @see elm_web_inwin_mode_set()
13776 EAPI void elm_web_dialog_prompt_hook_set(Evas_Object *obj, Elm_Web_Dialog_Prompt func, void *data);
13778 * Sets the function to call when an file selector dialog
13780 * This hook will be called when a JavaScript file selector dialog is
13782 * If no function is set or @c NULL is passed in @p func, the default
13783 * implementation will take place.
13785 * @param obj The web object where to set the hook function
13786 * @param func The callback function to be used
13787 * @param data User data
13789 * @see elm_web_inwin_mode_set()
13791 EAPI void elm_web_dialog_file_selector_hook_set(Evas_Object *obj, Elm_Web_Dialog_File_Selector func, void *data);
13793 * Sets the function to call when a console message is emitted from JS
13795 * This hook will be called when a console message is emitted from
13796 * JavaScript. There is no default implementation for this feature.
13798 * @param obj The web object where to set the hook function
13799 * @param func The callback function to be used
13800 * @param data User data
13802 EAPI void elm_web_console_message_hook_set(Evas_Object *obj, Elm_Web_Console_Message func, void *data);
13804 * Gets the status of the tab propagation
13806 * @param obj The web object to query
13807 * @return EINA_TRUE if tab propagation is enabled, EINA_FALSE otherwise
13809 * @see elm_web_tab_propagate_set()
13811 EAPI Eina_Bool elm_web_tab_propagate_get(const Evas_Object *obj);
13813 * Sets whether to use tab propagation
13815 * If tab propagation is enabled, whenever the user presses the Tab key,
13816 * Elementary will handle it and switch focus to the next widget.
13817 * The default value is disabled, where WebKit will handle the Tab key to
13818 * cycle focus though its internal objects, jumping to the next widget
13819 * only when that cycle ends.
13821 * @param obj The web object
13822 * @param propagate Whether to propagate Tab keys to Elementary or not
13824 EAPI void elm_web_tab_propagate_set(Evas_Object *obj, Eina_Bool propagate);
13826 * Sets the URI for the web object
13828 * It must be a full URI, with resource included, in the form
13829 * http://www.enlightenment.org or file:///tmp/something.html
13831 * @param obj The web object
13832 * @param uri The URI to set
13833 * @return EINA_TRUE if the URI could be, EINA_FALSE if an error occurred
13835 EAPI Eina_Bool elm_web_uri_set(Evas_Object *obj, const char *uri);
13837 * Gets the current URI for the object
13839 * The returned string must not be freed and is guaranteed to be
13842 * @param obj The web object
13843 * @return A stringshared internal string with the current URI, or NULL on
13846 EAPI const char *elm_web_uri_get(const Evas_Object *obj);
13848 * Gets the current title
13850 * The returned string must not be freed and is guaranteed to be
13853 * @param obj The web object
13854 * @return A stringshared internal string with the current title, or NULL on
13857 EAPI const char *elm_web_title_get(const Evas_Object *obj);
13859 * Sets the background color to be used by the web object
13861 * This is the color that will be used by default when the loaded page
13862 * does not set it's own. Color values are pre-multiplied.
13864 * @param obj The web object
13865 * @param r Red component
13866 * @param g Green component
13867 * @param b Blue component
13868 * @param a Alpha component
13870 EAPI void elm_web_bg_color_set(Evas_Object *obj, int r, int g, int b, int a);
13872 * Gets the background color to be used by the web object
13874 * This is the color that will be used by default when the loaded page
13875 * does not set it's own. Color values are pre-multiplied.
13877 * @param obj The web object
13878 * @param r Red component
13879 * @param g Green component
13880 * @param b Blue component
13881 * @param a Alpha component
13883 EAPI void elm_web_bg_color_get(const Evas_Object *obj, int *r, int *g, int *b, int *a);
13885 * Gets a copy of the currently selected text
13887 * The string returned must be freed by the user when it's done with it.
13889 * @param obj The web object
13890 * @return A newly allocated string, or NULL if nothing is selected or an
13893 EAPI char *elm_view_selection_get(const Evas_Object *obj);
13895 * Tells the web object which index in the currently open popup was selected
13897 * When the user handles the popup creation from the "popup,created" signal,
13898 * it needs to tell the web object which item was selected by calling this
13899 * function with the index corresponding to the item.
13901 * @param obj The web object
13902 * @param index The index selected
13904 * @see elm_web_popup_destroy()
13906 EAPI void elm_web_popup_selected_set(Evas_Object *obj, int index);
13908 * Dismisses an open dropdown popup
13910 * When the popup from a dropdown widget is to be dismissed, either after
13911 * selecting an option or to cancel it, this function must be called, which
13912 * will later emit an "popup,willdelete" signal to notify the user that
13913 * any memory and objects related to this popup can be freed.
13915 * @param obj The web object
13916 * @return EINA_TRUE if the menu was successfully destroyed, or EINA_FALSE
13917 * if there was no menu to destroy
13919 EAPI Eina_Bool elm_web_popup_destroy(Evas_Object *obj);
13921 * Searches the given string in a document.
13923 * @param obj The web object where to search the text
13924 * @param string String to search
13925 * @param case_sensitive If search should be case sensitive or not
13926 * @param forward If search is from cursor and on or backwards
13927 * @param wrap If search should wrap at the end
13929 * @return @c EINA_TRUE if the given string was found, @c EINA_FALSE if not
13932 EAPI Eina_Bool elm_web_text_search(const Evas_Object *obj, const char *string, Eina_Bool case_sensitive, Eina_Bool forward, Eina_Bool wrap);
13934 * Marks matches of the given string in a document.
13936 * @param obj The web object where to search text
13937 * @param string String to match
13938 * @param case_sensitive If match should be case sensitive or not
13939 * @param highlight If matches should be highlighted
13940 * @param limit Maximum amount of matches, or zero to unlimited
13942 * @return number of matched @a string
13944 EAPI unsigned int elm_web_text_matches_mark(Evas_Object *obj, const char *string, Eina_Bool case_sensitive, Eina_Bool highlight, unsigned int limit);
13946 * Clears all marked matches in the document
13948 * @param obj The web object
13950 * @return EINA_TRUE on success, EINA_FALSE otherwise
13952 EAPI Eina_Bool elm_web_text_matches_unmark_all(Evas_Object *obj);
13954 * Sets whether to highlight the matched marks
13956 * If enabled, marks set with elm_web_text_matches_mark() will be
13959 * @param obj The web object
13960 * @param highlight Whether to highlight the marks or not
13962 * @return EINA_TRUE on success, EINA_FALSE otherwise
13964 EAPI Eina_Bool elm_web_text_matches_highlight_set(Evas_Object *obj, Eina_Bool highlight);
13966 * Gets whether highlighting marks is enabled
13968 * @param The web object
13970 * @return EINA_TRUE is marks are set to be highlighted, EINA_FALSE
13973 EAPI Eina_Bool elm_web_text_matches_highlight_get(const Evas_Object *obj);
13975 * Gets the overall loading progress of the page
13977 * Returns the estimated loading progress of the page, with a value between
13978 * 0.0 and 1.0. This is an estimated progress accounting for all the frames
13979 * included in the page.
13981 * @param The web object
13983 * @return A value between 0.0 and 1.0 indicating the progress, or -1.0 on
13986 EAPI double elm_web_load_progress_get(const Evas_Object *obj);
13988 * Stops loading the current page
13990 * Cancels the loading of the current page in the web object. This will
13991 * cause a "load,error" signal to be emitted, with the is_cancellation
13992 * flag set to EINA_TRUE.
13994 * @param obj The web object
13996 * @return EINA_TRUE if the cancel was successful, EINA_FALSE otherwise
13998 EAPI Eina_Bool elm_web_stop(Evas_Object *obj);
14000 * Requests a reload of the current document in the object
14002 * @param obj The web object
14004 * @return EINA_TRUE on success, EINA_FALSE otherwise
14006 EAPI Eina_Bool elm_web_reload(Evas_Object *obj);
14008 * Requests a reload of the current document, avoiding any existing caches
14010 * @param obj The web object
14012 * @return EINA_TRUE on success, EINA_FALSE otherwise
14014 EAPI Eina_Bool elm_web_reload_full(Evas_Object *obj);
14016 * Goes back one step in the browsing history
14018 * This is equivalent to calling elm_web_object_navigate(obj, -1);
14020 * @param obj The web object
14022 * @return EINA_TRUE on success, EINA_FALSE otherwise
14024 * @see elm_web_history_enable_set()
14025 * @see elm_web_back_possible()
14026 * @see elm_web_forward()
14027 * @see elm_web_navigate()
14029 EAPI Eina_Bool elm_web_back(Evas_Object *obj);
14031 * Goes forward one step in the browsing history
14033 * This is equivalent to calling elm_web_object_navigate(obj, 1);
14035 * @param obj The web object
14037 * @return EINA_TRUE on success, EINA_FALSE otherwise
14039 * @see elm_web_history_enable_set()
14040 * @see elm_web_forward_possible()
14041 * @see elm_web_back()
14042 * @see elm_web_navigate()
14044 EAPI Eina_Bool elm_web_forward(Evas_Object *obj);
14046 * Jumps the given number of steps in the browsing history
14048 * The @p steps value can be a negative integer to back in history, or a
14049 * positive to move forward.
14051 * @param obj The web object
14052 * @param steps The number of steps to jump
14054 * @return EINA_TRUE on success, EINA_FALSE on error or if not enough
14055 * history exists to jump the given number of steps
14057 * @see elm_web_history_enable_set()
14058 * @see elm_web_navigate_possible()
14059 * @see elm_web_back()
14060 * @see elm_web_forward()
14062 EAPI Eina_Bool elm_web_navigate(Evas_Object *obj, int steps);
14064 * Queries whether it's possible to go back in history
14066 * @param obj The web object
14068 * @return EINA_TRUE if it's possible to back in history, EINA_FALSE
14071 EAPI Eina_Bool elm_web_back_possible(Evas_Object *obj);
14073 * Queries whether it's possible to go forward in history
14075 * @param obj The web object
14077 * @return EINA_TRUE if it's possible to forward in history, EINA_FALSE
14080 EAPI Eina_Bool elm_web_forward_possible(Evas_Object *obj);
14082 * Queries whether it's possible to jump the given number of steps
14084 * The @p steps value can be a negative integer to back in history, or a
14085 * positive to move forward.
14087 * @param obj The web object
14088 * @param steps The number of steps to check for
14090 * @return EINA_TRUE if enough history exists to perform the given jump,
14091 * EINA_FALSE otherwise
14093 EAPI Eina_Bool elm_web_navigate_possible(Evas_Object *obj, int steps);
14095 * Gets whether browsing history is enabled for the given object
14097 * @param obj The web object
14099 * @return EINA_TRUE if history is enabled, EINA_FALSE otherwise
14101 EAPI Eina_Bool elm_web_history_enable_get(const Evas_Object *obj);
14103 * Enables or disables the browsing history
14105 * @param obj The web object
14106 * @param enable Whether to enable or disable the browsing history
14108 EAPI void elm_web_history_enable_set(Evas_Object *obj, Eina_Bool enable);
14110 * Sets the zoom level of the web object
14112 * Zoom level matches the Webkit API, so 1.0 means normal zoom, with higher
14113 * values meaning zoom in and lower meaning zoom out. This function will
14114 * only affect the zoom level if the mode set with elm_web_zoom_mode_set()
14115 * is ::ELM_WEB_ZOOM_MODE_MANUAL.
14117 * @param obj The web object
14118 * @param zoom The zoom level to set
14120 EAPI void elm_web_zoom_set(Evas_Object *obj, double zoom);
14122 * Gets the current zoom level set on the web object
14124 * Note that this is the zoom level set on the web object and not that
14125 * of the underlying Webkit one. In the ::ELM_WEB_ZOOM_MODE_MANUAL mode,
14126 * the two zoom levels should match, but for the other two modes the
14127 * Webkit zoom is calculated internally to match the chosen mode without
14128 * changing the zoom level set for the web object.
14130 * @param obj The web object
14132 * @return The zoom level set on the object
14134 EAPI double elm_web_zoom_get(const Evas_Object *obj);
14136 * Sets the zoom mode to use
14138 * The modes can be any of those defined in ::Elm_Web_Zoom_Mode, except
14139 * ::ELM_WEB_ZOOM_MODE_LAST. The default is ::ELM_WEB_ZOOM_MODE_MANUAL.
14141 * ::ELM_WEB_ZOOM_MODE_MANUAL means the zoom level will be controlled
14142 * with the elm_web_zoom_set() function.
14143 * ::ELM_WEB_ZOOM_MODE_AUTO_FIT will calculate the needed zoom level to
14144 * make sure the entirety of the web object's contents are shown.
14145 * ::ELM_WEB_ZOOM_MODE_AUTO_FILL will calculate the needed zoom level to
14146 * fit the contents in the web object's size, without leaving any space
14149 * @param obj The web object
14150 * @param mode The mode to set
14152 EAPI void elm_web_zoom_mode_set(Evas_Object *obj, Elm_Web_Zoom_Mode mode);
14154 * Gets the currently set zoom mode
14156 * @param obj The web object
14158 * @return The current zoom mode set for the object, or
14159 * ::ELM_WEB_ZOOM_MODE_LAST on error
14161 EAPI Elm_Web_Zoom_Mode elm_web_zoom_mode_get(const Evas_Object *obj);
14163 * Shows the given region in the web object
14165 * @param obj The web object
14166 * @param x The x coordinate of the region to show
14167 * @param y The y coordinate of the region to show
14168 * @param w The width of the region to show
14169 * @param h The height of the region to show
14171 EAPI void elm_web_region_show(Evas_Object *obj, int x, int y, int w, int h);
14173 * Brings in the region to the visible area
14175 * Like elm_web_region_show(), but it animates the scrolling of the object
14178 * @param obj The web object
14179 * @param x The x coordinate of the region to show
14180 * @param y The y coordinate of the region to show
14181 * @param w The width of the region to show
14182 * @param h The height of the region to show
14184 EAPI void elm_web_region_bring_in(Evas_Object *obj, int x, int y, int w, int h);
14186 * Sets the default dialogs to use an Inwin instead of a normal window
14188 * If set, then the default implementation for the JavaScript dialogs and
14189 * file selector will be opened in an Inwin. Otherwise they will use a
14190 * normal separated window.
14192 * @param obj The web object
14193 * @param value EINA_TRUE to use Inwin, EINA_FALSE to use a normal window
14195 EAPI void elm_web_inwin_mode_set(Evas_Object *obj, Eina_Bool value);
14197 * Gets whether Inwin mode is set for the current object
14199 * @param obj The web object
14201 * @return EINA_TRUE if Inwin mode is set, EINA_FALSE otherwise
14203 EAPI Eina_Bool elm_web_inwin_mode_get(const Evas_Object *obj);
14205 EAPI void elm_web_window_features_ref(Elm_Web_Window_Features *wf);
14206 EAPI void elm_web_window_features_unref(Elm_Web_Window_Features *wf);
14207 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);
14208 EAPI void elm_web_window_features_int_property_get(const Elm_Web_Window_Features *wf, int *x, int *y, int *w, int *h);
14215 * @defgroup Hoversel Hoversel
14217 * @image html img/widget/hoversel/preview-00.png
14218 * @image latex img/widget/hoversel/preview-00.eps
14220 * A hoversel is a button that pops up a list of items (automatically
14221 * choosing the direction to display) that have a label and, optionally, an
14222 * icon to select from. It is a convenience widget to avoid the need to do
14223 * all the piecing together yourself. It is intended for a small number of
14224 * items in the hoversel menu (no more than 8), though is capable of many
14227 * Signals that you can add callbacks for are:
14228 * "clicked" - the user clicked the hoversel button and popped up the sel
14229 * "selected" - an item in the hoversel list is selected. event_info is the item
14230 * "dismissed" - the hover is dismissed
14232 * See @ref tutorial_hoversel for an example.
14235 typedef struct _Elm_Hoversel_Item Elm_Hoversel_Item; /**< Item of Elm_Hoversel. Sub-type of Elm_Widget_Item */
14237 * @brief Add a new Hoversel object
14239 * @param parent The parent object
14240 * @return The new object or NULL if it cannot be created
14242 EAPI Evas_Object *elm_hoversel_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
14244 * @brief This sets the hoversel to expand horizontally.
14246 * @param obj The hoversel object
14247 * @param horizontal If true, the hover will expand horizontally to the
14250 * @note The initial button will display horizontally regardless of this
14253 EAPI void elm_hoversel_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
14255 * @brief This returns whether the hoversel is set to expand horizontally.
14257 * @param obj The hoversel object
14258 * @return If true, the hover will expand horizontally to the right.
14260 * @see elm_hoversel_horizontal_set()
14262 EAPI Eina_Bool elm_hoversel_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14264 * @brief Set the Hover parent
14266 * @param obj The hoversel object
14267 * @param parent The parent to use
14269 * Sets the hover parent object, the area that will be darkened when the
14270 * hoversel is clicked. Should probably be the window that the hoversel is
14271 * in. See @ref Hover objects for more information.
14273 EAPI void elm_hoversel_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
14275 * @brief Get the Hover parent
14277 * @param obj The hoversel object
14278 * @return The used parent
14280 * Gets the hover parent object.
14282 * @see elm_hoversel_hover_parent_set()
14284 EAPI Evas_Object *elm_hoversel_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14286 * @brief Set the hoversel button label
14288 * @param obj The hoversel object
14289 * @param label The label text.
14291 * This sets the label of the button that is always visible (before it is
14292 * clicked and expanded).
14294 * @deprecated elm_object_text_set()
14296 EINA_DEPRECATED EAPI void elm_hoversel_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
14298 * @brief Get the hoversel button label
14300 * @param obj The hoversel object
14301 * @return The label text.
14303 * @deprecated elm_object_text_get()
14305 EINA_DEPRECATED EAPI const char *elm_hoversel_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14307 * @brief Set the icon of the hoversel button
14309 * @param obj The hoversel object
14310 * @param icon The icon object
14312 * Sets the icon of the button that is always visible (before it is clicked
14313 * and expanded). Once the icon object is set, a previously set one will be
14314 * deleted, if you want to keep that old content object, use the
14315 * elm_hoversel_icon_unset() function.
14317 * @see elm_object_content_set() for the button widget
14319 EAPI void elm_hoversel_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
14321 * @brief Get the icon of the hoversel button
14323 * @param obj The hoversel object
14324 * @return The icon object
14326 * Get the icon of the button that is always visible (before it is clicked
14327 * and expanded). Also see elm_object_content_get() for the button widget.
14329 * @see elm_hoversel_icon_set()
14331 EAPI Evas_Object *elm_hoversel_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14333 * @brief Get and unparent the icon of the hoversel button
14335 * @param obj The hoversel object
14336 * @return The icon object that was being used
14338 * Unparent and return the icon of the button that is always visible
14339 * (before it is clicked and expanded).
14341 * @see elm_hoversel_icon_set()
14342 * @see elm_object_content_unset() for the button widget
14344 EAPI Evas_Object *elm_hoversel_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
14346 * @brief This triggers the hoversel popup from code, the same as if the user
14347 * had clicked the button.
14349 * @param obj The hoversel object
14351 EAPI void elm_hoversel_hover_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
14353 * @brief This dismisses the hoversel popup as if the user had clicked
14354 * outside the hover.
14356 * @param obj The hoversel object
14358 EAPI void elm_hoversel_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
14360 * @brief Returns whether the hoversel is expanded.
14362 * @param obj The hoversel object
14363 * @return This will return EINA_TRUE if the hoversel is expanded or
14364 * EINA_FALSE if it is not expanded.
14366 EAPI Eina_Bool elm_hoversel_expanded_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14368 * @brief This will remove all the children items from the hoversel.
14370 * @param obj The hoversel object
14372 * @warning Should @b not be called while the hoversel is active; use
14373 * elm_hoversel_expanded_get() to check first.
14375 * @see elm_hoversel_item_del_cb_set()
14376 * @see elm_hoversel_item_del()
14378 EAPI void elm_hoversel_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
14380 * @brief Get the list of items within the given hoversel.
14382 * @param obj The hoversel object
14383 * @return Returns a list of Elm_Hoversel_Item*
14385 * @see elm_hoversel_item_add()
14387 EAPI const Eina_List *elm_hoversel_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14389 * @brief Add an item to the hoversel button
14391 * @param obj The hoversel object
14392 * @param label The text label to use for the item (NULL if not desired)
14393 * @param icon_file An image file path on disk to use for the icon or standard
14394 * icon name (NULL if not desired)
14395 * @param icon_type The icon type if relevant
14396 * @param func Convenience function to call when this item is selected
14397 * @param data Data to pass to item-related functions
14398 * @return A handle to the item added.
14400 * This adds an item to the hoversel to show when it is clicked. Note: if you
14401 * need to use an icon from an edje file then use
14402 * elm_hoversel_item_icon_set() right after the this function, and set
14403 * icon_file to NULL here.
14405 * For more information on what @p icon_file and @p icon_type are see the
14406 * @ref Icon "icon documentation".
14408 EAPI Elm_Hoversel_Item *elm_hoversel_item_add(Evas_Object *obj, const char *label, const char *icon_file, Elm_Icon_Type icon_type, Evas_Smart_Cb func, const void *data) EINA_ARG_NONNULL(1);
14410 * @brief Delete an item from the hoversel
14412 * @param item The item to delete
14414 * This deletes the item from the hoversel (should not be called while the
14415 * hoversel is active; use elm_hoversel_expanded_get() to check first).
14417 * @see elm_hoversel_item_add()
14418 * @see elm_hoversel_item_del_cb_set()
14420 EAPI void elm_hoversel_item_del(Elm_Hoversel_Item *item) EINA_ARG_NONNULL(1);
14422 * @brief Set the function to be called when an item from the hoversel is
14425 * @param item The item to set the callback on
14426 * @param func The function called
14428 * That function will receive these parameters:
14429 * @li void *item_data
14430 * @li Evas_Object *the_item_object
14431 * @li Elm_Hoversel_Item *the_object_struct
14433 * @see elm_hoversel_item_add()
14435 EAPI void elm_hoversel_item_del_cb_set(Elm_Hoversel_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
14437 * @brief This returns the data pointer supplied with elm_hoversel_item_add()
14438 * that will be passed to associated function callbacks.
14440 * @param item The item to get the data from
14441 * @return The data pointer set with elm_hoversel_item_add()
14443 * @see elm_hoversel_item_add()
14445 EAPI void *elm_hoversel_item_data_get(const Elm_Hoversel_Item *it) EINA_ARG_NONNULL(1);
14447 * @brief This returns the label text of the given hoversel item.
14449 * @param item The item to get the label
14450 * @return The label text of the hoversel item
14452 * @see elm_hoversel_item_add()
14454 EAPI const char *elm_hoversel_item_label_get(const Elm_Hoversel_Item *it) EINA_ARG_NONNULL(1);
14456 * @brief This sets the icon for the given hoversel item.
14458 * @param item The item to set the icon
14459 * @param icon_file An image file path on disk to use for the icon or standard
14461 * @param icon_group The edje group to use if @p icon_file is an edje file. Set this
14462 * to NULL if the icon is not an edje file
14463 * @param icon_type The icon type
14465 * The icon can be loaded from the standard set, from an image file, or from
14468 * @see elm_hoversel_item_add()
14470 EAPI void elm_hoversel_item_icon_set(Elm_Hoversel_Item *it, const char *icon_file, const char *icon_group, Elm_Icon_Type icon_type) EINA_ARG_NONNULL(1);
14472 * @brief Get the icon object of the hoversel item
14474 * @param item The item to get the icon from
14475 * @param icon_file The image file path on disk used for the icon or standard
14477 * @param icon_group The edje group used if @p icon_file is an edje file. NULL
14478 * if the icon is not an edje file
14479 * @param icon_type The icon type
14481 * @see elm_hoversel_item_icon_set()
14482 * @see elm_hoversel_item_add()
14484 EAPI void elm_hoversel_item_icon_get(const Elm_Hoversel_Item *it, const char **icon_file, const char **icon_group, Elm_Icon_Type *icon_type) EINA_ARG_NONNULL(1);
14490 * @defgroup Toolbar Toolbar
14491 * @ingroup Elementary
14493 * @image html img/widget/toolbar/preview-00.png
14494 * @image latex img/widget/toolbar/preview-00.eps width=\textwidth
14496 * @image html img/toolbar.png
14497 * @image latex img/toolbar.eps width=\textwidth
14499 * A toolbar is a widget that displays a list of items inside
14500 * a box. It can be scrollable, show a menu with items that don't fit
14501 * to toolbar size or even crop them.
14503 * Only one item can be selected at a time.
14505 * Items can have multiple states, or show menus when selected by the user.
14507 * Smart callbacks one can listen to:
14508 * - "clicked" - when the user clicks on a toolbar item and becomes selected.
14509 * - "language,changed" - when the program language changes
14511 * Available styles for it:
14513 * - @c "transparent" - no background or shadow, just show the content
14515 * List of examples:
14516 * @li @ref toolbar_example_01
14517 * @li @ref toolbar_example_02
14518 * @li @ref toolbar_example_03
14522 * @addtogroup Toolbar
14527 * @enum _Elm_Toolbar_Shrink_Mode
14528 * @typedef Elm_Toolbar_Shrink_Mode
14530 * Set toolbar's items display behavior, it can be scrollabel,
14531 * show a menu with exceeding items, or simply hide them.
14533 * @note Default value is #ELM_TOOLBAR_SHRINK_MENU. It reads value
14536 * Values <b> don't </b> work as bitmask, only one can be choosen.
14538 * @see elm_toolbar_mode_shrink_set()
14539 * @see elm_toolbar_mode_shrink_get()
14543 typedef enum _Elm_Toolbar_Shrink_Mode
14545 ELM_TOOLBAR_SHRINK_NONE, /**< Set toolbar minimun size to fit all the items. */
14546 ELM_TOOLBAR_SHRINK_HIDE, /**< Hide exceeding items. */
14547 ELM_TOOLBAR_SHRINK_SCROLL, /**< Allow accessing exceeding items through a scroller. */
14548 ELM_TOOLBAR_SHRINK_MENU, /**< Inserts a button to pop up a menu with exceeding items. */
14549 ELM_TOOLBAR_SHRINK_LAST /**< Indicates error if returned by elm_toolbar_shrink_mode_get() */
14550 } Elm_Toolbar_Shrink_Mode;
14552 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(). */
14555 * Add a new toolbar widget to the given parent Elementary
14556 * (container) object.
14558 * @param parent The parent object.
14559 * @return a new toolbar widget handle or @c NULL, on errors.
14561 * This function inserts a new toolbar widget on the canvas.
14565 EAPI Evas_Object *elm_toolbar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
14567 * Set the icon size, in pixels, to be used by toolbar items.
14569 * @param obj The toolbar object
14570 * @param icon_size The icon size in pixels
14572 * @note Default value is @c 32. It reads value from elm config.
14574 * @see elm_toolbar_icon_size_get()
14578 EAPI void elm_toolbar_icon_size_set(Evas_Object *obj, int icon_size) EINA_ARG_NONNULL(1);
14580 * Get the icon size, in pixels, to be used by toolbar items.
14582 * @param obj The toolbar object.
14583 * @return The icon size in pixels.
14585 * @see elm_toolbar_icon_size_set() for details.
14589 EAPI int elm_toolbar_icon_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14591 * Sets icon lookup order, for toolbar items' icons.
14593 * @param obj The toolbar object.
14594 * @param order The icon lookup order.
14596 * Icons added before calling this function will not be affected.
14597 * The default lookup order is #ELM_ICON_LOOKUP_THEME_FDO.
14599 * @see elm_toolbar_icon_order_lookup_get()
14603 EAPI void elm_toolbar_icon_order_lookup_set(Evas_Object *obj, Elm_Icon_Lookup_Order order) EINA_ARG_NONNULL(1);
14605 * Gets the icon lookup order.
14607 * @param obj The toolbar object.
14608 * @return The icon lookup order.
14610 * @see elm_toolbar_icon_order_lookup_set() for details.
14614 EAPI Elm_Icon_Lookup_Order elm_toolbar_icon_order_lookup_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14616 * Set whether the toolbar should always have an item selected.
14618 * @param obj The toolbar object.
14619 * @param wrap @c EINA_TRUE to enable always-select mode or @c EINA_FALSE to
14622 * This will cause the toolbar to always have an item selected, and clicking
14623 * the selected item will not cause a selected event to be emitted. Enabling this mode
14624 * will immediately select the first toolbar item.
14626 * Always-selected is disabled by default.
14628 * @see elm_toolbar_always_select_mode_get().
14632 EAPI void elm_toolbar_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
14634 * Get whether the toolbar should always have an item selected.
14636 * @param obj The toolbar object.
14637 * @return @c EINA_TRUE means an item will always be selected, @c EINA_FALSE indicates
14638 * that it is possible to have no items selected. If @p obj is @c NULL, @c EINA_FALSE is returned.
14640 * @see elm_toolbar_always_select_mode_set() for details.
14644 EAPI Eina_Bool elm_toolbar_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14646 * Set whether the toolbar items' should be selected by the user or not.
14648 * @param obj The toolbar object.
14649 * @param wrap @c EINA_TRUE to disable selection or @c EINA_FALSE to
14652 * This will turn off the ability to select items entirely and they will
14653 * neither appear selected nor emit selected signals. The clicked
14654 * callback function will still be called.
14656 * Selection is enabled by default.
14658 * @see elm_toolbar_no_select_mode_get().
14662 EAPI void elm_toolbar_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
14665 * Set whether the toolbar items' should be selected by the user or not.
14667 * @param obj The toolbar object.
14668 * @return @c EINA_TRUE means items can be selected. @c EINA_FALSE indicates
14669 * they can't. If @p obj is @c NULL, @c EINA_FALSE is returned.
14671 * @see elm_toolbar_no_select_mode_set() for details.
14675 EAPI Eina_Bool elm_toolbar_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14677 * Append item to the toolbar.
14679 * @param obj The toolbar object.
14680 * @param icon A string with icon name or the absolute path of an image file.
14681 * @param label The label of the item.
14682 * @param func The function to call when the item is clicked.
14683 * @param data The data to associate with the item for related callbacks.
14684 * @return The created item or @c NULL upon failure.
14686 * A new item will be created and appended to the toolbar, i.e., will
14687 * be set as @b last item.
14689 * Items created with this method can be deleted with
14690 * elm_toolbar_item_del().
14692 * Associated @p data can be properly freed when item is deleted if a
14693 * callback function is set with elm_toolbar_item_del_cb_set().
14695 * If a function is passed as argument, it will be called everytime this item
14696 * is selected, i.e., the user clicks over an unselected item.
14697 * If such function isn't needed, just passing
14698 * @c NULL as @p func is enough. The same should be done for @p data.
14700 * Toolbar will load icon image from fdo or current theme.
14701 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
14702 * If an absolute path is provided it will load it direct from a file.
14704 * @see elm_toolbar_item_icon_set()
14705 * @see elm_toolbar_item_del()
14706 * @see elm_toolbar_item_del_cb_set()
14710 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);
14712 * Prepend item to the toolbar.
14714 * @param obj The toolbar object.
14715 * @param icon A string with icon name or the absolute path of an image file.
14716 * @param label The label of the item.
14717 * @param func The function to call when the item is clicked.
14718 * @param data The data to associate with the item for related callbacks.
14719 * @return The created item or @c NULL upon failure.
14721 * A new item will be created and prepended to the toolbar, i.e., will
14722 * be set as @b first item.
14724 * Items created with this method can be deleted with
14725 * elm_toolbar_item_del().
14727 * Associated @p data can be properly freed when item is deleted if a
14728 * callback function is set with elm_toolbar_item_del_cb_set().
14730 * If a function is passed as argument, it will be called everytime this item
14731 * is selected, i.e., the user clicks over an unselected item.
14732 * If such function isn't needed, just passing
14733 * @c NULL as @p func is enough. The same should be done for @p data.
14735 * Toolbar will load icon image from fdo or current theme.
14736 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
14737 * If an absolute path is provided it will load it direct from a file.
14739 * @see elm_toolbar_item_icon_set()
14740 * @see elm_toolbar_item_del()
14741 * @see elm_toolbar_item_del_cb_set()
14745 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);
14747 * Insert a new item into the toolbar object before item @p before.
14749 * @param obj The toolbar object.
14750 * @param before The toolbar item to insert before.
14751 * @param icon A string with icon name or the absolute path of an image file.
14752 * @param label The label of the item.
14753 * @param func The function to call when the item is clicked.
14754 * @param data The data to associate with the item for related callbacks.
14755 * @return The created item or @c NULL upon failure.
14757 * A new item will be created and added to the toolbar. Its position in
14758 * this toolbar will be just before item @p before.
14760 * Items created with this method can be deleted with
14761 * elm_toolbar_item_del().
14763 * Associated @p data can be properly freed when item is deleted if a
14764 * callback function is set with elm_toolbar_item_del_cb_set().
14766 * If a function is passed as argument, it will be called everytime this item
14767 * is selected, i.e., the user clicks over an unselected item.
14768 * If such function isn't needed, just passing
14769 * @c NULL as @p func is enough. The same should be done for @p data.
14771 * Toolbar will load icon image from fdo or current theme.
14772 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
14773 * If an absolute path is provided it will load it direct from a file.
14775 * @see elm_toolbar_item_icon_set()
14776 * @see elm_toolbar_item_del()
14777 * @see elm_toolbar_item_del_cb_set()
14781 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);
14784 * Insert a new item into the toolbar object after item @p after.
14786 * @param obj The toolbar object.
14787 * @param after The toolbar item to insert after.
14788 * @param icon A string with icon name or the absolute path of an image file.
14789 * @param label The label of the item.
14790 * @param func The function to call when the item is clicked.
14791 * @param data The data to associate with the item for related callbacks.
14792 * @return The created item or @c NULL upon failure.
14794 * A new item will be created and added to the toolbar. Its position in
14795 * this toolbar will be just after item @p after.
14797 * Items created with this method can be deleted with
14798 * elm_toolbar_item_del().
14800 * Associated @p data can be properly freed when item is deleted if a
14801 * callback function is set with elm_toolbar_item_del_cb_set().
14803 * If a function is passed as argument, it will be called everytime this item
14804 * is selected, i.e., the user clicks over an unselected item.
14805 * If such function isn't needed, just passing
14806 * @c NULL as @p func is enough. The same should be done for @p data.
14808 * Toolbar will load icon image from fdo or current theme.
14809 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
14810 * If an absolute path is provided it will load it direct from a file.
14812 * @see elm_toolbar_item_icon_set()
14813 * @see elm_toolbar_item_del()
14814 * @see elm_toolbar_item_del_cb_set()
14818 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);
14820 * Get the first item in the given toolbar widget's list of
14823 * @param obj The toolbar object
14824 * @return The first item or @c NULL, if it has no items (and on
14827 * @see elm_toolbar_item_append()
14828 * @see elm_toolbar_last_item_get()
14832 EAPI Elm_Object_Item *elm_toolbar_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14834 * Get the last item in the given toolbar widget's list of
14837 * @param obj The toolbar object
14838 * @return The last item or @c NULL, if it has no items (and on
14841 * @see elm_toolbar_item_prepend()
14842 * @see elm_toolbar_first_item_get()
14846 EAPI Elm_Object_Item *elm_toolbar_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14848 * Get the item after @p item in toolbar.
14850 * @param it The toolbar item.
14851 * @return The item after @p item, or @c NULL if none or on failure.
14853 * @note If it is the last item, @c NULL will be returned.
14855 * @see elm_toolbar_item_append()
14859 EAPI Elm_Object_Item *elm_toolbar_item_next_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
14861 * Get the item before @p item in toolbar.
14863 * @param item The toolbar item.
14864 * @return The item before @p item, or @c NULL if none or on failure.
14866 * @note If it is the first item, @c NULL will be returned.
14868 * @see elm_toolbar_item_prepend()
14872 EAPI Elm_Object_Item *elm_toolbar_item_prev_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
14874 * Get the toolbar object from an item.
14876 * @param it The item.
14877 * @return The toolbar object.
14879 * This returns the toolbar object itself that an item belongs to.
14883 EAPI Evas_Object *elm_toolbar_item_toolbar_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
14885 * Set the priority of a toolbar item.
14887 * @param it The toolbar item.
14888 * @param priority The item priority. The default is zero.
14890 * This is used only when the toolbar shrink mode is set to
14891 * #ELM_TOOLBAR_SHRINK_MENU or #ELM_TOOLBAR_SHRINK_HIDE.
14892 * When space is less than required, items with low priority
14893 * will be removed from the toolbar and added to a dynamically-created menu,
14894 * while items with higher priority will remain on the toolbar,
14895 * with the same order they were added.
14897 * @see elm_toolbar_item_priority_get()
14901 EAPI void elm_toolbar_item_priority_set(Elm_Object_Item *it, int priority) EINA_ARG_NONNULL(1);
14903 * Get the priority of a toolbar item.
14905 * @param it The toolbar item.
14906 * @return The @p item priority, or @c 0 on failure.
14908 * @see elm_toolbar_item_priority_set() for details.
14912 EAPI int elm_toolbar_item_priority_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
14914 * Get the label of item.
14916 * @param it The item of toolbar.
14917 * @return The label of item.
14919 * The return value is a pointer to the label associated to @p item when
14920 * it was created, with function elm_toolbar_item_append() or similar,
14922 * with function elm_toolbar_item_label_set. If no label
14923 * was passed as argument, it will return @c NULL.
14925 * @see elm_toolbar_item_label_set() for more details.
14926 * @see elm_toolbar_item_append()
14930 EAPI const char *elm_toolbar_item_label_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
14932 * Set the label of item.
14934 * @param it The item of toolbar.
14935 * @param text The label of item.
14937 * The label to be displayed by the item.
14938 * Label will be placed at icons bottom (if set).
14940 * If a label was passed as argument on item creation, with function
14941 * elm_toolbar_item_append() or similar, it will be already
14942 * displayed by the item.
14944 * @see elm_toolbar_item_label_get()
14945 * @see elm_toolbar_item_append()
14949 EAPI void elm_toolbar_item_label_set(Elm_Object_Item *it, const char *label) EINA_ARG_NONNULL(1);
14951 * Return the data associated with a given toolbar widget item.
14953 * @param it The toolbar widget item handle.
14954 * @return The data associated with @p item.
14956 * @see elm_toolbar_item_data_set()
14960 EAPI void *elm_toolbar_item_data_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
14962 * Set the data associated with a given toolbar widget item.
14964 * @param it The toolbar widget item handle
14965 * @param data The new data pointer to set to @p item.
14967 * This sets new item data on @p item.
14969 * @warning The old data pointer won't be touched by this function, so
14970 * the user had better to free that old data himself/herself.
14974 EAPI void elm_toolbar_item_data_set(Elm_Object_Item *it, const void *data) EINA_ARG_NONNULL(1);
14976 * Returns a pointer to a toolbar item by its label.
14978 * @param obj The toolbar object.
14979 * @param label The label of the item to find.
14981 * @return The pointer to the toolbar item matching @p label or @c NULL
14986 EAPI Elm_Object_Item *elm_toolbar_item_find_by_label(const Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
14988 * Get whether the @p item is selected or not.
14990 * @param it The toolbar item.
14991 * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
14992 * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
14994 * @see elm_toolbar_selected_item_set() for details.
14995 * @see elm_toolbar_item_selected_get()
14999 EAPI Eina_Bool elm_toolbar_item_selected_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
15001 * Set the selected state of an item.
15003 * @param it The toolbar item
15004 * @param selected The selected state
15006 * This sets the selected state of the given item @p it.
15007 * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
15009 * If a new item is selected the previosly selected will be unselected.
15010 * Previoulsy selected item can be get with function
15011 * elm_toolbar_selected_item_get().
15013 * Selected items will be highlighted.
15015 * @see elm_toolbar_item_selected_get()
15016 * @see elm_toolbar_selected_item_get()
15020 EAPI void elm_toolbar_item_selected_set(Elm_Object_Item *it, Eina_Bool selected) EINA_ARG_NONNULL(1);
15022 * Get the selected item.
15024 * @param obj The toolbar object.
15025 * @return The selected toolbar item.
15027 * The selected item can be unselected with function
15028 * elm_toolbar_item_selected_set().
15030 * The selected item always will be highlighted on toolbar.
15032 * @see elm_toolbar_selected_items_get()
15036 EAPI Elm_Object_Item *elm_toolbar_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15038 * Set the icon associated with @p item.
15040 * @param obj The parent of this item.
15041 * @param it The toolbar item.
15042 * @param icon A string with icon name or the absolute path of an image file.
15044 * Toolbar will load icon image from fdo or current theme.
15045 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
15046 * If an absolute path is provided it will load it direct from a file.
15048 * @see elm_toolbar_icon_order_lookup_set()
15049 * @see elm_toolbar_icon_order_lookup_get()
15053 EAPI void elm_toolbar_item_icon_set(Elm_Object_Item *it, const char *icon) EINA_ARG_NONNULL(1);
15055 * Get the string used to set the icon of @p item.
15057 * @param it The toolbar item.
15058 * @return The string associated with the icon object.
15060 * @see elm_toolbar_item_icon_set() for details.
15064 EAPI const char *elm_toolbar_item_icon_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
15066 * Get the object of @p item.
15068 * @param it The toolbar item.
15069 * @return The object
15073 EAPI Evas_Object *elm_toolbar_item_object_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
15075 * Get the icon object of @p item.
15077 * @param it The toolbar item.
15078 * @return The icon object
15080 * @see elm_toolbar_item_icon_set() or elm_toolbar_item_icon_memfile_set() for details.
15084 EAPI Evas_Object *elm_toolbar_item_icon_object_get(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
15086 * Set the icon associated with @p item to an image in a binary buffer.
15088 * @param it The toolbar item.
15089 * @param img The binary data that will be used as an image
15090 * @param size The size of binary data @p img
15091 * @param format Optional format of @p img to pass to the image loader
15092 * @param key Optional key of @p img to pass to the image loader (eg. if @p img is an edje file)
15094 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
15096 * @note The icon image set by this function can be changed by
15097 * elm_toolbar_item_icon_set().
15101 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);
15103 * Delete them item from the toolbar.
15105 * @param it The item of toolbar to be deleted.
15107 * @see elm_toolbar_item_append()
15108 * @see elm_toolbar_item_del_cb_set()
15112 EAPI void elm_toolbar_item_del(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
15115 * Set the function called when a toolbar item is freed.
15117 * @param it The item to set the callback on.
15118 * @param func The function called.
15120 * If there is a @p func, then it will be called prior item's memory release.
15121 * That will be called with the following arguments:
15123 * @li item's Evas object;
15126 * This way, a data associated to a toolbar item could be properly freed.
15130 EAPI void elm_toolbar_item_del_cb_set(Elm_Object_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
15133 * Get a value whether toolbar item is disabled or not.
15135 * @param it The item.
15136 * @return The disabled state.
15138 * @see elm_toolbar_item_disabled_set() for more details.
15142 EAPI Eina_Bool elm_toolbar_item_disabled_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
15145 * Sets the disabled/enabled state of a toolbar item.
15147 * @param it The item.
15148 * @param disabled The disabled state.
15150 * A disabled item cannot be selected or unselected. It will also
15151 * change its appearance (generally greyed out). This sets the
15152 * disabled state (@c EINA_TRUE for disabled, @c EINA_FALSE for
15157 EAPI void elm_toolbar_item_disabled_set(Elm_Object_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1);
15160 * Set or unset item as a separator.
15162 * @param it The toolbar item.
15163 * @param setting @c EINA_TRUE to set item @p item as separator or
15164 * @c EINA_FALSE to unset, i.e., item will be used as a regular item.
15166 * Items aren't set as separator by default.
15168 * If set as separator it will display separator theme, so won't display
15171 * @see elm_toolbar_item_separator_get()
15175 EAPI void elm_toolbar_item_separator_set(Elm_Object_Item *it, Eina_Bool separator) EINA_ARG_NONNULL(1);
15178 * Get a value whether item is a separator or not.
15180 * @param it The toolbar item.
15181 * @return @c EINA_TRUE means item @p it is a separator. @c EINA_FALSE
15182 * indicates it's not. If @p it is @c NULL, @c EINA_FALSE is returned.
15184 * @see elm_toolbar_item_separator_set() for details.
15188 EAPI Eina_Bool elm_toolbar_item_separator_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
15191 * Set the shrink state of toolbar @p obj.
15193 * @param obj The toolbar object.
15194 * @param shrink_mode Toolbar's items display behavior.
15196 * The toolbar won't scroll if #ELM_TOOLBAR_SHRINK_NONE,
15197 * but will enforce a minimun size so all the items will fit, won't scroll
15198 * and won't show the items that don't fit if #ELM_TOOLBAR_SHRINK_HIDE,
15199 * will scroll if #ELM_TOOLBAR_SHRINK_SCROLL, and will create a button to
15200 * pop up excess elements with #ELM_TOOLBAR_SHRINK_MENU.
15204 EAPI void elm_toolbar_mode_shrink_set(Evas_Object *obj, Elm_Toolbar_Shrink_Mode shrink_mode) EINA_ARG_NONNULL(1);
15207 * Get the shrink mode of toolbar @p obj.
15209 * @param obj The toolbar object.
15210 * @return Toolbar's items display behavior.
15212 * @see elm_toolbar_mode_shrink_set() for details.
15216 EAPI Elm_Toolbar_Shrink_Mode elm_toolbar_mode_shrink_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15219 * Enable/disable homogeneous mode.
15221 * @param obj The toolbar object
15222 * @param homogeneous Assume the items within the toolbar are of the
15223 * same size (EINA_TRUE = on, EINA_FALSE = off). Default is @c EINA_FALSE.
15225 * This will enable the homogeneous mode where items are of the same size.
15226 * @see elm_toolbar_homogeneous_get()
15230 EAPI void elm_toolbar_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
15233 * Get whether the homogeneous mode is enabled.
15235 * @param obj The toolbar object.
15236 * @return Assume the items within the toolbar are of the same height
15237 * and width (EINA_TRUE = on, EINA_FALSE = off).
15239 * @see elm_toolbar_homogeneous_set()
15243 EAPI Eina_Bool elm_toolbar_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15245 * Set the parent object of the toolbar items' menus.
15247 * @param obj The toolbar object.
15248 * @param parent The parent of the menu objects.
15250 * Each item can be set as item menu, with elm_toolbar_item_menu_set().
15252 * For more details about setting the parent for toolbar menus, see
15253 * elm_menu_parent_set().
15255 * @see elm_menu_parent_set() for details.
15256 * @see elm_toolbar_item_menu_set() for details.
15260 EAPI void elm_toolbar_menu_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
15262 * Get the parent object of the toolbar items' menus.
15264 * @param obj The toolbar object.
15265 * @return The parent of the menu objects.
15267 * @see elm_toolbar_menu_parent_set() for details.
15271 EAPI Evas_Object *elm_toolbar_menu_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15273 * Set the alignment of the items.
15275 * @param obj The toolbar object.
15276 * @param align The new alignment, a float between <tt> 0.0 </tt>
15277 * and <tt> 1.0 </tt>.
15279 * Alignment of toolbar items, from <tt> 0.0 </tt> to indicates to align
15280 * left, to <tt> 1.0 </tt>, to align to right. <tt> 0.5 </tt> centralize
15283 * Centered items by default.
15285 * @see elm_toolbar_align_get()
15289 EAPI void elm_toolbar_align_set(Evas_Object *obj, double align) EINA_ARG_NONNULL(1);
15291 * Get the alignment of the items.
15293 * @param obj The toolbar object.
15294 * @return toolbar items alignment, a float between <tt> 0.0 </tt> and
15297 * @see elm_toolbar_align_set() for details.
15301 EAPI double elm_toolbar_align_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15303 * Set whether the toolbar item opens a menu.
15305 * @param it The toolbar item.
15306 * @param menu If @c EINA_TRUE, @p item will opens a menu when selected.
15308 * A toolbar item can be set to be a menu, using this function.
15310 * Once it is set to be a menu, it can be manipulated through the
15311 * menu-like function elm_toolbar_menu_parent_set() and the other
15312 * elm_menu functions, using the Evas_Object @c menu returned by
15313 * elm_toolbar_item_menu_get().
15315 * So, items to be displayed in this item's menu should be added with
15316 * elm_menu_item_add().
15318 * The following code exemplifies the most basic usage:
15320 * tb = elm_toolbar_add(win)
15321 * item = elm_toolbar_item_append(tb, "refresh", "Menu", NULL, NULL);
15322 * elm_toolbar_item_menu_set(item, EINA_TRUE);
15323 * elm_toolbar_menu_parent_set(tb, win);
15324 * menu = elm_toolbar_item_menu_get(item);
15325 * elm_menu_item_add(menu, NULL, "edit-cut", "Cut", NULL, NULL);
15326 * menu_item = elm_menu_item_add(menu, NULL, "edit-copy", "Copy", NULL,
15330 * @see elm_toolbar_item_menu_get()
15334 EAPI void elm_toolbar_item_menu_set(Elm_Object_Item *it, Eina_Bool menu) EINA_ARG_NONNULL(1);
15336 * Get toolbar item's menu.
15338 * @param it The toolbar item.
15339 * @return Item's menu object or @c NULL on failure.
15341 * If @p item wasn't set as menu item with elm_toolbar_item_menu_set(),
15342 * this function will set it.
15344 * @see elm_toolbar_item_menu_set() for details.
15348 EAPI Evas_Object *elm_toolbar_item_menu_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
15350 * Add a new state to @p item.
15352 * @param it The toolbar item.
15353 * @param icon A string with icon name or the absolute path of an image file.
15354 * @param label The label of the new state.
15355 * @param func The function to call when the item is clicked when this
15356 * state is selected.
15357 * @param data The data to associate with the state.
15358 * @return The toolbar item state, or @c NULL upon failure.
15360 * Toolbar will load icon image from fdo or current theme.
15361 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
15362 * If an absolute path is provided it will load it direct from a file.
15364 * States created with this function can be removed with
15365 * elm_toolbar_item_state_del().
15367 * @see elm_toolbar_item_state_del()
15368 * @see elm_toolbar_item_state_sel()
15369 * @see elm_toolbar_item_state_get()
15373 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);
15375 * Delete a previoulsy added state to @p item.
15377 * @param it The toolbar item.
15378 * @param state The state to be deleted.
15379 * @return @c EINA_TRUE on success or @c EINA_FALSE on failure.
15381 * @see elm_toolbar_item_state_add()
15383 EAPI Eina_Bool elm_toolbar_item_state_del(Elm_Object_Item *it, Elm_Toolbar_Item_State *state) EINA_ARG_NONNULL(1);
15385 * Set @p state as the current state of @p it.
15387 * @param it The toolbar item.
15388 * @param state The state to use.
15389 * @return @c EINA_TRUE on success or @c EINA_FALSE on failure.
15391 * If @p state is @c NULL, it won't select any state and the default item's
15392 * icon and label will be used. It's the same behaviour than
15393 * elm_toolbar_item_state_unser().
15395 * @see elm_toolbar_item_state_unset()
15399 EAPI Eina_Bool elm_toolbar_item_state_set(Elm_Object_Item *it, Elm_Toolbar_Item_State *state) EINA_ARG_NONNULL(1);
15401 * Unset the state of @p it.
15403 * @param it The toolbar item.
15405 * The default icon and label from this item will be displayed.
15407 * @see elm_toolbar_item_state_set() for more details.
15411 EAPI void elm_toolbar_item_state_unset(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
15413 * Get the current state of @p it.
15415 * @param it The toolbar item.
15416 * @return The selected state or @c NULL if none is selected or on failure.
15418 * @see elm_toolbar_item_state_set() for details.
15419 * @see elm_toolbar_item_state_unset()
15420 * @see elm_toolbar_item_state_add()
15424 EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
15426 * Get the state after selected state in toolbar's @p item.
15428 * @param it The toolbar item to change state.
15429 * @return The state after current state, or @c NULL on failure.
15431 * If last state is selected, this function will return first state.
15433 * @see elm_toolbar_item_state_set()
15434 * @see elm_toolbar_item_state_add()
15438 EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_next(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
15440 * Get the state before selected state in toolbar's @p item.
15442 * @param it The toolbar item to change state.
15443 * @return The state before current state, or @c NULL on failure.
15445 * If first state is selected, this function will return last state.
15447 * @see elm_toolbar_item_state_set()
15448 * @see elm_toolbar_item_state_add()
15452 EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_prev(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
15454 * Set the text to be shown in a given toolbar item's tooltips.
15456 * @param it toolbar item.
15457 * @param text The text to set in the content.
15459 * Setup the text as tooltip to object. The item can have only one tooltip,
15460 * so any previous tooltip data - set with this function or
15461 * elm_toolbar_item_tooltip_content_cb_set() - is removed.
15463 * @see elm_object_tooltip_text_set() for more details.
15467 EAPI void elm_toolbar_item_tooltip_text_set(Elm_Object_Item *it, const char *text) EINA_ARG_NONNULL(1);
15469 * Set the content to be shown in the tooltip item.
15471 * Setup the tooltip to item. The item can have only one tooltip,
15472 * so any previous tooltip data is removed. @p func(with @p data) will
15473 * be called every time that need show the tooltip and it should
15474 * return a valid Evas_Object. This object is then managed fully by
15475 * tooltip system and is deleted when the tooltip is gone.
15477 * @param it the toolbar item being attached a tooltip.
15478 * @param func the function used to create the tooltip contents.
15479 * @param data what to provide to @a func as callback data/context.
15480 * @param del_cb called when data is not needed anymore, either when
15481 * another callback replaces @a func, the tooltip is unset with
15482 * elm_toolbar_item_tooltip_unset() or the owner @a item
15483 * dies. This callback receives as the first parameter the
15484 * given @a data, and @c event_info is the item.
15486 * @see elm_object_tooltip_content_cb_set() for more details.
15490 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);
15492 * Unset tooltip from item.
15494 * @param it toolbar item to remove previously set tooltip.
15496 * Remove tooltip from item. The callback provided as del_cb to
15497 * elm_toolbar_item_tooltip_content_cb_set() will be called to notify
15498 * it is not used anymore.
15500 * @see elm_object_tooltip_unset() for more details.
15501 * @see elm_toolbar_item_tooltip_content_cb_set()
15505 EAPI void elm_toolbar_item_tooltip_unset(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
15507 * Sets a different style for this item tooltip.
15509 * @note before you set a style you should define a tooltip with
15510 * elm_toolbar_item_tooltip_content_cb_set() or
15511 * elm_toolbar_item_tooltip_text_set()
15513 * @param it toolbar item with tooltip already set.
15514 * @param style the theme style to use (default, transparent, ...)
15516 * @see elm_object_tooltip_style_set() for more details.
15520 EAPI void elm_toolbar_item_tooltip_style_set(Elm_Object_Item *it, const char *style) EINA_ARG_NONNULL(1);
15522 * Get the style for this item tooltip.
15524 * @param it toolbar item with tooltip already set.
15525 * @return style the theme style in use, defaults to "default". If the
15526 * object does not have a tooltip set, then NULL is returned.
15528 * @see elm_object_tooltip_style_get() for more details.
15529 * @see elm_toolbar_item_tooltip_style_set()
15533 EAPI const char *elm_toolbar_item_tooltip_style_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
15535 * Set the type of mouse pointer/cursor decoration to be shown,
15536 * when the mouse pointer is over the given toolbar widget item
15538 * @param it toolbar item to customize cursor on
15539 * @param cursor the cursor type's name
15541 * This function works analogously as elm_object_cursor_set(), but
15542 * here the cursor's changing area is restricted to the item's
15543 * area, and not the whole widget's. Note that that item cursors
15544 * have precedence over widget cursors, so that a mouse over an
15545 * item with custom cursor set will always show @b that cursor.
15547 * If this function is called twice for an object, a previously set
15548 * cursor will be unset on the second call.
15550 * @see elm_object_cursor_set()
15551 * @see elm_toolbar_item_cursor_get()
15552 * @see elm_toolbar_item_cursor_unset()
15556 EAPI void elm_toolbar_item_cursor_set(Elm_Object_Item *it, const char *cursor) EINA_ARG_NONNULL(1);
15559 * Get the type of mouse pointer/cursor decoration set to be shown,
15560 * when the mouse pointer is over the given toolbar widget item
15562 * @param it toolbar item with custom cursor set
15563 * @return the cursor type's name or @c NULL, if no custom cursors
15564 * were set to @p item (and on errors)
15566 * @see elm_object_cursor_get()
15567 * @see elm_toolbar_item_cursor_set()
15568 * @see elm_toolbar_item_cursor_unset()
15572 EAPI const char *elm_toolbar_item_cursor_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
15575 * Unset any custom mouse pointer/cursor decoration set to be
15576 * shown, when the mouse pointer is over the given toolbar widget
15577 * item, thus making it show the @b default cursor again.
15579 * @param it a toolbar item
15581 * Use this call to undo any custom settings on this item's cursor
15582 * decoration, bringing it back to defaults (no custom style set).
15584 * @see elm_object_cursor_unset()
15585 * @see elm_toolbar_item_cursor_set()
15589 EAPI void elm_toolbar_item_cursor_unset(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
15592 * Set a different @b style for a given custom cursor set for a
15595 * @param it toolbar item with custom cursor set
15596 * @param style the <b>theme style</b> to use (e.g. @c "default",
15597 * @c "transparent", etc)
15599 * This function only makes sense when one is using custom mouse
15600 * cursor decorations <b>defined in a theme file</b>, which can have,
15601 * given a cursor name/type, <b>alternate styles</b> on it. It
15602 * works analogously as elm_object_cursor_style_set(), but here
15603 * applyed only to toolbar item objects.
15605 * @warning Before you set a cursor style you should have definen a
15606 * custom cursor previously on the item, with
15607 * elm_toolbar_item_cursor_set()
15609 * @see elm_toolbar_item_cursor_engine_only_set()
15610 * @see elm_toolbar_item_cursor_style_get()
15614 EAPI void elm_toolbar_item_cursor_style_set(Elm_Object_Item *it, const char *style) EINA_ARG_NONNULL(1);
15617 * Get the current @b style set for a given toolbar item's custom
15620 * @param it toolbar item with custom cursor set.
15621 * @return style the cursor style in use. If the object does not
15622 * have a cursor set, then @c NULL is returned.
15624 * @see elm_toolbar_item_cursor_style_set() for more details
15628 EAPI const char *elm_toolbar_item_cursor_style_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
15631 * Set if the (custom)cursor for a given toolbar item should be
15632 * searched in its theme, also, or should only rely on the
15633 * rendering engine.
15635 * @param it item with custom (custom) cursor already set on
15636 * @param engine_only Use @c EINA_TRUE to have cursors looked for
15637 * only on those provided by the rendering engine, @c EINA_FALSE to
15638 * have them searched on the widget's theme, as well.
15640 * @note This call is of use only if you've set a custom cursor
15641 * for toolbar items, with elm_toolbar_item_cursor_set().
15643 * @note By default, cursors will only be looked for between those
15644 * provided by the rendering engine.
15648 EAPI void elm_toolbar_item_cursor_engine_only_set(Elm_Object_Item *it, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
15651 * Get if the (custom) cursor for a given toolbar item is being
15652 * searched in its theme, also, or is only relying on the rendering
15655 * @param it a toolbar item
15656 * @return @c EINA_TRUE, if cursors are being looked for only on
15657 * those provided by the rendering engine, @c EINA_FALSE if they
15658 * are being searched on the widget's theme, as well.
15660 * @see elm_toolbar_item_cursor_engine_only_set(), for more details
15664 EAPI Eina_Bool elm_toolbar_item_cursor_engine_only_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
15667 * Change a toolbar's orientation
15668 * @param obj The toolbar object
15669 * @param vertical If @c EINA_TRUE, the toolbar is vertical
15670 * By default, a toolbar will be horizontal. Use this function to create a vertical toolbar.
15672 * @deprecated use elm_toolbar_horizontal_set() instead.
15674 EINA_DEPRECATED EAPI void elm_toolbar_orientation_set(Evas_Object *obj, Eina_Bool vertical) EINA_ARG_NONNULL(1);
15677 * Change a toolbar's orientation
15678 * @param obj The toolbar object
15679 * @param horizontal If @c EINA_TRUE, the toolbar is horizontal
15680 * By default, a toolbar will be horizontal. Use this function to create a vertical toolbar.
15683 EAPI void elm_toolbar_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
15686 * Get a toolbar's orientation
15687 * @param obj The toolbar object
15688 * @return If @c EINA_TRUE, the toolbar is vertical
15689 * By default, a toolbar will be horizontal. Use this function to determine whether a toolbar is vertical.
15691 * @deprecated use elm_toolbar_horizontal_get() instead.
15693 EINA_DEPRECATED EAPI Eina_Bool elm_toolbar_orientation_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15696 * Get a toolbar's orientation
15697 * @param obj The toolbar object
15698 * @return If @c EINA_TRUE, the toolbar is horizontal
15699 * By default, a toolbar will be horizontal. Use this function to determine whether a toolbar is vertical.
15702 EAPI Eina_Bool elm_toolbar_horizontal_get(const Evas_Object *obj);
15708 * @defgroup Tooltips Tooltips
15710 * The Tooltip is an (internal, for now) smart object used to show a
15711 * content in a frame on mouse hover of objects(or widgets), with
15712 * tips/information about them.
15717 EAPI double elm_tooltip_delay_get(void);
15718 EAPI Eina_Bool elm_tooltip_delay_set(double delay);
15719 EAPI void elm_object_tooltip_show(Evas_Object *obj) EINA_ARG_NONNULL(1);
15720 EAPI void elm_object_tooltip_hide(Evas_Object *obj) EINA_ARG_NONNULL(1);
15721 EAPI void elm_object_tooltip_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1, 2);
15722 EAPI void elm_object_tooltip_domain_translatable_text_set(Evas_Object *obj, const char *domain, const char *text) EINA_ARG_NONNULL(1, 3);
15723 #define elm_object_tooltip_translatable_text_set(obj, text) elm_object_tooltip_domain_translatable_text_set((obj), NULL, (text))
15724 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);
15725 EAPI void elm_object_tooltip_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
15726 EAPI void elm_object_tooltip_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
15727 EAPI const char *elm_object_tooltip_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15728 EAPI Eina_Bool elm_tooltip_size_restrict_disable(Evas_Object *obj, Eina_Bool disable) EINA_ARG_NONNULL(1);
15729 EAPI Eina_Bool elm_tooltip_size_restrict_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15736 * @defgroup Cursors Cursors
15738 * The Elementary cursor is an internal smart object used to
15739 * customize the mouse cursor displayed over objects (or
15740 * widgets). In the most common scenario, the cursor decoration
15741 * comes from the graphical @b engine Elementary is running
15742 * on. Those engines may provide different decorations for cursors,
15743 * and Elementary provides functions to choose them (think of X11
15744 * cursors, as an example).
15746 * There's also the possibility of, besides using engine provided
15747 * cursors, also use ones coming from Edje theming files. Both
15748 * globally and per widget, Elementary makes it possible for one to
15749 * make the cursors lookup to be held on engines only or on
15750 * Elementary's theme file, too. To set cursor's hot spot,
15751 * two data items should be added to cursor's theme: "hot_x" and
15752 * "hot_y", that are the offset from upper-left corner of the cursor
15753 * (coordinates 0,0).
15759 * Set the cursor to be shown when mouse is over the object
15761 * Set the cursor that will be displayed when mouse is over the
15762 * object. The object can have only one cursor set to it, so if
15763 * this function is called twice for an object, the previous set
15765 * If using X cursors, a definition of all the valid cursor names
15766 * is listed on Elementary_Cursors.h. If an invalid name is set
15767 * the default cursor will be used.
15769 * @param obj the object being set a cursor.
15770 * @param cursor the cursor name to be used.
15774 EAPI void elm_object_cursor_set(Evas_Object *obj, const char *cursor) EINA_ARG_NONNULL(1);
15777 * Get the cursor to be shown when mouse is over the object
15779 * @param obj an object with cursor already set.
15780 * @return the cursor name.
15784 EAPI const char *elm_object_cursor_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15787 * Unset cursor for object
15789 * Unset cursor for object, and set the cursor to default if the mouse
15790 * was over this object.
15792 * @param obj Target object
15793 * @see elm_object_cursor_set()
15797 EAPI void elm_object_cursor_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
15800 * Sets a different style for this object cursor.
15802 * @note before you set a style you should define a cursor with
15803 * elm_object_cursor_set()
15805 * @param obj an object with cursor already set.
15806 * @param style the theme style to use (default, transparent, ...)
15810 EAPI void elm_object_cursor_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
15813 * Get the style for this object cursor.
15815 * @param obj an object with cursor already set.
15816 * @return style the theme style in use, defaults to "default". If the
15817 * object does not have a cursor set, then NULL is returned.
15821 EAPI const char *elm_object_cursor_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15824 * Set if the cursor set should be searched on the theme or should use
15825 * the provided by the engine, only.
15827 * @note before you set if should look on theme you should define a cursor
15828 * with elm_object_cursor_set(). By default it will only look for cursors
15829 * provided by the engine.
15831 * @param obj an object with cursor already set.
15832 * @param engine_only boolean to define it cursors should be looked only
15833 * between the provided by the engine or searched on widget's theme as well.
15837 EAPI void elm_object_cursor_engine_only_set(Evas_Object *obj, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
15840 * Get the cursor engine only usage for this object cursor.
15842 * @param obj an object with cursor already set.
15843 * @return engine_only boolean to define it cursors should be
15844 * looked only between the provided by the engine or searched on
15845 * widget's theme as well. If the object does not have a cursor
15846 * set, then EINA_FALSE is returned.
15850 EAPI Eina_Bool elm_object_cursor_engine_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15853 * Get the configured cursor engine only usage
15855 * This gets the globally configured exclusive usage of engine cursors.
15857 * @return 1 if only engine cursors should be used
15860 EAPI int elm_cursor_engine_only_get(void);
15863 * Set the configured cursor engine only usage
15865 * This sets the globally configured exclusive usage of engine cursors.
15866 * It won't affect cursors set before changing this value.
15868 * @param engine_only If 1 only engine cursors will be enabled, if 0 will
15869 * look for them on theme before.
15870 * @return EINA_TRUE if value is valid and setted (0 or 1)
15873 EAPI Eina_Bool elm_cursor_engine_only_set(int engine_only);
15880 * @defgroup Menu Menu
15882 * @image html img/widget/menu/preview-00.png
15883 * @image latex img/widget/menu/preview-00.eps
15885 * A menu is a list of items displayed above its parent. When the menu is
15886 * showing its parent is darkened. Each item can have a sub-menu. The menu
15887 * object can be used to display a menu on a right click event, in a toolbar,
15890 * Signals that you can add callbacks for are:
15891 * @li "clicked" - the user clicked the empty space in the menu to dismiss.
15893 * Default contents parts of the menu items that you can use for are:
15894 * @li "default" - A main content of the menu item
15896 * Default text parts of the menu items that you can use for are:
15897 * @li "default" - label in the menu item
15899 * @see @ref tutorial_menu
15904 * @brief Add a new menu to the parent
15906 * @param parent The parent object.
15907 * @return The new object or NULL if it cannot be created.
15909 EAPI Evas_Object *elm_menu_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
15911 * @brief Set the parent for the given menu widget
15913 * @param obj The menu object.
15914 * @param parent The new parent.
15916 EAPI void elm_menu_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
15918 * @brief Get the parent for the given menu widget
15920 * @param obj The menu object.
15921 * @return The parent.
15923 * @see elm_menu_parent_set()
15925 EAPI Evas_Object *elm_menu_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15927 * @brief Move the menu to a new position
15929 * @param obj The menu object.
15930 * @param x The new position.
15931 * @param y The new position.
15933 * Sets the top-left position of the menu to (@p x,@p y).
15935 * @note @p x and @p y coordinates are relative to parent.
15937 EAPI void elm_menu_move(Evas_Object *obj, Evas_Coord x, Evas_Coord y) EINA_ARG_NONNULL(1);
15939 * @brief Close a opened menu
15941 * @param obj the menu object
15944 * Hides the menu and all it's sub-menus.
15946 EAPI void elm_menu_close(Evas_Object *obj) EINA_ARG_NONNULL(1);
15948 * @brief Returns a list of @p item's items.
15950 * @param obj The menu object
15951 * @return An Eina_List* of @p item's items
15953 EAPI const Eina_List *elm_menu_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15955 * @brief Get the Evas_Object of an Elm_Object_Item
15957 * @param it The menu item object.
15958 * @return The edje object containing the swallowed content
15960 * @warning Don't manipulate this object!
15963 EAPI Evas_Object *elm_menu_item_object_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
15965 * @brief Add an item at the end of the given menu widget
15967 * @param obj The menu object.
15968 * @param parent The parent menu item (optional)
15969 * @param icon An icon display on the item. The icon will be destryed by the menu.
15970 * @param label The label of the item.
15971 * @param func Function called when the user select the item.
15972 * @param data Data sent by the callback.
15973 * @return Returns the new item.
15975 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);
15977 * @brief Add an object swallowed in an item at the end of the given menu
15980 * @param obj The menu object.
15981 * @param parent The parent menu item (optional)
15982 * @param subobj The object to swallow
15983 * @param func Function called when the user select the item.
15984 * @param data Data sent by the callback.
15985 * @return Returns the new item.
15987 * Add an evas object as an item to the menu.
15989 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);
15991 * @brief Set the label of a menu item
15993 * @param it The menu item object.
15994 * @param label The label to set for @p item
15996 * @warning Don't use this funcion on items created with
15997 * elm_menu_item_add_object() or elm_menu_item_separator_add().
15999 * @deprecated Use elm_object_item_text_set() instead
16001 EINA_DEPRECATED EAPI void elm_menu_item_label_set(Elm_Object_Item *it, const char *label) EINA_ARG_NONNULL(1);
16003 * @brief Get the label of a menu item
16005 * @param it The menu item object.
16006 * @return The label of @p item
16007 * @deprecated Use elm_object_item_text_get() instead
16009 EINA_DEPRECATED EAPI const char *elm_menu_item_label_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
16011 * @brief Set the icon of a menu item to the standard icon with name @p icon
16013 * @param it The menu item object.
16014 * @param icon The icon object to set for the content of @p item
16016 * Once this icon is set, any previously set icon will be deleted.
16018 EAPI void elm_menu_item_object_icon_name_set(Elm_Object_Item *it, const char *icon) EINA_ARG_NONNULL(1, 2);
16020 * @brief Get the string representation from the icon of a menu item
16022 * @param it The menu item object.
16023 * @return The string representation of @p item's icon or NULL
16025 * @see elm_menu_item_object_icon_name_set()
16027 EAPI const char *elm_menu_item_object_icon_name_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
16029 * @brief Set the content object of a menu item
16031 * @param it The menu item object
16032 * @param The content object or NULL
16033 * @return EINA_TRUE on success, else EINA_FALSE
16035 * Use this function to change the object swallowed by a menu item, deleting
16036 * any previously swallowed object.
16038 * @deprecated Use elm_object_item_content_set() instead
16040 EINA_DEPRECATED EAPI Eina_Bool elm_menu_item_object_content_set(Elm_Object_Item *it, Evas_Object *obj) EINA_ARG_NONNULL(1);
16042 * @brief Get the content object of a menu item
16044 * @param it The menu item object
16045 * @return The content object or NULL
16046 * @note If @p item was added with elm_menu_item_add_object, this
16047 * function will return the object passed, else it will return the
16050 * @see elm_menu_item_object_content_set()
16052 * @deprecated Use elm_object_item_content_get() instead
16054 EINA_DEPRECATED EAPI Evas_Object *elm_menu_item_object_content_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
16056 * @brief Set the selected state of @p item.
16058 * @param it The menu item object.
16059 * @param selected The selected/unselected state of the item
16061 EAPI void elm_menu_item_selected_set(Elm_Object_Item *it, Eina_Bool selected) EINA_ARG_NONNULL(1);
16063 * @brief Get the selected state of @p item.
16065 * @param it The menu item object.
16066 * @return The selected/unselected state of the item
16068 * @see elm_menu_item_selected_set()
16070 EAPI Eina_Bool elm_menu_item_selected_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
16072 * @brief Set the disabled state of @p item.
16074 * @param it The menu item object.
16075 * @param disabled The enabled/disabled state of the item
16076 * @deprecated Use elm_object_item_disabled_set() instead
16078 EINA_DEPRECATED EAPI void elm_menu_item_disabled_set(Elm_Object_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1);
16080 * @brief Get the disabled state of @p item.
16082 * @param it The menu item object.
16083 * @return The enabled/disabled state of the item
16085 * @see elm_menu_item_disabled_set()
16086 * @deprecated Use elm_object_item_disabled_get() instead
16088 EINA_DEPRECATED EAPI Eina_Bool elm_menu_item_disabled_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
16090 * @brief Add a separator item to menu @p obj under @p parent.
16092 * @param obj The menu object
16093 * @param parent The item to add the separator under
16094 * @return The created item or NULL on failure
16096 * This is item is a @ref Separator.
16098 EAPI Elm_Object_Item *elm_menu_item_separator_add(Evas_Object *obj, Elm_Object_Item *parent) EINA_ARG_NONNULL(1);
16100 * @brief Returns whether @p item is a separator.
16102 * @param it The item to check
16103 * @return If true, @p item is a separator
16105 * @see elm_menu_item_separator_add()
16107 EAPI Eina_Bool elm_menu_item_is_separator(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
16109 * @brief Deletes an item from the menu.
16111 * @param it The item to delete.
16113 * @see elm_menu_item_add()
16115 EAPI void elm_menu_item_del(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
16117 * @brief Set the function called when a menu item is deleted.
16119 * @param it The item to set the callback on
16120 * @param func The function called
16122 * @see elm_menu_item_add()
16123 * @see elm_menu_item_del()
16125 EAPI void elm_menu_item_del_cb_set(Elm_Object_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
16127 * @brief Returns the data associated with menu item @p item.
16129 * @param it The item
16130 * @return The data associated with @p item or NULL if none was set.
16132 * This is the data set with elm_menu_add() or elm_menu_item_data_set().
16134 * @deprecated Use elm_object_item_data_get() instead
16136 EINA_DEPRECATED EAPI void *elm_menu_item_data_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
16138 * @brief Sets the data to be associated with menu item @p item.
16140 * @param it The item
16141 * @param data The data to be associated with @p item
16143 * @deprecated Use elm_object_item_data_set() instead
16145 EINA_DEPRECATED EAPI void elm_menu_item_data_set(Elm_Object_Item *it, const void *data) EINA_ARG_NONNULL(1);
16148 * @brief Returns a list of @p item's subitems.
16150 * @param it The item
16151 * @return An Eina_List* of @p item's subitems
16153 * @see elm_menu_add()
16155 EAPI const Eina_List *elm_menu_item_subitems_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
16157 * @brief Get the position of a menu item
16159 * @param it The menu item
16160 * @return The item's index
16162 * This function returns the index position of a menu item in a menu.
16163 * For a sub-menu, this number is relative to the first item in the sub-menu.
16165 * @note Index values begin with 0
16167 EAPI unsigned int elm_menu_item_index_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1) EINA_PURE;
16169 * @brief @brief Return a menu item's owner menu
16171 * @param it The menu item
16172 * @return The menu object owning @p item, or NULL on failure
16174 * Use this function to get the menu object owning an item.
16176 EAPI Evas_Object *elm_menu_item_menu_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1) EINA_PURE;
16178 * @brief Get the selected item in the menu
16180 * @param obj The menu object
16181 * @return The selected item, or NULL if none
16183 * @see elm_menu_item_selected_get()
16184 * @see elm_menu_item_selected_set()
16186 EAPI Elm_Object_Item *elm_menu_selected_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
16188 * @brief Get the last item in the menu
16190 * @param obj The menu object
16191 * @return The last item, or NULL if none
16193 EAPI Elm_Object_Item *elm_menu_last_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
16195 * @brief Get the first item in the menu
16197 * @param obj The menu object
16198 * @return The first item, or NULL if none
16200 EAPI Elm_Object_Item *elm_menu_first_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
16202 * @brief Get the next item in the menu.
16204 * @param it The menu item object.
16205 * @return The item after it, or NULL if none
16207 EAPI Elm_Object_Item *elm_menu_item_next_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
16209 * @brief Get the previous item in the menu.
16211 * @param it The menu item object.
16212 * @return The item before it, or NULL if none
16214 EAPI Elm_Object_Item *elm_menu_item_prev_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
16220 * @defgroup List List
16221 * @ingroup Elementary
16223 * @image html img/widget/list/preview-00.png
16224 * @image latex img/widget/list/preview-00.eps width=\textwidth
16226 * @image html img/list.png
16227 * @image latex img/list.eps width=\textwidth
16229 * A list widget is a container whose children are displayed vertically or
16230 * horizontally, in order, and can be selected.
16231 * The list can accept only one or multiple items selection. Also has many
16232 * modes of items displaying.
16234 * A list is a very simple type of list widget. For more robust
16235 * lists, @ref Genlist should probably be used.
16237 * Smart callbacks one can listen to:
16238 * - @c "activated" - The user has double-clicked or pressed
16239 * (enter|return|spacebar) on an item. The @c event_info parameter
16240 * is the item that was activated.
16241 * - @c "clicked,double" - The user has double-clicked an item.
16242 * The @c event_info parameter is the item that was double-clicked.
16243 * - "selected" - when the user selected an item
16244 * - "unselected" - when the user unselected an item
16245 * - "longpressed" - an item in the list is long-pressed
16246 * - "edge,top" - the list is scrolled until the top edge
16247 * - "edge,bottom" - the list is scrolled until the bottom edge
16248 * - "edge,left" - the list is scrolled until the left edge
16249 * - "edge,right" - the list is scrolled until the right edge
16250 * - "language,changed" - the program's language changed
16252 * Available styles for it:
16255 * List of examples:
16256 * @li @ref list_example_01
16257 * @li @ref list_example_02
16258 * @li @ref list_example_03
16267 * @enum _Elm_List_Mode
16268 * @typedef Elm_List_Mode
16270 * Set list's resize behavior, transverse axis scroll and
16271 * items cropping. See each mode's description for more details.
16273 * @note Default value is #ELM_LIST_SCROLL.
16275 * Values <b> don't </b> work as bitmask, only one can be choosen.
16277 * @see elm_list_mode_set()
16278 * @see elm_list_mode_get()
16282 typedef enum _Elm_List_Mode
16284 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. */
16285 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). */
16286 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. */
16287 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. */
16288 ELM_LIST_LAST /**< Indicates error if returned by elm_list_mode_get() */
16291 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(). */
16294 * Add a new list widget to the given parent Elementary
16295 * (container) object.
16297 * @param parent The parent object.
16298 * @return a new list widget handle or @c NULL, on errors.
16300 * This function inserts a new list widget on the canvas.
16304 EAPI Evas_Object *elm_list_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
16309 * @param obj The list object
16311 * @note Call before running show() on the list object.
16312 * @warning If not called, it won't display the list properly.
16315 * li = elm_list_add(win);
16316 * elm_list_item_append(li, "First", NULL, NULL, NULL, NULL);
16317 * elm_list_item_append(li, "Second", NULL, NULL, NULL, NULL);
16319 * evas_object_show(li);
16324 EAPI void elm_list_go(Evas_Object *obj) EINA_ARG_NONNULL(1);
16327 * Enable or disable multiple items selection on the list object.
16329 * @param obj The list object
16330 * @param multi @c EINA_TRUE to enable multi selection or @c EINA_FALSE to
16333 * Disabled by default. If disabled, the user can select a single item of
16334 * the list each time. Selected items are highlighted on list.
16335 * If enabled, many items can be selected.
16337 * If a selected item is selected again, it will be unselected.
16339 * @see elm_list_multi_select_get()
16343 EAPI void elm_list_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
16346 * Get a value whether multiple items selection is enabled or not.
16348 * @see elm_list_multi_select_set() for details.
16350 * @param obj The list object.
16351 * @return @c EINA_TRUE means multiple items selection is enabled.
16352 * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
16353 * @c EINA_FALSE is returned.
16357 EAPI Eina_Bool elm_list_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16360 * Set which mode to use for the list object.
16362 * @param obj The list object
16363 * @param mode One of #Elm_List_Mode: #ELM_LIST_COMPRESS, #ELM_LIST_SCROLL,
16364 * #ELM_LIST_LIMIT or #ELM_LIST_EXPAND.
16366 * Set list's resize behavior, transverse axis scroll and
16367 * items cropping. See each mode's description for more details.
16369 * @note Default value is #ELM_LIST_SCROLL.
16371 * Only one can be set, if a previous one was set, it will be changed
16372 * by the new mode set. Bitmask won't work as well.
16374 * @see elm_list_mode_get()
16378 EAPI void elm_list_mode_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
16381 * Get the mode the list is at.
16383 * @param obj The list object
16384 * @return One of #Elm_List_Mode: #ELM_LIST_COMPRESS, #ELM_LIST_SCROLL,
16385 * #ELM_LIST_LIMIT, #ELM_LIST_EXPAND or #ELM_LIST_LAST on errors.
16387 * @note see elm_list_mode_set() for more information.
16391 EAPI Elm_List_Mode elm_list_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16394 * Enable or disable horizontal mode on the list object.
16396 * @param obj The list object.
16397 * @param horizontal @c EINA_TRUE to enable horizontal or @c EINA_FALSE to
16398 * disable it, i.e., to enable vertical mode.
16400 * @note Vertical mode is set by default.
16402 * On horizontal mode items are displayed on list from left to right,
16403 * instead of from top to bottom. Also, the list will scroll horizontally.
16404 * Each item will presents left icon on top and right icon, or end, at
16407 * @see elm_list_horizontal_get()
16411 EAPI void elm_list_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
16414 * Get a value whether horizontal mode is enabled or not.
16416 * @param obj The list object.
16417 * @return @c EINA_TRUE means horizontal mode selection is enabled.
16418 * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
16419 * @c EINA_FALSE is returned.
16421 * @see elm_list_horizontal_set() for details.
16425 EAPI Eina_Bool elm_list_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16428 * Enable or disable always select mode on the list object.
16430 * @param obj The list object
16431 * @param always_select @c EINA_TRUE to enable always select mode or
16432 * @c EINA_FALSE to disable it.
16434 * @note Always select mode is disabled by default.
16436 * Default behavior of list items is to only call its callback function
16437 * the first time it's pressed, i.e., when it is selected. If a selected
16438 * item is pressed again, and multi-select is disabled, it won't call
16439 * this function (if multi-select is enabled it will unselect the item).
16441 * If always select is enabled, it will call the callback function
16442 * everytime a item is pressed, so it will call when the item is selected,
16443 * and again when a selected item is pressed.
16445 * @see elm_list_always_select_mode_get()
16446 * @see elm_list_multi_select_set()
16450 EAPI void elm_list_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
16453 * Get a value whether always select mode is enabled or not, meaning that
16454 * an item will always call its callback function, even if already selected.
16456 * @param obj The list object
16457 * @return @c EINA_TRUE means horizontal mode selection is enabled.
16458 * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
16459 * @c EINA_FALSE is returned.
16461 * @see elm_list_always_select_mode_set() for details.
16465 EAPI Eina_Bool elm_list_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16468 * Set bouncing behaviour when the scrolled content reaches an edge.
16470 * Tell the internal scroller object whether it should bounce or not
16471 * when it reaches the respective edges for each axis.
16473 * @param obj The list object
16474 * @param h_bounce Whether to bounce or not in the horizontal axis.
16475 * @param v_bounce Whether to bounce or not in the vertical axis.
16477 * @see elm_scroller_bounce_set()
16481 EAPI void elm_list_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
16484 * Get the bouncing behaviour of the internal scroller.
16486 * Get whether the internal scroller should bounce when the edge of each
16487 * axis is reached scrolling.
16489 * @param obj The list object.
16490 * @param h_bounce Pointer where to store the bounce state of the horizontal
16492 * @param v_bounce Pointer where to store the bounce state of the vertical
16495 * @see elm_scroller_bounce_get()
16496 * @see elm_list_bounce_set()
16500 EAPI void elm_list_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
16503 * Set the scrollbar policy.
16505 * @param obj The list object
16506 * @param policy_h Horizontal scrollbar policy.
16507 * @param policy_v Vertical scrollbar policy.
16509 * This sets the scrollbar visibility policy for the given scroller.
16510 * #ELM_SCROLLER_POLICY_AUTO means the scrollbar is made visible if it
16511 * is needed, and otherwise kept hidden. #ELM_SCROLLER_POLICY_ON turns
16512 * it on all the time, and #ELM_SCROLLER_POLICY_OFF always keeps it off.
16513 * This applies respectively for the horizontal and vertical scrollbars.
16515 * The both are disabled by default, i.e., are set to
16516 * #ELM_SCROLLER_POLICY_OFF.
16520 EAPI void elm_list_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
16523 * Get the scrollbar policy.
16525 * @see elm_list_scroller_policy_get() for details.
16527 * @param obj The list object.
16528 * @param policy_h Pointer where to store horizontal scrollbar policy.
16529 * @param policy_v Pointer where to store vertical scrollbar policy.
16533 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);
16536 * Append a new item to the list object.
16538 * @param obj The list object.
16539 * @param label The label of the list item.
16540 * @param icon The icon object to use for the left side of the item. An
16541 * icon can be any Evas object, but usually it is an icon created
16542 * with elm_icon_add().
16543 * @param end The icon object to use for the right side of the item. An
16544 * icon can be any Evas object.
16545 * @param func The function to call when the item is clicked.
16546 * @param data The data to associate with the item for related callbacks.
16548 * @return The created item or @c NULL upon failure.
16550 * A new item will be created and appended to the list, i.e., will
16551 * be set as @b last item.
16553 * Items created with this method can be deleted with
16554 * elm_list_item_del().
16556 * Associated @p data can be properly freed when item is deleted if a
16557 * callback function is set with elm_list_item_del_cb_set().
16559 * If a function is passed as argument, it will be called everytime this item
16560 * is selected, i.e., the user clicks over an unselected item.
16561 * If always select is enabled it will call this function every time
16562 * user clicks over an item (already selected or not).
16563 * If such function isn't needed, just passing
16564 * @c NULL as @p func is enough. The same should be done for @p data.
16566 * Simple example (with no function callback or data associated):
16568 * li = elm_list_add(win);
16569 * ic = elm_icon_add(win);
16570 * elm_icon_file_set(ic, "path/to/image", NULL);
16571 * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
16572 * elm_list_item_append(li, "label", ic, NULL, NULL, NULL);
16574 * evas_object_show(li);
16577 * @see elm_list_always_select_mode_set()
16578 * @see elm_list_item_del()
16579 * @see elm_list_item_del_cb_set()
16580 * @see elm_list_clear()
16581 * @see elm_icon_add()
16585 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);
16588 * Prepend a new item to the list object.
16590 * @param obj The list object.
16591 * @param label The label of the list item.
16592 * @param icon The icon object to use for the left side of the item. An
16593 * icon can be any Evas object, but usually it is an icon created
16594 * with elm_icon_add().
16595 * @param end The icon object to use for the right side of the item. An
16596 * icon can be any Evas object.
16597 * @param func The function to call when the item is clicked.
16598 * @param data The data to associate with the item for related callbacks.
16600 * @return The created item or @c NULL upon failure.
16602 * A new item will be created and prepended to the list, i.e., will
16603 * be set as @b first item.
16605 * Items created with this method can be deleted with
16606 * elm_list_item_del().
16608 * Associated @p data can be properly freed when item is deleted if a
16609 * callback function is set with elm_list_item_del_cb_set().
16611 * If a function is passed as argument, it will be called everytime this item
16612 * is selected, i.e., the user clicks over an unselected item.
16613 * If always select is enabled it will call this function every time
16614 * user clicks over an item (already selected or not).
16615 * If such function isn't needed, just passing
16616 * @c NULL as @p func is enough. The same should be done for @p data.
16618 * @see elm_list_item_append() for a simple code example.
16619 * @see elm_list_always_select_mode_set()
16620 * @see elm_list_item_del()
16621 * @see elm_list_item_del_cb_set()
16622 * @see elm_list_clear()
16623 * @see elm_icon_add()
16627 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);
16630 * Insert a new item into the list object before item @p before.
16632 * @param obj The list object.
16633 * @param before The list item to insert before.
16634 * @param label The label of the list item.
16635 * @param icon The icon object to use for the left side of the item. An
16636 * icon can be any Evas object, but usually it is an icon created
16637 * with elm_icon_add().
16638 * @param end The icon object to use for the right side of the item. An
16639 * icon can be any Evas object.
16640 * @param func The function to call when the item is clicked.
16641 * @param data The data to associate with the item for related callbacks.
16643 * @return The created item or @c NULL upon failure.
16645 * A new item will be created and added to the list. Its position in
16646 * this list will be just before item @p before.
16648 * Items created with this method can be deleted with
16649 * elm_list_item_del().
16651 * Associated @p data can be properly freed when item is deleted if a
16652 * callback function is set with elm_list_item_del_cb_set().
16654 * If a function is passed as argument, it will be called everytime this item
16655 * is selected, i.e., the user clicks over an unselected item.
16656 * If always select is enabled it will call this function every time
16657 * user clicks over an item (already selected or not).
16658 * If such function isn't needed, just passing
16659 * @c NULL as @p func is enough. The same should be done for @p data.
16661 * @see elm_list_item_append() for a simple code example.
16662 * @see elm_list_always_select_mode_set()
16663 * @see elm_list_item_del()
16664 * @see elm_list_item_del_cb_set()
16665 * @see elm_list_clear()
16666 * @see elm_icon_add()
16670 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);
16673 * Insert a new item into the list object after item @p after.
16675 * @param obj The list object.
16676 * @param after The list item to insert after.
16677 * @param label The label of the list item.
16678 * @param icon The icon object to use for the left side of the item. An
16679 * icon can be any Evas object, but usually it is an icon created
16680 * with elm_icon_add().
16681 * @param end The icon object to use for the right side of the item. An
16682 * icon can be any Evas object.
16683 * @param func The function to call when the item is clicked.
16684 * @param data The data to associate with the item for related callbacks.
16686 * @return The created item or @c NULL upon failure.
16688 * A new item will be created and added to the list. Its position in
16689 * this list will be just after item @p after.
16691 * Items created with this method can be deleted with
16692 * elm_list_item_del().
16694 * Associated @p data can be properly freed when item is deleted if a
16695 * callback function is set with elm_list_item_del_cb_set().
16697 * If a function is passed as argument, it will be called everytime this item
16698 * is selected, i.e., the user clicks over an unselected item.
16699 * If always select is enabled it will call this function every time
16700 * user clicks over an item (already selected or not).
16701 * If such function isn't needed, just passing
16702 * @c NULL as @p func is enough. The same should be done for @p data.
16704 * @see elm_list_item_append() for a simple code example.
16705 * @see elm_list_always_select_mode_set()
16706 * @see elm_list_item_del()
16707 * @see elm_list_item_del_cb_set()
16708 * @see elm_list_clear()
16709 * @see elm_icon_add()
16713 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);
16716 * Insert a new item into the sorted list object.
16718 * @param obj The list object.
16719 * @param label The label of the list item.
16720 * @param icon The icon object to use for the left side of the item. An
16721 * icon can be any Evas object, but usually it is an icon created
16722 * with elm_icon_add().
16723 * @param end The icon object to use for the right side of the item. An
16724 * icon can be any Evas object.
16725 * @param func The function to call when the item is clicked.
16726 * @param data The data to associate with the item for related callbacks.
16727 * @param cmp_func The comparing function to be used to sort list
16728 * items <b>by #Elm_List_Item item handles</b>. This function will
16729 * receive two items and compare them, returning a non-negative integer
16730 * if the second item should be place after the first, or negative value
16731 * if should be placed before.
16733 * @return The created item or @c NULL upon failure.
16735 * @note This function inserts values into a list object assuming it was
16736 * sorted and the result will be sorted.
16738 * A new item will be created and added to the list. Its position in
16739 * this list will be found comparing the new item with previously inserted
16740 * items using function @p cmp_func.
16742 * Items created with this method can be deleted with
16743 * elm_list_item_del().
16745 * Associated @p data can be properly freed when item is deleted if a
16746 * callback function is set with elm_list_item_del_cb_set().
16748 * If a function is passed as argument, it will be called everytime this item
16749 * is selected, i.e., the user clicks over an unselected item.
16750 * If always select is enabled it will call this function every time
16751 * user clicks over an item (already selected or not).
16752 * If such function isn't needed, just passing
16753 * @c NULL as @p func is enough. The same should be done for @p data.
16755 * @see elm_list_item_append() for a simple code example.
16756 * @see elm_list_always_select_mode_set()
16757 * @see elm_list_item_del()
16758 * @see elm_list_item_del_cb_set()
16759 * @see elm_list_clear()
16760 * @see elm_icon_add()
16764 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);
16767 * Remove all list's items.
16769 * @param obj The list object
16771 * @see elm_list_item_del()
16772 * @see elm_list_item_append()
16776 EAPI void elm_list_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
16779 * Get a list of all the list items.
16781 * @param obj The list object
16782 * @return An @c Eina_List of list items, #Elm_List_Item,
16783 * or @c NULL on failure.
16785 * @see elm_list_item_append()
16786 * @see elm_list_item_del()
16787 * @see elm_list_clear()
16791 EAPI const Eina_List *elm_list_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16794 * Get the selected item.
16796 * @param obj The list object.
16797 * @return The selected list item.
16799 * The selected item can be unselected with function
16800 * elm_list_item_selected_set().
16802 * The selected item always will be highlighted on list.
16804 * @see elm_list_selected_items_get()
16808 EAPI Elm_List_Item *elm_list_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16811 * Return a list of the currently selected list items.
16813 * @param obj The list object.
16814 * @return An @c Eina_List of list items, #Elm_List_Item,
16815 * or @c NULL on failure.
16817 * Multiple items can be selected if multi select is enabled. It can be
16818 * done with elm_list_multi_select_set().
16820 * @see elm_list_selected_item_get()
16821 * @see elm_list_multi_select_set()
16825 EAPI const Eina_List *elm_list_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16828 * Set the selected state of an item.
16830 * @param item The list item
16831 * @param selected The selected state
16833 * This sets the selected state of the given item @p it.
16834 * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
16836 * If a new item is selected the previosly selected will be unselected,
16837 * unless multiple selection is enabled with elm_list_multi_select_set().
16838 * Previoulsy selected item can be get with function
16839 * elm_list_selected_item_get().
16841 * Selected items will be highlighted.
16843 * @see elm_list_item_selected_get()
16844 * @see elm_list_selected_item_get()
16845 * @see elm_list_multi_select_set()
16849 EAPI void elm_list_item_selected_set(Elm_List_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
16852 * Get whether the @p item is selected or not.
16854 * @param item The list item.
16855 * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
16856 * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
16858 * @see elm_list_selected_item_set() for details.
16859 * @see elm_list_item_selected_get()
16863 EAPI Eina_Bool elm_list_item_selected_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16866 * Set or unset item as a separator.
16868 * @param it The list item.
16869 * @param setting @c EINA_TRUE to set item @p it as separator or
16870 * @c EINA_FALSE to unset, i.e., item will be used as a regular item.
16872 * Items aren't set as separator by default.
16874 * If set as separator it will display separator theme, so won't display
16877 * @see elm_list_item_separator_get()
16881 EAPI void elm_list_item_separator_set(Elm_List_Item *it, Eina_Bool setting) EINA_ARG_NONNULL(1);
16884 * Get a value whether item is a separator or not.
16886 * @see elm_list_item_separator_set() for details.
16888 * @param it The list item.
16889 * @return @c EINA_TRUE means item @p it is a separator. @c EINA_FALSE
16890 * indicates it's not. If @p it is @c NULL, @c EINA_FALSE is returned.
16894 EAPI Eina_Bool elm_list_item_separator_get(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
16897 * Show @p item in the list view.
16899 * @param item The list item to be shown.
16901 * It won't animate list until item is visible. If such behavior is wanted,
16902 * use elm_list_bring_in() intead.
16906 EAPI void elm_list_item_show(Elm_List_Item *item) EINA_ARG_NONNULL(1);
16909 * Bring in the given item to list view.
16911 * @param item The item.
16913 * This causes list to jump to the given item @p item and show it
16914 * (by scrolling), if it is not fully visible.
16916 * This may use animation to do so and take a period of time.
16918 * If animation isn't wanted, elm_list_item_show() can be used.
16922 EAPI void elm_list_item_bring_in(Elm_List_Item *item) EINA_ARG_NONNULL(1);
16925 * Delete them item from the list.
16927 * @param item The item of list to be deleted.
16929 * If deleting all list items is required, elm_list_clear()
16930 * should be used instead of getting items list and deleting each one.
16932 * @see elm_list_clear()
16933 * @see elm_list_item_append()
16934 * @see elm_list_item_del_cb_set()
16938 EAPI void elm_list_item_del(Elm_List_Item *item) EINA_ARG_NONNULL(1);
16941 * Set the function called when a list item is freed.
16943 * @param item The item to set the callback on
16944 * @param func The function called
16946 * If there is a @p func, then it will be called prior item's memory release.
16947 * That will be called with the following arguments:
16949 * @li item's Evas object;
16952 * This way, a data associated to a list item could be properly freed.
16956 EAPI void elm_list_item_del_cb_set(Elm_List_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
16959 * Get the data associated to the item.
16961 * @param item The list item
16962 * @return The data associated to @p item
16964 * The return value is a pointer to data associated to @p item when it was
16965 * created, with function elm_list_item_append() or similar. If no data
16966 * was passed as argument, it will return @c NULL.
16968 * @see elm_list_item_append()
16972 EAPI void *elm_list_item_data_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16975 * Get the left side icon associated to the item.
16977 * @param item The list item
16978 * @return The left side icon associated to @p item
16980 * The return value is a pointer to the icon associated to @p item when
16982 * created, with function elm_list_item_append() or similar, or later
16983 * with function elm_list_item_icon_set(). If no icon
16984 * was passed as argument, it will return @c NULL.
16986 * @see elm_list_item_append()
16987 * @see elm_list_item_icon_set()
16991 EAPI Evas_Object *elm_list_item_icon_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16994 * Set the left side icon associated to the item.
16996 * @param item The list item
16997 * @param icon The left side icon object to associate with @p item
16999 * The icon object to use at left side of the item. An
17000 * icon can be any Evas object, but usually it is an icon created
17001 * with elm_icon_add().
17003 * Once the icon object is set, a previously set one will be deleted.
17004 * @warning Setting the same icon for two items will cause the icon to
17005 * dissapear from the first item.
17007 * If an icon was passed as argument on item creation, with function
17008 * elm_list_item_append() or similar, it will be already
17009 * associated to the item.
17011 * @see elm_list_item_append()
17012 * @see elm_list_item_icon_get()
17016 EAPI void elm_list_item_icon_set(Elm_List_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
17019 * Get the right side icon associated to the item.
17021 * @param item The list item
17022 * @return The right side icon associated to @p item
17024 * The return value is a pointer to the icon associated to @p item when
17026 * created, with function elm_list_item_append() or similar, or later
17027 * with function elm_list_item_icon_set(). If no icon
17028 * was passed as argument, it will return @c NULL.
17030 * @see elm_list_item_append()
17031 * @see elm_list_item_icon_set()
17035 EAPI Evas_Object *elm_list_item_end_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17038 * Set the right side icon associated to the item.
17040 * @param item The list item
17041 * @param end The right side icon object to associate with @p item
17043 * The icon object to use at right side of the item. An
17044 * icon can be any Evas object, but usually it is an icon created
17045 * with elm_icon_add().
17047 * Once the icon object is set, a previously set one will be deleted.
17048 * @warning Setting the same icon for two items will cause the icon to
17049 * dissapear from the first item.
17051 * If an icon was passed as argument on item creation, with function
17052 * elm_list_item_append() or similar, it will be already
17053 * associated to the item.
17055 * @see elm_list_item_append()
17056 * @see elm_list_item_end_get()
17060 EAPI void elm_list_item_end_set(Elm_List_Item *item, Evas_Object *end) EINA_ARG_NONNULL(1);
17063 * Gets the base object of the item.
17065 * @param item The list item
17066 * @return The base object associated with @p item
17068 * Base object is the @c Evas_Object that represents that item.
17072 EAPI Evas_Object *elm_list_item_object_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17073 EINA_DEPRECATED EAPI Evas_Object *elm_list_item_base_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17076 * Get the label of item.
17078 * @param item The item of list.
17079 * @return The label of item.
17081 * The return value is a pointer to the label associated to @p item when
17082 * it was created, with function elm_list_item_append(), or later
17083 * with function elm_list_item_label_set. If no label
17084 * was passed as argument, it will return @c NULL.
17086 * @see elm_list_item_label_set() for more details.
17087 * @see elm_list_item_append()
17091 EAPI const char *elm_list_item_label_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17094 * Set the label of item.
17096 * @param item The item of list.
17097 * @param text The label of item.
17099 * The label to be displayed by the item.
17100 * Label will be placed between left and right side icons (if set).
17102 * If a label was passed as argument on item creation, with function
17103 * elm_list_item_append() or similar, it will be already
17104 * displayed by the item.
17106 * @see elm_list_item_label_get()
17107 * @see elm_list_item_append()
17111 EAPI void elm_list_item_label_set(Elm_List_Item *item, const char *text) EINA_ARG_NONNULL(1);
17115 * Get the item before @p it in list.
17117 * @param it The list item.
17118 * @return The item before @p it, or @c NULL if none or on failure.
17120 * @note If it is the first item, @c NULL will be returned.
17122 * @see elm_list_item_append()
17123 * @see elm_list_items_get()
17127 EAPI Elm_List_Item *elm_list_item_prev(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
17130 * Get the item after @p it in list.
17132 * @param it The list item.
17133 * @return The item after @p it, or @c NULL if none or on failure.
17135 * @note If it is the last item, @c NULL will be returned.
17137 * @see elm_list_item_append()
17138 * @see elm_list_items_get()
17142 EAPI Elm_List_Item *elm_list_item_next(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
17145 * Sets the disabled/enabled state of a list item.
17147 * @param it The item.
17148 * @param disabled The disabled state.
17150 * A disabled item cannot be selected or unselected. It will also
17151 * change its appearance (generally greyed out). This sets the
17152 * disabled state (@c EINA_TRUE for disabled, @c EINA_FALSE for
17157 EAPI void elm_list_item_disabled_set(Elm_List_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1);
17160 * Get a value whether list item is disabled or not.
17162 * @param it The item.
17163 * @return The disabled state.
17165 * @see elm_list_item_disabled_set() for more details.
17169 EAPI Eina_Bool elm_list_item_disabled_get(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
17172 * Set the text to be shown in a given list item's tooltips.
17174 * @param item Target item.
17175 * @param text The text to set in the content.
17177 * Setup the text as tooltip to object. The item can have only one tooltip,
17178 * so any previous tooltip data - set with this function or
17179 * elm_list_item_tooltip_content_cb_set() - is removed.
17181 * @see elm_object_tooltip_text_set() for more details.
17185 EAPI void elm_list_item_tooltip_text_set(Elm_List_Item *item, const char *text) EINA_ARG_NONNULL(1);
17189 * @brief Disable size restrictions on an object's tooltip
17190 * @param item The tooltip's anchor object
17191 * @param disable If EINA_TRUE, size restrictions are disabled
17192 * @return EINA_FALSE on failure, EINA_TRUE on success
17194 * This function allows a tooltip to expand beyond its parant window's canvas.
17195 * It will instead be limited only by the size of the display.
17197 EAPI Eina_Bool elm_list_item_tooltip_size_restrict_disable(Elm_List_Item *item, Eina_Bool disable) EINA_ARG_NONNULL(1);
17199 * @brief Retrieve size restriction state of an object's tooltip
17200 * @param obj The tooltip's anchor object
17201 * @return If EINA_TRUE, size restrictions are disabled
17203 * This function returns whether a tooltip is allowed to expand beyond
17204 * its parant window's canvas.
17205 * It will instead be limited only by the size of the display.
17207 EAPI Eina_Bool elm_list_item_tooltip_size_restrict_disabled_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17210 * Set the content to be shown in the tooltip item.
17212 * Setup the tooltip to item. The item can have only one tooltip,
17213 * so any previous tooltip data is removed. @p func(with @p data) will
17214 * be called every time that need show the tooltip and it should
17215 * return a valid Evas_Object. This object is then managed fully by
17216 * tooltip system and is deleted when the tooltip is gone.
17218 * @param item the list item being attached a tooltip.
17219 * @param func the function used to create the tooltip contents.
17220 * @param data what to provide to @a func as callback data/context.
17221 * @param del_cb called when data is not needed anymore, either when
17222 * another callback replaces @a func, the tooltip is unset with
17223 * elm_list_item_tooltip_unset() or the owner @a item
17224 * dies. This callback receives as the first parameter the
17225 * given @a data, and @c event_info is the item.
17227 * @see elm_object_tooltip_content_cb_set() for more details.
17231 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);
17234 * Unset tooltip from item.
17236 * @param item list item to remove previously set tooltip.
17238 * Remove tooltip from item. The callback provided as del_cb to
17239 * elm_list_item_tooltip_content_cb_set() will be called to notify
17240 * it is not used anymore.
17242 * @see elm_object_tooltip_unset() for more details.
17243 * @see elm_list_item_tooltip_content_cb_set()
17247 EAPI void elm_list_item_tooltip_unset(Elm_List_Item *item) EINA_ARG_NONNULL(1);
17250 * Sets a different style for this item tooltip.
17252 * @note before you set a style you should define a tooltip with
17253 * elm_list_item_tooltip_content_cb_set() or
17254 * elm_list_item_tooltip_text_set()
17256 * @param item list item with tooltip already set.
17257 * @param style the theme style to use (default, transparent, ...)
17259 * @see elm_object_tooltip_style_set() for more details.
17263 EAPI void elm_list_item_tooltip_style_set(Elm_List_Item *item, const char *style) EINA_ARG_NONNULL(1);
17266 * Get the style for this item tooltip.
17268 * @param item list item with tooltip already set.
17269 * @return style the theme style in use, defaults to "default". If the
17270 * object does not have a tooltip set, then NULL is returned.
17272 * @see elm_object_tooltip_style_get() for more details.
17273 * @see elm_list_item_tooltip_style_set()
17277 EAPI const char *elm_list_item_tooltip_style_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17280 * Set the type of mouse pointer/cursor decoration to be shown,
17281 * when the mouse pointer is over the given list widget item
17283 * @param item list item to customize cursor on
17284 * @param cursor the cursor type's name
17286 * This function works analogously as elm_object_cursor_set(), but
17287 * here the cursor's changing area is restricted to the item's
17288 * area, and not the whole widget's. Note that that item cursors
17289 * have precedence over widget cursors, so that a mouse over an
17290 * item with custom cursor set will always show @b that cursor.
17292 * If this function is called twice for an object, a previously set
17293 * cursor will be unset on the second call.
17295 * @see elm_object_cursor_set()
17296 * @see elm_list_item_cursor_get()
17297 * @see elm_list_item_cursor_unset()
17301 EAPI void elm_list_item_cursor_set(Elm_List_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
17304 * Get the type of mouse pointer/cursor decoration set to be shown,
17305 * when the mouse pointer is over the given list widget item
17307 * @param item list item with custom cursor set
17308 * @return the cursor type's name or @c NULL, if no custom cursors
17309 * were set to @p item (and on errors)
17311 * @see elm_object_cursor_get()
17312 * @see elm_list_item_cursor_set()
17313 * @see elm_list_item_cursor_unset()
17317 EAPI const char *elm_list_item_cursor_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17320 * Unset any custom mouse pointer/cursor decoration set to be
17321 * shown, when the mouse pointer is over the given list widget
17322 * item, thus making it show the @b default cursor again.
17324 * @param item a list item
17326 * Use this call to undo any custom settings on this item's cursor
17327 * decoration, bringing it back to defaults (no custom style set).
17329 * @see elm_object_cursor_unset()
17330 * @see elm_list_item_cursor_set()
17334 EAPI void elm_list_item_cursor_unset(Elm_List_Item *item) EINA_ARG_NONNULL(1);
17337 * Set a different @b style for a given custom cursor set for a
17340 * @param item list item with custom cursor set
17341 * @param style the <b>theme style</b> to use (e.g. @c "default",
17342 * @c "transparent", etc)
17344 * This function only makes sense when one is using custom mouse
17345 * cursor decorations <b>defined in a theme file</b>, which can have,
17346 * given a cursor name/type, <b>alternate styles</b> on it. It
17347 * works analogously as elm_object_cursor_style_set(), but here
17348 * applyed only to list item objects.
17350 * @warning Before you set a cursor style you should have definen a
17351 * custom cursor previously on the item, with
17352 * elm_list_item_cursor_set()
17354 * @see elm_list_item_cursor_engine_only_set()
17355 * @see elm_list_item_cursor_style_get()
17359 EAPI void elm_list_item_cursor_style_set(Elm_List_Item *item, const char *style) EINA_ARG_NONNULL(1);
17362 * Get the current @b style set for a given list item's custom
17365 * @param item list item with custom cursor set.
17366 * @return style the cursor style in use. If the object does not
17367 * have a cursor set, then @c NULL is returned.
17369 * @see elm_list_item_cursor_style_set() for more details
17373 EAPI const char *elm_list_item_cursor_style_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17376 * Set if the (custom)cursor for a given list item should be
17377 * searched in its theme, also, or should only rely on the
17378 * rendering engine.
17380 * @param item item with custom (custom) cursor already set on
17381 * @param engine_only Use @c EINA_TRUE to have cursors looked for
17382 * only on those provided by the rendering engine, @c EINA_FALSE to
17383 * have them searched on the widget's theme, as well.
17385 * @note This call is of use only if you've set a custom cursor
17386 * for list items, with elm_list_item_cursor_set().
17388 * @note By default, cursors will only be looked for between those
17389 * provided by the rendering engine.
17393 EAPI void elm_list_item_cursor_engine_only_set(Elm_List_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
17396 * Get if the (custom) cursor for a given list item is being
17397 * searched in its theme, also, or is only relying on the rendering
17400 * @param item a list item
17401 * @return @c EINA_TRUE, if cursors are being looked for only on
17402 * those provided by the rendering engine, @c EINA_FALSE if they
17403 * are being searched on the widget's theme, as well.
17405 * @see elm_list_item_cursor_engine_only_set(), for more details
17409 EAPI Eina_Bool elm_list_item_cursor_engine_only_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17416 * @defgroup Slider Slider
17417 * @ingroup Elementary
17419 * @image html img/widget/slider/preview-00.png
17420 * @image latex img/widget/slider/preview-00.eps width=\textwidth
17422 * The slider adds a dragable āsliderā widget for selecting the value of
17423 * something within a range.
17425 * A slider can be horizontal or vertical. It can contain an Icon and has a
17426 * primary label as well as a units label (that is formatted with floating
17427 * point values and thus accepts a printf-style format string, like
17428 * ā%1.2f unitsā. There is also an indicator string that may be somewhere
17429 * else (like on the slider itself) that also accepts a format string like
17430 * units. Label, Icon Unit and Indicator strings/objects are optional.
17432 * A slider may be inverted which means values invert, with high vales being
17433 * on the left or top and low values on the right or bottom (as opposed to
17434 * normally being low on the left or top and high on the bottom and right).
17436 * The slider should have its minimum and maximum values set by the
17437 * application with elm_slider_min_max_set() and value should also be set by
17438 * the application before use with elm_slider_value_set(). The span of the
17439 * slider is its length (horizontally or vertically). This will be scaled by
17440 * the object or applications scaling factor. At any point code can query the
17441 * slider for its value with elm_slider_value_get().
17443 * Smart callbacks one can listen to:
17444 * - "changed" - Whenever the slider value is changed by the user.
17445 * - "slider,drag,start" - dragging the slider indicator around has started.
17446 * - "slider,drag,stop" - dragging the slider indicator around has stopped.
17447 * - "delay,changed" - A short time after the value is changed by the user.
17448 * This will be called only when the user stops dragging for
17449 * a very short period or when they release their
17450 * finger/mouse, so it avoids possibly expensive reactions to
17451 * the value change.
17453 * Available styles for it:
17456 * Default contents parts of the slider widget that you can use for are:
17457 * @li "icon" - An icon of the slider
17458 * @li "end" - A end part content of the slider
17460 * Default text parts of the silder widget that you can use for are:
17461 * @li "default" - Label of the silder
17462 * Here is an example on its usage:
17463 * @li @ref slider_example
17467 * @addtogroup Slider
17472 * Add a new slider widget to the given parent Elementary
17473 * (container) object.
17475 * @param parent The parent object.
17476 * @return a new slider widget handle or @c NULL, on errors.
17478 * This function inserts a new slider widget on the canvas.
17482 EAPI Evas_Object *elm_slider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
17485 * Set the label of a given slider widget
17487 * @param obj The progress bar object
17488 * @param label The text label string, in UTF-8
17491 * @deprecated use elm_object_text_set() instead.
17493 EINA_DEPRECATED EAPI void elm_slider_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
17496 * Get the label of a given slider widget
17498 * @param obj The progressbar object
17499 * @return The text label string, in UTF-8
17502 * @deprecated use elm_object_text_get() instead.
17504 EINA_DEPRECATED EAPI const char *elm_slider_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17507 * Set the icon object of the slider object.
17509 * @param obj The slider object.
17510 * @param icon The icon object.
17512 * On horizontal mode, icon is placed at left, and on vertical mode,
17515 * @note Once the icon object is set, a previously set one will be deleted.
17516 * If you want to keep that old content object, use the
17517 * elm_slider_icon_unset() function.
17519 * @warning If the object being set does not have minimum size hints set,
17520 * it won't get properly displayed.
17523 * @deprecated use elm_object_part_content_set() instead.
17525 EINA_DEPRECATED EAPI void elm_slider_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
17528 * Unset an icon set on a given slider widget.
17530 * @param obj The slider object.
17531 * @return The icon object that was being used, if any was set, or
17532 * @c NULL, otherwise (and on errors).
17534 * On horizontal mode, icon is placed at left, and on vertical mode,
17537 * This call will unparent and return the icon object which was set
17538 * for this widget, previously, on success.
17540 * @see elm_slider_icon_set() for more details
17541 * @see elm_slider_icon_get()
17542 * @deprecated use elm_object_part_content_unset() instead.
17546 EINA_DEPRECATED EAPI Evas_Object *elm_slider_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
17549 * Retrieve the icon object set for a given slider widget.
17551 * @param obj The slider object.
17552 * @return The icon object's handle, if @p obj had one set, or @c NULL,
17553 * otherwise (and on errors).
17555 * On horizontal mode, icon is placed at left, and on vertical mode,
17558 * @see elm_slider_icon_set() for more details
17559 * @see elm_slider_icon_unset()
17561 * @deprecated use elm_object_part_content_get() instead.
17565 EINA_DEPRECATED EAPI Evas_Object *elm_slider_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17568 * Set the end object of the slider object.
17570 * @param obj The slider object.
17571 * @param end The end object.
17573 * On horizontal mode, end is placed at left, and on vertical mode,
17574 * placed at bottom.
17576 * @note Once the icon object is set, a previously set one will be deleted.
17577 * If you want to keep that old content object, use the
17578 * elm_slider_end_unset() function.
17580 * @warning If the object being set does not have minimum size hints set,
17581 * it won't get properly displayed.
17583 * @deprecated use elm_object_part_content_set() instead.
17587 EINA_DEPRECATED EAPI void elm_slider_end_set(Evas_Object *obj, Evas_Object *end) EINA_ARG_NONNULL(1);
17590 * Unset an end object set on a given slider widget.
17592 * @param obj The slider object.
17593 * @return The end object that was being used, if any was set, or
17594 * @c NULL, otherwise (and on errors).
17596 * On horizontal mode, end is placed at left, and on vertical mode,
17597 * placed at bottom.
17599 * This call will unparent and return the icon object which was set
17600 * for this widget, previously, on success.
17602 * @see elm_slider_end_set() for more details.
17603 * @see elm_slider_end_get()
17605 * @deprecated use elm_object_part_content_unset() instead
17610 EINA_DEPRECATED EAPI Evas_Object *elm_slider_end_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
17613 * Retrieve the end object set for a given slider widget.
17615 * @param obj The slider object.
17616 * @return The end object's handle, if @p obj had one set, or @c NULL,
17617 * otherwise (and on errors).
17619 * On horizontal mode, icon is placed at right, and on vertical mode,
17620 * placed at bottom.
17622 * @see elm_slider_end_set() for more details.
17623 * @see elm_slider_end_unset()
17626 * @deprecated use elm_object_part_content_get() instead
17631 EINA_DEPRECATED EAPI Evas_Object *elm_slider_end_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17634 * Set the (exact) length of the bar region of a given slider widget.
17636 * @param obj The slider object.
17637 * @param size The length of the slider's bar region.
17639 * This sets the minimum width (when in horizontal mode) or height
17640 * (when in vertical mode) of the actual bar area of the slider
17641 * @p obj. This in turn affects the object's minimum size. Use
17642 * this when you're not setting other size hints expanding on the
17643 * given direction (like weight and alignment hints) and you would
17644 * like it to have a specific size.
17646 * @note Icon, end, label, indicator and unit text around @p obj
17647 * will require their
17648 * own space, which will make @p obj to require more the @p size,
17651 * @see elm_slider_span_size_get()
17655 EAPI void elm_slider_span_size_set(Evas_Object *obj, Evas_Coord size) EINA_ARG_NONNULL(1);
17658 * Get the length set for the bar region of a given slider widget
17660 * @param obj The slider object.
17661 * @return The length of the slider's bar region.
17663 * If that size was not set previously, with
17664 * elm_slider_span_size_set(), this call will return @c 0.
17668 EAPI Evas_Coord elm_slider_span_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17671 * Set the format string for the unit label.
17673 * @param obj The slider object.
17674 * @param format The format string for the unit display.
17676 * Unit label is displayed all the time, if set, after slider's bar.
17677 * In horizontal mode, at right and in vertical mode, at bottom.
17679 * If @c NULL, unit label won't be visible. If not it sets the format
17680 * string for the label text. To the label text is provided a floating point
17681 * value, so the label text can display up to 1 floating point value.
17682 * Note that this is optional.
17684 * Use a format string such as "%1.2f meters" for example, and it will
17685 * display values like: "3.14 meters" for a value equal to 3.14159.
17687 * Default is unit label disabled.
17689 * @see elm_slider_indicator_format_get()
17693 EAPI void elm_slider_unit_format_set(Evas_Object *obj, const char *format) EINA_ARG_NONNULL(1);
17696 * Get the unit label format of the slider.
17698 * @param obj The slider object.
17699 * @return The unit label format string in UTF-8.
17701 * Unit label is displayed all the time, if set, after slider's bar.
17702 * In horizontal mode, at right and in vertical mode, at bottom.
17704 * @see elm_slider_unit_format_set() for more
17705 * information on how this works.
17709 EAPI const char *elm_slider_unit_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17712 * Set the format string for the indicator label.
17714 * @param obj The slider object.
17715 * @param indicator The format string for the indicator display.
17717 * The slider may display its value somewhere else then unit label,
17718 * for example, above the slider knob that is dragged around. This function
17719 * sets the format string used for this.
17721 * If @c NULL, indicator label won't be visible. If not it sets the format
17722 * string for the label text. To the label text is provided a floating point
17723 * value, so the label text can display up to 1 floating point value.
17724 * Note that this is optional.
17726 * Use a format string such as "%1.2f meters" for example, and it will
17727 * display values like: "3.14 meters" for a value equal to 3.14159.
17729 * Default is indicator label disabled.
17731 * @see elm_slider_indicator_format_get()
17735 EAPI void elm_slider_indicator_format_set(Evas_Object *obj, const char *indicator) EINA_ARG_NONNULL(1);
17738 * Get the indicator label format of the slider.
17740 * @param obj The slider object.
17741 * @return The indicator label format string in UTF-8.
17743 * The slider may display its value somewhere else then unit label,
17744 * for example, above the slider knob that is dragged around. This function
17745 * gets the format string used for this.
17747 * @see elm_slider_indicator_format_set() for more
17748 * information on how this works.
17752 EAPI const char *elm_slider_indicator_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17755 * Set the format function pointer for the indicator label
17757 * @param obj The slider object.
17758 * @param func The indicator format function.
17759 * @param free_func The freeing function for the format string.
17761 * Set the callback function to format the indicator string.
17763 * @see elm_slider_indicator_format_set() for more info on how this works.
17767 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);
17770 * Set the format function pointer for the units label
17772 * @param obj The slider object.
17773 * @param func The units format function.
17774 * @param free_func The freeing function for the format string.
17776 * Set the callback function to format the indicator string.
17778 * @see elm_slider_units_format_set() for more info on how this works.
17782 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);
17785 * Set the orientation of a given slider widget.
17787 * @param obj The slider object.
17788 * @param horizontal Use @c EINA_TRUE to make @p obj to be
17789 * @b horizontal, @c EINA_FALSE to make it @b vertical.
17791 * Use this function to change how your slider is to be
17792 * disposed: vertically or horizontally.
17794 * By default it's displayed horizontally.
17796 * @see elm_slider_horizontal_get()
17800 EAPI void elm_slider_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
17803 * Retrieve the orientation of a given slider widget
17805 * @param obj The slider object.
17806 * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
17807 * @c EINA_FALSE if it's @b vertical (and on errors).
17809 * @see elm_slider_horizontal_set() for more details.
17813 EAPI Eina_Bool elm_slider_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17816 * Set the minimum and maximum values for the slider.
17818 * @param obj The slider object.
17819 * @param min The minimum value.
17820 * @param max The maximum value.
17822 * Define the allowed range of values to be selected by the user.
17824 * If actual value is less than @p min, it will be updated to @p min. If it
17825 * is bigger then @p max, will be updated to @p max. Actual value can be
17826 * get with elm_slider_value_get().
17828 * By default, min is equal to 0.0, and max is equal to 1.0.
17830 * @warning Maximum must be greater than minimum, otherwise behavior
17833 * @see elm_slider_min_max_get()
17837 EAPI void elm_slider_min_max_set(Evas_Object *obj, double min, double max) EINA_ARG_NONNULL(1);
17840 * Get the minimum and maximum values of the slider.
17842 * @param obj The slider object.
17843 * @param min Pointer where to store the minimum value.
17844 * @param max Pointer where to store the maximum value.
17846 * @note If only one value is needed, the other pointer can be passed
17849 * @see elm_slider_min_max_set() for details.
17853 EAPI void elm_slider_min_max_get(const Evas_Object *obj, double *min, double *max) EINA_ARG_NONNULL(1);
17856 * Set the value the slider displays.
17858 * @param obj The slider object.
17859 * @param val The value to be displayed.
17861 * Value will be presented on the unit label following format specified with
17862 * elm_slider_unit_format_set() and on indicator with
17863 * elm_slider_indicator_format_set().
17865 * @warning The value must to be between min and max values. This values
17866 * are set by elm_slider_min_max_set().
17868 * @see elm_slider_value_get()
17869 * @see elm_slider_unit_format_set()
17870 * @see elm_slider_indicator_format_set()
17871 * @see elm_slider_min_max_set()
17875 EAPI void elm_slider_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
17878 * Get the value displayed by the spinner.
17880 * @param obj The spinner object.
17881 * @return The value displayed.
17883 * @see elm_spinner_value_set() for details.
17887 EAPI double elm_slider_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17890 * Invert a given slider widget's displaying values order
17892 * @param obj The slider object.
17893 * @param inverted Use @c EINA_TRUE to make @p obj inverted,
17894 * @c EINA_FALSE to bring it back to default, non-inverted values.
17896 * A slider may be @b inverted, in which state it gets its
17897 * values inverted, with high vales being on the left or top and
17898 * low values on the right or bottom, as opposed to normally have
17899 * the low values on the former and high values on the latter,
17900 * respectively, for horizontal and vertical modes.
17902 * @see elm_slider_inverted_get()
17906 EAPI void elm_slider_inverted_set(Evas_Object *obj, Eina_Bool inverted) EINA_ARG_NONNULL(1);
17909 * Get whether a given slider widget's displaying values are
17912 * @param obj The slider object.
17913 * @return @c EINA_TRUE, if @p obj has inverted values,
17914 * @c EINA_FALSE otherwise (and on errors).
17916 * @see elm_slider_inverted_set() for more details.
17920 EAPI Eina_Bool elm_slider_inverted_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17923 * Set whether to enlarge slider indicator (augmented knob) or not.
17925 * @param obj The slider object.
17926 * @param show @c EINA_TRUE will make it enlarge, @c EINA_FALSE will
17927 * let the knob always at default size.
17929 * By default, indicator will be bigger while dragged by the user.
17931 * @warning It won't display values set with
17932 * elm_slider_indicator_format_set() if you disable indicator.
17936 EAPI void elm_slider_indicator_show_set(Evas_Object *obj, Eina_Bool show) EINA_ARG_NONNULL(1);
17939 * Get whether a given slider widget's enlarging indicator or not.
17941 * @param obj The slider object.
17942 * @return @c EINA_TRUE, if @p obj is enlarging indicator, or
17943 * @c EINA_FALSE otherwise (and on errors).
17945 * @see elm_slider_indicator_show_set() for details.
17949 EAPI Eina_Bool elm_slider_indicator_show_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17956 * @addtogroup Actionslider Actionslider
17958 * @image html img/widget/actionslider/preview-00.png
17959 * @image latex img/widget/actionslider/preview-00.eps
17961 * An actionslider is a switcher for 2 or 3 labels with customizable magnet
17962 * properties. The user drags and releases the indicator, to choose a label.
17964 * Labels occupy the following positions.
17969 * Positions can be enabled or disabled.
17971 * Magnets can be set on the above positions.
17973 * When the indicator is released, it will move to its nearest "enabled and magnetized" position.
17975 * @note By default all positions are set as enabled.
17977 * Signals that you can add callbacks for are:
17979 * "selected" - when user selects an enabled position (the label is passed
17982 * "pos_changed" - when the indicator reaches any of the positions("left",
17983 * "right" or "center").
17985 * See an example of actionslider usage @ref actionslider_example_page "here"
17988 typedef enum _Elm_Actionslider_Pos
17990 ELM_ACTIONSLIDER_NONE = 0,
17991 ELM_ACTIONSLIDER_LEFT = 1 << 0,
17992 ELM_ACTIONSLIDER_CENTER = 1 << 1,
17993 ELM_ACTIONSLIDER_RIGHT = 1 << 2,
17994 ELM_ACTIONSLIDER_ALL = (1 << 3) -1
17995 } Elm_Actionslider_Pos;
17998 * Add a new actionslider to the parent.
18000 * @param parent The parent object
18001 * @return The new actionslider object or NULL if it cannot be created
18003 EAPI Evas_Object *elm_actionslider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
18005 * Set actionslider labels.
18007 * @param obj The actionslider object
18008 * @param left_label The label to be set on the left.
18009 * @param center_label The label to be set on the center.
18010 * @param right_label The label to be set on the right.
18011 * @deprecated use elm_object_text_set() instead.
18013 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);
18015 * Get actionslider labels.
18017 * @param obj The actionslider object
18018 * @param left_label A char** to place the left_label of @p obj into.
18019 * @param center_label A char** to place the center_label of @p obj into.
18020 * @param right_label A char** to place the right_label of @p obj into.
18021 * @deprecated use elm_object_text_set() instead.
18023 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);
18025 * Get actionslider selected label.
18027 * @param obj The actionslider object
18028 * @return The selected label
18030 EAPI const char *elm_actionslider_selected_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18032 * Set actionslider indicator position.
18034 * @param obj The actionslider object.
18035 * @param pos The position of the indicator.
18037 EAPI void elm_actionslider_indicator_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
18039 * Get actionslider indicator position.
18041 * @param obj The actionslider object.
18042 * @return The position of the indicator.
18044 EAPI Elm_Actionslider_Pos elm_actionslider_indicator_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18046 * Set actionslider magnet position. To make multiple positions magnets @c or
18047 * them together(e.g.: ELM_ACTIONSLIDER_LEFT | ELM_ACTIONSLIDER_RIGHT)
18049 * @param obj The actionslider object.
18050 * @param pos Bit mask indicating the magnet positions.
18052 EAPI void elm_actionslider_magnet_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
18054 * Get actionslider magnet position.
18056 * @param obj The actionslider object.
18057 * @return The positions with magnet property.
18059 EAPI Elm_Actionslider_Pos elm_actionslider_magnet_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18061 * Set actionslider enabled position. To set multiple positions as enabled @c or
18062 * them together(e.g.: ELM_ACTIONSLIDER_LEFT | ELM_ACTIONSLIDER_RIGHT).
18064 * @note All the positions are enabled by default.
18066 * @param obj The actionslider object.
18067 * @param pos Bit mask indicating the enabled positions.
18069 EAPI void elm_actionslider_enabled_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
18071 * Get actionslider enabled position.
18073 * @param obj The actionslider object.
18074 * @return The enabled positions.
18076 EAPI Elm_Actionslider_Pos elm_actionslider_enabled_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18078 * Set the label used on the indicator.
18080 * @param obj The actionslider object
18081 * @param label The label to be set on the indicator.
18082 * @deprecated use elm_object_text_set() instead.
18084 EINA_DEPRECATED EAPI void elm_actionslider_indicator_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
18086 * Get the label used on the indicator object.
18088 * @param obj The actionslider object
18089 * @return The indicator label
18090 * @deprecated use elm_object_text_get() instead.
18092 EINA_DEPRECATED EAPI const char *elm_actionslider_indicator_label_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
18098 * @defgroup Genlist Genlist
18100 * @image html img/widget/genlist/preview-00.png
18101 * @image latex img/widget/genlist/preview-00.eps
18102 * @image html img/genlist.png
18103 * @image latex img/genlist.eps
18105 * This widget aims to have more expansive list than the simple list in
18106 * Elementary that could have more flexible items and allow many more entries
18107 * while still being fast and low on memory usage. At the same time it was
18108 * also made to be able to do tree structures. But the price to pay is more
18109 * complexity when it comes to usage. If all you want is a simple list with
18110 * icons and a single label, use the normal @ref List object.
18112 * Genlist has a fairly large API, mostly because it's relatively complex,
18113 * trying to be both expansive, powerful and efficient. First we will begin
18114 * an overview on the theory behind genlist.
18116 * @section Genlist_Item_Class Genlist item classes - creating items
18118 * In order to have the ability to add and delete items on the fly, genlist
18119 * implements a class (callback) system where the application provides a
18120 * structure with information about that type of item (genlist may contain
18121 * multiple different items with different classes, states and styles).
18122 * Genlist will call the functions in this struct (methods) when an item is
18123 * "realized" (i.e., created dynamically, while the user is scrolling the
18124 * grid). All objects will simply be deleted when no longer needed with
18125 * evas_object_del(). The #Elm_Genlist_Item_Class structure contains the
18126 * following members:
18127 * - @c item_style - This is a constant string and simply defines the name
18128 * of the item style. It @b must be specified and the default should be @c
18131 * - @c func - A struct with pointers to functions that will be called when
18132 * an item is going to be actually created. All of them receive a @c data
18133 * parameter that will point to the same data passed to
18134 * elm_genlist_item_append() and related item creation functions, and a @c
18135 * obj parameter that points to the genlist object itself.
18137 * The function pointers inside @c func are @c label_get, @c icon_get, @c
18138 * state_get and @c del. The 3 first functions also receive a @c part
18139 * parameter described below. A brief description of these functions follows:
18141 * - @c label_get - The @c part parameter is the name string of one of the
18142 * existing text parts in the Edje group implementing the item's theme.
18143 * This function @b must return a strdup'()ed string, as the caller will
18144 * free() it when done. See #Elm_Genlist_Item_Label_Get_Cb.
18145 * - @c content_get - The @c part parameter is the name string of one of the
18146 * existing (content) swallow parts in the Edje group implementing the item's
18147 * theme. It must return @c NULL, when no content is desired, or a valid
18148 * object handle, otherwise. The object will be deleted by the genlist on
18149 * its deletion or when the item is "unrealized". See
18150 * #Elm_Genlist_Item_Content_Get_Cb.
18151 * - @c func.state_get - The @c part parameter is the name string of one of
18152 * the state parts in the Edje group implementing the item's theme. Return
18153 * @c EINA_FALSE for false/off or @c EINA_TRUE for true/on. Genlists will
18154 * emit a signal to its theming Edje object with @c "elm,state,XXX,active"
18155 * and @c "elm" as "emission" and "source" arguments, respectively, when
18156 * the state is true (the default is false), where @c XXX is the name of
18157 * the (state) part. See #Elm_Genlist_Item_State_Get_Cb.
18158 * - @c func.del - This is intended for use when genlist items are deleted,
18159 * so any data attached to the item (e.g. its data parameter on creation)
18160 * can be deleted. See #Elm_Genlist_Item_Del_Cb.
18162 * available item styles:
18164 * - default_style - The text part is a textblock
18166 * @image html img/widget/genlist/preview-04.png
18167 * @image latex img/widget/genlist/preview-04.eps
18171 * @image html img/widget/genlist/preview-01.png
18172 * @image latex img/widget/genlist/preview-01.eps
18174 * - icon_top_text_bottom
18176 * @image html img/widget/genlist/preview-02.png
18177 * @image latex img/widget/genlist/preview-02.eps
18181 * @image html img/widget/genlist/preview-03.png
18182 * @image latex img/widget/genlist/preview-03.eps
18184 * @section Genlist_Items Structure of items
18186 * An item in a genlist can have 0 or more text labels (they can be regular
18187 * text or textblock Evas objects - that's up to the style to determine), 0
18188 * or more contents (which are simply objects swallowed into the genlist item's
18189 * theming Edje object) and 0 or more <b>boolean states</b>, which have the
18190 * behavior left to the user to define. The Edje part names for each of
18191 * these properties will be looked up, in the theme file for the genlist,
18192 * under the Edje (string) data items named @c "labels", @c "contents" and @c
18193 * "states", respectively. For each of those properties, if more than one
18194 * part is provided, they must have names listed separated by spaces in the
18195 * data fields. For the default genlist item theme, we have @b one label
18196 * part (@c "elm.text"), @b two content parts (@c "elm.swalllow.icon" and @c
18197 * "elm.swallow.end") and @b no state parts.
18199 * A genlist item may be at one of several styles. Elementary provides one
18200 * by default - "default", but this can be extended by system or application
18201 * custom themes/overlays/extensions (see @ref Theme "themes" for more
18204 * @section Genlist_Manipulation Editing and Navigating
18206 * Items can be added by several calls. All of them return a @ref
18207 * Elm_Genlist_Item handle that is an internal member inside the genlist.
18208 * They all take a data parameter that is meant to be used for a handle to
18209 * the applications internal data (eg the struct with the original item
18210 * data). The parent parameter is the parent genlist item this belongs to if
18211 * it is a tree or an indexed group, and NULL if there is no parent. The
18212 * flags can be a bitmask of #ELM_GENLIST_ITEM_NONE,
18213 * #ELM_GENLIST_ITEM_SUBITEMS and #ELM_GENLIST_ITEM_GROUP. If
18214 * #ELM_GENLIST_ITEM_SUBITEMS is set then this item is displayed as an item
18215 * that is able to expand and have child items. If ELM_GENLIST_ITEM_GROUP
18216 * is set then this item is group index item that is displayed at the top
18217 * until the next group comes. The func parameter is a convenience callback
18218 * that is called when the item is selected and the data parameter will be
18219 * the func_data parameter, obj be the genlist object and event_info will be
18220 * the genlist item.
18222 * elm_genlist_item_append() adds an item to the end of the list, or if
18223 * there is a parent, to the end of all the child items of the parent.
18224 * elm_genlist_item_prepend() is the same but adds to the beginning of
18225 * the list or children list. elm_genlist_item_insert_before() inserts at
18226 * item before another item and elm_genlist_item_insert_after() inserts after
18227 * the indicated item.
18229 * The application can clear the list with elm_genlist_clear() which deletes
18230 * all the items in the list and elm_genlist_item_del() will delete a specific
18231 * item. elm_genlist_item_subitems_clear() will clear all items that are
18232 * children of the indicated parent item.
18234 * To help inspect list items you can jump to the item at the top of the list
18235 * with elm_genlist_first_item_get() which will return the item pointer, and
18236 * similarly elm_genlist_last_item_get() gets the item at the end of the list.
18237 * elm_genlist_item_next_get() and elm_genlist_item_prev_get() get the next
18238 * and previous items respectively relative to the indicated item. Using
18239 * these calls you can walk the entire item list/tree. Note that as a tree
18240 * the items are flattened in the list, so elm_genlist_item_parent_get() will
18241 * let you know which item is the parent (and thus know how to skip them if
18244 * @section Genlist_Muti_Selection Multi-selection
18246 * If the application wants multiple items to be able to be selected,
18247 * elm_genlist_multi_select_set() can enable this. If the list is
18248 * single-selection only (the default), then elm_genlist_selected_item_get()
18249 * will return the selected item, if any, or NULL if none is selected. If the
18250 * list is multi-select then elm_genlist_selected_items_get() will return a
18251 * list (that is only valid as long as no items are modified (added, deleted,
18252 * selected or unselected)).
18254 * @section Genlist_Usage_Hints Usage hints
18256 * There are also convenience functions. elm_genlist_item_genlist_get() will
18257 * return the genlist object the item belongs to. elm_genlist_item_show()
18258 * will make the scroller scroll to show that specific item so its visible.
18259 * elm_genlist_item_data_get() returns the data pointer set by the item
18260 * creation functions.
18262 * If an item changes (state of boolean changes, label or contents change),
18263 * then use elm_genlist_item_update() to have genlist update the item with
18264 * the new state. Genlist will re-realize the item thus call the functions
18265 * in the _Elm_Genlist_Item_Class for that item.
18267 * To programmatically (un)select an item use elm_genlist_item_selected_set().
18268 * To get its selected state use elm_genlist_item_selected_get(). Similarly
18269 * to expand/contract an item and get its expanded state, use
18270 * elm_genlist_item_expanded_set() and elm_genlist_item_expanded_get(). And
18271 * again to make an item disabled (unable to be selected and appear
18272 * differently) use elm_genlist_item_disabled_set() to set this and
18273 * elm_genlist_item_disabled_get() to get the disabled state.
18275 * In general to indicate how the genlist should expand items horizontally to
18276 * fill the list area, use elm_genlist_horizontal_set(). Valid modes are
18277 * ELM_LIST_LIMIT and ELM_LIST_SCROLL. The default is ELM_LIST_SCROLL. This
18278 * mode means that if items are too wide to fit, the scroller will scroll
18279 * horizontally. Otherwise items are expanded to fill the width of the
18280 * viewport of the scroller. If it is ELM_LIST_LIMIT, items will be expanded
18281 * to the viewport width and limited to that size. This can be combined with
18282 * a different style that uses edjes' ellipsis feature (cutting text off like
18285 * Items will only call their selection func and callback when first becoming
18286 * selected. Any further clicks will do nothing, unless you enable always
18287 * select with elm_genlist_always_select_mode_set(). This means even if
18288 * selected, every click will make the selected callbacks be called.
18289 * elm_genlist_no_select_mode_set() will turn off the ability to select
18290 * items entirely and they will neither appear selected nor call selected
18291 * callback functions.
18293 * Remember that you can create new styles and add your own theme augmentation
18294 * per application with elm_theme_extension_add(). If you absolutely must
18295 * have a specific style that overrides any theme the user or system sets up
18296 * you can use elm_theme_overlay_add() to add such a file.
18298 * @section Genlist_Implementation Implementation
18300 * Evas tracks every object you create. Every time it processes an event
18301 * (mouse move, down, up etc.) it needs to walk through objects and find out
18302 * what event that affects. Even worse every time it renders display updates,
18303 * in order to just calculate what to re-draw, it needs to walk through many
18304 * many many objects. Thus, the more objects you keep active, the more
18305 * overhead Evas has in just doing its work. It is advisable to keep your
18306 * active objects to the minimum working set you need. Also remember that
18307 * object creation and deletion carries an overhead, so there is a
18308 * middle-ground, which is not easily determined. But don't keep massive lists
18309 * of objects you can't see or use. Genlist does this with list objects. It
18310 * creates and destroys them dynamically as you scroll around. It groups them
18311 * into blocks so it can determine the visibility etc. of a whole block at
18312 * once as opposed to having to walk the whole list. This 2-level list allows
18313 * for very large numbers of items to be in the list (tests have used up to
18314 * 2,000,000 items). Also genlist employs a queue for adding items. As items
18315 * may be different sizes, every item added needs to be calculated as to its
18316 * size and thus this presents a lot of overhead on populating the list, this
18317 * genlist employs a queue. Any item added is queued and spooled off over
18318 * time, actually appearing some time later, so if your list has many members
18319 * you may find it takes a while for them to all appear, with your process
18320 * consuming a lot of CPU while it is busy spooling.
18322 * Genlist also implements a tree structure, but it does so with callbacks to
18323 * the application, with the application filling in tree structures when
18324 * requested (allowing for efficient building of a very deep tree that could
18325 * even be used for file-management). See the above smart signal callbacks for
18328 * @section Genlist_Smart_Events Genlist smart events
18330 * Signals that you can add callbacks for are:
18331 * - @c "activated" - The user has double-clicked or pressed
18332 * (enter|return|spacebar) on an item. The @c event_info parameter is the
18333 * item that was activated.
18334 * - @c "clicked,double" - The user has double-clicked an item. The @c
18335 * event_info parameter is the item that was double-clicked.
18336 * - @c "selected" - This is called when a user has made an item selected.
18337 * The event_info parameter is the genlist item that was selected.
18338 * - @c "unselected" - This is called when a user has made an item
18339 * unselected. The event_info parameter is the genlist item that was
18341 * - @c "expanded" - This is called when elm_genlist_item_expanded_set() is
18342 * called and the item is now meant to be expanded. The event_info
18343 * parameter is the genlist item that was indicated to expand. It is the
18344 * job of this callback to then fill in the child items.
18345 * - @c "contracted" - This is called when elm_genlist_item_expanded_set() is
18346 * called and the item is now meant to be contracted. The event_info
18347 * parameter is the genlist item that was indicated to contract. It is the
18348 * job of this callback to then delete the child items.
18349 * - @c "expand,request" - This is called when a user has indicated they want
18350 * to expand a tree branch item. The callback should decide if the item can
18351 * expand (has any children) and then call elm_genlist_item_expanded_set()
18352 * appropriately to set the state. The event_info parameter is the genlist
18353 * item that was indicated to expand.
18354 * - @c "contract,request" - This is called when a user has indicated they
18355 * want to contract a tree branch item. The callback should decide if the
18356 * item can contract (has any children) and then call
18357 * elm_genlist_item_expanded_set() appropriately to set the state. The
18358 * event_info parameter is the genlist item that was indicated to contract.
18359 * - @c "realized" - This is called when the item in the list is created as a
18360 * real evas object. event_info parameter is the genlist item that was
18361 * created. The object may be deleted at any time, so it is up to the
18362 * caller to not use the object pointer from elm_genlist_item_object_get()
18363 * in a way where it may point to freed objects.
18364 * - @c "unrealized" - This is called just before an item is unrealized.
18365 * After this call content objects provided will be deleted and the item
18366 * object itself delete or be put into a floating cache.
18367 * - @c "drag,start,up" - This is called when the item in the list has been
18368 * dragged (not scrolled) up.
18369 * - @c "drag,start,down" - This is called when the item in the list has been
18370 * dragged (not scrolled) down.
18371 * - @c "drag,start,left" - This is called when the item in the list has been
18372 * dragged (not scrolled) left.
18373 * - @c "drag,start,right" - This is called when the item in the list has
18374 * been dragged (not scrolled) right.
18375 * - @c "drag,stop" - This is called when the item in the list has stopped
18377 * - @c "drag" - This is called when the item in the list is being dragged.
18378 * - @c "longpressed" - This is called when the item is pressed for a certain
18379 * amount of time. By default it's 1 second.
18380 * - @c "scroll,anim,start" - This is called when scrolling animation has
18382 * - @c "scroll,anim,stop" - This is called when scrolling animation has
18384 * - @c "scroll,drag,start" - This is called when dragging the content has
18386 * - @c "scroll,drag,stop" - This is called when dragging the content has
18388 * - @c "edge,top" - This is called when the genlist is scrolled until
18390 * - @c "edge,bottom" - This is called when the genlist is scrolled
18391 * until the bottom edge.
18392 * - @c "edge,left" - This is called when the genlist is scrolled
18393 * until the left edge.
18394 * - @c "edge,right" - This is called when the genlist is scrolled
18395 * until the right edge.
18396 * - @c "multi,swipe,left" - This is called when the genlist is multi-touch
18398 * - @c "multi,swipe,right" - This is called when the genlist is multi-touch
18400 * - @c "multi,swipe,up" - This is called when the genlist is multi-touch
18402 * - @c "multi,swipe,down" - This is called when the genlist is multi-touch
18404 * - @c "multi,pinch,out" - This is called when the genlist is multi-touch
18405 * pinched out. "- @c multi,pinch,in" - This is called when the genlist is
18406 * multi-touch pinched in.
18407 * - @c "swipe" - This is called when the genlist is swiped.
18408 * - @c "moved" - This is called when a genlist item is moved.
18409 * - @c "language,changed" - This is called when the program's language is
18412 * @section Genlist_Examples Examples
18414 * Here is a list of examples that use the genlist, trying to show some of
18415 * its capabilities:
18416 * - @ref genlist_example_01
18417 * - @ref genlist_example_02
18418 * - @ref genlist_example_03
18419 * - @ref genlist_example_04
18420 * - @ref genlist_example_05
18424 * @addtogroup Genlist
18429 * @enum _Elm_Genlist_Item_Flags
18430 * @typedef Elm_Genlist_Item_Flags
18432 * Defines if the item is of any special type (has subitems or it's the
18433 * index of a group), or is just a simple item.
18437 typedef enum _Elm_Genlist_Item_Flags
18439 ELM_GENLIST_ITEM_NONE = 0, /**< simple item */
18440 ELM_GENLIST_ITEM_SUBITEMS = (1 << 0), /**< may expand and have child items */
18441 ELM_GENLIST_ITEM_GROUP = (1 << 1) /**< index of a group of items */
18442 } Elm_Genlist_Item_Flags;
18443 typedef enum _Elm_Genlist_Item_Field_Flags
18445 ELM_GENLIST_ITEM_FIELD_ALL = 0,
18446 ELM_GENLIST_ITEM_FIELD_LABEL = (1 << 0),
18447 ELM_GENLIST_ITEM_FIELD_CONTENT = (1 << 1),
18448 ELM_GENLIST_ITEM_FIELD_STATE = (1 << 2)
18449 } Elm_Genlist_Item_Field_Flags;
18450 typedef struct _Elm_Genlist_Item_Class Elm_Genlist_Item_Class; /**< Genlist item class definition structs */
18451 #define Elm_Genlist_Item_Class Elm_Gen_Item_Class
18452 typedef struct _Elm_Genlist_Item Elm_Genlist_Item; /**< Item of Elm_Genlist. Sub-type of Elm_Widget_Item */
18453 #define Elm_Genlist_Item Elm_Gen_Item /**< Item of Elm_Genlist. Sub-type of Elm_Widget_Item */
18454 typedef struct _Elm_Genlist_Item_Class_Func Elm_Genlist_Item_Class_Func; /**< Class functions for genlist item class */
18456 * Label fetching class function for Elm_Gen_Item_Class.
18457 * @param data The data passed in the item creation function
18458 * @param obj The base widget object
18459 * @param part The part name of the swallow
18460 * @return The allocated (NOT stringshared) string to set as the label
18462 typedef char *(*Elm_Genlist_Item_Label_Get_Cb) (void *data, Evas_Object *obj, const char *part);
18464 * Content (swallowed object) fetching class function for Elm_Gen_Item_Class.
18465 * @param data The data passed in the item creation function
18466 * @param obj The base widget object
18467 * @param part The part name of the swallow
18468 * @return The content object to swallow
18470 typedef Evas_Object *(*Elm_Genlist_Item_Content_Get_Cb) (void *data, Evas_Object *obj, const char *part);
18472 * State fetching class function for Elm_Gen_Item_Class.
18473 * @param data The data passed in the item creation function
18474 * @param obj The base widget object
18475 * @param part The part name of the swallow
18476 * @return The hell if I know
18478 typedef Eina_Bool (*Elm_Genlist_Item_State_Get_Cb) (void *data, Evas_Object *obj, const char *part);
18480 * Deletion class function for Elm_Gen_Item_Class.
18481 * @param data The data passed in the item creation function
18482 * @param obj The base widget object
18484 typedef void (*Elm_Genlist_Item_Del_Cb) (void *data, Evas_Object *obj);
18487 * @struct _Elm_Genlist_Item_Class
18489 * Genlist item class definition structs.
18491 * This struct contains the style and fetching functions that will define the
18492 * contents of each item.
18494 * @see @ref Genlist_Item_Class
18496 struct _Elm_Genlist_Item_Class
18498 const char *item_style; /**< style of this class. */
18499 struct Elm_Genlist_Item_Class_Func
18501 Elm_Genlist_Item_Label_Get_Cb label_get; /**< Label fetching class function for genlist item classes.*/
18502 Elm_Genlist_Item_Content_Get_Cb content_get; /**< Content fetching class function for genlist item classes. */
18503 Elm_Genlist_Item_State_Get_Cb state_get; /**< State fetching class function for genlist item classes. */
18504 Elm_Genlist_Item_Del_Cb del; /**< Deletion class function for genlist item classes. */
18507 #define Elm_Genlist_Item_Class_Func Elm_Gen_Item_Class_Func
18509 * Add a new genlist widget to the given parent Elementary
18510 * (container) object
18512 * @param parent The parent object
18513 * @return a new genlist widget handle or @c NULL, on errors
18515 * This function inserts a new genlist widget on the canvas.
18517 * @see elm_genlist_item_append()
18518 * @see elm_genlist_item_del()
18519 * @see elm_genlist_clear()
18523 EAPI Evas_Object *elm_genlist_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
18525 * Remove all items from a given genlist widget.
18527 * @param obj The genlist object
18529 * This removes (and deletes) all items in @p obj, leaving it empty.
18531 * @see elm_genlist_item_del(), to remove just one item.
18535 EAPI void elm_genlist_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
18537 * Enable or disable multi-selection in the genlist
18539 * @param obj The genlist object
18540 * @param multi Multi-select enable/disable. Default is disabled.
18542 * This enables (@c EINA_TRUE) or disables (@c EINA_FALSE) multi-selection in
18543 * the list. This allows more than 1 item to be selected. To retrieve the list
18544 * of selected items, use elm_genlist_selected_items_get().
18546 * @see elm_genlist_selected_items_get()
18547 * @see elm_genlist_multi_select_get()
18551 EAPI void elm_genlist_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
18553 * Gets if multi-selection in genlist is enabled or disabled.
18555 * @param obj The genlist object
18556 * @return Multi-select enabled/disabled
18557 * (@c EINA_TRUE = enabled/@c EINA_FALSE = disabled). Default is @c EINA_FALSE.
18559 * @see elm_genlist_multi_select_set()
18563 EAPI Eina_Bool elm_genlist_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18565 * This sets the horizontal stretching mode.
18567 * @param obj The genlist object
18568 * @param mode The mode to use (one of #ELM_LIST_SCROLL or #ELM_LIST_LIMIT).
18570 * This sets the mode used for sizing items horizontally. Valid modes
18571 * are #ELM_LIST_LIMIT and #ELM_LIST_SCROLL. The default is
18572 * ELM_LIST_SCROLL. This mode means that if items are too wide to fit,
18573 * the scroller will scroll horizontally. Otherwise items are expanded
18574 * to fill the width of the viewport of the scroller. If it is
18575 * ELM_LIST_LIMIT, items will be expanded to the viewport width and
18576 * limited to that size.
18578 * @see elm_genlist_horizontal_get()
18582 EAPI void elm_genlist_horizontal_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
18583 EINA_DEPRECATED EAPI void elm_genlist_horizontal_mode_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
18585 * Gets the horizontal stretching mode.
18587 * @param obj The genlist object
18588 * @return The mode to use
18589 * (#ELM_LIST_LIMIT, #ELM_LIST_SCROLL)
18591 * @see elm_genlist_horizontal_set()
18595 EAPI Elm_List_Mode elm_genlist_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18596 EINA_DEPRECATED EAPI Elm_List_Mode elm_genlist_horizontal_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18598 * Set the always select mode.
18600 * @param obj The genlist object
18601 * @param always_select The always select mode (@c EINA_TRUE = on, @c
18602 * EINA_FALSE = off). Default is @c EINA_FALSE.
18604 * Items will only call their selection func and callback when first
18605 * becoming selected. Any further clicks will do nothing, unless you
18606 * enable always select with elm_genlist_always_select_mode_set().
18607 * This means that, even if selected, every click will make the selected
18608 * callbacks be called.
18610 * @see elm_genlist_always_select_mode_get()
18614 EAPI void elm_genlist_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
18616 * Get the always select mode.
18618 * @param obj The genlist object
18619 * @return The always select mode
18620 * (@c EINA_TRUE = on, @c EINA_FALSE = off)
18622 * @see elm_genlist_always_select_mode_set()
18626 EAPI Eina_Bool elm_genlist_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18628 * Enable/disable the no select mode.
18630 * @param obj The genlist object
18631 * @param no_select The no select mode
18632 * (EINA_TRUE = on, EINA_FALSE = off)
18634 * This will turn off the ability to select items entirely and they
18635 * will neither appear selected nor call selected callback functions.
18637 * @see elm_genlist_no_select_mode_get()
18641 EAPI void elm_genlist_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
18643 * Gets whether the no select mode is enabled.
18645 * @param obj The genlist object
18646 * @return The no select mode
18647 * (@c EINA_TRUE = on, @c EINA_FALSE = off)
18649 * @see elm_genlist_no_select_mode_set()
18653 EAPI Eina_Bool elm_genlist_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18655 * Enable/disable compress mode.
18657 * @param obj The genlist object
18658 * @param compress The compress mode
18659 * (@c EINA_TRUE = on, @c EINA_FALSE = off). Default is @c EINA_FALSE.
18661 * This will enable the compress mode where items are "compressed"
18662 * horizontally to fit the genlist scrollable viewport width. This is
18663 * special for genlist. Do not rely on
18664 * elm_genlist_horizontal_set() being set to @c ELM_LIST_COMPRESS to
18665 * work as genlist needs to handle it specially.
18667 * @see elm_genlist_compress_mode_get()
18671 EAPI void elm_genlist_compress_mode_set(Evas_Object *obj, Eina_Bool compress) EINA_ARG_NONNULL(1);
18673 * Get whether the compress mode is enabled.
18675 * @param obj The genlist object
18676 * @return The compress mode
18677 * (@c EINA_TRUE = on, @c EINA_FALSE = off)
18679 * @see elm_genlist_compress_mode_set()
18683 EAPI Eina_Bool elm_genlist_compress_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18685 * Enable/disable height-for-width mode.
18687 * @param obj The genlist object
18688 * @param setting The height-for-width mode (@c EINA_TRUE = on,
18689 * @c EINA_FALSE = off). Default is @c EINA_FALSE.
18691 * With height-for-width mode the item width will be fixed (restricted
18692 * to a minimum of) to the list width when calculating its size in
18693 * order to allow the height to be calculated based on it. This allows,
18694 * for instance, text block to wrap lines if the Edje part is
18695 * configured with "text.min: 0 1".
18697 * @note This mode will make list resize slower as it will have to
18698 * recalculate every item height again whenever the list width
18701 * @note When height-for-width mode is enabled, it also enables
18702 * compress mode (see elm_genlist_compress_mode_set()) and
18703 * disables homogeneous (see elm_genlist_homogeneous_set()).
18707 EAPI void elm_genlist_height_for_width_mode_set(Evas_Object *obj, Eina_Bool height_for_width) EINA_ARG_NONNULL(1);
18709 * Get whether the height-for-width mode is enabled.
18711 * @param obj The genlist object
18712 * @return The height-for-width mode (@c EINA_TRUE = on, @c EINA_FALSE =
18717 EAPI Eina_Bool elm_genlist_height_for_width_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18719 * Enable/disable horizontal and vertical bouncing effect.
18721 * @param obj The genlist object
18722 * @param h_bounce Allow bounce horizontally (@c EINA_TRUE = on, @c
18723 * EINA_FALSE = off). Default is @c EINA_FALSE.
18724 * @param v_bounce Allow bounce vertically (@c EINA_TRUE = on, @c
18725 * EINA_FALSE = off). Default is @c EINA_TRUE.
18727 * This will enable or disable the scroller bouncing effect for the
18728 * genlist. See elm_scroller_bounce_set() for details.
18730 * @see elm_scroller_bounce_set()
18731 * @see elm_genlist_bounce_get()
18735 EAPI void elm_genlist_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
18737 * Get whether the horizontal and vertical bouncing effect is enabled.
18739 * @param obj The genlist object
18740 * @param h_bounce Pointer to a bool to receive if the bounce horizontally
18742 * @param v_bounce Pointer to a bool to receive if the bounce vertically
18745 * @see elm_genlist_bounce_set()
18749 EAPI void elm_genlist_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
18751 * Enable/disable homogeneous mode.
18753 * @param obj The genlist object
18754 * @param homogeneous Assume the items within the genlist are of the
18755 * same height and width (EINA_TRUE = on, EINA_FALSE = off). Default is @c
18758 * This will enable the homogeneous mode where items are of the same
18759 * height and width so that genlist may do the lazy-loading at its
18760 * maximum (which increases the performance for scrolling the list). This
18761 * implies 'compressed' mode.
18763 * @see elm_genlist_compress_mode_set()
18764 * @see elm_genlist_homogeneous_get()
18768 EAPI void elm_genlist_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
18770 * Get whether the homogeneous mode is enabled.
18772 * @param obj The genlist object
18773 * @return Assume the items within the genlist are of the same height
18774 * and width (EINA_TRUE = on, EINA_FALSE = off)
18776 * @see elm_genlist_homogeneous_set()
18780 EAPI Eina_Bool elm_genlist_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18782 * Set the maximum number of items within an item block
18784 * @param obj The genlist object
18785 * @param n Maximum number of items within an item block. Default is 32.
18787 * This will configure the block count to tune to the target with
18788 * particular performance matrix.
18790 * A block of objects will be used to reduce the number of operations due to
18791 * many objects in the screen. It can determine the visibility, or if the
18792 * object has changed, it theme needs to be updated, etc. doing this kind of
18793 * calculation to the entire block, instead of per object.
18795 * The default value for the block count is enough for most lists, so unless
18796 * you know you will have a lot of objects visible in the screen at the same
18797 * time, don't try to change this.
18799 * @see elm_genlist_block_count_get()
18800 * @see @ref Genlist_Implementation
18804 EAPI void elm_genlist_block_count_set(Evas_Object *obj, int n) EINA_ARG_NONNULL(1);
18806 * Get the maximum number of items within an item block
18808 * @param obj The genlist object
18809 * @return Maximum number of items within an item block
18811 * @see elm_genlist_block_count_set()
18815 EAPI int elm_genlist_block_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18817 * Set the timeout in seconds for the longpress event.
18819 * @param obj The genlist object
18820 * @param timeout timeout in seconds. Default is 1.
18822 * This option will change how long it takes to send an event "longpressed"
18823 * after the mouse down signal is sent to the list. If this event occurs, no
18824 * "clicked" event will be sent.
18826 * @see elm_genlist_longpress_timeout_set()
18830 EAPI void elm_genlist_longpress_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
18832 * Get the timeout in seconds for the longpress event.
18834 * @param obj The genlist object
18835 * @return timeout in seconds
18837 * @see elm_genlist_longpress_timeout_get()
18841 EAPI double elm_genlist_longpress_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18843 * Append a new item in a given genlist widget.
18845 * @param obj The genlist object
18846 * @param itc The item class for the item
18847 * @param data The item data
18848 * @param parent The parent item, or NULL if none
18849 * @param flags Item flags
18850 * @param func Convenience function called when the item is selected
18851 * @param func_data Data passed to @p func above.
18852 * @return A handle to the item added or @c NULL if not possible
18854 * This adds the given item to the end of the list or the end of
18855 * the children list if the @p parent is given.
18857 * @see elm_genlist_item_prepend()
18858 * @see elm_genlist_item_insert_before()
18859 * @see elm_genlist_item_insert_after()
18860 * @see elm_genlist_item_del()
18864 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);
18866 * Prepend a new item in a given genlist widget.
18868 * @param obj The genlist object
18869 * @param itc The item class for the item
18870 * @param data The item data
18871 * @param parent The parent item, or NULL if none
18872 * @param flags Item flags
18873 * @param func Convenience function called when the item is selected
18874 * @param func_data Data passed to @p func above.
18875 * @return A handle to the item added or NULL if not possible
18877 * This adds an item to the beginning of the list or beginning of the
18878 * children of the parent if given.
18880 * @see elm_genlist_item_append()
18881 * @see elm_genlist_item_insert_before()
18882 * @see elm_genlist_item_insert_after()
18883 * @see elm_genlist_item_del()
18887 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);
18889 * Insert an item before another in a genlist widget
18891 * @param obj The genlist object
18892 * @param itc The item class for the item
18893 * @param data The item data
18894 * @param before The item to place this new one before.
18895 * @param flags Item flags
18896 * @param func Convenience function called when the item is selected
18897 * @param func_data Data passed to @p func above.
18898 * @return A handle to the item added or @c NULL if not possible
18900 * This inserts an item before another in the list. It will be in the
18901 * same tree level or group as the item it is inserted before.
18903 * @see elm_genlist_item_append()
18904 * @see elm_genlist_item_prepend()
18905 * @see elm_genlist_item_insert_after()
18906 * @see elm_genlist_item_del()
18910 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);
18912 * Insert an item after another in a genlist widget
18914 * @param obj The genlist object
18915 * @param itc The item class for the item
18916 * @param data The item data
18917 * @param after The item to place this new one after.
18918 * @param flags Item flags
18919 * @param func Convenience function called when the item is selected
18920 * @param func_data Data passed to @p func above.
18921 * @return A handle to the item added or @c NULL if not possible
18923 * This inserts an item after another in the list. It will be in the
18924 * same tree level or group as the item it is inserted after.
18926 * @see elm_genlist_item_append()
18927 * @see elm_genlist_item_prepend()
18928 * @see elm_genlist_item_insert_before()
18929 * @see elm_genlist_item_del()
18933 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);
18935 * Insert a new item into the sorted genlist object
18937 * @param obj The genlist object
18938 * @param itc The item class for the item
18939 * @param data The item data
18940 * @param parent The parent item, or NULL if none
18941 * @param flags Item flags
18942 * @param comp The function called for the sort
18943 * @param func Convenience function called when item selected
18944 * @param func_data Data passed to @p func above.
18945 * @return A handle to the item added or NULL if not possible
18949 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);
18950 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);
18951 /* operations to retrieve existing items */
18953 * Get the selectd item in the genlist.
18955 * @param obj The genlist object
18956 * @return The selected item, or NULL if none is selected.
18958 * This gets the selected item in the list (if multi-selection is enabled, only
18959 * the item that was first selected in the list is returned - which is not very
18960 * useful, so see elm_genlist_selected_items_get() for when multi-selection is
18963 * If no item is selected, NULL is returned.
18965 * @see elm_genlist_selected_items_get()
18969 EAPI Elm_Genlist_Item *elm_genlist_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18971 * Get a list of selected items in the genlist.
18973 * @param obj The genlist object
18974 * @return The list of selected items, or NULL if none are selected.
18976 * It returns a list of the selected items. This list pointer is only valid so
18977 * long as the selection doesn't change (no items are selected or unselected, or
18978 * unselected implicitly by deletion). The list contains Elm_Genlist_Item
18979 * pointers. The order of the items in this list is the order which they were
18980 * selected, i.e. the first item in this list is the first item that was
18981 * selected, and so on.
18983 * @note If not in multi-select mode, consider using function
18984 * elm_genlist_selected_item_get() instead.
18986 * @see elm_genlist_multi_select_set()
18987 * @see elm_genlist_selected_item_get()
18991 EAPI const Eina_List *elm_genlist_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18993 * Get the mode item style of items in the genlist
18994 * @param obj The genlist object
18995 * @return The mode item style string, or NULL if none is specified
18997 * This is a constant string and simply defines the name of the
18998 * style that will be used for mode animations. It can be
18999 * @c NULL if you don't plan to use Genlist mode. See
19000 * elm_genlist_item_mode_set() for more info.
19004 EAPI const char *elm_genlist_mode_item_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19006 * Set the mode item style of items in the genlist
19007 * @param obj The genlist object
19008 * @param style The mode item style string, or NULL if none is desired
19010 * This is a constant string and simply defines the name of the
19011 * style that will be used for mode animations. It can be
19012 * @c NULL if you don't plan to use Genlist mode. See
19013 * elm_genlist_item_mode_set() for more info.
19017 EAPI void elm_genlist_mode_item_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
19019 * Get a list of realized items in genlist
19021 * @param obj The genlist object
19022 * @return The list of realized items, nor NULL if none are realized.
19024 * This returns a list of the realized items in the genlist. The list
19025 * contains Elm_Genlist_Item pointers. The list must be freed by the
19026 * caller when done with eina_list_free(). The item pointers in the
19027 * list are only valid so long as those items are not deleted or the
19028 * genlist is not deleted.
19030 * @see elm_genlist_realized_items_update()
19034 EAPI Eina_List *elm_genlist_realized_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19036 * Get the item that is at the x, y canvas coords.
19038 * @param obj The gelinst object.
19039 * @param x The input x coordinate
19040 * @param y The input y coordinate
19041 * @param posret The position relative to the item returned here
19042 * @return The item at the coordinates or NULL if none
19044 * This returns the item at the given coordinates (which are canvas
19045 * relative, not object-relative). If an item is at that coordinate,
19046 * that item handle is returned, and if @p posret is not NULL, the
19047 * integer pointed to is set to a value of -1, 0 or 1, depending if
19048 * the coordinate is on the upper portion of that item (-1), on the
19049 * middle section (0) or on the lower part (1). If NULL is returned as
19050 * an item (no item found there), then posret may indicate -1 or 1
19051 * based if the coordinate is above or below all items respectively in
19056 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);
19058 * Get the first item in the genlist
19060 * This returns the first item in the list.
19062 * @param obj The genlist object
19063 * @return The first item, or NULL if none
19067 EAPI Elm_Genlist_Item *elm_genlist_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19069 * Get the last item in the genlist
19071 * This returns the last item in the list.
19073 * @return The last item, or NULL if none
19077 EAPI Elm_Genlist_Item *elm_genlist_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19079 * Set the scrollbar policy
19081 * @param obj The genlist object
19082 * @param policy_h Horizontal scrollbar policy.
19083 * @param policy_v Vertical scrollbar policy.
19085 * This sets the scrollbar visibility policy for the given genlist
19086 * scroller. #ELM_SMART_SCROLLER_POLICY_AUTO means the scrollbar is
19087 * made visible if it is needed, and otherwise kept hidden.
19088 * #ELM_SMART_SCROLLER_POLICY_ON turns it on all the time, and
19089 * #ELM_SMART_SCROLLER_POLICY_OFF always keeps it off. This applies
19090 * respectively for the horizontal and vertical scrollbars. Default is
19091 * #ELM_SMART_SCROLLER_POLICY_AUTO
19093 * @see elm_genlist_scroller_policy_get()
19097 EAPI void elm_genlist_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
19099 * Get the scrollbar policy
19101 * @param obj The genlist object
19102 * @param policy_h Pointer to store the horizontal scrollbar policy.
19103 * @param policy_v Pointer to store the vertical scrollbar policy.
19105 * @see elm_genlist_scroller_policy_set()
19109 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);
19111 * Get the @b next item in a genlist widget's internal list of items,
19112 * given a handle to one of those items.
19114 * @param item The genlist item to fetch next from
19115 * @return The item after @p item, or @c NULL if there's none (and
19118 * This returns the item placed after the @p item, on the container
19121 * @see elm_genlist_item_prev_get()
19125 EAPI Elm_Genlist_Item *elm_genlist_item_next_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19127 * Get the @b previous item in a genlist widget's internal list of items,
19128 * given a handle to one of those items.
19130 * @param item The genlist item to fetch previous from
19131 * @return The item before @p item, or @c NULL if there's none (and
19134 * This returns the item placed before the @p item, on the container
19137 * @see elm_genlist_item_next_get()
19141 EAPI Elm_Genlist_Item *elm_genlist_item_prev_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19143 * Get the genlist object's handle which contains a given genlist
19146 * @param item The item to fetch the container from
19147 * @return The genlist (parent) object
19149 * This returns the genlist object itself that an item belongs to.
19153 EAPI Evas_Object *elm_genlist_item_genlist_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19155 * Get the parent item of the given item
19157 * @param it The item
19158 * @return The parent of the item or @c NULL if it has no parent.
19160 * This returns the item that was specified as parent of the item @p it on
19161 * elm_genlist_item_append() and insertion related functions.
19165 EAPI Elm_Genlist_Item *elm_genlist_item_parent_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19167 * Remove all sub-items (children) of the given item
19169 * @param it The item
19171 * This removes all items that are children (and their descendants) of the
19172 * given item @p it.
19174 * @see elm_genlist_clear()
19175 * @see elm_genlist_item_del()
19179 EAPI void elm_genlist_item_subitems_clear(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19181 * Set whether a given genlist item is selected or not
19183 * @param it The item
19184 * @param selected Use @c EINA_TRUE, to make it selected, @c
19185 * EINA_FALSE to make it unselected
19187 * This sets the selected state of an item. If multi selection is
19188 * not enabled on the containing genlist and @p selected is @c
19189 * EINA_TRUE, any other previously selected items will get
19190 * unselected in favor of this new one.
19192 * @see elm_genlist_item_selected_get()
19196 EAPI void elm_genlist_item_selected_set(Elm_Genlist_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
19198 * Get whether a given genlist item is selected or not
19200 * @param it The item
19201 * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
19203 * @see elm_genlist_item_selected_set() for more details
19207 EAPI Eina_Bool elm_genlist_item_selected_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19209 * Sets the expanded state of an item.
19211 * @param it The item
19212 * @param expanded The expanded state (@c EINA_TRUE expanded, @c EINA_FALSE not expanded).
19214 * This function flags the item of type #ELM_GENLIST_ITEM_SUBITEMS as
19217 * The theme will respond to this change visually, and a signal "expanded" or
19218 * "contracted" will be sent from the genlist with a pointer to the item that
19219 * has been expanded/contracted.
19221 * Calling this function won't show or hide any child of this item (if it is
19222 * a parent). You must manually delete and create them on the callbacks fo
19223 * the "expanded" or "contracted" signals.
19225 * @see elm_genlist_item_expanded_get()
19229 EAPI void elm_genlist_item_expanded_set(Elm_Genlist_Item *item, Eina_Bool expanded) EINA_ARG_NONNULL(1);
19231 * Get the expanded state of an item
19233 * @param it The item
19234 * @return The expanded state
19236 * This gets the expanded state of an item.
19238 * @see elm_genlist_item_expanded_set()
19242 EAPI Eina_Bool elm_genlist_item_expanded_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19244 * Get the depth of expanded item
19246 * @param it The genlist item object
19247 * @return The depth of expanded item
19251 EAPI int elm_genlist_item_expanded_depth_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19253 * Set whether a given genlist item is disabled or not.
19255 * @param it The item
19256 * @param disabled Use @c EINA_TRUE, true disable it, @c EINA_FALSE
19257 * to enable it back.
19259 * A disabled item cannot be selected or unselected. It will also
19260 * change its appearance, to signal the user it's disabled.
19262 * @see elm_genlist_item_disabled_get()
19266 EAPI void elm_genlist_item_disabled_set(Elm_Genlist_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
19268 * Get whether a given genlist item is disabled or not.
19270 * @param it The item
19271 * @return @c EINA_TRUE, if it's disabled, @c EINA_FALSE otherwise
19274 * @see elm_genlist_item_disabled_set() for more details
19278 EAPI Eina_Bool elm_genlist_item_disabled_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19280 * Sets the display only state of an item.
19282 * @param it The item
19283 * @param display_only @c EINA_TRUE if the item is display only, @c
19284 * EINA_FALSE otherwise.
19286 * A display only item cannot be selected or unselected. It is for
19287 * display only and not selecting or otherwise clicking, dragging
19288 * etc. by the user, thus finger size rules will not be applied to
19291 * It's good to set group index items to display only state.
19293 * @see elm_genlist_item_display_only_get()
19297 EAPI void elm_genlist_item_display_only_set(Elm_Genlist_Item *it, Eina_Bool display_only) EINA_ARG_NONNULL(1);
19299 * Get the display only state of an item
19301 * @param it The item
19302 * @return @c EINA_TRUE if the item is display only, @c
19303 * EINA_FALSE otherwise.
19305 * @see elm_genlist_item_display_only_set()
19309 EAPI Eina_Bool elm_genlist_item_display_only_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19311 * Show the portion of a genlist's internal list containing a given
19312 * item, immediately.
19314 * @param it The item to display
19316 * This causes genlist to jump to the given item @p it and show it (by
19317 * immediately scrolling to that position), if it is not fully visible.
19319 * @see elm_genlist_item_bring_in()
19320 * @see elm_genlist_item_top_show()
19321 * @see elm_genlist_item_middle_show()
19325 EAPI void elm_genlist_item_show(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19327 * Animatedly bring in, to the visible are of a genlist, a given
19330 * @param it The item to display
19332 * This causes genlist to jump to the given item @p it and show it (by
19333 * animatedly scrolling), if it is not fully visible. This may use animation
19334 * to do so and take a period of time
19336 * @see elm_genlist_item_show()
19337 * @see elm_genlist_item_top_bring_in()
19338 * @see elm_genlist_item_middle_bring_in()
19342 EAPI void elm_genlist_item_bring_in(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19344 * Show the portion of a genlist's internal list containing a given
19345 * item, immediately.
19347 * @param it The item to display
19349 * This causes genlist to jump to the given item @p it and show it (by
19350 * immediately scrolling to that position), if it is not fully visible.
19352 * The item will be positioned at the top of the genlist viewport.
19354 * @see elm_genlist_item_show()
19355 * @see elm_genlist_item_top_bring_in()
19359 EAPI void elm_genlist_item_top_show(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19361 * Animatedly bring in, to the visible are of a genlist, a given
19364 * @param it The item
19366 * This causes genlist to jump to the given item @p it and show it (by
19367 * animatedly scrolling), if it is not fully visible. This may use animation
19368 * to do so and take a period of time
19370 * The item will be positioned at the top of the genlist viewport.
19372 * @see elm_genlist_item_bring_in()
19373 * @see elm_genlist_item_top_show()
19377 EAPI void elm_genlist_item_top_bring_in(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19379 * Show the portion of a genlist's internal list containing a given
19380 * item, immediately.
19382 * @param it The item to display
19384 * This causes genlist to jump to the given item @p it and show it (by
19385 * immediately scrolling to that position), if it is not fully visible.
19387 * The item will be positioned at the middle of the genlist viewport.
19389 * @see elm_genlist_item_show()
19390 * @see elm_genlist_item_middle_bring_in()
19394 EAPI void elm_genlist_item_middle_show(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19396 * Animatedly bring in, to the visible are of a genlist, a given
19399 * @param it The item
19401 * This causes genlist to jump to the given item @p it and show it (by
19402 * animatedly scrolling), if it is not fully visible. This may use animation
19403 * to do so and take a period of time
19405 * The item will be positioned at the middle of the genlist viewport.
19407 * @see elm_genlist_item_bring_in()
19408 * @see elm_genlist_item_middle_show()
19412 EAPI void elm_genlist_item_middle_bring_in(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19414 * Remove a genlist item from the its parent, deleting it.
19416 * @param item The item to be removed.
19417 * @return @c EINA_TRUE on success or @c EINA_FALSE, otherwise.
19419 * @see elm_genlist_clear(), to remove all items in a genlist at
19424 EAPI void elm_genlist_item_del(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19426 * Return the data associated to a given genlist item
19428 * @param item The genlist item.
19429 * @return the data associated to this item.
19431 * This returns the @c data value passed on the
19432 * elm_genlist_item_append() and related item addition calls.
19434 * @see elm_genlist_item_append()
19435 * @see elm_genlist_item_data_set()
19439 EAPI void *elm_genlist_item_data_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19441 * Set the data associated to a given genlist item
19443 * @param item The genlist item
19444 * @param data The new data pointer to set on it
19446 * This @b overrides the @c data value passed on the
19447 * elm_genlist_item_append() and related item addition calls. This
19448 * function @b won't call elm_genlist_item_update() automatically,
19449 * so you'd issue it afterwards if you want to hove the item
19450 * updated to reflect the that new data.
19452 * @see elm_genlist_item_data_get()
19456 EAPI void elm_genlist_item_data_set(Elm_Genlist_Item *it, const void *data) EINA_ARG_NONNULL(1);
19458 * Tells genlist to "orphan" icons fetchs by the item class
19460 * @param it The item
19462 * This instructs genlist to release references to icons in the item,
19463 * meaning that they will no longer be managed by genlist and are
19464 * floating "orphans" that can be re-used elsewhere if the user wants
19469 EAPI void elm_genlist_item_contents_orphan(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19470 EINA_DEPRECATED EAPI void elm_genlist_item_icons_orphan(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19472 * Get the real Evas object created to implement the view of a
19473 * given genlist item
19475 * @param item The genlist item.
19476 * @return the Evas object implementing this item's view.
19478 * This returns the actual Evas object used to implement the
19479 * specified genlist item's view. This may be @c NULL, as it may
19480 * not have been created or may have been deleted, at any time, by
19481 * the genlist. <b>Do not modify this object</b> (move, resize,
19482 * show, hide, etc.), as the genlist is controlling it. This
19483 * function is for querying, emitting custom signals or hooking
19484 * lower level callbacks for events on that object. Do not delete
19485 * this object under any circumstances.
19487 * @see elm_genlist_item_data_get()
19491 EAPI const Evas_Object *elm_genlist_item_object_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19493 * Update the contents of an item
19495 * @param it The item
19497 * This updates an item by calling all the item class functions again
19498 * to get the icons, labels and states. Use this when the original
19499 * item data has changed and the changes are desired to be reflected.
19501 * Use elm_genlist_realized_items_update() to update all already realized
19504 * @see elm_genlist_realized_items_update()
19508 EAPI void elm_genlist_item_update(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19510 * Promote an item to the top of the list
19512 * @param it The item
19516 EAPI void elm_genlist_item_promote(Elm_Gen_Item *it) EINA_ARG_NONNULL(1);
19518 * Demote an item to the end of the list
19520 * @param it The item
19524 EAPI void elm_genlist_item_demote(Elm_Gen_Item *it) EINA_ARG_NONNULL(1);
19526 * Update the part of an item
19528 * @param it The item
19529 * @param parts The name of item's part
19530 * @param itf The flags of item's part type
19532 * This updates an item's part by calling item's fetching functions again
19533 * to get the icons, labels and states. Use this when the original
19534 * item data has changed and the changes are desired to be reflected.
19535 * Second parts argument is used for globbing to match '*', '?', and '.'
19536 * It can be used at updating multi fields.
19538 * Use elm_genlist_realized_items_update() to update an item's all
19541 * @see elm_genlist_item_update()
19545 EAPI void elm_genlist_item_fields_update(Elm_Genlist_Item *it, const char *parts, Elm_Genlist_Item_Field_Flags itf) EINA_ARG_NONNULL(1);
19547 * Update the item class of an item
19549 * @param it The item
19550 * @param itc The item class for the item
19552 * This sets another class fo the item, changing the way that it is
19553 * displayed. After changing the item class, elm_genlist_item_update() is
19554 * called on the item @p it.
19558 EAPI void elm_genlist_item_item_class_update(Elm_Genlist_Item *it, const Elm_Genlist_Item_Class *itc) EINA_ARG_NONNULL(1, 2);
19559 EAPI const Elm_Genlist_Item_Class *elm_genlist_item_item_class_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19561 * Set the text to be shown in a given genlist item's tooltips.
19563 * @param item The genlist item
19564 * @param text The text to set in the content
19566 * This call will setup the text to be used as tooltip to that item
19567 * (analogous to elm_object_tooltip_text_set(), but being item
19568 * tooltips with higher precedence than object tooltips). It can
19569 * have only one tooltip at a time, so any previous tooltip data
19570 * will get removed.
19572 * In order to set an icon or something else as a tooltip, look at
19573 * elm_genlist_item_tooltip_content_cb_set().
19577 EAPI void elm_genlist_item_tooltip_text_set(Elm_Genlist_Item *item, const char *text) EINA_ARG_NONNULL(1);
19579 * Set the content to be shown in a given genlist item's tooltips
19581 * @param item The genlist item.
19582 * @param func The function returning the tooltip contents.
19583 * @param data What to provide to @a func as callback data/context.
19584 * @param del_cb Called when data is not needed anymore, either when
19585 * another callback replaces @p func, the tooltip is unset with
19586 * elm_genlist_item_tooltip_unset() or the owner @p item
19587 * dies. This callback receives as its first parameter the
19588 * given @p data, being @c event_info the item handle.
19590 * This call will setup the tooltip's contents to @p item
19591 * (analogous to elm_object_tooltip_content_cb_set(), but being
19592 * item tooltips with higher precedence than object tooltips). It
19593 * can have only one tooltip at a time, so any previous tooltip
19594 * content will get removed. @p func (with @p data) will be called
19595 * every time Elementary needs to show the tooltip and it should
19596 * return a valid Evas object, which will be fully managed by the
19597 * tooltip system, getting deleted when the tooltip is gone.
19599 * In order to set just a text as a tooltip, look at
19600 * elm_genlist_item_tooltip_text_set().
19604 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);
19606 * Unset a tooltip from a given genlist item
19608 * @param item genlist item to remove a previously set tooltip from.
19610 * This call removes any tooltip set on @p item. The callback
19611 * provided as @c del_cb to
19612 * elm_genlist_item_tooltip_content_cb_set() will be called to
19613 * notify it is not used anymore (and have resources cleaned, if
19616 * @see elm_genlist_item_tooltip_content_cb_set()
19620 EAPI void elm_genlist_item_tooltip_unset(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19622 * Set a different @b style for a given genlist item's tooltip.
19624 * @param item genlist item with tooltip set
19625 * @param style the <b>theme style</b> to use on tooltips (e.g. @c
19626 * "default", @c "transparent", etc)
19628 * Tooltips can have <b>alternate styles</b> to be displayed on,
19629 * which are defined by the theme set on Elementary. This function
19630 * works analogously as elm_object_tooltip_style_set(), but here
19631 * applied only to genlist item objects. The default style for
19632 * tooltips is @c "default".
19634 * @note before you set a style you should define a tooltip with
19635 * elm_genlist_item_tooltip_content_cb_set() or
19636 * elm_genlist_item_tooltip_text_set()
19638 * @see elm_genlist_item_tooltip_style_get()
19642 EAPI void elm_genlist_item_tooltip_style_set(Elm_Genlist_Item *item, const char *style) EINA_ARG_NONNULL(1);
19644 * Get the style set a given genlist item's tooltip.
19646 * @param item genlist item with tooltip already set on.
19647 * @return style the theme style in use, which defaults to
19648 * "default". If the object does not have a tooltip set,
19649 * then @c NULL is returned.
19651 * @see elm_genlist_item_tooltip_style_set() for more details
19655 EAPI const char *elm_genlist_item_tooltip_style_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19657 * @brief Disable size restrictions on an object's tooltip
19658 * @param item The tooltip's anchor object
19659 * @param disable If EINA_TRUE, size restrictions are disabled
19660 * @return EINA_FALSE on failure, EINA_TRUE on success
19662 * This function allows a tooltip to expand beyond its parant window's canvas.
19663 * It will instead be limited only by the size of the display.
19665 EAPI Eina_Bool elm_genlist_item_tooltip_size_restrict_disable(Elm_Genlist_Item *item, Eina_Bool disable);
19667 * @brief Retrieve size restriction state of an object's tooltip
19668 * @param item The tooltip's anchor object
19669 * @return If EINA_TRUE, size restrictions are disabled
19671 * This function returns whether a tooltip is allowed to expand beyond
19672 * its parant window's canvas.
19673 * It will instead be limited only by the size of the display.
19675 EAPI Eina_Bool elm_genlist_item_tooltip_size_restrict_disabled_get(const Elm_Genlist_Item *item);
19677 * Set the type of mouse pointer/cursor decoration to be shown,
19678 * when the mouse pointer is over the given genlist widget item
19680 * @param item genlist item to customize cursor on
19681 * @param cursor the cursor type's name
19683 * This function works analogously as elm_object_cursor_set(), but
19684 * here the cursor's changing area is restricted to the item's
19685 * area, and not the whole widget's. Note that that item cursors
19686 * have precedence over widget cursors, so that a mouse over @p
19687 * item will always show cursor @p type.
19689 * If this function is called twice for an object, a previously set
19690 * cursor will be unset on the second call.
19692 * @see elm_object_cursor_set()
19693 * @see elm_genlist_item_cursor_get()
19694 * @see elm_genlist_item_cursor_unset()
19698 EAPI void elm_genlist_item_cursor_set(Elm_Genlist_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
19700 * Get the type of mouse pointer/cursor decoration set to be shown,
19701 * when the mouse pointer is over the given genlist widget item
19703 * @param item genlist item with custom cursor set
19704 * @return the cursor type's name or @c NULL, if no custom cursors
19705 * were set to @p item (and on errors)
19707 * @see elm_object_cursor_get()
19708 * @see elm_genlist_item_cursor_set() for more details
19709 * @see elm_genlist_item_cursor_unset()
19713 EAPI const char *elm_genlist_item_cursor_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19715 * Unset any custom mouse pointer/cursor decoration set to be
19716 * shown, when the mouse pointer is over the given genlist widget
19717 * item, thus making it show the @b default cursor again.
19719 * @param item a genlist item
19721 * Use this call to undo any custom settings on this item's cursor
19722 * decoration, bringing it back to defaults (no custom style set).
19724 * @see elm_object_cursor_unset()
19725 * @see elm_genlist_item_cursor_set() for more details
19729 EAPI void elm_genlist_item_cursor_unset(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19731 * Set a different @b style for a given custom cursor set for a
19734 * @param item genlist item with custom cursor set
19735 * @param style the <b>theme style</b> to use (e.g. @c "default",
19736 * @c "transparent", etc)
19738 * This function only makes sense when one is using custom mouse
19739 * cursor decorations <b>defined in a theme file</b> , which can
19740 * have, given a cursor name/type, <b>alternate styles</b> on
19741 * it. It works analogously as elm_object_cursor_style_set(), but
19742 * here applied only to genlist item objects.
19744 * @warning Before you set a cursor style you should have defined a
19745 * custom cursor previously on the item, with
19746 * elm_genlist_item_cursor_set()
19748 * @see elm_genlist_item_cursor_engine_only_set()
19749 * @see elm_genlist_item_cursor_style_get()
19753 EAPI void elm_genlist_item_cursor_style_set(Elm_Genlist_Item *item, const char *style) EINA_ARG_NONNULL(1);
19755 * Get the current @b style set for a given genlist item's custom
19758 * @param item genlist item with custom cursor set.
19759 * @return style the cursor style in use. If the object does not
19760 * have a cursor set, then @c NULL is returned.
19762 * @see elm_genlist_item_cursor_style_set() for more details
19766 EAPI const char *elm_genlist_item_cursor_style_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19768 * Set if the (custom) cursor for a given genlist item should be
19769 * searched in its theme, also, or should only rely on the
19770 * rendering engine.
19772 * @param item item with custom (custom) cursor already set on
19773 * @param engine_only Use @c EINA_TRUE to have cursors looked for
19774 * only on those provided by the rendering engine, @c EINA_FALSE to
19775 * have them searched on the widget's theme, as well.
19777 * @note This call is of use only if you've set a custom cursor
19778 * for genlist items, with elm_genlist_item_cursor_set().
19780 * @note By default, cursors will only be looked for between those
19781 * provided by the rendering engine.
19785 EAPI void elm_genlist_item_cursor_engine_only_set(Elm_Genlist_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
19787 * Get if the (custom) cursor for a given genlist item is being
19788 * searched in its theme, also, or is only relying on the rendering
19791 * @param item a genlist item
19792 * @return @c EINA_TRUE, if cursors are being looked for only on
19793 * those provided by the rendering engine, @c EINA_FALSE if they
19794 * are being searched on the widget's theme, as well.
19796 * @see elm_genlist_item_cursor_engine_only_set(), for more details
19800 EAPI Eina_Bool elm_genlist_item_cursor_engine_only_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19802 * Update the contents of all realized items.
19804 * @param obj The genlist object.
19806 * This updates all realized items by calling all the item class functions again
19807 * to get the icons, labels and states. Use this when the original
19808 * item data has changed and the changes are desired to be reflected.
19810 * To update just one item, use elm_genlist_item_update().
19812 * @see elm_genlist_realized_items_get()
19813 * @see elm_genlist_item_update()
19817 EAPI void elm_genlist_realized_items_update(Evas_Object *obj) EINA_ARG_NONNULL(1);
19819 * Activate a genlist mode on an item
19821 * @param item The genlist item
19822 * @param mode Mode name
19823 * @param mode_set Boolean to define set or unset mode.
19825 * A genlist mode is a different way of selecting an item. Once a mode is
19826 * activated on an item, any other selected item is immediately unselected.
19827 * This feature provides an easy way of implementing a new kind of animation
19828 * for selecting an item, without having to entirely rewrite the item style
19829 * theme. However, the elm_genlist_selected_* API can't be used to get what
19830 * item is activate for a mode.
19832 * The current item style will still be used, but applying a genlist mode to
19833 * an item will select it using a different kind of animation.
19835 * The current active item for a mode can be found by
19836 * elm_genlist_mode_item_get().
19838 * The characteristics of genlist mode are:
19839 * - Only one mode can be active at any time, and for only one item.
19840 * - Genlist handles deactivating other items when one item is activated.
19841 * - A mode is defined in the genlist theme (edc), and more modes can easily
19843 * - A mode style and the genlist item style are different things. They
19844 * can be combined to provide a default style to the item, with some kind
19845 * of animation for that item when the mode is activated.
19847 * When a mode is activated on an item, a new view for that item is created.
19848 * The theme of this mode defines the animation that will be used to transit
19849 * the item from the old view to the new view. This second (new) view will be
19850 * active for that item while the mode is active on the item, and will be
19851 * destroyed after the mode is totally deactivated from that item.
19853 * @see elm_genlist_mode_get()
19854 * @see elm_genlist_mode_item_get()
19858 EAPI void elm_genlist_item_mode_set(Elm_Genlist_Item *it, const char *mode_type, Eina_Bool mode_set) EINA_ARG_NONNULL(1, 2);
19860 * Get the last (or current) genlist mode used.
19862 * @param obj The genlist object
19864 * This function just returns the name of the last used genlist mode. It will
19865 * be the current mode if it's still active.
19867 * @see elm_genlist_item_mode_set()
19868 * @see elm_genlist_mode_item_get()
19872 EAPI const char *elm_genlist_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19874 * Get active genlist mode item
19876 * @param obj The genlist object
19877 * @return The active item for that current mode. Or @c NULL if no item is
19878 * activated with any mode.
19880 * This function returns the item that was activated with a mode, by the
19881 * function elm_genlist_item_mode_set().
19883 * @see elm_genlist_item_mode_set()
19884 * @see elm_genlist_mode_get()
19888 EAPI const Elm_Genlist_Item *elm_genlist_mode_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19893 * @param obj The genlist object
19894 * @param reorder_mode The reorder mode
19895 * (EINA_TRUE = on, EINA_FALSE = off)
19899 EAPI void elm_genlist_reorder_mode_set(Evas_Object *obj, Eina_Bool reorder_mode) EINA_ARG_NONNULL(1);
19902 * Get the reorder mode
19904 * @param obj The genlist object
19905 * @return The reorder mode
19906 * (EINA_TRUE = on, EINA_FALSE = off)
19910 EAPI Eina_Bool elm_genlist_reorder_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19917 * @defgroup Check Check
19919 * @image html img/widget/check/preview-00.png
19920 * @image latex img/widget/check/preview-00.eps
19921 * @image html img/widget/check/preview-01.png
19922 * @image latex img/widget/check/preview-01.eps
19923 * @image html img/widget/check/preview-02.png
19924 * @image latex img/widget/check/preview-02.eps
19926 * @brief The check widget allows for toggling a value between true and
19929 * Check objects are a lot like radio objects in layout and functionality
19930 * except they do not work as a group, but independently and only toggle the
19931 * value of a boolean from false to true (0 or 1). elm_check_state_set() sets
19932 * the boolean state (1 for true, 0 for false), and elm_check_state_get()
19933 * returns the current state. For convenience, like the radio objects, you
19934 * can set a pointer to a boolean directly with elm_check_state_pointer_set()
19935 * for it to modify.
19937 * Signals that you can add callbacks for are:
19938 * "changed" - This is called whenever the user changes the state of one of
19939 * the check object(event_info is NULL).
19941 * Default contents parts of the check widget that you can use for are:
19942 * @li "icon" - An icon of the check
19944 * Default text parts of the check widget that you can use for are:
19945 * @li "elm.text" - Label of the check
19947 * @ref tutorial_check should give you a firm grasp of how to use this widget
19952 * @brief Add a new Check object
19954 * @param parent The parent object
19955 * @return The new object or NULL if it cannot be created
19957 EAPI Evas_Object *elm_check_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
19959 * @brief Set the text label of the check object
19961 * @param obj The check object
19962 * @param label The text label string in UTF-8
19964 * @deprecated use elm_object_text_set() instead.
19966 EINA_DEPRECATED EAPI void elm_check_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
19968 * @brief Get the text label of the check object
19970 * @param obj The check object
19971 * @return The text label string in UTF-8
19973 * @deprecated use elm_object_text_get() instead.
19975 EINA_DEPRECATED EAPI const char *elm_check_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19977 * @brief Set the icon object of the check object
19979 * @param obj The check object
19980 * @param icon The icon object
19982 * Once the icon object is set, a previously set one will be deleted.
19983 * If you want to keep that old content object, use the
19984 * elm_object_content_unset() function.
19986 * @deprecated use elm_object_part_content_set() instead.
19989 EINA_DEPRECATED EAPI void elm_check_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
19991 * @brief Get the icon object of the check object
19993 * @param obj The check object
19994 * @return The icon object
19996 * @deprecated use elm_object_part_content_get() instead.
19999 EINA_DEPRECATED EAPI Evas_Object *elm_check_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20001 * @brief Unset the icon used for the check object
20003 * @param obj The check object
20004 * @return The icon object that was being used
20006 * Unparent and return the icon object which was set for this widget.
20008 * @deprecated use elm_object_part_content_unset() instead.
20011 EINA_DEPRECATED EAPI Evas_Object *elm_check_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
20013 * @brief Set the on/off state of the check object
20015 * @param obj The check object
20016 * @param state The state to use (1 == on, 0 == off)
20018 * This sets the state of the check. If set
20019 * with elm_check_state_pointer_set() the state of that variable is also
20020 * changed. Calling this @b doesn't cause the "changed" signal to be emited.
20022 EAPI void elm_check_state_set(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
20024 * @brief Get the state of the check object
20026 * @param obj The check object
20027 * @return The boolean state
20029 EAPI Eina_Bool elm_check_state_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20031 * @brief Set a convenience pointer to a boolean to change
20033 * @param obj The check object
20034 * @param statep Pointer to the boolean to modify
20036 * This sets a pointer to a boolean, that, in addition to the check objects
20037 * state will also be modified directly. To stop setting the object pointed
20038 * to simply use NULL as the @p statep parameter. If @p statep is not NULL,
20039 * then when this is called, the check objects state will also be modified to
20040 * reflect the value of the boolean @p statep points to, just like calling
20041 * elm_check_state_set().
20043 EAPI void elm_check_state_pointer_set(Evas_Object *obj, Eina_Bool *statep) EINA_ARG_NONNULL(1);
20044 EINA_DEPRECATED EAPI void elm_check_states_labels_set(Evas_Object *obj, const char *ontext, const char *offtext) EINA_ARG_NONNULL(1,2,3);
20045 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);
20052 * @defgroup Radio Radio
20054 * @image html img/widget/radio/preview-00.png
20055 * @image latex img/widget/radio/preview-00.eps
20057 * @brief Radio is a widget that allows for 1 or more options to be displayed
20058 * and have the user choose only 1 of them.
20060 * A radio object contains an indicator, an optional Label and an optional
20061 * icon object. While it's possible to have a group of only one radio they,
20062 * are normally used in groups of 2 or more. To add a radio to a group use
20063 * elm_radio_group_add(). The radio object(s) will select from one of a set
20064 * of integer values, so any value they are configuring needs to be mapped to
20065 * a set of integers. To configure what value that radio object represents,
20066 * use elm_radio_state_value_set() to set the integer it represents. To set
20067 * the value the whole group(which one is currently selected) is to indicate
20068 * use elm_radio_value_set() on any group member, and to get the groups value
20069 * use elm_radio_value_get(). For convenience the radio objects are also able
20070 * to directly set an integer(int) to the value that is selected. To specify
20071 * the pointer to this integer to modify, use elm_radio_value_pointer_set().
20072 * The radio objects will modify this directly. That implies the pointer must
20073 * point to valid memory for as long as the radio objects exist.
20075 * Signals that you can add callbacks for are:
20076 * @li changed - This is called whenever the user changes the state of one of
20077 * the radio objects within the group of radio objects that work together.
20079 * Default contents parts of the radio widget that you can use for are:
20080 * @li "icon" - An icon of the radio
20082 * @ref tutorial_radio show most of this API in action.
20086 * @brief Add a new radio to the parent
20088 * @param parent The parent object
20089 * @return The new object or NULL if it cannot be created
20091 EAPI Evas_Object *elm_radio_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20093 * @brief Set the text label of the radio object
20095 * @param obj The radio object
20096 * @param label The text label string in UTF-8
20098 * @deprecated use elm_object_text_set() instead.
20100 EINA_DEPRECATED EAPI void elm_radio_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
20102 * @brief Get the text label of the radio object
20104 * @param obj The radio object
20105 * @return The text label string in UTF-8
20107 * @deprecated use elm_object_text_set() instead.
20109 EINA_DEPRECATED EAPI const char *elm_radio_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20111 * @brief Set the icon object of the radio object
20113 * @param obj The radio object
20114 * @param icon The icon object
20116 * Once the icon object is set, a previously set one will be deleted. If you
20117 * want to keep that old content object, use the elm_radio_icon_unset()
20120 * @deprecated use elm_object_part_content_set() instead.
20123 EINA_DEPRECATED EAPI void elm_radio_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
20125 * @brief Get the icon object of the radio object
20127 * @param obj The radio object
20128 * @return The icon object
20130 * @see elm_radio_icon_set()
20132 * @deprecated use elm_object_part_content_get() instead.
20135 EINA_DEPRECATED EAPI Evas_Object *elm_radio_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20137 * @brief Unset the icon used for the radio object
20139 * @param obj The radio object
20140 * @return The icon object that was being used
20142 * Unparent and return the icon object which was set for this widget.
20144 * @see elm_radio_icon_set()
20145 * @deprecated use elm_object_part_content_unset() instead.
20148 EINA_DEPRECATED EAPI Evas_Object *elm_radio_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
20150 * @brief Add this radio to a group of other radio objects
20152 * @param obj The radio object
20153 * @param group Any object whose group the @p obj is to join.
20155 * Radio objects work in groups. Each member should have a different integer
20156 * value assigned. In order to have them work as a group, they need to know
20157 * about each other. This adds the given radio object to the group of which
20158 * the group object indicated is a member.
20160 EAPI void elm_radio_group_add(Evas_Object *obj, Evas_Object *group) EINA_ARG_NONNULL(1);
20162 * @brief Set the integer value that this radio object represents
20164 * @param obj The radio object
20165 * @param value The value to use if this radio object is selected
20167 * This sets the value of the radio.
20169 EAPI void elm_radio_state_value_set(Evas_Object *obj, int value) EINA_ARG_NONNULL(1);
20171 * @brief Get the integer value that this radio object represents
20173 * @param obj The radio object
20174 * @return The value used if this radio object is selected
20176 * This gets the value of the radio.
20178 * @see elm_radio_value_set()
20180 EAPI int elm_radio_state_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20182 * @brief Set the value of the radio.
20184 * @param obj The radio object
20185 * @param value The value to use for the group
20187 * This sets the value of the radio group and will also set the value if
20188 * pointed to, to the value supplied, but will not call any callbacks.
20190 EAPI void elm_radio_value_set(Evas_Object *obj, int value) EINA_ARG_NONNULL(1);
20192 * @brief Get the state of the radio object
20194 * @param obj The radio object
20195 * @return The integer state
20197 EAPI int elm_radio_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20199 * @brief Set a convenience pointer to a integer to change
20201 * @param obj The radio object
20202 * @param valuep Pointer to the integer to modify
20204 * This sets a pointer to a integer, that, in addition to the radio objects
20205 * state will also be modified directly. To stop setting the object pointed
20206 * to simply use NULL as the @p valuep argument. If valuep is not NULL, then
20207 * when this is called, the radio objects state will also be modified to
20208 * reflect the value of the integer valuep points to, just like calling
20209 * elm_radio_value_set().
20211 EAPI void elm_radio_value_pointer_set(Evas_Object *obj, int *valuep) EINA_ARG_NONNULL(1);
20217 * @defgroup Pager Pager
20219 * @image html img/widget/pager/preview-00.png
20220 * @image latex img/widget/pager/preview-00.eps
20222 * @brief Widget that allows flipping between one or more āpagesā
20225 * The flipping between pages of objects is animated. All content
20226 * in the pager is kept in a stack, being the last content added
20227 * (visible one) on the top of that stack.
20229 * Objects can be pushed or popped from the stack or deleted as
20230 * well. Pushes and pops will animate the widget accordingly to its
20231 * style (a pop will also delete the child object once the
20232 * animation is finished). Any object already in the pager can be
20233 * promoted to the top (from its current stacking position) through
20234 * the use of elm_pager_content_promote(). New objects are pushed
20235 * to the top with elm_pager_content_push(). When the top item is
20236 * no longer wanted, simply pop it with elm_pager_content_pop() and
20237 * it will also be deleted. If an object is no longer needed and is
20238 * not the top item, just delete it as normal. You can query which
20239 * objects are the top and bottom with
20240 * elm_pager_content_bottom_get() and elm_pager_content_top_get().
20242 * Signals that you can add callbacks for are:
20243 * - @c "show,finished" - when a new page is actually shown on the top
20244 * - @c "hide,finished" - when a previous page is hidden
20246 * Only after the first of that signals the child object is
20247 * guaranteed to be visible, as in @c evas_object_visible_get().
20249 * This widget has the following styles available:
20252 * - @c "fade_translucide"
20253 * - @c "fade_invisible"
20255 * @note These styles affect only the flipping animations on the
20256 * default theme; the appearance when not animating is unaffected
20259 * @ref tutorial_pager gives a good overview of the usage of the API.
20264 * Add a new pager to the parent
20266 * @param parent The parent object
20267 * @return The new object or NULL if it cannot be created
20271 EAPI Evas_Object *elm_pager_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20274 * @brief Push an object to the top of the pager stack (and show it).
20276 * @param obj The pager object
20277 * @param content The object to push
20279 * The object pushed becomes a child of the pager, it will be controlled and
20280 * deleted when the pager is deleted.
20282 * @note If the content is already in the stack use
20283 * elm_pager_content_promote().
20284 * @warning Using this function on @p content already in the stack results in
20285 * undefined behavior.
20287 EAPI void elm_pager_content_push(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
20290 * @brief Pop the object that is on top of the stack
20292 * @param obj The pager object
20294 * This pops the object that is on the top(visible) of the pager, makes it
20295 * disappear, then deletes the object. The object that was underneath it on
20296 * the stack will become visible.
20298 EAPI void elm_pager_content_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
20301 * @brief Moves an object already in the pager stack to the top of the stack.
20303 * @param obj The pager object
20304 * @param content The object to promote
20306 * This will take the @p content and move it to the top of the stack as
20307 * if it had been pushed there.
20309 * @note If the content isn't already in the stack use
20310 * elm_pager_content_push().
20311 * @warning Using this function on @p content not already in the stack
20312 * results in undefined behavior.
20314 EAPI void elm_pager_content_promote(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
20317 * @brief Return the object at the bottom of the pager stack
20319 * @param obj The pager object
20320 * @return The bottom object or NULL if none
20322 EAPI Evas_Object *elm_pager_content_bottom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20325 * @brief Return the object at the top of the pager stack
20327 * @param obj The pager object
20328 * @return The top object or NULL if none
20330 EAPI Evas_Object *elm_pager_content_top_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20337 * @defgroup Slideshow Slideshow
20339 * @image html img/widget/slideshow/preview-00.png
20340 * @image latex img/widget/slideshow/preview-00.eps
20342 * This widget, as the name indicates, is a pre-made image
20343 * slideshow panel, with API functions acting on (child) image
20344 * items presentation. Between those actions, are:
20345 * - advance to next/previous image
20346 * - select the style of image transition animation
20347 * - set the exhibition time for each image
20348 * - start/stop the slideshow
20350 * The transition animations are defined in the widget's theme,
20351 * consequently new animations can be added without having to
20352 * update the widget's code.
20354 * @section Slideshow_Items Slideshow items
20356 * For slideshow items, just like for @ref Genlist "genlist" ones,
20357 * the user defines a @b classes, specifying functions that will be
20358 * called on the item's creation and deletion times.
20360 * The #Elm_Slideshow_Item_Class structure contains the following
20363 * - @c func.get - When an item is displayed, this function is
20364 * called, and it's where one should create the item object, de
20365 * facto. For example, the object can be a pure Evas image object
20366 * or an Elementary @ref Photocam "photocam" widget. See
20367 * #SlideshowItemGetFunc.
20368 * - @c func.del - When an item is no more displayed, this function
20369 * is called, where the user must delete any data associated to
20370 * the item. See #SlideshowItemDelFunc.
20372 * @section Slideshow_Caching Slideshow caching
20374 * The slideshow provides facilities to have items adjacent to the
20375 * one being displayed <b>already "realized"</b> (i.e. loaded) for
20376 * you, so that the system does not have to decode image data
20377 * anymore at the time it has to actually switch images on its
20378 * viewport. The user is able to set the numbers of items to be
20379 * cached @b before and @b after the current item, in the widget's
20382 * Smart events one can add callbacks for are:
20384 * - @c "changed" - when the slideshow switches its view to a new
20387 * List of examples for the slideshow widget:
20388 * @li @ref slideshow_example
20392 * @addtogroup Slideshow
20396 typedef struct _Elm_Slideshow_Item_Class Elm_Slideshow_Item_Class; /**< Slideshow item class definition struct */
20397 typedef struct _Elm_Slideshow_Item_Class_Func Elm_Slideshow_Item_Class_Func; /**< Class functions for slideshow item classes. */
20398 typedef struct _Elm_Slideshow_Item Elm_Slideshow_Item; /**< Slideshow item handle */
20399 typedef Evas_Object *(*SlideshowItemGetFunc) (void *data, Evas_Object *obj); /**< Image fetching class function for slideshow item classes. */
20400 typedef void (*SlideshowItemDelFunc) (void *data, Evas_Object *obj); /**< Deletion class function for slideshow item classes. */
20403 * @struct _Elm_Slideshow_Item_Class
20405 * Slideshow item class definition. See @ref Slideshow_Items for
20408 struct _Elm_Slideshow_Item_Class
20410 struct _Elm_Slideshow_Item_Class_Func
20412 SlideshowItemGetFunc get;
20413 SlideshowItemDelFunc del;
20415 }; /**< #Elm_Slideshow_Item_Class member definitions */
20418 * Add a new slideshow widget to the given parent Elementary
20419 * (container) object
20421 * @param parent The parent object
20422 * @return A new slideshow widget handle or @c NULL, on errors
20424 * This function inserts a new slideshow widget on the canvas.
20426 * @ingroup Slideshow
20428 EAPI Evas_Object *elm_slideshow_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20431 * Add (append) a new item in a given slideshow widget.
20433 * @param obj The slideshow object
20434 * @param itc The item class for the item
20435 * @param data The item's data
20436 * @return A handle to the item added or @c NULL, on errors
20438 * Add a new item to @p obj's internal list of items, appending it.
20439 * The item's class must contain the function really fetching the
20440 * image object to show for this item, which could be an Evas image
20441 * object or an Elementary photo, for example. The @p data
20442 * parameter is going to be passed to both class functions of the
20445 * @see #Elm_Slideshow_Item_Class
20446 * @see elm_slideshow_item_sorted_insert()
20448 * @ingroup Slideshow
20450 EAPI Elm_Slideshow_Item *elm_slideshow_item_add(Evas_Object *obj, const Elm_Slideshow_Item_Class *itc, const void *data) EINA_ARG_NONNULL(1);
20453 * Insert a new item into the given slideshow widget, using the @p func
20454 * function to sort items (by item handles).
20456 * @param obj The slideshow object
20457 * @param itc The item class for the item
20458 * @param data The item's data
20459 * @param func The comparing function to be used to sort slideshow
20460 * items <b>by #Elm_Slideshow_Item item handles</b>
20461 * @return Returns The slideshow item handle, on success, or
20462 * @c NULL, on errors
20464 * Add a new item to @p obj's internal list of items, in a position
20465 * determined by the @p func comparing function. The item's class
20466 * must contain the function really fetching the image object to
20467 * show for this item, which could be an Evas image object or an
20468 * Elementary photo, for example. The @p data parameter is going to
20469 * be passed to both class functions of the item.
20471 * @see #Elm_Slideshow_Item_Class
20472 * @see elm_slideshow_item_add()
20474 * @ingroup Slideshow
20476 EAPI Elm_Slideshow_Item *elm_slideshow_item_sorted_insert(Evas_Object *obj, const Elm_Slideshow_Item_Class *itc, const void *data, Eina_Compare_Cb func) EINA_ARG_NONNULL(1);
20479 * Display a given slideshow widget's item, programmatically.
20481 * @param obj The slideshow object
20482 * @param item The item to display on @p obj's viewport
20484 * The change between the current item and @p item will use the
20485 * transition @p obj is set to use (@see
20486 * elm_slideshow_transition_set()).
20488 * @ingroup Slideshow
20490 EAPI void elm_slideshow_show(Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
20493 * Slide to the @b next item, in a given slideshow widget
20495 * @param obj The slideshow object
20497 * The sliding animation @p obj is set to use will be the
20498 * transition effect used, after this call is issued.
20500 * @note If the end of the slideshow's internal list of items is
20501 * reached, it'll wrap around to the list's beginning, again.
20503 * @ingroup Slideshow
20505 EAPI void elm_slideshow_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
20508 * Slide to the @b previous item, in a given slideshow widget
20510 * @param obj The slideshow object
20512 * The sliding animation @p obj is set to use will be the
20513 * transition effect used, after this call is issued.
20515 * @note If the beginning of the slideshow's internal list of items
20516 * is reached, it'll wrap around to the list's end, again.
20518 * @ingroup Slideshow
20520 EAPI void elm_slideshow_previous(Evas_Object *obj) EINA_ARG_NONNULL(1);
20523 * Returns the list of sliding transition/effect names available, for a
20524 * given slideshow widget.
20526 * @param obj The slideshow object
20527 * @return The list of transitions (list of @b stringshared strings
20530 * The transitions, which come from @p obj's theme, must be an EDC
20531 * data item named @c "transitions" on the theme file, with (prefix)
20532 * names of EDC programs actually implementing them.
20534 * The available transitions for slideshows on the default theme are:
20535 * - @c "fade" - the current item fades out, while the new one
20536 * fades in to the slideshow's viewport.
20537 * - @c "black_fade" - the current item fades to black, and just
20538 * then, the new item will fade in.
20539 * - @c "horizontal" - the current item slides horizontally, until
20540 * it gets out of the slideshow's viewport, while the new item
20541 * comes from the left to take its place.
20542 * - @c "vertical" - the current item slides vertically, until it
20543 * gets out of the slideshow's viewport, while the new item comes
20544 * from the bottom to take its place.
20545 * - @c "square" - the new item starts to appear from the middle of
20546 * the current one, but with a tiny size, growing until its
20547 * target (full) size and covering the old one.
20549 * @warning The stringshared strings get no new references
20550 * exclusive to the user grabbing the list, here, so if you'd like
20551 * to use them out of this call's context, you'd better @c
20552 * eina_stringshare_ref() them.
20554 * @see elm_slideshow_transition_set()
20556 * @ingroup Slideshow
20558 EAPI const Eina_List *elm_slideshow_transitions_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20561 * Set the current slide transition/effect in use for a given
20564 * @param obj The slideshow object
20565 * @param transition The new transition's name string
20567 * If @p transition is implemented in @p obj's theme (i.e., is
20568 * contained in the list returned by
20569 * elm_slideshow_transitions_get()), this new sliding effect will
20570 * be used on the widget.
20572 * @see elm_slideshow_transitions_get() for more details
20574 * @ingroup Slideshow
20576 EAPI void elm_slideshow_transition_set(Evas_Object *obj, const char *transition) EINA_ARG_NONNULL(1);
20579 * Get the current slide transition/effect in use for a given
20582 * @param obj The slideshow object
20583 * @return The current transition's name
20585 * @see elm_slideshow_transition_set() for more details
20587 * @ingroup Slideshow
20589 EAPI const char *elm_slideshow_transition_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20592 * Set the interval between each image transition on a given
20593 * slideshow widget, <b>and start the slideshow, itself</b>
20595 * @param obj The slideshow object
20596 * @param timeout The new displaying timeout for images
20598 * After this call, the slideshow widget will start cycling its
20599 * view, sequentially and automatically, with the images of the
20600 * items it has. The time between each new image displayed is going
20601 * to be @p timeout, in @b seconds. If a different timeout was set
20602 * previously and an slideshow was in progress, it will continue
20603 * with the new time between transitions, after this call.
20605 * @note A value less than or equal to 0 on @p timeout will disable
20606 * the widget's internal timer, thus halting any slideshow which
20607 * could be happening on @p obj.
20609 * @see elm_slideshow_timeout_get()
20611 * @ingroup Slideshow
20613 EAPI void elm_slideshow_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
20616 * Get the interval set for image transitions on a given slideshow
20619 * @param obj The slideshow object
20620 * @return Returns the timeout set on it
20622 * @see elm_slideshow_timeout_set() for more details
20624 * @ingroup Slideshow
20626 EAPI double elm_slideshow_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20629 * Set if, after a slideshow is started, for a given slideshow
20630 * widget, its items should be displayed cyclically or not.
20632 * @param obj The slideshow object
20633 * @param loop Use @c EINA_TRUE to make it cycle through items or
20634 * @c EINA_FALSE for it to stop at the end of @p obj's internal
20637 * @note elm_slideshow_next() and elm_slideshow_previous() will @b
20638 * ignore what is set by this functions, i.e., they'll @b always
20639 * cycle through items. This affects only the "automatic"
20640 * slideshow, as set by elm_slideshow_timeout_set().
20642 * @see elm_slideshow_loop_get()
20644 * @ingroup Slideshow
20646 EAPI void elm_slideshow_loop_set(Evas_Object *obj, Eina_Bool loop) EINA_ARG_NONNULL(1);
20649 * Get if, after a slideshow is started, for a given slideshow
20650 * widget, its items are to be displayed cyclically or not.
20652 * @param obj The slideshow object
20653 * @return @c EINA_TRUE, if the items in @p obj will be cycled
20654 * through or @c EINA_FALSE, otherwise
20656 * @see elm_slideshow_loop_set() for more details
20658 * @ingroup Slideshow
20660 EAPI Eina_Bool elm_slideshow_loop_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20663 * Remove all items from a given slideshow widget
20665 * @param obj The slideshow object
20667 * This removes (and deletes) all items in @p obj, leaving it
20670 * @see elm_slideshow_item_del(), to remove just one item.
20672 * @ingroup Slideshow
20674 EAPI void elm_slideshow_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
20677 * Get the internal list of items in a given slideshow widget.
20679 * @param obj The slideshow object
20680 * @return The list of items (#Elm_Slideshow_Item as data) or
20681 * @c NULL on errors.
20683 * This list is @b not to be modified in any way and must not be
20684 * freed. Use the list members with functions like
20685 * elm_slideshow_item_del(), elm_slideshow_item_data_get().
20687 * @warning This list is only valid until @p obj object's internal
20688 * items list is changed. It should be fetched again with another
20689 * call to this function when changes happen.
20691 * @ingroup Slideshow
20693 EAPI const Eina_List *elm_slideshow_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20696 * Delete a given item from a slideshow widget.
20698 * @param item The slideshow item
20700 * @ingroup Slideshow
20702 EAPI void elm_slideshow_item_del(Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
20705 * Return the data associated with a given slideshow item
20707 * @param item The slideshow item
20708 * @return Returns the data associated to this item
20710 * @ingroup Slideshow
20712 EAPI void *elm_slideshow_item_data_get(const Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
20715 * Returns the currently displayed item, in a given slideshow widget
20717 * @param obj The slideshow object
20718 * @return A handle to the item being displayed in @p obj or
20719 * @c NULL, if none is (and on errors)
20721 * @ingroup Slideshow
20723 EAPI Elm_Slideshow_Item *elm_slideshow_item_current_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20726 * Get the real Evas object created to implement the view of a
20727 * given slideshow item
20729 * @param item The slideshow item.
20730 * @return the Evas object implementing this item's view.
20732 * This returns the actual Evas object used to implement the
20733 * specified slideshow item's view. This may be @c NULL, as it may
20734 * not have been created or may have been deleted, at any time, by
20735 * the slideshow. <b>Do not modify this object</b> (move, resize,
20736 * show, hide, etc.), as the slideshow is controlling it. This
20737 * function is for querying, emitting custom signals or hooking
20738 * lower level callbacks for events on that object. Do not delete
20739 * this object under any circumstances.
20741 * @see elm_slideshow_item_data_get()
20743 * @ingroup Slideshow
20745 EAPI Evas_Object* elm_slideshow_item_object_get(const Elm_Slideshow_Item* item) EINA_ARG_NONNULL(1);
20748 * Get the the item, in a given slideshow widget, placed at
20749 * position @p nth, in its internal items list
20751 * @param obj The slideshow object
20752 * @param nth The number of the item to grab a handle to (0 being
20754 * @return The item stored in @p obj at position @p nth or @c NULL,
20755 * if there's no item with that index (and on errors)
20757 * @ingroup Slideshow
20759 EAPI Elm_Slideshow_Item *elm_slideshow_item_nth_get(const Evas_Object *obj, unsigned int nth) EINA_ARG_NONNULL(1);
20762 * Set the current slide layout in use for a given slideshow widget
20764 * @param obj The slideshow object
20765 * @param layout The new layout's name string
20767 * If @p layout is implemented in @p obj's theme (i.e., is contained
20768 * in the list returned by elm_slideshow_layouts_get()), this new
20769 * images layout will be used on the widget.
20771 * @see elm_slideshow_layouts_get() for more details
20773 * @ingroup Slideshow
20775 EAPI void elm_slideshow_layout_set(Evas_Object *obj, const char *layout) EINA_ARG_NONNULL(1);
20778 * Get the current slide layout in use for a given slideshow widget
20780 * @param obj The slideshow object
20781 * @return The current layout's name
20783 * @see elm_slideshow_layout_set() for more details
20785 * @ingroup Slideshow
20787 EAPI const char *elm_slideshow_layout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20790 * Returns the list of @b layout names available, for a given
20791 * slideshow widget.
20793 * @param obj The slideshow object
20794 * @return The list of layouts (list of @b stringshared strings
20797 * Slideshow layouts will change how the widget is to dispose each
20798 * image item in its viewport, with regard to cropping, scaling,
20801 * The layouts, which come from @p obj's theme, must be an EDC
20802 * data item name @c "layouts" on the theme file, with (prefix)
20803 * names of EDC programs actually implementing them.
20805 * The available layouts for slideshows on the default theme are:
20806 * - @c "fullscreen" - item images with original aspect, scaled to
20807 * touch top and down slideshow borders or, if the image's heigh
20808 * is not enough, left and right slideshow borders.
20809 * - @c "not_fullscreen" - the same behavior as the @c "fullscreen"
20810 * one, but always leaving 10% of the slideshow's dimensions of
20811 * distance between the item image's borders and the slideshow
20812 * borders, for each axis.
20814 * @warning The stringshared strings get no new references
20815 * exclusive to the user grabbing the list, here, so if you'd like
20816 * to use them out of this call's context, you'd better @c
20817 * eina_stringshare_ref() them.
20819 * @see elm_slideshow_layout_set()
20821 * @ingroup Slideshow
20823 EAPI const Eina_List *elm_slideshow_layouts_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20826 * Set the number of items to cache, on a given slideshow widget,
20827 * <b>before the current item</b>
20829 * @param obj The slideshow object
20830 * @param count Number of items to cache before the current one
20832 * The default value for this property is @c 2. See
20833 * @ref Slideshow_Caching "slideshow caching" for more details.
20835 * @see elm_slideshow_cache_before_get()
20837 * @ingroup Slideshow
20839 EAPI void elm_slideshow_cache_before_set(Evas_Object *obj, int count) EINA_ARG_NONNULL(1);
20842 * Retrieve the number of items to cache, on a given slideshow widget,
20843 * <b>before the current item</b>
20845 * @param obj The slideshow object
20846 * @return The number of items set to be cached before the current one
20848 * @see elm_slideshow_cache_before_set() for more details
20850 * @ingroup Slideshow
20852 EAPI int elm_slideshow_cache_before_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20855 * Set the number of items to cache, on a given slideshow widget,
20856 * <b>after the current item</b>
20858 * @param obj The slideshow object
20859 * @param count Number of items to cache after the current one
20861 * The default value for this property is @c 2. See
20862 * @ref Slideshow_Caching "slideshow caching" for more details.
20864 * @see elm_slideshow_cache_after_get()
20866 * @ingroup Slideshow
20868 EAPI void elm_slideshow_cache_after_set(Evas_Object *obj, int count) EINA_ARG_NONNULL(1);
20871 * Retrieve the number of items to cache, on a given slideshow widget,
20872 * <b>after the current item</b>
20874 * @param obj The slideshow object
20875 * @return The number of items set to be cached after the current one
20877 * @see elm_slideshow_cache_after_set() for more details
20879 * @ingroup Slideshow
20881 EAPI int elm_slideshow_cache_after_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20884 * Get the number of items stored in a given slideshow widget
20886 * @param obj The slideshow object
20887 * @return The number of items on @p obj, at the moment of this call
20889 * @ingroup Slideshow
20891 EAPI unsigned int elm_slideshow_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20898 * @defgroup Fileselector File Selector
20900 * @image html img/widget/fileselector/preview-00.png
20901 * @image latex img/widget/fileselector/preview-00.eps
20903 * A file selector is a widget that allows a user to navigate
20904 * through a file system, reporting file selections back via its
20907 * It contains shortcut buttons for home directory (@c ~) and to
20908 * jump one directory upwards (..), as well as cancel/ok buttons to
20909 * confirm/cancel a given selection. After either one of those two
20910 * former actions, the file selector will issue its @c "done" smart
20913 * There's a text entry on it, too, showing the name of the current
20914 * selection. There's the possibility of making it editable, so it
20915 * is useful on file saving dialogs on applications, where one
20916 * gives a file name to save contents to, in a given directory in
20917 * the system. This custom file name will be reported on the @c
20918 * "done" smart callback (explained in sequence).
20920 * Finally, it has a view to display file system items into in two
20925 * If Elementary is built with support of the Ethumb thumbnailing
20926 * library, the second form of view will display preview thumbnails
20927 * of files which it supports.
20929 * Smart callbacks one can register to:
20931 * - @c "selected" - the user has clicked on a file (when not in
20932 * folders-only mode) or directory (when in folders-only mode)
20933 * - @c "directory,open" - the list has been populated with new
20934 * content (@c event_info is a pointer to the directory's
20935 * path, a @b stringshared string)
20936 * - @c "done" - the user has clicked on the "ok" or "cancel"
20937 * buttons (@c event_info is a pointer to the selection's
20938 * path, a @b stringshared string)
20940 * Here is an example on its usage:
20941 * @li @ref fileselector_example
20945 * @addtogroup Fileselector
20950 * Defines how a file selector widget is to layout its contents
20951 * (file system entries).
20953 typedef enum _Elm_Fileselector_Mode
20955 ELM_FILESELECTOR_LIST = 0, /**< layout as a list */
20956 ELM_FILESELECTOR_GRID, /**< layout as a grid */
20957 ELM_FILESELECTOR_LAST /**< sentinel (helper) value, not used */
20958 } Elm_Fileselector_Mode;
20961 * Add a new file selector widget to the given parent Elementary
20962 * (container) object
20964 * @param parent The parent object
20965 * @return a new file selector widget handle or @c NULL, on errors
20967 * This function inserts a new file selector widget on the canvas.
20969 * @ingroup Fileselector
20971 EAPI Evas_Object *elm_fileselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20974 * Enable/disable the file name entry box where the user can type
20975 * in a name for a file, in a given file selector widget
20977 * @param obj The file selector object
20978 * @param is_save @c EINA_TRUE to make the file selector a "saving
20979 * dialog", @c EINA_FALSE otherwise
20981 * Having the entry editable is useful on file saving dialogs on
20982 * applications, where one gives a file name to save contents to,
20983 * in a given directory in the system. This custom file name will
20984 * be reported on the @c "done" smart callback.
20986 * @see elm_fileselector_is_save_get()
20988 * @ingroup Fileselector
20990 EAPI void elm_fileselector_is_save_set(Evas_Object *obj, Eina_Bool is_save) EINA_ARG_NONNULL(1);
20993 * Get whether the given file selector is in "saving dialog" mode
20995 * @param obj The file selector object
20996 * @return @c EINA_TRUE, if the file selector is in "saving dialog"
20997 * mode, @c EINA_FALSE otherwise (and on errors)
20999 * @see elm_fileselector_is_save_set() for more details
21001 * @ingroup Fileselector
21003 EAPI Eina_Bool elm_fileselector_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21006 * Enable/disable folder-only view for a given file selector widget
21008 * @param obj The file selector object
21009 * @param only @c EINA_TRUE to make @p obj only display
21010 * directories, @c EINA_FALSE to make files to be displayed in it
21013 * If enabled, the widget's view will only display folder items,
21016 * @see elm_fileselector_folder_only_get()
21018 * @ingroup Fileselector
21020 EAPI void elm_fileselector_folder_only_set(Evas_Object *obj, Eina_Bool only) EINA_ARG_NONNULL(1);
21023 * Get whether folder-only view is set for a given file selector
21026 * @param obj The file selector object
21027 * @return only @c EINA_TRUE if @p obj is only displaying
21028 * directories, @c EINA_FALSE if files are being displayed in it
21029 * too (and on errors)
21031 * @see elm_fileselector_folder_only_get()
21033 * @ingroup Fileselector
21035 EAPI Eina_Bool elm_fileselector_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21038 * Enable/disable the "ok" and "cancel" buttons on a given file
21041 * @param obj The file selector object
21042 * @param only @c EINA_TRUE to show them, @c EINA_FALSE to hide.
21044 * @note A file selector without those buttons will never emit the
21045 * @c "done" smart event, and is only usable if one is just hooking
21046 * to the other two events.
21048 * @see elm_fileselector_buttons_ok_cancel_get()
21050 * @ingroup Fileselector
21052 EAPI void elm_fileselector_buttons_ok_cancel_set(Evas_Object *obj, Eina_Bool buttons) EINA_ARG_NONNULL(1);
21055 * Get whether the "ok" and "cancel" buttons on a given file
21056 * selector widget are being shown.
21058 * @param obj The file selector object
21059 * @return @c EINA_TRUE if they are being shown, @c EINA_FALSE
21060 * otherwise (and on errors)
21062 * @see elm_fileselector_buttons_ok_cancel_set() for more details
21064 * @ingroup Fileselector
21066 EAPI Eina_Bool elm_fileselector_buttons_ok_cancel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21069 * Enable/disable a tree view in the given file selector widget,
21070 * <b>if it's in @c #ELM_FILESELECTOR_LIST mode</b>
21072 * @param obj The file selector object
21073 * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
21076 * In a tree view, arrows are created on the sides of directories,
21077 * allowing them to expand in place.
21079 * @note If it's in other mode, the changes made by this function
21080 * will only be visible when one switches back to "list" mode.
21082 * @see elm_fileselector_expandable_get()
21084 * @ingroup Fileselector
21086 EAPI void elm_fileselector_expandable_set(Evas_Object *obj, Eina_Bool expand) EINA_ARG_NONNULL(1);
21089 * Get whether tree view is enabled for the given file selector
21092 * @param obj The file selector object
21093 * @return @c EINA_TRUE if @p obj is in tree view, @c EINA_FALSE
21094 * otherwise (and or errors)
21096 * @see elm_fileselector_expandable_set() for more details
21098 * @ingroup Fileselector
21100 EAPI Eina_Bool elm_fileselector_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21103 * Set, programmatically, the @b directory that a given file
21104 * selector widget will display contents from
21106 * @param obj The file selector object
21107 * @param path The path to display in @p obj
21109 * This will change the @b directory that @p obj is displaying. It
21110 * will also clear the text entry area on the @p obj object, which
21111 * displays select files' names.
21113 * @see elm_fileselector_path_get()
21115 * @ingroup Fileselector
21117 EAPI void elm_fileselector_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
21120 * Get the parent directory's path that a given file selector
21121 * widget is displaying
21123 * @param obj The file selector object
21124 * @return The (full) path of the directory the file selector is
21125 * displaying, a @b stringshared string
21127 * @see elm_fileselector_path_set()
21129 * @ingroup Fileselector
21131 EAPI const char *elm_fileselector_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21134 * Set, programmatically, the currently selected file/directory in
21135 * the given file selector widget
21137 * @param obj The file selector object
21138 * @param path The (full) path to a file or directory
21139 * @return @c EINA_TRUE on success, @c EINA_FALSE on failure. The
21140 * latter case occurs if the directory or file pointed to do not
21143 * @see elm_fileselector_selected_get()
21145 * @ingroup Fileselector
21147 EAPI Eina_Bool elm_fileselector_selected_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
21150 * Get the currently selected item's (full) path, in the given file
21153 * @param obj The file selector object
21154 * @return The absolute path of the selected item, a @b
21155 * stringshared string
21157 * @note Custom editions on @p obj object's text entry, if made,
21158 * will appear on the return string of this function, naturally.
21160 * @see elm_fileselector_selected_set() for more details
21162 * @ingroup Fileselector
21164 EAPI const char *elm_fileselector_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21167 * Set the mode in which a given file selector widget will display
21168 * (layout) file system entries in its view
21170 * @param obj The file selector object
21171 * @param mode The mode of the fileselector, being it one of
21172 * #ELM_FILESELECTOR_LIST (default) or #ELM_FILESELECTOR_GRID. The
21173 * first one, naturally, will display the files in a list. The
21174 * latter will make the widget to display its entries in a grid
21177 * @note By using elm_fileselector_expandable_set(), the user may
21178 * trigger a tree view for that list.
21180 * @note If Elementary is built with support of the Ethumb
21181 * thumbnailing library, the second form of view will display
21182 * preview thumbnails of files which it supports. You must have
21183 * elm_need_ethumb() called in your Elementary for thumbnailing to
21186 * @see elm_fileselector_expandable_set().
21187 * @see elm_fileselector_mode_get().
21189 * @ingroup Fileselector
21191 EAPI void elm_fileselector_mode_set(Evas_Object *obj, Elm_Fileselector_Mode mode) EINA_ARG_NONNULL(1);
21194 * Get the mode in which a given file selector widget is displaying
21195 * (layouting) file system entries in its view
21197 * @param obj The fileselector object
21198 * @return The mode in which the fileselector is at
21200 * @see elm_fileselector_mode_set() for more details
21202 * @ingroup Fileselector
21204 EAPI Elm_Fileselector_Mode elm_fileselector_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21211 * @defgroup Progressbar Progress bar
21213 * The progress bar is a widget for visually representing the
21214 * progress status of a given job/task.
21216 * A progress bar may be horizontal or vertical. It may display an
21217 * icon besides it, as well as primary and @b units labels. The
21218 * former is meant to label the widget as a whole, while the
21219 * latter, which is formatted with floating point values (and thus
21220 * accepts a <c>printf</c>-style format string, like <c>"%1.2f
21221 * units"</c>), is meant to label the widget's <b>progress
21222 * value</b>. Label, icon and unit strings/objects are @b optional
21223 * for progress bars.
21225 * A progress bar may be @b inverted, in which state it gets its
21226 * values inverted, with high values being on the left or top and
21227 * low values on the right or bottom, as opposed to normally have
21228 * the low values on the former and high values on the latter,
21229 * respectively, for horizontal and vertical modes.
21231 * The @b span of the progress, as set by
21232 * elm_progressbar_span_size_set(), is its length (horizontally or
21233 * vertically), unless one puts size hints on the widget to expand
21234 * on desired directions, by any container. That length will be
21235 * scaled by the object or applications scaling factor. At any
21236 * point code can query the progress bar for its value with
21237 * elm_progressbar_value_get().
21239 * Available widget styles for progress bars:
21241 * - @c "wheel" (simple style, no text, no progression, only
21242 * "pulse" effect is available)
21244 * Default contents parts of the progressbar widget that you can use for are:
21245 * @li "icon" - An icon of the progressbar
21247 * Here is an example on its usage:
21248 * @li @ref progressbar_example
21252 * Add a new progress bar widget to the given parent Elementary
21253 * (container) object
21255 * @param parent The parent object
21256 * @return a new progress bar widget handle or @c NULL, on errors
21258 * This function inserts a new progress bar widget on the canvas.
21260 * @ingroup Progressbar
21262 EAPI Evas_Object *elm_progressbar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21265 * Set whether a given progress bar widget is at "pulsing mode" or
21268 * @param obj The progress bar object
21269 * @param pulse @c EINA_TRUE to put @p obj in pulsing mode,
21270 * @c EINA_FALSE to put it back to its default one
21272 * By default, progress bars will display values from the low to
21273 * high value boundaries. There are, though, contexts in which the
21274 * state of progression of a given task is @b unknown. For those,
21275 * one can set a progress bar widget to a "pulsing state", to give
21276 * the user an idea that some computation is being held, but
21277 * without exact progress values. In the default theme it will
21278 * animate its bar with the contents filling in constantly and back
21279 * to non-filled, in a loop. To start and stop this pulsing
21280 * animation, one has to explicitly call elm_progressbar_pulse().
21282 * @see elm_progressbar_pulse_get()
21283 * @see elm_progressbar_pulse()
21285 * @ingroup Progressbar
21287 EAPI void elm_progressbar_pulse_set(Evas_Object *obj, Eina_Bool pulse) EINA_ARG_NONNULL(1);
21290 * Get whether a given progress bar widget is at "pulsing mode" or
21293 * @param obj The progress bar object
21294 * @return @c EINA_TRUE, if @p obj is in pulsing mode, @c EINA_FALSE
21295 * if it's in the default one (and on errors)
21297 * @ingroup Progressbar
21299 EAPI Eina_Bool elm_progressbar_pulse_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21302 * Start/stop a given progress bar "pulsing" animation, if its
21305 * @param obj The progress bar object
21306 * @param state @c EINA_TRUE, to @b start the pulsing animation,
21307 * @c EINA_FALSE to @b stop it
21309 * @note This call won't do anything if @p obj is not under "pulsing mode".
21311 * @see elm_progressbar_pulse_set() for more details.
21313 * @ingroup Progressbar
21315 EAPI void elm_progressbar_pulse(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
21318 * Set the progress value (in percentage) on a given progress bar
21321 * @param obj The progress bar object
21322 * @param val The progress value (@b must be between @c 0.0 and @c
21325 * Use this call to set progress bar levels.
21327 * @note If you passes a value out of the specified range for @p
21328 * val, it will be interpreted as the @b closest of the @b boundary
21329 * values in the range.
21331 * @ingroup Progressbar
21333 EAPI void elm_progressbar_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
21336 * Get the progress value (in percentage) on a given progress bar
21339 * @param obj The progress bar object
21340 * @return The value of the progressbar
21342 * @see elm_progressbar_value_set() for more details
21344 * @ingroup Progressbar
21346 EAPI double elm_progressbar_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21349 * Set the label of a given progress bar widget
21351 * @param obj The progress bar object
21352 * @param label The text label string, in UTF-8
21354 * @ingroup Progressbar
21355 * @deprecated use elm_object_text_set() instead.
21357 EINA_DEPRECATED EAPI void elm_progressbar_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
21360 * Get the label of a given progress bar widget
21362 * @param obj The progressbar object
21363 * @return The text label string, in UTF-8
21365 * @ingroup Progressbar
21366 * @deprecated use elm_object_text_set() instead.
21368 EINA_DEPRECATED EAPI const char *elm_progressbar_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21371 * Set the icon object of a given progress bar widget
21373 * @param obj The progress bar object
21374 * @param icon The icon object
21376 * Use this call to decorate @p obj with an icon next to it.
21378 * @note Once the icon object is set, a previously set one will be
21379 * deleted. If you want to keep that old content object, use the
21380 * elm_progressbar_icon_unset() function.
21382 * @see elm_progressbar_icon_get()
21383 * @deprecated use elm_object_part_content_set() instead.
21385 * @ingroup Progressbar
21387 EINA_DEPRECATED EAPI void elm_progressbar_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
21390 * Retrieve the icon object set for a given progress bar widget
21392 * @param obj The progress bar object
21393 * @return The icon object's handle, if @p obj had one set, or @c NULL,
21394 * otherwise (and on errors)
21396 * @see elm_progressbar_icon_set() for more details
21397 * @deprecated use elm_object_part_content_get() instead.
21399 * @ingroup Progressbar
21401 EINA_DEPRECATED EAPI Evas_Object *elm_progressbar_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21404 * Unset an icon set on a given progress bar widget
21406 * @param obj The progress bar object
21407 * @return The icon object that was being used, if any was set, or
21408 * @c NULL, otherwise (and on errors)
21410 * This call will unparent and return the icon object which was set
21411 * for this widget, previously, on success.
21413 * @see elm_progressbar_icon_set() for more details
21414 * @deprecated use elm_object_part_content_unset() instead.
21416 * @ingroup Progressbar
21418 EINA_DEPRECATED EAPI Evas_Object *elm_progressbar_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
21421 * Set the (exact) length of the bar region of a given progress bar
21424 * @param obj The progress bar object
21425 * @param size The length of the progress bar's bar region
21427 * This sets the minimum width (when in horizontal mode) or height
21428 * (when in vertical mode) of the actual bar area of the progress
21429 * bar @p obj. This in turn affects the object's minimum size. Use
21430 * this when you're not setting other size hints expanding on the
21431 * given direction (like weight and alignment hints) and you would
21432 * like it to have a specific size.
21434 * @note Icon, label and unit text around @p obj will require their
21435 * own space, which will make @p obj to require more the @p size,
21438 * @see elm_progressbar_span_size_get()
21440 * @ingroup Progressbar
21442 EAPI void elm_progressbar_span_size_set(Evas_Object *obj, Evas_Coord size) EINA_ARG_NONNULL(1);
21445 * Get the length set for the bar region of a given progress bar
21448 * @param obj The progress bar object
21449 * @return The length of the progress bar's bar region
21451 * If that size was not set previously, with
21452 * elm_progressbar_span_size_set(), this call will return @c 0.
21454 * @ingroup Progressbar
21456 EAPI Evas_Coord elm_progressbar_span_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21459 * Set the format string for a given progress bar widget's units
21462 * @param obj The progress bar object
21463 * @param format The format string for @p obj's units label
21465 * If @c NULL is passed on @p format, it will make @p obj's units
21466 * area to be hidden completely. If not, it'll set the <b>format
21467 * string</b> for the units label's @b text. The units label is
21468 * provided a floating point value, so the units text is up display
21469 * at most one floating point falue. Note that the units label is
21470 * optional. Use a format string such as "%1.2f meters" for
21473 * @note The default format string for a progress bar is an integer
21474 * percentage, as in @c "%.0f %%".
21476 * @see elm_progressbar_unit_format_get()
21478 * @ingroup Progressbar
21480 EAPI void elm_progressbar_unit_format_set(Evas_Object *obj, const char *format) EINA_ARG_NONNULL(1);
21483 * Retrieve the format string set for a given progress bar widget's
21486 * @param obj The progress bar object
21487 * @return The format set string for @p obj's units label or
21488 * @c NULL, if none was set (and on errors)
21490 * @see elm_progressbar_unit_format_set() for more details
21492 * @ingroup Progressbar
21494 EAPI const char *elm_progressbar_unit_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21497 * Set the orientation of a given progress bar widget
21499 * @param obj The progress bar object
21500 * @param horizontal Use @c EINA_TRUE to make @p obj to be
21501 * @b horizontal, @c EINA_FALSE to make it @b vertical
21503 * Use this function to change how your progress bar is to be
21504 * disposed: vertically or horizontally.
21506 * @see elm_progressbar_horizontal_get()
21508 * @ingroup Progressbar
21510 EAPI void elm_progressbar_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
21513 * Retrieve the orientation of a given progress bar widget
21515 * @param obj The progress bar object
21516 * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
21517 * @c EINA_FALSE if it's @b vertical (and on errors)
21519 * @see elm_progressbar_horizontal_set() for more details
21521 * @ingroup Progressbar
21523 EAPI Eina_Bool elm_progressbar_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21526 * Invert a given progress bar widget's displaying values order
21528 * @param obj The progress bar object
21529 * @param inverted Use @c EINA_TRUE to make @p obj inverted,
21530 * @c EINA_FALSE to bring it back to default, non-inverted values.
21532 * A progress bar may be @b inverted, in which state it gets its
21533 * values inverted, with high values being on the left or top and
21534 * low values on the right or bottom, as opposed to normally have
21535 * the low values on the former and high values on the latter,
21536 * respectively, for horizontal and vertical modes.
21538 * @see elm_progressbar_inverted_get()
21540 * @ingroup Progressbar
21542 EAPI void elm_progressbar_inverted_set(Evas_Object *obj, Eina_Bool inverted) EINA_ARG_NONNULL(1);
21545 * Get whether a given progress bar widget's displaying values are
21548 * @param obj The progress bar object
21549 * @return @c EINA_TRUE, if @p obj has inverted values,
21550 * @c EINA_FALSE otherwise (and on errors)
21552 * @see elm_progressbar_inverted_set() for more details
21554 * @ingroup Progressbar
21556 EAPI Eina_Bool elm_progressbar_inverted_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21559 * @defgroup Separator Separator
21561 * @brief Separator is a very thin object used to separate other objects.
21563 * A separator can be vertical or horizontal.
21565 * @ref tutorial_separator is a good example of how to use a separator.
21569 * @brief Add a separator object to @p parent
21571 * @param parent The parent object
21573 * @return The separator object, or NULL upon failure
21575 EAPI Evas_Object *elm_separator_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21577 * @brief Set the horizontal mode of a separator object
21579 * @param obj The separator object
21580 * @param horizontal If true, the separator is horizontal
21582 EAPI void elm_separator_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
21584 * @brief Get the horizontal mode of a separator object
21586 * @param obj The separator object
21587 * @return If true, the separator is horizontal
21589 * @see elm_separator_horizontal_set()
21591 EAPI Eina_Bool elm_separator_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21597 * @defgroup Spinner Spinner
21598 * @ingroup Elementary
21600 * @image html img/widget/spinner/preview-00.png
21601 * @image latex img/widget/spinner/preview-00.eps
21603 * A spinner is a widget which allows the user to increase or decrease
21604 * numeric values using arrow buttons, or edit values directly, clicking
21605 * over it and typing the new value.
21607 * By default the spinner will not wrap and has a label
21608 * of "%.0f" (just showing the integer value of the double).
21610 * A spinner has a label that is formatted with floating
21611 * point values and thus accepts a printf-style format string, like
21612 * ā%1.2f unitsā.
21614 * It also allows specific values to be replaced by pre-defined labels.
21616 * Smart callbacks one can register to:
21618 * - "changed" - Whenever the spinner value is changed.
21619 * - "delay,changed" - A short time after the value is changed by the user.
21620 * This will be called only when the user stops dragging for a very short
21621 * period or when they release their finger/mouse, so it avoids possibly
21622 * expensive reactions to the value change.
21624 * Available styles for it:
21626 * - @c "vertical": up/down buttons at the right side and text left aligned.
21628 * Here is an example on its usage:
21629 * @ref spinner_example
21633 * @addtogroup Spinner
21638 * Add a new spinner widget to the given parent Elementary
21639 * (container) object.
21641 * @param parent The parent object.
21642 * @return a new spinner widget handle or @c NULL, on errors.
21644 * This function inserts a new spinner widget on the canvas.
21649 EAPI Evas_Object *elm_spinner_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21652 * Set the format string of the displayed label.
21654 * @param obj The spinner object.
21655 * @param fmt The format string for the label display.
21657 * If @c NULL, this sets the format to "%.0f". If not it sets the format
21658 * string for the label text. The label text is provided a floating point
21659 * value, so the label text can display up to 1 floating point value.
21660 * Note that this is optional.
21662 * Use a format string such as "%1.2f meters" for example, and it will
21663 * display values like: "3.14 meters" for a value equal to 3.14159.
21665 * Default is "%0.f".
21667 * @see elm_spinner_label_format_get()
21671 EAPI void elm_spinner_label_format_set(Evas_Object *obj, const char *fmt) EINA_ARG_NONNULL(1);
21674 * Get the label format of the spinner.
21676 * @param obj The spinner object.
21677 * @return The text label format string in UTF-8.
21679 * @see elm_spinner_label_format_set() for details.
21683 EAPI const char *elm_spinner_label_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21686 * Set the minimum and maximum values for the spinner.
21688 * @param obj The spinner object.
21689 * @param min The minimum value.
21690 * @param max The maximum value.
21692 * Define the allowed range of values to be selected by the user.
21694 * If actual value is less than @p min, it will be updated to @p min. If it
21695 * is bigger then @p max, will be updated to @p max. Actual value can be
21696 * get with elm_spinner_value_get().
21698 * By default, min is equal to 0, and max is equal to 100.
21700 * @warning Maximum must be greater than minimum.
21702 * @see elm_spinner_min_max_get()
21706 EAPI void elm_spinner_min_max_set(Evas_Object *obj, double min, double max) EINA_ARG_NONNULL(1);
21709 * Get the minimum and maximum values of the spinner.
21711 * @param obj The spinner object.
21712 * @param min Pointer where to store the minimum value.
21713 * @param max Pointer where to store the maximum value.
21715 * @note If only one value is needed, the other pointer can be passed
21718 * @see elm_spinner_min_max_set() for details.
21722 EAPI void elm_spinner_min_max_get(const Evas_Object *obj, double *min, double *max) EINA_ARG_NONNULL(1);
21725 * Set the step used to increment or decrement the spinner value.
21727 * @param obj The spinner object.
21728 * @param step The step value.
21730 * This value will be incremented or decremented to the displayed value.
21731 * It will be incremented while the user keep right or top arrow pressed,
21732 * and will be decremented while the user keep left or bottom arrow pressed.
21734 * The interval to increment / decrement can be set with
21735 * elm_spinner_interval_set().
21737 * By default step value is equal to 1.
21739 * @see elm_spinner_step_get()
21743 EAPI void elm_spinner_step_set(Evas_Object *obj, double step) EINA_ARG_NONNULL(1);
21746 * Get the step used to increment or decrement the spinner value.
21748 * @param obj The spinner object.
21749 * @return The step value.
21751 * @see elm_spinner_step_get() for more details.
21755 EAPI double elm_spinner_step_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21758 * Set the value the spinner displays.
21760 * @param obj The spinner object.
21761 * @param val The value to be displayed.
21763 * Value will be presented on the label following format specified with
21764 * elm_spinner_format_set().
21766 * @warning The value must to be between min and max values. This values
21767 * are set by elm_spinner_min_max_set().
21769 * @see elm_spinner_value_get().
21770 * @see elm_spinner_format_set().
21771 * @see elm_spinner_min_max_set().
21775 EAPI void elm_spinner_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
21778 * Get the value displayed by the spinner.
21780 * @param obj The spinner object.
21781 * @return The value displayed.
21783 * @see elm_spinner_value_set() for details.
21787 EAPI double elm_spinner_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21790 * Set whether the spinner should wrap when it reaches its
21791 * minimum or maximum value.
21793 * @param obj The spinner object.
21794 * @param wrap @c EINA_TRUE to enable wrap or @c EINA_FALSE to
21797 * Disabled by default. If disabled, when the user tries to increment the
21799 * but displayed value plus step value is bigger than maximum value,
21801 * won't allow it. The same happens when the user tries to decrement it,
21802 * but the value less step is less than minimum value.
21804 * When wrap is enabled, in such situations it will allow these changes,
21805 * but will get the value that would be less than minimum and subtracts
21806 * from maximum. Or add the value that would be more than maximum to
21810 * @li min value = 10
21811 * @li max value = 50
21812 * @li step value = 20
21813 * @li displayed value = 20
21815 * When the user decrement value (using left or bottom arrow), it will
21816 * displays @c 40, because max - (min - (displayed - step)) is
21817 * @c 50 - (@c 10 - (@c 20 - @c 20)) = @c 40.
21819 * @see elm_spinner_wrap_get().
21823 EAPI void elm_spinner_wrap_set(Evas_Object *obj, Eina_Bool wrap) EINA_ARG_NONNULL(1);
21826 * Get whether the spinner should wrap when it reaches its
21827 * minimum or maximum value.
21829 * @param obj The spinner object
21830 * @return @c EINA_TRUE means wrap is enabled. @c EINA_FALSE indicates
21831 * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
21833 * @see elm_spinner_wrap_set() for details.
21837 EAPI Eina_Bool elm_spinner_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21840 * Set whether the spinner can be directly edited by the user or not.
21842 * @param obj The spinner object.
21843 * @param editable @c EINA_TRUE to allow users to edit it or @c EINA_FALSE to
21844 * don't allow users to edit it directly.
21846 * Spinner objects can have edition @b disabled, in which state they will
21847 * be changed only by arrows.
21848 * Useful for contexts
21849 * where you don't want your users to interact with it writting the value.
21851 * when using special values, the user can see real value instead
21852 * of special label on edition.
21854 * It's enabled by default.
21856 * @see elm_spinner_editable_get()
21860 EAPI void elm_spinner_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
21863 * Get whether the spinner can be directly edited by the user or not.
21865 * @param obj The spinner object.
21866 * @return @c EINA_TRUE means edition is enabled. @c EINA_FALSE indicates
21867 * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
21869 * @see elm_spinner_editable_set() for details.
21873 EAPI Eina_Bool elm_spinner_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21876 * Set a special string to display in the place of the numerical value.
21878 * @param obj The spinner object.
21879 * @param value The value to be replaced.
21880 * @param label The label to be used.
21882 * It's useful for cases when a user should select an item that is
21883 * better indicated by a label than a value. For example, weekdays or months.
21887 * sp = elm_spinner_add(win);
21888 * elm_spinner_min_max_set(sp, 1, 3);
21889 * elm_spinner_special_value_add(sp, 1, "January");
21890 * elm_spinner_special_value_add(sp, 2, "February");
21891 * elm_spinner_special_value_add(sp, 3, "March");
21892 * evas_object_show(sp);
21897 EAPI void elm_spinner_special_value_add(Evas_Object *obj, double value, const char *label) EINA_ARG_NONNULL(1);
21900 * Set the interval on time updates for an user mouse button hold
21901 * on spinner widgets' arrows.
21903 * @param obj The spinner object.
21904 * @param interval The (first) interval value in seconds.
21906 * This interval value is @b decreased while the user holds the
21907 * mouse pointer either incrementing or decrementing spinner's value.
21909 * This helps the user to get to a given value distant from the
21910 * current one easier/faster, as it will start to change quicker and
21911 * quicker on mouse button holds.
21913 * The calculation for the next change interval value, starting from
21914 * the one set with this call, is the previous interval divided by
21915 * @c 1.05, so it decreases a little bit.
21917 * The default starting interval value for automatic changes is
21920 * @see elm_spinner_interval_get()
21924 EAPI void elm_spinner_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
21927 * Get the interval on time updates for an user mouse button hold
21928 * on spinner widgets' arrows.
21930 * @param obj The spinner object.
21931 * @return The (first) interval value, in seconds, set on it.
21933 * @see elm_spinner_interval_set() for more details.
21937 EAPI double elm_spinner_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21944 * @defgroup Index Index
21946 * @image html img/widget/index/preview-00.png
21947 * @image latex img/widget/index/preview-00.eps
21949 * An index widget gives you an index for fast access to whichever
21950 * group of other UI items one might have. It's a list of text
21951 * items (usually letters, for alphabetically ordered access).
21953 * Index widgets are by default hidden and just appear when the
21954 * user clicks over it's reserved area in the canvas. In its
21955 * default theme, it's an area one @ref Fingers "finger" wide on
21956 * the right side of the index widget's container.
21958 * When items on the index are selected, smart callbacks get
21959 * called, so that its user can make other container objects to
21960 * show a given area or child object depending on the index item
21961 * selected. You'd probably be using an index together with @ref
21962 * List "lists", @ref Genlist "generic lists" or @ref Gengrid
21965 * Smart events one can add callbacks for are:
21966 * - @c "changed" - When the selected index item changes. @c
21967 * event_info is the selected item's data pointer.
21968 * - @c "delay,changed" - When the selected index item changes, but
21969 * after a small idling period. @c event_info is the selected
21970 * item's data pointer.
21971 * - @c "selected" - When the user releases a mouse button and
21972 * selects an item. @c event_info is the selected item's data
21974 * - @c "level,up" - when the user moves a finger from the first
21975 * level to the second level
21976 * - @c "level,down" - when the user moves a finger from the second
21977 * level to the first level
21979 * The @c "delay,changed" event is so that it'll wait a small time
21980 * before actually reporting those events and, moreover, just the
21981 * last event happening on those time frames will actually be
21984 * Here are some examples on its usage:
21985 * @li @ref index_example_01
21986 * @li @ref index_example_02
21990 * @addtogroup Index
21994 typedef struct _Elm_Index_Item Elm_Index_Item; /**< Opaque handle for items of Elementary index widgets */
21997 * Add a new index widget to the given parent Elementary
21998 * (container) object
22000 * @param parent The parent object
22001 * @return a new index widget handle or @c NULL, on errors
22003 * This function inserts a new index widget on the canvas.
22007 EAPI Evas_Object *elm_index_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22010 * Set whether a given index widget is or not visible,
22013 * @param obj The index object
22014 * @param active @c EINA_TRUE to show it, @c EINA_FALSE to hide it
22016 * Not to be confused with visible as in @c evas_object_show() --
22017 * visible with regard to the widget's auto hiding feature.
22019 * @see elm_index_active_get()
22023 EAPI void elm_index_active_set(Evas_Object *obj, Eina_Bool active) EINA_ARG_NONNULL(1);
22026 * Get whether a given index widget is currently visible or not.
22028 * @param obj The index object
22029 * @return @c EINA_TRUE, if it's shown, @c EINA_FALSE otherwise
22031 * @see elm_index_active_set() for more details
22035 EAPI Eina_Bool elm_index_active_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22038 * Set the items level for a given index widget.
22040 * @param obj The index object.
22041 * @param level @c 0 or @c 1, the currently implemented levels.
22043 * @see elm_index_item_level_get()
22047 EAPI void elm_index_item_level_set(Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
22050 * Get the items level set for a given index widget.
22052 * @param obj The index object.
22053 * @return @c 0 or @c 1, which are the levels @p obj might be at.
22055 * @see elm_index_item_level_set() for more information
22059 EAPI int elm_index_item_level_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22062 * Returns the last selected item's data, for a given index widget.
22064 * @param obj The index object.
22065 * @return The item @b data associated to the last selected item on
22066 * @p obj (or @c NULL, on errors).
22068 * @warning The returned value is @b not an #Elm_Index_Item item
22069 * handle, but the data associated to it (see the @c item parameter
22070 * in elm_index_item_append(), as an example).
22074 EAPI void *elm_index_item_selected_get(const Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
22077 * Append a new item on a given index widget.
22079 * @param obj The index object.
22080 * @param letter Letter under which the item should be indexed
22081 * @param item The item data to set for the index's item
22083 * Despite the most common usage of the @p letter argument is for
22084 * single char strings, one could use arbitrary strings as index
22087 * @c item will be the pointer returned back on @c "changed", @c
22088 * "delay,changed" and @c "selected" smart events.
22092 EAPI void elm_index_item_append(Evas_Object *obj, const char *letter, const void *item) EINA_ARG_NONNULL(1);
22095 * Prepend a new item on a given index widget.
22097 * @param obj The index object.
22098 * @param letter Letter under which the item should be indexed
22099 * @param item The item data to set for the index's item
22101 * Despite the most common usage of the @p letter argument is for
22102 * single char strings, one could use arbitrary strings as index
22105 * @c item will be the pointer returned back on @c "changed", @c
22106 * "delay,changed" and @c "selected" smart events.
22110 EAPI void elm_index_item_prepend(Evas_Object *obj, const char *letter, const void *item) EINA_ARG_NONNULL(1);
22113 * Append a new item, on a given index widget, <b>after the item
22114 * having @p relative as data</b>.
22116 * @param obj The index object.
22117 * @param letter Letter under which the item should be indexed
22118 * @param item The item data to set for the index's item
22119 * @param relative The item data of the index item to be the
22120 * predecessor of this new one
22122 * Despite the most common usage of the @p letter argument is for
22123 * single char strings, one could use arbitrary strings as index
22126 * @c item will be the pointer returned back on @c "changed", @c
22127 * "delay,changed" and @c "selected" smart events.
22129 * @note If @p relative is @c NULL or if it's not found to be data
22130 * set on any previous item on @p obj, this function will behave as
22131 * elm_index_item_append().
22135 EAPI void elm_index_item_append_relative(Evas_Object *obj, const char *letter, const void *item, const void *relative) EINA_ARG_NONNULL(1);
22138 * Prepend a new item, on a given index widget, <b>after the item
22139 * having @p relative as data</b>.
22141 * @param obj The index object.
22142 * @param letter Letter under which the item should be indexed
22143 * @param item The item data to set for the index's item
22144 * @param relative The item data of the index item to be the
22145 * successor of this new one
22147 * Despite the most common usage of the @p letter argument is for
22148 * single char strings, one could use arbitrary strings as index
22151 * @c item will be the pointer returned back on @c "changed", @c
22152 * "delay,changed" and @c "selected" smart events.
22154 * @note If @p relative is @c NULL or if it's not found to be data
22155 * set on any previous item on @p obj, this function will behave as
22156 * elm_index_item_prepend().
22160 EAPI void elm_index_item_prepend_relative(Evas_Object *obj, const char *letter, const void *item, const void *relative) EINA_ARG_NONNULL(1);
22163 * Insert a new item into the given index widget, using @p cmp_func
22164 * function to sort items (by item handles).
22166 * @param obj The index object.
22167 * @param letter Letter under which the item should be indexed
22168 * @param item The item data to set for the index's item
22169 * @param cmp_func The comparing function to be used to sort index
22170 * items <b>by #Elm_Index_Item item handles</b>
22171 * @param cmp_data_func A @b fallback function to be called for the
22172 * sorting of index items <b>by item data</b>). It will be used
22173 * when @p cmp_func returns @c 0 (equality), which means an index
22174 * item with provided item data already exists. To decide which
22175 * data item should be pointed to by the index item in question, @p
22176 * cmp_data_func will be used. If @p cmp_data_func returns a
22177 * non-negative value, the previous index item data will be
22178 * replaced by the given @p item pointer. If the previous data need
22179 * to be freed, it should be done by the @p cmp_data_func function,
22180 * because all references to it will be lost. If this function is
22181 * not provided (@c NULL is given), index items will be @b
22182 * duplicated, if @p cmp_func returns @c 0.
22184 * Despite the most common usage of the @p letter argument is for
22185 * single char strings, one could use arbitrary strings as index
22188 * @c item will be the pointer returned back on @c "changed", @c
22189 * "delay,changed" and @c "selected" smart events.
22193 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);
22196 * Remove an item from a given index widget, <b>to be referenced by
22197 * it's data value</b>.
22199 * @param obj The index object
22200 * @param item The item's data pointer for the item to be removed
22203 * If a deletion callback is set, via elm_index_item_del_cb_set(),
22204 * that callback function will be called by this one.
22206 * @warning The item to be removed from @p obj will be found via
22207 * its item data pointer, and not by an #Elm_Index_Item handle.
22211 EAPI void elm_index_item_del(Evas_Object *obj, const void *item) EINA_ARG_NONNULL(1);
22214 * Find a given index widget's item, <b>using item data</b>.
22216 * @param obj The index object
22217 * @param item The item data pointed to by the desired index item
22218 * @return The index item handle, if found, or @c NULL otherwise
22222 EAPI Elm_Index_Item *elm_index_item_find(Evas_Object *obj, const void *item) EINA_ARG_NONNULL(1);
22225 * Removes @b all items from a given index widget.
22227 * @param obj The index object.
22229 * If deletion callbacks are set, via elm_index_item_del_cb_set(),
22230 * that callback function will be called for each item in @p obj.
22234 EAPI void elm_index_item_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
22237 * Go to a given items level on a index widget
22239 * @param obj The index object
22240 * @param level The index level (one of @c 0 or @c 1)
22244 EAPI void elm_index_item_go(Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
22247 * Return the data associated with a given index widget item
22249 * @param it The index widget item handle
22250 * @return The data associated with @p it
22252 * @see elm_index_item_data_set()
22256 EAPI void *elm_index_item_data_get(const Elm_Index_Item *item) EINA_ARG_NONNULL(1);
22259 * Set the data associated with a given index widget item
22261 * @param it The index widget item handle
22262 * @param data The new data pointer to set to @p it
22264 * This sets new item data on @p it.
22266 * @warning The old data pointer won't be touched by this function, so
22267 * the user had better to free that old data himself/herself.
22271 EAPI void elm_index_item_data_set(Elm_Index_Item *it, const void *data) EINA_ARG_NONNULL(1);
22274 * Set the function to be called when a given index widget item is freed.
22276 * @param it The item to set the callback on
22277 * @param func The function to call on the item's deletion
22279 * When called, @p func will have both @c data and @c event_info
22280 * arguments with the @p it item's data value and, naturally, the
22281 * @c obj argument with a handle to the parent index widget.
22285 EAPI void elm_index_item_del_cb_set(Elm_Index_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
22288 * Get the letter (string) set on a given index widget item.
22290 * @param it The index item handle
22291 * @return The letter string set on @p it
22295 EAPI const char *elm_index_item_letter_get(const Elm_Index_Item *item) EINA_ARG_NONNULL(1);
22302 * @defgroup Photocam Photocam
22304 * @image html img/widget/photocam/preview-00.png
22305 * @image latex img/widget/photocam/preview-00.eps
22307 * This is a widget specifically for displaying high-resolution digital
22308 * camera photos giving speedy feedback (fast load), low memory footprint
22309 * and zooming and panning as well as fitting logic. It is entirely focused
22310 * on jpeg images, and takes advantage of properties of the jpeg format (via
22311 * evas loader features in the jpeg loader).
22313 * Signals that you can add callbacks for are:
22314 * @li "clicked" - This is called when a user has clicked the photo without
22316 * @li "press" - This is called when a user has pressed down on the photo.
22317 * @li "longpressed" - This is called when a user has pressed down on the
22318 * photo for a long time without dragging around.
22319 * @li "clicked,double" - This is called when a user has double-clicked the
22321 * @li "load" - Photo load begins.
22322 * @li "loaded" - This is called when the image file load is complete for the
22323 * first view (low resolution blurry version).
22324 * @li "load,detail" - Photo detailed data load begins.
22325 * @li "loaded,detail" - This is called when the image file load is complete
22326 * for the detailed image data (full resolution needed).
22327 * @li "zoom,start" - Zoom animation started.
22328 * @li "zoom,stop" - Zoom animation stopped.
22329 * @li "zoom,change" - Zoom changed when using an auto zoom mode.
22330 * @li "scroll" - the content has been scrolled (moved)
22331 * @li "scroll,anim,start" - scrolling animation has started
22332 * @li "scroll,anim,stop" - scrolling animation has stopped
22333 * @li "scroll,drag,start" - dragging the contents around has started
22334 * @li "scroll,drag,stop" - dragging the contents around has stopped
22336 * @ref tutorial_photocam shows the API in action.
22340 * @brief Types of zoom available.
22342 typedef enum _Elm_Photocam_Zoom_Mode
22344 ELM_PHOTOCAM_ZOOM_MODE_MANUAL = 0, /**< Zoom controlled normally by elm_photocam_zoom_set */
22345 ELM_PHOTOCAM_ZOOM_MODE_AUTO_FIT, /**< Zoom until photo fits in photocam */
22346 ELM_PHOTOCAM_ZOOM_MODE_AUTO_FILL, /**< Zoom until photo fills photocam */
22347 ELM_PHOTOCAM_ZOOM_MODE_LAST
22348 } Elm_Photocam_Zoom_Mode;
22350 * @brief Add a new Photocam object
22352 * @param parent The parent object
22353 * @return The new object or NULL if it cannot be created
22355 EAPI Evas_Object *elm_photocam_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22357 * @brief Set the photo file to be shown
22359 * @param obj The photocam object
22360 * @param file The photo file
22361 * @return The return error (see EVAS_LOAD_ERROR_NONE, EVAS_LOAD_ERROR_GENERIC etc.)
22363 * This sets (and shows) the specified file (with a relative or absolute
22364 * path) and will return a load error (same error that
22365 * evas_object_image_load_error_get() will return). The image will change and
22366 * adjust its size at this point and begin a background load process for this
22367 * photo that at some time in the future will be displayed at the full
22370 EAPI Evas_Load_Error elm_photocam_file_set(Evas_Object *obj, const char *file) EINA_ARG_NONNULL(1);
22372 * @brief Returns the path of the current image file
22374 * @param obj The photocam object
22375 * @return Returns the path
22377 * @see elm_photocam_file_set()
22379 EAPI const char *elm_photocam_file_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22381 * @brief Set the zoom level of the photo
22383 * @param obj The photocam object
22384 * @param zoom The zoom level to set
22386 * This sets the zoom level. 1 will be 1:1 pixel for pixel. 2 will be 2:1
22387 * (that is 2x2 photo pixels will display as 1 on-screen pixel). 4:1 will be
22388 * 4x4 photo pixels as 1 screen pixel, and so on. The @p zoom parameter must
22389 * be greater than 0. It is usggested to stick to powers of 2. (1, 2, 4, 8,
22392 EAPI void elm_photocam_zoom_set(Evas_Object *obj, double zoom) EINA_ARG_NONNULL(1);
22394 * @brief Get the zoom level of the photo
22396 * @param obj The photocam object
22397 * @return The current zoom level
22399 * This returns the current zoom level of the photocam object. Note that if
22400 * you set the fill mode to other than ELM_PHOTOCAM_ZOOM_MODE_MANUAL
22401 * (which is the default), the zoom level may be changed at any time by the
22402 * photocam object itself to account for photo size and photocam viewpoer
22405 * @see elm_photocam_zoom_set()
22406 * @see elm_photocam_zoom_mode_set()
22408 EAPI double elm_photocam_zoom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22410 * @brief Set the zoom mode
22412 * @param obj The photocam object
22413 * @param mode The desired mode
22415 * This sets the zoom mode to manual or one of several automatic levels.
22416 * Manual (ELM_PHOTOCAM_ZOOM_MODE_MANUAL) means that zoom is set manually by
22417 * elm_photocam_zoom_set() and will stay at that level until changed by code
22418 * or until zoom mode is changed. This is the default mode. The Automatic
22419 * modes will allow the photocam object to automatically adjust zoom mode
22420 * based on properties. ELM_PHOTOCAM_ZOOM_MODE_AUTO_FIT) will adjust zoom so
22421 * the photo fits EXACTLY inside the scroll frame with no pixels outside this
22422 * area. ELM_PHOTOCAM_ZOOM_MODE_AUTO_FILL will be similar but ensure no
22423 * pixels within the frame are left unfilled.
22425 EAPI void elm_photocam_zoom_mode_set(Evas_Object *obj, Elm_Photocam_Zoom_Mode mode) EINA_ARG_NONNULL(1);
22427 * @brief Get the zoom mode
22429 * @param obj The photocam object
22430 * @return The current zoom mode
22432 * This gets the current zoom mode of the photocam object.
22434 * @see elm_photocam_zoom_mode_set()
22436 EAPI Elm_Photocam_Zoom_Mode elm_photocam_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22438 * @brief Get the current image pixel width and height
22440 * @param obj The photocam object
22441 * @param w A pointer to the width return
22442 * @param h A pointer to the height return
22444 * This gets the current photo pixel width and height (for the original).
22445 * The size will be returned in the integers @p w and @p h that are pointed
22448 EAPI void elm_photocam_image_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
22450 * @brief Get the area of the image that is currently shown
22453 * @param x A pointer to the X-coordinate of region
22454 * @param y A pointer to the Y-coordinate of region
22455 * @param w A pointer to the width
22456 * @param h A pointer to the height
22458 * @see elm_photocam_image_region_show()
22459 * @see elm_photocam_image_region_bring_in()
22461 EAPI void elm_photocam_region_get(const Evas_Object *obj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
22463 * @brief Set the viewed portion of the image
22465 * @param obj The photocam object
22466 * @param x X-coordinate of region in image original pixels
22467 * @param y Y-coordinate of region in image original pixels
22468 * @param w Width of region in image original pixels
22469 * @param h Height of region in image original pixels
22471 * This shows the region of the image without using animation.
22473 EAPI void elm_photocam_image_region_show(Evas_Object *obj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
22475 * @brief Bring in the viewed portion of the image
22477 * @param obj The photocam object
22478 * @param x X-coordinate of region in image original pixels
22479 * @param y Y-coordinate of region in image original pixels
22480 * @param w Width of region in image original pixels
22481 * @param h Height of region in image original pixels
22483 * This shows the region of the image using animation.
22485 EAPI void elm_photocam_image_region_bring_in(Evas_Object *obj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
22487 * @brief Set the paused state for photocam
22489 * @param obj The photocam object
22490 * @param paused The pause state to set
22492 * This sets the paused state to on(EINA_TRUE) or off (EINA_FALSE) for
22493 * photocam. The default is off. This will stop zooming using animation on
22494 * zoom levels changes and change instantly. This will stop any existing
22495 * animations that are running.
22497 EAPI void elm_photocam_paused_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
22499 * @brief Get the paused state for photocam
22501 * @param obj The photocam object
22502 * @return The current paused state
22504 * This gets the current paused state for the photocam object.
22506 * @see elm_photocam_paused_set()
22508 EAPI Eina_Bool elm_photocam_paused_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22510 * @brief Get the internal low-res image used for photocam
22512 * @param obj The photocam object
22513 * @return The internal image object handle, or NULL if none exists
22515 * This gets the internal image object inside photocam. Do not modify it. It
22516 * is for inspection only, and hooking callbacks to. Nothing else. It may be
22517 * deleted at any time as well.
22519 EAPI Evas_Object *elm_photocam_internal_image_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22521 * @brief Set the photocam scrolling bouncing.
22523 * @param obj The photocam object
22524 * @param h_bounce bouncing for horizontal
22525 * @param v_bounce bouncing for vertical
22527 EAPI void elm_photocam_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
22529 * @brief Get the photocam scrolling bouncing.
22531 * @param obj The photocam object
22532 * @param h_bounce bouncing for horizontal
22533 * @param v_bounce bouncing for vertical
22535 * @see elm_photocam_bounce_set()
22537 EAPI void elm_photocam_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
22543 * @defgroup Map Map
22544 * @ingroup Elementary
22546 * @image html img/widget/map/preview-00.png
22547 * @image latex img/widget/map/preview-00.eps
22549 * This is a widget specifically for displaying a map. It uses basically
22550 * OpenStreetMap provider http://www.openstreetmap.org/,
22551 * but custom providers can be added.
22553 * It supports some basic but yet nice features:
22554 * @li zoom and scroll
22555 * @li markers with content to be displayed when user clicks over it
22556 * @li group of markers
22559 * Smart callbacks one can listen to:
22561 * - "clicked" - This is called when a user has clicked the map without
22563 * - "press" - This is called when a user has pressed down on the map.
22564 * - "longpressed" - This is called when a user has pressed down on the map
22565 * for a long time without dragging around.
22566 * - "clicked,double" - This is called when a user has double-clicked
22568 * - "load,detail" - Map detailed data load begins.
22569 * - "loaded,detail" - This is called when all currently visible parts of
22570 * the map are loaded.
22571 * - "zoom,start" - Zoom animation started.
22572 * - "zoom,stop" - Zoom animation stopped.
22573 * - "zoom,change" - Zoom changed when using an auto zoom mode.
22574 * - "scroll" - the content has been scrolled (moved).
22575 * - "scroll,anim,start" - scrolling animation has started.
22576 * - "scroll,anim,stop" - scrolling animation has stopped.
22577 * - "scroll,drag,start" - dragging the contents around has started.
22578 * - "scroll,drag,stop" - dragging the contents around has stopped.
22579 * - "downloaded" - This is called when all currently required map images
22581 * - "route,load" - This is called when route request begins.
22582 * - "route,loaded" - This is called when route request ends.
22583 * - "name,load" - This is called when name request begins.
22584 * - "name,loaded- This is called when name request ends.
22586 * Available style for map widget:
22589 * Available style for markers:
22594 * Available style for marker bubble:
22597 * List of examples:
22598 * @li @ref map_example_01
22599 * @li @ref map_example_02
22600 * @li @ref map_example_03
22609 * @enum _Elm_Map_Zoom_Mode
22610 * @typedef Elm_Map_Zoom_Mode
22612 * Set map's zoom behavior. It can be set to manual or automatic.
22614 * Default value is #ELM_MAP_ZOOM_MODE_MANUAL.
22616 * Values <b> don't </b> work as bitmask, only one can be choosen.
22618 * @note Valid sizes are 2^zoom, consequently the map may be smaller
22619 * than the scroller view.
22621 * @see elm_map_zoom_mode_set()
22622 * @see elm_map_zoom_mode_get()
22626 typedef enum _Elm_Map_Zoom_Mode
22628 ELM_MAP_ZOOM_MODE_MANUAL, /**< Zoom controlled manually by elm_map_zoom_set(). It's set by default. */
22629 ELM_MAP_ZOOM_MODE_AUTO_FIT, /**< Zoom until map fits inside the scroll frame with no pixels outside this area. */
22630 ELM_MAP_ZOOM_MODE_AUTO_FILL, /**< Zoom until map fills scroll, ensuring no pixels are left unfilled. */
22631 ELM_MAP_ZOOM_MODE_LAST
22632 } Elm_Map_Zoom_Mode;
22635 * @enum _Elm_Map_Route_Sources
22636 * @typedef Elm_Map_Route_Sources
22638 * Set route service to be used. By default used source is
22639 * #ELM_MAP_ROUTE_SOURCE_YOURS.
22641 * @see elm_map_route_source_set()
22642 * @see elm_map_route_source_get()
22646 typedef enum _Elm_Map_Route_Sources
22648 ELM_MAP_ROUTE_SOURCE_YOURS, /**< Routing service http://www.yournavigation.org/ . Set by default.*/
22649 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. */
22650 ELM_MAP_ROUTE_SOURCE_ORS, /**< Open Route Service: http://www.openrouteservice.org/ . It's not working with Map yet. */
22651 ELM_MAP_ROUTE_SOURCE_LAST
22652 } Elm_Map_Route_Sources;
22654 typedef enum _Elm_Map_Name_Sources
22656 ELM_MAP_NAME_SOURCE_NOMINATIM,
22657 ELM_MAP_NAME_SOURCE_LAST
22658 } Elm_Map_Name_Sources;
22661 * @enum _Elm_Map_Route_Type
22662 * @typedef Elm_Map_Route_Type
22664 * Set type of transport used on route.
22666 * @see elm_map_route_add()
22670 typedef enum _Elm_Map_Route_Type
22672 ELM_MAP_ROUTE_TYPE_MOTOCAR, /**< Route should consider an automobile will be used. */
22673 ELM_MAP_ROUTE_TYPE_BICYCLE, /**< Route should consider a bicycle will be used by the user. */
22674 ELM_MAP_ROUTE_TYPE_FOOT, /**< Route should consider user will be walking. */
22675 ELM_MAP_ROUTE_TYPE_LAST
22676 } Elm_Map_Route_Type;
22679 * @enum _Elm_Map_Route_Method
22680 * @typedef Elm_Map_Route_Method
22682 * Set the routing method, what should be priorized, time or distance.
22684 * @see elm_map_route_add()
22688 typedef enum _Elm_Map_Route_Method
22690 ELM_MAP_ROUTE_METHOD_FASTEST, /**< Route should priorize time. */
22691 ELM_MAP_ROUTE_METHOD_SHORTEST, /**< Route should priorize distance. */
22692 ELM_MAP_ROUTE_METHOD_LAST
22693 } Elm_Map_Route_Method;
22695 typedef enum _Elm_Map_Name_Method
22697 ELM_MAP_NAME_METHOD_SEARCH,
22698 ELM_MAP_NAME_METHOD_REVERSE,
22699 ELM_MAP_NAME_METHOD_LAST
22700 } Elm_Map_Name_Method;
22702 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(). */
22703 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(). */
22704 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(). */
22705 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(). */
22706 typedef struct _Elm_Map_Name Elm_Map_Name; /**< A handle for specific coordinates. */
22707 typedef struct _Elm_Map_Track Elm_Map_Track;
22709 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. */
22710 typedef void (*ElmMapMarkerDelFunc) (Evas_Object *obj, Elm_Map_Marker *marker, void *data, Evas_Object *o); /**< Function to delete bubble content for marker classes. */
22711 typedef Evas_Object *(*ElmMapMarkerIconGetFunc) (Evas_Object *obj, Elm_Map_Marker *marker, void *data); /**< Icon fetching class function for marker classes. */
22712 typedef Evas_Object *(*ElmMapGroupIconGetFunc) (Evas_Object *obj, void *data); /**< Icon fetching class function for markers group classes. */
22714 typedef char *(*ElmMapModuleSourceFunc) (void);
22715 typedef int (*ElmMapModuleZoomMinFunc) (void);
22716 typedef int (*ElmMapModuleZoomMaxFunc) (void);
22717 typedef char *(*ElmMapModuleUrlFunc) (Evas_Object *obj, int x, int y, int zoom);
22718 typedef int (*ElmMapModuleRouteSourceFunc) (void);
22719 typedef char *(*ElmMapModuleRouteUrlFunc) (Evas_Object *obj, char *type_name, int method, double flon, double flat, double tlon, double tlat);
22720 typedef char *(*ElmMapModuleNameUrlFunc) (Evas_Object *obj, int method, char *name, double lon, double lat);
22721 typedef Eina_Bool (*ElmMapModuleGeoIntoCoordFunc) (const Evas_Object *obj, int zoom, double lon, double lat, int size, int *x, int *y);
22722 typedef Eina_Bool (*ElmMapModuleCoordIntoGeoFunc) (const Evas_Object *obj, int zoom, int x, int y, int size, double *lon, double *lat);
22725 * Add a new map widget to the given parent Elementary (container) object.
22727 * @param parent The parent object.
22728 * @return a new map widget handle or @c NULL, on errors.
22730 * This function inserts a new map widget on the canvas.
22734 EAPI Evas_Object *elm_map_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22737 * Set the zoom level of the map.
22739 * @param obj The map object.
22740 * @param zoom The zoom level to set.
22742 * This sets the zoom level.
22744 * It will respect limits defined by elm_map_source_zoom_min_set() and
22745 * elm_map_source_zoom_max_set().
22747 * By default these values are 0 (world map) and 18 (maximum zoom).
22749 * This function should be used when zoom mode is set to
22750 * #ELM_MAP_ZOOM_MODE_MANUAL. This is the default mode, and can be set
22751 * with elm_map_zoom_mode_set().
22753 * @see elm_map_zoom_mode_set().
22754 * @see elm_map_zoom_get().
22758 EAPI void elm_map_zoom_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
22761 * Get the zoom level of the map.
22763 * @param obj The map object.
22764 * @return The current zoom level.
22766 * This returns the current zoom level of the map object.
22768 * Note that if you set the fill mode to other than #ELM_MAP_ZOOM_MODE_MANUAL
22769 * (which is the default), the zoom level may be changed at any time by the
22770 * map object itself to account for map size and map viewport size.
22772 * @see elm_map_zoom_set() for details.
22776 EAPI int elm_map_zoom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22779 * Set the zoom mode used by the map object.
22781 * @param obj The map object.
22782 * @param mode The zoom mode of the map, being it one of
22783 * #ELM_MAP_ZOOM_MODE_MANUAL (default), #ELM_MAP_ZOOM_MODE_AUTO_FIT,
22784 * or #ELM_MAP_ZOOM_MODE_AUTO_FILL.
22786 * This sets the zoom mode to manual or one of the automatic levels.
22787 * Manual (#ELM_MAP_ZOOM_MODE_MANUAL) means that zoom is set manually by
22788 * elm_map_zoom_set() and will stay at that level until changed by code
22789 * or until zoom mode is changed. This is the default mode.
22791 * The Automatic modes will allow the map object to automatically
22792 * adjust zoom mode based on properties. #ELM_MAP_ZOOM_MODE_AUTO_FIT will
22793 * adjust zoom so the map fits inside the scroll frame with no pixels
22794 * outside this area. #ELM_MAP_ZOOM_MODE_AUTO_FILL will be similar but
22795 * ensure no pixels within the frame are left unfilled. Do not forget that
22796 * the valid sizes are 2^zoom, consequently the map may be smaller than
22797 * the scroller view.
22799 * @see elm_map_zoom_set()
22803 EAPI void elm_map_zoom_mode_set(Evas_Object *obj, Elm_Map_Zoom_Mode mode) EINA_ARG_NONNULL(1);
22806 * Get the zoom mode used by the map object.
22808 * @param obj The map object.
22809 * @return The zoom mode of the map, being it one of
22810 * #ELM_MAP_ZOOM_MODE_MANUAL (default), #ELM_MAP_ZOOM_MODE_AUTO_FIT,
22811 * or #ELM_MAP_ZOOM_MODE_AUTO_FILL.
22813 * This function returns the current zoom mode used by the map object.
22815 * @see elm_map_zoom_mode_set() for more details.
22819 EAPI Elm_Map_Zoom_Mode elm_map_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22822 * Get the current coordinates of the map.
22824 * @param obj The map object.
22825 * @param lon Pointer where to store longitude.
22826 * @param lat Pointer where to store latitude.
22828 * This gets the current center coordinates of the map object. It can be
22829 * set by elm_map_geo_region_bring_in() and elm_map_geo_region_show().
22831 * @see elm_map_geo_region_bring_in()
22832 * @see elm_map_geo_region_show()
22836 EAPI void elm_map_geo_region_get(const Evas_Object *obj, double *lon, double *lat) EINA_ARG_NONNULL(1);
22839 * Animatedly bring in given coordinates to the center of the map.
22841 * @param obj The map object.
22842 * @param lon Longitude to center at.
22843 * @param lat Latitude to center at.
22845 * This causes map to jump to the given @p lat and @p lon coordinates
22846 * and show it (by scrolling) in the center of the viewport, if it is not
22847 * already centered. This will use animation to do so and take a period
22848 * of time to complete.
22850 * @see elm_map_geo_region_show() for a function to avoid animation.
22851 * @see elm_map_geo_region_get()
22855 EAPI void elm_map_geo_region_bring_in(Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
22858 * Show the given coordinates at the center of the map, @b immediately.
22860 * @param obj The map object.
22861 * @param lon Longitude to center at.
22862 * @param lat Latitude to center at.
22864 * This causes map to @b redraw its viewport's contents to the
22865 * region contining the given @p lat and @p lon, that will be moved to the
22866 * center of the map.
22868 * @see elm_map_geo_region_bring_in() for a function to move with animation.
22869 * @see elm_map_geo_region_get()
22873 EAPI void elm_map_geo_region_show(Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
22876 * Pause or unpause the map.
22878 * @param obj The map object.
22879 * @param paused Use @c EINA_TRUE to pause the map @p obj or @c EINA_FALSE
22882 * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
22885 * The default is off.
22887 * This will stop zooming using animation, changing zoom levels will
22888 * change instantly. This will stop any existing animations that are running.
22890 * @see elm_map_paused_get()
22894 EAPI void elm_map_paused_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
22897 * Get a value whether map is paused or not.
22899 * @param obj The map object.
22900 * @return @c EINA_TRUE means map is pause. @c EINA_FALSE indicates
22901 * it is not. If @p obj is @c NULL, @c EINA_FALSE is returned.
22903 * This gets the current paused state for the map object.
22905 * @see elm_map_paused_set() for details.
22909 EAPI Eina_Bool elm_map_paused_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22912 * Set to show markers during zoom level changes or not.
22914 * @param obj The map object.
22915 * @param paused Use @c EINA_TRUE to @b not show markers or @c EINA_FALSE
22918 * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
22921 * The default is off.
22923 * This will stop zooming using animation, changing zoom levels will
22924 * change instantly. This will stop any existing animations that are running.
22926 * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
22929 * The default is off.
22931 * Enabling it will force the map to stop displaying the markers during
22932 * zoom level changes. Set to on if you have a large number of markers.
22934 * @see elm_map_paused_markers_get()
22938 EAPI void elm_map_paused_markers_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
22941 * Get a value whether markers will be displayed on zoom level changes or not
22943 * @param obj The map object.
22944 * @return @c EINA_TRUE means map @b won't display markers or @c EINA_FALSE
22945 * indicates it will. If @p obj is @c NULL, @c EINA_FALSE is returned.
22947 * This gets the current markers paused state for the map object.
22949 * @see elm_map_paused_markers_set() for details.
22953 EAPI Eina_Bool elm_map_paused_markers_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22956 * Get the information of downloading status.
22958 * @param obj The map object.
22959 * @param try_num Pointer where to store number of tiles being downloaded.
22960 * @param finish_num Pointer where to store number of tiles successfully
22963 * This gets the current downloading status for the map object, the number
22964 * of tiles being downloaded and the number of tiles already downloaded.
22968 EAPI void elm_map_utils_downloading_status_get(const Evas_Object *obj, int *try_num, int *finish_num) EINA_ARG_NONNULL(1, 2, 3);
22971 * Convert a pixel coordinate (x,y) into a geographic coordinate
22972 * (longitude, latitude).
22974 * @param obj The map object.
22975 * @param x the coordinate.
22976 * @param y the coordinate.
22977 * @param size the size in pixels of the map.
22978 * The map is a square and generally his size is : pow(2.0, zoom)*256.
22979 * @param lon Pointer where to store the longitude that correspond to x.
22980 * @param lat Pointer where to store the latitude that correspond to y.
22982 * @note Origin pixel point is the top left corner of the viewport.
22983 * Map zoom and size are taken on account.
22985 * @see elm_map_utils_convert_geo_into_coord() if you need the inverse.
22989 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);
22992 * Convert a geographic coordinate (longitude, latitude) into a pixel
22993 * coordinate (x, y).
22995 * @param obj The map object.
22996 * @param lon the longitude.
22997 * @param lat the latitude.
22998 * @param size the size in pixels of the map. The map is a square
22999 * and generally his size is : pow(2.0, zoom)*256.
23000 * @param x Pointer where to store the horizontal pixel coordinate that
23001 * correspond to the longitude.
23002 * @param y Pointer where to store the vertical pixel coordinate that
23003 * correspond to the latitude.
23005 * @note Origin pixel point is the top left corner of the viewport.
23006 * Map zoom and size are taken on account.
23008 * @see elm_map_utils_convert_coord_into_geo() if you need the inverse.
23012 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);
23015 * Convert a geographic coordinate (longitude, latitude) into a name
23018 * @param obj The map object.
23019 * @param lon the longitude.
23020 * @param lat the latitude.
23021 * @return name A #Elm_Map_Name handle for this coordinate.
23023 * To get the string for this address, elm_map_name_address_get()
23026 * @see elm_map_utils_convert_name_into_coord() if you need the inverse.
23030 EAPI Elm_Map_Name *elm_map_utils_convert_coord_into_name(const Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
23033 * Convert a name (address) into a geographic coordinate
23034 * (longitude, latitude).
23036 * @param obj The map object.
23037 * @param name The address.
23038 * @return name A #Elm_Map_Name handle for this address.
23040 * To get the longitude and latitude, elm_map_name_region_get()
23043 * @see elm_map_utils_convert_coord_into_name() if you need the inverse.
23047 EAPI Elm_Map_Name *elm_map_utils_convert_name_into_coord(const Evas_Object *obj, char *address) EINA_ARG_NONNULL(1, 2);
23050 * Convert a pixel coordinate into a rotated pixel coordinate.
23052 * @param obj The map object.
23053 * @param x horizontal coordinate of the point to rotate.
23054 * @param y vertical coordinate of the point to rotate.
23055 * @param cx rotation's center horizontal position.
23056 * @param cy rotation's center vertical position.
23057 * @param degree amount of degrees from 0.0 to 360.0 to rotate arount Z axis.
23058 * @param xx Pointer where to store rotated x.
23059 * @param yy Pointer where to store rotated y.
23063 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);
23066 * Add a new marker to the map object.
23068 * @param obj The map object.
23069 * @param lon The longitude of the marker.
23070 * @param lat The latitude of the marker.
23071 * @param clas The class, to use when marker @b isn't grouped to others.
23072 * @param clas_group The class group, to use when marker is grouped to others
23073 * @param data The data passed to the callbacks.
23075 * @return The created marker or @c NULL upon failure.
23077 * A marker will be created and shown in a specific point of the map, defined
23078 * by @p lon and @p lat.
23080 * It will be displayed using style defined by @p class when this marker
23081 * is displayed alone (not grouped). A new class can be created with
23082 * elm_map_marker_class_new().
23084 * If the marker is grouped to other markers, it will be displayed with
23085 * style defined by @p class_group. Markers with the same group are grouped
23086 * if they are close. A new group class can be created with
23087 * elm_map_marker_group_class_new().
23089 * Markers created with this method can be deleted with
23090 * elm_map_marker_remove().
23092 * A marker can have associated content to be displayed by a bubble,
23093 * when a user click over it, as well as an icon. These objects will
23094 * be fetch using class' callback functions.
23096 * @see elm_map_marker_class_new()
23097 * @see elm_map_marker_group_class_new()
23098 * @see elm_map_marker_remove()
23102 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);
23105 * Set the maximum numbers of markers' content to be displayed in a group.
23107 * @param obj The map object.
23108 * @param max The maximum numbers of items displayed in a bubble.
23110 * A bubble will be displayed when the user clicks over the group,
23111 * and will place the content of markers that belong to this group
23114 * A group can have a long list of markers, consequently the creation
23115 * of the content of the bubble can be very slow.
23117 * In order to avoid this, a maximum number of items is displayed
23120 * By default this number is 30.
23122 * Marker with the same group class are grouped if they are close.
23124 * @see elm_map_marker_add()
23128 EAPI void elm_map_max_marker_per_group_set(Evas_Object *obj, int max) EINA_ARG_NONNULL(1);
23131 * Remove a marker from the map.
23133 * @param marker The marker to remove.
23135 * @see elm_map_marker_add()
23139 EAPI void elm_map_marker_remove(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
23142 * Get the current coordinates of the marker.
23144 * @param marker marker.
23145 * @param lat Pointer where to store the marker's latitude.
23146 * @param lon Pointer where to store the marker's longitude.
23148 * These values are set when adding markers, with function
23149 * elm_map_marker_add().
23151 * @see elm_map_marker_add()
23155 EAPI void elm_map_marker_region_get(const Elm_Map_Marker *marker, double *lon, double *lat) EINA_ARG_NONNULL(1);
23158 * Animatedly bring in given marker to the center of the map.
23160 * @param marker The marker to center at.
23162 * This causes map to jump to the given @p marker's coordinates
23163 * and show it (by scrolling) in the center of the viewport, if it is not
23164 * already centered. This will use animation to do so and take a period
23165 * of time to complete.
23167 * @see elm_map_marker_show() for a function to avoid animation.
23168 * @see elm_map_marker_region_get()
23172 EAPI void elm_map_marker_bring_in(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
23175 * Show the given marker at the center of the map, @b immediately.
23177 * @param marker The marker to center at.
23179 * This causes map to @b redraw its viewport's contents to the
23180 * region contining the given @p marker's coordinates, that will be
23181 * moved to the center of the map.
23183 * @see elm_map_marker_bring_in() for a function to move with animation.
23184 * @see elm_map_markers_list_show() if more than one marker need to be
23186 * @see elm_map_marker_region_get()
23190 EAPI void elm_map_marker_show(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
23193 * Move and zoom the map to display a list of markers.
23195 * @param markers A list of #Elm_Map_Marker handles.
23197 * The map will be centered on the center point of the markers in the list.
23198 * Then the map will be zoomed in order to fit the markers using the maximum
23199 * zoom which allows display of all the markers.
23201 * @warning All the markers should belong to the same map object.
23203 * @see elm_map_marker_show() to show a single marker.
23204 * @see elm_map_marker_bring_in()
23208 EAPI void elm_map_markers_list_show(Eina_List *markers) EINA_ARG_NONNULL(1);
23211 * Get the Evas object returned by the ElmMapMarkerGetFunc callback
23213 * @param marker The marker wich content should be returned.
23214 * @return Return the evas object if it exists, else @c NULL.
23216 * To set callback function #ElmMapMarkerGetFunc for the marker class,
23217 * elm_map_marker_class_get_cb_set() should be used.
23219 * This content is what will be inside the bubble that will be displayed
23220 * when an user clicks over the marker.
23222 * This returns the actual Evas object used to be placed inside
23223 * the bubble. This may be @c NULL, as it may
23224 * not have been created or may have been deleted, at any time, by
23225 * the map. <b>Do not modify this object</b> (move, resize,
23226 * show, hide, etc.), as the map is controlling it. This
23227 * function is for querying, emitting custom signals or hooking
23228 * lower level callbacks for events on that object. Do not delete
23229 * this object under any circumstances.
23233 EAPI Evas_Object *elm_map_marker_object_get(const Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
23236 * Update the marker
23238 * @param marker The marker to be updated.
23240 * If a content is set to this marker, it will call function to delete it,
23241 * #ElmMapMarkerDelFunc, and then will fetch the content again with
23242 * #ElmMapMarkerGetFunc.
23244 * These functions are set for the marker class with
23245 * elm_map_marker_class_get_cb_set() and elm_map_marker_class_del_cb_set().
23249 EAPI void elm_map_marker_update(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
23252 * Close all the bubbles opened by the user.
23254 * @param obj The map object.
23256 * A bubble is displayed with a content fetched with #ElmMapMarkerGetFunc
23257 * when the user clicks on a marker.
23259 * This functions is set for the marker class with
23260 * elm_map_marker_class_get_cb_set().
23264 EAPI void elm_map_bubbles_close(Evas_Object *obj) EINA_ARG_NONNULL(1);
23267 * Create a new group class.
23269 * @param obj The map object.
23270 * @return Returns the new group class.
23272 * Each marker must be associated to a group class. Markers in the same
23273 * group are grouped if they are close.
23275 * The group class defines the style of the marker when a marker is grouped
23276 * to others markers. When it is alone, another class will be used.
23278 * A group class will need to be provided when creating a marker with
23279 * elm_map_marker_add().
23281 * Some properties and functions can be set by class, as:
23282 * - style, with elm_map_group_class_style_set()
23283 * - data - to be associated to the group class. It can be set using
23284 * elm_map_group_class_data_set().
23285 * - min zoom to display markers, set with
23286 * elm_map_group_class_zoom_displayed_set().
23287 * - max zoom to group markers, set using
23288 * elm_map_group_class_zoom_grouped_set().
23289 * - visibility - set if markers will be visible or not, set with
23290 * elm_map_group_class_hide_set().
23291 * - #ElmMapGroupIconGetFunc - used to fetch icon for markers group classes.
23292 * It can be set using elm_map_group_class_icon_cb_set().
23294 * @see elm_map_marker_add()
23295 * @see elm_map_group_class_style_set()
23296 * @see elm_map_group_class_data_set()
23297 * @see elm_map_group_class_zoom_displayed_set()
23298 * @see elm_map_group_class_zoom_grouped_set()
23299 * @see elm_map_group_class_hide_set()
23300 * @see elm_map_group_class_icon_cb_set()
23304 EAPI Elm_Map_Group_Class *elm_map_group_class_new(Evas_Object *obj) EINA_ARG_NONNULL(1);
23307 * Set the marker's style of a group class.
23309 * @param clas The group class.
23310 * @param style The style to be used by markers.
23312 * Each marker must be associated to a group class, and will use the style
23313 * defined by such class when grouped to other markers.
23315 * The following styles are provided by default theme:
23316 * @li @c radio - blue circle
23317 * @li @c radio2 - green circle
23320 * @see elm_map_group_class_new() for more details.
23321 * @see elm_map_marker_add()
23325 EAPI void elm_map_group_class_style_set(Elm_Map_Group_Class *clas, const char *style) EINA_ARG_NONNULL(1);
23328 * Set the icon callback function of a group class.
23330 * @param clas The group class.
23331 * @param icon_get The callback function that will return the icon.
23333 * Each marker must be associated to a group class, and it can display a
23334 * custom icon. The function @p icon_get must return this icon.
23336 * @see elm_map_group_class_new() for more details.
23337 * @see elm_map_marker_add()
23341 EAPI void elm_map_group_class_icon_cb_set(Elm_Map_Group_Class *clas, ElmMapGroupIconGetFunc icon_get) EINA_ARG_NONNULL(1);
23344 * Set the data associated to the group class.
23346 * @param clas The group class.
23347 * @param data The new user data.
23349 * This data will be passed for callback functions, like icon get callback,
23350 * that can be set with elm_map_group_class_icon_cb_set().
23352 * If a data was previously set, the object will lose the pointer for it,
23353 * so if needs to be freed, you must do it yourself.
23355 * @see elm_map_group_class_new() for more details.
23356 * @see elm_map_group_class_icon_cb_set()
23357 * @see elm_map_marker_add()
23361 EAPI void elm_map_group_class_data_set(Elm_Map_Group_Class *clas, void *data) EINA_ARG_NONNULL(1);
23364 * Set the minimum zoom from where the markers are displayed.
23366 * @param clas The group class.
23367 * @param zoom The minimum zoom.
23369 * Markers only will be displayed when the map is displayed at @p zoom
23372 * @see elm_map_group_class_new() for more details.
23373 * @see elm_map_marker_add()
23377 EAPI void elm_map_group_class_zoom_displayed_set(Elm_Map_Group_Class *clas, int zoom) EINA_ARG_NONNULL(1);
23380 * Set the zoom from where the markers are no more grouped.
23382 * @param clas The group class.
23383 * @param zoom The maximum zoom.
23385 * Markers only will be grouped when the map is displayed at
23386 * less than @p zoom.
23388 * @see elm_map_group_class_new() for more details.
23389 * @see elm_map_marker_add()
23393 EAPI void elm_map_group_class_zoom_grouped_set(Elm_Map_Group_Class *clas, int zoom) EINA_ARG_NONNULL(1);
23396 * Set if the markers associated to the group class @clas are hidden or not.
23398 * @param clas The group class.
23399 * @param hide Use @c EINA_TRUE to hide markers or @c EINA_FALSE
23402 * If @p hide is @c EINA_TRUE the markers will be hidden, but default
23407 EAPI void elm_map_group_class_hide_set(Evas_Object *obj, Elm_Map_Group_Class *clas, Eina_Bool hide) EINA_ARG_NONNULL(1, 2);
23410 * Create a new marker class.
23412 * @param obj The map object.
23413 * @return Returns the new group class.
23415 * Each marker must be associated to a class.
23417 * The marker class defines the style of the marker when a marker is
23418 * displayed alone, i.e., not grouped to to others markers. When grouped
23419 * it will use group class style.
23421 * A marker class will need to be provided when creating a marker with
23422 * elm_map_marker_add().
23424 * Some properties and functions can be set by class, as:
23425 * - style, with elm_map_marker_class_style_set()
23426 * - #ElmMapMarkerIconGetFunc - used to fetch icon for markers classes.
23427 * It can be set using elm_map_marker_class_icon_cb_set().
23428 * - #ElmMapMarkerGetFunc - used to fetch bubble content for marker classes.
23429 * Set using elm_map_marker_class_get_cb_set().
23430 * - #ElmMapMarkerDelFunc - used to delete bubble content for marker classes.
23431 * Set using elm_map_marker_class_del_cb_set().
23433 * @see elm_map_marker_add()
23434 * @see elm_map_marker_class_style_set()
23435 * @see elm_map_marker_class_icon_cb_set()
23436 * @see elm_map_marker_class_get_cb_set()
23437 * @see elm_map_marker_class_del_cb_set()
23441 EAPI Elm_Map_Marker_Class *elm_map_marker_class_new(Evas_Object *obj) EINA_ARG_NONNULL(1);
23444 * Set the marker's style of a marker class.
23446 * @param clas The marker class.
23447 * @param style The style to be used by markers.
23449 * Each marker must be associated to a marker class, and will use the style
23450 * defined by such class when alone, i.e., @b not grouped to other markers.
23452 * The following styles are provided by default theme:
23457 * @see elm_map_marker_class_new() for more details.
23458 * @see elm_map_marker_add()
23462 EAPI void elm_map_marker_class_style_set(Elm_Map_Marker_Class *clas, const char *style) EINA_ARG_NONNULL(1);
23465 * Set the icon callback function of a marker class.
23467 * @param clas The marker class.
23468 * @param icon_get The callback function that will return the icon.
23470 * Each marker must be associated to a marker class, and it can display a
23471 * custom icon. The function @p icon_get must return this icon.
23473 * @see elm_map_marker_class_new() for more details.
23474 * @see elm_map_marker_add()
23478 EAPI void elm_map_marker_class_icon_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerIconGetFunc icon_get) EINA_ARG_NONNULL(1);
23481 * Set the bubble content callback function of a marker class.
23483 * @param clas The marker class.
23484 * @param get The callback function that will return the content.
23486 * Each marker must be associated to a marker class, and it can display a
23487 * a content on a bubble that opens when the user click over the marker.
23488 * The function @p get must return this content object.
23490 * If this content will need to be deleted, elm_map_marker_class_del_cb_set()
23493 * @see elm_map_marker_class_new() for more details.
23494 * @see elm_map_marker_class_del_cb_set()
23495 * @see elm_map_marker_add()
23499 EAPI void elm_map_marker_class_get_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerGetFunc get) EINA_ARG_NONNULL(1);
23502 * Set the callback function used to delete bubble content of a marker class.
23504 * @param clas The marker class.
23505 * @param del The callback function that will delete the content.
23507 * Each marker must be associated to a marker class, and it can display a
23508 * a content on a bubble that opens when the user click over the marker.
23509 * The function to return such content can be set with
23510 * elm_map_marker_class_get_cb_set().
23512 * If this content must be freed, a callback function need to be
23513 * set for that task with this function.
23515 * If this callback is defined it will have to delete (or not) the
23516 * object inside, but if the callback is not defined the object will be
23517 * destroyed with evas_object_del().
23519 * @see elm_map_marker_class_new() for more details.
23520 * @see elm_map_marker_class_get_cb_set()
23521 * @see elm_map_marker_add()
23525 EAPI void elm_map_marker_class_del_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerDelFunc del) EINA_ARG_NONNULL(1);
23528 * Get the list of available sources.
23530 * @param obj The map object.
23531 * @return The source names list.
23533 * It will provide a list with all available sources, that can be set as
23534 * current source with elm_map_source_name_set(), or get with
23535 * elm_map_source_name_get().
23537 * Available sources:
23543 * @see elm_map_source_name_set() for more details.
23544 * @see elm_map_source_name_get()
23548 EAPI const char **elm_map_source_names_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23551 * Set the source of the map.
23553 * @param obj The map object.
23554 * @param source The source to be used.
23556 * Map widget retrieves images that composes the map from a web service.
23557 * This web service can be set with this method.
23559 * A different service can return a different maps with different
23560 * information and it can use different zoom values.
23562 * The @p source_name need to match one of the names provided by
23563 * elm_map_source_names_get().
23565 * The current source can be get using elm_map_source_name_get().
23567 * @see elm_map_source_names_get()
23568 * @see elm_map_source_name_get()
23573 EAPI void elm_map_source_name_set(Evas_Object *obj, const char *source_name) EINA_ARG_NONNULL(1);
23576 * Get the name of currently used source.
23578 * @param obj The map object.
23579 * @return Returns the name of the source in use.
23581 * @see elm_map_source_name_set() for more details.
23585 EAPI const char *elm_map_source_name_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23588 * Set the source of the route service to be used by the map.
23590 * @param obj The map object.
23591 * @param source The route service to be used, being it one of
23592 * #ELM_MAP_ROUTE_SOURCE_YOURS (default), #ELM_MAP_ROUTE_SOURCE_MONAV,
23593 * and #ELM_MAP_ROUTE_SOURCE_ORS.
23595 * Each one has its own algorithm, so the route retrieved may
23596 * differ depending on the source route. Now, only the default is working.
23598 * #ELM_MAP_ROUTE_SOURCE_YOURS is the routing service provided at
23599 * http://www.yournavigation.org/.
23601 * #ELM_MAP_ROUTE_SOURCE_MONAV, offers exact routing without heuristic
23602 * assumptions. Its routing core is based on Contraction Hierarchies.
23604 * #ELM_MAP_ROUTE_SOURCE_ORS, is provided at http://www.openrouteservice.org/
23606 * @see elm_map_route_source_get().
23610 EAPI void elm_map_route_source_set(Evas_Object *obj, Elm_Map_Route_Sources source) EINA_ARG_NONNULL(1);
23613 * Get the current route source.
23615 * @param obj The map object.
23616 * @return The source of the route service used by the map.
23618 * @see elm_map_route_source_set() for details.
23622 EAPI Elm_Map_Route_Sources elm_map_route_source_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23625 * Set the minimum zoom of the source.
23627 * @param obj The map object.
23628 * @param zoom New minimum zoom value to be used.
23630 * By default, it's 0.
23634 EAPI void elm_map_source_zoom_min_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
23637 * Get the minimum zoom of the source.
23639 * @param obj The map object.
23640 * @return Returns the minimum zoom of the source.
23642 * @see elm_map_source_zoom_min_set() for details.
23646 EAPI int elm_map_source_zoom_min_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23649 * Set the maximum zoom of the source.
23651 * @param obj The map object.
23652 * @param zoom New maximum zoom value to be used.
23654 * By default, it's 18.
23658 EAPI void elm_map_source_zoom_max_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
23661 * Get the maximum zoom of the source.
23663 * @param obj The map object.
23664 * @return Returns the maximum zoom of the source.
23666 * @see elm_map_source_zoom_min_set() for details.
23670 EAPI int elm_map_source_zoom_max_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23673 * Set the user agent used by the map object to access routing services.
23675 * @param obj The map object.
23676 * @param user_agent The user agent to be used by the map.
23678 * User agent is a client application implementing a network protocol used
23679 * in communications within a clientāserver distributed computing system
23681 * The @p user_agent identification string will transmitted in a header
23682 * field @c User-Agent.
23684 * @see elm_map_user_agent_get()
23688 EAPI void elm_map_user_agent_set(Evas_Object *obj, const char *user_agent) EINA_ARG_NONNULL(1, 2);
23691 * Get the user agent used by the map object.
23693 * @param obj The map object.
23694 * @return The user agent identification string used by the map.
23696 * @see elm_map_user_agent_set() for details.
23700 EAPI const char *elm_map_user_agent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23703 * Add a new route to the map object.
23705 * @param obj The map object.
23706 * @param type The type of transport to be considered when tracing a route.
23707 * @param method The routing method, what should be priorized.
23708 * @param flon The start longitude.
23709 * @param flat The start latitude.
23710 * @param tlon The destination longitude.
23711 * @param tlat The destination latitude.
23713 * @return The created route or @c NULL upon failure.
23715 * A route will be traced by point on coordinates (@p flat, @p flon)
23716 * to point on coordinates (@p tlat, @p tlon), using the route service
23717 * set with elm_map_route_source_set().
23719 * It will take @p type on consideration to define the route,
23720 * depending if the user will be walking or driving, the route may vary.
23721 * One of #ELM_MAP_ROUTE_TYPE_MOTOCAR, #ELM_MAP_ROUTE_TYPE_BICYCLE, or
23722 * #ELM_MAP_ROUTE_TYPE_FOOT need to be used.
23724 * Another parameter is what the route should priorize, the minor distance
23725 * or the less time to be spend on the route. So @p method should be one
23726 * of #ELM_MAP_ROUTE_METHOD_SHORTEST or #ELM_MAP_ROUTE_METHOD_FASTEST.
23728 * Routes created with this method can be deleted with
23729 * elm_map_route_remove(), colored with elm_map_route_color_set(),
23730 * and distance can be get with elm_map_route_distance_get().
23732 * @see elm_map_route_remove()
23733 * @see elm_map_route_color_set()
23734 * @see elm_map_route_distance_get()
23735 * @see elm_map_route_source_set()
23739 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);
23742 * Remove a route from the map.
23744 * @param route The route to remove.
23746 * @see elm_map_route_add()
23750 EAPI void elm_map_route_remove(Elm_Map_Route *route) EINA_ARG_NONNULL(1);
23753 * Set the route color.
23755 * @param route The route object.
23756 * @param r Red channel value, from 0 to 255.
23757 * @param g Green channel value, from 0 to 255.
23758 * @param b Blue channel value, from 0 to 255.
23759 * @param a Alpha channel value, from 0 to 255.
23761 * It uses an additive color model, so each color channel represents
23762 * how much of each primary colors must to be used. 0 represents
23763 * ausence of this color, so if all of the three are set to 0,
23764 * the color will be black.
23766 * These component values should be integers in the range 0 to 255,
23767 * (single 8-bit byte).
23769 * This sets the color used for the route. By default, it is set to
23770 * solid red (r = 255, g = 0, b = 0, a = 255).
23772 * For alpha channel, 0 represents completely transparent, and 255, opaque.
23774 * @see elm_map_route_color_get()
23778 EAPI void elm_map_route_color_set(Elm_Map_Route *route, int r, int g , int b, int a) EINA_ARG_NONNULL(1);
23781 * Get the route color.
23783 * @param route The route object.
23784 * @param r Pointer where to store the red channel value.
23785 * @param g Pointer where to store the green channel value.
23786 * @param b Pointer where to store the blue channel value.
23787 * @param a Pointer where to store the alpha channel value.
23789 * @see elm_map_route_color_set() for details.
23793 EAPI void elm_map_route_color_get(const Elm_Map_Route *route, int *r, int *g , int *b, int *a) EINA_ARG_NONNULL(1);
23796 * Get the route distance in kilometers.
23798 * @param route The route object.
23799 * @return The distance of route (unit : km).
23803 EAPI double elm_map_route_distance_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
23806 * Get the information of route nodes.
23808 * @param route The route object.
23809 * @return Returns a string with the nodes of route.
23813 EAPI const char *elm_map_route_node_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
23816 * Get the information of route waypoint.
23818 * @param route the route object.
23819 * @return Returns a string with information about waypoint of route.
23823 EAPI const char *elm_map_route_waypoint_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
23826 * Get the address of the name.
23828 * @param name The name handle.
23829 * @return Returns the address string of @p name.
23831 * This gets the coordinates of the @p name, created with one of the
23832 * conversion functions.
23834 * @see elm_map_utils_convert_name_into_coord()
23835 * @see elm_map_utils_convert_coord_into_name()
23839 EAPI const char *elm_map_name_address_get(const Elm_Map_Name *name) EINA_ARG_NONNULL(1);
23842 * Get the current coordinates of the name.
23844 * @param name The name handle.
23845 * @param lat Pointer where to store the latitude.
23846 * @param lon Pointer where to store The longitude.
23848 * This gets the coordinates of the @p name, created with one of the
23849 * conversion functions.
23851 * @see elm_map_utils_convert_name_into_coord()
23852 * @see elm_map_utils_convert_coord_into_name()
23856 EAPI void elm_map_name_region_get(const Elm_Map_Name *name, double *lon, double *lat) EINA_ARG_NONNULL(1);
23859 * Remove a name from the map.
23861 * @param name The name to remove.
23863 * Basically the struct handled by @p name will be freed, so convertions
23864 * between address and coordinates will be lost.
23866 * @see elm_map_utils_convert_name_into_coord()
23867 * @see elm_map_utils_convert_coord_into_name()
23871 EAPI void elm_map_name_remove(Elm_Map_Name *name) EINA_ARG_NONNULL(1);
23876 * @param obj The map object.
23877 * @param degree Angle from 0.0 to 360.0 to rotate arount Z axis.
23878 * @param cx Rotation's center horizontal position.
23879 * @param cy Rotation's center vertical position.
23881 * @see elm_map_rotate_get()
23885 EAPI void elm_map_rotate_set(Evas_Object *obj, double degree, Evas_Coord cx, Evas_Coord cy) EINA_ARG_NONNULL(1);
23888 * Get the rotate degree of the map
23890 * @param obj The map object
23891 * @param degree Pointer where to store degrees from 0.0 to 360.0
23892 * to rotate arount Z axis.
23893 * @param cx Pointer where to store rotation's center horizontal position.
23894 * @param cy Pointer where to store rotation's center vertical position.
23896 * @see elm_map_rotate_set() to set map rotation.
23900 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);
23903 * Enable or disable mouse wheel to be used to zoom in / out the map.
23905 * @param obj The map object.
23906 * @param disabled Use @c EINA_TRUE to disable mouse wheel or @c EINA_FALSE
23909 * Mouse wheel can be used for the user to zoom in or zoom out the map.
23911 * It's disabled by default.
23913 * @see elm_map_wheel_disabled_get()
23917 EAPI void elm_map_wheel_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
23920 * Get a value whether mouse wheel is enabled or not.
23922 * @param obj The map object.
23923 * @return @c EINA_TRUE means map is disabled. @c EINA_FALSE indicates
23924 * it is enabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
23926 * Mouse wheel can be used for the user to zoom in or zoom out the map.
23928 * @see elm_map_wheel_disabled_set() for details.
23932 EAPI Eina_Bool elm_map_wheel_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23936 * Add a track on the map
23938 * @param obj The map object.
23939 * @param emap The emap route object.
23940 * @return The route object. This is an elm object of type Route.
23942 * @see elm_route_add() for details.
23946 EAPI Evas_Object *elm_map_track_add(Evas_Object *obj, EMap_Route *emap) EINA_ARG_NONNULL(1);
23950 * Remove a track from the map
23952 * @param obj The map object.
23953 * @param route The track to remove.
23957 EAPI void elm_map_track_remove(Evas_Object *obj, Evas_Object *route) EINA_ARG_NONNULL(1);
23964 EAPI Evas_Object *elm_route_add(Evas_Object *parent);
23966 EAPI void elm_route_emap_set(Evas_Object *obj, EMap_Route *emap);
23968 EAPI double elm_route_lon_min_get(Evas_Object *obj);
23969 EAPI double elm_route_lat_min_get(Evas_Object *obj);
23970 EAPI double elm_route_lon_max_get(Evas_Object *obj);
23971 EAPI double elm_route_lat_max_get(Evas_Object *obj);
23975 * @defgroup Panel Panel
23977 * @image html img/widget/panel/preview-00.png
23978 * @image latex img/widget/panel/preview-00.eps
23980 * @brief A panel is a type of animated container that contains subobjects.
23981 * It can be expanded or contracted by clicking the button on it's edge.
23983 * Orientations are as follows:
23984 * @li ELM_PANEL_ORIENT_TOP
23985 * @li ELM_PANEL_ORIENT_LEFT
23986 * @li ELM_PANEL_ORIENT_RIGHT
23988 * Default contents parts of the panel widget that you can use for are:
23989 * @li "default" - A content of the panel
23991 * @ref tutorial_panel shows one way to use this widget.
23994 typedef enum _Elm_Panel_Orient
23996 ELM_PANEL_ORIENT_TOP, /**< Panel (dis)appears from the top */
23997 ELM_PANEL_ORIENT_BOTTOM, /**< Not implemented */
23998 ELM_PANEL_ORIENT_LEFT, /**< Panel (dis)appears from the left */
23999 ELM_PANEL_ORIENT_RIGHT, /**< Panel (dis)appears from the right */
24000 } Elm_Panel_Orient;
24002 * @brief Adds a panel object
24004 * @param parent The parent object
24006 * @return The panel object, or NULL on failure
24008 EAPI Evas_Object *elm_panel_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24010 * @brief Sets the orientation of the panel
24012 * @param parent The parent object
24013 * @param orient The panel orientation. Can be one of the following:
24014 * @li ELM_PANEL_ORIENT_TOP
24015 * @li ELM_PANEL_ORIENT_LEFT
24016 * @li ELM_PANEL_ORIENT_RIGHT
24018 * Sets from where the panel will (dis)appear.
24020 EAPI void elm_panel_orient_set(Evas_Object *obj, Elm_Panel_Orient orient) EINA_ARG_NONNULL(1);
24022 * @brief Get the orientation of the panel.
24024 * @param obj The panel object
24025 * @return The Elm_Panel_Orient, or ELM_PANEL_ORIENT_LEFT on failure.
24027 EAPI Elm_Panel_Orient elm_panel_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24029 * @brief Set the content of the panel.
24031 * @param obj The panel object
24032 * @param content The panel content
24034 * Once the content object is set, a previously set one will be deleted.
24035 * If you want to keep that old content object, use the
24036 * elm_panel_content_unset() function.
24038 * @deprecated use elm_object_content_set() instead
24041 EINA_DEPRECATED EAPI void elm_panel_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
24043 * @brief Get the content of the panel.
24045 * @param obj The panel object
24046 * @return The content that is being used
24048 * Return the content object which is set for this widget.
24050 * @see elm_panel_content_set()
24052 * @deprecated use elm_object_content_get() instead
24055 EINA_DEPRECATED EAPI Evas_Object *elm_panel_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24057 * @brief Unset the content of the panel.
24059 * @param obj The panel object
24060 * @return The content that was being used
24062 * Unparent and return the content object which was set for this widget.
24064 * @see elm_panel_content_set()
24066 * @deprecated use elm_object_content_unset() instead
24069 EINA_DEPRECATED EAPI Evas_Object *elm_panel_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24071 * @brief Set the state of the panel.
24073 * @param obj The panel object
24074 * @param hidden If true, the panel will run the animation to contract
24076 EAPI void elm_panel_hidden_set(Evas_Object *obj, Eina_Bool hidden) EINA_ARG_NONNULL(1);
24078 * @brief Get the state of the panel.
24080 * @param obj The panel object
24081 * @param hidden If true, the panel is in the "hide" state
24083 EAPI Eina_Bool elm_panel_hidden_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24085 * @brief Toggle the hidden state of the panel from code
24087 * @param obj The panel object
24089 EAPI void elm_panel_toggle(Evas_Object *obj) EINA_ARG_NONNULL(1);
24095 * @defgroup Panes Panes
24096 * @ingroup Elementary
24098 * @image html img/widget/panes/preview-00.png
24099 * @image latex img/widget/panes/preview-00.eps width=\textwidth
24101 * @image html img/panes.png
24102 * @image latex img/panes.eps width=\textwidth
24104 * The panes adds a dragable bar between two contents. When dragged
24105 * this bar will resize contents size.
24107 * Panes can be displayed vertically or horizontally, and contents
24108 * size proportion can be customized (homogeneous by default).
24110 * Smart callbacks one can listen to:
24111 * - "press" - The panes has been pressed (button wasn't released yet).
24112 * - "unpressed" - The panes was released after being pressed.
24113 * - "clicked" - The panes has been clicked>
24114 * - "clicked,double" - The panes has been double clicked
24116 * Available styles for it:
24119 * Default contents parts of the panes widget that you can use for are:
24120 * @li "left" - A leftside content of the panes
24121 * @li "right" - A rightside content of the panes
24123 * If panes is displayed vertically, left content will be displayed at
24126 * Here is an example on its usage:
24127 * @li @ref panes_example
24131 * @addtogroup Panes
24136 * Add a new panes widget to the given parent Elementary
24137 * (container) object.
24139 * @param parent The parent object.
24140 * @return a new panes widget handle or @c NULL, on errors.
24142 * This function inserts a new panes widget on the canvas.
24146 EAPI Evas_Object *elm_panes_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24149 * Set the left content of the panes widget.
24151 * @param obj The panes object.
24152 * @param content The new left content object.
24154 * Once the content object is set, a previously set one will be deleted.
24155 * If you want to keep that old content object, use the
24156 * elm_panes_content_left_unset() function.
24158 * If panes is displayed vertically, left content will be displayed at
24161 * @see elm_panes_content_left_get()
24162 * @see elm_panes_content_right_set() to set content on the other side.
24164 * @deprecated use elm_object_part_content_set() instead
24168 EINA_DEPRECATED EAPI void elm_panes_content_left_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
24171 * Set the right content of the panes widget.
24173 * @param obj The panes object.
24174 * @param content The new right content object.
24176 * Once the content object is set, a previously set one will be deleted.
24177 * If you want to keep that old content object, use the
24178 * elm_panes_content_right_unset() function.
24180 * If panes is displayed vertically, left content will be displayed at
24183 * @see elm_panes_content_right_get()
24184 * @see elm_panes_content_left_set() to set content on the other side.
24186 * @deprecated use elm_object_part_content_set() instead
24190 EINA_DEPRECATED EAPI void elm_panes_content_right_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
24193 * Get the left content of the panes.
24195 * @param obj The panes object.
24196 * @return The left content object that is being used.
24198 * Return the left content object which is set for this widget.
24200 * @see elm_panes_content_left_set() for details.
24202 * @deprecated use elm_object_part_content_get() instead
24206 EINA_DEPRECATED EAPI Evas_Object *elm_panes_content_left_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24209 * Get the right content of the panes.
24211 * @param obj The panes object
24212 * @return The right content object that is being used
24214 * Return the right content object which is set for this widget.
24216 * @see elm_panes_content_right_set() for details.
24218 * @deprecated use elm_object_part_content_get() instead
24222 EINA_DEPRECATED EAPI Evas_Object *elm_panes_content_right_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24225 * Unset the left content used for the panes.
24227 * @param obj The panes object.
24228 * @return The left content object that was being used.
24230 * Unparent and return the left content object which was set for this widget.
24232 * @see elm_panes_content_left_set() for details.
24233 * @see elm_panes_content_left_get().
24235 * @deprecated use elm_object_part_content_unset() instead
24239 EINA_DEPRECATED EAPI Evas_Object *elm_panes_content_left_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24242 * Unset the right content used for the panes.
24244 * @param obj The panes object.
24245 * @return The right content object that was being used.
24247 * Unparent and return the right content object which was set for this
24250 * @see elm_panes_content_right_set() for details.
24251 * @see elm_panes_content_right_get().
24253 * @deprecated use elm_object_part_content_unset() instead
24257 EINA_DEPRECATED EAPI Evas_Object *elm_panes_content_right_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24260 * Get the size proportion of panes widget's left side.
24262 * @param obj The panes object.
24263 * @return float value between 0.0 and 1.0 representing size proportion
24266 * @see elm_panes_content_left_size_set() for more details.
24270 EAPI double elm_panes_content_left_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24273 * Set the size proportion of panes widget's left side.
24275 * @param obj The panes object.
24276 * @param size Value between 0.0 and 1.0 representing size proportion
24279 * By default it's homogeneous, i.e., both sides have the same size.
24281 * If something different is required, it can be set with this function.
24282 * For example, if the left content should be displayed over
24283 * 75% of the panes size, @p size should be passed as @c 0.75.
24284 * This way, right content will be resized to 25% of panes size.
24286 * If displayed vertically, left content is displayed at top, and
24287 * right content at bottom.
24289 * @note This proportion will change when user drags the panes bar.
24291 * @see elm_panes_content_left_size_get()
24295 EAPI void elm_panes_content_left_size_set(Evas_Object *obj, double size) EINA_ARG_NONNULL(1);
24298 * Set the orientation of a given panes widget.
24300 * @param obj The panes object.
24301 * @param horizontal Use @c EINA_TRUE to make @p obj to be
24302 * @b horizontal, @c EINA_FALSE to make it @b vertical.
24304 * Use this function to change how your panes is to be
24305 * disposed: vertically or horizontally.
24307 * By default it's displayed horizontally.
24309 * @see elm_panes_horizontal_get()
24313 EAPI void elm_panes_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
24316 * Retrieve the orientation of a given panes widget.
24318 * @param obj The panes object.
24319 * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
24320 * @c EINA_FALSE if it's @b vertical (and on errors).
24322 * @see elm_panes_horizontal_set() for more details.
24326 EAPI Eina_Bool elm_panes_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24327 EAPI void elm_panes_fixed_set(Evas_Object *obj, Eina_Bool fixed) EINA_ARG_NONNULL(1);
24328 EAPI Eina_Bool elm_panes_fixed_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24335 * @defgroup Flip Flip
24337 * @image html img/widget/flip/preview-00.png
24338 * @image latex img/widget/flip/preview-00.eps
24340 * This widget holds 2 content objects(Evas_Object): one on the front and one
24341 * on the back. It allows you to flip from front to back and vice-versa using
24342 * various animations.
24344 * If either the front or back contents are not set the flip will treat that
24345 * as transparent. So if you wore to set the front content but not the back,
24346 * and then call elm_flip_go() you would see whatever is below the flip.
24348 * For a list of supported animations see elm_flip_go().
24350 * Signals that you can add callbacks for are:
24351 * "animate,begin" - when a flip animation was started
24352 * "animate,done" - when a flip animation is finished
24354 * @ref tutorial_flip show how to use most of the API.
24358 typedef enum _Elm_Flip_Mode
24360 ELM_FLIP_ROTATE_Y_CENTER_AXIS,
24361 ELM_FLIP_ROTATE_X_CENTER_AXIS,
24362 ELM_FLIP_ROTATE_XZ_CENTER_AXIS,
24363 ELM_FLIP_ROTATE_YZ_CENTER_AXIS,
24364 ELM_FLIP_CUBE_LEFT,
24365 ELM_FLIP_CUBE_RIGHT,
24367 ELM_FLIP_CUBE_DOWN,
24368 ELM_FLIP_PAGE_LEFT,
24369 ELM_FLIP_PAGE_RIGHT,
24373 typedef enum _Elm_Flip_Interaction
24375 ELM_FLIP_INTERACTION_NONE,
24376 ELM_FLIP_INTERACTION_ROTATE,
24377 ELM_FLIP_INTERACTION_CUBE,
24378 ELM_FLIP_INTERACTION_PAGE
24379 } Elm_Flip_Interaction;
24380 typedef enum _Elm_Flip_Direction
24382 ELM_FLIP_DIRECTION_UP, /**< Allows interaction with the top of the widget */
24383 ELM_FLIP_DIRECTION_DOWN, /**< Allows interaction with the bottom of the widget */
24384 ELM_FLIP_DIRECTION_LEFT, /**< Allows interaction with the left portion of the widget */
24385 ELM_FLIP_DIRECTION_RIGHT /**< Allows interaction with the right portion of the widget */
24386 } Elm_Flip_Direction;
24388 * @brief Add a new flip to the parent
24390 * @param parent The parent object
24391 * @return The new object or NULL if it cannot be created
24393 EAPI Evas_Object *elm_flip_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24395 * @brief Set the front content of the flip widget.
24397 * @param obj The flip object
24398 * @param content The new front content object
24400 * Once the content object is set, a previously set one will be deleted.
24401 * If you want to keep that old content object, use the
24402 * elm_flip_content_front_unset() function.
24404 EAPI void elm_flip_content_front_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
24406 * @brief Set the back content of the flip widget.
24408 * @param obj The flip object
24409 * @param content The new back content object
24411 * Once the content object is set, a previously set one will be deleted.
24412 * If you want to keep that old content object, use the
24413 * elm_flip_content_back_unset() function.
24415 EAPI void elm_flip_content_back_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
24417 * @brief Get the front content used for the flip
24419 * @param obj The flip object
24420 * @return The front content object that is being used
24422 * Return the front content object which is set for this widget.
24424 EAPI Evas_Object *elm_flip_content_front_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24426 * @brief Get the back content used for the flip
24428 * @param obj The flip object
24429 * @return The back content object that is being used
24431 * Return the back content object which is set for this widget.
24433 EAPI Evas_Object *elm_flip_content_back_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24435 * @brief Unset the front content used for the flip
24437 * @param obj The flip object
24438 * @return The front content object that was being used
24440 * Unparent and return the front content object which was set for this widget.
24442 EAPI Evas_Object *elm_flip_content_front_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24444 * @brief Unset the back content used for the flip
24446 * @param obj The flip object
24447 * @return The back content object that was being used
24449 * Unparent and return the back content object which was set for this widget.
24451 EAPI Evas_Object *elm_flip_content_back_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24453 * @brief Get flip front visibility state
24455 * @param obj The flip objct
24456 * @return EINA_TRUE if front front is showing, EINA_FALSE if the back is
24459 EAPI Eina_Bool elm_flip_front_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24461 * @brief Set flip perspective
24463 * @param obj The flip object
24464 * @param foc The coordinate to set the focus on
24465 * @param x The X coordinate
24466 * @param y The Y coordinate
24468 * @warning This function currently does nothing.
24470 EAPI void elm_flip_perspective_set(Evas_Object *obj, Evas_Coord foc, Evas_Coord x, Evas_Coord y) EINA_ARG_NONNULL(1);
24472 * @brief Runs the flip animation
24474 * @param obj The flip object
24475 * @param mode The mode type
24477 * Flips the front and back contents using the @p mode animation. This
24478 * efectively hides the currently visible content and shows the hidden one.
24480 * There a number of possible animations to use for the flipping:
24481 * @li ELM_FLIP_ROTATE_X_CENTER_AXIS - Rotate the currently visible content
24482 * around a horizontal axis in the middle of its height, the other content
24483 * is shown as the other side of the flip.
24484 * @li ELM_FLIP_ROTATE_Y_CENTER_AXIS - Rotate the currently visible content
24485 * around a vertical axis in the middle of its width, the other content is
24486 * shown as the other side of the flip.
24487 * @li ELM_FLIP_ROTATE_XZ_CENTER_AXIS - Rotate the currently visible content
24488 * around a diagonal axis in the middle of its width, the other content is
24489 * shown as the other side of the flip.
24490 * @li ELM_FLIP_ROTATE_YZ_CENTER_AXIS - Rotate the currently visible content
24491 * around a diagonal axis in the middle of its height, the other content is
24492 * shown as the other side of the flip.
24493 * @li ELM_FLIP_CUBE_LEFT - Rotate the currently visible content to the left
24494 * as if the flip was a cube, the other content is show as the right face of
24496 * @li ELM_FLIP_CUBE_RIGHT - Rotate the currently visible content to the
24497 * right as if the flip was a cube, the other content is show as the left
24498 * face of the cube.
24499 * @li ELM_FLIP_CUBE_UP - Rotate the currently visible content up as if the
24500 * flip was a cube, the other content is show as the bottom face of the cube.
24501 * @li ELM_FLIP_CUBE_DOWN - Rotate the currently visible content down as if
24502 * the flip was a cube, the other content is show as the upper face of the
24504 * @li ELM_FLIP_PAGE_LEFT - Move the currently visible content to the left as
24505 * if the flip was a book, the other content is shown as the page below that.
24506 * @li ELM_FLIP_PAGE_RIGHT - Move the currently visible content to the right
24507 * as if the flip was a book, the other content is shown as the page below
24509 * @li ELM_FLIP_PAGE_UP - Move the currently visible content up as if the
24510 * flip was a book, the other content is shown as the page below that.
24511 * @li ELM_FLIP_PAGE_DOWN - Move the currently visible content down as if the
24512 * flip was a book, the other content is shown as the page below that.
24514 * @image html elm_flip.png
24515 * @image latex elm_flip.eps width=\textwidth
24517 EAPI void elm_flip_go(Evas_Object *obj, Elm_Flip_Mode mode) EINA_ARG_NONNULL(1);
24519 * @brief Set the interactive flip mode
24521 * @param obj The flip object
24522 * @param mode The interactive flip mode to use
24524 * This sets if the flip should be interactive (allow user to click and
24525 * drag a side of the flip to reveal the back page and cause it to flip).
24526 * By default a flip is not interactive. You may also need to set which
24527 * sides of the flip are "active" for flipping and how much space they use
24528 * (a minimum of a finger size) with elm_flip_interacton_direction_enabled_set()
24529 * and elm_flip_interacton_direction_hitsize_set()
24531 * The four avilable mode of interaction are:
24532 * @li ELM_FLIP_INTERACTION_NONE - No interaction is allowed
24533 * @li ELM_FLIP_INTERACTION_ROTATE - Interaction will cause rotate animation
24534 * @li ELM_FLIP_INTERACTION_CUBE - Interaction will cause cube animation
24535 * @li ELM_FLIP_INTERACTION_PAGE - Interaction will cause page animation
24537 * @note ELM_FLIP_INTERACTION_ROTATE won't cause
24538 * ELM_FLIP_ROTATE_XZ_CENTER_AXIS or ELM_FLIP_ROTATE_YZ_CENTER_AXIS to
24539 * happen, those can only be acheived with elm_flip_go();
24541 EAPI void elm_flip_interaction_set(Evas_Object *obj, Elm_Flip_Interaction mode);
24543 * @brief Get the interactive flip mode
24545 * @param obj The flip object
24546 * @return The interactive flip mode
24548 * Returns the interactive flip mode set by elm_flip_interaction_set()
24550 EAPI Elm_Flip_Interaction elm_flip_interaction_get(const Evas_Object *obj);
24552 * @brief Set which directions of the flip respond to interactive flip
24554 * @param obj The flip object
24555 * @param dir The direction to change
24556 * @param enabled If that direction is enabled or not
24558 * By default all directions are disabled, so you may want to enable the
24559 * desired directions for flipping if you need interactive flipping. You must
24560 * call this function once for each direction that should be enabled.
24562 * @see elm_flip_interaction_set()
24564 EAPI void elm_flip_interacton_direction_enabled_set(Evas_Object *obj, Elm_Flip_Direction dir, Eina_Bool enabled);
24566 * @brief Get the enabled state of that flip direction
24568 * @param obj The flip object
24569 * @param dir The direction to check
24570 * @return If that direction is enabled or not
24572 * Gets the enabled state set by elm_flip_interacton_direction_enabled_set()
24574 * @see elm_flip_interaction_set()
24576 EAPI Eina_Bool elm_flip_interacton_direction_enabled_get(Evas_Object *obj, Elm_Flip_Direction dir);
24578 * @brief Set the amount of the flip that is sensitive to interactive flip
24580 * @param obj The flip object
24581 * @param dir The direction to modify
24582 * @param hitsize The amount of that dimension (0.0 to 1.0) to use
24584 * Set the amount of the flip that is sensitive to interactive flip, with 0
24585 * representing no area in the flip and 1 representing the entire flip. There
24586 * is however a consideration to be made in that the area will never be
24587 * smaller than the finger size set(as set in your Elementary configuration).
24589 * @see elm_flip_interaction_set()
24591 EAPI void elm_flip_interacton_direction_hitsize_set(Evas_Object *obj, Elm_Flip_Direction dir, double hitsize);
24593 * @brief Get the amount of the flip that is sensitive to interactive flip
24595 * @param obj The flip object
24596 * @param dir The direction to check
24597 * @return The size set for that direction
24599 * Returns the amount os sensitive area set by
24600 * elm_flip_interacton_direction_hitsize_set().
24602 EAPI double elm_flip_interacton_direction_hitsize_get(Evas_Object *obj, Elm_Flip_Direction dir);
24607 /* scrolledentry */
24608 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24609 EINA_DEPRECATED EAPI void elm_scrolled_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line) EINA_ARG_NONNULL(1);
24610 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_single_line_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24611 EINA_DEPRECATED EAPI void elm_scrolled_entry_password_set(Evas_Object *obj, Eina_Bool password) EINA_ARG_NONNULL(1);
24612 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_password_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24613 EINA_DEPRECATED EAPI void elm_scrolled_entry_entry_set(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
24614 EINA_DEPRECATED EAPI const char *elm_scrolled_entry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24615 EINA_DEPRECATED EAPI void elm_scrolled_entry_entry_append(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
24616 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_is_empty(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24617 EINA_DEPRECATED EAPI const char *elm_scrolled_entry_selection_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24618 EINA_DEPRECATED EAPI void elm_scrolled_entry_entry_insert(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
24619 EINA_DEPRECATED EAPI void elm_scrolled_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
24620 EINA_DEPRECATED EAPI void elm_scrolled_entry_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
24621 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24622 EINA_DEPRECATED EAPI void elm_scrolled_entry_select_none(Evas_Object *obj) EINA_ARG_NONNULL(1);
24623 EINA_DEPRECATED EAPI void elm_scrolled_entry_select_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
24624 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
24625 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
24626 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_up(Evas_Object *obj) EINA_ARG_NONNULL(1);
24627 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_down(Evas_Object *obj) EINA_ARG_NONNULL(1);
24628 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
24629 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
24630 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_line_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
24631 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_line_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
24632 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_selection_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
24633 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_selection_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
24634 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_is_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24635 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_is_visible_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24636 EINA_DEPRECATED EAPI const char *elm_scrolled_entry_cursor_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24637 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_pos_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
24638 EINA_DEPRECATED EAPI int elm_scrolled_entry_cursor_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24639 EINA_DEPRECATED EAPI void elm_scrolled_entry_selection_cut(Evas_Object *obj) EINA_ARG_NONNULL(1);
24640 EINA_DEPRECATED EAPI void elm_scrolled_entry_selection_copy(Evas_Object *obj) EINA_ARG_NONNULL(1);
24641 EINA_DEPRECATED EAPI void elm_scrolled_entry_selection_paste(Evas_Object *obj) EINA_ARG_NONNULL(1);
24642 EINA_DEPRECATED EAPI void elm_scrolled_entry_context_menu_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
24643 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);
24644 EINA_DEPRECATED EAPI void elm_scrolled_entry_context_menu_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
24645 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_context_menu_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24646 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);
24647 EINA_DEPRECATED EAPI void elm_scrolled_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
24648 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);
24649 EINA_DEPRECATED EAPI void elm_scrolled_entry_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1, 2);
24650 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24651 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24652 EINA_DEPRECATED EAPI void elm_scrolled_entry_icon_visible_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
24653 EINA_DEPRECATED EAPI void elm_scrolled_entry_end_set(Evas_Object *obj, Evas_Object *end) EINA_ARG_NONNULL(1, 2);
24654 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_end_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24655 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_end_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24656 EINA_DEPRECATED EAPI void elm_scrolled_entry_end_visible_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
24657 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);
24658 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);
24659 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);
24660 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);
24661 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);
24662 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);
24663 EINA_DEPRECATED EAPI void elm_scrolled_entry_file_set(Evas_Object *obj, const char *file, Elm_Text_Format format) EINA_ARG_NONNULL(1);
24664 EINA_DEPRECATED EAPI void elm_scrolled_entry_file_get(const Evas_Object *obj, const char **file, Elm_Text_Format *format) EINA_ARG_NONNULL(1);
24665 EINA_DEPRECATED EAPI void elm_scrolled_entry_file_save(Evas_Object *obj) EINA_ARG_NONNULL(1);
24666 EINA_DEPRECATED EAPI void elm_scrolled_entry_autosave_set(Evas_Object *obj, Eina_Bool autosave) EINA_ARG_NONNULL(1);
24667 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_autosave_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24668 EINA_DEPRECATED EAPI void elm_scrolled_entry_cnp_textonly_set(Evas_Object *obj, Eina_Bool textonly) EINA_ARG_NONNULL(1);
24669 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cnp_textonly_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
24672 * @defgroup Conformant Conformant
24673 * @ingroup Elementary
24675 * @image html img/widget/conformant/preview-00.png
24676 * @image latex img/widget/conformant/preview-00.eps width=\textwidth
24678 * @image html img/conformant.png
24679 * @image latex img/conformant.eps width=\textwidth
24681 * The aim is to provide a widget that can be used in elementary apps to
24682 * account for space taken up by the indicator, virtual keypad & softkey
24683 * windows when running the illume2 module of E17.
24685 * So conformant content will be sized and positioned considering the
24686 * space required for such stuff, and when they popup, as a keyboard
24687 * shows when an entry is selected, conformant content won't change.
24689 * Available styles for it:
24692 * Default contents parts of the conformant widget that you can use for are:
24693 * @li "default" - A content of the conformant
24695 * See how to use this widget in this example:
24696 * @ref conformant_example
24700 * @addtogroup Conformant
24705 * Add a new conformant widget to the given parent Elementary
24706 * (container) object.
24708 * @param parent The parent object.
24709 * @return A new conformant widget handle or @c NULL, on errors.
24711 * This function inserts a new conformant widget on the canvas.
24713 * @ingroup Conformant
24715 EAPI Evas_Object *elm_conformant_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24718 * Set the content of the conformant widget.
24720 * @param obj The conformant object.
24721 * @param content The content to be displayed by the conformant.
24723 * Content will be sized and positioned considering the space required
24724 * to display a virtual keyboard. So it won't fill all the conformant
24725 * size. This way is possible to be sure that content won't resize
24726 * or be re-positioned after the keyboard is displayed.
24728 * Once the content object is set, a previously set one will be deleted.
24729 * If you want to keep that old content object, use the
24730 * elm_object_content_unset() function.
24732 * @see elm_object_content_unset()
24733 * @see elm_object_content_get()
24735 * @deprecated use elm_object_content_set() instead
24737 * @ingroup Conformant
24739 EINA_DEPRECATED EAPI void elm_conformant_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
24742 * Get the content of the conformant widget.
24744 * @param obj The conformant object.
24745 * @return The content that is being used.
24747 * Return the content object which is set for this widget.
24748 * It won't be unparent from conformant. For that, use
24749 * elm_object_content_unset().
24751 * @see elm_object_content_set().
24752 * @see elm_object_content_unset()
24754 * @deprecated use elm_object_content_get() instead
24756 * @ingroup Conformant
24758 EINA_DEPRECATED EAPI Evas_Object *elm_conformant_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24761 * Unset the content of the conformant widget.
24763 * @param obj The conformant object.
24764 * @return The content that was being used.
24766 * Unparent and return the content object which was set for this widget.
24768 * @see elm_object_content_set().
24770 * @deprecated use elm_object_content_unset() instead
24772 * @ingroup Conformant
24774 EINA_DEPRECATED EAPI Evas_Object *elm_conformant_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24777 * Returns the Evas_Object that represents the content area.
24779 * @param obj The conformant object.
24780 * @return The content area of the widget.
24782 * @ingroup Conformant
24784 EAPI Evas_Object *elm_conformant_content_area_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24791 * @defgroup Mapbuf Mapbuf
24792 * @ingroup Elementary
24794 * @image html img/widget/mapbuf/preview-00.png
24795 * @image latex img/widget/mapbuf/preview-00.eps width=\textwidth
24797 * This holds one content object and uses an Evas Map of transformation
24798 * points to be later used with this content. So the content will be
24799 * moved, resized, etc as a single image. So it will improve performance
24800 * when you have a complex interafce, with a lot of elements, and will
24801 * need to resize or move it frequently (the content object and its
24804 * Default contents parts of the mapbuf widget that you can use for are:
24805 * @li "default" - A content of the mapbuf
24807 * To enable map, elm_mapbuf_enabled_set() should be used.
24809 * See how to use this widget in this example:
24810 * @ref mapbuf_example
24814 * @addtogroup Mapbuf
24819 * Add a new mapbuf widget to the given parent Elementary
24820 * (container) object.
24822 * @param parent The parent object.
24823 * @return A new mapbuf widget handle or @c NULL, on errors.
24825 * This function inserts a new mapbuf widget on the canvas.
24829 EAPI Evas_Object *elm_mapbuf_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24832 * Set the content of the mapbuf.
24834 * @param obj The mapbuf object.
24835 * @param content The content that will be filled in this mapbuf object.
24837 * Once the content object is set, a previously set one will be deleted.
24838 * If you want to keep that old content object, use the
24839 * elm_mapbuf_content_unset() function.
24841 * To enable map, elm_mapbuf_enabled_set() should be used.
24843 * @deprecated use elm_object_content_set() instead
24847 EINA_DEPRECATED EAPI void elm_mapbuf_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
24850 * Get the content of the mapbuf.
24852 * @param obj The mapbuf object.
24853 * @return The content that is being used.
24855 * Return the content object which is set for this widget.
24857 * @see elm_mapbuf_content_set() for details.
24859 * @deprecated use elm_object_content_get() instead
24863 EINA_DEPRECATED EAPI Evas_Object *elm_mapbuf_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24866 * Unset the content of the mapbuf.
24868 * @param obj The mapbuf object.
24869 * @return The content that was being used.
24871 * Unparent and return the content object which was set for this widget.
24873 * @see elm_mapbuf_content_set() for details.
24875 * @deprecated use elm_object_content_unset() instead
24879 EINA_DEPRECATED EAPI Evas_Object *elm_mapbuf_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24882 * Enable or disable the map.
24884 * @param obj The mapbuf object.
24885 * @param enabled @c EINA_TRUE to enable map or @c EINA_FALSE to disable it.
24887 * This enables the map that is set or disables it. On enable, the object
24888 * geometry will be saved, and the new geometry will change (position and
24889 * size) to reflect the map geometry set.
24891 * Also, when enabled, alpha and smooth states will be used, so if the
24892 * content isn't solid, alpha should be enabled, for example, otherwise
24893 * a black retangle will fill the content.
24895 * When disabled, the stored map will be freed and geometry prior to
24896 * enabling the map will be restored.
24898 * It's disabled by default.
24900 * @see elm_mapbuf_alpha_set()
24901 * @see elm_mapbuf_smooth_set()
24905 EAPI void elm_mapbuf_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
24908 * Get a value whether map is enabled or not.
24910 * @param obj The mapbuf object.
24911 * @return @c EINA_TRUE means map is enabled. @c EINA_FALSE indicates
24912 * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
24914 * @see elm_mapbuf_enabled_set() for details.
24918 EAPI Eina_Bool elm_mapbuf_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24921 * Enable or disable smooth map rendering.
24923 * @param obj The mapbuf object.
24924 * @param smooth @c EINA_TRUE to enable smooth map rendering or @c EINA_FALSE
24927 * This sets smoothing for map rendering. If the object is a type that has
24928 * its own smoothing settings, then both the smooth settings for this object
24929 * and the map must be turned off.
24931 * By default smooth maps are enabled.
24935 EAPI void elm_mapbuf_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
24938 * Get a value whether smooth map rendering is enabled or not.
24940 * @param obj The mapbuf object.
24941 * @return @c EINA_TRUE means smooth map rendering is enabled. @c EINA_FALSE
24942 * indicates it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
24944 * @see elm_mapbuf_smooth_set() for details.
24948 EAPI Eina_Bool elm_mapbuf_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24951 * Set or unset alpha flag for map rendering.
24953 * @param obj The mapbuf object.
24954 * @param alpha @c EINA_TRUE to enable alpha blending or @c EINA_FALSE
24957 * This sets alpha flag for map rendering. If the object is a type that has
24958 * its own alpha settings, then this will take precedence. Only image objects
24959 * have this currently. It stops alpha blending of the map area, and is
24960 * useful if you know the object and/or all sub-objects is 100% solid.
24962 * Alpha is enabled by default.
24966 EAPI void elm_mapbuf_alpha_set(Evas_Object *obj, Eina_Bool alpha) EINA_ARG_NONNULL(1);
24969 * Get a value whether alpha blending is enabled or not.
24971 * @param obj The mapbuf object.
24972 * @return @c EINA_TRUE means alpha blending is enabled. @c EINA_FALSE
24973 * indicates it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
24975 * @see elm_mapbuf_alpha_set() for details.
24979 EAPI Eina_Bool elm_mapbuf_alpha_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24986 * @defgroup Flipselector Flip Selector
24988 * @image html img/widget/flipselector/preview-00.png
24989 * @image latex img/widget/flipselector/preview-00.eps
24991 * A flip selector is a widget to show a set of @b text items, one
24992 * at a time, with the same sheet switching style as the @ref Clock
24993 * "clock" widget, when one changes the current displaying sheet
24994 * (thus, the "flip" in the name).
24996 * User clicks to flip sheets which are @b held for some time will
24997 * make the flip selector to flip continuosly and automatically for
24998 * the user. The interval between flips will keep growing in time,
24999 * so that it helps the user to reach an item which is distant from
25000 * the current selection.
25002 * Smart callbacks one can register to:
25003 * - @c "selected" - when the widget's selected text item is changed
25004 * - @c "overflowed" - when the widget's current selection is changed
25005 * from the first item in its list to the last
25006 * - @c "underflowed" - when the widget's current selection is changed
25007 * from the last item in its list to the first
25009 * Available styles for it:
25012 * To set/get the label of the flipselector item, you can use
25013 * elm_object_item_text_set/get APIs.
25014 * Once the text is set, a previously set one will be deleted.
25016 * Here is an example on its usage:
25017 * @li @ref flipselector_example
25021 * @addtogroup Flipselector
25026 * Add a new flip selector widget to the given parent Elementary
25027 * (container) widget
25029 * @param parent The parent object
25030 * @return a new flip selector widget handle or @c NULL, on errors
25032 * This function inserts a new flip selector widget on the canvas.
25034 * @ingroup Flipselector
25036 EAPI Evas_Object *elm_flipselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
25039 * Programmatically select the next item of a flip selector widget
25041 * @param obj The flipselector object
25043 * @note The selection will be animated. Also, if it reaches the
25044 * end of its list of member items, it will continue with the first
25047 * @ingroup Flipselector
25049 EAPI void elm_flipselector_flip_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
25052 * Programmatically select the previous item of a flip selector
25055 * @param obj The flipselector object
25057 * @note The selection will be animated. Also, if it reaches the
25058 * beginning of its list of member items, it will continue with the
25059 * last one backwards.
25061 * @ingroup Flipselector
25063 EAPI void elm_flipselector_flip_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
25066 * Append a (text) item to a flip selector widget
25068 * @param obj The flipselector object
25069 * @param label The (text) label of the new item
25070 * @param func Convenience callback function to take place when
25072 * @param data Data passed to @p func, above
25073 * @return A handle to the item added or @c NULL, on errors
25075 * The widget's list of labels to show will be appended with the
25076 * given value. If the user wishes so, a callback function pointer
25077 * can be passed, which will get called when this same item is
25080 * @note The current selection @b won't be modified by appending an
25081 * element to the list.
25083 * @note The maximum length of the text label is going to be
25084 * determined <b>by the widget's theme</b>. Strings larger than
25085 * that value are going to be @b truncated.
25087 * @ingroup Flipselector
25089 EAPI Elm_Object_Item *elm_flipselector_item_append(Evas_Object *obj, const char *label, Evas_Smart_Cb func, void *data) EINA_ARG_NONNULL(1);
25092 * Prepend a (text) item to a flip selector widget
25094 * @param obj The flipselector object
25095 * @param label The (text) label of the new item
25096 * @param func Convenience callback function to take place when
25098 * @param data Data passed to @p func, above
25099 * @return A handle to the item added or @c NULL, on errors
25101 * The widget's list of labels to show will be prepended with the
25102 * given value. If the user wishes so, a callback function pointer
25103 * can be passed, which will get called when this same item is
25106 * @note The current selection @b won't be modified by prepending
25107 * an element to the list.
25109 * @note The maximum length of the text label is going to be
25110 * determined <b>by the widget's theme</b>. Strings larger than
25111 * that value are going to be @b truncated.
25113 * @ingroup Flipselector
25115 EAPI Elm_Object_Item *elm_flipselector_item_prepend(Evas_Object *obj, const char *label, Evas_Smart_Cb func, void *data) EINA_ARG_NONNULL(1);
25118 * Get the internal list of items in a given flip selector widget.
25120 * @param obj The flipselector object
25121 * @return The list of items (#Elm_Object_Item as data) or
25122 * @c NULL on errors.
25124 * This list is @b not to be modified in any way and must not be
25125 * freed. Use the list members with functions like
25126 * elm_object_item_text_set(),
25127 * elm_object_item_text_get(),
25128 * elm_flipselector_item_del(),
25129 * elm_flipselector_item_selected_get(),
25130 * elm_flipselector_item_selected_set().
25132 * @warning This list is only valid until @p obj object's internal
25133 * items list is changed. It should be fetched again with another
25134 * call to this function when changes happen.
25136 * @ingroup Flipselector
25138 EAPI const Eina_List *elm_flipselector_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25141 * Get the first item in the given flip selector widget's list of
25144 * @param obj The flipselector object
25145 * @return The first item or @c NULL, if it has no items (and on
25148 * @see elm_flipselector_item_append()
25149 * @see elm_flipselector_last_item_get()
25151 * @ingroup Flipselector
25153 EAPI Elm_Object_Item *elm_flipselector_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25156 * Get the last item in the given flip selector widget's list of
25159 * @param obj The flipselector object
25160 * @return The last item or @c NULL, if it has no items (and on
25163 * @see elm_flipselector_item_prepend()
25164 * @see elm_flipselector_first_item_get()
25166 * @ingroup Flipselector
25168 EAPI Elm_Object_Item *elm_flipselector_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25171 * Get the currently selected item in a flip selector widget.
25173 * @param obj The flipselector object
25174 * @return The selected item or @c NULL, if the widget has no items
25177 * @ingroup Flipselector
25179 EAPI Elm_Object_Item *elm_flipselector_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25182 * Set whether a given flip selector widget's item should be the
25183 * currently selected one.
25185 * @param it The flip selector item
25186 * @param selected @c EINA_TRUE to select it, @c EINA_FALSE to unselect.
25188 * This sets whether @p item is or not the selected (thus, under
25189 * display) one. If @p item is different than one under display,
25190 * the latter will be unselected. If the @p item is set to be
25191 * unselected, on the other hand, the @b first item in the widget's
25192 * internal members list will be the new selected one.
25194 * @see elm_flipselector_item_selected_get()
25196 * @ingroup Flipselector
25198 EAPI void elm_flipselector_item_selected_set(Elm_Object_Item *it, Eina_Bool selected) EINA_ARG_NONNULL(1);
25201 * Get whether a given flip selector widget's item is the currently
25204 * @param it The flip selector item
25205 * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
25208 * @see elm_flipselector_item_selected_set()
25210 * @ingroup Flipselector
25212 EAPI Eina_Bool elm_flipselector_item_selected_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
25215 * Delete a given item from a flip selector widget.
25217 * @param it The item to delete
25219 * @ingroup Flipselector
25221 EAPI void elm_flipselector_item_del(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
25224 * Get the label of a given flip selector widget's item.
25226 * @param it The item to get label from
25227 * @return The text label of @p item or @c NULL, on errors
25229 * @see elm_object_item_text_set()
25231 * @deprecated see elm_object_item_text_get() instead
25232 * @ingroup Flipselector
25234 EINA_DEPRECATED EAPI const char *elm_flipselector_item_label_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
25237 * Set the label of a given flip selector widget's item.
25239 * @param it The item to set label on
25240 * @param label The text label string, in UTF-8 encoding
25242 * @see elm_object_item_text_get()
25244 * @deprecated see elm_object_item_text_set() instead
25245 * @ingroup Flipselector
25247 EINA_DEPRECATED EAPI void elm_flipselector_item_label_set(Elm_Object_Item *it, const char *label) EINA_ARG_NONNULL(1);
25250 * Gets the item before @p item in a flip selector widget's
25251 * internal list of items.
25253 * @param it The item to fetch previous from
25254 * @return The item before the @p item, in its parent's list. If
25255 * there is no previous item for @p item or there's an
25256 * error, @c NULL is returned.
25258 * @see elm_flipselector_item_next_get()
25260 * @ingroup Flipselector
25262 EAPI Elm_Object_Item *elm_flipselector_item_prev_get(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
25265 * Gets the item after @p item in a flip selector widget's
25266 * internal list of items.
25268 * @param it The item to fetch next from
25269 * @return The item after the @p item, in its parent's list. If
25270 * there is no next item for @p item or there's an
25271 * error, @c NULL is returned.
25273 * @see elm_flipselector_item_next_get()
25275 * @ingroup Flipselector
25277 EAPI Elm_Object_Item *elm_flipselector_item_next_get(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
25280 * Set the interval on time updates for an user mouse button hold
25281 * on a flip selector widget.
25283 * @param obj The flip selector object
25284 * @param interval The (first) interval value in seconds
25286 * This interval value is @b decreased while the user holds the
25287 * mouse pointer either flipping up or flipping doww a given flip
25290 * This helps the user to get to a given item distant from the
25291 * current one easier/faster, as it will start to flip quicker and
25292 * quicker on mouse button holds.
25294 * The calculation for the next flip interval value, starting from
25295 * the one set with this call, is the previous interval divided by
25296 * 1.05, so it decreases a little bit.
25298 * The default starting interval value for automatic flips is
25301 * @see elm_flipselector_interval_get()
25303 * @ingroup Flipselector
25305 EAPI void elm_flipselector_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
25308 * Get the interval on time updates for an user mouse button hold
25309 * on a flip selector widget.
25311 * @param obj The flip selector object
25312 * @return The (first) interval value, in seconds, set on it
25314 * @see elm_flipselector_interval_set() for more details
25316 * @ingroup Flipselector
25318 EAPI double elm_flipselector_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25324 * @addtogroup Calendar
25329 * @enum _Elm_Calendar_Mark_Repeat
25330 * @typedef Elm_Calendar_Mark_Repeat
25332 * Event periodicity, used to define if a mark should be repeated
25333 * @b beyond event's day. It's set when a mark is added.
25335 * So, for a mark added to 13th May with periodicity set to WEEKLY,
25336 * there will be marks every week after this date. Marks will be displayed
25337 * at 13th, 20th, 27th, 3rd June ...
25339 * Values don't work as bitmask, only one can be choosen.
25341 * @see elm_calendar_mark_add()
25343 * @ingroup Calendar
25345 typedef enum _Elm_Calendar_Mark_Repeat
25347 ELM_CALENDAR_UNIQUE, /**< Default value. Marks will be displayed only on event day. */
25348 ELM_CALENDAR_DAILY, /**< Marks will be displayed everyday after event day (inclusive). */
25349 ELM_CALENDAR_WEEKLY, /**< Marks will be displayed every week after event day (inclusive) - i.e. each seven days. */
25350 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*/
25351 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. */
25352 } Elm_Calendar_Mark_Repeat;
25354 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(). */
25357 * Add a new calendar widget to the given parent Elementary
25358 * (container) object.
25360 * @param parent The parent object.
25361 * @return a new calendar widget handle or @c NULL, on errors.
25363 * This function inserts a new calendar widget on the canvas.
25365 * @ref calendar_example_01
25367 * @ingroup Calendar
25369 EAPI Evas_Object *elm_calendar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
25372 * Get weekdays names displayed by the calendar.
25374 * @param obj The calendar object.
25375 * @return Array of seven strings to be used as weekday names.
25377 * By default, weekdays abbreviations get from system are displayed:
25378 * E.g. for an en_US locale: "Sun, Mon, Tue, Wed, Thu, Fri, Sat"
25379 * The first string is related to Sunday, the second to Monday...
25381 * @see elm_calendar_weekdays_name_set()
25383 * @ref calendar_example_05
25385 * @ingroup Calendar
25387 EAPI const char **elm_calendar_weekdays_names_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25390 * Set weekdays names to be displayed by the calendar.
25392 * @param obj The calendar object.
25393 * @param weekdays Array of seven strings to be used as weekday names.
25394 * @warning It must have 7 elements, or it will access invalid memory.
25395 * @warning The strings must be NULL terminated ('@\0').
25397 * By default, weekdays abbreviations get from system are displayed:
25398 * E.g. for an en_US locale: "Sun, Mon, Tue, Wed, Thu, Fri, Sat"
25400 * The first string should be related to Sunday, the second to Monday...
25402 * The usage should be like this:
25404 * const char *weekdays[] =
25406 * "Sunday", "Monday", "Tuesday", "Wednesday",
25407 * "Thursday", "Friday", "Saturday"
25409 * elm_calendar_weekdays_names_set(calendar, weekdays);
25412 * @see elm_calendar_weekdays_name_get()
25414 * @ref calendar_example_02
25416 * @ingroup Calendar
25418 EAPI void elm_calendar_weekdays_names_set(Evas_Object *obj, const char *weekdays[]) EINA_ARG_NONNULL(1, 2);
25421 * Set the minimum and maximum values for the year
25423 * @param obj The calendar object
25424 * @param min The minimum year, greater than 1901;
25425 * @param max The maximum year;
25427 * Maximum must be greater than minimum, except if you don't wan't to set
25429 * Default values are 1902 and -1.
25431 * If the maximum year is a negative value, it will be limited depending
25432 * on the platform architecture (year 2037 for 32 bits);
25434 * @see elm_calendar_min_max_year_get()
25436 * @ref calendar_example_03
25438 * @ingroup Calendar
25440 EAPI void elm_calendar_min_max_year_set(Evas_Object *obj, int min, int max) EINA_ARG_NONNULL(1);
25443 * Get the minimum and maximum values for the year
25445 * @param obj The calendar object.
25446 * @param min The minimum year.
25447 * @param max The maximum year.
25449 * Default values are 1902 and -1.
25451 * @see elm_calendar_min_max_year_get() for more details.
25453 * @ref calendar_example_05
25455 * @ingroup Calendar
25457 EAPI void elm_calendar_min_max_year_get(const Evas_Object *obj, int *min, int *max) EINA_ARG_NONNULL(1);
25460 * Enable or disable day selection
25462 * @param obj The calendar object.
25463 * @param enabled @c EINA_TRUE to enable selection or @c EINA_FALSE to
25466 * Enabled by default. If disabled, the user still can select months,
25467 * but not days. Selected days are highlighted on calendar.
25468 * It should be used if you won't need such selection for the widget usage.
25470 * When a day is selected, or month is changed, smart callbacks for
25471 * signal "changed" will be called.
25473 * @see elm_calendar_day_selection_enable_get()
25475 * @ref calendar_example_04
25477 * @ingroup Calendar
25479 EAPI void elm_calendar_day_selection_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
25482 * Get a value whether day selection is enabled or not.
25484 * @see elm_calendar_day_selection_enable_set() for details.
25486 * @param obj The calendar object.
25487 * @return EINA_TRUE means day selection is enabled. EINA_FALSE indicates
25488 * it's disabled. If @p obj is NULL, EINA_FALSE is returned.
25490 * @ref calendar_example_05
25492 * @ingroup Calendar
25494 EAPI Eina_Bool elm_calendar_day_selection_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25498 * Set selected date to be highlighted on calendar.
25500 * @param obj The calendar object.
25501 * @param selected_time A @b tm struct to represent the selected date.
25503 * Set the selected date, changing the displayed month if needed.
25504 * Selected date changes when the user goes to next/previous month or
25505 * select a day pressing over it on calendar.
25507 * @see elm_calendar_selected_time_get()
25509 * @ref calendar_example_04
25511 * @ingroup Calendar
25513 EAPI void elm_calendar_selected_time_set(Evas_Object *obj, struct tm *selected_time) EINA_ARG_NONNULL(1);
25516 * Get selected date.
25518 * @param obj The calendar object
25519 * @param selected_time A @b tm struct to point to selected date
25520 * @return EINA_FALSE means an error ocurred and returned time shouldn't
25523 * Get date selected by the user or set by function
25524 * elm_calendar_selected_time_set().
25525 * Selected date changes when the user goes to next/previous month or
25526 * select a day pressing over it on calendar.
25528 * @see elm_calendar_selected_time_get()
25530 * @ref calendar_example_05
25532 * @ingroup Calendar
25534 EAPI Eina_Bool elm_calendar_selected_time_get(const Evas_Object *obj, struct tm *selected_time) EINA_ARG_NONNULL(1, 2);
25537 * Set a function to format the string that will be used to display
25540 * @param obj The calendar object
25541 * @param format_function Function to set the month-year string given
25542 * the selected date
25544 * By default it uses strftime with "%B %Y" format string.
25545 * It should allocate the memory that will be used by the string,
25546 * that will be freed by the widget after usage.
25547 * A pointer to the string and a pointer to the time struct will be provided.
25552 * _format_month_year(struct tm *selected_time)
25555 * if (!strftime(buf, sizeof(buf), "%B %Y", selected_time)) return NULL;
25556 * return strdup(buf);
25559 * elm_calendar_format_function_set(calendar, _format_month_year);
25562 * @ref calendar_example_02
25564 * @ingroup Calendar
25566 EAPI void elm_calendar_format_function_set(Evas_Object *obj, char * (*format_function) (struct tm *stime)) EINA_ARG_NONNULL(1);
25569 * Add a new mark to the calendar
25571 * @param obj The calendar object
25572 * @param mark_type A string used to define the type of mark. It will be
25573 * emitted to the theme, that should display a related modification on these
25574 * days representation.
25575 * @param mark_time A time struct to represent the date of inclusion of the
25576 * mark. For marks that repeats it will just be displayed after the inclusion
25577 * date in the calendar.
25578 * @param repeat Repeat the event following this periodicity. Can be a unique
25579 * mark (that don't repeat), daily, weekly, monthly or annually.
25580 * @return The created mark or @p NULL upon failure.
25582 * Add a mark that will be drawn in the calendar respecting the insertion
25583 * time and periodicity. It will emit the type as signal to the widget theme.
25584 * Default theme supports "holiday" and "checked", but it can be extended.
25586 * It won't immediately update the calendar, drawing the marks.
25587 * For this, call elm_calendar_marks_draw(). However, when user selects
25588 * next or previous month calendar forces marks drawn.
25590 * Marks created with this method can be deleted with
25591 * elm_calendar_mark_del().
25595 * struct tm selected_time;
25596 * time_t current_time;
25598 * current_time = time(NULL) + 5 * 84600;
25599 * localtime_r(¤t_time, &selected_time);
25600 * elm_calendar_mark_add(cal, "holiday", selected_time,
25601 * ELM_CALENDAR_ANNUALLY);
25603 * current_time = time(NULL) + 1 * 84600;
25604 * localtime_r(¤t_time, &selected_time);
25605 * elm_calendar_mark_add(cal, "checked", selected_time, ELM_CALENDAR_UNIQUE);
25607 * elm_calendar_marks_draw(cal);
25610 * @see elm_calendar_marks_draw()
25611 * @see elm_calendar_mark_del()
25613 * @ref calendar_example_06
25615 * @ingroup Calendar
25617 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);
25620 * Delete mark from the calendar.
25622 * @param mark The mark to be deleted.
25624 * If deleting all calendar marks is required, elm_calendar_marks_clear()
25625 * should be used instead of getting marks list and deleting each one.
25627 * @see elm_calendar_mark_add()
25629 * @ref calendar_example_06
25631 * @ingroup Calendar
25633 EAPI void elm_calendar_mark_del(Elm_Calendar_Mark *mark) EINA_ARG_NONNULL(1);
25636 * Remove all calendar's marks
25638 * @param obj The calendar object.
25640 * @see elm_calendar_mark_add()
25641 * @see elm_calendar_mark_del()
25643 * @ingroup Calendar
25645 EAPI void elm_calendar_marks_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
25649 * Get a list of all the calendar marks.
25651 * @param obj The calendar object.
25652 * @return An @c Eina_List of calendar marks objects, or @c NULL on failure.
25654 * @see elm_calendar_mark_add()
25655 * @see elm_calendar_mark_del()
25656 * @see elm_calendar_marks_clear()
25658 * @ingroup Calendar
25660 EAPI const Eina_List *elm_calendar_marks_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25663 * Draw calendar marks.
25665 * @param obj The calendar object.
25667 * Should be used after adding, removing or clearing marks.
25668 * It will go through the entire marks list updating the calendar.
25669 * If lots of marks will be added, add all the marks and then call
25672 * When the month is changed, i.e. user selects next or previous month,
25673 * marks will be drawed.
25675 * @see elm_calendar_mark_add()
25676 * @see elm_calendar_mark_del()
25677 * @see elm_calendar_marks_clear()
25679 * @ref calendar_example_06
25681 * @ingroup Calendar
25683 EAPI void elm_calendar_marks_draw(Evas_Object *obj) EINA_ARG_NONNULL(1);
25686 * Set a day text color to the same that represents Saturdays.
25688 * @param obj The calendar object.
25689 * @param pos The text position. Position is the cell counter, from left
25690 * to right, up to down. It starts on 0 and ends on 41.
25692 * @deprecated use elm_calendar_mark_add() instead like:
25695 * struct tm t = { 0, 0, 12, 6, 0, 0, 6, 6, -1 };
25696 * elm_calendar_mark_add(obj, "sat", &t, ELM_CALENDAR_WEEKLY);
25699 * @see elm_calendar_mark_add()
25701 * @ingroup Calendar
25703 EINA_DEPRECATED EAPI void elm_calendar_text_saturday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
25706 * Set a day text color to the same that represents Sundays.
25708 * @param obj The calendar object.
25709 * @param pos The text position. Position is the cell counter, from left
25710 * to right, up to down. It starts on 0 and ends on 41.
25712 * @deprecated use elm_calendar_mark_add() instead like:
25715 * struct tm t = { 0, 0, 12, 7, 0, 0, 0, 0, -1 };
25716 * elm_calendar_mark_add(obj, "sat", &t, ELM_CALENDAR_WEEKLY);
25719 * @see elm_calendar_mark_add()
25721 * @ingroup Calendar
25723 EINA_DEPRECATED EAPI void elm_calendar_text_sunday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
25726 * Set a day text color to the same that represents Weekdays.
25728 * @param obj The calendar object
25729 * @param pos The text position. Position is the cell counter, from left
25730 * to right, up to down. It starts on 0 and ends on 41.
25732 * @deprecated use elm_calendar_mark_add() instead like:
25735 * struct tm t = { 0, 0, 12, 1, 0, 0, 0, 0, -1 };
25737 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // monday
25738 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
25739 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // tuesday
25740 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
25741 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // wednesday
25742 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
25743 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // thursday
25744 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
25745 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // friday
25748 * @see elm_calendar_mark_add()
25750 * @ingroup Calendar
25752 EINA_DEPRECATED EAPI void elm_calendar_text_weekday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
25755 * Set the interval on time updates for an user mouse button hold
25756 * on calendar widgets' month selection.
25758 * @param obj The calendar object
25759 * @param interval The (first) interval value in seconds
25761 * This interval value is @b decreased while the user holds the
25762 * mouse pointer either selecting next or previous month.
25764 * This helps the user to get to a given month distant from the
25765 * current one easier/faster, as it will start to change quicker and
25766 * quicker on mouse button holds.
25768 * The calculation for the next change interval value, starting from
25769 * the one set with this call, is the previous interval divided by
25770 * 1.05, so it decreases a little bit.
25772 * The default starting interval value for automatic changes is
25775 * @see elm_calendar_interval_get()
25777 * @ingroup Calendar
25779 EAPI void elm_calendar_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
25782 * Get the interval on time updates for an user mouse button hold
25783 * on calendar widgets' month selection.
25785 * @param obj The calendar object
25786 * @return The (first) interval value, in seconds, set on it
25788 * @see elm_calendar_interval_set() for more details
25790 * @ingroup Calendar
25792 EAPI double elm_calendar_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25799 * @defgroup Diskselector Diskselector
25800 * @ingroup Elementary
25802 * @image html img/widget/diskselector/preview-00.png
25803 * @image latex img/widget/diskselector/preview-00.eps
25805 * A diskselector is a kind of list widget. It scrolls horizontally,
25806 * and can contain label and icon objects. Three items are displayed
25807 * with the selected one in the middle.
25809 * It can act like a circular list with round mode and labels can be
25810 * reduced for a defined length for side items.
25812 * Smart callbacks one can listen to:
25813 * - "selected" - when item is selected, i.e. scroller stops.
25815 * Available styles for it:
25818 * List of examples:
25819 * @li @ref diskselector_example_01
25820 * @li @ref diskselector_example_02
25824 * @addtogroup Diskselector
25828 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(). */
25831 * Add a new diskselector widget to the given parent Elementary
25832 * (container) object.
25834 * @param parent The parent object.
25835 * @return a new diskselector widget handle or @c NULL, on errors.
25837 * This function inserts a new diskselector widget on the canvas.
25839 * @ingroup Diskselector
25841 EAPI Evas_Object *elm_diskselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
25844 * Enable or disable round mode.
25846 * @param obj The diskselector object.
25847 * @param round @c EINA_TRUE to enable round mode or @c EINA_FALSE to
25850 * Disabled by default. If round mode is enabled the items list will
25851 * work like a circle list, so when the user reaches the last item,
25852 * the first one will popup.
25854 * @see elm_diskselector_round_get()
25856 * @ingroup Diskselector
25858 EAPI void elm_diskselector_round_set(Evas_Object *obj, Eina_Bool round) EINA_ARG_NONNULL(1);
25861 * Get a value whether round mode is enabled or not.
25863 * @see elm_diskselector_round_set() for details.
25865 * @param obj The diskselector object.
25866 * @return @c EINA_TRUE means round mode is enabled. @c EINA_FALSE indicates
25867 * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
25869 * @ingroup Diskselector
25871 EAPI Eina_Bool elm_diskselector_round_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25874 * Get the side labels max length.
25876 * @deprecated use elm_diskselector_side_label_length_get() instead:
25878 * @param obj The diskselector object.
25879 * @return The max length defined for side labels, or 0 if not a valid
25882 * @ingroup Diskselector
25884 EINA_DEPRECATED EAPI int elm_diskselector_side_label_lenght_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25887 * Set the side labels max length.
25889 * @deprecated use elm_diskselector_side_label_length_set() instead:
25891 * @param obj The diskselector object.
25892 * @param len The max length defined for side labels.
25894 * @ingroup Diskselector
25896 EINA_DEPRECATED EAPI void elm_diskselector_side_label_lenght_set(Evas_Object *obj, int len) EINA_ARG_NONNULL(1);
25899 * Get the side labels max length.
25901 * @see elm_diskselector_side_label_length_set() for details.
25903 * @param obj The diskselector object.
25904 * @return The max length defined for side labels, or 0 if not a valid
25907 * @ingroup Diskselector
25909 EAPI int elm_diskselector_side_label_length_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25912 * Set the side labels max length.
25914 * @param obj The diskselector object.
25915 * @param len The max length defined for side labels.
25917 * Length is the number of characters of items' label that will be
25918 * visible when it's set on side positions. It will just crop
25919 * the string after defined size. E.g.:
25921 * An item with label "January" would be displayed on side position as
25922 * "Jan" if max length is set to 3, or "Janu", if this property
25925 * When it's selected, the entire label will be displayed, except for
25926 * width restrictions. In this case label will be cropped and "..."
25927 * will be concatenated.
25929 * Default side label max length is 3.
25931 * This property will be applyed over all items, included before or
25932 * later this function call.
25934 * @ingroup Diskselector
25936 EAPI void elm_diskselector_side_label_length_set(Evas_Object *obj, int len) EINA_ARG_NONNULL(1);
25939 * Set the number of items to be displayed.
25941 * @param obj The diskselector object.
25942 * @param num The number of items the diskselector will display.
25944 * Default value is 3, and also it's the minimun. If @p num is less
25945 * than 3, it will be set to 3.
25947 * Also, it can be set on theme, using data item @c display_item_num
25948 * on group "elm/diskselector/item/X", where X is style set.
25951 * group { name: "elm/diskselector/item/X";
25953 * item: "display_item_num" "5";
25956 * @ingroup Diskselector
25958 EAPI void elm_diskselector_display_item_num_set(Evas_Object *obj, int num) EINA_ARG_NONNULL(1);
25961 * Get the number of items in the diskselector object.
25963 * @param obj The diskselector object.
25965 * @ingroup Diskselector
25967 EAPI int elm_diskselector_display_item_num_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25970 * Set bouncing behaviour when the scrolled content reaches an edge.
25972 * Tell the internal scroller object whether it should bounce or not
25973 * when it reaches the respective edges for each axis.
25975 * @param obj The diskselector object.
25976 * @param h_bounce Whether to bounce or not in the horizontal axis.
25977 * @param v_bounce Whether to bounce or not in the vertical axis.
25979 * @see elm_scroller_bounce_set()
25981 * @ingroup Diskselector
25983 EAPI void elm_diskselector_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
25986 * Get the bouncing behaviour of the internal scroller.
25988 * Get whether the internal scroller should bounce when the edge of each
25989 * axis is reached scrolling.
25991 * @param obj The diskselector object.
25992 * @param h_bounce Pointer where to store the bounce state of the horizontal
25994 * @param v_bounce Pointer where to store the bounce state of the vertical
25997 * @see elm_scroller_bounce_get()
25998 * @see elm_diskselector_bounce_set()
26000 * @ingroup Diskselector
26002 EAPI void elm_diskselector_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
26005 * Get the scrollbar policy.
26007 * @see elm_diskselector_scroller_policy_get() for details.
26009 * @param obj The diskselector object.
26010 * @param policy_h Pointer where to store horizontal scrollbar policy.
26011 * @param policy_v Pointer where to store vertical scrollbar policy.
26013 * @ingroup Diskselector
26015 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);
26018 * Set the scrollbar policy.
26020 * @param obj The diskselector object.
26021 * @param policy_h Horizontal scrollbar policy.
26022 * @param policy_v Vertical scrollbar policy.
26024 * This sets the scrollbar visibility policy for the given scroller.
26025 * #ELM_SCROLLER_POLICY_AUTO means the scrollbar is made visible if it
26026 * is needed, and otherwise kept hidden. #ELM_SCROLLER_POLICY_ON turns
26027 * it on all the time, and #ELM_SCROLLER_POLICY_OFF always keeps it off.
26028 * This applies respectively for the horizontal and vertical scrollbars.
26030 * The both are disabled by default, i.e., are set to
26031 * #ELM_SCROLLER_POLICY_OFF.
26033 * @ingroup Diskselector
26035 EAPI void elm_diskselector_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
26038 * Remove all diskselector's items.
26040 * @param obj The diskselector object.
26042 * @see elm_diskselector_item_del()
26043 * @see elm_diskselector_item_append()
26045 * @ingroup Diskselector
26047 EAPI void elm_diskselector_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
26050 * Get a list of all the diskselector items.
26052 * @param obj The diskselector object.
26053 * @return An @c Eina_List of diskselector items, #Elm_Diskselector_Item,
26054 * or @c NULL on failure.
26056 * @see elm_diskselector_item_append()
26057 * @see elm_diskselector_item_del()
26058 * @see elm_diskselector_clear()
26060 * @ingroup Diskselector
26062 EAPI const Eina_List *elm_diskselector_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26065 * Appends a new item to the diskselector object.
26067 * @param obj The diskselector object.
26068 * @param label The label of the diskselector item.
26069 * @param icon The icon object to use at left side of the item. An
26070 * icon can be any Evas object, but usually it is an icon created
26071 * with elm_icon_add().
26072 * @param func The function to call when the item is selected.
26073 * @param data The data to associate with the item for related callbacks.
26075 * @return The created item or @c NULL upon failure.
26077 * A new item will be created and appended to the diskselector, i.e., will
26078 * be set as last item. Also, if there is no selected item, it will
26079 * be selected. This will always happens for the first appended item.
26081 * If no icon is set, label will be centered on item position, otherwise
26082 * the icon will be placed at left of the label, that will be shifted
26085 * Items created with this method can be deleted with
26086 * elm_diskselector_item_del().
26088 * Associated @p data can be properly freed when item is deleted if a
26089 * callback function is set with elm_diskselector_item_del_cb_set().
26091 * If a function is passed as argument, it will be called everytime this item
26092 * is selected, i.e., the user stops the diskselector with this
26093 * item on center position. If such function isn't needed, just passing
26094 * @c NULL as @p func is enough. The same should be done for @p data.
26096 * Simple example (with no function callback or data associated):
26098 * disk = elm_diskselector_add(win);
26099 * ic = elm_icon_add(win);
26100 * elm_icon_file_set(ic, "path/to/image", NULL);
26101 * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
26102 * elm_diskselector_item_append(disk, "label", ic, NULL, NULL);
26105 * @see elm_diskselector_item_del()
26106 * @see elm_diskselector_item_del_cb_set()
26107 * @see elm_diskselector_clear()
26108 * @see elm_icon_add()
26110 * @ingroup Diskselector
26112 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);
26116 * Delete them item from the diskselector.
26118 * @param it The item of diskselector to be deleted.
26120 * If deleting all diskselector items is required, elm_diskselector_clear()
26121 * should be used instead of getting items list and deleting each one.
26123 * @see elm_diskselector_clear()
26124 * @see elm_diskselector_item_append()
26125 * @see elm_diskselector_item_del_cb_set()
26127 * @ingroup Diskselector
26129 EAPI void elm_diskselector_item_del(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26132 * Set the function called when a diskselector item is freed.
26134 * @param it The item to set the callback on
26135 * @param func The function called
26137 * If there is a @p func, then it will be called prior item's memory release.
26138 * That will be called with the following arguments:
26140 * @li item's Evas object;
26143 * This way, a data associated to a diskselector item could be properly
26146 * @ingroup Diskselector
26148 EAPI void elm_diskselector_item_del_cb_set(Elm_Diskselector_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
26151 * Get the data associated to the item.
26153 * @param it The diskselector item
26154 * @return The data associated to @p it
26156 * The return value is a pointer to data associated to @p item when it was
26157 * created, with function elm_diskselector_item_append(). If no data
26158 * was passed as argument, it will return @c NULL.
26160 * @see elm_diskselector_item_append()
26162 * @ingroup Diskselector
26164 EAPI void *elm_diskselector_item_data_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26167 * Set the icon associated to the item.
26169 * @param it The diskselector item
26170 * @param icon The icon object to associate with @p it
26172 * The icon object to use at left side of the item. An
26173 * icon can be any Evas object, but usually it is an icon created
26174 * with elm_icon_add().
26176 * Once the icon object is set, a previously set one will be deleted.
26177 * @warning Setting the same icon for two items will cause the icon to
26178 * dissapear from the first item.
26180 * If an icon was passed as argument on item creation, with function
26181 * elm_diskselector_item_append(), it will be already
26182 * associated to the item.
26184 * @see elm_diskselector_item_append()
26185 * @see elm_diskselector_item_icon_get()
26187 * @ingroup Diskselector
26189 EAPI void elm_diskselector_item_icon_set(Elm_Diskselector_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
26192 * Get the icon associated to the item.
26194 * @param it The diskselector item
26195 * @return The icon associated to @p it
26197 * The return value is a pointer to the icon associated to @p item when it was
26198 * created, with function elm_diskselector_item_append(), or later
26199 * with function elm_diskselector_item_icon_set. If no icon
26200 * was passed as argument, it will return @c NULL.
26202 * @see elm_diskselector_item_append()
26203 * @see elm_diskselector_item_icon_set()
26205 * @ingroup Diskselector
26207 EAPI Evas_Object *elm_diskselector_item_icon_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26210 * Set the label of item.
26212 * @param it The item of diskselector.
26213 * @param label The label of item.
26215 * The label to be displayed by the item.
26217 * If no icon is set, label will be centered on item position, otherwise
26218 * the icon will be placed at left of the label, that will be shifted
26221 * An item with label "January" would be displayed on side position as
26222 * "Jan" if max length is set to 3 with function
26223 * elm_diskselector_side_label_lenght_set(), or "Janu", if this property
26226 * When this @p item is selected, the entire label will be displayed,
26227 * except for width restrictions.
26228 * In this case label will be cropped and "..." will be concatenated,
26229 * but only for display purposes. It will keep the entire string, so
26230 * if diskselector is resized the remaining characters will be displayed.
26232 * If a label was passed as argument on item creation, with function
26233 * elm_diskselector_item_append(), it will be already
26234 * displayed by the item.
26236 * @see elm_diskselector_side_label_lenght_set()
26237 * @see elm_diskselector_item_label_get()
26238 * @see elm_diskselector_item_append()
26240 * @ingroup Diskselector
26242 EAPI void elm_diskselector_item_label_set(Elm_Diskselector_Item *item, const char *label) EINA_ARG_NONNULL(1);
26245 * Get the label of item.
26247 * @param it The item of diskselector.
26248 * @return The label of item.
26250 * The return value is a pointer to the label associated to @p item when it was
26251 * created, with function elm_diskselector_item_append(), or later
26252 * with function elm_diskselector_item_label_set. If no label
26253 * was passed as argument, it will return @c NULL.
26255 * @see elm_diskselector_item_label_set() for more details.
26256 * @see elm_diskselector_item_append()
26258 * @ingroup Diskselector
26260 EAPI const char *elm_diskselector_item_label_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26263 * Get the selected item.
26265 * @param obj The diskselector object.
26266 * @return The selected diskselector item.
26268 * The selected item can be unselected with function
26269 * elm_diskselector_item_selected_set(), and the first item of
26270 * diskselector will be selected.
26272 * The selected item always will be centered on diskselector, with
26273 * full label displayed, i.e., max lenght set to side labels won't
26274 * apply on the selected item. More details on
26275 * elm_diskselector_side_label_length_set().
26277 * @ingroup Diskselector
26279 EAPI Elm_Diskselector_Item *elm_diskselector_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26282 * Set the selected state of an item.
26284 * @param it The diskselector item
26285 * @param selected The selected state
26287 * This sets the selected state of the given item @p it.
26288 * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
26290 * If a new item is selected the previosly selected will be unselected.
26291 * Previoulsy selected item can be get with function
26292 * elm_diskselector_selected_item_get().
26294 * If the item @p it is unselected, the first item of diskselector will
26297 * Selected items will be visible on center position of diskselector.
26298 * So if it was on another position before selected, or was invisible,
26299 * diskselector will animate items until the selected item reaches center
26302 * @see elm_diskselector_item_selected_get()
26303 * @see elm_diskselector_selected_item_get()
26305 * @ingroup Diskselector
26307 EAPI void elm_diskselector_item_selected_set(Elm_Diskselector_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
26310 * Get whether the @p item is selected or not.
26312 * @param it The diskselector item.
26313 * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
26314 * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
26316 * @see elm_diskselector_selected_item_set() for details.
26317 * @see elm_diskselector_item_selected_get()
26319 * @ingroup Diskselector
26321 EAPI Eina_Bool elm_diskselector_item_selected_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26324 * Get the first item of the diskselector.
26326 * @param obj The diskselector object.
26327 * @return The first item, or @c NULL if none.
26329 * The list of items follows append order. So it will return the first
26330 * item appended to the widget that wasn't deleted.
26332 * @see elm_diskselector_item_append()
26333 * @see elm_diskselector_items_get()
26335 * @ingroup Diskselector
26337 EAPI Elm_Diskselector_Item *elm_diskselector_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26340 * Get the last item of the diskselector.
26342 * @param obj The diskselector object.
26343 * @return The last item, or @c NULL if none.
26345 * The list of items follows append order. So it will return last first
26346 * item appended to the widget that wasn't deleted.
26348 * @see elm_diskselector_item_append()
26349 * @see elm_diskselector_items_get()
26351 * @ingroup Diskselector
26353 EAPI Elm_Diskselector_Item *elm_diskselector_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26356 * Get the item before @p item in diskselector.
26358 * @param it The diskselector item.
26359 * @return The item before @p item, or @c NULL if none or on failure.
26361 * The list of items follows append order. So it will return item appended
26362 * just before @p item and that wasn't deleted.
26364 * If it is the first item, @c NULL will be returned.
26365 * First item can be get by elm_diskselector_first_item_get().
26367 * @see elm_diskselector_item_append()
26368 * @see elm_diskselector_items_get()
26370 * @ingroup Diskselector
26372 EAPI Elm_Diskselector_Item *elm_diskselector_item_prev_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26375 * Get the item after @p item in diskselector.
26377 * @param it The diskselector item.
26378 * @return The item after @p item, or @c NULL if none or on failure.
26380 * The list of items follows append order. So it will return item appended
26381 * just after @p item and that wasn't deleted.
26383 * If it is the last item, @c NULL will be returned.
26384 * Last item can be get by elm_diskselector_last_item_get().
26386 * @see elm_diskselector_item_append()
26387 * @see elm_diskselector_items_get()
26389 * @ingroup Diskselector
26391 EAPI Elm_Diskselector_Item *elm_diskselector_item_next_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26394 * Set the text to be shown in the diskselector item.
26396 * @param item Target item
26397 * @param text The text to set in the content
26399 * Setup the text as tooltip to object. The item can have only one tooltip,
26400 * so any previous tooltip data is removed.
26402 * @see elm_object_tooltip_text_set() for more details.
26404 * @ingroup Diskselector
26406 EAPI void elm_diskselector_item_tooltip_text_set(Elm_Diskselector_Item *item, const char *text) EINA_ARG_NONNULL(1);
26409 * Set the content to be shown in the tooltip item.
26411 * Setup the tooltip to item. The item can have only one tooltip,
26412 * so any previous tooltip data is removed. @p func(with @p data) will
26413 * be called every time that need show the tooltip and it should
26414 * return a valid Evas_Object. This object is then managed fully by
26415 * tooltip system and is deleted when the tooltip is gone.
26417 * @param item the diskselector item being attached a tooltip.
26418 * @param func the function used to create the tooltip contents.
26419 * @param data what to provide to @a func as callback data/context.
26420 * @param del_cb called when data is not needed anymore, either when
26421 * another callback replaces @p func, the tooltip is unset with
26422 * elm_diskselector_item_tooltip_unset() or the owner @a item
26423 * dies. This callback receives as the first parameter the
26424 * given @a data, and @c event_info is the item.
26426 * @see elm_object_tooltip_content_cb_set() for more details.
26428 * @ingroup Diskselector
26430 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);
26433 * Unset tooltip from item.
26435 * @param item diskselector item to remove previously set tooltip.
26437 * Remove tooltip from item. The callback provided as del_cb to
26438 * elm_diskselector_item_tooltip_content_cb_set() will be called to notify
26439 * it is not used anymore.
26441 * @see elm_object_tooltip_unset() for more details.
26442 * @see elm_diskselector_item_tooltip_content_cb_set()
26444 * @ingroup Diskselector
26446 EAPI void elm_diskselector_item_tooltip_unset(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26450 * Sets a different style for this item tooltip.
26452 * @note before you set a style you should define a tooltip with
26453 * elm_diskselector_item_tooltip_content_cb_set() or
26454 * elm_diskselector_item_tooltip_text_set()
26456 * @param item diskselector item with tooltip already set.
26457 * @param style the theme style to use (default, transparent, ...)
26459 * @see elm_object_tooltip_style_set() for more details.
26461 * @ingroup Diskselector
26463 EAPI void elm_diskselector_item_tooltip_style_set(Elm_Diskselector_Item *item, const char *style) EINA_ARG_NONNULL(1);
26466 * Get the style for this item tooltip.
26468 * @param item diskselector item with tooltip already set.
26469 * @return style the theme style in use, defaults to "default". If the
26470 * object does not have a tooltip set, then NULL is returned.
26472 * @see elm_object_tooltip_style_get() for more details.
26473 * @see elm_diskselector_item_tooltip_style_set()
26475 * @ingroup Diskselector
26477 EAPI const char *elm_diskselector_item_tooltip_style_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26480 * Set the cursor to be shown when mouse is over the diskselector item
26482 * @param item Target item
26483 * @param cursor the cursor name to be used.
26485 * @see elm_object_cursor_set() for more details.
26487 * @ingroup Diskselector
26489 EAPI void elm_diskselector_item_cursor_set(Elm_Diskselector_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
26492 * Get the cursor to be shown when mouse is over the diskselector item
26494 * @param item diskselector item with cursor already set.
26495 * @return the cursor name.
26497 * @see elm_object_cursor_get() for more details.
26498 * @see elm_diskselector_cursor_set()
26500 * @ingroup Diskselector
26502 EAPI const char *elm_diskselector_item_cursor_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26506 * Unset the cursor to be shown when mouse is over the diskselector item
26508 * @param item Target item
26510 * @see elm_object_cursor_unset() for more details.
26511 * @see elm_diskselector_cursor_set()
26513 * @ingroup Diskselector
26515 EAPI void elm_diskselector_item_cursor_unset(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26518 * Sets a different style for this item cursor.
26520 * @note before you set a style you should define a cursor with
26521 * elm_diskselector_item_cursor_set()
26523 * @param item diskselector item with cursor already set.
26524 * @param style the theme style to use (default, transparent, ...)
26526 * @see elm_object_cursor_style_set() for more details.
26528 * @ingroup Diskselector
26530 EAPI void elm_diskselector_item_cursor_style_set(Elm_Diskselector_Item *item, const char *style) EINA_ARG_NONNULL(1);
26534 * Get the style for this item cursor.
26536 * @param item diskselector item with cursor already set.
26537 * @return style the theme style in use, defaults to "default". If the
26538 * object does not have a cursor set, then @c NULL is returned.
26540 * @see elm_object_cursor_style_get() for more details.
26541 * @see elm_diskselector_item_cursor_style_set()
26543 * @ingroup Diskselector
26545 EAPI const char *elm_diskselector_item_cursor_style_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26549 * Set if the cursor set should be searched on the theme or should use
26550 * the provided by the engine, only.
26552 * @note before you set if should look on theme you should define a cursor
26553 * with elm_diskselector_item_cursor_set().
26554 * By default it will only look for cursors provided by the engine.
26556 * @param item widget item with cursor already set.
26557 * @param engine_only boolean to define if cursors set with
26558 * elm_diskselector_item_cursor_set() should be searched only
26559 * between cursors provided by the engine or searched on widget's
26562 * @see elm_object_cursor_engine_only_set() for more details.
26564 * @ingroup Diskselector
26566 EAPI void elm_diskselector_item_cursor_engine_only_set(Elm_Diskselector_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
26569 * Get the cursor engine only usage for this item cursor.
26571 * @param item widget item with cursor already set.
26572 * @return engine_only boolean to define it cursors should be looked only
26573 * between the provided by the engine or searched on widget's theme as well.
26574 * If the item does not have a cursor set, then @c EINA_FALSE is returned.
26576 * @see elm_object_cursor_engine_only_get() for more details.
26577 * @see elm_diskselector_item_cursor_engine_only_set()
26579 * @ingroup Diskselector
26581 EAPI Eina_Bool elm_diskselector_item_cursor_engine_only_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26588 * @defgroup Colorselector Colorselector
26592 * @image html img/widget/colorselector/preview-00.png
26593 * @image latex img/widget/colorselector/preview-00.eps
26595 * @brief Widget for user to select a color.
26597 * Signals that you can add callbacks for are:
26598 * "changed" - When the color value changes(event_info is NULL).
26600 * See @ref tutorial_colorselector.
26603 * @brief Add a new colorselector to the parent
26605 * @param parent The parent object
26606 * @return The new object or NULL if it cannot be created
26608 * @ingroup Colorselector
26610 EAPI Evas_Object *elm_colorselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
26612 * Set a color for the colorselector
26614 * @param obj Colorselector object
26615 * @param r r-value of color
26616 * @param g g-value of color
26617 * @param b b-value of color
26618 * @param a a-value of color
26620 * @ingroup Colorselector
26622 EAPI void elm_colorselector_color_set(Evas_Object *obj, int r, int g , int b, int a) EINA_ARG_NONNULL(1);
26624 * Get a color from the colorselector
26626 * @param obj Colorselector object
26627 * @param r integer pointer for r-value of color
26628 * @param g integer pointer for g-value of color
26629 * @param b integer pointer for b-value of color
26630 * @param a integer pointer for a-value of color
26632 * @ingroup Colorselector
26634 EAPI void elm_colorselector_color_get(const Evas_Object *obj, int *r, int *g , int *b, int *a) EINA_ARG_NONNULL(1);
26640 * @defgroup Ctxpopup Ctxpopup
26642 * @image html img/widget/ctxpopup/preview-00.png
26643 * @image latex img/widget/ctxpopup/preview-00.eps
26645 * @brief Context popup widet.
26647 * A ctxpopup is a widget that, when shown, pops up a list of items.
26648 * It automatically chooses an area inside its parent object's view
26649 * (set via elm_ctxpopup_add() and elm_ctxpopup_hover_parent_set()) to
26650 * optimally fit into it. In the default theme, it will also point an
26651 * arrow to it's top left position at the time one shows it. Ctxpopup
26652 * items have a label and/or an icon. It is intended for a small
26653 * number of items (hence the use of list, not genlist).
26655 * @note Ctxpopup is a especialization of @ref Hover.
26657 * Signals that you can add callbacks for are:
26658 * "dismissed" - the ctxpopup was dismissed
26660 * Default contents parts of the ctxpopup widget that you can use for are:
26661 * @li "default" - A content of the ctxpopup
26663 * Default contents parts of the naviframe items that you can use for are:
26664 * @li "icon" - An icon in the title area
26666 * Default text parts of the naviframe items that you can use for are:
26667 * @li "default" - Title label in the title area
26669 * @ref tutorial_ctxpopup shows the usage of a good deal of the API.
26672 typedef enum _Elm_Ctxpopup_Direction
26674 ELM_CTXPOPUP_DIRECTION_DOWN, /**< ctxpopup show appear below clicked
26676 ELM_CTXPOPUP_DIRECTION_RIGHT, /**< ctxpopup show appear to the right of
26677 the clicked area */
26678 ELM_CTXPOPUP_DIRECTION_LEFT, /**< ctxpopup show appear to the left of
26679 the clicked area */
26680 ELM_CTXPOPUP_DIRECTION_UP, /**< ctxpopup show appear above the clicked
26682 ELM_CTXPOPUP_DIRECTION_UNKNOWN, /**< ctxpopup does not determine it's direction yet*/
26683 } Elm_Ctxpopup_Direction;
26686 * @brief Add a new Ctxpopup object to the parent.
26688 * @param parent Parent object
26689 * @return New object or @c NULL, if it cannot be created
26691 EAPI Evas_Object *elm_ctxpopup_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
26693 * @brief Set the Ctxpopup's parent
26695 * @param obj The ctxpopup object
26696 * @param area The parent to use
26698 * Set the parent object.
26700 * @note elm_ctxpopup_add() will automatically call this function
26701 * with its @c parent argument.
26703 * @see elm_ctxpopup_add()
26704 * @see elm_hover_parent_set()
26706 EAPI void elm_ctxpopup_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1, 2);
26708 * @brief Get the Ctxpopup's parent
26710 * @param obj The ctxpopup object
26712 * @see elm_ctxpopup_hover_parent_set() for more information
26714 EAPI Evas_Object *elm_ctxpopup_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26716 * @brief Clear all items in the given ctxpopup object.
26718 * @param obj Ctxpopup object
26720 EAPI void elm_ctxpopup_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
26722 * @brief Change the ctxpopup's orientation to horizontal or vertical.
26724 * @param obj Ctxpopup object
26725 * @param horizontal @c EINA_TRUE for horizontal mode, @c EINA_FALSE for vertical
26727 EAPI void elm_ctxpopup_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
26729 * @brief Get the value of current ctxpopup object's orientation.
26731 * @param obj Ctxpopup object
26732 * @return @c EINA_TRUE for horizontal mode, @c EINA_FALSE for vertical mode (or errors)
26734 * @see elm_ctxpopup_horizontal_set()
26736 EAPI Eina_Bool elm_ctxpopup_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26738 * @brief Add a new item to a ctxpopup object.
26740 * @param obj Ctxpopup object
26741 * @param icon Icon to be set on new item
26742 * @param label The Label of the new item
26743 * @param func Convenience function called when item selected
26744 * @param data Data passed to @p func
26745 * @return A handle to the item added or @c NULL, on errors
26747 * @warning Ctxpopup can't hold both an item list and a content at the same
26748 * time. When an item is added, any previous content will be removed.
26750 * @see elm_ctxpopup_content_set()
26752 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);
26754 * @brief Delete the given item in a ctxpopup object.
26756 * @param it Ctxpopup item to be deleted
26758 * @see elm_ctxpopup_item_append()
26760 EAPI void elm_ctxpopup_item_del(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26762 * @brief Set the ctxpopup item's state as disabled or enabled.
26764 * @param it Ctxpopup item to be enabled/disabled
26765 * @param disabled @c EINA_TRUE to disable it, @c EINA_FALSE to enable it
26767 * When disabled the item is greyed out to indicate it's state.
26768 * @deprecated use elm_object_item_disabled_set() instead
26770 EINA_DEPRECATED EAPI void elm_ctxpopup_item_disabled_set(Elm_Object_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1);
26772 * @brief Get the ctxpopup item's disabled/enabled state.
26774 * @param it Ctxpopup item to be enabled/disabled
26775 * @return disabled @c EINA_TRUE, if disabled, @c EINA_FALSE otherwise
26777 * @see elm_ctxpopup_item_disabled_set()
26778 * @deprecated use elm_object_item_disabled_get() instead
26780 EAPI Eina_Bool elm_ctxpopup_item_disabled_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26782 * @brief Get the icon object for the given ctxpopup item.
26784 * @param it Ctxpopup item
26785 * @return icon object or @c NULL, if the item does not have icon or an error
26788 * @see elm_ctxpopup_item_append()
26789 * @see elm_ctxpopup_item_icon_set()
26791 * @deprecated use elm_object_item_part_content_get() instead
26793 EINA_DEPRECATED EAPI Evas_Object *elm_ctxpopup_item_icon_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26795 * @brief Sets the side icon associated with the ctxpopup item
26797 * @param it Ctxpopup item
26798 * @param icon Icon object to be set
26800 * Once the icon object is set, a previously set one will be deleted.
26801 * @warning Setting the same icon for two items will cause the icon to
26802 * dissapear from the first item.
26804 * @see elm_ctxpopup_item_append()
26806 * @deprecated use elm_object_item_part_content_set() instead
26809 EINA_DEPRECATED EAPI void elm_ctxpopup_item_icon_set(Elm_Object_Item *it, Evas_Object *icon) EINA_ARG_NONNULL(1);
26811 * @brief Get the label for the given ctxpopup item.
26813 * @param it Ctxpopup item
26814 * @return label string or @c NULL, if the item does not have label or an
26817 * @see elm_ctxpopup_item_append()
26818 * @see elm_ctxpopup_item_label_set()
26820 * @deprecated use elm_object_item_text_get() instead
26822 EINA_DEPRECATED EAPI const char *elm_ctxpopup_item_label_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26824 * @brief (Re)set the label on the given ctxpopup item.
26826 * @param it Ctxpopup item
26827 * @param label String to set as label
26829 * @deprecated use elm_object_item_text_set() instead
26831 EINA_DEPRECATED EAPI void elm_ctxpopup_item_label_set(Elm_Object_Item *it, const char *label) EINA_ARG_NONNULL(1);
26833 * @brief Set an elm widget as the content of the ctxpopup.
26835 * @param obj Ctxpopup object
26836 * @param content Content to be swallowed
26838 * If the content object is already set, a previous one will bedeleted. If
26839 * you want to keep that old content object, use the
26840 * elm_ctxpopup_content_unset() function.
26842 * @warning Ctxpopup can't hold both a item list and a content at the same
26843 * time. When a content is set, any previous items will be removed.
26845 * @deprecated use elm_object_content_set() instead
26848 EINA_DEPRECATED EAPI void elm_ctxpopup_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1, 2);
26850 * @brief Unset the ctxpopup content
26852 * @param obj Ctxpopup object
26853 * @return The content that was being used
26855 * Unparent and return the content object which was set for this widget.
26857 * @deprecated use elm_object_content_unset()
26859 * @see elm_ctxpopup_content_set()
26861 * @deprecated use elm_object_content_unset() instead
26864 EINA_DEPRECATED EAPI Evas_Object *elm_ctxpopup_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
26866 * @brief Set the direction priority of a ctxpopup.
26868 * @param obj Ctxpopup object
26869 * @param first 1st priority of direction
26870 * @param second 2nd priority of direction
26871 * @param third 3th priority of direction
26872 * @param fourth 4th priority of direction
26874 * This functions gives a chance to user to set the priority of ctxpopup
26875 * showing direction. This doesn't guarantee the ctxpopup will appear in the
26876 * requested direction.
26878 * @see Elm_Ctxpopup_Direction
26880 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);
26882 * @brief Get the direction priority of a ctxpopup.
26884 * @param obj Ctxpopup object
26885 * @param first 1st priority of direction to be returned
26886 * @param second 2nd priority of direction to be returned
26887 * @param third 3th priority of direction to be returned
26888 * @param fourth 4th priority of direction to be returned
26890 * @see elm_ctxpopup_direction_priority_set() for more information.
26892 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);
26895 * @brief Get the current direction of a ctxpopup.
26897 * @param obj Ctxpopup object
26898 * @return current direction of a ctxpopup
26900 * @warning Once the ctxpopup showed up, the direction would be determined
26902 EAPI Elm_Ctxpopup_Direction elm_ctxpopup_direction_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26911 * @defgroup Transit Transit
26912 * @ingroup Elementary
26914 * Transit is designed to apply various animated transition effects to @c
26915 * Evas_Object, such like translation, rotation, etc. For using these
26916 * effects, create an @ref Elm_Transit and add the desired transition effects.
26918 * Once the effects are added into transit, they will be automatically
26919 * managed (their callback will be called until the duration is ended, and
26920 * they will be deleted on completion).
26924 * Elm_Transit *trans = elm_transit_add();
26925 * elm_transit_object_add(trans, obj);
26926 * elm_transit_effect_translation_add(trans, 0, 0, 280, 280
26927 * elm_transit_duration_set(transit, 1);
26928 * elm_transit_auto_reverse_set(transit, EINA_TRUE);
26929 * elm_transit_tween_mode_set(transit, ELM_TRANSIT_TWEEN_MODE_DECELERATE);
26930 * elm_transit_repeat_times_set(transit, 3);
26933 * Some transition effects are used to change the properties of objects. They
26935 * @li @ref elm_transit_effect_translation_add
26936 * @li @ref elm_transit_effect_color_add
26937 * @li @ref elm_transit_effect_rotation_add
26938 * @li @ref elm_transit_effect_wipe_add
26939 * @li @ref elm_transit_effect_zoom_add
26940 * @li @ref elm_transit_effect_resizing_add
26942 * Other transition effects are used to make one object disappear and another
26943 * object appear on its old place. These effects are:
26945 * @li @ref elm_transit_effect_flip_add
26946 * @li @ref elm_transit_effect_resizable_flip_add
26947 * @li @ref elm_transit_effect_fade_add
26948 * @li @ref elm_transit_effect_blend_add
26950 * It's also possible to make a transition chain with @ref
26951 * elm_transit_chain_transit_add.
26953 * @warning We strongly recommend to use elm_transit just when edje can not do
26954 * the trick. Edje has more advantage than Elm_Transit, it has more flexibility and
26955 * animations can be manipulated inside the theme.
26957 * List of examples:
26958 * @li @ref transit_example_01_explained
26959 * @li @ref transit_example_02_explained
26960 * @li @ref transit_example_03_c
26961 * @li @ref transit_example_04_c
26967 * @enum Elm_Transit_Tween_Mode
26969 * The type of acceleration used in the transition.
26973 ELM_TRANSIT_TWEEN_MODE_LINEAR, /**< Constant speed */
26974 ELM_TRANSIT_TWEEN_MODE_SINUSOIDAL, /**< Starts slow, increase speed
26975 over time, then decrease again
26977 ELM_TRANSIT_TWEEN_MODE_DECELERATE, /**< Starts fast and decrease
26979 ELM_TRANSIT_TWEEN_MODE_ACCELERATE /**< Starts slow and increase speed
26981 } Elm_Transit_Tween_Mode;
26984 * @enum Elm_Transit_Effect_Flip_Axis
26986 * The axis where flip effect should be applied.
26990 ELM_TRANSIT_EFFECT_FLIP_AXIS_X, /**< Flip on X axis */
26991 ELM_TRANSIT_EFFECT_FLIP_AXIS_Y /**< Flip on Y axis */
26992 } Elm_Transit_Effect_Flip_Axis;
26994 * @enum Elm_Transit_Effect_Wipe_Dir
26996 * The direction where the wipe effect should occur.
27000 ELM_TRANSIT_EFFECT_WIPE_DIR_LEFT, /**< Wipe to the left */
27001 ELM_TRANSIT_EFFECT_WIPE_DIR_RIGHT, /**< Wipe to the right */
27002 ELM_TRANSIT_EFFECT_WIPE_DIR_UP, /**< Wipe up */
27003 ELM_TRANSIT_EFFECT_WIPE_DIR_DOWN /**< Wipe down */
27004 } Elm_Transit_Effect_Wipe_Dir;
27005 /** @enum Elm_Transit_Effect_Wipe_Type
27007 * Whether the wipe effect should show or hide the object.
27011 ELM_TRANSIT_EFFECT_WIPE_TYPE_HIDE, /**< Hide the object during the
27013 ELM_TRANSIT_EFFECT_WIPE_TYPE_SHOW /**< Show the object during the
27015 } Elm_Transit_Effect_Wipe_Type;
27018 * @typedef Elm_Transit
27020 * The Transit created with elm_transit_add(). This type has the information
27021 * about the objects which the transition will be applied, and the
27022 * transition effects that will be used. It also contains info about
27023 * duration, number of repetitions, auto-reverse, etc.
27025 typedef struct _Elm_Transit Elm_Transit;
27026 typedef void Elm_Transit_Effect;
27028 * @typedef Elm_Transit_Effect_Transition_Cb
27030 * Transition callback called for this effect on each transition iteration.
27032 typedef void (*Elm_Transit_Effect_Transition_Cb) (Elm_Transit_Effect *effect, Elm_Transit *transit, double progress);
27034 * Elm_Transit_Effect_End_Cb
27036 * Transition callback called for this effect when the transition is over.
27038 typedef void (*Elm_Transit_Effect_End_Cb) (Elm_Transit_Effect *effect, Elm_Transit *transit);
27041 * Elm_Transit_Del_Cb
27043 * A callback called when the transit is deleted.
27045 typedef void (*Elm_Transit_Del_Cb) (void *data, Elm_Transit *transit);
27050 * @note Is not necessary to delete the transit object, it will be deleted at
27051 * the end of its operation.
27052 * @note The transit will start playing when the program enter in the main loop, is not
27053 * necessary to give a start to the transit.
27055 * @return The transit object.
27059 EAPI Elm_Transit *elm_transit_add(void);
27062 * Stops the animation and delete the @p transit object.
27064 * Call this function if you wants to stop the animation before the duration
27065 * time. Make sure the @p transit object is still alive with
27066 * elm_transit_del_cb_set() function.
27067 * All added effects will be deleted, calling its repective data_free_cb
27068 * functions. The function setted by elm_transit_del_cb_set() will be called.
27070 * @see elm_transit_del_cb_set()
27072 * @param transit The transit object to be deleted.
27075 * @warning Just call this function if you are sure the transit is alive.
27077 EAPI void elm_transit_del(Elm_Transit *transit) EINA_ARG_NONNULL(1);
27080 * Add a new effect to the transit.
27082 * @note The cb function and the data are the key to the effect. If you try to
27083 * add an already added effect, nothing is done.
27084 * @note After the first addition of an effect in @p transit, if its
27085 * effect list become empty again, the @p transit will be killed by
27086 * elm_transit_del(transit) function.
27090 * Elm_Transit *transit = elm_transit_add();
27091 * elm_transit_effect_add(transit,
27092 * elm_transit_effect_blend_op,
27093 * elm_transit_effect_blend_context_new(),
27094 * elm_transit_effect_blend_context_free);
27097 * @param transit The transit object.
27098 * @param transition_cb The operation function. It is called when the
27099 * animation begins, it is the function that actually performs the animation.
27100 * It is called with the @p data, @p transit and the time progression of the
27101 * animation (a double value between 0.0 and 1.0).
27102 * @param effect The context data of the effect.
27103 * @param end_cb The function to free the context data, it will be called
27104 * at the end of the effect, it must finalize the animation and free the
27108 * @warning The transit free the context data at the and of the transition with
27109 * the data_free_cb function, do not use the context data in another transit.
27111 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);
27114 * Delete an added effect.
27116 * This function will remove the effect from the @p transit, calling the
27117 * data_free_cb to free the @p data.
27119 * @see elm_transit_effect_add()
27121 * @note If the effect is not found, nothing is done.
27122 * @note If the effect list become empty, this function will call
27123 * elm_transit_del(transit), that is, it will kill the @p transit.
27125 * @param transit The transit object.
27126 * @param transition_cb The operation function.
27127 * @param effect The context data of the effect.
27131 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);
27134 * Add new object to apply the effects.
27136 * @note After the first addition of an object in @p transit, if its
27137 * object list become empty again, the @p transit will be killed by
27138 * elm_transit_del(transit) function.
27139 * @note If the @p obj belongs to another transit, the @p obj will be
27140 * removed from it and it will only belong to the @p transit. If the old
27141 * transit stays without objects, it will die.
27142 * @note When you add an object into the @p transit, its state from
27143 * evas_object_pass_events_get(obj) is saved, and it is applied when the
27144 * transit ends, if you change this state whith evas_object_pass_events_set()
27145 * after add the object, this state will change again when @p transit stops to
27148 * @param transit The transit object.
27149 * @param obj Object to be animated.
27152 * @warning It is not allowed to add a new object after transit begins to go.
27154 EAPI void elm_transit_object_add(Elm_Transit *transit, Evas_Object *obj) EINA_ARG_NONNULL(1, 2);
27157 * Removes an added object from the transit.
27159 * @note If the @p obj is not in the @p transit, nothing is done.
27160 * @note If the list become empty, this function will call
27161 * elm_transit_del(transit), that is, it will kill the @p transit.
27163 * @param transit The transit object.
27164 * @param obj Object to be removed from @p transit.
27167 * @warning It is not allowed to remove objects after transit begins to go.
27169 EAPI void elm_transit_object_remove(Elm_Transit *transit, Evas_Object *obj) EINA_ARG_NONNULL(1, 2);
27172 * Get the objects of the transit.
27174 * @param transit The transit object.
27175 * @return a Eina_List with the objects from the transit.
27179 EAPI const Eina_List *elm_transit_objects_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27182 * Enable/disable keeping up the objects states.
27183 * If it is not kept, the objects states will be reset when transition ends.
27185 * @note @p transit can not be NULL.
27186 * @note One state includes geometry, color, map data.
27188 * @param transit The transit object.
27189 * @param state_keep Keeping or Non Keeping.
27193 EAPI void elm_transit_objects_final_state_keep_set(Elm_Transit *transit, Eina_Bool state_keep) EINA_ARG_NONNULL(1);
27196 * Get a value whether the objects states will be reset or not.
27198 * @note @p transit can not be NULL
27200 * @see elm_transit_objects_final_state_keep_set()
27202 * @param transit The transit object.
27203 * @return EINA_TRUE means the states of the objects will be reset.
27204 * If @p transit is NULL, EINA_FALSE is returned
27208 EAPI Eina_Bool elm_transit_objects_final_state_keep_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27211 * Set the event enabled when transit is operating.
27213 * If @p enabled is EINA_TRUE, the objects of the transit will receives
27214 * events from mouse and keyboard during the animation.
27215 * @note When you add an object with elm_transit_object_add(), its state from
27216 * evas_object_pass_events_get(obj) is saved, and it is applied when the
27217 * transit ends, if you change this state with evas_object_pass_events_set()
27218 * after adding the object, this state will change again when @p transit stops
27221 * @param transit The transit object.
27222 * @param enabled Events are received when enabled is @c EINA_TRUE, and
27223 * ignored otherwise.
27227 EAPI void elm_transit_event_enabled_set(Elm_Transit *transit, Eina_Bool enabled) EINA_ARG_NONNULL(1);
27230 * Get the value of event enabled status.
27232 * @see elm_transit_event_enabled_set()
27234 * @param transit The Transit object
27235 * @return EINA_TRUE, when event is enabled. If @p transit is NULL
27236 * EINA_FALSE is returned
27240 EAPI Eina_Bool elm_transit_event_enabled_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27243 * Set the user-callback function when the transit is deleted.
27245 * @note Using this function twice will overwrite the first function setted.
27246 * @note the @p transit object will be deleted after call @p cb function.
27248 * @param transit The transit object.
27249 * @param cb Callback function pointer. This function will be called before
27250 * the deletion of the transit.
27251 * @param data Callback funtion user data. It is the @p op parameter.
27255 EAPI void elm_transit_del_cb_set(Elm_Transit *transit, Elm_Transit_Del_Cb cb, void *data) EINA_ARG_NONNULL(1);
27258 * Set reverse effect automatically.
27260 * If auto reverse is setted, after running the effects with the progress
27261 * parameter from 0 to 1, it will call the effecs again with the progress
27262 * from 1 to 0. The transit will last for a time iqual to (2 * duration * repeat),
27263 * where the duration was setted with the function elm_transit_add and
27264 * the repeat with the function elm_transit_repeat_times_set().
27266 * @param transit The transit object.
27267 * @param reverse EINA_TRUE means the auto_reverse is on.
27271 EAPI void elm_transit_auto_reverse_set(Elm_Transit *transit, Eina_Bool reverse) EINA_ARG_NONNULL(1);
27274 * Get if the auto reverse is on.
27276 * @see elm_transit_auto_reverse_set()
27278 * @param transit The transit object.
27279 * @return EINA_TRUE means auto reverse is on. If @p transit is NULL
27280 * EINA_FALSE is returned
27284 EAPI Eina_Bool elm_transit_auto_reverse_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27287 * Set the transit repeat count. Effect will be repeated by repeat count.
27289 * This function sets the number of repetition the transit will run after
27290 * the first one, that is, if @p repeat is 1, the transit will run 2 times.
27291 * If the @p repeat is a negative number, it will repeat infinite times.
27293 * @note If this function is called during the transit execution, the transit
27294 * will run @p repeat times, ignoring the times it already performed.
27296 * @param transit The transit object
27297 * @param repeat Repeat count
27301 EAPI void elm_transit_repeat_times_set(Elm_Transit *transit, int repeat) EINA_ARG_NONNULL(1);
27304 * Get the transit repeat count.
27306 * @see elm_transit_repeat_times_set()
27308 * @param transit The Transit object.
27309 * @return The repeat count. If @p transit is NULL
27314 EAPI int elm_transit_repeat_times_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27317 * Set the transit animation acceleration type.
27319 * This function sets the tween mode of the transit that can be:
27320 * ELM_TRANSIT_TWEEN_MODE_LINEAR - The default mode.
27321 * ELM_TRANSIT_TWEEN_MODE_SINUSOIDAL - Starts in accelerate mode and ends decelerating.
27322 * ELM_TRANSIT_TWEEN_MODE_DECELERATE - The animation will be slowed over time.
27323 * ELM_TRANSIT_TWEEN_MODE_ACCELERATE - The animation will accelerate over time.
27325 * @param transit The transit object.
27326 * @param tween_mode The tween type.
27330 EAPI void elm_transit_tween_mode_set(Elm_Transit *transit, Elm_Transit_Tween_Mode tween_mode) EINA_ARG_NONNULL(1);
27333 * Get the transit animation acceleration type.
27335 * @note @p transit can not be NULL
27337 * @param transit The transit object.
27338 * @return The tween type. If @p transit is NULL
27339 * ELM_TRANSIT_TWEEN_MODE_LINEAR is returned.
27343 EAPI Elm_Transit_Tween_Mode elm_transit_tween_mode_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27346 * Set the transit animation time
27348 * @note @p transit can not be NULL
27350 * @param transit The transit object.
27351 * @param duration The animation time.
27355 EAPI void elm_transit_duration_set(Elm_Transit *transit, double duration) EINA_ARG_NONNULL(1);
27358 * Get the transit animation time
27360 * @note @p transit can not be NULL
27362 * @param transit The transit object.
27364 * @return The transit animation time.
27368 EAPI double elm_transit_duration_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27371 * Starts the transition.
27372 * Once this API is called, the transit begins to measure the time.
27374 * @note @p transit can not be NULL
27376 * @param transit The transit object.
27380 EAPI void elm_transit_go(Elm_Transit *transit) EINA_ARG_NONNULL(1);
27383 * Pause/Resume the transition.
27385 * If you call elm_transit_go again, the transit will be started from the
27386 * beginning, and will be unpaused.
27388 * @note @p transit can not be NULL
27390 * @param transit The transit object.
27391 * @param paused Whether the transition should be paused or not.
27395 EAPI void elm_transit_paused_set(Elm_Transit *transit, Eina_Bool paused) EINA_ARG_NONNULL(1);
27398 * Get the value of paused status.
27400 * @see elm_transit_paused_set()
27402 * @note @p transit can not be NULL
27404 * @param transit The transit object.
27405 * @return EINA_TRUE means transition is paused. If @p transit is NULL
27406 * EINA_FALSE is returned
27410 EAPI Eina_Bool elm_transit_paused_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27413 * Get the time progression of the animation (a double value between 0.0 and 1.0).
27415 * The value returned is a fraction (current time / total time). It
27416 * represents the progression position relative to the total.
27418 * @note @p transit can not be NULL
27420 * @param transit The transit object.
27422 * @return The time progression value. If @p transit is NULL
27427 EAPI double elm_transit_progress_value_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27430 * Makes the chain relationship between two transits.
27432 * @note @p transit can not be NULL. Transit would have multiple chain transits.
27433 * @note @p chain_transit can not be NULL. Chain transits could be chained to the only one transit.
27435 * @param transit The transit object.
27436 * @param chain_transit The chain transit object. This transit will be operated
27437 * after transit is done.
27439 * This function adds @p chain_transit transition to a chain after the @p
27440 * transit, and will be started as soon as @p transit ends. See @ref
27441 * transit_example_02_explained for a full example.
27445 EAPI void elm_transit_chain_transit_add(Elm_Transit *transit, Elm_Transit *chain_transit) EINA_ARG_NONNULL(1, 2);
27448 * Cut off the chain relationship between two transits.
27450 * @note @p transit can not be NULL. Transit would have the chain relationship with @p chain transit.
27451 * @note @p chain_transit can not be NULL. Chain transits should be chained to the @p transit.
27453 * @param transit The transit object.
27454 * @param chain_transit The chain transit object.
27456 * This function remove the @p chain_transit transition from the @p transit.
27460 EAPI void elm_transit_chain_transit_del(Elm_Transit *transit, Elm_Transit *chain_transit) EINA_ARG_NONNULL(1,2);
27463 * Get the current chain transit list.
27465 * @note @p transit can not be NULL.
27467 * @param transit The transit object.
27468 * @return chain transit list.
27472 EAPI Eina_List *elm_transit_chain_transits_get(const Elm_Transit *transit);
27475 * Add the Resizing Effect to Elm_Transit.
27477 * @note This API is one of the facades. It creates resizing effect context
27478 * and add it's required APIs to elm_transit_effect_add.
27480 * @see elm_transit_effect_add()
27482 * @param transit Transit object.
27483 * @param from_w Object width size when effect begins.
27484 * @param from_h Object height size when effect begins.
27485 * @param to_w Object width size when effect ends.
27486 * @param to_h Object height size when effect ends.
27487 * @return Resizing effect context data.
27491 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);
27494 * Add the Translation Effect to Elm_Transit.
27496 * @note This API is one of the facades. It creates translation effect context
27497 * and add it's required APIs to elm_transit_effect_add.
27499 * @see elm_transit_effect_add()
27501 * @param transit Transit object.
27502 * @param from_dx X Position variation when effect begins.
27503 * @param from_dy Y Position variation when effect begins.
27504 * @param to_dx X Position variation when effect ends.
27505 * @param to_dy Y Position variation when effect ends.
27506 * @return Translation effect context data.
27509 * @warning It is highly recommended just create a transit with this effect when
27510 * the window that the objects of the transit belongs has already been created.
27511 * This is because this effect needs the geometry information about the objects,
27512 * and if the window was not created yet, it can get a wrong information.
27514 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);
27517 * Add the Zoom Effect to Elm_Transit.
27519 * @note This API is one of the facades. It creates zoom effect context
27520 * and add it's required APIs to elm_transit_effect_add.
27522 * @see elm_transit_effect_add()
27524 * @param transit Transit object.
27525 * @param from_rate Scale rate when effect begins (1 is current rate).
27526 * @param to_rate Scale rate when effect ends.
27527 * @return Zoom effect context data.
27530 * @warning It is highly recommended just create a transit with this effect when
27531 * the window that the objects of the transit belongs has already been created.
27532 * This is because this effect needs the geometry information about the objects,
27533 * and if the window was not created yet, it can get a wrong information.
27535 EAPI Elm_Transit_Effect *elm_transit_effect_zoom_add(Elm_Transit *transit, float from_rate, float to_rate);
27538 * Add the Flip Effect to Elm_Transit.
27540 * @note This API is one of the facades. It creates flip effect context
27541 * and add it's required APIs to elm_transit_effect_add.
27542 * @note This effect is applied to each pair of objects in the order they are listed
27543 * in the transit list of objects. The first object in the pair will be the
27544 * "front" object and the second will be the "back" object.
27546 * @see elm_transit_effect_add()
27548 * @param transit Transit object.
27549 * @param axis Flipping Axis(X or Y).
27550 * @param cw Flipping Direction. EINA_TRUE is clock-wise.
27551 * @return Flip effect context data.
27554 * @warning It is highly recommended just create a transit with this effect when
27555 * the window that the objects of the transit belongs has already been created.
27556 * This is because this effect needs the geometry information about the objects,
27557 * and if the window was not created yet, it can get a wrong information.
27559 EAPI Elm_Transit_Effect *elm_transit_effect_flip_add(Elm_Transit *transit, Elm_Transit_Effect_Flip_Axis axis, Eina_Bool cw);
27562 * Add the Resizable Flip Effect to Elm_Transit.
27564 * @note This API is one of the facades. It creates resizable flip effect context
27565 * and add it's required APIs to elm_transit_effect_add.
27566 * @note This effect is applied to each pair of objects in the order they are listed
27567 * in the transit list of objects. The first object in the pair will be the
27568 * "front" object and the second will be the "back" object.
27570 * @see elm_transit_effect_add()
27572 * @param transit Transit object.
27573 * @param axis Flipping Axis(X or Y).
27574 * @param cw Flipping Direction. EINA_TRUE is clock-wise.
27575 * @return Resizable flip effect context data.
27578 * @warning It is highly recommended just create a transit with this effect when
27579 * the window that the objects of the transit belongs has already been created.
27580 * This is because this effect needs the geometry information about the objects,
27581 * and if the window was not created yet, it can get a wrong information.
27583 EAPI Elm_Transit_Effect *elm_transit_effect_resizable_flip_add(Elm_Transit *transit, Elm_Transit_Effect_Flip_Axis axis, Eina_Bool cw);
27586 * Add the Wipe Effect to Elm_Transit.
27588 * @note This API is one of the facades. It creates wipe effect context
27589 * and add it's required APIs to elm_transit_effect_add.
27591 * @see elm_transit_effect_add()
27593 * @param transit Transit object.
27594 * @param type Wipe type. Hide or show.
27595 * @param dir Wipe Direction.
27596 * @return Wipe effect context data.
27599 * @warning It is highly recommended just create a transit with this effect when
27600 * the window that the objects of the transit belongs has already been created.
27601 * This is because this effect needs the geometry information about the objects,
27602 * and if the window was not created yet, it can get a wrong information.
27604 EAPI Elm_Transit_Effect *elm_transit_effect_wipe_add(Elm_Transit *transit, Elm_Transit_Effect_Wipe_Type type, Elm_Transit_Effect_Wipe_Dir dir);
27607 * Add the Color Effect to Elm_Transit.
27609 * @note This API is one of the facades. It creates color effect context
27610 * and add it's required APIs to elm_transit_effect_add.
27612 * @see elm_transit_effect_add()
27614 * @param transit Transit object.
27615 * @param from_r RGB R when effect begins.
27616 * @param from_g RGB G when effect begins.
27617 * @param from_b RGB B when effect begins.
27618 * @param from_a RGB A when effect begins.
27619 * @param to_r RGB R when effect ends.
27620 * @param to_g RGB G when effect ends.
27621 * @param to_b RGB B when effect ends.
27622 * @param to_a RGB A when effect ends.
27623 * @return Color effect context data.
27627 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);
27630 * Add the Fade Effect to Elm_Transit.
27632 * @note This API is one of the facades. It creates fade effect context
27633 * and add it's required APIs to elm_transit_effect_add.
27634 * @note This effect is applied to each pair of objects in the order they are listed
27635 * in the transit list of objects. The first object in the pair will be the
27636 * "before" object and the second will be the "after" object.
27638 * @see elm_transit_effect_add()
27640 * @param transit Transit object.
27641 * @return Fade effect context data.
27644 * @warning It is highly recommended just create a transit with this effect when
27645 * the window that the objects of the transit belongs has already been created.
27646 * This is because this effect needs the color information about the objects,
27647 * and if the window was not created yet, it can get a wrong information.
27649 EAPI Elm_Transit_Effect *elm_transit_effect_fade_add(Elm_Transit *transit);
27652 * Add the Blend Effect to Elm_Transit.
27654 * @note This API is one of the facades. It creates blend effect context
27655 * and add it's required APIs to elm_transit_effect_add.
27656 * @note This effect is applied to each pair of objects in the order they are listed
27657 * in the transit list of objects. The first object in the pair will be the
27658 * "before" object and the second will be the "after" object.
27660 * @see elm_transit_effect_add()
27662 * @param transit Transit object.
27663 * @return Blend effect context data.
27666 * @warning It is highly recommended just create a transit with this effect when
27667 * the window that the objects of the transit belongs has already been created.
27668 * This is because this effect needs the color information about the objects,
27669 * and if the window was not created yet, it can get a wrong information.
27671 EAPI Elm_Transit_Effect *elm_transit_effect_blend_add(Elm_Transit *transit);
27674 * Add the Rotation Effect to Elm_Transit.
27676 * @note This API is one of the facades. It creates rotation effect context
27677 * and add it's required APIs to elm_transit_effect_add.
27679 * @see elm_transit_effect_add()
27681 * @param transit Transit object.
27682 * @param from_degree Degree when effect begins.
27683 * @param to_degree Degree when effect is ends.
27684 * @return Rotation effect context data.
27687 * @warning It is highly recommended just create a transit with this effect when
27688 * the window that the objects of the transit belongs has already been created.
27689 * This is because this effect needs the geometry information about the objects,
27690 * and if the window was not created yet, it can get a wrong information.
27692 EAPI Elm_Transit_Effect *elm_transit_effect_rotation_add(Elm_Transit *transit, float from_degree, float to_degree);
27695 * Add the ImageAnimation Effect to Elm_Transit.
27697 * @note This API is one of the facades. It creates image animation effect context
27698 * and add it's required APIs to elm_transit_effect_add.
27699 * The @p images parameter is a list images paths. This list and
27700 * its contents will be deleted at the end of the effect by
27701 * elm_transit_effect_image_animation_context_free() function.
27705 * char buf[PATH_MAX];
27706 * Eina_List *images = NULL;
27707 * Elm_Transit *transi = elm_transit_add();
27709 * snprintf(buf, sizeof(buf), "%s/images/icon_11.png", PACKAGE_DATA_DIR);
27710 * images = eina_list_append(images, eina_stringshare_add(buf));
27712 * snprintf(buf, sizeof(buf), "%s/images/logo_small.png", PACKAGE_DATA_DIR);
27713 * images = eina_list_append(images, eina_stringshare_add(buf));
27714 * elm_transit_effect_image_animation_add(transi, images);
27718 * @see elm_transit_effect_add()
27720 * @param transit Transit object.
27721 * @param images Eina_List of images file paths. This list and
27722 * its contents will be deleted at the end of the effect by
27723 * elm_transit_effect_image_animation_context_free() function.
27724 * @return Image Animation effect context data.
27728 EAPI Elm_Transit_Effect *elm_transit_effect_image_animation_add(Elm_Transit *transit, Eina_List *images);
27733 typedef struct _Elm_Store Elm_Store;
27734 typedef struct _Elm_Store_Filesystem Elm_Store_Filesystem;
27735 typedef struct _Elm_Store_Item Elm_Store_Item;
27736 typedef struct _Elm_Store_Item_Filesystem Elm_Store_Item_Filesystem;
27737 typedef struct _Elm_Store_Item_Info Elm_Store_Item_Info;
27738 typedef struct _Elm_Store_Item_Info_Filesystem Elm_Store_Item_Info_Filesystem;
27739 typedef struct _Elm_Store_Item_Mapping Elm_Store_Item_Mapping;
27740 typedef struct _Elm_Store_Item_Mapping_Empty Elm_Store_Item_Mapping_Empty;
27741 typedef struct _Elm_Store_Item_Mapping_Icon Elm_Store_Item_Mapping_Icon;
27742 typedef struct _Elm_Store_Item_Mapping_Photo Elm_Store_Item_Mapping_Photo;
27743 typedef struct _Elm_Store_Item_Mapping_Custom Elm_Store_Item_Mapping_Custom;
27745 typedef Eina_Bool (*Elm_Store_Item_List_Cb) (void *data, Elm_Store_Item_Info *info);
27746 typedef void (*Elm_Store_Item_Fetch_Cb) (void *data, Elm_Store_Item *sti);
27747 typedef void (*Elm_Store_Item_Unfetch_Cb) (void *data, Elm_Store_Item *sti);
27748 typedef void *(*Elm_Store_Item_Mapping_Cb) (void *data, Elm_Store_Item *sti, const char *part);
27752 ELM_STORE_ITEM_MAPPING_NONE = 0,
27753 ELM_STORE_ITEM_MAPPING_LABEL, // const char * -> label
27754 ELM_STORE_ITEM_MAPPING_STATE, // Eina_Bool -> state
27755 ELM_STORE_ITEM_MAPPING_ICON, // char * -> icon path
27756 ELM_STORE_ITEM_MAPPING_PHOTO, // char * -> photo path
27757 ELM_STORE_ITEM_MAPPING_CUSTOM, // item->custom(it->data, it, part) -> void * (-> any)
27758 // can add more here as needed by common apps
27759 ELM_STORE_ITEM_MAPPING_LAST
27760 } Elm_Store_Item_Mapping_Type;
27762 struct _Elm_Store_Item_Mapping_Icon
27764 // FIXME: allow edje file icons
27766 Elm_Icon_Lookup_Order lookup_order;
27767 Eina_Bool standard_name : 1;
27768 Eina_Bool no_scale : 1;
27769 Eina_Bool smooth : 1;
27770 Eina_Bool scale_up : 1;
27771 Eina_Bool scale_down : 1;
27774 struct _Elm_Store_Item_Mapping_Empty
27779 struct _Elm_Store_Item_Mapping_Photo
27784 struct _Elm_Store_Item_Mapping_Custom
27786 Elm_Store_Item_Mapping_Cb func;
27789 struct _Elm_Store_Item_Mapping
27791 Elm_Store_Item_Mapping_Type type;
27796 Elm_Store_Item_Mapping_Empty empty;
27797 Elm_Store_Item_Mapping_Icon icon;
27798 Elm_Store_Item_Mapping_Photo photo;
27799 Elm_Store_Item_Mapping_Custom custom;
27800 // add more types here
27804 struct _Elm_Store_Item_Info
27806 Elm_Genlist_Item_Class *item_class;
27807 const Elm_Store_Item_Mapping *mapping;
27812 struct _Elm_Store_Item_Info_Filesystem
27814 Elm_Store_Item_Info base;
27818 #define ELM_STORE_ITEM_MAPPING_END { ELM_STORE_ITEM_MAPPING_NONE, NULL, 0, { .empty = { EINA_TRUE } } }
27819 #define ELM_STORE_ITEM_MAPPING_OFFSET(st, it) offsetof(st, it)
27821 EAPI void elm_store_free(Elm_Store *st);
27823 EAPI Elm_Store *elm_store_filesystem_new(void);
27824 EAPI void elm_store_filesystem_directory_set(Elm_Store *st, const char *dir) EINA_ARG_NONNULL(1);
27825 EAPI const char *elm_store_filesystem_directory_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
27826 EAPI const char *elm_store_item_filesystem_path_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27828 EAPI void elm_store_target_genlist_set(Elm_Store *st, Evas_Object *obj) EINA_ARG_NONNULL(1);
27830 EAPI void elm_store_cache_set(Elm_Store *st, int max) EINA_ARG_NONNULL(1);
27831 EAPI int elm_store_cache_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
27832 EAPI void elm_store_list_func_set(Elm_Store *st, Elm_Store_Item_List_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
27833 EAPI void elm_store_fetch_func_set(Elm_Store *st, Elm_Store_Item_Fetch_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
27834 EAPI void elm_store_fetch_thread_set(Elm_Store *st, Eina_Bool use_thread) EINA_ARG_NONNULL(1);
27835 EAPI Eina_Bool elm_store_fetch_thread_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
27837 EAPI void elm_store_unfetch_func_set(Elm_Store *st, Elm_Store_Item_Unfetch_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
27838 EAPI void elm_store_sorted_set(Elm_Store *st, Eina_Bool sorted) EINA_ARG_NONNULL(1);
27839 EAPI Eina_Bool elm_store_sorted_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
27840 EAPI void elm_store_item_data_set(Elm_Store_Item *sti, void *data) EINA_ARG_NONNULL(1);
27841 EAPI void *elm_store_item_data_get(Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27842 EAPI const Elm_Store *elm_store_item_store_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27843 EAPI const Elm_Genlist_Item *elm_store_item_genlist_item_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27846 * @defgroup SegmentControl SegmentControl
27847 * @ingroup Elementary
27849 * @image html img/widget/segment_control/preview-00.png
27850 * @image latex img/widget/segment_control/preview-00.eps width=\textwidth
27852 * @image html img/segment_control.png
27853 * @image latex img/segment_control.eps width=\textwidth
27855 * Segment control widget is a horizontal control made of multiple segment
27856 * items, each segment item functioning similar to discrete two state button.
27857 * A segment control groups the items together and provides compact
27858 * single button with multiple equal size segments.
27860 * Segment item size is determined by base widget
27861 * size and the number of items added.
27862 * Only one segment item can be at selected state. A segment item can display
27863 * combination of Text and any Evas_Object like Images or other widget.
27865 * Smart callbacks one can listen to:
27866 * - "changed" - When the user clicks on a segment item which is not
27867 * previously selected and get selected. The event_info parameter is the
27868 * segment item pointer.
27870 * Available styles for it:
27873 * Here is an example on its usage:
27874 * @li @ref segment_control_example
27878 * @addtogroup SegmentControl
27882 typedef struct _Elm_Segment_Item Elm_Segment_Item; /**< Item handle for a segment control widget. */
27885 * Add a new segment control widget to the given parent Elementary
27886 * (container) object.
27888 * @param parent The parent object.
27889 * @return a new segment control widget handle or @c NULL, on errors.
27891 * This function inserts a new segment control widget on the canvas.
27893 * @ingroup SegmentControl
27895 EAPI Evas_Object *elm_segment_control_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
27898 * Append a new item to the segment control object.
27900 * @param obj The segment control object.
27901 * @param icon The icon object to use for the left side of the item. An
27902 * icon can be any Evas object, but usually it is an icon created
27903 * with elm_icon_add().
27904 * @param label The label of the item.
27905 * Note that, NULL is different from empty string "".
27906 * @return The created item or @c NULL upon failure.
27908 * A new item will be created and appended to the segment control, i.e., will
27909 * be set as @b last item.
27911 * If it should be inserted at another position,
27912 * elm_segment_control_item_insert_at() should be used instead.
27914 * Items created with this function can be deleted with function
27915 * elm_segment_control_item_del() or elm_segment_control_item_del_at().
27917 * @note @p label set to @c NULL is different from empty string "".
27919 * only has icon, it will be displayed bigger and centered. If it has
27920 * icon and label, even that an empty string, icon will be smaller and
27921 * positioned at left.
27925 * sc = elm_segment_control_add(win);
27926 * ic = elm_icon_add(win);
27927 * elm_icon_file_set(ic, "path/to/image", NULL);
27928 * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
27929 * elm_segment_control_item_add(sc, ic, "label");
27930 * evas_object_show(sc);
27933 * @see elm_segment_control_item_insert_at()
27934 * @see elm_segment_control_item_del()
27936 * @ingroup SegmentControl
27938 EAPI Elm_Segment_Item *elm_segment_control_item_add(Evas_Object *obj, Evas_Object *icon, const char *label) EINA_ARG_NONNULL(1);
27941 * Insert a new item to the segment control object at specified position.
27943 * @param obj The segment control object.
27944 * @param icon The icon object to use for the left side of the item. An
27945 * icon can be any Evas object, but usually it is an icon created
27946 * with elm_icon_add().
27947 * @param label The label of the item.
27948 * @param index Item position. Value should be between 0 and items count.
27949 * @return The created item or @c NULL upon failure.
27951 * Index values must be between @c 0, when item will be prepended to
27952 * segment control, and items count, that can be get with
27953 * elm_segment_control_item_count_get(), case when item will be appended
27954 * to segment control, just like elm_segment_control_item_add().
27956 * Items created with this function can be deleted with function
27957 * elm_segment_control_item_del() or elm_segment_control_item_del_at().
27959 * @note @p label set to @c NULL is different from empty string "".
27961 * only has icon, it will be displayed bigger and centered. If it has
27962 * icon and label, even that an empty string, icon will be smaller and
27963 * positioned at left.
27965 * @see elm_segment_control_item_add()
27966 * @see elm_segment_control_item_count_get()
27967 * @see elm_segment_control_item_del()
27969 * @ingroup SegmentControl
27971 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);
27974 * Remove a segment control item from its parent, deleting it.
27976 * @param it The item to be removed.
27978 * Items can be added with elm_segment_control_item_add() or
27979 * elm_segment_control_item_insert_at().
27981 * @ingroup SegmentControl
27983 EAPI void elm_segment_control_item_del(Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
27986 * Remove a segment control item at given index from its parent,
27989 * @param obj The segment control object.
27990 * @param index The position of the segment control item to be deleted.
27992 * Items can be added with elm_segment_control_item_add() or
27993 * elm_segment_control_item_insert_at().
27995 * @ingroup SegmentControl
27997 EAPI void elm_segment_control_item_del_at(Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
28000 * Get the Segment items count from segment control.
28002 * @param obj The segment control object.
28003 * @return Segment items count.
28005 * It will just return the number of items added to segment control @p obj.
28007 * @ingroup SegmentControl
28009 EAPI int elm_segment_control_item_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
28012 * Get the item placed at specified index.
28014 * @param obj The segment control object.
28015 * @param index The index of the segment item.
28016 * @return The segment control item or @c NULL on failure.
28018 * Index is the position of an item in segment control widget. Its
28019 * range is from @c 0 to <tt> count - 1 </tt>.
28020 * Count is the number of items, that can be get with
28021 * elm_segment_control_item_count_get().
28023 * @ingroup SegmentControl
28025 EAPI Elm_Segment_Item *elm_segment_control_item_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
28028 * Get the label of item.
28030 * @param obj The segment control object.
28031 * @param index The index of the segment item.
28032 * @return The label of the item at @p index.
28034 * The return value is a pointer to the label associated to the item when
28035 * it was created, with function elm_segment_control_item_add(), or later
28036 * with function elm_segment_control_item_label_set. If no label
28037 * was passed as argument, it will return @c NULL.
28039 * @see elm_segment_control_item_label_set() for more details.
28040 * @see elm_segment_control_item_add()
28042 * @ingroup SegmentControl
28044 EAPI const char *elm_segment_control_item_label_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
28047 * Set the label of item.
28049 * @param it The item of segment control.
28050 * @param text The label of item.
28052 * The label to be displayed by the item.
28053 * Label will be at right of the icon (if set).
28055 * If a label was passed as argument on item creation, with function
28056 * elm_control_segment_item_add(), it will be already
28057 * displayed by the item.
28059 * @see elm_segment_control_item_label_get()
28060 * @see elm_segment_control_item_add()
28062 * @ingroup SegmentControl
28064 EAPI void elm_segment_control_item_label_set(Elm_Segment_Item* it, const char* label) EINA_ARG_NONNULL(1);
28067 * Get the icon associated to the item.
28069 * @param obj The segment control object.
28070 * @param index The index of the segment item.
28071 * @return The left side icon associated to the item at @p index.
28073 * The return value is a pointer to the icon associated to the item when
28074 * it was created, with function elm_segment_control_item_add(), or later
28075 * with function elm_segment_control_item_icon_set(). If no icon
28076 * was passed as argument, it will return @c NULL.
28078 * @see elm_segment_control_item_add()
28079 * @see elm_segment_control_item_icon_set()
28081 * @ingroup SegmentControl
28083 EAPI Evas_Object *elm_segment_control_item_icon_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
28086 * Set the icon associated to the item.
28088 * @param it The segment control item.
28089 * @param icon The icon object to associate with @p it.
28091 * The icon object to use at left side of the item. An
28092 * icon can be any Evas object, but usually it is an icon created
28093 * with elm_icon_add().
28095 * Once the icon object is set, a previously set one will be deleted.
28096 * @warning Setting the same icon for two items will cause the icon to
28097 * dissapear from the first item.
28099 * If an icon was passed as argument on item creation, with function
28100 * elm_segment_control_item_add(), it will be already
28101 * associated to the item.
28103 * @see elm_segment_control_item_add()
28104 * @see elm_segment_control_item_icon_get()
28106 * @ingroup SegmentControl
28108 EAPI void elm_segment_control_item_icon_set(Elm_Segment_Item *it, Evas_Object *icon) EINA_ARG_NONNULL(1);
28111 * Get the index of an item.
28113 * @param it The segment control item.
28114 * @return The position of item in segment control widget.
28116 * Index is the position of an item in segment control widget. Its
28117 * range is from @c 0 to <tt> count - 1 </tt>.
28118 * Count is the number of items, that can be get with
28119 * elm_segment_control_item_count_get().
28121 * @ingroup SegmentControl
28123 EAPI int elm_segment_control_item_index_get(const Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
28126 * Get the base object of the item.
28128 * @param it The segment control item.
28129 * @return The base object associated with @p it.
28131 * Base object is the @c Evas_Object that represents that item.
28133 * @ingroup SegmentControl
28135 EAPI Evas_Object *elm_segment_control_item_object_get(const Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
28138 * Get the selected item.
28140 * @param obj The segment control object.
28141 * @return The selected item or @c NULL if none of segment items is
28144 * The selected item can be unselected with function
28145 * elm_segment_control_item_selected_set().
28147 * The selected item always will be highlighted on segment control.
28149 * @ingroup SegmentControl
28151 EAPI Elm_Segment_Item *elm_segment_control_item_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
28154 * Set the selected state of an item.
28156 * @param it The segment control item
28157 * @param select The selected state
28159 * This sets the selected state of the given item @p it.
28160 * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
28162 * If a new item is selected the previosly selected will be unselected.
28163 * Previoulsy selected item can be get with function
28164 * elm_segment_control_item_selected_get().
28166 * The selected item always will be highlighted on segment control.
28168 * @see elm_segment_control_item_selected_get()
28170 * @ingroup SegmentControl
28172 EAPI void elm_segment_control_item_selected_set(Elm_Segment_Item *it, Eina_Bool select) EINA_ARG_NONNULL(1);
28179 * @defgroup Grid Grid
28181 * The grid is a grid layout widget that lays out a series of children as a
28182 * fixed "grid" of widgets using a given percentage of the grid width and
28183 * height each using the child object.
28185 * The Grid uses a "Virtual resolution" that is stretched to fill the grid
28186 * widgets size itself. The default is 100 x 100, so that means the
28187 * position and sizes of children will effectively be percentages (0 to 100)
28188 * of the width or height of the grid widget
28194 * Add a new grid to the parent
28196 * @param parent The parent object
28197 * @return The new object or NULL if it cannot be created
28201 EAPI Evas_Object *elm_grid_add(Evas_Object *parent);
28204 * Set the virtual size of the grid
28206 * @param obj The grid object
28207 * @param w The virtual width of the grid
28208 * @param h The virtual height of the grid
28212 EAPI void elm_grid_size_set(Evas_Object *obj, int w, int h);
28215 * Get the virtual size of the grid
28217 * @param obj The grid object
28218 * @param w Pointer to integer to store the virtual width of the grid
28219 * @param h Pointer to integer to store the virtual height of the grid
28223 EAPI void elm_grid_size_get(Evas_Object *obj, int *w, int *h);
28226 * Pack child at given position and size
28228 * @param obj The grid object
28229 * @param subobj The child to pack
28230 * @param x The virtual x coord at which to pack it
28231 * @param y The virtual y coord at which to pack it
28232 * @param w The virtual width at which to pack it
28233 * @param h The virtual height at which to pack it
28237 EAPI void elm_grid_pack(Evas_Object *obj, Evas_Object *subobj, int x, int y, int w, int h);
28240 * Unpack a child from a grid object
28242 * @param obj The grid object
28243 * @param subobj The child to unpack
28247 EAPI void elm_grid_unpack(Evas_Object *obj, Evas_Object *subobj);
28250 * Faster way to remove all child objects from a grid object.
28252 * @param obj The grid object
28253 * @param clear If true, it will delete just removed children
28257 EAPI void elm_grid_clear(Evas_Object *obj, Eina_Bool clear);
28260 * Set packing of an existing child at to position and size
28262 * @param subobj The child to set packing of
28263 * @param x The virtual x coord at which to pack it
28264 * @param y The virtual y coord at which to pack it
28265 * @param w The virtual width at which to pack it
28266 * @param h The virtual height at which to pack it
28270 EAPI void elm_grid_pack_set(Evas_Object *subobj, int x, int y, int w, int h);
28273 * get packing of a child
28275 * @param subobj The child to query
28276 * @param x Pointer to integer to store the virtual x coord
28277 * @param y Pointer to integer to store the virtual y coord
28278 * @param w Pointer to integer to store the virtual width
28279 * @param h Pointer to integer to store the virtual height
28283 EAPI void elm_grid_pack_get(Evas_Object *subobj, int *x, int *y, int *w, int *h);
28289 EAPI Evas_Object *elm_factory_add(Evas_Object *parent);
28290 EINA_DEPRECATED EAPI void elm_factory_content_set(Evas_Object *obj, Evas_Object *content);
28291 EINA_DEPRECATED EAPI Evas_Object *elm_factory_content_get(const Evas_Object *obj);
28292 EAPI void elm_factory_maxmin_mode_set(Evas_Object *obj, Eina_Bool enabled);
28293 EAPI Eina_Bool elm_factory_maxmin_mode_get(const Evas_Object *obj);
28294 EAPI void elm_factory_maxmin_reset_set(Evas_Object *obj);
28297 * @defgroup Video Video
28299 * @addtogroup Video
28302 * Elementary comes with two object that help design application that need
28303 * to display video. The main one, Elm_Video, display a video by using Emotion.
28304 * It does embedded the video inside an Edje object, so you can do some
28305 * animation depending on the video state change. It does also implement a
28306 * ressource management policy to remove this burden from the application writer.
28308 * The second one, Elm_Player is a video player that need to be linked with and Elm_Video.
28309 * It take care of updating its content according to Emotion event and provide a
28310 * way to theme itself. It also does automatically raise the priority of the
28311 * linked Elm_Video so it will use the video decoder if available. It also does
28312 * activate the remember function on the linked Elm_Video object.
28314 * Signals that you can add callback for are :
28316 * "forward,clicked" - the user clicked the forward button.
28317 * "info,clicked" - the user clicked the info button.
28318 * "next,clicked" - the user clicked the next button.
28319 * "pause,clicked" - the user clicked the pause button.
28320 * "play,clicked" - the user clicked the play button.
28321 * "prev,clicked" - the user clicked the prev button.
28322 * "rewind,clicked" - the user clicked the rewind button.
28323 * "stop,clicked" - the user clicked the stop button.
28325 * Default contents parts of the player widget that you can use for are:
28326 * @li "video" - A video of the player
28331 * @brief Add a new Elm_Player object to the given parent Elementary (container) object.
28333 * @param parent The parent object
28334 * @return a new player widget handle or @c NULL, on errors.
28336 * This function inserts a new player widget on the canvas.
28338 * @see elm_object_part_content_set()
28342 EAPI Evas_Object *elm_player_add(Evas_Object *parent);
28345 * @brief Link a Elm_Payer with an Elm_Video object.
28347 * @param player the Elm_Player object.
28348 * @param video The Elm_Video object.
28350 * This mean that action on the player widget will affect the
28351 * video object and the state of the video will be reflected in
28352 * the player itself.
28354 * @see elm_player_add()
28355 * @see elm_video_add()
28356 * @deprecated use elm_object_part_content_set() instead
28360 EINA_DEPRECATED EAPI void elm_player_video_set(Evas_Object *player, Evas_Object *video);
28363 * @brief Add a new Elm_Video object to the given parent Elementary (container) object.
28365 * @param parent The parent object
28366 * @return a new video widget handle or @c NULL, on errors.
28368 * This function inserts a new video widget on the canvas.
28370 * @seeelm_video_file_set()
28371 * @see elm_video_uri_set()
28375 EAPI Evas_Object *elm_video_add(Evas_Object *parent);
28378 * @brief Define the file that will be the video source.
28380 * @param video The video object to define the file for.
28381 * @param filename The file to target.
28383 * This function will explicitly define a filename as a source
28384 * for the video of the Elm_Video object.
28386 * @see elm_video_uri_set()
28387 * @see elm_video_add()
28388 * @see elm_player_add()
28392 EAPI void elm_video_file_set(Evas_Object *video, const char *filename);
28395 * @brief Define the uri that will be the video source.
28397 * @param video The video object to define the file for.
28398 * @param uri The uri to target.
28400 * This function will define an uri as a source for the video of the
28401 * Elm_Video object. URI could be remote source of video, like http:// or local source
28402 * like for example WebCam who are most of the time v4l2:// (but that depend and
28403 * you should use Emotion API to request and list the available Webcam on your system).
28405 * @see elm_video_file_set()
28406 * @see elm_video_add()
28407 * @see elm_player_add()
28411 EAPI void elm_video_uri_set(Evas_Object *video, const char *uri);
28414 * @brief Get the underlying Emotion object.
28416 * @param video The video object to proceed the request on.
28417 * @return the underlying Emotion object.
28421 EAPI Evas_Object *elm_video_emotion_get(const Evas_Object *video);
28424 * @brief Start to play the video
28426 * @param video The video object to proceed the request on.
28428 * Start to play the video and cancel all suspend state.
28432 EAPI void elm_video_play(Evas_Object *video);
28435 * @brief Pause the video
28437 * @param video The video object to proceed the request on.
28439 * Pause the video and start a timer to trigger suspend mode.
28443 EAPI void elm_video_pause(Evas_Object *video);
28446 * @brief Stop the video
28448 * @param video The video object to proceed the request on.
28450 * Stop the video and put the emotion in deep sleep mode.
28454 EAPI void elm_video_stop(Evas_Object *video);
28457 * @brief Is the video actually playing.
28459 * @param video The video object to proceed the request on.
28460 * @return EINA_TRUE if the video is actually playing.
28462 * You should consider watching event on the object instead of polling
28463 * the object state.
28467 EAPI Eina_Bool elm_video_is_playing(const Evas_Object *video);
28470 * @brief Is it possible to seek inside the video.
28472 * @param video The video object to proceed the request on.
28473 * @return EINA_TRUE if is possible to seek inside the video.
28477 EAPI Eina_Bool elm_video_is_seekable(const Evas_Object *video);
28480 * @brief Is the audio muted.
28482 * @param video The video object to proceed the request on.
28483 * @return EINA_TRUE if the audio is muted.
28487 EAPI Eina_Bool elm_video_audio_mute_get(const Evas_Object *video);
28490 * @brief Change the mute state of the Elm_Video object.
28492 * @param video The video object to proceed the request on.
28493 * @param mute The new mute state.
28497 EAPI void elm_video_audio_mute_set(Evas_Object *video, Eina_Bool mute);
28500 * @brief Get the audio level of the current video.
28502 * @param video The video object to proceed the request on.
28503 * @return the current audio level.
28507 EAPI double elm_video_audio_level_get(const Evas_Object *video);
28510 * @brief Set the audio level of anElm_Video object.
28512 * @param video The video object to proceed the request on.
28513 * @param volume The new audio volume.
28517 EAPI void elm_video_audio_level_set(Evas_Object *video, double volume);
28519 EAPI double elm_video_play_position_get(const Evas_Object *video);
28520 EAPI void elm_video_play_position_set(Evas_Object *video, double position);
28521 EAPI double elm_video_play_length_get(const Evas_Object *video);
28522 EAPI void elm_video_remember_position_set(Evas_Object *video, Eina_Bool remember);
28523 EAPI Eina_Bool elm_video_remember_position_get(const Evas_Object *video);
28524 EAPI const char *elm_video_title_get(const Evas_Object *video);
28530 * @defgroup Naviframe Naviframe
28531 * @ingroup Elementary
28533 * @brief Naviframe is a kind of view manager for the applications.
28535 * Naviframe provides functions to switch different pages with stack
28536 * mechanism. It means if one page(item) needs to be changed to the new one,
28537 * then naviframe would push the new page to it's internal stack. Of course,
28538 * it can be back to the previous page by popping the top page. Naviframe
28539 * provides some transition effect while the pages are switching (same as
28542 * Since each item could keep the different styles, users could keep the
28543 * same look & feel for the pages or different styles for the items in it's
28546 * Signals that you can add callback for are:
28547 * @li "transition,finished" - When the transition is finished in changing
28549 * @li "title,clicked" - User clicked title area
28551 * Default contents parts of the naviframe items that you can use for are:
28552 * @li "default" - A main content of the page
28553 * @li "icon" - An icon in the title area
28554 * @li "prev_btn" - A button to go to the previous page
28555 * @li "next_btn" - A button to go to the next page
28557 * Default text parts of the naviframe items that you can use for are:
28558 * @li "default" - Title label in the title area
28559 * @li "subtitle" - Sub-title label in the title area
28561 * @ref tutorial_naviframe gives a good overview of the usage of the API.
28565 * @addtogroup Naviframe
28570 * @brief Add a new Naviframe object to the parent.
28572 * @param parent Parent object
28573 * @return New object or @c NULL, if it cannot be created
28575 * @ingroup Naviframe
28577 EAPI Evas_Object *elm_naviframe_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
28579 * @brief Push a new item to the top of the naviframe stack (and show it).
28581 * @param obj The naviframe object
28582 * @param title_label The label in the title area. The name of the title
28583 * label part is "elm.text.title"
28584 * @param prev_btn The button to go to the previous item. If it is NULL,
28585 * then naviframe will create a back button automatically. The name of
28586 * the prev_btn part is "elm.swallow.prev_btn"
28587 * @param next_btn The button to go to the next item. Or It could be just an
28588 * extra function button. The name of the next_btn part is
28589 * "elm.swallow.next_btn"
28590 * @param content The main content object. The name of content part is
28591 * "elm.swallow.content"
28592 * @param item_style The current item style name. @c NULL would be default.
28593 * @return The created item or @c NULL upon failure.
28595 * The item pushed becomes one page of the naviframe, this item will be
28596 * deleted when it is popped.
28598 * @see also elm_naviframe_item_style_set()
28599 * @see also elm_naviframe_item_insert_before()
28600 * @see also elm_naviframe_item_insert_after()
28602 * The following styles are available for this item:
28605 * @ingroup Naviframe
28607 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);
28609 * @brief Insert a new item into the naviframe before item @p before.
28611 * @param before The naviframe item to insert before.
28612 * @param title_label The label in the title area. The name of the title
28613 * label part is "elm.text.title"
28614 * @param prev_btn The button to go to the previous item. If it is NULL,
28615 * then naviframe will create a back button automatically. The name of
28616 * the prev_btn part is "elm.swallow.prev_btn"
28617 * @param next_btn The button to go to the next item. Or It could be just an
28618 * extra function button. The name of the next_btn part is
28619 * "elm.swallow.next_btn"
28620 * @param content The main content object. The name of content part is
28621 * "elm.swallow.content"
28622 * @param item_style The current item style name. @c NULL would be default.
28623 * @return The created item or @c NULL upon failure.
28625 * The item is inserted into the naviframe straight away without any
28626 * transition operations. This item will be deleted when it is popped.
28628 * @see also elm_naviframe_item_style_set()
28629 * @see also elm_naviframe_item_push()
28630 * @see also elm_naviframe_item_insert_after()
28632 * The following styles are available for this item:
28635 * @ingroup Naviframe
28637 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);
28639 * @brief Insert a new item into the naviframe after item @p after.
28641 * @param after The naviframe item to insert after.
28642 * @param title_label The label in the title area. The name of the title
28643 * label part is "elm.text.title"
28644 * @param prev_btn The button to go to the previous item. If it is NULL,
28645 * then naviframe will create a back button automatically. The name of
28646 * the prev_btn part is "elm.swallow.prev_btn"
28647 * @param next_btn The button to go to the next item. Or It could be just an
28648 * extra function button. The name of the next_btn part is
28649 * "elm.swallow.next_btn"
28650 * @param content The main content object. The name of content part is
28651 * "elm.swallow.content"
28652 * @param item_style The current item style name. @c NULL would be default.
28653 * @return The created item or @c NULL upon failure.
28655 * The item is inserted into the naviframe straight away without any
28656 * transition operations. This item will be deleted when it is popped.
28658 * @see also elm_naviframe_item_style_set()
28659 * @see also elm_naviframe_item_push()
28660 * @see also elm_naviframe_item_insert_before()
28662 * The following styles are available for this item:
28665 * @ingroup Naviframe
28667 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);
28669 * @brief Pop an item that is on top of the stack
28671 * @param obj The naviframe object
28672 * @return @c NULL or the content object(if the
28673 * elm_naviframe_content_preserve_on_pop_get is true).
28675 * This pops an item that is on the top(visible) of the naviframe, makes it
28676 * disappear, then deletes the item. The item that was underneath it on the
28677 * stack will become visible.
28679 * @see also elm_naviframe_content_preserve_on_pop_get()
28681 * @ingroup Naviframe
28683 EAPI Evas_Object *elm_naviframe_item_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
28685 * @brief Pop the items between the top and the above one on the given item.
28687 * @param it The naviframe item
28689 * @ingroup Naviframe
28691 EAPI void elm_naviframe_item_pop_to(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
28693 * Promote an item already in the naviframe stack to the top of the stack
28695 * @param it The naviframe item
28697 * This will take the indicated item and promote it to the top of the stack
28698 * as if it had been pushed there. The item must already be inside the
28699 * naviframe stack to work.
28702 EAPI void elm_naviframe_item_promote(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
28704 * @brief Delete the given item instantly.
28706 * @param it The naviframe item
28708 * This just deletes the given item from the naviframe item list instantly.
28709 * So this would not emit any signals for view transitions but just change
28710 * the current view if the given item is a top one.
28712 * @ingroup Naviframe
28714 EAPI void elm_naviframe_item_del(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
28716 * @brief preserve the content objects when items are popped.
28718 * @param obj The naviframe object
28719 * @param preserve Enable the preserve mode if EINA_TRUE, disable otherwise
28721 * @see also elm_naviframe_content_preserve_on_pop_get()
28723 * @ingroup Naviframe
28725 EAPI void elm_naviframe_content_preserve_on_pop_set(Evas_Object *obj, Eina_Bool preserve) EINA_ARG_NONNULL(1);
28727 * @brief Get a value whether preserve mode is enabled or not.
28729 * @param obj The naviframe object
28730 * @return If @c EINA_TRUE, preserve mode is enabled
28732 * @see also elm_naviframe_content_preserve_on_pop_set()
28734 * @ingroup Naviframe
28736 EAPI Eina_Bool elm_naviframe_content_preserve_on_pop_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
28738 * @brief Get a top item on the naviframe stack
28740 * @param obj The naviframe object
28741 * @return The top item on the naviframe stack or @c NULL, if the stack is
28744 * @ingroup Naviframe
28746 EAPI Elm_Object_Item *elm_naviframe_top_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
28748 * @brief Get a bottom item on the naviframe stack
28750 * @param obj The naviframe object
28751 * @return The bottom item on the naviframe stack or @c NULL, if the stack is
28754 * @ingroup Naviframe
28756 EAPI Elm_Object_Item *elm_naviframe_bottom_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
28758 * @brief Set an item style
28760 * @param obj The naviframe item
28761 * @param item_style The current item style name. @c NULL would be default
28763 * The following styles are available for this item:
28766 * @see also elm_naviframe_item_style_get()
28768 * @ingroup Naviframe
28770 EAPI void elm_naviframe_item_style_set(Elm_Object_Item *it, const char *item_style) EINA_ARG_NONNULL(1);
28772 * @brief Get an item style
28774 * @param obj The naviframe item
28775 * @return The current item style name
28777 * @see also elm_naviframe_item_style_set()
28779 * @ingroup Naviframe
28781 EAPI const char *elm_naviframe_item_style_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
28783 * @brief Show/Hide the title area
28785 * @param it The naviframe item
28786 * @param visible If @c EINA_TRUE, title area will be visible, hidden
28789 * When the title area is invisible, then the controls would be hidden so as * to expand the content area to full-size.
28791 * @see also elm_naviframe_item_title_visible_get()
28793 * @ingroup Naviframe
28795 EAPI void elm_naviframe_item_title_visible_set(Elm_Object_Item *it, Eina_Bool visible) EINA_ARG_NONNULL(1);
28797 * @brief Get a value whether title area is visible or not.
28799 * @param it The naviframe item
28800 * @return If @c EINA_TRUE, title area is visible
28802 * @see also elm_naviframe_item_title_visible_set()
28804 * @ingroup Naviframe
28806 EAPI Eina_Bool elm_naviframe_item_title_visible_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
28809 * @brief Set creating prev button automatically or not
28811 * @param obj The naviframe object
28812 * @param auto_pushed If @c EINA_TRUE, the previous button(back button) will
28813 * be created internally when you pass the @c NULL to the prev_btn
28814 * parameter in elm_naviframe_item_push
28816 * @see also elm_naviframe_item_push()
28818 EAPI void elm_naviframe_prev_btn_auto_pushed_set(Evas_Object *obj, Eina_Bool auto_pushed) EINA_ARG_NONNULL(1);
28820 * @brief Get a value whether prev button(back button) will be auto pushed or
28823 * @param obj The naviframe object
28824 * @return If @c EINA_TRUE, prev button will be auto pushed.
28826 * @see also elm_naviframe_item_push()
28827 * elm_naviframe_prev_btn_auto_pushed_set()
28829 EAPI Eina_Bool elm_naviframe_prev_btn_auto_pushed_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
28831 * @brief Get a list of all the naviframe items.
28833 * @param obj The naviframe object
28834 * @return An Eina_Inlist* of naviframe items, #Elm_Object_Item,
28835 * or @c NULL on failure.
28837 EAPI Eina_Inlist *elm_naviframe_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
28844 * @defgroup Multibuttonentry Multibuttonentry
28846 * A Multibuttonentry is a widget to allow a user enter text and manage it as a number of buttons
28847 * Each text button is inserted by pressing the "return" key. If there is no space in the current row,
28848 * a new button is added to the next row. When a text button is pressed, it will become focused.
28849 * Backspace removes the focus.
28850 * When the Multibuttonentry loses focus items longer than 1 lines are shrunk to one line.
28852 * Smart callbacks one can register:
28853 * - @c "item,selected" - when item is selected. May be called on backspace key.
28854 * - @c "item,added" - when a new multibuttonentry item is added.
28855 * - @c "item,deleted" - when a multibuttonentry item is deleted.
28856 * - @c "item,clicked" - selected item of multibuttonentry is clicked.
28857 * - @c "clicked" - when multibuttonentry is clicked.
28858 * - @c "focused" - when multibuttonentry is focused.
28859 * - @c "unfocused" - when multibuttonentry is unfocused.
28860 * - @c "expanded" - when multibuttonentry is expanded.
28861 * - @c "shrank" - when multibuttonentry is shrank.
28862 * - @c "shrank,state,changed" - when shrink mode state of multibuttonentry is changed.
28864 * Here is an example on its usage:
28865 * @li @ref multibuttonentry_example
28868 * @addtogroup Multibuttonentry
28872 typedef struct _Multibuttonentry_Item Elm_Multibuttonentry_Item;
28873 typedef Eina_Bool (*Elm_Multibuttonentry_Item_Filter_callback) (Evas_Object *obj, const char *item_label, void *item_data, void *data);
28876 * @brief Add a new multibuttonentry to the parent
28878 * @param parent The parent object
28879 * @return The new object or NULL if it cannot be created
28882 EAPI Evas_Object *elm_multibuttonentry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
28886 * @param obj The multibuttonentry object
28887 * @return The label, or NULL if none
28890 EAPI const char *elm_multibuttonentry_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
28894 * @param obj The multibuttonentry object
28895 * @param label The text label string
28898 EAPI void elm_multibuttonentry_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
28900 * Get the entry of the multibuttonentry object
28902 * @param obj The multibuttonentry object
28903 * @return The entry object, or NULL if none
28906 EAPI Evas_Object *elm_multibuttonentry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
28908 * Get the guide text
28910 * @param obj The multibuttonentry object
28911 * @return The guide text, or NULL if none
28914 EAPI const char * elm_multibuttonentry_guide_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
28916 * Set the guide text
28918 * @param obj The multibuttonentry object
28919 * @param label The guide text string
28922 EAPI void elm_multibuttonentry_guide_text_set(Evas_Object *obj, const char *guidetext) EINA_ARG_NONNULL(1);
28924 * Get the value of shrink_mode state.
28926 * @param obj The multibuttonentry object
28927 * @param the value of shrink mode state.
28930 EAPI int elm_multibuttonentry_shrink_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
28932 * Set/Unset the multibuttonentry to shrink mode state of single line
28934 * @param obj The multibuttonentry object
28935 * @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.
28938 EAPI void elm_multibuttonentry_shrink_mode_set(Evas_Object *obj, int shrink) EINA_ARG_NONNULL(1);
28940 * Prepend a new item to the multibuttonentry
28942 * @param obj The multibuttonentry object
28943 * @param label The label of new item
28944 * @param data The ponter to the data to be attached
28945 * @return A handle to the item added or NULL if not possible
28948 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_prepend(Evas_Object *obj, const char *label, void *data) EINA_ARG_NONNULL(1);
28950 * Append a new item to the multibuttonentry
28952 * @param obj The multibuttonentry object
28953 * @param label The label of new item
28954 * @param data The ponter to the data to be attached
28955 * @return A handle to the item added or NULL if not possible
28958 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_append(Evas_Object *obj, const char *label, void *data) EINA_ARG_NONNULL(1);
28960 * Add a new item to the multibuttonentry before the indicated object
28963 * @param obj The multibuttonentry object
28964 * @param before The item before which to add it
28965 * @param label The label of new item
28966 * @param data The ponter to the data to be attached
28967 * @return A handle to the item added or NULL if not possible
28970 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);
28972 * Add a new item to the multibuttonentry after the indicated object
28974 * @param obj The multibuttonentry object
28975 * @param after The item after which to add it
28976 * @param label The label of new item
28977 * @param data The ponter to the data to be attached
28978 * @return A handle to the item added or NULL if not possible
28981 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);
28983 * Get a list of items in the multibuttonentry
28985 * @param obj The multibuttonentry object
28986 * @return The list of items, or NULL if none
28989 EAPI const Eina_List *elm_multibuttonentry_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
28991 * Get the first item in the multibuttonentry
28993 * @param obj The multibuttonentry object
28994 * @return The first item, or NULL if none
28997 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
28999 * Get the last item in the multibuttonentry
29001 * @param obj The multibuttonentry object
29002 * @return The last item, or NULL if none
29005 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
29007 * Get the selected item in the multibuttonentry
29009 * @param obj The multibuttonentry object
29010 * @return The selected item, or NULL if none
29013 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
29015 * Set the selected state of an item
29017 * @param item The item
29018 * @param selected if it's EINA_TRUE, select the item otherwise, unselect the item
29021 EAPI void elm_multibuttonentry_item_select(Elm_Multibuttonentry_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
29023 * unselect all items.
29025 * @param obj The multibuttonentry object
29028 EAPI void elm_multibuttonentry_item_unselect_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
29030 * Delete a given item
29032 * @param item The item
29035 EAPI void elm_multibuttonentry_item_del(Elm_Multibuttonentry_Item *item) EINA_ARG_NONNULL(1);
29037 * Remove all items in the multibuttonentry.
29039 * @param obj The multibuttonentry object
29042 EAPI void elm_multibuttonentry_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
29044 * Get the label of a given item
29046 * @param item The item
29047 * @return The label of a given item, or NULL if none
29050 EAPI const char *elm_multibuttonentry_item_label_get(const Elm_Multibuttonentry_Item *item) EINA_ARG_NONNULL(1);
29052 * Set the label of a given item
29054 * @param item The item
29055 * @param label The text label string
29058 EAPI void elm_multibuttonentry_item_label_set(Elm_Multibuttonentry_Item *item, const char *str) EINA_ARG_NONNULL(1);
29060 * Get the previous item in the multibuttonentry
29062 * @param item The item
29063 * @return The item before the item @p item
29066 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_prev_get(const Elm_Multibuttonentry_Item *item) EINA_ARG_NONNULL(1);
29068 * Get the next item in the multibuttonentry
29070 * @param item The item
29071 * @return The item after the item @p item
29074 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_next_get(const Elm_Multibuttonentry_Item *item) EINA_ARG_NONNULL(1);
29076 * Append a item filter function for text inserted in the Multibuttonentry
29078 * Append the given callback to the list. This functions will be called
29079 * whenever any text is inserted into the Multibuttonentry, with the text to be inserted
29080 * as a parameter. The callback function is free to alter the text in any way
29081 * it wants, but it must remember to free the given pointer and update it.
29082 * If the new text is to be discarded, the function can free it and set it text
29083 * parameter to NULL. This will also prevent any following filters from being
29086 * @param obj The multibuttonentryentry object
29087 * @param func The function to use as item filter
29088 * @param data User data to pass to @p func
29091 EAPI void elm_multibuttonentry_item_filter_append(Evas_Object *obj, Elm_Multibuttonentry_Item_Filter_callback func, void *data) EINA_ARG_NONNULL(1);
29093 * Prepend a filter function for text inserted in the Multibuttentry
29095 * Prepend the given callback to the list. See elm_multibuttonentry_item_filter_append()
29096 * for more information
29098 * @param obj The multibuttonentry object
29099 * @param func The function to use as text filter
29100 * @param data User data to pass to @p func
29103 EAPI void elm_multibuttonentry_item_filter_prepend(Evas_Object *obj, Elm_Multibuttonentry_Item_Filter_callback func, void *data) EINA_ARG_NONNULL(1);
29105 * Remove a filter from the list
29107 * Removes the given callback from the filter list. See elm_multibuttonentry_item_filter_append()
29108 * for more information.
29110 * @param obj The multibuttonentry object
29111 * @param func The filter function to remove
29112 * @param data The user data passed when adding the function
29115 EAPI void elm_multibuttonentry_item_filter_remove(Evas_Object *obj, Elm_Multibuttonentry_Item_Filter_callback func, void *data) EINA_ARG_NONNULL(1);