3 * vim:ts=8:sw=3:sts=3:expandtab:cino=>5n-3f0^-2{2(0W1st0
8 @brief Elementary Widget Library
13 @image html elementary.png
17 @section intro What is Elementary?
19 This is a VERY SIMPLE toolkit. It is not meant for writing extensive desktop
20 applications (yet). Small simple ones with simple needs.
22 It is meant to make the programmers work almost brainless but give them lots
25 @li @ref Start - Go here to quickly get started with writing Apps
27 @section organization Organization
29 One can divide Elemementary into three main groups:
30 @li @ref infralist - These are modules that deal with Elementary as a whole.
31 @li @ref widgetslist - These are the widgets you'll compose your UI out of.
32 @li @ref containerslist - These are the containers which hold the widgets.
34 @section license License
36 LGPL v2 (see COPYING in the base of Elementary's source). This applies to
37 all files in the source tree.
39 @section ack Acknowledgements
40 There is a lot that goes into making a widget set, and they don't happen out of
41 nothing. It's like trying to make everyone everywhere happy, regardless of age,
42 gender, race or nationality - and that is really tough. So thanks to people and
43 organisations behind this, as listed in the @ref authors page.
48 * @defgroup Start Getting Started
50 * To write an Elementary app, you can get started with the following:
53 #include <Elementary.h>
55 elm_main(int argc, char **argv)
57 // create window(s) here and do any application init
58 elm_run(); // run main loop
59 elm_shutdown(); // after mainloop finishes running, shutdown
60 return 0; // exit 0 for exit code
65 * To use autotools (which helps in many ways in the long run, like being able
66 * to immediately create releases of your software directly from your tree
67 * and ensure everything needed to build it is there) you will need a
68 * configure.ac, Makefile.am and autogen.sh file.
73 AC_INIT(myapp, 0.0.0, myname@mydomain.com)
75 AC_CONFIG_SRCDIR(configure.ac)
76 AM_CONFIG_HEADER(config.h)
78 AM_INIT_AUTOMAKE(1.6 dist-bzip2)
79 PKG_CHECK_MODULES([ELEMENTARY], elementary)
86 AUTOMAKE_OPTIONS = 1.4 foreign
87 MAINTAINERCLEANFILES = Makefile.in aclocal.m4 config.h.in configure depcomp install-sh missing
89 INCLUDES = -I$(top_srcdir)
93 myapp_SOURCES = main.c
94 myapp_LDADD = @ELEMENTARY_LIBS@
95 myapp_CFLAGS = @ELEMENTARY_CFLAGS@
102 echo "Running aclocal..." ; aclocal $ACLOCAL_FLAGS || exit 1
103 echo "Running autoheader..." ; autoheader || exit 1
104 echo "Running autoconf..." ; autoconf || exit 1
105 echo "Running automake..." ; automake --add-missing --copy --gnu || exit 1
109 * To generate all the things needed to bootstrap just run:
115 * This will generate Makefile.in's, the confgure script and everything else.
116 * After this it works like all normal autotools projects:
123 * Note sudo was assumed to get root permissions, as this would install in
124 * /usr/local which is system-owned. Use any way you like to gain root, or
125 * specify a different prefix with configure:
128 ./confiugre --prefix=$HOME/mysoftware
131 * Also remember that autotools buys you some useful commands like:
136 * This uninstalls the software after it was installed with "make install".
137 * It is very useful to clear up what you built if you wish to clean the
144 * This firstly checks if your build tree is "clean" and ready for
145 * distribution. It also builds a tarball (myapp-0.0.0.tar.gz) that is
146 * ready to upload and distribute to the world, that contains the generated
147 * Makefile.in's and configure script. The users do not need to run
148 * autogen.sh - just configure and on. They don't need autotools installed.
149 * This tarball also builds cleanly, has all the sources it needs to build
150 * included (that is sources for your application, not libraries it depends
151 * on like Elementary). It builds cleanly in a buildroot and does not
152 * contain any files that are temporarily generated like binaries and other
153 * build-generated files, so the tarball is clean, and no need to worry
154 * about cleaning up your tree before packaging.
160 * This cleans up all build files (binaries, objects etc.) from the tree.
166 * This cleans out all files from the build and from configure's output too.
169 make maintainer-clean
172 * This deletes all the files autogen.sh will produce so the tree is clean
173 * to be put into a revision-control system (like CVS, SVN or GIT for example).
175 * There is a more advanced way of making use of the quicklaunch infrastructure
176 * in Elementary (which will not be covered here due to its more advanced
179 * Now let's actually create an interactive "Hello World" gui that you can
180 * click the ok button to exit. It's more code because this now does something
181 * much more significant, but it's still very simple:
184 #include <Elementary.h>
187 on_done(void *data, Evas_Object *obj, void *event_info)
189 // quit the mainloop (elm_run function will return)
194 elm_main(int argc, char **argv)
196 Evas_Object *win, *bg, *box, *lab, *btn;
198 // new window - do the usual and give it a name (hello) and title (Hello)
199 win = elm_win_util_standard_add("hello", "Hello");
200 // when the user clicks "close" on a window there is a request to delete
201 evas_object_smart_callback_add(win, "delete,request", on_done, NULL);
203 // add a box object - default is vertical. a box holds children in a row,
204 // either horizontally or vertically. nothing more.
205 box = elm_box_add(win);
206 // make the box hotizontal
207 elm_box_horizontal_set(box, EINA_TRUE);
208 // add object as a resize object for the window (controls window minimum
209 // size as well as gets resized if window is resized)
210 elm_win_resize_object_add(win, box);
211 evas_object_show(box);
213 // add a label widget, set the text and put it in the pad frame
214 lab = elm_label_add(win);
215 // set default text of the label
216 elm_object_text_set(lab, "Hello out there world!");
217 // pack the label at the end of the box
218 elm_box_pack_end(box, lab);
219 evas_object_show(lab);
222 btn = elm_button_add(win);
223 // set default text of button to "OK"
224 elm_object_text_set(btn, "OK");
225 // pack the button at the end of the box
226 elm_box_pack_end(box, btn);
227 evas_object_show(btn);
228 // call on_done when button is clicked
229 evas_object_smart_callback_add(btn, "clicked", on_done, NULL);
231 // now we are done, show the window
232 evas_object_show(win);
234 // run the mainloop and process events and callbacks
244 @page authors Authors
245 @author Carsten Haitzler <raster@@rasterman.com>
246 @author Gustavo Sverzut Barbieri <barbieri@@profusion.mobi>
247 @author Cedric Bail <cedric.bail@@free.fr>
248 @author Vincent Torri <vtorri@@univ-evry.fr>
249 @author Daniel Kolesa <quaker66@@gmail.com>
250 @author Jaime Thomas <avi.thomas@@gmail.com>
251 @author Swisscom - http://www.swisscom.ch/
252 @author Christopher Michael <devilhorns@@comcast.net>
253 @author Marco Trevisan (TreviƱo) <mail@@3v1n0.net>
254 @author Michael Bouchaud <michael.bouchaud@@gmail.com>
255 @author Jonathan Atton (Watchwolf) <jonathan.atton@@gmail.com>
256 @author Brian Wang <brian.wang.0721@@gmail.com>
257 @author Mike Blumenkrantz (discomfitor/zmike) <michael.blumenkrantz@@gmail.com>
258 @author Samsung Electronics <tbd>
259 @author Samsung SAIT <tbd>
260 @author Brett Nash <nash@@nash.id.au>
261 @author Bruno Dilly <bdilly@@profusion.mobi>
262 @author Rafael Fonseca <rfonseca@@profusion.mobi>
263 @author Chuneon Park <hermet@@hermet.pe.kr>
264 @author Woohyun Jung <wh0705.jung@@samsung.com>
265 @author Jaehwan Kim <jae.hwan.kim@@samsung.com>
266 @author Wonguk Jeong <wonguk.jeong@@samsung.com>
267 @author Leandro A. F. Pereira <leandro@@profusion.mobi>
268 @author Helen Fornazier <helen.fornazier@@profusion.mobi>
269 @author Gustavo Lima Chaves <glima@@profusion.mobi>
270 @author Fabiano FidĆŖncio <fidencio@@profusion.mobi>
271 @author Tiago FalcĆ£o <tiago@@profusion.mobi>
272 @author Otavio Pontes <otavio@@profusion.mobi>
273 @author Viktor Kojouharov <vkojouharov@@gmail.com>
274 @author Daniel Juyung Seo (SeoZ) <juyung.seo@@samsung.com> <seojuyung2@@gmail.com>
275 @author Sangho Park <sangho.g.park@@samsung.com> <gouache95@@gmail.com>
276 @author Rajeev Ranjan (Rajeev) <rajeev.r@@samsung.com> <rajeev.jnnce@@gmail.com>
277 @author Seunggyun Kim <sgyun.kim@@samsung.com> <tmdrbs@@gmail.com>
278 @author Sohyun Kim <anna1014.kim@@samsung.com> <sohyun.anna@@gmail.com>
279 @author Jihoon Kim <jihoon48.kim@@samsung.com>
280 @author Jeonghyun Yun (arosis) <jh0506.yun@@samsung.com>
281 @author Tom Hacohen <tom@@stosb.com>
282 @author Aharon Hillel <a.hillel@@partner.samsung.com>
283 @author Jonathan Atton (Watchwolf) <jonathan.atton@@gmail.com>
284 @author Shinwoo Kim <kimcinoo@@gmail.com>
285 @author Govindaraju SM <govi.sm@@samsung.com> <govism@@gmail.com>
286 @author Prince Kumar Dubey <prince.dubey@@samsung.com> <prince.dubey@@gmail.com>
287 @author Sung W. Park <sungwoo@@gmail.com>
288 @author Thierry el Borgi <thierry@@substantiel.fr>
289 @author Shilpa Singh <shilpa.singh@@samsung.com> <shilpasingh.o@@gmail.com>
290 @author Chanwook Jung <joey.jung@@samsung.com>
291 @author Hyoyoung Chang <hyoyoung.chang@@samsung.com>
292 @author Guillaume "Kuri" Friloux <guillaume.friloux@@asp64.com>
293 @author Kim Yunhan <spbear@@gmail.com>
294 @author Bluezery <ohpowel@@gmail.com>
295 @author Nicolas Aguirre <aguirre.nicolas@@gmail.com>
296 @author Sanjeev BA <iamsanjeev@@gmail.com>
298 Please contact <enlightenment-devel@lists.sourceforge.net> to get in
299 contact with the developers and maintainers.
307 * @brief Elementary's API
312 @ELM_UNIX_DEF@ ELM_UNIX
313 @ELM_WIN32_DEF@ ELM_WIN32
314 @ELM_WINCE_DEF@ ELM_WINCE
315 @ELM_EDBUS_DEF@ ELM_EDBUS
316 @ELM_EFREET_DEF@ ELM_EFREET
317 @ELM_ETHUMB_DEF@ ELM_ETHUMB
318 @ELM_WEB_DEF@ ELM_WEB
319 @ELM_EMAP_DEF@ ELM_EMAP
320 @ELM_DEBUG_DEF@ ELM_DEBUG
321 @ELM_ALLOCA_H_DEF@ ELM_ALLOCA_H
322 @ELM_LIBINTL_H_DEF@ ELM_LIBINTL_H
323 @ELM_DIRENT_H_DEF@ ELM_DIRENT_H
325 /* Standard headers for standard system calls etc. */
330 #include <sys/types.h>
331 #include <sys/stat.h>
332 #include <sys/time.h>
333 #include <sys/param.h>
347 # ifdef ELM_LIBINTL_H
348 # include <libintl.h>
359 #if defined (ELM_WIN32) || defined (ELM_WINCE)
362 # define alloca _alloca
371 // disabled - evas 1.1 won't have this.
372 //#include <Evas_GL.h>
374 #include <Ecore_Evas.h>
375 #include <Ecore_File.h>
376 @ELEMENTARY_ECORE_IMF_INC@
377 @ELEMENTARY_ECORE_CON_INC@
386 # include <Efreet_Mime.h>
387 # include <Efreet_Trash.h>
391 # include <Ethumb_Client.h>
403 # ifdef ELEMENTARY_BUILD
405 # define EAPI __declspec(dllexport)
408 # endif /* ! DLL_EXPORT */
410 # define EAPI __declspec(dllimport)
411 # endif /* ! EFL_EVAS_BUILD */
415 # define EAPI __attribute__ ((visibility("default")))
422 #endif /* ! _WIN32 */
427 # define EAPI_MAIN EAPI
430 /* allow usage from c++ */
435 #define ELM_VERSION_MAJOR @VMAJ@
436 #define ELM_VERSION_MINOR @VMIN@
438 typedef struct _Elm_Version
446 EAPI extern Elm_Version *elm_version;
449 #define ELM_RECTS_INTERSECT(x, y, w, h, xx, yy, ww, hh) (((x) < ((xx) + (ww))) && ((y) < ((yy) + (hh))) && (((x) + (w)) > (xx)) && (((y) + (h)) > (yy)))
450 #define ELM_PI 3.14159265358979323846
453 * @defgroup General General
455 * @brief General Elementary API. Functions that don't relate to
456 * Elementary objects specifically.
458 * Here are documented functions which init/shutdown the library,
459 * that apply to generic Elementary objects, that deal with
460 * configuration, et cetera.
462 * @ref general_functions_example_page "This" example contemplates
463 * some of these functions.
467 * @addtogroup General
472 * Defines couple of standard Evas_Object layers to be used
473 * with evas_object_layer_set().
475 * @note whenever extending with new values, try to keep some padding
476 * to siblings so there is room for further extensions.
478 typedef enum _Elm_Object_Layer
480 ELM_OBJECT_LAYER_BACKGROUND = EVAS_LAYER_MIN + 64, /**< where to place backgrounds */
481 ELM_OBJECT_LAYER_DEFAULT = 0, /**< Evas_Object default layer (and thus for Elementary) */
482 ELM_OBJECT_LAYER_FOCUS = EVAS_LAYER_MAX - 128, /**< where focus object visualization is */
483 ELM_OBJECT_LAYER_TOOLTIP = EVAS_LAYER_MAX - 64, /**< where to show tooltips */
484 ELM_OBJECT_LAYER_CURSOR = EVAS_LAYER_MAX - 32, /**< where to show cursors */
485 ELM_OBJECT_LAYER_LAST /**< last layer known by Elementary */
488 /**************************************************************************/
489 EAPI extern int ELM_ECORE_EVENT_ETHUMB_CONNECT;
492 * Emitted when the application has reconfigured elementary settings due
493 * to an external configuration tool asking it to.
495 EAPI extern int ELM_EVENT_CONFIG_ALL_CHANGED;
498 * Emitted when any Elementary's policy value is changed.
500 EAPI extern int ELM_EVENT_POLICY_CHANGED;
503 * @typedef Elm_Event_Policy_Changed
505 * Data on the event when an Elementary policy has changed
507 typedef struct _Elm_Event_Policy_Changed Elm_Event_Policy_Changed;
510 * @struct _Elm_Event_Policy_Changed
512 * Data on the event when an Elementary policy has changed
514 struct _Elm_Event_Policy_Changed
516 unsigned int policy; /**< the policy identifier */
517 int new_value; /**< value the policy had before the change */
518 int old_value; /**< new value the policy got */
522 * Policy identifiers.
524 typedef enum _Elm_Policy
526 ELM_POLICY_QUIT, /**< under which circumstances the application
527 * should quit automatically. @see
531 } Elm_Policy; /**< Elementary policy identifiers/groups enumeration. @see elm_policy_set()
534 typedef enum _Elm_Policy_Quit
536 ELM_POLICY_QUIT_NONE = 0, /**< never quit the application
538 ELM_POLICY_QUIT_LAST_WINDOW_CLOSED /**< quit when the
540 * window is closed */
541 } Elm_Policy_Quit; /**< Possible values for the #ELM_POLICY_QUIT policy */
543 typedef enum _Elm_Focus_Direction
547 } Elm_Focus_Direction;
549 typedef enum _Elm_Text_Format
551 ELM_TEXT_FORMAT_PLAIN_UTF8,
552 ELM_TEXT_FORMAT_MARKUP_UTF8
556 * Line wrapping types.
558 typedef enum _Elm_Wrap_Type
560 ELM_WRAP_NONE = 0, /**< No wrap - value is zero */
561 ELM_WRAP_CHAR, /**< Char wrap - wrap between characters */
562 ELM_WRAP_WORD, /**< Word wrap - wrap in allowed wrapping points (as defined in the unicode standard) */
563 ELM_WRAP_MIXED, /**< Mixed wrap - Word wrap, and if that fails, char wrap. */
569 ELM_INPUT_PANEL_LAYOUT_NORMAL, /**< Default layout */
570 ELM_INPUT_PANEL_LAYOUT_NUMBER, /**< Number layout */
571 ELM_INPUT_PANEL_LAYOUT_EMAIL, /**< Email layout */
572 ELM_INPUT_PANEL_LAYOUT_URL, /**< URL layout */
573 ELM_INPUT_PANEL_LAYOUT_PHONENUMBER, /**< Phone Number layout */
574 ELM_INPUT_PANEL_LAYOUT_IP, /**< IP layout */
575 ELM_INPUT_PANEL_LAYOUT_MONTH, /**< Month layout */
576 ELM_INPUT_PANEL_LAYOUT_NUMBERONLY, /**< Number Only layout */
577 ELM_INPUT_PANEL_LAYOUT_INVALID
578 } Elm_Input_Panel_Layout;
582 ELM_AUTOCAPITAL_TYPE_NONE,
583 ELM_AUTOCAPITAL_TYPE_WORD,
584 ELM_AUTOCAPITAL_TYPE_SENTENCE,
585 ELM_AUTOCAPITAL_TYPE_ALLCHARACTER,
586 } Elm_Autocapital_Type;
589 * @typedef Elm_Object_Item
590 * An Elementary Object item handle.
593 typedef struct _Elm_Object_Item Elm_Object_Item;
597 * Called back when a widget's tooltip is activated and needs content.
598 * @param data user-data given to elm_object_tooltip_content_cb_set()
599 * @param obj owner widget.
600 * @param tooltip The tooltip object (affix content to this!)
602 typedef Evas_Object *(*Elm_Tooltip_Content_Cb) (void *data, Evas_Object *obj, Evas_Object *tooltip);
605 * Called back when a widget's item tooltip is activated and needs content.
606 * @param data user-data given to elm_object_tooltip_content_cb_set()
607 * @param obj owner widget.
608 * @param tooltip The tooltip object (affix content to this!)
609 * @param item context dependent item. As an example, if tooltip was
610 * set on Elm_List_Item, then it is of this type.
612 typedef Evas_Object *(*Elm_Tooltip_Item_Content_Cb) (void *data, Evas_Object *obj, Evas_Object *tooltip, void *item);
614 typedef Eina_Bool (*Elm_Event_Cb) (void *data, Evas_Object *obj, Evas_Object *src, Evas_Callback_Type type, void *event_info); /**< Function prototype definition for callbacks on input events happening on Elementary widgets. @a data will receive the user data pointer passed to elm_object_event_callback_add(). @a src will be a pointer to the widget on which the input event took place. @a type will get the type of this event and @a event_info, the struct with details on this event. */
616 #ifndef ELM_LIB_QUICKLAUNCH
617 #define ELM_MAIN() int main(int argc, char **argv) {elm_init(argc, argv); return elm_main(argc, argv);} /**< macro to be used after the elm_main() function */
619 #define ELM_MAIN() int main(int argc, char **argv) {return elm_quicklaunch_fallback(argc, argv);} /**< macro to be used after the elm_main() function */
622 /**************************************************************************/
626 * Initialize Elementary
628 * @param[in] argc System's argument count value
629 * @param[in] argv System's pointer to array of argument strings
630 * @return The init counter value.
632 * This function initializes Elementary and increments a counter of
633 * the number of calls to it. It returns the new counter's value.
635 * @warning This call is exported only for use by the @c ELM_MAIN()
636 * macro. There is no need to use this if you use this macro (which
637 * is highly advisable). An elm_main() should contain the entry
638 * point code for your application, having the same prototype as
639 * elm_init(), and @b not being static (putting the @c EAPI symbol
640 * in front of its type declaration is advisable). The @c
641 * ELM_MAIN() call should be placed just after it.
644 * @dontinclude bg_example_01.c
648 * See the full @ref bg_example_01_c "example".
650 * @see elm_shutdown().
653 EAPI int elm_init(int argc, char **argv);
656 * Shut down Elementary
658 * @return The init counter value.
660 * This should be called at the end of your application, just
661 * before it ceases to do any more processing. This will clean up
662 * any permanent resources your application may have allocated via
663 * Elementary that would otherwise persist.
665 * @see elm_init() for an example
669 EAPI int elm_shutdown(void);
672 * Run Elementary's main loop
674 * This call should be issued just after all initialization is
675 * completed. This function will not return until elm_exit() is
676 * called. It will keep looping, running the main
677 * (event/processing) loop for Elementary.
679 * @see elm_init() for an example
683 EAPI void elm_run(void);
686 * Exit Elementary's main loop
688 * If this call is issued, it will flag the main loop to cease
689 * processing and return back to its parent function (usually your
690 * elm_main() function).
692 * @see elm_init() for an example. There, just after a request to
693 * close the window comes, the main loop will be left.
695 * @note By using the appropriate #ELM_POLICY_QUIT on your Elementary
696 * applications, you'll be able to get this function called automatically for you.
700 EAPI void elm_exit(void);
703 * Provide information in order to make Elementary determine the @b
704 * run time location of the software in question, so other data files
705 * such as images, sound files, executable utilities, libraries,
706 * modules and locale files can be found.
708 * @param mainfunc This is your application's main function name,
709 * whose binary's location is to be found. Providing @c NULL
710 * will make Elementary not to use it
711 * @param dom This will be used as the application's "domain", in the
712 * form of a prefix to any environment variables that may
713 * override prefix detection and the directory name, inside the
714 * standard share or data directories, where the software's
715 * data files will be looked for.
716 * @param checkfile This is an (optional) magic file's path to check
717 * for existence (and it must be located in the data directory,
718 * under the share directory provided above). Its presence will
719 * help determine the prefix found was correct. Pass @c NULL if
720 * the check is not to be done.
722 * This function allows one to re-locate the application somewhere
723 * else after compilation, if the developer wishes for easier
724 * distribution of pre-compiled binaries.
726 * The prefix system is designed to locate where the given software is
727 * installed (under a common path prefix) at run time and then report
728 * specific locations of this prefix and common directories inside
729 * this prefix like the binary, library, data and locale directories,
730 * through the @c elm_app_*_get() family of functions.
732 * Call elm_app_info_set() early on before you change working
733 * directory or anything about @c argv[0], so it gets accurate
736 * It will then try and trace back which file @p mainfunc comes from,
737 * if provided, to determine the application's prefix directory.
739 * The @p dom parameter provides a string prefix to prepend before
740 * environment variables, allowing a fallback to @b specific
741 * environment variables to locate the software. You would most
742 * probably provide a lowercase string there, because it will also
743 * serve as directory domain, explained next. For environment
744 * variables purposes, this string is made uppercase. For example if
745 * @c "myapp" is provided as the prefix, then the program would expect
746 * @c "MYAPP_PREFIX" as a master environment variable to specify the
747 * exact install prefix for the software, or more specific environment
748 * variables like @c "MYAPP_BIN_DIR", @c "MYAPP_LIB_DIR", @c
749 * "MYAPP_DATA_DIR" and @c "MYAPP_LOCALE_DIR", which could be set by
750 * the user or scripts before launching. If not provided (@c NULL),
751 * environment variables will not be used to override compiled-in
752 * defaults or auto detections.
754 * The @p dom string also provides a subdirectory inside the system
755 * shared data directory for data files. For example, if the system
756 * directory is @c /usr/local/share, then this directory name is
757 * appended, creating @c /usr/local/share/myapp, if it @p was @c
758 * "myapp". It is expected that the application installs data files in
761 * The @p checkfile is a file name or path of something inside the
762 * share or data directory to be used to test that the prefix
763 * detection worked. For example, your app will install a wallpaper
764 * image as @c /usr/local/share/myapp/images/wallpaper.jpg and so to
765 * check that this worked, provide @c "images/wallpaper.jpg" as the @p
768 * @see elm_app_compile_bin_dir_set()
769 * @see elm_app_compile_lib_dir_set()
770 * @see elm_app_compile_data_dir_set()
771 * @see elm_app_compile_locale_set()
772 * @see elm_app_prefix_dir_get()
773 * @see elm_app_bin_dir_get()
774 * @see elm_app_lib_dir_get()
775 * @see elm_app_data_dir_get()
776 * @see elm_app_locale_dir_get()
778 EAPI void elm_app_info_set(void *mainfunc, const char *dom, const char *checkfile);
781 * Provide information on the @b fallback application's binaries
782 * directory, in scenarios where they get overriden by
783 * elm_app_info_set().
785 * @param dir The path to the default binaries directory (compile time
788 * @note Elementary will as well use this path to determine actual
789 * names of binaries' directory paths, maybe changing it to be @c
790 * something/local/bin instead of @c something/bin, only, for
793 * @warning You should call this function @b before
794 * elm_app_info_set().
796 EAPI void elm_app_compile_bin_dir_set(const char *dir);
799 * Provide information on the @b fallback application's libraries
800 * directory, on scenarios where they get overriden by
801 * elm_app_info_set().
803 * @param dir The path to the default libraries directory (compile
806 * @note Elementary will as well use this path to determine actual
807 * names of libraries' directory paths, maybe changing it to be @c
808 * something/lib32 or @c something/lib64 instead of @c something/lib,
811 * @warning You should call this function @b before
812 * elm_app_info_set().
814 EAPI void elm_app_compile_lib_dir_set(const char *dir);
817 * Provide information on the @b fallback application's data
818 * directory, on scenarios where they get overriden by
819 * elm_app_info_set().
821 * @param dir The path to the default data directory (compile time
824 * @note Elementary will as well use this path to determine actual
825 * names of data directory paths, maybe changing it to be @c
826 * something/local/share instead of @c something/share, only, for
829 * @warning You should call this function @b before
830 * elm_app_info_set().
832 EAPI void elm_app_compile_data_dir_set(const char *dir);
835 * Provide information on the @b fallback application's locale
836 * directory, on scenarios where they get overriden by
837 * elm_app_info_set().
839 * @param dir The path to the default locale directory (compile time
842 * @warning You should call this function @b before
843 * elm_app_info_set().
845 EAPI void elm_app_compile_locale_set(const char *dir);
848 * Retrieve the application's run time prefix directory, as set by
849 * elm_app_info_set() and the way (environment) the application was
852 * @return The directory prefix the application is actually using.
854 EAPI const char *elm_app_prefix_dir_get(void);
857 * Retrieve the application's run time binaries prefix directory, as
858 * set by elm_app_info_set() and the way (environment) the application
861 * @return The binaries directory prefix the application is actually
864 EAPI const char *elm_app_bin_dir_get(void);
867 * Retrieve the application's run time libraries prefix directory, as
868 * set by elm_app_info_set() and the way (environment) the application
871 * @return The libraries directory prefix the application is actually
874 EAPI const char *elm_app_lib_dir_get(void);
877 * Retrieve the application's run time data prefix directory, as
878 * set by elm_app_info_set() and the way (environment) the application
881 * @return The data directory prefix the application is actually
884 EAPI const char *elm_app_data_dir_get(void);
887 * Retrieve the application's run time locale prefix directory, as
888 * set by elm_app_info_set() and the way (environment) the application
891 * @return The locale directory prefix the application is actually
894 EAPI const char *elm_app_locale_dir_get(void);
896 EAPI void elm_quicklaunch_mode_set(Eina_Bool ql_on);
897 EAPI Eina_Bool elm_quicklaunch_mode_get(void);
898 EAPI int elm_quicklaunch_init(int argc, char **argv);
899 EAPI int elm_quicklaunch_sub_init(int argc, char **argv);
900 EAPI int elm_quicklaunch_sub_shutdown(void);
901 EAPI int elm_quicklaunch_shutdown(void);
902 EAPI void elm_quicklaunch_seed(void);
903 EAPI Eina_Bool elm_quicklaunch_prepare(int argc, char **argv);
904 EAPI Eina_Bool elm_quicklaunch_fork(int argc, char **argv, char *cwd, void (postfork_func) (void *data), void *postfork_data);
905 EAPI void elm_quicklaunch_cleanup(void);
906 EAPI int elm_quicklaunch_fallback(int argc, char **argv);
907 EAPI char *elm_quicklaunch_exe_path_get(const char *exe);
909 EAPI Eina_Bool elm_need_efreet(void);
910 EAPI Eina_Bool elm_need_e_dbus(void);
913 * This must be called before any other function that deals with
914 * elm_thumb objects or ethumb_client instances.
918 EAPI Eina_Bool elm_need_ethumb(void);
921 * This must be called before any other function that deals with
922 * elm_web objects or ewk_view instances.
926 EAPI Eina_Bool elm_need_web(void);
929 * Set a new policy's value (for a given policy group/identifier).
931 * @param policy policy identifier, as in @ref Elm_Policy.
932 * @param value policy value, which depends on the identifier
934 * @return @c EINA_TRUE on success or @c EINA_FALSE, on error.
936 * Elementary policies define applications' behavior,
937 * somehow. These behaviors are divided in policy groups (see
938 * #Elm_Policy enumeration). This call will emit the Ecore event
939 * #ELM_EVENT_POLICY_CHANGED, which can be hooked at with
940 * handlers. An #Elm_Event_Policy_Changed struct will be passed,
943 * @note Currently, we have only one policy identifier/group
944 * (#ELM_POLICY_QUIT), which has two possible values.
948 EAPI Eina_Bool elm_policy_set(unsigned int policy, int value);
951 * Gets the policy value for given policy identifier.
953 * @param policy policy identifier, as in #Elm_Policy.
954 * @return The currently set policy value, for that
955 * identifier. Will be @c 0 if @p policy passed is invalid.
959 EAPI int elm_policy_get(unsigned int policy);
962 * Change the language of the current application
964 * The @p lang passed must be the full name of the locale to use, for
965 * example "en_US.utf8" or "es_ES@euro".
967 * Changing language with this function will make Elementary run through
968 * all its widgets, translating strings set with
969 * elm_object_domain_translatable_text_part_set(). This way, an entire
970 * UI can have its language changed without having to restart the program.
972 * For more complex cases, like having formatted strings that need
973 * translation, widgets will also emit a "language,changed" signal that
974 * the user can listen to to manually translate the text.
976 * @param lang Language to set, must be the full name of the locale
980 EAPI void elm_language_set(const char *lang);
983 * Set a label of an object
985 * @param obj The Elementary object
986 * @param part The text part name to set (NULL for the default label)
987 * @param label The new text of the label
989 * @note Elementary objects may have many labels (e.g. Action Slider)
990 * @deprecated Use elm_object_part_text_set() instead.
993 EINA_DEPRECATED EAPI void elm_object_text_part_set(Evas_Object *obj, const char *part, const char *label);
996 * Set a label of an object
998 * @param obj The Elementary object
999 * @param part The text part name to set (NULL for the default label)
1000 * @param label The new text of the label
1002 * @note Elementary objects may have many labels (e.g. Action Slider)
1006 EAPI void elm_object_part_text_set(Evas_Object *obj, const char *part, const char *label);
1008 #define elm_object_text_set(obj, label) elm_object_part_text_set((obj), NULL, (label))
1011 * Get a label of an object
1013 * @param obj The Elementary object
1014 * @param part The text part name to get (NULL for the default label)
1015 * @return text of the label or NULL for any error
1017 * @note Elementary objects may have many labels (e.g. Action Slider)
1018 * @deprecated Use elm_object_part_text_get() instead.
1021 EINA_DEPRECATED EAPI const char *elm_object_text_part_get(const Evas_Object *obj, const char *part);
1024 * Get a label of an object
1026 * @param obj The Elementary object
1027 * @param part The text part name to get (NULL for the default label)
1028 * @return text of the label or NULL for any error
1030 * @note Elementary objects may have many labels (e.g. Action Slider)
1034 EAPI const char *elm_object_part_text_get(const Evas_Object *obj, const char *part);
1036 #define elm_object_text_get(obj) elm_object_part_text_get((obj), NULL)
1039 * Set the text for an objects' part, marking it as translatable.
1041 * The string to set as @p text must be the original one. Do not pass the
1042 * return of @c gettext() here. Elementary will translate the string
1043 * internally and set it on the object using elm_object_part_text_set(),
1044 * also storing the original string so that it can be automatically
1045 * translated when the language is changed with elm_language_set().
1047 * The @p domain will be stored along to find the translation in the
1048 * correct catalog. It can be NULL, in which case it will use whatever
1049 * domain was set by the application with @c textdomain(). This is useful
1050 * in case you are building a library on top of Elementary that will have
1051 * its own translatable strings, that should not be mixed with those of
1052 * programs using the library.
1054 * @param obj The object containing the text part
1055 * @param part The name of the part to set
1056 * @param domain The translation domain to use
1057 * @param text The original, non-translated text to set
1061 EAPI void elm_object_domain_translatable_text_part_set(Evas_Object *obj, const char *part, const char *domain, const char *text);
1063 #define elm_object_domain_translatable_text_set(obj, domain, text) elm_object_domain_translatable_text_part_set((obj), NULL, (domain), (text))
1065 #define elm_object_translatable_text_set(obj, text) elm_object_domain_translatable_text_part_set((obj), NULL, NULL, (text))
1068 * Gets the original string set as translatable for an object
1070 * When setting translated strings, the function elm_object_part_text_get()
1071 * will return the translation returned by @c gettext(). To get the
1072 * original string use this function.
1074 * @param obj The object
1075 * @param part The name of the part that was set
1077 * @return The original, untranslated string
1081 EAPI const char *elm_object_translatable_text_part_get(const Evas_Object *obj, const char *part);
1083 #define elm_object_translatable_text_get(obj) elm_object_translatable_text_part_get((obj), NULL)
1086 * Set a content of an object
1088 * @param obj The Elementary object
1089 * @param part The content part name to set (NULL for the default content)
1090 * @param content The new content of the object
1092 * @note Elementary objects may have many contents
1093 * @deprecated Use elm_object_part_content_set instead.
1096 EINA_DEPRECATED EAPI void elm_object_content_part_set(Evas_Object *obj, const char *part, Evas_Object *content);
1099 * Set a content of an object
1101 * @param obj The Elementary object
1102 * @param part The content part name to set (NULL for the default content)
1103 * @param content The new content of the object
1105 * @note Elementary objects may have many contents
1109 EAPI void elm_object_part_content_set(Evas_Object *obj, const char *part, Evas_Object *content);
1111 #define elm_object_content_set(obj, content) elm_object_part_content_set((obj), NULL, (content))
1114 * Get a content of an object
1116 * @param obj The Elementary object
1117 * @param item The content part name to get (NULL for the default content)
1118 * @return content of the object or NULL for any error
1120 * @note Elementary objects may have many contents
1121 * @deprecated Use elm_object_part_content_get instead.
1124 EINA_DEPRECATED EAPI Evas_Object *elm_object_content_part_get(const Evas_Object *obj, const char *part);
1127 * Get a content of an object
1129 * @param obj The Elementary object
1130 * @param item The content part name to get (NULL for the default content)
1131 * @return content of the object or NULL for any error
1133 * @note Elementary objects may have many contents
1137 EAPI Evas_Object *elm_object_part_content_get(const Evas_Object *obj, const char *part);
1139 #define elm_object_content_get(obj) elm_object_part_content_get((obj), NULL)
1142 * Unset a content of an object
1144 * @param obj The Elementary object
1145 * @param item The content part name to unset (NULL for the default content)
1147 * @note Elementary objects may have many contents
1148 * @deprecated Use elm_object_part_content_unset instead.
1151 EINA_DEPRECATED EAPI Evas_Object *elm_object_content_part_unset(Evas_Object *obj, const char *part);
1154 * Unset a content of an object
1156 * @param obj The Elementary object
1157 * @param item The content part name to unset (NULL for the default content)
1159 * @note Elementary objects may have many contents
1163 EAPI Evas_Object *elm_object_part_content_unset(Evas_Object *obj, const char *part);
1165 #define elm_object_content_unset(obj) elm_object_part_content_unset((obj), NULL)
1168 * Set the text to read out when in accessibility mode
1170 * @param obj The object which is to be described
1171 * @param txt The text that describes the widget to people with poor or no vision
1175 EAPI void elm_object_access_info_set(Evas_Object *obj, const char *txt);
1178 * Get the widget object's handle which contains a given item
1180 * @param item The Elementary object item
1181 * @return The widget object
1183 * @note This returns the widget object itself that an item belongs to.
1187 EAPI Evas_Object *elm_object_item_object_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
1190 * Set a content of an object item
1192 * @param it The Elementary object item
1193 * @param part The content part name to set (NULL for the default content)
1194 * @param content The new content of the object item
1196 * @note Elementary object items may have many contents
1197 * @deprecated Use elm_object_item_part_content_set instead.
1200 EINA_DEPRECATED EAPI void elm_object_item_content_part_set(Elm_Object_Item *it, const char *part, Evas_Object *content);
1203 * Set a content of an object item
1205 * @param it The Elementary object item
1206 * @param part The content part name to set (NULL for the default content)
1207 * @param content The new content of the object item
1209 * @note Elementary object items may have many contents
1213 EAPI void elm_object_item_part_content_set(Elm_Object_Item *it, const char *part, Evas_Object *content);
1215 #define elm_object_item_content_set(it, content) elm_object_item_part_content_set((it), NULL, (content))
1218 * Get a content of an object item
1220 * @param it The Elementary object item
1221 * @param part The content part name to unset (NULL for the default content)
1222 * @return content of the object item or NULL for any error
1224 * @note Elementary object items may have many contents
1225 * @deprecated Use elm_object_item_part_content_get instead.
1228 EAPI Evas_Object *elm_object_item_content_part_get(const Elm_Object_Item *it, const char *part);
1231 * Get a content of an object item
1233 * @param it The Elementary object item
1234 * @param part The content part name to unset (NULL for the default content)
1235 * @return content of the object item or NULL for any error
1237 * @note Elementary object items may have many contents
1241 EAPI Evas_Object *elm_object_item_part_content_get(const Elm_Object_Item *it, const char *part);
1243 #define elm_object_item_content_get(it) elm_object_item_part_content_get((it), NULL)
1246 * Unset a content of an object item
1248 * @param it The Elementary object item
1249 * @param part The content part name to unset (NULL for the default content)
1251 * @note Elementary object items may have many contents
1252 * @deprecated Use elm_object_item_part_content_unset instead.
1255 EINA_DEPRECATED EAPI Evas_Object *elm_object_item_content_part_unset(Elm_Object_Item *it, const char *part);
1258 * Unset a content of an object item
1260 * @param it The Elementary object item
1261 * @param part The content part name to unset (NULL for the default content)
1263 * @note Elementary object items may have many contents
1267 EAPI Evas_Object *elm_object_item_part_content_unset(Elm_Object_Item *it, const char *part);
1269 #define elm_object_item_content_unset(it) elm_object_item_part_content_unset((it), NULL)
1272 * Set a label of an object item
1274 * @param it The Elementary object item
1275 * @param part The text part name to set (NULL for the default label)
1276 * @param label The new text of the label
1278 * @note Elementary object items may have many labels
1279 * @deprecated Use elm_object_item_part_text_set instead.
1282 EINA_DEPRECATED EAPI void elm_object_item_text_part_set(Elm_Object_Item *it, const char *part, const char *label);
1285 * Set a label of an object item
1287 * @param it The Elementary object item
1288 * @param part The text part name to set (NULL for the default label)
1289 * @param label The new text of the label
1291 * @note Elementary object items may have many labels
1295 EAPI void elm_object_item_part_text_set(Elm_Object_Item *it, const char *part, const char *label);
1297 #define elm_object_item_text_set(it, label) elm_object_item_part_text_set((it), NULL, (label))
1300 * Get a label of an object item
1302 * @param it The Elementary object item
1303 * @param part The text part name to get (NULL for the default label)
1304 * @return text of the label or NULL for any error
1306 * @note Elementary object items may have many labels
1307 * @deprecated Use elm_object_item_part_text_get instead.
1310 EINA_DEPRECATED EAPI const char *elm_object_item_text_part_get(const Elm_Object_Item *it, const char *part);
1312 * Get a label of an object item
1314 * @param it The Elementary object item
1315 * @param part The text part name to get (NULL for the default label)
1316 * @return text of the label or NULL for any error
1318 * @note Elementary object items may have many labels
1322 EAPI const char *elm_object_item_part_text_get(const Elm_Object_Item *it, const char *part);
1324 #define elm_object_item_text_get(it) elm_object_item_part_text_get((it), NULL)
1327 * Set the text to read out when in accessibility mode
1329 * @param it The object item which is to be described
1330 * @param txt The text that describes the widget to people with poor or no vision
1334 EAPI void elm_object_item_access_info_set(Elm_Object_Item *it, const char *txt);
1337 * Get the data associated with an object item
1338 * @param it The Elementary object item
1339 * @return The data associated with @p it
1343 EAPI void *elm_object_item_data_get(const Elm_Object_Item *it);
1346 * Set the data associated with an object item
1347 * @param it The Elementary object item
1348 * @param data The data to be associated with @p it
1352 EAPI void elm_object_item_data_set(Elm_Object_Item *it, void *data);
1355 * Send a signal to the edje object of the widget item.
1357 * This function sends a signal to the edje object of the obj item. An
1358 * edje program can respond to a signal by specifying matching
1359 * 'signal' and 'source' fields.
1361 * @param it The Elementary object item
1362 * @param emission The signal's name.
1363 * @param source The signal's source.
1366 EAPI void elm_object_item_signal_emit(Elm_Object_Item *it, const char *emission, const char *source) EINA_ARG_NONNULL(1);
1369 * Set the disabled state of an widget item.
1371 * @param obj The Elementary object item
1372 * @param disabled The state to put in in: @c EINA_TRUE for
1373 * disabled, @c EINA_FALSE for enabled
1375 * Elementary object item can be @b disabled, in which state they won't
1376 * receive input and, in general, will be themed differently from
1377 * their normal state, usually greyed out. Useful for contexts
1378 * where you don't want your users to interact with some of the
1379 * parts of you interface.
1381 * This sets the state for the widget item, either disabling it or
1386 EAPI void elm_object_item_disabled_set(Elm_Object_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1);
1389 * Get the disabled state of an widget item.
1391 * @param obj The Elementary object
1392 * @return @c EINA_TRUE, if the widget item is disabled, @c EINA_FALSE
1393 * if it's enabled (or on errors)
1395 * This gets the state of the widget, which might be enabled or disabled.
1399 EAPI Eina_Bool elm_object_item_disabled_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
1406 * @defgroup Caches Caches
1408 * These are functions which let one fine-tune some cache values for
1409 * Elementary applications, thus allowing for performance adjustments.
1415 * @brief Flush all caches.
1417 * Frees all data that was in cache and is not currently being used to reduce
1418 * memory usage. This frees Edje's, Evas' and Eet's cache. This is equivalent
1419 * to calling all of the following functions:
1420 * @li edje_file_cache_flush()
1421 * @li edje_collection_cache_flush()
1422 * @li eet_clearcache()
1423 * @li evas_image_cache_flush()
1424 * @li evas_font_cache_flush()
1425 * @li evas_render_dump()
1426 * @note Evas caches are flushed for every canvas associated with a window.
1430 EAPI void elm_all_flush(void);
1433 * Get the configured cache flush interval time
1435 * This gets the globally configured cache flush interval time, in
1438 * @return The cache flush interval time
1441 * @see elm_all_flush()
1443 EAPI int elm_cache_flush_interval_get(void);
1446 * Set the configured cache flush interval time
1448 * This sets the globally configured cache flush interval time, in ticks
1450 * @param size The cache flush interval time
1453 * @see elm_all_flush()
1455 EAPI void elm_cache_flush_interval_set(int size);
1458 * Set the configured cache flush interval time for all applications on the
1461 * This sets the globally configured cache flush interval time -- in ticks
1462 * -- for all applications on the display.
1464 * @param size The cache flush interval time
1467 EAPI void elm_cache_flush_interval_all_set(int size);
1470 * Get the configured cache flush enabled state
1472 * This gets the globally configured cache flush state - if it is enabled
1473 * or not. When cache flushing is enabled, elementary will regularly
1474 * (see elm_cache_flush_interval_get() ) flush caches and dump data out of
1475 * memory and allow usage to re-seed caches and data in memory where it
1476 * can do so. An idle application will thus minimise its memory usage as
1477 * data will be freed from memory and not be re-loaded as it is idle and
1478 * not rendering or doing anything graphically right now.
1480 * @return The cache flush state
1483 * @see elm_all_flush()
1485 EAPI Eina_Bool elm_cache_flush_enabled_get(void);
1488 * Set the configured cache flush enabled state
1490 * This sets the globally configured cache flush enabled state.
1492 * @param size The cache flush enabled state
1495 * @see elm_all_flush()
1497 EAPI void elm_cache_flush_enabled_set(Eina_Bool enabled);
1500 * Set the configured cache flush enabled state for all applications on the
1503 * This sets the globally configured cache flush enabled state for all
1504 * applications on the display.
1506 * @param size The cache flush enabled state
1509 EAPI void elm_cache_flush_enabled_all_set(Eina_Bool enabled);
1512 * Get the configured font cache size
1514 * This gets the globally configured font cache size, in bytes.
1516 * @return The font cache size
1519 EAPI int elm_font_cache_get(void);
1522 * Set the configured font cache size
1524 * This sets the globally configured font cache size, in bytes
1526 * @param size The font cache size
1529 EAPI void elm_font_cache_set(int size);
1532 * Set the configured font cache size for all applications on the
1535 * This sets the globally configured font cache size -- in bytes
1536 * -- for all applications on the display.
1538 * @param size The font cache size
1541 EAPI void elm_font_cache_all_set(int size);
1544 * Get the configured image cache size
1546 * This gets the globally configured image cache size, in bytes
1548 * @return The image cache size
1551 EAPI int elm_image_cache_get(void);
1554 * Set the configured image cache size
1556 * This sets the globally configured image cache size, in bytes
1558 * @param size The image cache size
1561 EAPI void elm_image_cache_set(int size);
1564 * Set the configured image cache size for all applications on the
1567 * This sets the globally configured image cache size -- in bytes
1568 * -- for all applications on the display.
1570 * @param size The image cache size
1573 EAPI void elm_image_cache_all_set(int size);
1576 * Get the configured edje file cache size.
1578 * This gets the globally configured edje file cache size, in number
1581 * @return The edje file cache size
1584 EAPI int elm_edje_file_cache_get(void);
1587 * Set the configured edje file cache size
1589 * This sets the globally configured edje file cache size, in number
1592 * @param size The edje file cache size
1595 EAPI void elm_edje_file_cache_set(int size);
1598 * Set the configured edje file cache size for all applications on the
1601 * This sets the globally configured edje file cache size -- in number
1602 * of files -- for all applications on the display.
1604 * @param size The edje file cache size
1607 EAPI void elm_edje_file_cache_all_set(int size);
1610 * Get the configured edje collections (groups) cache size.
1612 * This gets the globally configured edje collections cache size, in
1613 * number of collections.
1615 * @return The edje collections cache size
1618 EAPI int elm_edje_collection_cache_get(void);
1621 * Set the configured edje collections (groups) cache size
1623 * This sets the globally configured edje collections cache size, in
1624 * number of collections.
1626 * @param size The edje collections cache size
1629 EAPI void elm_edje_collection_cache_set(int size);
1632 * Set the configured edje collections (groups) cache size for all
1633 * applications on the display
1635 * This sets the globally configured edje collections cache size -- in
1636 * number of collections -- for all applications on the display.
1638 * @param size The edje collections cache size
1641 EAPI void elm_edje_collection_cache_all_set(int size);
1648 * @defgroup Scaling Widget Scaling
1650 * Different widgets can be scaled independently. These functions
1651 * allow you to manipulate this scaling on a per-widget basis. The
1652 * object and all its children get their scaling factors multiplied
1653 * by the scale factor set. This is multiplicative, in that if a
1654 * child also has a scale size set it is in turn multiplied by its
1655 * parent's scale size. @c 1.0 means ādon't scaleā, @c 2.0 is
1656 * double size, @c 0.5 is half, etc.
1658 * @ref general_functions_example_page "This" example contemplates
1659 * some of these functions.
1663 * Get the global scaling factor
1665 * This gets the globally configured scaling factor that is applied to all
1668 * @return The scaling factor
1671 EAPI double elm_scale_get(void);
1674 * Set the global scaling factor
1676 * This sets the globally configured scaling factor that is applied to all
1679 * @param scale The scaling factor to set
1682 EAPI void elm_scale_set(double scale);
1685 * Set the global scaling factor for all applications on the display
1687 * This sets the globally configured scaling factor that is applied to all
1688 * objects for all applications.
1689 * @param scale The scaling factor to set
1692 EAPI void elm_scale_all_set(double scale);
1695 * Set the scaling factor for a given Elementary object
1697 * @param obj The Elementary to operate on
1698 * @param scale Scale factor (from @c 0.0 up, with @c 1.0 meaning
1703 EAPI void elm_object_scale_set(Evas_Object *obj, double scale) EINA_ARG_NONNULL(1);
1706 * Get the scaling factor for a given Elementary object
1708 * @param obj The object
1709 * @return The scaling factor set by elm_object_scale_set()
1713 EAPI double elm_object_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1716 * @defgroup Password_last_show Password last input show
1718 * Last show feature of password mode enables user to view
1719 * the last input entered for few seconds before masking it.
1720 * These functions allow to set this feature in password mode
1721 * of entry widget and also allow to manipulate the duration
1722 * for which the input has to be visible.
1728 * Get show last setting of password mode.
1730 * This gets the show last input setting of password mode which might be
1731 * enabled or disabled.
1733 * @return @c EINA_TRUE, if the last input show setting is enabled, @c EINA_FALSE
1735 * @ingroup Password_last_show
1737 EAPI Eina_Bool elm_password_show_last_get(void);
1740 * Set show last setting in password mode.
1742 * This enables or disables show last setting of password mode.
1744 * @param password_show_last If EINA_TRUE enable's last input show in password mode.
1745 * @see elm_password_show_last_timeout_set()
1746 * @ingroup Password_last_show
1748 EAPI void elm_password_show_last_set(Eina_Bool password_show_last);
1751 * Get's the timeout value in last show password mode.
1753 * This gets the time out value for which the last input entered in password
1754 * mode will be visible.
1756 * @return The timeout value of last show password mode.
1757 * @ingroup Password_last_show
1759 EAPI double elm_password_show_last_timeout_get(void);
1762 * Set's the timeout value in last show password mode.
1764 * This sets the time out value for which the last input entered in password
1765 * mode will be visible.
1767 * @param password_show_last_timeout The timeout value.
1768 * @see elm_password_show_last_set()
1769 * @ingroup Password_last_show
1771 EAPI void elm_password_show_last_timeout_set(double password_show_last_timeout);
1778 * @defgroup UI-Mirroring Selective Widget mirroring
1780 * These functions allow you to set ui-mirroring on specific
1781 * widgets or the whole interface. Widgets can be in one of two
1782 * modes, automatic and manual. Automatic means they'll be changed
1783 * according to the system mirroring mode and manual means only
1784 * explicit changes will matter. You are not supposed to change
1785 * mirroring state of a widget set to automatic, will mostly work,
1786 * but the behavior is not really defined.
1791 EAPI Eina_Bool elm_mirrored_get(void);
1792 EAPI void elm_mirrored_set(Eina_Bool mirrored);
1795 * Get the system mirrored mode. This determines the default mirrored mode
1798 * @return EINA_TRUE if mirrored is set, EINA_FALSE otherwise
1800 EAPI Eina_Bool elm_object_mirrored_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1803 * Set the system mirrored mode. This determines the default mirrored mode
1806 * @param mirrored EINA_TRUE to set mirrored mode, EINA_FALSE to unset it.
1808 EAPI void elm_object_mirrored_set(Evas_Object *obj, Eina_Bool mirrored) EINA_ARG_NONNULL(1);
1811 * Returns the widget's mirrored mode setting.
1813 * @param obj The widget.
1814 * @return mirrored mode setting of the object.
1817 EAPI Eina_Bool elm_object_mirrored_automatic_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1820 * Sets the widget's mirrored mode setting.
1821 * When widget in automatic mode, it follows the system mirrored mode set by
1822 * elm_mirrored_set().
1823 * @param obj The widget.
1824 * @param automatic EINA_TRUE for auto mirrored mode. EINA_FALSE for manual.
1826 EAPI void elm_object_mirrored_automatic_set(Evas_Object *obj, Eina_Bool automatic) EINA_ARG_NONNULL(1);
1833 * Set the style to use by a widget
1835 * Sets the style name that will define the appearance of a widget. Styles
1836 * vary from widget to widget and may also be defined by other themes
1837 * by means of extensions and overlays.
1839 * @param obj The Elementary widget to style
1840 * @param style The style name to use
1842 * @see elm_theme_extension_add()
1843 * @see elm_theme_extension_del()
1844 * @see elm_theme_overlay_add()
1845 * @see elm_theme_overlay_del()
1849 EAPI void elm_object_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
1851 * Get the style used by the widget
1853 * This gets the style being used for that widget. Note that the string
1854 * pointer is only valid as longas the object is valid and the style doesn't
1857 * @param obj The Elementary widget to query for its style
1858 * @return The style name used
1860 * @see elm_object_style_set()
1864 EAPI const char *elm_object_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1867 * @defgroup Styles Styles
1869 * Widgets can have different styles of look. These generic API's
1870 * set styles of widgets, if they support them (and if the theme(s)
1873 * @ref general_functions_example_page "This" example contemplates
1874 * some of these functions.
1878 * Set the disabled state of an Elementary object.
1880 * @param obj The Elementary object to operate on
1881 * @param disabled The state to put in in: @c EINA_TRUE for
1882 * disabled, @c EINA_FALSE for enabled
1884 * Elementary objects can be @b disabled, in which state they won't
1885 * receive input and, in general, will be themed differently from
1886 * their normal state, usually greyed out. Useful for contexts
1887 * where you don't want your users to interact with some of the
1888 * parts of you interface.
1890 * This sets the state for the widget, either disabling it or
1895 EAPI void elm_object_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
1898 * Get the disabled state of an Elementary object.
1900 * @param obj The Elementary object to operate on
1901 * @return @c EINA_TRUE, if the widget is disabled, @c EINA_FALSE
1902 * if it's enabled (or on errors)
1904 * This gets the state of the widget, which might be enabled or disabled.
1908 EAPI Eina_Bool elm_object_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1911 * @defgroup WidgetNavigation Widget Tree Navigation.
1913 * How to check if an Evas Object is an Elementary widget? How to
1914 * get the first elementary widget that is parent of the given
1915 * object? These are all covered in widget tree navigation.
1917 * @ref general_functions_example_page "This" example contemplates
1918 * some of these functions.
1922 * Check if the given Evas Object is an Elementary widget.
1924 * @param obj the object to query.
1925 * @return @c EINA_TRUE if it is an elementary widget variant,
1926 * @c EINA_FALSE otherwise
1927 * @ingroup WidgetNavigation
1929 EAPI Eina_Bool elm_object_widget_check(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1932 * Get the first parent of the given object that is an Elementary
1935 * @param obj the Elementary object to query parent from.
1936 * @return the parent object that is an Elementary widget, or @c
1937 * NULL, if it was not found.
1939 * Use this to query for an object's parent widget.
1941 * @note Most of Elementary users wouldn't be mixing non-Elementary
1942 * smart objects in the objects tree of an application, as this is
1943 * an advanced usage of Elementary with Evas. So, except for the
1944 * application's window, which is the root of that tree, all other
1945 * objects would have valid Elementary widget parents.
1947 * @ingroup WidgetNavigation
1949 EAPI Evas_Object *elm_object_parent_widget_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1952 * Get the top level parent of an Elementary widget.
1954 * @param obj The object to query.
1955 * @return The top level Elementary widget, or @c NULL if parent cannot be
1957 * @ingroup WidgetNavigation
1959 EAPI Evas_Object *elm_object_top_widget_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1962 * Get the string that represents this Elementary widget.
1964 * @note Elementary is weird and exposes itself as a single
1965 * Evas_Object_Smart_Class of type "elm_widget", so
1966 * evas_object_type_get() always return that, making debug and
1967 * language bindings hard. This function tries to mitigate this
1968 * problem, but the solution is to change Elementary to use
1969 * proper inheritance.
1971 * @param obj the object to query.
1972 * @return Elementary widget name, or @c NULL if not a valid widget.
1973 * @ingroup WidgetNavigation
1975 EAPI const char *elm_object_widget_type_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1978 * @defgroup Config Elementary Config
1980 * Elementary configuration is formed by a set options bounded to a
1981 * given @ref Profile profile, like @ref Theme theme, @ref Fingers
1982 * "finger size", etc. These are functions with which one syncronizes
1983 * changes made to those values to the configuration storing files, de
1984 * facto. You most probably don't want to use the functions in this
1985 * group unlees you're writing an elementary configuration manager.
1991 * Save back Elementary's configuration, so that it will persist on
1994 * @return @c EINA_TRUE, when sucessful. @c EINA_FALSE, otherwise.
1997 * This function will take effect -- thus, do I/O -- immediately. Use
1998 * it when you want to apply all configuration changes at once. The
1999 * current configuration set will get saved onto the current profile
2000 * configuration file.
2003 EAPI Eina_Bool elm_config_save(void);
2006 * Reload Elementary's configuration, bounded to current selected
2009 * @return @c EINA_TRUE, when sucessful. @c EINA_FALSE, otherwise.
2012 * Useful when you want to force reloading of configuration values for
2013 * a profile. If one removes user custom configuration directories,
2014 * for example, it will force a reload with system values instead.
2017 EAPI void elm_config_reload(void);
2024 * @defgroup Profile Elementary Profile
2026 * Profiles are pre-set options that affect the whole look-and-feel of
2027 * Elementary-based applications. There are, for example, profiles
2028 * aimed at desktop computer applications and others aimed at mobile,
2029 * touchscreen-based ones. You most probably don't want to use the
2030 * functions in this group unlees you're writing an elementary
2031 * configuration manager.
2037 * Get Elementary's profile in use.
2039 * This gets the global profile that is applied to all Elementary
2042 * @return The profile's name
2045 EAPI const char *elm_profile_current_get(void);
2048 * Get an Elementary's profile directory path in the filesystem. One
2049 * may want to fetch a system profile's dir or an user one (fetched
2052 * @param profile The profile's name
2053 * @param is_user Whether to lookup for an user profile (@c EINA_TRUE)
2054 * or a system one (@c EINA_FALSE)
2055 * @return The profile's directory path.
2058 * @note You must free it with elm_profile_dir_free().
2060 EAPI const char *elm_profile_dir_get(const char *profile, Eina_Bool is_user);
2063 * Free an Elementary's profile directory path, as returned by
2064 * elm_profile_dir_get().
2066 * @param p_dir The profile's path
2070 EAPI void elm_profile_dir_free(const char *p_dir);
2073 * Get Elementary's list of available profiles.
2075 * @return The profiles list. List node data are the profile name
2079 * @note One must free this list, after usage, with the function
2080 * elm_profile_list_free().
2082 EAPI Eina_List *elm_profile_list_get(void);
2085 * Free Elementary's list of available profiles.
2087 * @param l The profiles list, as returned by elm_profile_list_get().
2091 EAPI void elm_profile_list_free(Eina_List *l);
2094 * Set Elementary's profile.
2096 * This sets the global profile that is applied to Elementary
2097 * applications. Just the process the call comes from will be
2100 * @param profile The profile's name
2104 EAPI void elm_profile_set(const char *profile);
2107 * Set Elementary's profile.
2109 * This sets the global profile that is applied to all Elementary
2110 * applications. All running Elementary windows will be affected.
2112 * @param profile The profile's name
2116 EAPI void elm_profile_all_set(const char *profile);
2123 * @defgroup Engine Elementary Engine
2125 * These are functions setting and querying which rendering engine
2126 * Elementary will use for drawing its windows' pixels.
2128 * The following are the available engines:
2129 * @li "software_x11"
2132 * @li "software_16_x11"
2133 * @li "software_8_x11"
2136 * @li "software_gdi"
2137 * @li "software_16_wince_gdi"
2139 * @li "software_16_sdl"
2143 * @li "opengl_cocoa"
2150 * @brief Get Elementary's rendering engine in use.
2152 * @return The rendering engine's name
2153 * @note there's no need to free the returned string, here.
2155 * This gets the global rendering engine that is applied to all Elementary
2158 * @see elm_engine_set()
2160 EAPI const char *elm_engine_current_get(void);
2163 * @brief Set Elementary's rendering engine for use.
2165 * @param engine The rendering engine's name
2167 * This sets global rendering engine that is applied to all Elementary
2168 * applications. Note that it will take effect only to Elementary windows
2169 * created after this is called.
2171 * @see elm_win_add()
2173 EAPI void elm_engine_set(const char *engine);
2180 * @defgroup Fonts Elementary Fonts
2182 * These are functions dealing with font rendering, selection and the
2183 * like for Elementary applications. One might fetch which system
2184 * fonts are there to use and set custom fonts for individual classes
2185 * of UI items containing text (text classes).
2190 typedef struct _Elm_Text_Class
2196 typedef struct _Elm_Font_Overlay
2198 const char *text_class;
2200 Evas_Font_Size size;
2203 typedef struct _Elm_Font_Properties
2207 } Elm_Font_Properties;
2210 * Get Elementary's list of supported text classes.
2212 * @return The text classes list, with @c Elm_Text_Class blobs as data.
2215 * Release the list with elm_text_classes_list_free().
2217 EAPI const Eina_List *elm_text_classes_list_get(void);
2220 * Free Elementary's list of supported text classes.
2224 * @see elm_text_classes_list_get().
2226 EAPI void elm_text_classes_list_free(const Eina_List *list);
2229 * Get Elementary's list of font overlays, set with
2230 * elm_font_overlay_set().
2232 * @return The font overlays list, with @c Elm_Font_Overlay blobs as
2237 * For each text class, one can set a <b>font overlay</b> for it,
2238 * overriding the default font properties for that class coming from
2239 * the theme in use. There is no need to free this list.
2241 * @see elm_font_overlay_set() and elm_font_overlay_unset().
2243 EAPI const Eina_List *elm_font_overlay_list_get(void);
2246 * Set a font overlay for a given Elementary text class.
2248 * @param text_class Text class name
2249 * @param font Font name and style string
2250 * @param size Font size
2254 * @p font has to be in the format returned by
2255 * elm_font_fontconfig_name_get(). @see elm_font_overlay_list_get()
2256 * and elm_font_overlay_unset().
2258 EAPI void elm_font_overlay_set(const char *text_class, const char *font, Evas_Font_Size size);
2261 * Unset a font overlay for a given Elementary text class.
2263 * @param text_class Text class name
2267 * This will bring back text elements belonging to text class
2268 * @p text_class back to their default font settings.
2270 EAPI void elm_font_overlay_unset(const char *text_class);
2273 * Apply the changes made with elm_font_overlay_set() and
2274 * elm_font_overlay_unset() on the current Elementary window.
2278 * This applies all font overlays set to all objects in the UI.
2280 EAPI void elm_font_overlay_apply(void);
2283 * Apply the changes made with elm_font_overlay_set() and
2284 * elm_font_overlay_unset() on all Elementary application windows.
2288 * This applies all font overlays set to all objects in the UI.
2290 EAPI void elm_font_overlay_all_apply(void);
2293 * Translate a font (family) name string in fontconfig's font names
2294 * syntax into an @c Elm_Font_Properties struct.
2296 * @param font The font name and styles string
2297 * @return the font properties struct
2301 * @note The reverse translation can be achived with
2302 * elm_font_fontconfig_name_get(), for one style only (single font
2303 * instance, not family).
2305 EAPI Elm_Font_Properties *elm_font_properties_get(const char *font) EINA_ARG_NONNULL(1);
2308 * Free font properties return by elm_font_properties_get().
2310 * @param efp the font properties struct
2314 EAPI void elm_font_properties_free(Elm_Font_Properties *efp) EINA_ARG_NONNULL(1);
2317 * Translate a font name, bound to a style, into fontconfig's font names
2320 * @param name The font (family) name
2321 * @param style The given style (may be @c NULL)
2323 * @return the font name and style string
2327 * @note The reverse translation can be achived with
2328 * elm_font_properties_get(), for one style only (single font
2329 * instance, not family).
2331 EAPI const char *elm_font_fontconfig_name_get(const char *name, const char *style) EINA_ARG_NONNULL(1);
2334 * Free the font string return by elm_font_fontconfig_name_get().
2336 * @param efp the font properties struct
2340 EAPI void elm_font_fontconfig_name_free(const char *name) EINA_ARG_NONNULL(1);
2343 * Create a font hash table of available system fonts.
2345 * One must call it with @p list being the return value of
2346 * evas_font_available_list(). The hash will be indexed by font
2347 * (family) names, being its values @c Elm_Font_Properties blobs.
2349 * @param list The list of available system fonts, as returned by
2350 * evas_font_available_list().
2351 * @return the font hash.
2355 * @note The user is supposed to get it populated at least with 3
2356 * default font families (Sans, Serif, Monospace), which should be
2357 * present on most systems.
2359 EAPI Eina_Hash *elm_font_available_hash_add(Eina_List *list);
2362 * Free the hash return by elm_font_available_hash_add().
2364 * @param hash the hash to be freed.
2368 EAPI void elm_font_available_hash_del(Eina_Hash *hash);
2375 * @defgroup Fingers Fingers
2377 * Elementary is designed to be finger-friendly for touchscreens,
2378 * and so in addition to scaling for display resolution, it can
2379 * also scale based on finger "resolution" (or size). You can then
2380 * customize the granularity of the areas meant to receive clicks
2383 * Different profiles may have pre-set values for finger sizes.
2385 * @ref general_functions_example_page "This" example contemplates
2386 * some of these functions.
2392 * Get the configured "finger size"
2394 * @return The finger size
2396 * This gets the globally configured finger size, <b>in pixels</b>
2400 EAPI Evas_Coord elm_finger_size_get(void);
2403 * Set the configured finger size
2405 * This sets the globally configured finger size in pixels
2407 * @param size The finger size
2410 EAPI void elm_finger_size_set(Evas_Coord size);
2413 * Set the configured finger size for all applications on the display
2415 * This sets the globally configured finger size in pixels for all
2416 * applications on the display
2418 * @param size The finger size
2421 EAPI void elm_finger_size_all_set(Evas_Coord size);
2428 * @defgroup Focus Focus
2430 * An Elementary application has, at all times, one (and only one)
2431 * @b focused object. This is what determines where the input
2432 * events go to within the application's window. Also, focused
2433 * objects can be decorated differently, in order to signal to the
2434 * user where the input is, at a given moment.
2436 * Elementary applications also have the concept of <b>focus
2437 * chain</b>: one can cycle through all the windows' focusable
2438 * objects by input (tab key) or programmatically. The default
2439 * focus chain for an application is the one define by the order in
2440 * which the widgets where added in code. One will cycle through
2441 * top level widgets, and, for each one containg sub-objects, cycle
2442 * through them all, before returning to the level
2443 * above. Elementary also allows one to set @b custom focus chains
2444 * for their applications.
2446 * Besides the focused decoration a widget may exhibit, when it
2447 * gets focus, Elementary has a @b global focus highlight object
2448 * that can be enabled for a window. If one chooses to do so, this
2449 * extra highlight effect will surround the current focused object,
2452 * @note Some Elementary widgets are @b unfocusable, after
2453 * creation, by their very nature: they are not meant to be
2454 * interacted with input events, but are there just for visual
2457 * @ref general_functions_example_page "This" example contemplates
2458 * some of these functions.
2462 * Get the enable status of the focus highlight
2464 * This gets whether the highlight on focused objects is enabled or not
2467 EAPI Eina_Bool elm_focus_highlight_enabled_get(void);
2470 * Set the enable status of the focus highlight
2472 * Set whether to show or not the highlight on focused objects
2473 * @param enable Enable highlight if EINA_TRUE, disable otherwise
2476 EAPI void elm_focus_highlight_enabled_set(Eina_Bool enable);
2479 * Get the enable status of the highlight animation
2481 * Get whether the focus highlight, if enabled, will animate its switch from
2482 * one object to the next
2485 EAPI Eina_Bool elm_focus_highlight_animate_get(void);
2488 * Set the enable status of the highlight animation
2490 * Set whether the focus highlight, if enabled, will animate its switch from
2491 * one object to the next
2492 * @param animate Enable animation if EINA_TRUE, disable otherwise
2495 EAPI void elm_focus_highlight_animate_set(Eina_Bool animate);
2498 * Get the whether an Elementary object has the focus or not.
2500 * @param obj The Elementary object to get the information from
2501 * @return @c EINA_TRUE, if the object is focused, @c EINA_FALSE if
2502 * not (and on errors).
2504 * @see elm_object_focus_set()
2508 EAPI Eina_Bool elm_object_focus_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2511 * Set/unset focus to a given Elementary object.
2513 * @param obj The Elementary object to operate on.
2514 * @param enable @c EINA_TRUE Set focus to a given object,
2515 * @c EINA_FALSE Unset focus to a given object.
2517 * @note When you set focus to this object, if it can handle focus, will
2518 * take the focus away from the one who had it previously and will, for
2519 * now on, be the one receiving input events. Unsetting focus will remove
2520 * the focus from @p obj, passing it back to the previous element in the
2523 * @see elm_object_focus_get(), elm_object_focus_custom_chain_get()
2527 EAPI void elm_object_focus_set(Evas_Object *obj, Eina_Bool focus) EINA_ARG_NONNULL(1);
2530 * Make a given Elementary object the focused one.
2532 * @param obj The Elementary object to make focused.
2534 * @note This object, if it can handle focus, will take the focus
2535 * away from the one who had it previously and will, for now on, be
2536 * the one receiving input events.
2538 * @see elm_object_focus_get()
2539 * @deprecated use elm_object_focus_set() instead.
2543 EINA_DEPRECATED EAPI void elm_object_focus(Evas_Object *obj) EINA_ARG_NONNULL(1);
2546 * Remove the focus from an Elementary object
2548 * @param obj The Elementary to take focus from
2550 * This removes the focus from @p obj, passing it back to the
2551 * previous element in the focus chain list.
2553 * @see elm_object_focus() and elm_object_focus_custom_chain_get()
2554 * @deprecated use elm_object_focus_set() instead.
2558 EINA_DEPRECATED EAPI void elm_object_unfocus(Evas_Object *obj) EINA_ARG_NONNULL(1);
2561 * Set the ability for an Element object to be focused
2563 * @param obj The Elementary object to operate on
2564 * @param enable @c EINA_TRUE if the object can be focused, @c
2565 * EINA_FALSE if not (and on errors)
2567 * This sets whether the object @p obj is able to take focus or
2568 * not. Unfocusable objects do nothing when programmatically
2569 * focused, being the nearest focusable parent object the one
2570 * really getting focus. Also, when they receive mouse input, they
2571 * will get the event, but not take away the focus from where it
2576 EAPI void elm_object_focus_allow_set(Evas_Object *obj, Eina_Bool enable) EINA_ARG_NONNULL(1);
2579 * Get whether an Elementary object is focusable or not
2581 * @param obj The Elementary object to operate on
2582 * @return @c EINA_TRUE if the object is allowed to be focused, @c
2583 * EINA_FALSE if not (and on errors)
2585 * @note Objects which are meant to be interacted with by input
2586 * events are created able to be focused, by default. All the
2591 EAPI Eina_Bool elm_object_focus_allow_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2594 * Set custom focus chain.
2596 * This function overwrites any previous custom focus chain within
2597 * the list of objects. The previous list will be deleted and this list
2598 * will be managed by elementary. After it is set, don't modify it.
2600 * @note On focus cycle, only will be evaluated children of this container.
2602 * @param obj The container object
2603 * @param objs Chain of objects to pass focus
2606 EAPI void elm_object_focus_custom_chain_set(Evas_Object *obj, Eina_List *objs) EINA_ARG_NONNULL(1);
2609 * Unset a custom focus chain on a given Elementary widget
2611 * @param obj The container object to remove focus chain from
2613 * Any focus chain previously set on @p obj (for its child objects)
2614 * is removed entirely after this call.
2618 EAPI void elm_object_focus_custom_chain_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
2621 * Get custom focus chain
2623 * @param obj The container object
2626 EAPI const Eina_List *elm_object_focus_custom_chain_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2629 * Append object to custom focus chain.
2631 * @note If relative_child equal to NULL or not in custom chain, the object
2632 * will be added in end.
2634 * @note On focus cycle, only will be evaluated children of this container.
2636 * @param obj The container object
2637 * @param child The child to be added in custom chain
2638 * @param relative_child The relative object to position the child
2641 EAPI void elm_object_focus_custom_chain_append(Evas_Object *obj, Evas_Object *child, Evas_Object *relative_child) EINA_ARG_NONNULL(1, 2);
2644 * Prepend object to custom focus chain.
2646 * @note If relative_child equal to NULL or not in custom chain, the object
2647 * will be added in begin.
2649 * @note On focus cycle, only will be evaluated children of this container.
2651 * @param obj The container object
2652 * @param child The child to be added in custom chain
2653 * @param relative_child The relative object to position the child
2656 EAPI void elm_object_focus_custom_chain_prepend(Evas_Object *obj, Evas_Object *child, Evas_Object *relative_child) EINA_ARG_NONNULL(1, 2);
2659 * Give focus to next object in object tree.
2661 * Give focus to next object in focus chain of one object sub-tree.
2662 * If the last object of chain already have focus, the focus will go to the
2663 * first object of chain.
2665 * @param obj The object root of sub-tree
2666 * @param dir Direction to cycle the focus
2670 EAPI void elm_object_focus_cycle(Evas_Object *obj, Elm_Focus_Direction dir) EINA_ARG_NONNULL(1);
2673 * Give focus to near object in one direction.
2675 * Give focus to near object in direction of one object.
2676 * If none focusable object in given direction, the focus will not change.
2678 * @param obj The reference object
2679 * @param x Horizontal component of direction to focus
2680 * @param y Vertical component of direction to focus
2684 EAPI void elm_object_focus_direction_go(Evas_Object *obj, int x, int y) EINA_ARG_NONNULL(1);
2687 * Make the elementary object and its children to be unfocusable
2690 * @param obj The Elementary object to operate on
2691 * @param tree_unfocusable @c EINA_TRUE for unfocusable,
2692 * @c EINA_FALSE for focusable.
2694 * This sets whether the object @p obj and its children objects
2695 * are able to take focus or not. If the tree is set as unfocusable,
2696 * newest focused object which is not in this tree will get focus.
2697 * This API can be helpful for an object to be deleted.
2698 * When an object will be deleted soon, it and its children may not
2699 * want to get focus (by focus reverting or by other focus controls).
2700 * Then, just use this API before deleting.
2702 * @see elm_object_tree_unfocusable_get()
2706 EAPI void elm_object_tree_unfocusable_set(Evas_Object *obj, Eina_Bool tree_unfocusable) EINA_ARG_NONNULL(1);
2709 * Get whether an Elementary object and its children are unfocusable or not.
2711 * @param obj The Elementary object to get the information from
2712 * @return @c EINA_TRUE, if the tree is unfocussable,
2713 * @c EINA_FALSE if not (and on errors).
2715 * @see elm_object_tree_unfocusable_set()
2719 EAPI Eina_Bool elm_object_tree_unfocusable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2722 * @defgroup Scrolling Scrolling
2724 * These are functions setting how scrollable views in Elementary
2725 * widgets should behave on user interaction.
2731 * Get whether scrollers should bounce when they reach their
2732 * viewport's edge during a scroll.
2734 * @return the thumb scroll bouncing state
2736 * This is the default behavior for touch screens, in general.
2737 * @ingroup Scrolling
2739 EAPI Eina_Bool elm_scroll_bounce_enabled_get(void);
2742 * Set whether scrollers should bounce when they reach their
2743 * viewport's edge during a scroll.
2745 * @param enabled the thumb scroll bouncing state
2747 * @see elm_thumbscroll_bounce_enabled_get()
2748 * @ingroup Scrolling
2750 EAPI void elm_scroll_bounce_enabled_set(Eina_Bool enabled);
2753 * Set whether scrollers should bounce when they reach their
2754 * viewport's edge during a scroll, for all Elementary application
2757 * @param enabled the thumb scroll bouncing state
2759 * @see elm_thumbscroll_bounce_enabled_get()
2760 * @ingroup Scrolling
2762 EAPI void elm_scroll_bounce_enabled_all_set(Eina_Bool enabled);
2765 * Get the amount of inertia a scroller will impose at bounce
2768 * @return the thumb scroll bounce friction
2770 * @ingroup Scrolling
2772 EAPI double elm_scroll_bounce_friction_get(void);
2775 * Set the amount of inertia a scroller will impose at bounce
2778 * @param friction the thumb scroll bounce friction
2780 * @see elm_thumbscroll_bounce_friction_get()
2781 * @ingroup Scrolling
2783 EAPI void elm_scroll_bounce_friction_set(double friction);
2786 * Set the amount of inertia a scroller will impose at bounce
2787 * animations, for all Elementary application windows.
2789 * @param friction the thumb scroll bounce friction
2791 * @see elm_thumbscroll_bounce_friction_get()
2792 * @ingroup Scrolling
2794 EAPI void elm_scroll_bounce_friction_all_set(double friction);
2797 * Get the amount of inertia a <b>paged</b> scroller will impose at
2798 * page fitting animations.
2800 * @return the page scroll friction
2802 * @ingroup Scrolling
2804 EAPI double elm_scroll_page_scroll_friction_get(void);
2807 * Set the amount of inertia a <b>paged</b> scroller will impose at
2808 * page fitting animations.
2810 * @param friction the page scroll friction
2812 * @see elm_thumbscroll_page_scroll_friction_get()
2813 * @ingroup Scrolling
2815 EAPI void elm_scroll_page_scroll_friction_set(double friction);
2818 * Set the amount of inertia a <b>paged</b> scroller will impose at
2819 * page fitting animations, for all Elementary application windows.
2821 * @param friction the page scroll friction
2823 * @see elm_thumbscroll_page_scroll_friction_get()
2824 * @ingroup Scrolling
2826 EAPI void elm_scroll_page_scroll_friction_all_set(double friction);
2829 * Get the amount of inertia a scroller will impose at region bring
2832 * @return the bring in scroll friction
2834 * @ingroup Scrolling
2836 EAPI double elm_scroll_bring_in_scroll_friction_get(void);
2839 * Set the amount of inertia a scroller will impose at region bring
2842 * @param friction the bring in scroll friction
2844 * @see elm_thumbscroll_bring_in_scroll_friction_get()
2845 * @ingroup Scrolling
2847 EAPI void elm_scroll_bring_in_scroll_friction_set(double friction);
2850 * Set the amount of inertia a scroller will impose at region bring
2851 * animations, for all Elementary application windows.
2853 * @param friction the bring in scroll friction
2855 * @see elm_thumbscroll_bring_in_scroll_friction_get()
2856 * @ingroup Scrolling
2858 EAPI void elm_scroll_bring_in_scroll_friction_all_set(double friction);
2861 * Get the amount of inertia scrollers will impose at animations
2862 * triggered by Elementary widgets' zooming API.
2864 * @return the zoom friction
2866 * @ingroup Scrolling
2868 EAPI double elm_scroll_zoom_friction_get(void);
2871 * Set the amount of inertia scrollers will impose at animations
2872 * triggered by Elementary widgets' zooming API.
2874 * @param friction the zoom friction
2876 * @see elm_thumbscroll_zoom_friction_get()
2877 * @ingroup Scrolling
2879 EAPI void elm_scroll_zoom_friction_set(double friction);
2882 * Set the amount of inertia scrollers will impose at animations
2883 * triggered by Elementary widgets' zooming API, for all Elementary
2884 * application windows.
2886 * @param friction the zoom friction
2888 * @see elm_thumbscroll_zoom_friction_get()
2889 * @ingroup Scrolling
2891 EAPI void elm_scroll_zoom_friction_all_set(double friction);
2894 * Get whether scrollers should be draggable from any point in their
2897 * @return the thumb scroll state
2899 * @note This is the default behavior for touch screens, in general.
2900 * @note All other functions namespaced with "thumbscroll" will only
2901 * have effect if this mode is enabled.
2903 * @ingroup Scrolling
2905 EAPI Eina_Bool elm_scroll_thumbscroll_enabled_get(void);
2908 * Set whether scrollers should be draggable from any point in their
2911 * @param enabled the thumb scroll state
2913 * @see elm_thumbscroll_enabled_get()
2914 * @ingroup Scrolling
2916 EAPI void elm_scroll_thumbscroll_enabled_set(Eina_Bool enabled);
2919 * Set whether scrollers should be draggable from any point in their
2920 * views, for all Elementary application windows.
2922 * @param enabled the thumb scroll state
2924 * @see elm_thumbscroll_enabled_get()
2925 * @ingroup Scrolling
2927 EAPI void elm_scroll_thumbscroll_enabled_all_set(Eina_Bool enabled);
2930 * Get the number of pixels one should travel while dragging a
2931 * scroller's view to actually trigger scrolling.
2933 * @return the thumb scroll threshould
2935 * One would use higher values for touch screens, in general, because
2936 * of their inherent imprecision.
2937 * @ingroup Scrolling
2939 EAPI unsigned int elm_scroll_thumbscroll_threshold_get(void);
2942 * Set the number of pixels one should travel while dragging a
2943 * scroller's view to actually trigger scrolling.
2945 * @param threshold the thumb scroll threshould
2947 * @see elm_thumbscroll_threshould_get()
2948 * @ingroup Scrolling
2950 EAPI void elm_scroll_thumbscroll_threshold_set(unsigned int threshold);
2953 * Set the number of pixels one should travel while dragging a
2954 * scroller's view to actually trigger scrolling, for all Elementary
2955 * application windows.
2957 * @param threshold the thumb scroll threshould
2959 * @see elm_thumbscroll_threshould_get()
2960 * @ingroup Scrolling
2962 EAPI void elm_scroll_thumbscroll_threshold_all_set(unsigned int threshold);
2965 * Get the minimum speed of mouse cursor movement which will trigger
2966 * list self scrolling animation after a mouse up event
2969 * @return the thumb scroll momentum threshould
2971 * @ingroup Scrolling
2973 EAPI double elm_scroll_thumbscroll_momentum_threshold_get(void);
2976 * Set the minimum speed of mouse cursor movement which will trigger
2977 * list self scrolling animation after a mouse up event
2980 * @param threshold the thumb scroll momentum threshould
2982 * @see elm_thumbscroll_momentum_threshould_get()
2983 * @ingroup Scrolling
2985 EAPI void elm_scroll_thumbscroll_momentum_threshold_set(double threshold);
2988 * Set the minimum speed of mouse cursor movement which will trigger
2989 * list self scrolling animation after a mouse up event
2990 * (pixels/second), for all Elementary application windows.
2992 * @param threshold the thumb scroll momentum threshould
2994 * @see elm_thumbscroll_momentum_threshould_get()
2995 * @ingroup Scrolling
2997 EAPI void elm_scroll_thumbscroll_momentum_threshold_all_set(double threshold);
3000 * Get the amount of inertia a scroller will impose at self scrolling
3003 * @return the thumb scroll friction
3005 * @ingroup Scrolling
3007 EAPI double elm_scroll_thumbscroll_friction_get(void);
3010 * Set the amount of inertia a scroller will impose at self scrolling
3013 * @param friction the thumb scroll friction
3015 * @see elm_thumbscroll_friction_get()
3016 * @ingroup Scrolling
3018 EAPI void elm_scroll_thumbscroll_friction_set(double friction);
3021 * Set the amount of inertia a scroller will impose at self scrolling
3022 * animations, for all Elementary application windows.
3024 * @param friction the thumb scroll friction
3026 * @see elm_thumbscroll_friction_get()
3027 * @ingroup Scrolling
3029 EAPI void elm_scroll_thumbscroll_friction_all_set(double friction);
3032 * Get the amount of lag between your actual mouse cursor dragging
3033 * movement and a scroller's view movement itself, while pushing it
3034 * into bounce state manually.
3036 * @return the thumb scroll border friction
3038 * @ingroup Scrolling
3040 EAPI double elm_scroll_thumbscroll_border_friction_get(void);
3043 * Set the amount of lag between your actual mouse cursor dragging
3044 * movement and a scroller's view movement itself, while pushing it
3045 * into bounce state manually.
3047 * @param friction the thumb scroll border friction. @c 0.0 for
3048 * perfect synchrony between two movements, @c 1.0 for maximum
3051 * @see elm_thumbscroll_border_friction_get()
3052 * @note parameter value will get bound to 0.0 - 1.0 interval, always
3054 * @ingroup Scrolling
3056 EAPI void elm_scroll_thumbscroll_border_friction_set(double friction);
3059 * Set the amount of lag between your actual mouse cursor dragging
3060 * movement and a scroller's view movement itself, while pushing it
3061 * into bounce state manually, for all Elementary application windows.
3063 * @param friction the thumb scroll border friction. @c 0.0 for
3064 * perfect synchrony between two movements, @c 1.0 for maximum
3067 * @see elm_thumbscroll_border_friction_get()
3068 * @note parameter value will get bound to 0.0 - 1.0 interval, always
3070 * @ingroup Scrolling
3072 EAPI void elm_scroll_thumbscroll_border_friction_all_set(double friction);
3075 * Get the sensitivity amount which is be multiplied by the length of
3078 * @return the thumb scroll sensitivity friction
3080 * @ingroup Scrolling
3082 EAPI double elm_scroll_thumbscroll_sensitivity_friction_get(void);
3085 * Set the sensitivity amount which is be multiplied by the length of
3088 * @param friction the thumb scroll sensitivity friction. @c 0.1 for
3089 * minimun sensitivity, @c 1.0 for maximum sensitivity. 0.25
3092 * @see elm_thumbscroll_sensitivity_friction_get()
3093 * @note parameter value will get bound to 0.1 - 1.0 interval, always
3095 * @ingroup Scrolling
3097 EAPI void elm_scroll_thumbscroll_sensitivity_friction_set(double friction);
3100 * Set the sensitivity amount which is be multiplied by the length of
3101 * mouse dragging, for all Elementary application windows.
3103 * @param friction the thumb scroll sensitivity friction. @c 0.1 for
3104 * minimun sensitivity, @c 1.0 for maximum sensitivity. 0.25
3107 * @see elm_thumbscroll_sensitivity_friction_get()
3108 * @note parameter value will get bound to 0.1 - 1.0 interval, always
3110 * @ingroup Scrolling
3112 EAPI void elm_scroll_thumbscroll_sensitivity_friction_all_set(double friction);
3119 * @defgroup Scrollhints Scrollhints
3121 * Objects when inside a scroller can scroll, but this may not always be
3122 * desirable in certain situations. This allows an object to hint to itself
3123 * and parents to "not scroll" in one of 2 ways. If any child object of a
3124 * scroller has pushed a scroll freeze or hold then it affects all parent
3125 * scrollers until all children have released them.
3127 * 1. To hold on scrolling. This means just flicking and dragging may no
3128 * longer scroll, but pressing/dragging near an edge of the scroller will
3129 * still scroll. This is automatically used by the entry object when
3132 * 2. To totally freeze scrolling. This means it stops. until
3139 * Push the scroll hold by 1
3141 * This increments the scroll hold count by one. If it is more than 0 it will
3142 * take effect on the parents of the indicated object.
3144 * @param obj The object
3145 * @ingroup Scrollhints
3147 EAPI void elm_object_scroll_hold_push(Evas_Object *obj) EINA_ARG_NONNULL(1);
3150 * Pop the scroll hold by 1
3152 * This decrements the scroll hold count by one. If it is more than 0 it will
3153 * take effect on the parents of the indicated object.
3155 * @param obj The object
3156 * @ingroup Scrollhints
3158 EAPI void elm_object_scroll_hold_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
3161 * Push the scroll freeze by 1
3163 * This increments the scroll freeze count by one. If it is more
3164 * than 0 it will take effect on the parents of the indicated
3167 * @param obj The object
3168 * @ingroup Scrollhints
3170 EAPI void elm_object_scroll_freeze_push(Evas_Object *obj) EINA_ARG_NONNULL(1);
3173 * Pop the scroll freeze by 1
3175 * This decrements the scroll freeze count by one. If it is more
3176 * than 0 it will take effect on the parents of the indicated
3179 * @param obj The object
3180 * @ingroup Scrollhints
3182 EAPI void elm_object_scroll_freeze_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
3185 * Lock the scrolling of the given widget (and thus all parents)
3187 * This locks the given object from scrolling in the X axis (and implicitly
3188 * also locks all parent scrollers too from doing the same).
3190 * @param obj The object
3191 * @param lock The lock state (1 == locked, 0 == unlocked)
3192 * @ingroup Scrollhints
3194 EAPI void elm_object_scroll_lock_x_set(Evas_Object *obj, Eina_Bool lock) EINA_ARG_NONNULL(1);
3197 * Lock the scrolling of the given widget (and thus all parents)
3199 * This locks the given object from scrolling in the Y axis (and implicitly
3200 * also locks all parent scrollers too from doing the same).
3202 * @param obj The object
3203 * @param lock The lock state (1 == locked, 0 == unlocked)
3204 * @ingroup Scrollhints
3206 EAPI void elm_object_scroll_lock_y_set(Evas_Object *obj, Eina_Bool lock) EINA_ARG_NONNULL(1);
3209 * Get the scrolling lock of the given widget
3211 * This gets the lock for X axis scrolling.
3213 * @param obj The object
3214 * @ingroup Scrollhints
3216 EAPI Eina_Bool elm_object_scroll_lock_x_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3219 * Get the scrolling lock of the given widget
3221 * This gets the lock for X axis scrolling.
3223 * @param obj The object
3224 * @ingroup Scrollhints
3226 EAPI Eina_Bool elm_object_scroll_lock_y_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3233 * Send a signal to the widget edje object.
3235 * This function sends a signal to the edje object of the obj. An
3236 * edje program can respond to a signal by specifying matching
3237 * 'signal' and 'source' fields.
3239 * @param obj The object
3240 * @param emission The signal's name.
3241 * @param source The signal's source.
3244 EAPI void elm_object_signal_emit(Evas_Object *obj, const char *emission, const char *source) EINA_ARG_NONNULL(1);
3247 * Add a callback for a signal emitted by widget edje object.
3249 * This function connects a callback function to a signal emitted by the
3250 * edje object of the obj.
3251 * Globs can occur in either the emission or source name.
3253 * @param obj The object
3254 * @param emission The signal's name.
3255 * @param source The signal's source.
3256 * @param func The callback function to be executed when the signal is
3258 * @param data A pointer to data to pass in to the callback function.
3261 EAPI void elm_object_signal_callback_add(Evas_Object *obj, const char *emission, const char *source, Edje_Signal_Cb func, void *data) EINA_ARG_NONNULL(1, 4);
3264 * Remove a signal-triggered callback from a widget edje object.
3266 * This function removes a callback, previoulsy attached to a
3267 * signal emitted by the edje object of the obj. The parameters
3268 * emission, source and func must match exactly those passed to a
3269 * previous call to elm_object_signal_callback_add(). The data
3270 * pointer that was passed to this call will be returned.
3272 * @param obj The object
3273 * @param emission The signal's name.
3274 * @param source The signal's source.
3275 * @param func The callback function to be executed when the signal is
3277 * @return The data pointer
3280 EAPI void *elm_object_signal_callback_del(Evas_Object *obj, const char *emission, const char *source, Edje_Signal_Cb func) EINA_ARG_NONNULL(1, 4);
3283 * Add a callback for input events (key up, key down, mouse wheel)
3284 * on a given Elementary widget
3286 * @param obj The widget to add an event callback on
3287 * @param func The callback function to be executed when the event
3289 * @param data Data to pass in to @p func
3291 * Every widget in an Elementary interface set to receive focus,
3292 * with elm_object_focus_allow_set(), will propagate @b all of its
3293 * key up, key down and mouse wheel input events up to its parent
3294 * object, and so on. All of the focusable ones in this chain which
3295 * had an event callback set, with this call, will be able to treat
3296 * those events. There are two ways of making the propagation of
3297 * these event upwards in the tree of widgets to @b cease:
3298 * - Just return @c EINA_TRUE on @p func. @c EINA_FALSE will mean
3299 * the event was @b not processed, so the propagation will go on.
3300 * - The @c event_info pointer passed to @p func will contain the
3301 * event's structure and, if you OR its @c event_flags inner
3302 * value to @c EVAS_EVENT_FLAG_ON_HOLD, you're telling Elementary
3303 * one has already handled it, thus killing the event's
3306 * @note Your event callback will be issued on those events taking
3307 * place only if no other child widget of @obj has consumed the
3310 * @note Not to be confused with @c
3311 * evas_object_event_callback_add(), which will add event callbacks
3312 * per type on general Evas objects (no event propagation
3313 * infrastructure taken in account).
3315 * @note Not to be confused with @c
3316 * elm_object_signal_callback_add(), which will add callbacks to @b
3317 * signals coming from a widget's theme, not input events.
3319 * @note Not to be confused with @c
3320 * edje_object_signal_callback_add(), which does the same as
3321 * elm_object_signal_callback_add(), but directly on an Edje
3324 * @note Not to be confused with @c
3325 * evas_object_smart_callback_add(), which adds callbacks to smart
3326 * objects' <b>smart events</b>, and not input events.
3328 * @see elm_object_event_callback_del()
3332 EAPI void elm_object_event_callback_add(Evas_Object *obj, Elm_Event_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
3335 * Remove an event callback from a widget.
3337 * This function removes a callback, previoulsy attached to event emission
3339 * The parameters func and data must match exactly those passed to
3340 * a previous call to elm_object_event_callback_add(). The data pointer that
3341 * was passed to this call will be returned.
3343 * @param obj The object
3344 * @param func The callback function to be executed when the event is
3346 * @param data Data to pass in to the callback function.
3347 * @return The data pointer
3350 EAPI void *elm_object_event_callback_del(Evas_Object *obj, Elm_Event_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
3353 * Adjust size of an element for finger usage.
3355 * @param times_w How many fingers should fit horizontally
3356 * @param w Pointer to the width size to adjust
3357 * @param times_h How many fingers should fit vertically
3358 * @param h Pointer to the height size to adjust
3360 * This takes width and height sizes (in pixels) as input and a
3361 * size multiple (which is how many fingers you want to place
3362 * within the area, being "finger" the size set by
3363 * elm_finger_size_set()), and adjusts the size to be large enough
3364 * to accommodate the resulting size -- if it doesn't already
3365 * accommodate it. On return the @p w and @p h sizes pointed to by
3366 * these parameters will be modified, on those conditions.
3368 * @note This is kind of a low level Elementary call, most useful
3369 * on size evaluation times for widgets. An external user wouldn't
3370 * be calling, most of the time.
3374 EAPI void elm_coords_finger_size_adjust(int times_w, Evas_Coord *w, int times_h, Evas_Coord *h);
3377 * Get the duration for occuring long press event.
3379 * @return Timeout for long press event
3380 * @ingroup Longpress
3382 EAPI double elm_longpress_timeout_get(void);
3385 * Set the duration for occuring long press event.
3387 * @param lonpress_timeout Timeout for long press event
3388 * @ingroup Longpress
3390 EAPI void elm_longpress_timeout_set(double longpress_timeout);
3393 * @defgroup Debug Debug
3394 * don't use it unless you are sure
3400 * Print Tree object hierarchy in stdout
3402 * @param obj The root object
3405 EAPI void elm_object_tree_dump(const Evas_Object *top);
3408 * Print Elm Objects tree hierarchy in file as dot(graphviz) syntax.
3410 * @param obj The root object
3411 * @param file The path of output file
3414 EAPI void elm_object_tree_dot_dump(const Evas_Object *top, const char *file);
3421 * @defgroup Theme Theme
3423 * Elementary uses Edje to theme its widgets, naturally. But for the most
3424 * part this is hidden behind a simpler interface that lets the user set
3425 * extensions and choose the style of widgets in a much easier way.
3427 * Instead of thinking in terms of paths to Edje files and their groups
3428 * each time you want to change the appearance of a widget, Elementary
3429 * works so you can add any theme file with extensions or replace the
3430 * main theme at one point in the application, and then just set the style
3431 * of widgets with elm_object_style_set() and related functions. Elementary
3432 * will then look in its list of themes for a matching group and apply it,
3433 * and when the theme changes midway through the application, all widgets
3434 * will be updated accordingly.
3436 * There are three concepts you need to know to understand how Elementary
3437 * theming works: default theme, extensions and overlays.
3439 * Default theme, obviously enough, is the one that provides the default
3440 * look of all widgets. End users can change the theme used by Elementary
3441 * by setting the @c ELM_THEME environment variable before running an
3442 * application, or globally for all programs using the @c elementary_config
3443 * utility. Applications can change the default theme using elm_theme_set(),
3444 * but this can go against the user wishes, so it's not an adviced practice.
3446 * Ideally, applications should find everything they need in the already
3447 * provided theme, but there may be occasions when that's not enough and
3448 * custom styles are required to correctly express the idea. For this
3449 * cases, Elementary has extensions.
3451 * Extensions allow the application developer to write styles of its own
3452 * to apply to some widgets. This requires knowledge of how each widget
3453 * is themed, as extensions will always replace the entire group used by
3454 * the widget, so important signals and parts need to be there for the
3455 * object to behave properly (see documentation of Edje for details).
3456 * Once the theme for the extension is done, the application needs to add
3457 * it to the list of themes Elementary will look into, using
3458 * elm_theme_extension_add(), and set the style of the desired widgets as
3459 * he would normally with elm_object_style_set().
3461 * Overlays, on the other hand, can replace the look of all widgets by
3462 * overriding the default style. Like extensions, it's up to the application
3463 * developer to write the theme for the widgets it wants, the difference
3464 * being that when looking for the theme, Elementary will check first the
3465 * list of overlays, then the set theme and lastly the list of extensions,
3466 * so with overlays it's possible to replace the default view and every
3467 * widget will be affected. This is very much alike to setting the whole
3468 * theme for the application and will probably clash with the end user
3469 * options, not to mention the risk of ending up with not matching styles
3470 * across the program. Unless there's a very special reason to use them,
3471 * overlays should be avoided for the resons exposed before.
3473 * All these theme lists are handled by ::Elm_Theme instances. Elementary
3474 * keeps one default internally and every function that receives one of
3475 * these can be called with NULL to refer to this default (except for
3476 * elm_theme_free()). It's possible to create a new instance of a
3477 * ::Elm_Theme to set other theme for a specific widget (and all of its
3478 * children), but this is as discouraged, if not even more so, than using
3479 * overlays. Don't use this unless you really know what you are doing.
3481 * But to be less negative about things, you can look at the following
3483 * @li @ref theme_example_01 "Using extensions"
3484 * @li @ref theme_example_02 "Using overlays"
3489 * @typedef Elm_Theme
3491 * Opaque handler for the list of themes Elementary looks for when
3492 * rendering widgets.
3494 * Stay out of this unless you really know what you are doing. For most
3495 * cases, sticking to the default is all a developer needs.
3497 typedef struct _Elm_Theme Elm_Theme;
3500 * Create a new specific theme
3502 * This creates an empty specific theme that only uses the default theme. A
3503 * specific theme has its own private set of extensions and overlays too
3504 * (which are empty by default). Specific themes do not fall back to themes
3505 * of parent objects. They are not intended for this use. Use styles, overlays
3506 * and extensions when needed, but avoid specific themes unless there is no
3507 * other way (example: you want to have a preview of a new theme you are
3508 * selecting in a "theme selector" window. The preview is inside a scroller
3509 * and should display what the theme you selected will look like, but not
3510 * actually apply it yet. The child of the scroller will have a specific
3511 * theme set to show this preview before the user decides to apply it to all
3514 EAPI Elm_Theme *elm_theme_new(void);
3516 * Free a specific theme
3518 * @param th The theme to free
3520 * This frees a theme created with elm_theme_new().
3522 EAPI void elm_theme_free(Elm_Theme *th);
3524 * Copy the theme fom the source to the destination theme
3526 * @param th The source theme to copy from
3527 * @param thdst The destination theme to copy data to
3529 * This makes a one-time static copy of all the theme config, extensions
3530 * and overlays from @p th to @p thdst. If @p th references a theme, then
3531 * @p thdst is also set to reference it, with all the theme settings,
3532 * overlays and extensions that @p th had.
3534 EAPI void elm_theme_copy(Elm_Theme *th, Elm_Theme *thdst);
3536 * Tell the source theme to reference the ref theme
3538 * @param th The theme that will do the referencing
3539 * @param thref The theme that is the reference source
3541 * This clears @p th to be empty and then sets it to refer to @p thref
3542 * so @p th acts as an override to @p thref, but where its overrides
3543 * don't apply, it will fall through to @p thref for configuration.
3545 EAPI void elm_theme_ref_set(Elm_Theme *th, Elm_Theme *thref);
3547 * Return the theme referred to
3549 * @param th The theme to get the reference from
3550 * @return The referenced theme handle
3552 * This gets the theme set as the reference theme by elm_theme_ref_set().
3553 * If no theme is set as a reference, NULL is returned.
3555 EAPI Elm_Theme *elm_theme_ref_get(Elm_Theme *th);
3557 * Return the default theme
3559 * @return The default theme handle
3561 * This returns the internal default theme setup handle that all widgets
3562 * use implicitly unless a specific theme is set. This is also often use
3563 * as a shorthand of NULL.
3565 EAPI Elm_Theme *elm_theme_default_get(void);
3567 * Prepends a theme overlay to the list of overlays
3569 * @param th The theme to add to, or if NULL, the default theme
3570 * @param item The Edje file path to be used
3572 * Use this if your application needs to provide some custom overlay theme
3573 * (An Edje file that replaces some default styles of widgets) where adding
3574 * new styles, or changing system theme configuration is not possible. Do
3575 * NOT use this instead of a proper system theme configuration. Use proper
3576 * configuration files, profiles, environment variables etc. to set a theme
3577 * so that the theme can be altered by simple confiugration by a user. Using
3578 * this call to achieve that effect is abusing the API and will create lots
3581 * @see elm_theme_extension_add()
3583 EAPI void elm_theme_overlay_add(Elm_Theme *th, const char *item);
3585 * Delete a theme overlay from the list of overlays
3587 * @param th The theme to delete from, or if NULL, the default theme
3588 * @param item The name of the theme overlay
3590 * @see elm_theme_overlay_add()
3592 EAPI void elm_theme_overlay_del(Elm_Theme *th, const char *item);
3594 * Appends a theme extension to the list of extensions.
3596 * @param th The theme to add to, or if NULL, the default theme
3597 * @param item The Edje file path to be used
3599 * This is intended when an application needs more styles of widgets or new
3600 * widget themes that the default does not provide (or may not provide). The
3601 * application has "extended" usage by coming up with new custom style names
3602 * for widgets for specific uses, but as these are not "standard", they are
3603 * not guaranteed to be provided by a default theme. This means the
3604 * application is required to provide these extra elements itself in specific
3605 * Edje files. This call adds one of those Edje files to the theme search
3606 * path to be search after the default theme. The use of this call is
3607 * encouraged when default styles do not meet the needs of the application.
3608 * Use this call instead of elm_theme_overlay_add() for almost all cases.
3610 * @see elm_object_style_set()
3612 EAPI void elm_theme_extension_add(Elm_Theme *th, const char *item);
3614 * Deletes a theme extension from the list of extensions.
3616 * @param th The theme to delete from, or if NULL, the default theme
3617 * @param item The name of the theme extension
3619 * @see elm_theme_extension_add()
3621 EAPI void elm_theme_extension_del(Elm_Theme *th, const char *item);
3623 * Set the theme search order for the given theme
3625 * @param th The theme to set the search order, or if NULL, the default theme
3626 * @param theme Theme search string
3628 * This sets the search string for the theme in path-notation from first
3629 * theme to search, to last, delimited by the : character. Example:
3631 * "shiny:/path/to/file.edj:default"
3633 * See the ELM_THEME environment variable for more information.
3635 * @see elm_theme_get()
3636 * @see elm_theme_list_get()
3638 EAPI void elm_theme_set(Elm_Theme *th, const char *theme);
3640 * Return the theme search order
3642 * @param th The theme to get the search order, or if NULL, the default theme
3643 * @return The internal search order path
3645 * This function returns a colon separated string of theme elements as
3646 * returned by elm_theme_list_get().
3648 * @see elm_theme_set()
3649 * @see elm_theme_list_get()
3651 EAPI const char *elm_theme_get(Elm_Theme *th);
3653 * Return a list of theme elements to be used in a theme.
3655 * @param th Theme to get the list of theme elements from.
3656 * @return The internal list of theme elements
3658 * This returns the internal list of theme elements (will only be valid as
3659 * long as the theme is not modified by elm_theme_set() or theme is not
3660 * freed by elm_theme_free(). This is a list of strings which must not be
3661 * altered as they are also internal. If @p th is NULL, then the default
3662 * theme element list is returned.
3664 * A theme element can consist of a full or relative path to a .edj file,
3665 * or a name, without extension, for a theme to be searched in the known
3666 * theme paths for Elemementary.
3668 * @see elm_theme_set()
3669 * @see elm_theme_get()
3671 EAPI const Eina_List *elm_theme_list_get(const Elm_Theme *th);
3673 * Return the full patrh for a theme element
3675 * @param f The theme element name
3676 * @param in_search_path Pointer to a boolean to indicate if item is in the search path or not
3677 * @return The full path to the file found.
3679 * This returns a string you should free with free() on success, NULL on
3680 * failure. This will search for the given theme element, and if it is a
3681 * full or relative path element or a simple searchable name. The returned
3682 * path is the full path to the file, if searched, and the file exists, or it
3683 * is simply the full path given in the element or a resolved path if
3684 * relative to home. The @p in_search_path boolean pointed to is set to
3685 * EINA_TRUE if the file was a searchable file andis in the search path,
3686 * and EINA_FALSE otherwise.
3688 EAPI char *elm_theme_list_item_path_get(const char *f, Eina_Bool *in_search_path);
3690 * Flush the current theme.
3692 * @param th Theme to flush
3694 * This flushes caches that let elementary know where to find theme elements
3695 * in the given theme. If @p th is NULL, then the default theme is flushed.
3696 * Call this function if source theme data has changed in such a way as to
3697 * make any caches Elementary kept invalid.
3699 EAPI void elm_theme_flush(Elm_Theme *th);
3701 * This flushes all themes (default and specific ones).
3703 * This will flush all themes in the current application context, by calling
3704 * elm_theme_flush() on each of them.
3706 EAPI void elm_theme_full_flush(void);
3708 * Set the theme for all elementary using applications on the current display
3710 * @param theme The name of the theme to use. Format same as the ELM_THEME
3711 * environment variable.
3713 EAPI void elm_theme_all_set(const char *theme);
3715 * Return a list of theme elements in the theme search path
3717 * @return A list of strings that are the theme element names.
3719 * This lists all available theme files in the standard Elementary search path
3720 * for theme elements, and returns them in alphabetical order as theme
3721 * element names in a list of strings. Free this with
3722 * elm_theme_name_available_list_free() when you are done with the list.
3724 EAPI Eina_List *elm_theme_name_available_list_new(void);
3726 * Free the list returned by elm_theme_name_available_list_new()
3728 * This frees the list of themes returned by
3729 * elm_theme_name_available_list_new(). Once freed the list should no longer
3730 * be used. a new list mys be created.
3732 EAPI void elm_theme_name_available_list_free(Eina_List *list);
3734 * Set a specific theme to be used for this object and its children
3736 * @param obj The object to set the theme on
3737 * @param th The theme to set
3739 * This sets a specific theme that will be used for the given object and any
3740 * child objects it has. If @p th is NULL then the theme to be used is
3741 * cleared and the object will inherit its theme from its parent (which
3742 * ultimately will use the default theme if no specific themes are set).
3744 * Use special themes with great care as this will annoy users and make
3745 * configuration difficult. Avoid any custom themes at all if it can be
3748 EAPI void elm_object_theme_set(Evas_Object *obj, Elm_Theme *th) EINA_ARG_NONNULL(1);
3750 * Get the specific theme to be used
3752 * @param obj The object to get the specific theme from
3753 * @return The specifc theme set.
3755 * This will return a specific theme set, or NULL if no specific theme is
3756 * set on that object. It will not return inherited themes from parents, only
3757 * the specific theme set for that specific object. See elm_object_theme_set()
3758 * for more information.
3760 EAPI Elm_Theme *elm_object_theme_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3763 * Get a data item from a theme
3765 * @param th The theme, or NULL for default theme
3766 * @param key The data key to search with
3767 * @return The data value, or NULL on failure
3769 * This function is used to return data items from edc in @p th, an overlay, or an extension.
3770 * It works the same way as edje_file_data_get() except that the return is stringshared.
3772 EAPI const char *elm_theme_data_get(Elm_Theme *th, const char *key) EINA_ARG_NONNULL(2);
3778 /** @defgroup Win Win
3780 * @image html img/widget/win/preview-00.png
3781 * @image latex img/widget/win/preview-00.eps
3783 * The window class of Elementary. Contains functions to manipulate
3784 * windows. The Evas engine used to render the window contents is specified
3785 * in the system or user elementary config files (whichever is found last),
3786 * and can be overridden with the ELM_ENGINE environment variable for
3787 * testing. Engines that may be supported (depending on Evas and Ecore-Evas
3788 * compilation setup and modules actually installed at runtime) are (listed
3789 * in order of best supported and most likely to be complete and work to
3792 * @li "x11", "x", "software-x11", "software_x11" (Software rendering in X11)
3793 * @li "gl", "opengl", "opengl-x11", "opengl_x11" (OpenGL or OpenGL-ES2
3795 * @li "shot:..." (Virtual screenshot renderer - renders to output file and
3797 * @li "fb", "software-fb", "software_fb" (Linux framebuffer direct software
3799 * @li "sdl", "software-sdl", "software_sdl" (SDL software rendering to SDL
3801 * @li "gl-sdl", "gl_sdl", "opengl-sdl", "opengl_sdl" (OpenGL or OpenGL-ES2
3802 * rendering using SDL as the buffer)
3803 * @li "gdi", "software-gdi", "software_gdi" (Windows WIN32 rendering via
3804 * GDI with software)
3805 * @li "dfb", "directfb" (Rendering to a DirectFB window)
3806 * @li "x11-8", "x8", "software-8-x11", "software_8_x11" (Rendering in
3807 * grayscale using dedicated 8bit software engine in X11)
3808 * @li "x11-16", "x16", "software-16-x11", "software_16_x11" (Rendering in
3809 * X11 using 16bit software engine)
3810 * @li "wince-gdi", "software-16-wince-gdi", "software_16_wince_gdi"
3811 * (Windows CE rendering via GDI with 16bit software renderer)
3812 * @li "sdl-16", "software-16-sdl", "software_16_sdl" (Rendering to SDL
3813 * buffer with 16bit software renderer)
3814 * @li "ews" (rendering to EWS - Ecore + Evas Single Process Windowing System)
3815 * @li "gl-cocoa", "gl_cocoa", "opengl-cocoa", "opengl_cocoa" (OpenGL rendering in Cocoa)
3816 * @li "psl1ght" (PS3 rendering using PSL1GHT)
3818 * All engines use a simple string to select the engine to render, EXCEPT
3819 * the "shot" engine. This actually encodes the output of the virtual
3820 * screenshot and how long to delay in the engine string. The engine string
3821 * is encoded in the following way:
3823 * "shot:[delay=XX][:][repeat=DDD][:][file=XX]"
3825 * Where options are separated by a ":" char if more than one option is
3826 * given, with delay, if provided being the first option and file the last
3827 * (order is important). The delay specifies how long to wait after the
3828 * window is shown before doing the virtual "in memory" rendering and then
3829 * save the output to the file specified by the file option (and then exit).
3830 * If no delay is given, the default is 0.5 seconds. If no file is given the
3831 * default output file is "out.png". Repeat option is for continous
3832 * capturing screenshots. Repeat range is from 1 to 999 and filename is
3833 * fixed to "out001.png" Some examples of using the shot engine:
3835 * ELM_ENGINE="shot:delay=1.0:repeat=5:file=elm_test.png" elementary_test
3836 * ELM_ENGINE="shot:delay=1.0:file=elm_test.png" elementary_test
3837 * ELM_ENGINE="shot:file=elm_test2.png" elementary_test
3838 * ELM_ENGINE="shot:delay=2.0" elementary_test
3839 * ELM_ENGINE="shot:" elementary_test
3841 * Signals that you can add callbacks for are:
3843 * @li "delete,request": the user requested to close the window. See
3844 * elm_win_autodel_set().
3845 * @li "focus,in": window got focus
3846 * @li "focus,out": window lost focus
3847 * @li "moved": window that holds the canvas was moved
3850 * @li @ref win_example_01
3855 * Defines the types of window that can be created
3857 * These are hints set on the window so that a running Window Manager knows
3858 * how the window should be handled and/or what kind of decorations it
3861 * Currently, only the X11 backed engines use them.
3863 typedef enum _Elm_Win_Type
3865 ELM_WIN_BASIC, /**< A normal window. Indicates a normal, top-level
3866 window. Almost every window will be created with this
3868 ELM_WIN_DIALOG_BASIC, /**< Used for simple dialog windows/ */
3869 ELM_WIN_DESKTOP, /**< For special desktop windows, like a background
3870 window holding desktop icons. */
3871 ELM_WIN_DOCK, /**< The window is used as a dock or panel. Usually would
3872 be kept on top of any other window by the Window
3874 ELM_WIN_TOOLBAR, /**< The window is used to hold a floating toolbar, or
3876 ELM_WIN_MENU, /**< Similar to #ELM_WIN_TOOLBAR. */
3877 ELM_WIN_UTILITY, /**< A persistent utility window, like a toolbox or
3879 ELM_WIN_SPLASH, /**< Splash window for a starting up application. */
3880 ELM_WIN_DROPDOWN_MENU, /**< The window is a dropdown menu, as when an
3881 entry in a menubar is clicked. Typically used
3882 with elm_win_override_set(). This hint exists
3883 for completion only, as the EFL way of
3884 implementing a menu would not normally use a
3885 separate window for its contents. */
3886 ELM_WIN_POPUP_MENU, /**< Like #ELM_WIN_DROPDOWN_MENU, but for the menu
3887 triggered by right-clicking an object. */
3888 ELM_WIN_TOOLTIP, /**< The window is a tooltip. A short piece of
3889 explanatory text that typically appear after the
3890 mouse cursor hovers over an object for a while.
3891 Typically used with elm_win_override_set() and also
3892 not very commonly used in the EFL. */
3893 ELM_WIN_NOTIFICATION, /**< A notification window, like a warning about
3894 battery life or a new E-Mail received. */
3895 ELM_WIN_COMBO, /**< A window holding the contents of a combo box. Not
3896 usually used in the EFL. */
3897 ELM_WIN_DND, /**< Used to indicate the window is a representation of an
3898 object being dragged across different windows, or even
3899 applications. Typically used with
3900 elm_win_override_set(). */
3901 ELM_WIN_INLINED_IMAGE, /**< The window is rendered onto an image
3902 buffer. No actual window is created for this
3903 type, instead the window and all of its
3904 contents will be rendered to an image buffer.
3905 This allows to have children window inside a
3906 parent one just like any other object would
3907 be, and do other things like applying @c
3908 Evas_Map effects to it. This is the only type
3909 of window that requires the @c parent
3910 parameter of elm_win_add() to be a valid @c
3915 * The differents layouts that can be requested for the virtual keyboard.
3917 * When the application window is being managed by Illume, it may request
3918 * any of the following layouts for the virtual keyboard.
3920 typedef enum _Elm_Win_Keyboard_Mode
3922 ELM_WIN_KEYBOARD_UNKNOWN, /**< Unknown keyboard state */
3923 ELM_WIN_KEYBOARD_OFF, /**< Request to deactivate the keyboard */
3924 ELM_WIN_KEYBOARD_ON, /**< Enable keyboard with default layout */
3925 ELM_WIN_KEYBOARD_ALPHA, /**< Alpha (a-z) keyboard layout */
3926 ELM_WIN_KEYBOARD_NUMERIC, /**< Numeric keyboard layout */
3927 ELM_WIN_KEYBOARD_PIN, /**< PIN keyboard layout */
3928 ELM_WIN_KEYBOARD_PHONE_NUMBER, /**< Phone keyboard layout */
3929 ELM_WIN_KEYBOARD_HEX, /**< Hexadecimal numeric keyboard layout */
3930 ELM_WIN_KEYBOARD_TERMINAL, /**< Full (QUERTY) keyboard layout */
3931 ELM_WIN_KEYBOARD_PASSWORD, /**< Password keyboard layout */
3932 ELM_WIN_KEYBOARD_IP, /**< IP keyboard layout */
3933 ELM_WIN_KEYBOARD_HOST, /**< Host keyboard layout */
3934 ELM_WIN_KEYBOARD_FILE, /**< File keyboard layout */
3935 ELM_WIN_KEYBOARD_URL, /**< URL keyboard layout */
3936 ELM_WIN_KEYBOARD_KEYPAD, /**< Keypad layout */
3937 ELM_WIN_KEYBOARD_J2ME /**< J2ME keyboard layout */
3938 } Elm_Win_Keyboard_Mode;
3941 * Available commands that can be sent to the Illume manager.
3943 * When running under an Illume session, a window may send commands to the
3944 * Illume manager to perform different actions.
3946 typedef enum _Elm_Illume_Command
3948 ELM_ILLUME_COMMAND_FOCUS_BACK, /**< Reverts focus to the previous
3950 ELM_ILLUME_COMMAND_FOCUS_FORWARD, /**< Sends focus to the next window\
3952 ELM_ILLUME_COMMAND_FOCUS_HOME, /**< Hides all windows to show the Home
3954 ELM_ILLUME_COMMAND_CLOSE /**< Closes the currently active window */
3955 } Elm_Illume_Command;
3958 * Adds a window object. If this is the first window created, pass NULL as
3961 * @param parent Parent object to add the window to, or NULL
3962 * @param name The name of the window
3963 * @param type The window type, one of #Elm_Win_Type.
3965 * The @p parent paramter can be @c NULL for every window @p type except
3966 * #ELM_WIN_INLINED_IMAGE, which needs a parent to retrieve the canvas on
3967 * which the image object will be created.
3969 * @return The created object, or NULL on failure
3971 EAPI Evas_Object *elm_win_add(Evas_Object *parent, const char *name, Elm_Win_Type type);
3973 * Adds a window object with standard setup
3975 * @param name The name of the window
3976 * @param title The title for the window
3978 * This creates a window like elm_win_add() but also puts in a standard
3979 * background with elm_bg_add(), as well as setting the window title to
3980 * @p title. The window type created is of type ELM_WIN_BASIC, with NULL
3981 * as the parent widget.
3983 * @return The created object, or NULL on failure
3985 * @see elm_win_add()
3987 EAPI Evas_Object *elm_win_util_standard_add(const char *name, const char *title);
3989 * Add @p subobj as a resize object of window @p obj.
3992 * Setting an object as a resize object of the window means that the
3993 * @p subobj child's size and position will be controlled by the window
3994 * directly. That is, the object will be resized to match the window size
3995 * and should never be moved or resized manually by the developer.
3997 * In addition, resize objects of the window control what the minimum size
3998 * of it will be, as well as whether it can or not be resized by the user.
4000 * For the end user to be able to resize a window by dragging the handles
4001 * or borders provided by the Window Manager, or using any other similar
4002 * mechanism, all of the resize objects in the window should have their
4003 * evas_object_size_hint_weight_set() set to EVAS_HINT_EXPAND.
4005 * @param obj The window object
4006 * @param subobj The resize object to add
4008 EAPI void elm_win_resize_object_add(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
4010 * Delete @p subobj as a resize object of window @p obj.
4012 * This function removes the object @p subobj from the resize objects of
4013 * the window @p obj. It will not delete the object itself, which will be
4014 * left unmanaged and should be deleted by the developer, manually handled
4015 * or set as child of some other container.
4017 * @param obj The window object
4018 * @param subobj The resize object to add
4020 EAPI void elm_win_resize_object_del(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
4022 * Set the title of the window
4024 * @param obj The window object
4025 * @param title The title to set
4027 EAPI void elm_win_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
4029 * Get the title of the window
4031 * The returned string is an internal one and should not be freed or
4032 * modified. It will also be rendered invalid if a new title is set or if
4033 * the window is destroyed.
4035 * @param obj The window object
4038 EAPI const char *elm_win_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4040 * Set the window's autodel state.
4042 * When closing the window in any way outside of the program control, like
4043 * pressing the X button in the titlebar or using a command from the
4044 * Window Manager, a "delete,request" signal is emitted to indicate that
4045 * this event occurred and the developer can take any action, which may
4046 * include, or not, destroying the window object.
4048 * When the @p autodel parameter is set, the window will be automatically
4049 * destroyed when this event occurs, after the signal is emitted.
4050 * If @p autodel is @c EINA_FALSE, then the window will not be destroyed
4051 * and is up to the program to do so when it's required.
4053 * @param obj The window object
4054 * @param autodel If true, the window will automatically delete itself when
4057 EAPI void elm_win_autodel_set(Evas_Object *obj, Eina_Bool autodel) EINA_ARG_NONNULL(1);
4059 * Get the window's autodel state.
4061 * @param obj The window object
4062 * @return If the window will automatically delete itself when closed
4064 * @see elm_win_autodel_set()
4066 EAPI Eina_Bool elm_win_autodel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4068 * Activate a window object.
4070 * This function sends a request to the Window Manager to activate the
4071 * window pointed by @p obj. If honored by the WM, the window will receive
4072 * the keyboard focus.
4074 * @note This is just a request that a Window Manager may ignore, so calling
4075 * this function does not ensure in any way that the window will be the
4076 * active one after it.
4078 * @param obj The window object
4080 EAPI void elm_win_activate(Evas_Object *obj) EINA_ARG_NONNULL(1);
4082 * Lower a window object.
4084 * Places the window pointed by @p obj at the bottom of the stack, so that
4085 * no other window is covered by it.
4087 * If elm_win_override_set() is not set, the Window Manager may ignore this
4090 * @param obj The window object
4092 EAPI void elm_win_lower(Evas_Object *obj) EINA_ARG_NONNULL(1);
4094 * Raise a window object.
4096 * Places the window pointed by @p obj at the top of the stack, so that it's
4097 * not covered by any other window.
4099 * If elm_win_override_set() is not set, the Window Manager may ignore this
4102 * @param obj The window object
4104 EAPI void elm_win_raise(Evas_Object *obj) EINA_ARG_NONNULL(1);
4106 * Set the borderless state of a window.
4108 * This function requests the Window Manager to not draw any decoration
4109 * around the window.
4111 * @param obj The window object
4112 * @param borderless If true, the window is borderless
4114 EAPI void elm_win_borderless_set(Evas_Object *obj, Eina_Bool borderless) EINA_ARG_NONNULL(1);
4116 * Get the borderless state of a window.
4118 * @param obj The window object
4119 * @return If true, the window is borderless
4121 EAPI Eina_Bool elm_win_borderless_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4123 * Set the shaped state of a window.
4125 * Shaped windows, when supported, will render the parts of the window that
4126 * has no content, transparent.
4128 * If @p shaped is EINA_FALSE, then it is strongly adviced to have some
4129 * background object or cover the entire window in any other way, or the
4130 * parts of the canvas that have no data will show framebuffer artifacts.
4132 * @param obj The window object
4133 * @param shaped If true, the window is shaped
4135 * @see elm_win_alpha_set()
4137 EAPI void elm_win_shaped_set(Evas_Object *obj, Eina_Bool shaped) EINA_ARG_NONNULL(1);
4139 * Get the shaped state of a window.
4141 * @param obj The window object
4142 * @return If true, the window is shaped
4144 * @see elm_win_shaped_set()
4146 EAPI Eina_Bool elm_win_shaped_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4148 * Set the alpha channel state of a window.
4150 * If @p alpha is EINA_TRUE, the alpha channel of the canvas will be enabled
4151 * possibly making parts of the window completely or partially transparent.
4152 * This is also subject to the underlying system supporting it, like for
4153 * example, running under a compositing manager. If no compositing is
4154 * available, enabling this option will instead fallback to using shaped
4155 * windows, with elm_win_shaped_set().
4157 * @param obj The window object
4158 * @param alpha If true, the window has an alpha channel
4160 * @see elm_win_alpha_set()
4162 EAPI void elm_win_alpha_set(Evas_Object *obj, Eina_Bool alpha) EINA_ARG_NONNULL(1);
4164 * Get the transparency state of a window.
4166 * @param obj The window object
4167 * @return If true, the window is transparent
4169 * @see elm_win_transparent_set()
4171 EAPI Eina_Bool elm_win_transparent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4173 * Set the transparency state of a window.
4175 * Use elm_win_alpha_set() instead.
4177 * @param obj The window object
4178 * @param transparent If true, the window is transparent
4180 * @see elm_win_alpha_set()
4182 EAPI void elm_win_transparent_set(Evas_Object *obj, Eina_Bool transparent) EINA_ARG_NONNULL(1);
4184 * Get the alpha channel state of a window.
4186 * @param obj The window object
4187 * @return If true, the window has an alpha channel
4189 EAPI Eina_Bool elm_win_alpha_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4191 * Set the override state of a window.
4193 * A window with @p override set to EINA_TRUE will not be managed by the
4194 * Window Manager. This means that no decorations of any kind will be shown
4195 * for it, moving and resizing must be handled by the application, as well
4196 * as the window visibility.
4198 * This should not be used for normal windows, and even for not so normal
4199 * ones, it should only be used when there's a good reason and with a lot
4200 * of care. Mishandling override windows may result situations that
4201 * disrupt the normal workflow of the end user.
4203 * @param obj The window object
4204 * @param override If true, the window is overridden
4206 EAPI void elm_win_override_set(Evas_Object *obj, Eina_Bool override) EINA_ARG_NONNULL(1);
4208 * Get the override state of a window.
4210 * @param obj The window object
4211 * @return If true, the window is overridden
4213 * @see elm_win_override_set()
4215 EAPI Eina_Bool elm_win_override_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4217 * Set the fullscreen state of a window.
4219 * @param obj The window object
4220 * @param fullscreen If true, the window is fullscreen
4222 EAPI void elm_win_fullscreen_set(Evas_Object *obj, Eina_Bool fullscreen) EINA_ARG_NONNULL(1);
4224 * Get the fullscreen state of a window.
4226 * @param obj The window object
4227 * @return If true, the window is fullscreen
4229 EAPI Eina_Bool elm_win_fullscreen_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4231 * Set the maximized state of a window.
4233 * @param obj The window object
4234 * @param maximized If true, the window is maximized
4236 EAPI void elm_win_maximized_set(Evas_Object *obj, Eina_Bool maximized) EINA_ARG_NONNULL(1);
4238 * Get the maximized state of a window.
4240 * @param obj The window object
4241 * @return If true, the window is maximized
4243 EAPI Eina_Bool elm_win_maximized_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4245 * Set the iconified state of a window.
4247 * @param obj The window object
4248 * @param iconified If true, the window is iconified
4250 EAPI void elm_win_iconified_set(Evas_Object *obj, Eina_Bool iconified) EINA_ARG_NONNULL(1);
4252 * Get the iconified state of a window.
4254 * @param obj The window object
4255 * @return If true, the window is iconified
4257 EAPI Eina_Bool elm_win_iconified_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4259 * Set the layer of the window.
4261 * What this means exactly will depend on the underlying engine used.
4263 * In the case of X11 backed engines, the value in @p layer has the
4264 * following meanings:
4265 * @li < 3: The window will be placed below all others.
4266 * @li > 5: The window will be placed above all others.
4267 * @li other: The window will be placed in the default layer.
4269 * @param obj The window object
4270 * @param layer The layer of the window
4272 EAPI void elm_win_layer_set(Evas_Object *obj, int layer) EINA_ARG_NONNULL(1);
4274 * Get the layer of the window.
4276 * @param obj The window object
4277 * @return The layer of the window
4279 * @see elm_win_layer_set()
4281 EAPI int elm_win_layer_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4283 * Set the rotation of the window.
4285 * Most engines only work with multiples of 90.
4287 * This function is used to set the orientation of the window @p obj to
4288 * match that of the screen. The window itself will be resized to adjust
4289 * to the new geometry of its contents. If you want to keep the window size,
4290 * see elm_win_rotation_with_resize_set().
4292 * @param obj The window object
4293 * @param rotation The rotation of the window, in degrees (0-360),
4294 * counter-clockwise.
4296 EAPI void elm_win_rotation_set(Evas_Object *obj, int rotation) EINA_ARG_NONNULL(1);
4298 * Rotates the window and resizes it.
4300 * Like elm_win_rotation_set(), but it also resizes the window's contents so
4301 * that they fit inside the current window geometry.
4303 * @param obj The window object
4304 * @param layer The rotation of the window in degrees (0-360),
4305 * counter-clockwise.
4307 EAPI void elm_win_rotation_with_resize_set(Evas_Object *obj, int rotation) EINA_ARG_NONNULL(1);
4309 * Get the rotation of the window.
4311 * @param obj The window object
4312 * @return The rotation of the window in degrees (0-360)
4314 * @see elm_win_rotation_set()
4315 * @see elm_win_rotation_with_resize_set()
4317 EAPI int elm_win_rotation_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4319 * Set the sticky state of the window.
4321 * Hints the Window Manager that the window in @p obj should be left fixed
4322 * at its position even when the virtual desktop it's on moves or changes.
4324 * @param obj The window object
4325 * @param sticky If true, the window's sticky state is enabled
4327 EAPI void elm_win_sticky_set(Evas_Object *obj, Eina_Bool sticky) EINA_ARG_NONNULL(1);
4329 * Get the sticky state of the window.
4331 * @param obj The window object
4332 * @return If true, the window's sticky state is enabled
4334 * @see elm_win_sticky_set()
4336 EAPI Eina_Bool elm_win_sticky_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4338 * Set if this window is an illume conformant window
4340 * @param obj The window object
4341 * @param conformant The conformant flag (1 = conformant, 0 = non-conformant)
4343 EAPI void elm_win_conformant_set(Evas_Object *obj, Eina_Bool conformant) EINA_ARG_NONNULL(1);
4345 * Get if this window is an illume conformant window
4347 * @param obj The window object
4348 * @return A boolean if this window is illume conformant or not
4350 EAPI Eina_Bool elm_win_conformant_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4352 * Set a window to be an illume quickpanel window
4354 * By default window objects are not quickpanel windows.
4356 * @param obj The window object
4357 * @param quickpanel The quickpanel flag (1 = quickpanel, 0 = normal window)
4359 EAPI void elm_win_quickpanel_set(Evas_Object *obj, Eina_Bool quickpanel) EINA_ARG_NONNULL(1);
4361 * Get if this window is a quickpanel or not
4363 * @param obj The window object
4364 * @return A boolean if this window is a quickpanel or not
4366 EAPI Eina_Bool elm_win_quickpanel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4368 * Set the major priority of a quickpanel window
4370 * @param obj The window object
4371 * @param priority The major priority for this quickpanel
4373 EAPI void elm_win_quickpanel_priority_major_set(Evas_Object *obj, int priority) EINA_ARG_NONNULL(1);
4375 * Get the major priority of a quickpanel window
4377 * @param obj The window object
4378 * @return The major priority of this quickpanel
4380 EAPI int elm_win_quickpanel_priority_major_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4382 * Set the minor priority of a quickpanel window
4384 * @param obj The window object
4385 * @param priority The minor priority for this quickpanel
4387 EAPI void elm_win_quickpanel_priority_minor_set(Evas_Object *obj, int priority) EINA_ARG_NONNULL(1);
4389 * Get the minor priority of a quickpanel window
4391 * @param obj The window object
4392 * @return The minor priority of this quickpanel
4394 EAPI int elm_win_quickpanel_priority_minor_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4396 * Set which zone this quickpanel should appear in
4398 * @param obj The window object
4399 * @param zone The requested zone for this quickpanel
4401 EAPI void elm_win_quickpanel_zone_set(Evas_Object *obj, int zone) EINA_ARG_NONNULL(1);
4403 * Get which zone this quickpanel should appear in
4405 * @param obj The window object
4406 * @return The requested zone for this quickpanel
4408 EAPI int elm_win_quickpanel_zone_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4410 * Set the window to be skipped by keyboard focus
4412 * This sets the window to be skipped by normal keyboard input. This means
4413 * a window manager will be asked to not focus this window as well as omit
4414 * it from things like the taskbar, pager, "alt-tab" list etc. etc.
4416 * Call this and enable it on a window BEFORE you show it for the first time,
4417 * otherwise it may have no effect.
4419 * Use this for windows that have only output information or might only be
4420 * interacted with by the mouse or fingers, and never for typing input.
4421 * Be careful that this may have side-effects like making the window
4422 * non-accessible in some cases unless the window is specially handled. Use
4425 * @param obj The window object
4426 * @param skip The skip flag state (EINA_TRUE if it is to be skipped)
4428 EAPI void elm_win_prop_focus_skip_set(Evas_Object *obj, Eina_Bool skip) EINA_ARG_NONNULL(1);
4430 * Send a command to the windowing environment
4432 * This is intended to work in touchscreen or small screen device
4433 * environments where there is a more simplistic window management policy in
4434 * place. This uses the window object indicated to select which part of the
4435 * environment to control (the part that this window lives in), and provides
4436 * a command and an optional parameter structure (use NULL for this if not
4439 * @param obj The window object that lives in the environment to control
4440 * @param command The command to send
4441 * @param params Optional parameters for the command
4443 EAPI void elm_win_illume_command_send(Evas_Object *obj, Elm_Illume_Command command, void *params) EINA_ARG_NONNULL(1);
4445 * Get the inlined image object handle
4447 * When you create a window with elm_win_add() of type ELM_WIN_INLINED_IMAGE,
4448 * then the window is in fact an evas image object inlined in the parent
4449 * canvas. You can get this object (be careful to not manipulate it as it
4450 * is under control of elementary), and use it to do things like get pixel
4451 * data, save the image to a file, etc.
4453 * @param obj The window object to get the inlined image from
4454 * @return The inlined image object, or NULL if none exists
4456 EAPI Evas_Object *elm_win_inlined_image_object_get(Evas_Object *obj);
4458 * Determine whether a window has focus
4459 * @param obj The window to query
4460 * @return EINA_TRUE if the window exists and has focus, else EINA_FALSE
4462 EAPI Eina_Bool elm_win_focus_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4464 * Get screen geometry details for the screen that a window is on
4465 * @param obj The window to query
4466 * @param x where to return the horizontal offset value. May be NULL.
4467 * @param y where to return the vertical offset value. May be NULL.
4468 * @param w where to return the width value. May be NULL.
4469 * @param h where to return the height value. May be NULL.
4471 EAPI void elm_win_screen_size_get(const Evas_Object *obj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
4473 * Set the enabled status for the focus highlight in a window
4475 * This function will enable or disable the focus highlight only for the
4476 * given window, regardless of the global setting for it
4478 * @param obj The window where to enable the highlight
4479 * @param enabled The enabled value for the highlight
4481 EAPI void elm_win_focus_highlight_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
4483 * Get the enabled value of the focus highlight for this window
4485 * @param obj The window in which to check if the focus highlight is enabled
4487 * @return EINA_TRUE if enabled, EINA_FALSE otherwise
4489 EAPI Eina_Bool elm_win_focus_highlight_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4491 * Set the style for the focus highlight on this window
4493 * Sets the style to use for theming the highlight of focused objects on
4494 * the given window. If @p style is NULL, the default will be used.
4496 * @param obj The window where to set the style
4497 * @param style The style to set
4499 EAPI void elm_win_focus_highlight_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
4501 * Get the style set for the focus highlight object
4503 * Gets the style set for this windows highilght object, or NULL if none
4506 * @param obj The window to retrieve the highlights style from
4508 * @return The style set or NULL if none was. Default is used in that case.
4510 EAPI const char *elm_win_focus_highlight_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4512 * ecore_x_icccm_hints_set -> accepts_focus (add to ecore_evas)
4513 * ecore_x_icccm_hints_set -> window_group (add to ecore_evas)
4514 * ecore_x_icccm_size_pos_hints_set -> request_pos (add to ecore_evas)
4515 * ecore_x_icccm_client_leader_set -> l (add to ecore_evas)
4516 * ecore_x_icccm_window_role_set -> role (add to ecore_evas)
4517 * ecore_x_icccm_transient_for_set -> forwin (add to ecore_evas)
4518 * ecore_x_netwm_window_type_set -> type (add to ecore_evas)
4520 * (add to ecore_x) set netwm argb icon! (add to ecore_evas)
4521 * (blank mouse, private mouse obj, defaultmouse)
4525 * Sets the keyboard mode of the window.
4527 * @param obj The window object
4528 * @param mode The mode to set, one of #Elm_Win_Keyboard_Mode
4530 EAPI void elm_win_keyboard_mode_set(Evas_Object *obj, Elm_Win_Keyboard_Mode mode) EINA_ARG_NONNULL(1);
4532 * Gets the keyboard mode of the window.
4534 * @param obj The window object
4535 * @return The mode, one of #Elm_Win_Keyboard_Mode
4537 EAPI Elm_Win_Keyboard_Mode elm_win_keyboard_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4539 * Sets whether the window is a keyboard.
4541 * @param obj The window object
4542 * @param is_keyboard If true, the window is a virtual keyboard
4544 EAPI void elm_win_keyboard_win_set(Evas_Object *obj, Eina_Bool is_keyboard) EINA_ARG_NONNULL(1);
4546 * Gets whether the window is a keyboard.
4548 * @param obj The window object
4549 * @return If the window is a virtual keyboard
4551 EAPI Eina_Bool elm_win_keyboard_win_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4554 * Get the screen position of a window.
4556 * @param obj The window object
4557 * @param x The int to store the x coordinate to
4558 * @param y The int to store the y coordinate to
4560 EAPI void elm_win_screen_position_get(const Evas_Object *obj, int *x, int *y) EINA_ARG_NONNULL(1);
4566 * @defgroup Inwin Inwin
4568 * @image html img/widget/inwin/preview-00.png
4569 * @image latex img/widget/inwin/preview-00.eps
4570 * @image html img/widget/inwin/preview-01.png
4571 * @image latex img/widget/inwin/preview-01.eps
4572 * @image html img/widget/inwin/preview-02.png
4573 * @image latex img/widget/inwin/preview-02.eps
4575 * An inwin is a window inside a window that is useful for a quick popup.
4576 * It does not hover.
4578 * It works by creating an object that will occupy the entire window, so it
4579 * must be created using an @ref Win "elm_win" as parent only. The inwin
4580 * object can be hidden or restacked below every other object if it's
4581 * needed to show what's behind it without destroying it. If this is done,
4582 * the elm_win_inwin_activate() function can be used to bring it back to
4583 * full visibility again.
4585 * There are three styles available in the default theme. These are:
4586 * @li default: The inwin is sized to take over most of the window it's
4588 * @li minimal: The size of the inwin will be the minimum necessary to show
4590 * @li minimal_vertical: Horizontally, the inwin takes as much space as
4591 * possible, but it's sized vertically the most it needs to fit its\
4594 * Some examples of Inwin can be found in the following:
4595 * @li @ref inwin_example_01
4600 * Adds an inwin to the current window
4602 * The @p obj used as parent @b MUST be an @ref Win "Elementary Window".
4603 * Never call this function with anything other than the top-most window
4604 * as its parameter, unless you are fond of undefined behavior.
4606 * After creating the object, the widget will set itself as resize object
4607 * for the window with elm_win_resize_object_add(), so when shown it will
4608 * appear to cover almost the entire window (how much of it depends on its
4609 * content and the style used). It must not be added into other container
4610 * objects and it needs not be moved or resized manually.
4612 * @param parent The parent object
4613 * @return The new object or NULL if it cannot be created
4615 EAPI Evas_Object *elm_win_inwin_add(Evas_Object *obj) EINA_ARG_NONNULL(1);
4617 * Activates an inwin object, ensuring its visibility
4619 * This function will make sure that the inwin @p obj is completely visible
4620 * by calling evas_object_show() and evas_object_raise() on it, to bring it
4621 * to the front. It also sets the keyboard focus to it, which will be passed
4624 * The object's theme will also receive the signal "elm,action,show" with
4627 * @param obj The inwin to activate
4629 EAPI void elm_win_inwin_activate(Evas_Object *obj) EINA_ARG_NONNULL(1);
4631 * Set the content of an inwin object.
4633 * Once the content object is set, a previously set one will be deleted.
4634 * If you want to keep that old content object, use the
4635 * elm_win_inwin_content_unset() function.
4637 * @param obj The inwin object
4638 * @param content The object to set as content
4640 EAPI void elm_win_inwin_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
4642 * Get the content of an inwin object.
4644 * Return the content object which is set for this widget.
4646 * The returned object is valid as long as the inwin is still alive and no
4647 * other content is set on it. Deleting the object will notify the inwin
4648 * about it and this one will be left empty.
4650 * If you need to remove an inwin's content to be reused somewhere else,
4651 * see elm_win_inwin_content_unset().
4653 * @param obj The inwin object
4654 * @return The content that is being used
4656 EAPI Evas_Object *elm_win_inwin_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4658 * Unset the content of an inwin object.
4660 * Unparent and return the content object which was set for this widget.
4662 * @param obj The inwin object
4663 * @return The content that was being used
4665 EAPI Evas_Object *elm_win_inwin_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4669 /* X specific calls - won't work on non-x engines (return 0) */
4672 * Get the Ecore_X_Window of an Evas_Object
4674 * @param obj The object
4676 * @return The Ecore_X_Window of @p obj
4680 EAPI Ecore_X_Window elm_win_xwindow_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4682 /* smart callbacks called:
4683 * "delete,request" - the user requested to delete the window
4684 * "focus,in" - window got focus
4685 * "focus,out" - window lost focus
4686 * "moved" - window that holds the canvas was moved
4692 * @image html img/widget/bg/preview-00.png
4693 * @image latex img/widget/bg/preview-00.eps
4695 * @brief Background object, used for setting a solid color, image or Edje
4696 * group as background to a window or any container object.
4698 * The bg object is used for setting a solid background to a window or
4699 * packing into any container object. It works just like an image, but has
4700 * some properties useful to a background, like setting it to tiled,
4701 * centered, scaled or stretched.
4703 * Default contents parts of the bg widget that you can use for are:
4704 * @li "overlay" - overlay of the bg
4706 * Here is some sample code using it:
4707 * @li @ref bg_01_example_page
4708 * @li @ref bg_02_example_page
4709 * @li @ref bg_03_example_page
4713 typedef enum _Elm_Bg_Option
4715 ELM_BG_OPTION_CENTER, /**< center the background */
4716 ELM_BG_OPTION_SCALE, /**< scale the background retaining aspect ratio */
4717 ELM_BG_OPTION_STRETCH, /**< stretch the background to fill */
4718 ELM_BG_OPTION_TILE /**< tile background at its original size */
4722 * Add a new background to the parent
4724 * @param parent The parent object
4725 * @return The new object or NULL if it cannot be created
4729 EAPI Evas_Object *elm_bg_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4732 * Set the file (image or edje) used for the background
4734 * @param obj The bg object
4735 * @param file The file path
4736 * @param group Optional key (group in Edje) within the file
4738 * This sets the image file used in the background object. The image (or edje)
4739 * will be stretched (retaining aspect if its an image file) to completely fill
4740 * the bg object. This may mean some parts are not visible.
4742 * @note Once the image of @p obj is set, a previously set one will be deleted,
4743 * even if @p file is NULL.
4747 EAPI void elm_bg_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1);
4750 * Get the file (image or edje) used for the background
4752 * @param obj The bg object
4753 * @param file The file path
4754 * @param group Optional key (group in Edje) within the file
4758 EAPI void elm_bg_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
4761 * Set the option used for the background image
4763 * @param obj The bg object
4764 * @param option The desired background option (TILE, SCALE)
4766 * This sets the option used for manipulating the display of the background
4767 * image. The image can be tiled or scaled.
4771 EAPI void elm_bg_option_set(Evas_Object *obj, Elm_Bg_Option option) EINA_ARG_NONNULL(1);
4774 * Get the option used for the background image
4776 * @param obj The bg object
4777 * @return The desired background option (CENTER, SCALE, STRETCH or TILE)
4781 EAPI Elm_Bg_Option elm_bg_option_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4783 * Set the option used for the background color
4785 * @param obj The bg object
4790 * This sets the color used for the background rectangle. Its range goes
4795 EAPI void elm_bg_color_set(Evas_Object *obj, int r, int g, int b) EINA_ARG_NONNULL(1);
4797 * Get the option used for the background color
4799 * @param obj The bg object
4806 EAPI void elm_bg_color_get(const Evas_Object *obj, int *r, int *g, int *b) EINA_ARG_NONNULL(1);
4809 * Set the overlay object used for the background object.
4811 * @param obj The bg object
4812 * @param overlay The overlay object
4814 * This provides a way for elm_bg to have an 'overlay' that will be on top
4815 * of the bg. Once the over object is set, a previously set one will be
4816 * deleted, even if you set the new one to NULL. If you want to keep that
4817 * old content object, use the elm_bg_overlay_unset() function.
4819 * @deprecated use elm_object_part_content_set() instead
4824 EINA_DEPRECATED EAPI void elm_bg_overlay_set(Evas_Object *obj, Evas_Object *overlay) EINA_ARG_NONNULL(1);
4827 * Get the overlay object used for the background object.
4829 * @param obj The bg object
4830 * @return The content that is being used
4832 * Return the content object which is set for this widget
4834 * @deprecated use elm_object_part_content_get() instead
4838 EINA_DEPRECATED EAPI Evas_Object *elm_bg_overlay_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4841 * Get the overlay object used for the background object.
4843 * @param obj The bg object
4844 * @return The content that was being used
4846 * Unparent and return the overlay object which was set for this widget
4848 * @deprecated use elm_object_part_content_unset() instead
4852 EINA_DEPRECATED EAPI Evas_Object *elm_bg_overlay_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4855 * Set the size of the pixmap representation of the image.
4857 * This option just makes sense if an image is going to be set in the bg.
4859 * @param obj The bg object
4860 * @param w The new width of the image pixmap representation.
4861 * @param h The new height of the image pixmap representation.
4863 * This function sets a new size for pixmap representation of the given bg
4864 * image. It allows the image to be loaded already in the specified size,
4865 * reducing the memory usage and load time when loading a big image with load
4866 * size set to a smaller size.
4868 * NOTE: this is just a hint, the real size of the pixmap may differ
4869 * depending on the type of image being loaded, being bigger than requested.
4873 EAPI void elm_bg_load_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
4874 /* smart callbacks called:
4878 * @defgroup Icon Icon
4880 * @image html img/widget/icon/preview-00.png
4881 * @image latex img/widget/icon/preview-00.eps
4883 * An object that provides standard icon images (delete, edit, arrows, etc.)
4884 * or a custom file (PNG, JPG, EDJE, etc.) used for an icon.
4886 * The icon image requested can be in the elementary theme, or in the
4887 * freedesktop.org paths. It's possible to set the order of preference from
4888 * where the image will be used.
4890 * This API is very similar to @ref Image, but with ready to use images.
4892 * Default images provided by the theme are described below.
4894 * The first list contains icons that were first intended to be used in
4895 * toolbars, but can be used in many other places too:
4911 * Now some icons that were designed to be used in menus (but again, you can
4912 * use them anywhere else):
4917 * @li menu/arrow_down
4918 * @li menu/arrow_left
4919 * @li menu/arrow_right
4928 * And here we have some media player specific icons:
4929 * @li media_player/forward
4930 * @li media_player/info
4931 * @li media_player/next
4932 * @li media_player/pause
4933 * @li media_player/play
4934 * @li media_player/prev
4935 * @li media_player/rewind
4936 * @li media_player/stop
4938 * Signals that you can add callbacks for are:
4940 * "clicked" - This is called when a user has clicked the icon
4942 * An example of usage for this API follows:
4943 * @li @ref tutorial_icon
4951 typedef enum _Elm_Icon_Type
4958 * @enum _Elm_Icon_Lookup_Order
4959 * @typedef Elm_Icon_Lookup_Order
4961 * Lookup order used by elm_icon_standard_set(). Should look for icons in the
4962 * theme, FDO paths, or both?
4966 typedef enum _Elm_Icon_Lookup_Order
4968 ELM_ICON_LOOKUP_FDO_THEME, /**< icon look up order: freedesktop, theme */
4969 ELM_ICON_LOOKUP_THEME_FDO, /**< icon look up order: theme, freedesktop */
4970 ELM_ICON_LOOKUP_FDO, /**< icon look up order: freedesktop */
4971 ELM_ICON_LOOKUP_THEME /**< icon look up order: theme */
4972 } Elm_Icon_Lookup_Order;
4975 * Add a new icon object to the parent.
4977 * @param parent The parent object
4978 * @return The new object or NULL if it cannot be created
4980 * @see elm_icon_file_set()
4984 EAPI Evas_Object *elm_icon_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4986 * Set the file that will be used as icon.
4988 * @param obj The icon object
4989 * @param file The path to file that will be used as icon image
4990 * @param group The group that the icon belongs to an edje file
4992 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
4994 * @note The icon image set by this function can be changed by
4995 * elm_icon_standard_set().
4997 * @see elm_icon_file_get()
5001 EAPI Eina_Bool elm_icon_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
5003 * Set a location in memory to be used as an icon
5005 * @param obj The icon object
5006 * @param img The binary data that will be used as an image
5007 * @param size The size of binary data @p img
5008 * @param format Optional format of @p img to pass to the image loader
5009 * @param key Optional key of @p img to pass to the image loader (eg. if @p img is an edje file)
5011 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
5013 * @note The icon image set by this function can be changed by
5014 * elm_icon_standard_set().
5018 EAPI Eina_Bool elm_icon_memfile_set(Evas_Object *obj, const void *img, size_t size, const char *format, const char *key) EINA_ARG_NONNULL(1, 2);
5020 * Get the file that will be used as icon.
5022 * @param obj The icon object
5023 * @param file The path to file that will be used as the icon image
5024 * @param group The group that the icon belongs to, in edje file
5026 * @see elm_icon_file_set()
5030 EAPI void elm_icon_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
5031 EAPI void elm_icon_thumb_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
5033 * Set the icon by icon standards names.
5035 * @param obj The icon object
5036 * @param name The icon name
5038 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
5040 * For example, freedesktop.org defines standard icon names such as "home",
5041 * "network", etc. There can be different icon sets to match those icon
5042 * keys. The @p name given as parameter is one of these "keys", and will be
5043 * used to look in the freedesktop.org paths and elementary theme. One can
5044 * change the lookup order with elm_icon_order_lookup_set().
5046 * If name is not found in any of the expected locations and it is the
5047 * absolute path of an image file, this image will be used.
5049 * @note The icon image set by this function can be changed by
5050 * elm_icon_file_set().
5052 * @see elm_icon_standard_get()
5053 * @see elm_icon_file_set()
5057 EAPI Eina_Bool elm_icon_standard_set(Evas_Object *obj, const char *name) EINA_ARG_NONNULL(1);
5059 * Get the icon name set by icon standard names.
5061 * @param obj The icon object
5062 * @return The icon name
5064 * If the icon image was set using elm_icon_file_set() instead of
5065 * elm_icon_standard_set(), then this function will return @c NULL.
5067 * @see elm_icon_standard_set()
5071 EAPI const char *elm_icon_standard_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5073 * Set the smooth scaling for an icon object.
5075 * @param obj The icon object
5076 * @param smooth @c EINA_TRUE if smooth scaling should be used, @c EINA_FALSE
5077 * otherwise. Default is @c EINA_TRUE.
5079 * Set the scaling algorithm to be used when scaling the icon image. Smooth
5080 * scaling provides a better resulting image, but is slower.
5082 * The smooth scaling should be disabled when making animations that change
5083 * the icon size, since they will be faster. Animations that don't require
5084 * resizing of the icon can keep the smooth scaling enabled (even if the icon
5085 * is already scaled, since the scaled icon image will be cached).
5087 * @see elm_icon_smooth_get()
5091 EAPI void elm_icon_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
5093 * Get whether smooth scaling is enabled for an icon object.
5095 * @param obj The icon object
5096 * @return @c EINA_TRUE if smooth scaling is enabled, @c EINA_FALSE otherwise.
5098 * @see elm_icon_smooth_set()
5102 EAPI Eina_Bool elm_icon_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5104 * Disable scaling of this object.
5106 * @param obj The icon object.
5107 * @param no_scale @c EINA_TRUE if the object is not scalable, @c EINA_FALSE
5108 * otherwise. Default is @c EINA_FALSE.
5110 * This function disables scaling of the icon object through the function
5111 * elm_object_scale_set(). However, this does not affect the object
5112 * size/resize in any way. For that effect, take a look at
5113 * elm_icon_scale_set().
5115 * @see elm_icon_no_scale_get()
5116 * @see elm_icon_scale_set()
5117 * @see elm_object_scale_set()
5121 EAPI void elm_icon_no_scale_set(Evas_Object *obj, Eina_Bool no_scale) EINA_ARG_NONNULL(1);
5123 * Get whether scaling is disabled on the object.
5125 * @param obj The icon object
5126 * @return @c EINA_TRUE if scaling is disabled, @c EINA_FALSE otherwise
5128 * @see elm_icon_no_scale_set()
5132 EAPI Eina_Bool elm_icon_no_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5134 * Set if the object is (up/down) resizable.
5136 * @param obj The icon object
5137 * @param scale_up A bool to set if the object is resizable up. Default is
5139 * @param scale_down A bool to set if the object is resizable down. Default
5142 * This function limits the icon object resize ability. If @p scale_up is set to
5143 * @c EINA_FALSE, the object can't have its height or width resized to a value
5144 * higher than the original icon size. Same is valid for @p scale_down.
5146 * @see elm_icon_scale_get()
5150 EAPI void elm_icon_scale_set(Evas_Object *obj, Eina_Bool scale_up, Eina_Bool scale_down) EINA_ARG_NONNULL(1);
5152 * Get if the object is (up/down) resizable.
5154 * @param obj The icon object
5155 * @param scale_up A bool to set if the object is resizable up
5156 * @param scale_down A bool to set if the object is resizable down
5158 * @see elm_icon_scale_set()
5162 EAPI void elm_icon_scale_get(const Evas_Object *obj, Eina_Bool *scale_up, Eina_Bool *scale_down) EINA_ARG_NONNULL(1);
5164 * Get the object's image size
5166 * @param obj The icon object
5167 * @param w A pointer to store the width in
5168 * @param h A pointer to store the height in
5172 EAPI void elm_icon_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
5174 * Set if the icon fill the entire object area.
5176 * @param obj The icon object
5177 * @param fill_outside @c EINA_TRUE if the object is filled outside,
5178 * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
5180 * When the icon object is resized to a different aspect ratio from the
5181 * original icon image, the icon image will still keep its aspect. This flag
5182 * tells how the image should fill the object's area. They are: keep the
5183 * entire icon inside the limits of height and width of the object (@p
5184 * fill_outside is @c EINA_FALSE) or let the extra width or height go outside
5185 * of the object, and the icon will fill the entire object (@p fill_outside
5188 * @note Unlike @ref Image, there's no option in icon to set the aspect ratio
5189 * retain property to false. Thus, the icon image will always keep its
5190 * original aspect ratio.
5192 * @see elm_icon_fill_outside_get()
5193 * @see elm_image_fill_outside_set()
5197 EAPI void elm_icon_fill_outside_set(Evas_Object *obj, Eina_Bool fill_outside) EINA_ARG_NONNULL(1);
5199 * Get if the object is filled outside.
5201 * @param obj The icon object
5202 * @return @c EINA_TRUE if the object is filled outside, @c EINA_FALSE otherwise.
5204 * @see elm_icon_fill_outside_set()
5208 EAPI Eina_Bool elm_icon_fill_outside_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5210 * Set the prescale size for the icon.
5212 * @param obj The icon object
5213 * @param size The prescale size. This value is used for both width and
5216 * This function sets a new size for pixmap representation of the given
5217 * icon. It allows the icon to be loaded already in the specified size,
5218 * reducing the memory usage and load time when loading a big icon with load
5219 * size set to a smaller size.
5221 * It's equivalent to the elm_bg_load_size_set() function for bg.
5223 * @note this is just a hint, the real size of the pixmap may differ
5224 * depending on the type of icon being loaded, being bigger than requested.
5226 * @see elm_icon_prescale_get()
5227 * @see elm_bg_load_size_set()
5231 EAPI void elm_icon_prescale_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
5233 * Get the prescale size for the icon.
5235 * @param obj The icon object
5236 * @return The prescale size
5238 * @see elm_icon_prescale_set()
5242 EAPI int elm_icon_prescale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5244 * Gets the image object of the icon. DO NOT MODIFY THIS.
5246 * @param obj The icon object
5247 * @return The internal icon object
5251 EAPI Evas_Object *elm_icon_object_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
5253 * Sets the icon lookup order used by elm_icon_standard_set().
5255 * @param obj The icon object
5256 * @param order The icon lookup order (can be one of
5257 * ELM_ICON_LOOKUP_FDO_THEME, ELM_ICON_LOOKUP_THEME_FDO, ELM_ICON_LOOKUP_FDO
5258 * or ELM_ICON_LOOKUP_THEME)
5260 * @see elm_icon_order_lookup_get()
5261 * @see Elm_Icon_Lookup_Order
5265 EAPI void elm_icon_order_lookup_set(Evas_Object *obj, Elm_Icon_Lookup_Order order) EINA_ARG_NONNULL(1);
5267 * Gets the icon lookup order.
5269 * @param obj The icon object
5270 * @return The icon lookup order
5272 * @see elm_icon_order_lookup_set()
5273 * @see Elm_Icon_Lookup_Order
5277 EAPI Elm_Icon_Lookup_Order elm_icon_order_lookup_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5279 * Enable or disable preloading of the icon
5281 * @param obj The icon object
5282 * @param disable If EINA_TRUE, preloading will be disabled
5285 EAPI void elm_icon_preload_set(Evas_Object *obj, Eina_Bool disable) EINA_ARG_NONNULL(1);
5287 * Get if the icon supports animation or not.
5289 * @param obj The icon object
5290 * @return @c EINA_TRUE if the icon supports animation,
5291 * @c EINA_FALSE otherwise.
5293 * Return if this elm icon's image can be animated. Currently Evas only
5294 * supports gif animation. If the return value is EINA_FALSE, other
5295 * elm_icon_animated_XXX APIs won't work.
5298 EAPI Eina_Bool elm_icon_animated_available_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5300 * Set animation mode of the icon.
5302 * @param obj The icon object
5303 * @param anim @c EINA_TRUE if the object do animation job,
5304 * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
5306 * Since the default animation mode is set to EINA_FALSE,
5307 * the icon is shown without animation.
5308 * This might be desirable when the application developer wants to show
5309 * a snapshot of the animated icon.
5310 * Set it to EINA_TRUE when the icon needs to be animated.
5313 EAPI void elm_icon_animated_set(Evas_Object *obj, Eina_Bool animated) EINA_ARG_NONNULL(1);
5315 * Get animation mode of the icon.
5317 * @param obj The icon object
5318 * @return The animation mode of the icon object
5319 * @see elm_icon_animated_set
5322 EAPI Eina_Bool elm_icon_animated_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5324 * Set animation play mode of the icon.
5326 * @param obj The icon object
5327 * @param play @c EINA_TRUE the object play animation images,
5328 * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
5330 * To play elm icon's animation, set play to EINA_TURE.
5331 * For example, you make gif player using this set/get API and click event.
5333 * 1. Click event occurs
5334 * 2. Check play flag using elm_icon_animaged_play_get
5335 * 3. If elm icon was playing, set play to EINA_FALSE.
5336 * Then animation will be stopped and vice versa
5339 EAPI void elm_icon_animated_play_set(Evas_Object *obj, Eina_Bool play) EINA_ARG_NONNULL(1);
5341 * Get animation play mode of the icon.
5343 * @param obj The icon object
5344 * @return The play mode of the icon object
5346 * @see elm_icon_animated_play_get
5349 EAPI Eina_Bool elm_icon_animated_play_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5356 * @defgroup Image Image
5358 * @image html img/widget/image/preview-00.png
5359 * @image latex img/widget/image/preview-00.eps
5362 * An object that allows one to load an image file to it. It can be used
5363 * anywhere like any other elementary widget.
5365 * This widget provides most of the functionality provided from @ref Bg or @ref
5366 * Icon, but with a slightly different API (use the one that fits better your
5369 * The features not provided by those two other image widgets are:
5370 * @li allowing to get the basic @c Evas_Object with elm_image_object_get();
5371 * @li change the object orientation with elm_image_orient_set();
5372 * @li and turning the image editable with elm_image_editable_set().
5374 * Signals that you can add callbacks for are:
5376 * @li @c "clicked" - This is called when a user has clicked the image
5378 * An example of usage for this API follows:
5379 * @li @ref tutorial_image
5388 * @enum _Elm_Image_Orient
5389 * @typedef Elm_Image_Orient
5391 * Possible orientation options for elm_image_orient_set().
5393 * @image html elm_image_orient_set.png
5394 * @image latex elm_image_orient_set.eps width=\textwidth
5398 typedef enum _Elm_Image_Orient
5400 ELM_IMAGE_ORIENT_NONE, /**< no orientation change */
5401 ELM_IMAGE_ROTATE_90_CW, /**< rotate 90 degrees clockwise */
5402 ELM_IMAGE_ROTATE_180_CW, /**< rotate 180 degrees clockwise */
5403 ELM_IMAGE_ROTATE_90_CCW, /**< rotate 90 degrees counter-clockwise (i.e. 270 degrees clockwise) */
5404 ELM_IMAGE_FLIP_HORIZONTAL, /**< flip image horizontally */
5405 ELM_IMAGE_FLIP_VERTICAL, /**< flip image vertically */
5406 ELM_IMAGE_FLIP_TRANSPOSE, /**< flip the image along the y = (side - x) line*/
5407 ELM_IMAGE_FLIP_TRANSVERSE /**< flip the image along the y = x line */
5411 * Add a new image to the parent.
5413 * @param parent The parent object
5414 * @return The new object or NULL if it cannot be created
5416 * @see elm_image_file_set()
5420 EAPI Evas_Object *elm_image_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5422 * Set the file that will be used as image.
5424 * @param obj The image object
5425 * @param file The path to file that will be used as image
5426 * @param group The group that the image belongs in edje file (if it's an
5429 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
5431 * @see elm_image_file_get()
5435 EAPI Eina_Bool elm_image_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
5437 * Get the file that will be used as image.
5439 * @param obj The image object
5440 * @param file The path to file
5441 * @param group The group that the image belongs in edje file
5443 * @see elm_image_file_set()
5447 EAPI void elm_image_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
5449 * Set the smooth effect for an image.
5451 * @param obj The image object
5452 * @param smooth @c EINA_TRUE if smooth scaling should be used, @c EINA_FALSE
5453 * otherwise. Default is @c EINA_TRUE.
5455 * Set the scaling algorithm to be used when scaling the image. Smooth
5456 * scaling provides a better resulting image, but is slower.
5458 * The smooth scaling should be disabled when making animations that change
5459 * the image size, since it will be faster. Animations that don't require
5460 * resizing of the image can keep the smooth scaling enabled (even if the
5461 * image is already scaled, since the scaled image will be cached).
5463 * @see elm_image_smooth_get()
5467 EAPI void elm_image_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
5469 * Get the smooth effect for an image.
5471 * @param obj The image object
5472 * @return @c EINA_TRUE if smooth scaling is enabled, @c EINA_FALSE otherwise.
5474 * @see elm_image_smooth_get()
5478 EAPI Eina_Bool elm_image_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5481 * Gets the current size of the image.
5483 * @param obj The image object.
5484 * @param w Pointer to store width, or NULL.
5485 * @param h Pointer to store height, or NULL.
5487 * This is the real size of the image, not the size of the object.
5489 * On error, neither w or h will be written.
5493 EAPI void elm_image_object_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
5495 * Disable scaling of this object.
5497 * @param obj The image object.
5498 * @param no_scale @c EINA_TRUE if the object is not scalable, @c EINA_FALSE
5499 * otherwise. Default is @c EINA_FALSE.
5501 * This function disables scaling of the elm_image widget through the
5502 * function elm_object_scale_set(). However, this does not affect the widget
5503 * size/resize in any way. For that effect, take a look at
5504 * elm_image_scale_set().
5506 * @see elm_image_no_scale_get()
5507 * @see elm_image_scale_set()
5508 * @see elm_object_scale_set()
5512 EAPI void elm_image_no_scale_set(Evas_Object *obj, Eina_Bool no_scale) EINA_ARG_NONNULL(1);
5514 * Get whether scaling is disabled on the object.
5516 * @param obj The image object
5517 * @return @c EINA_TRUE if scaling is disabled, @c EINA_FALSE otherwise
5519 * @see elm_image_no_scale_set()
5523 EAPI Eina_Bool elm_image_no_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5525 * Set if the object is (up/down) resizable.
5527 * @param obj The image object
5528 * @param scale_up A bool to set if the object is resizable up. Default is
5530 * @param scale_down A bool to set if the object is resizable down. Default
5533 * This function limits the image resize ability. If @p scale_up is set to
5534 * @c EINA_FALSE, the object can't have its height or width resized to a value
5535 * higher than the original image size. Same is valid for @p scale_down.
5537 * @see elm_image_scale_get()
5541 EAPI void elm_image_scale_set(Evas_Object *obj, Eina_Bool scale_up, Eina_Bool scale_down) EINA_ARG_NONNULL(1);
5543 * Get if the object is (up/down) resizable.
5545 * @param obj The image object
5546 * @param scale_up A bool to set if the object is resizable up
5547 * @param scale_down A bool to set if the object is resizable down
5549 * @see elm_image_scale_set()
5553 EAPI void elm_image_scale_get(const Evas_Object *obj, Eina_Bool *scale_up, Eina_Bool *scale_down) EINA_ARG_NONNULL(1);
5555 * Set if the image fills the entire object area, when keeping the aspect ratio.
5557 * @param obj The image object
5558 * @param fill_outside @c EINA_TRUE if the object is filled outside,
5559 * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
5561 * When the image should keep its aspect ratio even if resized to another
5562 * aspect ratio, there are two possibilities to resize it: keep the entire
5563 * image inside the limits of height and width of the object (@p fill_outside
5564 * is @c EINA_FALSE) or let the extra width or height go outside of the object,
5565 * and the image will fill the entire object (@p fill_outside is @c EINA_TRUE).
5567 * @note This option will have no effect if
5568 * elm_image_aspect_ratio_retained_set() is set to @c EINA_FALSE.
5570 * @see elm_image_fill_outside_get()
5571 * @see elm_image_aspect_ratio_retained_set()
5575 EAPI void elm_image_fill_outside_set(Evas_Object *obj, Eina_Bool fill_outside) EINA_ARG_NONNULL(1);
5577 * Get if the object is filled outside
5579 * @param obj The image object
5580 * @return @c EINA_TRUE if the object is filled outside, @c EINA_FALSE otherwise.
5582 * @see elm_image_fill_outside_set()
5586 EAPI Eina_Bool elm_image_fill_outside_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5588 * Set the prescale size for the image
5590 * @param obj The image object
5591 * @param size The prescale size. This value is used for both width and
5594 * This function sets a new size for pixmap representation of the given
5595 * image. It allows the image to be loaded already in the specified size,
5596 * reducing the memory usage and load time when loading a big image with load
5597 * size set to a smaller size.
5599 * It's equivalent to the elm_bg_load_size_set() function for bg.
5601 * @note this is just a hint, the real size of the pixmap may differ
5602 * depending on the type of image being loaded, being bigger than requested.
5604 * @see elm_image_prescale_get()
5605 * @see elm_bg_load_size_set()
5609 EAPI void elm_image_prescale_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
5611 * Get the prescale size for the image
5613 * @param obj The image object
5614 * @return The prescale size
5616 * @see elm_image_prescale_set()
5620 EAPI int elm_image_prescale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5622 * Set the image orientation.
5624 * @param obj The image object
5625 * @param orient The image orientation @ref Elm_Image_Orient
5626 * Default is #ELM_IMAGE_ORIENT_NONE.
5628 * This function allows to rotate or flip the given image.
5630 * @see elm_image_orient_get()
5631 * @see @ref Elm_Image_Orient
5635 EAPI void elm_image_orient_set(Evas_Object *obj, Elm_Image_Orient orient) EINA_ARG_NONNULL(1);
5637 * Get the image orientation.
5639 * @param obj The image object
5640 * @return The image orientation @ref Elm_Image_Orient
5642 * @see elm_image_orient_set()
5643 * @see @ref Elm_Image_Orient
5647 EAPI Elm_Image_Orient elm_image_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5649 * Make the image 'editable'.
5651 * @param obj Image object.
5652 * @param set Turn on or off editability. Default is @c EINA_FALSE.
5654 * This means the image is a valid drag target for drag and drop, and can be
5655 * cut or pasted too.
5659 EAPI void elm_image_editable_set(Evas_Object *obj, Eina_Bool set) EINA_ARG_NONNULL(1);
5661 * Check if the image 'editable'.
5663 * @param obj Image object.
5664 * @return Editability.
5666 * A return value of EINA_TRUE means the image is a valid drag target
5667 * for drag and drop, and can be cut or pasted too.
5671 EAPI Eina_Bool elm_image_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5673 * Get the basic Evas_Image object from this object (widget).
5675 * @param obj The image object to get the inlined image from
5676 * @return The inlined image object, or NULL if none exists
5678 * This function allows one to get the underlying @c Evas_Object of type
5679 * Image from this elementary widget. It can be useful to do things like get
5680 * the pixel data, save the image to a file, etc.
5682 * @note Be careful to not manipulate it, as it is under control of
5687 EAPI Evas_Object *elm_image_object_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5689 * Set whether the original aspect ratio of the image should be kept on resize.
5691 * @param obj The image object.
5692 * @param retained @c EINA_TRUE if the image should retain the aspect,
5693 * @c EINA_FALSE otherwise.
5695 * The original aspect ratio (width / height) of the image is usually
5696 * distorted to match the object's size. Enabling this option will retain
5697 * this original aspect, and the way that the image is fit into the object's
5698 * area depends on the option set by elm_image_fill_outside_set().
5700 * @see elm_image_aspect_ratio_retained_get()
5701 * @see elm_image_fill_outside_set()
5705 EAPI void elm_image_aspect_ratio_retained_set(Evas_Object *obj, Eina_Bool retained) EINA_ARG_NONNULL(1);
5707 * Get if the object retains the original aspect ratio.
5709 * @param obj The image object.
5710 * @return @c EINA_TRUE if the object keeps the original aspect, @c EINA_FALSE
5715 EAPI Eina_Bool elm_image_aspect_ratio_retained_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5725 * @image html img/widget/box/preview-00.png
5726 * @image latex img/widget/box/preview-00.eps width=\textwidth
5728 * @image html img/box.png
5729 * @image latex img/box.eps width=\textwidth
5731 * A box arranges objects in a linear fashion, governed by a layout function
5732 * that defines the details of this arrangement.
5734 * By default, the box will use an internal function to set the layout to
5735 * a single row, either vertical or horizontal. This layout is affected
5736 * by a number of parameters, such as the homogeneous flag set by
5737 * elm_box_homogeneous_set(), the values given by elm_box_padding_set() and
5738 * elm_box_align_set() and the hints set to each object in the box.
5740 * For this default layout, it's possible to change the orientation with
5741 * elm_box_horizontal_set(). The box will start in the vertical orientation,
5742 * placing its elements ordered from top to bottom. When horizontal is set,
5743 * the order will go from left to right. If the box is set to be
5744 * homogeneous, every object in it will be assigned the same space, that
5745 * of the largest object. Padding can be used to set some spacing between
5746 * the cell given to each object. The alignment of the box, set with
5747 * elm_box_align_set(), determines how the bounding box of all the elements
5748 * will be placed within the space given to the box widget itself.
5750 * The size hints of each object also affect how they are placed and sized
5751 * within the box. evas_object_size_hint_min_set() will give the minimum
5752 * size the object can have, and the box will use it as the basis for all
5753 * latter calculations. Elementary widgets set their own minimum size as
5754 * needed, so there's rarely any need to use it manually.
5756 * evas_object_size_hint_weight_set(), when not in homogeneous mode, is
5757 * used to tell whether the object will be allocated the minimum size it
5758 * needs or if the space given to it should be expanded. It's important
5759 * to realize that expanding the size given to the object is not the same
5760 * thing as resizing the object. It could very well end being a small
5761 * widget floating in a much larger empty space. If not set, the weight
5762 * for objects will normally be 0.0 for both axis, meaning the widget will
5763 * not be expanded. To take as much space possible, set the weight to
5764 * EVAS_HINT_EXPAND (defined to 1.0) for the desired axis to expand.
5766 * Besides how much space each object is allocated, it's possible to control
5767 * how the widget will be placed within that space using
5768 * evas_object_size_hint_align_set(). By default, this value will be 0.5
5769 * for both axis, meaning the object will be centered, but any value from
5770 * 0.0 (left or top, for the @c x and @c y axis, respectively) to 1.0
5771 * (right or bottom) can be used. The special value EVAS_HINT_FILL, which
5772 * is -1.0, means the object will be resized to fill the entire space it
5775 * In addition, customized functions to define the layout can be set, which
5776 * allow the application developer to organize the objects within the box
5777 * in any number of ways.
5779 * The special elm_box_layout_transition() function can be used
5780 * to switch from one layout to another, animating the motion of the
5781 * children of the box.
5783 * @note Objects should not be added to box objects using _add() calls.
5785 * Some examples on how to use boxes follow:
5786 * @li @ref box_example_01
5787 * @li @ref box_example_02
5792 * @typedef Elm_Box_Transition
5794 * Opaque handler containing the parameters to perform an animated
5795 * transition of the layout the box uses.
5797 * @see elm_box_transition_new()
5798 * @see elm_box_layout_set()
5799 * @see elm_box_layout_transition()
5801 typedef struct _Elm_Box_Transition Elm_Box_Transition;
5804 * Add a new box to the parent
5806 * By default, the box will be in vertical mode and non-homogeneous.
5808 * @param parent The parent object
5809 * @return The new object or NULL if it cannot be created
5811 EAPI Evas_Object *elm_box_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5813 * Set the horizontal orientation
5815 * By default, box object arranges their contents vertically from top to
5817 * By calling this function with @p horizontal as EINA_TRUE, the box will
5818 * become horizontal, arranging contents from left to right.
5820 * @note This flag is ignored if a custom layout function is set.
5822 * @param obj The box object
5823 * @param horizontal The horizontal flag (EINA_TRUE = horizontal,
5824 * EINA_FALSE = vertical)
5826 EAPI void elm_box_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
5828 * Get the horizontal orientation
5830 * @param obj The box object
5831 * @return EINA_TRUE if the box is set to horizontal mode, EINA_FALSE otherwise
5833 EAPI Eina_Bool elm_box_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5835 * Set the box to arrange its children homogeneously
5837 * If enabled, homogeneous layout makes all items the same size, according
5838 * to the size of the largest of its children.
5840 * @note This flag is ignored if a custom layout function is set.
5842 * @param obj The box object
5843 * @param homogeneous The homogeneous flag
5845 EAPI void elm_box_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
5847 * Get whether the box is using homogeneous mode or not
5849 * @param obj The box object
5850 * @return EINA_TRUE if it's homogeneous, EINA_FALSE otherwise
5852 EAPI Eina_Bool elm_box_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5854 * Add an object to the beginning of the pack list
5856 * Pack @p subobj into the box @p obj, placing it first in the list of
5857 * children objects. The actual position the object will get on screen
5858 * depends on the layout used. If no custom layout is set, it will be at
5859 * the top or left, depending if the box is vertical or horizontal,
5862 * @param obj The box object
5863 * @param subobj The object to add to the box
5865 * @see elm_box_pack_end()
5866 * @see elm_box_pack_before()
5867 * @see elm_box_pack_after()
5868 * @see elm_box_unpack()
5869 * @see elm_box_unpack_all()
5870 * @see elm_box_clear()
5872 EAPI void elm_box_pack_start(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
5874 * Add an object at the end of the pack list
5876 * Pack @p subobj into the box @p obj, placing it last in the list of
5877 * children objects. The actual position the object will get on screen
5878 * depends on the layout used. If no custom layout is set, it will be at
5879 * the bottom or right, depending if the box is vertical or horizontal,
5882 * @param obj The box object
5883 * @param subobj The object to add to the box
5885 * @see elm_box_pack_start()
5886 * @see elm_box_pack_before()
5887 * @see elm_box_pack_after()
5888 * @see elm_box_unpack()
5889 * @see elm_box_unpack_all()
5890 * @see elm_box_clear()
5892 EAPI void elm_box_pack_end(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
5894 * Adds an object to the box before the indicated object
5896 * This will add the @p subobj to the box indicated before the object
5897 * indicated with @p before. If @p before is not already in the box, results
5898 * are undefined. Before means either to the left of the indicated object or
5899 * above it depending on orientation.
5901 * @param obj The box object
5902 * @param subobj The object to add to the box
5903 * @param before The object before which to add it
5905 * @see elm_box_pack_start()
5906 * @see elm_box_pack_end()
5907 * @see elm_box_pack_after()
5908 * @see elm_box_unpack()
5909 * @see elm_box_unpack_all()
5910 * @see elm_box_clear()
5912 EAPI void elm_box_pack_before(Evas_Object *obj, Evas_Object *subobj, Evas_Object *before) EINA_ARG_NONNULL(1);
5914 * Adds an object to the box after the indicated object
5916 * This will add the @p subobj to the box indicated after the object
5917 * indicated with @p after. If @p after is not already in the box, results
5918 * are undefined. After means either to the right of the indicated object or
5919 * below it depending on orientation.
5921 * @param obj The box object
5922 * @param subobj The object to add to the box
5923 * @param after The object after which to add it
5925 * @see elm_box_pack_start()
5926 * @see elm_box_pack_end()
5927 * @see elm_box_pack_before()
5928 * @see elm_box_unpack()
5929 * @see elm_box_unpack_all()
5930 * @see elm_box_clear()
5932 EAPI void elm_box_pack_after(Evas_Object *obj, Evas_Object *subobj, Evas_Object *after) EINA_ARG_NONNULL(1);
5934 * Clear the box of all children
5936 * Remove all the elements contained by the box, deleting the respective
5939 * @param obj The box object
5941 * @see elm_box_unpack()
5942 * @see elm_box_unpack_all()
5944 EAPI void elm_box_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
5948 * Remove the object given by @p subobj from the box @p obj without
5951 * @param obj The box object
5953 * @see elm_box_unpack_all()
5954 * @see elm_box_clear()
5956 EAPI void elm_box_unpack(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
5958 * Remove all items from the box, without deleting them
5960 * Clear the box from all children, but don't delete the respective objects.
5961 * If no other references of the box children exist, the objects will never
5962 * be deleted, and thus the application will leak the memory. Make sure
5963 * when using this function that you hold a reference to all the objects
5964 * in the box @p obj.
5966 * @param obj The box object
5968 * @see elm_box_clear()
5969 * @see elm_box_unpack()
5971 EAPI void elm_box_unpack_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
5973 * Retrieve a list of the objects packed into the box
5975 * Returns a new @c Eina_List with a pointer to @c Evas_Object in its nodes.
5976 * The order of the list corresponds to the packing order the box uses.
5978 * You must free this list with eina_list_free() once you are done with it.
5980 * @param obj The box object
5982 EAPI const Eina_List *elm_box_children_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5984 * Set the space (padding) between the box's elements.
5986 * Extra space in pixels that will be added between a box child and its
5987 * neighbors after its containing cell has been calculated. This padding
5988 * is set for all elements in the box, besides any possible padding that
5989 * individual elements may have through their size hints.
5991 * @param obj The box object
5992 * @param horizontal The horizontal space between elements
5993 * @param vertical The vertical space between elements
5995 EAPI void elm_box_padding_set(Evas_Object *obj, Evas_Coord horizontal, Evas_Coord vertical) EINA_ARG_NONNULL(1);
5997 * Get the space (padding) between the box's elements.
5999 * @param obj The box object
6000 * @param horizontal The horizontal space between elements
6001 * @param vertical The vertical space between elements
6003 * @see elm_box_padding_set()
6005 EAPI void elm_box_padding_get(const Evas_Object *obj, Evas_Coord *horizontal, Evas_Coord *vertical) EINA_ARG_NONNULL(1);
6007 * Set the alignment of the whole bouding box of contents.
6009 * Sets how the bounding box containing all the elements of the box, after
6010 * their sizes and position has been calculated, will be aligned within
6011 * the space given for the whole box widget.
6013 * @param obj The box object
6014 * @param horizontal The horizontal alignment of elements
6015 * @param vertical The vertical alignment of elements
6017 EAPI void elm_box_align_set(Evas_Object *obj, double horizontal, double vertical) EINA_ARG_NONNULL(1);
6019 * Get the alignment of the whole bouding box of contents.
6021 * @param obj The box object
6022 * @param horizontal The horizontal alignment of elements
6023 * @param vertical The vertical alignment of elements
6025 * @see elm_box_align_set()
6027 EAPI void elm_box_align_get(const Evas_Object *obj, double *horizontal, double *vertical) EINA_ARG_NONNULL(1);
6030 * Force the box to recalculate its children packing.
6032 * If any children was added or removed, box will not calculate the
6033 * values immediately rather leaving it to the next main loop
6034 * iteration. While this is great as it would save lots of
6035 * recalculation, whenever you need to get the position of a just
6036 * added item you must force recalculate before doing so.
6038 * @param obj The box object.
6040 EAPI void elm_box_recalculate(Evas_Object *obj);
6043 * Set the layout defining function to be used by the box
6045 * Whenever anything changes that requires the box in @p obj to recalculate
6046 * the size and position of its elements, the function @p cb will be called
6047 * to determine what the layout of the children will be.
6049 * Once a custom function is set, everything about the children layout
6050 * is defined by it. The flags set by elm_box_horizontal_set() and
6051 * elm_box_homogeneous_set() no longer have any meaning, and the values
6052 * given by elm_box_padding_set() and elm_box_align_set() are up to this
6053 * layout function to decide if they are used and how. These last two
6054 * will be found in the @c priv parameter, of type @c Evas_Object_Box_Data,
6055 * passed to @p cb. The @c Evas_Object the function receives is not the
6056 * Elementary widget, but the internal Evas Box it uses, so none of the
6057 * functions described here can be used on it.
6059 * Any of the layout functions in @c Evas can be used here, as well as the
6060 * special elm_box_layout_transition().
6062 * The final @p data argument received by @p cb is the same @p data passed
6063 * here, and the @p free_data function will be called to free it
6064 * whenever the box is destroyed or another layout function is set.
6066 * Setting @p cb to NULL will revert back to the default layout function.
6068 * @param obj The box object
6069 * @param cb The callback function used for layout
6070 * @param data Data that will be passed to layout function
6071 * @param free_data Function called to free @p data
6073 * @see elm_box_layout_transition()
6075 EAPI void elm_box_layout_set(Evas_Object *obj, Evas_Object_Box_Layout cb, const void *data, void (*free_data)(void *data)) EINA_ARG_NONNULL(1);
6077 * Special layout function that animates the transition from one layout to another
6079 * Normally, when switching the layout function for a box, this will be
6080 * reflected immediately on screen on the next render, but it's also
6081 * possible to do this through an animated transition.
6083 * This is done by creating an ::Elm_Box_Transition and setting the box
6084 * layout to this function.
6088 * Elm_Box_Transition *t = elm_box_transition_new(1.0,
6089 * evas_object_box_layout_vertical, // start
6090 * NULL, // data for initial layout
6091 * NULL, // free function for initial data
6092 * evas_object_box_layout_horizontal, // end
6093 * NULL, // data for final layout
6094 * NULL, // free function for final data
6095 * anim_end, // will be called when animation ends
6096 * NULL); // data for anim_end function\
6097 * elm_box_layout_set(box, elm_box_layout_transition, t,
6098 * elm_box_transition_free);
6101 * @note This function can only be used with elm_box_layout_set(). Calling
6102 * it directly will not have the expected results.
6104 * @see elm_box_transition_new
6105 * @see elm_box_transition_free
6106 * @see elm_box_layout_set
6108 EAPI void elm_box_layout_transition(Evas_Object *obj, Evas_Object_Box_Data *priv, void *data);
6110 * Create a new ::Elm_Box_Transition to animate the switch of layouts
6112 * If you want to animate the change from one layout to another, you need
6113 * to set the layout function of the box to elm_box_layout_transition(),
6114 * passing as user data to it an instance of ::Elm_Box_Transition with the
6115 * necessary information to perform this animation. The free function to
6116 * set for the layout is elm_box_transition_free().
6118 * The parameters to create an ::Elm_Box_Transition sum up to how long
6119 * will it be, in seconds, a layout function to describe the initial point,
6120 * another for the final position of the children and one function to be
6121 * called when the whole animation ends. This last function is useful to
6122 * set the definitive layout for the box, usually the same as the end
6123 * layout for the animation, but could be used to start another transition.
6125 * @param start_layout The layout function that will be used to start the animation
6126 * @param start_layout_data The data to be passed the @p start_layout function
6127 * @param start_layout_free_data Function to free @p start_layout_data
6128 * @param end_layout The layout function that will be used to end the animation
6129 * @param end_layout_free_data The data to be passed the @p end_layout function
6130 * @param end_layout_free_data Function to free @p end_layout_data
6131 * @param transition_end_cb Callback function called when animation ends
6132 * @param transition_end_data Data to be passed to @p transition_end_cb
6133 * @return An instance of ::Elm_Box_Transition
6135 * @see elm_box_transition_new
6136 * @see elm_box_layout_transition
6138 EAPI Elm_Box_Transition *elm_box_transition_new(const double duration, Evas_Object_Box_Layout start_layout, void *start_layout_data, void(*start_layout_free_data)(void *data), Evas_Object_Box_Layout end_layout, void *end_layout_data, void(*end_layout_free_data)(void *data), void(*transition_end_cb)(void *data), void *transition_end_data) EINA_ARG_NONNULL(2, 5);
6140 * Free a Elm_Box_Transition instance created with elm_box_transition_new().
6142 * This function is mostly useful as the @c free_data parameter in
6143 * elm_box_layout_set() when elm_box_layout_transition().
6145 * @param data The Elm_Box_Transition instance to be freed.
6147 * @see elm_box_transition_new
6148 * @see elm_box_layout_transition
6150 EAPI void elm_box_transition_free(void *data);
6157 * @defgroup Button Button
6159 * @image html img/widget/button/preview-00.png
6160 * @image latex img/widget/button/preview-00.eps
6161 * @image html img/widget/button/preview-01.png
6162 * @image latex img/widget/button/preview-01.eps
6163 * @image html img/widget/button/preview-02.png
6164 * @image latex img/widget/button/preview-02.eps
6166 * This is a push-button. Press it and run some function. It can contain
6167 * a simple label and icon object and it also has an autorepeat feature.
6169 * This widgets emits the following signals:
6170 * @li "clicked": the user clicked the button (press/release).
6171 * @li "repeated": the user pressed the button without releasing it.
6172 * @li "pressed": button was pressed.
6173 * @li "unpressed": button was released after being pressed.
6174 * In all three cases, the @c event parameter of the callback will be
6177 * Also, defined in the default theme, the button has the following styles
6179 * @li default: a normal button.
6180 * @li anchor: Like default, but the button fades away when the mouse is not
6181 * over it, leaving only the text or icon.
6182 * @li hoversel_vertical: Internally used by @ref Hoversel to give a
6183 * continuous look across its options.
6184 * @li hoversel_vertical_entry: Another internal for @ref Hoversel.
6186 * Default contents parts of the button widget that you can use for are:
6187 * @li "icon" - A icon of the button
6189 * Default text parts of the button widget that you can use for are:
6190 * @li "default" - Label of the button
6192 * Follow through a complete example @ref button_example_01 "here".
6196 * Add a new button to the parent's canvas
6198 * @param parent The parent object
6199 * @return The new object or NULL if it cannot be created
6201 EAPI Evas_Object *elm_button_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6203 * Set the label used in the button
6205 * The passed @p label can be NULL to clean any existing text in it and
6206 * leave the button as an icon only object.
6208 * @param obj The button object
6209 * @param label The text will be written on the button
6210 * @deprecated use elm_object_text_set() instead.
6212 EINA_DEPRECATED EAPI void elm_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
6214 * Get the label set for the button
6216 * The string returned is an internal pointer and should not be freed or
6217 * altered. It will also become invalid when the button is destroyed.
6218 * The string returned, if not NULL, is a stringshare, so if you need to
6219 * keep it around even after the button is destroyed, you can use
6220 * eina_stringshare_ref().
6222 * @param obj The button object
6223 * @return The text set to the label, or NULL if nothing is set
6224 * @deprecated use elm_object_text_set() instead.
6226 EINA_DEPRECATED EAPI const char *elm_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6228 * Set the icon used for the button
6230 * Setting a new icon will delete any other that was previously set, making
6231 * any reference to them invalid. If you need to maintain the previous
6232 * object alive, unset it first with elm_button_icon_unset().
6234 * @param obj The button object
6235 * @param icon The icon object for the button
6236 * @deprecated use elm_object_part_content_set() instead.
6238 EINA_DEPRECATED EAPI void elm_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
6240 * Get the icon used for the button
6242 * Return the icon object which is set for this widget. If the button is
6243 * destroyed or another icon is set, the returned object will be deleted
6244 * and any reference to it will be invalid.
6246 * @param obj The button object
6247 * @return The icon object that is being used
6249 * @deprecated use elm_object_part_content_get() instead
6251 EINA_DEPRECATED EAPI Evas_Object *elm_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6253 * Remove the icon set without deleting it and return the object
6255 * This function drops the reference the button holds of the icon object
6256 * and returns this last object. It is used in case you want to remove any
6257 * icon, or set another one, without deleting the actual object. The button
6258 * will be left without an icon set.
6260 * @param obj The button object
6261 * @return The icon object that was being used
6262 * @deprecated use elm_object_part_content_unset() instead.
6264 EINA_DEPRECATED EAPI Evas_Object *elm_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6266 * Turn on/off the autorepeat event generated when the button is kept pressed
6268 * When off, no autorepeat is performed and buttons emit a normal @c clicked
6269 * signal when they are clicked.
6271 * When on, keeping a button pressed will continuously emit a @c repeated
6272 * signal until the button is released. The time it takes until it starts
6273 * emitting the signal is given by
6274 * elm_button_autorepeat_initial_timeout_set(), and the time between each
6275 * new emission by elm_button_autorepeat_gap_timeout_set().
6277 * @param obj The button object
6278 * @param on A bool to turn on/off the event
6280 EAPI void elm_button_autorepeat_set(Evas_Object *obj, Eina_Bool on) EINA_ARG_NONNULL(1);
6282 * Get whether the autorepeat feature is enabled
6284 * @param obj The button object
6285 * @return EINA_TRUE if autorepeat is on, EINA_FALSE otherwise
6287 * @see elm_button_autorepeat_set()
6289 EAPI Eina_Bool elm_button_autorepeat_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6291 * Set the initial timeout before the autorepeat event is generated
6293 * Sets the timeout, in seconds, since the button is pressed until the
6294 * first @c repeated signal is emitted. If @p t is 0.0 or less, there
6295 * won't be any delay and the even will be fired the moment the button is
6298 * @param obj The button object
6299 * @param t Timeout in seconds
6301 * @see elm_button_autorepeat_set()
6302 * @see elm_button_autorepeat_gap_timeout_set()
6304 EAPI void elm_button_autorepeat_initial_timeout_set(Evas_Object *obj, double t) EINA_ARG_NONNULL(1);
6306 * Get the initial timeout before the autorepeat event is generated
6308 * @param obj The button object
6309 * @return Timeout in seconds
6311 * @see elm_button_autorepeat_initial_timeout_set()
6313 EAPI double elm_button_autorepeat_initial_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6315 * Set the interval between each generated autorepeat event
6317 * After the first @c repeated event is fired, all subsequent ones will
6318 * follow after a delay of @p t seconds for each.
6320 * @param obj The button object
6321 * @param t Interval in seconds
6323 * @see elm_button_autorepeat_initial_timeout_set()
6325 EAPI void elm_button_autorepeat_gap_timeout_set(Evas_Object *obj, double t) EINA_ARG_NONNULL(1);
6327 * Get the interval between each generated autorepeat event
6329 * @param obj The button object
6330 * @return Interval in seconds
6332 EAPI double elm_button_autorepeat_gap_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6338 * @defgroup File_Selector_Button File Selector Button
6340 * @image html img/widget/fileselector_button/preview-00.png
6341 * @image latex img/widget/fileselector_button/preview-00.eps
6342 * @image html img/widget/fileselector_button/preview-01.png
6343 * @image latex img/widget/fileselector_button/preview-01.eps
6344 * @image html img/widget/fileselector_button/preview-02.png
6345 * @image latex img/widget/fileselector_button/preview-02.eps
6347 * This is a button that, when clicked, creates an Elementary
6348 * window (or inner window) <b> with a @ref Fileselector "file
6349 * selector widget" within</b>. When a file is chosen, the (inner)
6350 * window is closed and the button emits a signal having the
6351 * selected file as it's @c event_info.
6353 * This widget encapsulates operations on its internal file
6354 * selector on its own API. There is less control over its file
6355 * selector than that one would have instatiating one directly.
6357 * The following styles are available for this button:
6360 * @li @c "hoversel_vertical"
6361 * @li @c "hoversel_vertical_entry"
6363 * Smart callbacks one can register to:
6364 * - @c "file,chosen" - the user has selected a path, whose string
6365 * pointer comes as the @c event_info data (a stringshared
6368 * Here is an example on its usage:
6369 * @li @ref fileselector_button_example
6371 * @see @ref File_Selector_Entry for a similar widget.
6376 * Add a new file selector button widget to the given parent
6377 * Elementary (container) object
6379 * @param parent The parent object
6380 * @return a new file selector button widget handle or @c NULL, on
6383 EAPI Evas_Object *elm_fileselector_button_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6386 * Set the label for a given file selector button widget
6388 * @param obj The file selector button widget
6389 * @param label The text label to be displayed on @p obj
6391 * @deprecated use elm_object_text_set() instead.
6393 EINA_DEPRECATED EAPI void elm_fileselector_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
6396 * Get the label set for a given file selector button widget
6398 * @param obj The file selector button widget
6399 * @return The button label
6401 * @deprecated use elm_object_text_set() instead.
6403 EINA_DEPRECATED EAPI const char *elm_fileselector_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6406 * Set the icon on a given file selector button widget
6408 * @param obj The file selector button widget
6409 * @param icon The icon object for the button
6411 * Once the icon object is set, a previously set one will be
6412 * deleted. If you want to keep the latter, use the
6413 * elm_fileselector_button_icon_unset() function.
6415 * @see elm_fileselector_button_icon_get()
6417 EAPI void elm_fileselector_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
6420 * Get the icon set for a given file selector button widget
6422 * @param obj The file selector button widget
6423 * @return The icon object currently set on @p obj or @c NULL, if
6426 * @see elm_fileselector_button_icon_set()
6428 EAPI Evas_Object *elm_fileselector_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6431 * Unset the icon used in a given file selector button widget
6433 * @param obj The file selector button widget
6434 * @return The icon object that was being used on @p obj or @c
6437 * Unparent and return the icon object which was set for this
6440 * @see elm_fileselector_button_icon_set()
6442 EAPI Evas_Object *elm_fileselector_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6445 * Set the title for a given file selector button widget's window
6447 * @param obj The file selector button widget
6448 * @param title The title string
6450 * This will change the window's title, when the file selector pops
6451 * out after a click on the button. Those windows have the default
6452 * (unlocalized) value of @c "Select a file" as titles.
6454 * @note It will only take any effect if the file selector
6455 * button widget is @b not under "inwin mode".
6457 * @see elm_fileselector_button_window_title_get()
6459 EAPI void elm_fileselector_button_window_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
6462 * Get the title set for a given file selector button widget's
6465 * @param obj The file selector button widget
6466 * @return Title of the file selector button's window
6468 * @see elm_fileselector_button_window_title_get() for more details
6470 EAPI const char *elm_fileselector_button_window_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6473 * Set the size of a given file selector button widget's window,
6474 * holding the file selector itself.
6476 * @param obj The file selector button widget
6477 * @param width The window's width
6478 * @param height The window's height
6480 * @note it will only take any effect if the file selector button
6481 * widget is @b not under "inwin mode". The default size for the
6482 * window (when applicable) is 400x400 pixels.
6484 * @see elm_fileselector_button_window_size_get()
6486 EAPI void elm_fileselector_button_window_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
6489 * Get the size of a given file selector button widget's window,
6490 * holding the file selector itself.
6492 * @param obj The file selector button widget
6493 * @param width Pointer into which to store the width value
6494 * @param height Pointer into which to store the height value
6496 * @note Use @c NULL pointers on the size values you're not
6497 * interested in: they'll be ignored by the function.
6499 * @see elm_fileselector_button_window_size_set(), for more details
6501 EAPI void elm_fileselector_button_window_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
6504 * Set the initial file system path for a given file selector
6507 * @param obj The file selector button widget
6508 * @param path The path string
6510 * It must be a <b>directory</b> path, which will have the contents
6511 * displayed initially in the file selector's view, when invoked
6512 * from @p obj. The default initial path is the @c "HOME"
6513 * environment variable's value.
6515 * @see elm_fileselector_button_path_get()
6517 EAPI void elm_fileselector_button_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
6520 * Get the initial file system path set for a given file selector
6523 * @param obj The file selector button widget
6524 * @return path The path string
6526 * @see elm_fileselector_button_path_set() for more details
6528 EAPI const char *elm_fileselector_button_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6531 * Enable/disable a tree view in the given file selector button
6532 * widget's internal file selector
6534 * @param obj The file selector button widget
6535 * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
6538 * This has the same effect as elm_fileselector_expandable_set(),
6539 * but now applied to a file selector button's internal file
6542 * @note There's no way to put a file selector button's internal
6543 * file selector in "grid mode", as one may do with "pure" file
6546 * @see elm_fileselector_expandable_get()
6548 EAPI void elm_fileselector_button_expandable_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6551 * Get whether tree view is enabled for the given file selector
6552 * button widget's internal file selector
6554 * @param obj The file selector button widget
6555 * @return @c EINA_TRUE if @p obj widget's internal file selector
6556 * is in tree view, @c EINA_FALSE otherwise (and or errors)
6558 * @see elm_fileselector_expandable_set() for more details
6560 EAPI Eina_Bool elm_fileselector_button_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6563 * Set whether a given file selector button widget's internal file
6564 * selector is to display folders only or the directory contents,
6567 * @param obj The file selector button widget
6568 * @param only @c EINA_TRUE to make @p obj widget's internal file
6569 * selector only display directories, @c EINA_FALSE to make files
6570 * to be displayed in it too
6572 * This has the same effect as elm_fileselector_folder_only_set(),
6573 * but now applied to a file selector button's internal file
6576 * @see elm_fileselector_folder_only_get()
6578 EAPI void elm_fileselector_button_folder_only_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6581 * Get whether a given file selector button widget's internal file
6582 * selector is displaying folders only or the directory contents,
6585 * @param obj The file selector button widget
6586 * @return @c EINA_TRUE if @p obj widget's internal file
6587 * selector is only displaying directories, @c EINA_FALSE if files
6588 * are being displayed in it too (and on errors)
6590 * @see elm_fileselector_button_folder_only_set() for more details
6592 EAPI Eina_Bool elm_fileselector_button_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6595 * Enable/disable the file name entry box where the user can type
6596 * in a name for a file, in a given file selector button widget's
6597 * internal file selector.
6599 * @param obj The file selector button widget
6600 * @param is_save @c EINA_TRUE to make @p obj widget's internal
6601 * file selector a "saving dialog", @c EINA_FALSE otherwise
6603 * This has the same effect as elm_fileselector_is_save_set(),
6604 * but now applied to a file selector button's internal file
6607 * @see elm_fileselector_is_save_get()
6609 EAPI void elm_fileselector_button_is_save_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6612 * Get whether the given file selector button widget's internal
6613 * file selector is in "saving dialog" mode
6615 * @param obj The file selector button widget
6616 * @return @c EINA_TRUE, if @p obj widget's internal file selector
6617 * is in "saving dialog" mode, @c EINA_FALSE otherwise (and on
6620 * @see elm_fileselector_button_is_save_set() for more details
6622 EAPI Eina_Bool elm_fileselector_button_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6625 * Set whether a given file selector button widget's internal file
6626 * selector will raise an Elementary "inner window", instead of a
6627 * dedicated Elementary window. By default, it won't.
6629 * @param obj The file selector button widget
6630 * @param value @c EINA_TRUE to make it use an inner window, @c
6631 * EINA_TRUE to make it use a dedicated window
6633 * @see elm_win_inwin_add() for more information on inner windows
6634 * @see elm_fileselector_button_inwin_mode_get()
6636 EAPI void elm_fileselector_button_inwin_mode_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6639 * Get whether a given file selector button widget's internal file
6640 * selector will raise an Elementary "inner window", instead of a
6641 * dedicated Elementary window.
6643 * @param obj The file selector button widget
6644 * @return @c EINA_TRUE if will use an inner window, @c EINA_TRUE
6645 * if it will use a dedicated window
6647 * @see elm_fileselector_button_inwin_mode_set() for more details
6649 EAPI Eina_Bool elm_fileselector_button_inwin_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6656 * @defgroup File_Selector_Entry File Selector Entry
6658 * @image html img/widget/fileselector_entry/preview-00.png
6659 * @image latex img/widget/fileselector_entry/preview-00.eps
6661 * This is an entry made to be filled with or display a <b>file
6662 * system path string</b>. Besides the entry itself, the widget has
6663 * a @ref File_Selector_Button "file selector button" on its side,
6664 * which will raise an internal @ref Fileselector "file selector widget",
6665 * when clicked, for path selection aided by file system
6668 * This file selector may appear in an Elementary window or in an
6669 * inner window. When a file is chosen from it, the (inner) window
6670 * is closed and the selected file's path string is exposed both as
6671 * an smart event and as the new text on the entry.
6673 * This widget encapsulates operations on its internal file
6674 * selector on its own API. There is less control over its file
6675 * selector than that one would have instatiating one directly.
6677 * Smart callbacks one can register to:
6678 * - @c "changed" - The text within the entry was changed
6679 * - @c "activated" - The entry has had editing finished and
6680 * changes are to be "committed"
6681 * - @c "press" - The entry has been clicked
6682 * - @c "longpressed" - The entry has been clicked (and held) for a
6684 * - @c "clicked" - The entry has been clicked
6685 * - @c "clicked,double" - The entry has been double clicked
6686 * - @c "focused" - The entry has received focus
6687 * - @c "unfocused" - The entry has lost focus
6688 * - @c "selection,paste" - A paste action has occurred on the
6690 * - @c "selection,copy" - A copy action has occurred on the entry
6691 * - @c "selection,cut" - A cut action has occurred on the entry
6692 * - @c "unpressed" - The file selector entry's button was released
6693 * after being pressed.
6694 * - @c "file,chosen" - The user has selected a path via the file
6695 * selector entry's internal file selector, whose string pointer
6696 * comes as the @c event_info data (a stringshared string)
6698 * Here is an example on its usage:
6699 * @li @ref fileselector_entry_example
6701 * @see @ref File_Selector_Button for a similar widget.
6706 * Add a new file selector entry widget to the given parent
6707 * Elementary (container) object
6709 * @param parent The parent object
6710 * @return a new file selector entry widget handle or @c NULL, on
6713 EAPI Evas_Object *elm_fileselector_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6716 * Set the label for a given file selector entry widget's button
6718 * @param obj The file selector entry widget
6719 * @param label The text label to be displayed on @p obj widget's
6722 * @deprecated use elm_object_text_set() instead.
6724 EINA_DEPRECATED EAPI void elm_fileselector_entry_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
6727 * Get the label set for a given file selector entry widget's button
6729 * @param obj The file selector entry widget
6730 * @return The widget button's label
6732 * @deprecated use elm_object_text_set() instead.
6734 EINA_DEPRECATED EAPI const char *elm_fileselector_entry_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6737 * Set the icon on a given file selector entry widget's button
6739 * @param obj The file selector entry widget
6740 * @param icon The icon object for the entry's button
6742 * Once the icon object is set, a previously set one will be
6743 * deleted. If you want to keep the latter, use the
6744 * elm_fileselector_entry_button_icon_unset() function.
6746 * @see elm_fileselector_entry_button_icon_get()
6748 EAPI void elm_fileselector_entry_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
6751 * Get the icon set for a given file selector entry widget's button
6753 * @param obj The file selector entry widget
6754 * @return The icon object currently set on @p obj widget's button
6755 * or @c NULL, if none is
6757 * @see elm_fileselector_entry_button_icon_set()
6759 EAPI Evas_Object *elm_fileselector_entry_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6762 * Unset the icon used in a given file selector entry widget's
6765 * @param obj The file selector entry widget
6766 * @return The icon object that was being used on @p obj widget's
6767 * button or @c NULL, on errors
6769 * Unparent and return the icon object which was set for this
6772 * @see elm_fileselector_entry_button_icon_set()
6774 EAPI Evas_Object *elm_fileselector_entry_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6777 * Set the title for a given file selector entry widget's window
6779 * @param obj The file selector entry widget
6780 * @param title The title string
6782 * This will change the window's title, when the file selector pops
6783 * out after a click on the entry's button. Those windows have the
6784 * default (unlocalized) value of @c "Select a file" as titles.
6786 * @note It will only take any effect if the file selector
6787 * entry widget is @b not under "inwin mode".
6789 * @see elm_fileselector_entry_window_title_get()
6791 EAPI void elm_fileselector_entry_window_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
6794 * Get the title set for a given file selector entry widget's
6797 * @param obj The file selector entry widget
6798 * @return Title of the file selector entry's window
6800 * @see elm_fileselector_entry_window_title_get() for more details
6802 EAPI const char *elm_fileselector_entry_window_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6805 * Set the size of a given file selector entry widget's window,
6806 * holding the file selector itself.
6808 * @param obj The file selector entry widget
6809 * @param width The window's width
6810 * @param height The window's height
6812 * @note it will only take any effect if the file selector entry
6813 * widget is @b not under "inwin mode". The default size for the
6814 * window (when applicable) is 400x400 pixels.
6816 * @see elm_fileselector_entry_window_size_get()
6818 EAPI void elm_fileselector_entry_window_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
6821 * Get the size of a given file selector entry widget's window,
6822 * holding the file selector itself.
6824 * @param obj The file selector entry widget
6825 * @param width Pointer into which to store the width value
6826 * @param height Pointer into which to store the height value
6828 * @note Use @c NULL pointers on the size values you're not
6829 * interested in: they'll be ignored by the function.
6831 * @see elm_fileselector_entry_window_size_set(), for more details
6833 EAPI void elm_fileselector_entry_window_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
6836 * Set the initial file system path and the entry's path string for
6837 * a given file selector entry widget
6839 * @param obj The file selector entry widget
6840 * @param path The path string
6842 * It must be a <b>directory</b> path, which will have the contents
6843 * displayed initially in the file selector's view, when invoked
6844 * from @p obj. The default initial path is the @c "HOME"
6845 * environment variable's value.
6847 * @see elm_fileselector_entry_path_get()
6849 EAPI void elm_fileselector_entry_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
6852 * Get the entry's path string for a given file selector entry
6855 * @param obj The file selector entry widget
6856 * @return path The path string
6858 * @see elm_fileselector_entry_path_set() for more details
6860 EAPI const char *elm_fileselector_entry_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6863 * Enable/disable a tree view in the given file selector entry
6864 * widget's internal file selector
6866 * @param obj The file selector entry widget
6867 * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
6870 * This has the same effect as elm_fileselector_expandable_set(),
6871 * but now applied to a file selector entry's internal file
6874 * @note There's no way to put a file selector entry's internal
6875 * file selector in "grid mode", as one may do with "pure" file
6878 * @see elm_fileselector_expandable_get()
6880 EAPI void elm_fileselector_entry_expandable_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6883 * Get whether tree view is enabled for the given file selector
6884 * entry widget's internal file selector
6886 * @param obj The file selector entry widget
6887 * @return @c EINA_TRUE if @p obj widget's internal file selector
6888 * is in tree view, @c EINA_FALSE otherwise (and or errors)
6890 * @see elm_fileselector_expandable_set() for more details
6892 EAPI Eina_Bool elm_fileselector_entry_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6895 * Set whether a given file selector entry widget's internal file
6896 * selector is to display folders only or the directory contents,
6899 * @param obj The file selector entry widget
6900 * @param only @c EINA_TRUE to make @p obj widget's internal file
6901 * selector only display directories, @c EINA_FALSE to make files
6902 * to be displayed in it too
6904 * This has the same effect as elm_fileselector_folder_only_set(),
6905 * but now applied to a file selector entry's internal file
6908 * @see elm_fileselector_folder_only_get()
6910 EAPI void elm_fileselector_entry_folder_only_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6913 * Get whether a given file selector entry widget's internal file
6914 * selector is displaying folders only or the directory contents,
6917 * @param obj The file selector entry widget
6918 * @return @c EINA_TRUE if @p obj widget's internal file
6919 * selector is only displaying directories, @c EINA_FALSE if files
6920 * are being displayed in it too (and on errors)
6922 * @see elm_fileselector_entry_folder_only_set() for more details
6924 EAPI Eina_Bool elm_fileselector_entry_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6927 * Enable/disable the file name entry box where the user can type
6928 * in a name for a file, in a given file selector entry widget's
6929 * internal file selector.
6931 * @param obj The file selector entry widget
6932 * @param is_save @c EINA_TRUE to make @p obj widget's internal
6933 * file selector a "saving dialog", @c EINA_FALSE otherwise
6935 * This has the same effect as elm_fileselector_is_save_set(),
6936 * but now applied to a file selector entry's internal file
6939 * @see elm_fileselector_is_save_get()
6941 EAPI void elm_fileselector_entry_is_save_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6944 * Get whether the given file selector entry widget's internal
6945 * file selector is in "saving dialog" mode
6947 * @param obj The file selector entry widget
6948 * @return @c EINA_TRUE, if @p obj widget's internal file selector
6949 * is in "saving dialog" mode, @c EINA_FALSE otherwise (and on
6952 * @see elm_fileselector_entry_is_save_set() for more details
6954 EAPI Eina_Bool elm_fileselector_entry_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6957 * Set whether a given file selector entry widget's internal file
6958 * selector will raise an Elementary "inner window", instead of a
6959 * dedicated Elementary window. By default, it won't.
6961 * @param obj The file selector entry widget
6962 * @param value @c EINA_TRUE to make it use an inner window, @c
6963 * EINA_TRUE to make it use a dedicated window
6965 * @see elm_win_inwin_add() for more information on inner windows
6966 * @see elm_fileselector_entry_inwin_mode_get()
6968 EAPI void elm_fileselector_entry_inwin_mode_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6971 * Get whether a given file selector entry widget's internal file
6972 * selector will raise an Elementary "inner window", instead of a
6973 * dedicated Elementary window.
6975 * @param obj The file selector entry widget
6976 * @return @c EINA_TRUE if will use an inner window, @c EINA_TRUE
6977 * if it will use a dedicated window
6979 * @see elm_fileselector_entry_inwin_mode_set() for more details
6981 EAPI Eina_Bool elm_fileselector_entry_inwin_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6984 * Set the initial file system path for a given file selector entry
6987 * @param obj The file selector entry widget
6988 * @param path The path string
6990 * It must be a <b>directory</b> path, which will have the contents
6991 * displayed initially in the file selector's view, when invoked
6992 * from @p obj. The default initial path is the @c "HOME"
6993 * environment variable's value.
6995 * @see elm_fileselector_entry_path_get()
6997 EAPI void elm_fileselector_entry_selected_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
7000 * Get the parent directory's path to the latest file selection on
7001 * a given filer selector entry widget
7003 * @param obj The file selector object
7004 * @return The (full) path of the directory of the last selection
7005 * on @p obj widget, a @b stringshared string
7007 * @see elm_fileselector_entry_path_set()
7009 EAPI const char *elm_fileselector_entry_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7016 * @defgroup Scroller Scroller
7018 * A scroller holds a single object and "scrolls it around". This means that
7019 * it allows the user to use a scrollbar (or a finger) to drag the viewable
7020 * region around, allowing to move through a much larger object that is
7021 * contained in the scroller. The scroller will always have a small minimum
7022 * size by default as it won't be limited by the contents of the scroller.
7024 * Signals that you can add callbacks for are:
7025 * @li "edge,left" - the left edge of the content has been reached
7026 * @li "edge,right" - the right edge of the content has been reached
7027 * @li "edge,top" - the top edge of the content has been reached
7028 * @li "edge,bottom" - the bottom edge of the content has been reached
7029 * @li "scroll" - the content has been scrolled (moved)
7030 * @li "scroll,anim,start" - scrolling animation has started
7031 * @li "scroll,anim,stop" - scrolling animation has stopped
7032 * @li "scroll,drag,start" - dragging the contents around has started
7033 * @li "scroll,drag,stop" - dragging the contents around has stopped
7034 * @note The "scroll,anim,*" and "scroll,drag,*" signals are only emitted by
7037 * @note When Elemementary is in embedded mode the scrollbars will not be
7038 * dragable, they appear merely as indicators of how much has been scrolled.
7039 * @note When Elementary is in desktop mode the thumbscroll(a.k.a.
7040 * fingerscroll) won't work.
7042 * Default contents parts of the scroller widget that you can use for are:
7043 * @li "default" - A content of the scroller
7045 * In @ref tutorial_scroller you'll find an example of how to use most of
7050 * @brief Type that controls when scrollbars should appear.
7052 * @see elm_scroller_policy_set()
7054 typedef enum _Elm_Scroller_Policy
7056 ELM_SCROLLER_POLICY_AUTO = 0, /**< Show scrollbars as needed */
7057 ELM_SCROLLER_POLICY_ON, /**< Always show scrollbars */
7058 ELM_SCROLLER_POLICY_OFF, /**< Never show scrollbars */
7059 ELM_SCROLLER_POLICY_LAST
7060 } Elm_Scroller_Policy;
7062 * @brief Add a new scroller to the parent
7064 * @param parent The parent object
7065 * @return The new object or NULL if it cannot be created
7067 EAPI Evas_Object *elm_scroller_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7069 * @brief Set the content of the scroller widget (the object to be scrolled around).
7071 * @param obj The scroller object
7072 * @param content The new content object
7074 * Once the content object is set, a previously set one will be deleted.
7075 * If you want to keep that old content object, use the
7076 * elm_scroller_content_unset() function.
7077 * @deprecated use elm_object_content_set() instead
7079 EINA_DEPRECATED EAPI void elm_scroller_content_set(Evas_Object *obj, Evas_Object *child) EINA_ARG_NONNULL(1);
7081 * @brief Get the content of the scroller widget
7083 * @param obj The slider object
7084 * @return The content that is being used
7086 * Return the content object which is set for this widget
7088 * @see elm_scroller_content_set()
7089 * @deprecated use elm_object_content_get() instead.
7091 EINA_DEPRECATED EAPI Evas_Object *elm_scroller_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7093 * @brief Unset the content of the scroller widget
7095 * @param obj The slider object
7096 * @return The content that was being used
7098 * Unparent and return the content object which was set for this widget
7100 * @see elm_scroller_content_set()
7101 * @deprecated use elm_object_content_unset() instead.
7103 EINA_DEPRECATED EAPI Evas_Object *elm_scroller_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
7105 * @brief Set custom theme elements for the scroller
7107 * @param obj The scroller object
7108 * @param widget The widget name to use (default is "scroller")
7109 * @param base The base name to use (default is "base")
7111 EAPI void elm_scroller_custom_widget_base_theme_set(Evas_Object *obj, const char *widget, const char *base) EINA_ARG_NONNULL(1, 2, 3);
7113 * @brief Make the scroller minimum size limited to the minimum size of the content
7115 * @param obj The scroller object
7116 * @param w Enable limiting minimum size horizontally
7117 * @param h Enable limiting minimum size vertically
7119 * By default the scroller will be as small as its design allows,
7120 * irrespective of its content. This will make the scroller minimum size the
7121 * right size horizontally and/or vertically to perfectly fit its content in
7124 EAPI void elm_scroller_content_min_limit(Evas_Object *obj, Eina_Bool w, Eina_Bool h) EINA_ARG_NONNULL(1);
7126 * @brief Show a specific virtual region within the scroller content object
7128 * @param obj The scroller object
7129 * @param x X coordinate of the region
7130 * @param y Y coordinate of the region
7131 * @param w Width of the region
7132 * @param h Height of the region
7134 * This will ensure all (or part if it does not fit) of the designated
7135 * region in the virtual content object (0, 0 starting at the top-left of the
7136 * virtual content object) is shown within the scroller.
7138 EAPI void elm_scroller_region_show(Evas_Object *obj, Evas_Coord x, Evas_Coord y, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
7140 * @brief Set the scrollbar visibility policy
7142 * @param obj The scroller object
7143 * @param policy_h Horizontal scrollbar policy
7144 * @param policy_v Vertical scrollbar policy
7146 * This sets the scrollbar visibility policy for the given scroller.
7147 * ELM_SCROLLER_POLICY_AUTO means the scrollbar is made visible if it is
7148 * needed, and otherwise kept hidden. ELM_SCROLLER_POLICY_ON turns it on all
7149 * the time, and ELM_SCROLLER_POLICY_OFF always keeps it off. This applies
7150 * respectively for the horizontal and vertical scrollbars.
7152 EAPI void elm_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
7154 * @brief Gets scrollbar visibility policy
7156 * @param obj The scroller object
7157 * @param policy_h Horizontal scrollbar policy
7158 * @param policy_v Vertical scrollbar policy
7160 * @see elm_scroller_policy_set()
7162 EAPI void elm_scroller_policy_get(const Evas_Object *obj, Elm_Scroller_Policy *policy_h, Elm_Scroller_Policy *policy_v) EINA_ARG_NONNULL(1);
7164 * @brief Get the currently visible content region
7166 * @param obj The scroller object
7167 * @param x X coordinate of the region
7168 * @param y Y coordinate of the region
7169 * @param w Width of the region
7170 * @param h Height of the region
7172 * This gets the current region in the content object that is visible through
7173 * the scroller. The region co-ordinates are returned in the @p x, @p y, @p
7174 * w, @p h values pointed to.
7176 * @note All coordinates are relative to the content.
7178 * @see elm_scroller_region_show()
7180 EAPI void elm_scroller_region_get(const Evas_Object *obj, Evas_Coord *x, Evas_Coord *y, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
7182 * @brief Get the size of the content object
7184 * @param obj The scroller object
7185 * @param w Width of the content object.
7186 * @param h Height of the content object.
7188 * This gets the size of the content object of the scroller.
7190 EAPI void elm_scroller_child_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
7192 * @brief Set bouncing behavior
7194 * @param obj The scroller object
7195 * @param h_bounce Allow bounce horizontally
7196 * @param v_bounce Allow bounce vertically
7198 * When scrolling, the scroller may "bounce" when reaching an edge of the
7199 * content object. This is a visual way to indicate the end has been reached.
7200 * This is enabled by default for both axis. This API will set if it is enabled
7201 * for the given axis with the boolean parameters for each axis.
7203 EAPI void elm_scroller_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
7205 * @brief Get the bounce behaviour
7207 * @param obj The Scroller object
7208 * @param h_bounce Will the scroller bounce horizontally or not
7209 * @param v_bounce Will the scroller bounce vertically or not
7211 * @see elm_scroller_bounce_set()
7213 EAPI void elm_scroller_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
7215 * @brief Set scroll page size relative to viewport size.
7217 * @param obj The scroller object
7218 * @param h_pagerel The horizontal page relative size
7219 * @param v_pagerel The vertical page relative size
7221 * The scroller is capable of limiting scrolling by the user to "pages". That
7222 * is to jump by and only show a "whole page" at a time as if the continuous
7223 * area of the scroller content is split into page sized pieces. This sets
7224 * the size of a page relative to the viewport of the scroller. 1.0 is "1
7225 * viewport" is size (horizontally or vertically). 0.0 turns it off in that
7226 * axis. This is mutually exclusive with page size
7227 * (see elm_scroller_page_size_set() for more information). Likewise 0.5
7228 * is "half a viewport". Sane usable values are normally between 0.0 and 1.0
7229 * including 1.0. If you only want 1 axis to be page "limited", use 0.0 for
7232 EAPI void elm_scroller_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel) EINA_ARG_NONNULL(1);
7234 * @brief Set scroll page size.
7236 * @param obj The scroller object
7237 * @param h_pagesize The horizontal page size
7238 * @param v_pagesize The vertical page size
7240 * This sets the page size to an absolute fixed value, with 0 turning it off
7243 * @see elm_scroller_page_relative_set()
7245 EAPI void elm_scroller_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize) EINA_ARG_NONNULL(1);
7247 * @brief Get scroll current page number.
7249 * @param obj The scroller object
7250 * @param h_pagenumber The horizontal page number
7251 * @param v_pagenumber The vertical page number
7253 * The page number starts from 0. 0 is the first page.
7254 * Current page means the page which meets the top-left of the viewport.
7255 * If there are two or more pages in the viewport, it returns the number of the page
7256 * which meets the top-left of the viewport.
7258 * @see elm_scroller_last_page_get()
7259 * @see elm_scroller_page_show()
7260 * @see elm_scroller_page_brint_in()
7262 EAPI void elm_scroller_current_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber) EINA_ARG_NONNULL(1);
7264 * @brief Get scroll last page number.
7266 * @param obj The scroller object
7267 * @param h_pagenumber The horizontal page number
7268 * @param v_pagenumber The vertical page number
7270 * The page number starts from 0. 0 is the first page.
7271 * This returns the last page number among the pages.
7273 * @see elm_scroller_current_page_get()
7274 * @see elm_scroller_page_show()
7275 * @see elm_scroller_page_brint_in()
7277 EAPI void elm_scroller_last_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber) EINA_ARG_NONNULL(1);
7279 * Show a specific virtual region within the scroller content object by page number.
7281 * @param obj The scroller object
7282 * @param h_pagenumber The horizontal page number
7283 * @param v_pagenumber The vertical page number
7285 * 0, 0 of the indicated page is located at the top-left of the viewport.
7286 * This will jump to the page directly without animation.
7291 * sc = elm_scroller_add(win);
7292 * elm_scroller_content_set(sc, content);
7293 * elm_scroller_page_relative_set(sc, 1, 0);
7294 * elm_scroller_current_page_get(sc, &h_page, &v_page);
7295 * elm_scroller_page_show(sc, h_page + 1, v_page);
7298 * @see elm_scroller_page_bring_in()
7300 EAPI void elm_scroller_page_show(Evas_Object *obj, int h_pagenumber, int v_pagenumber) EINA_ARG_NONNULL(1);
7302 * Show a specific virtual region within the scroller content object by page number.
7304 * @param obj The scroller object
7305 * @param h_pagenumber The horizontal page number
7306 * @param v_pagenumber The vertical page number
7308 * 0, 0 of the indicated page is located at the top-left of the viewport.
7309 * This will slide to the page with animation.
7314 * sc = elm_scroller_add(win);
7315 * elm_scroller_content_set(sc, content);
7316 * elm_scroller_page_relative_set(sc, 1, 0);
7317 * elm_scroller_last_page_get(sc, &h_page, &v_page);
7318 * elm_scroller_page_bring_in(sc, h_page, v_page);
7321 * @see elm_scroller_page_show()
7323 EAPI void elm_scroller_page_bring_in(Evas_Object *obj, int h_pagenumber, int v_pagenumber) EINA_ARG_NONNULL(1);
7325 * @brief Show a specific virtual region within the scroller content object.
7327 * @param obj The scroller object
7328 * @param x X coordinate of the region
7329 * @param y Y coordinate of the region
7330 * @param w Width of the region
7331 * @param h Height of the region
7333 * This will ensure all (or part if it does not fit) of the designated
7334 * region in the virtual content object (0, 0 starting at the top-left of the
7335 * virtual content object) is shown within the scroller. Unlike
7336 * elm_scroller_region_show(), this allow the scroller to "smoothly slide"
7337 * to this location (if configuration in general calls for transitions). It
7338 * may not jump immediately to the new location and make take a while and
7339 * show other content along the way.
7341 * @see elm_scroller_region_show()
7343 EAPI void elm_scroller_region_bring_in(Evas_Object *obj, Evas_Coord x, Evas_Coord y, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
7345 * @brief Set event propagation on a scroller
7347 * @param obj The scroller object
7348 * @param propagation If propagation is enabled or not
7350 * This enables or disabled event propagation from the scroller content to
7351 * the scroller and its parent. By default event propagation is disabled.
7353 EAPI void elm_scroller_propagate_events_set(Evas_Object *obj, Eina_Bool propagation) EINA_ARG_NONNULL(1);
7355 * @brief Get event propagation for a scroller
7357 * @param obj The scroller object
7358 * @return The propagation state
7360 * This gets the event propagation for a scroller.
7362 * @see elm_scroller_propagate_events_set()
7364 EAPI Eina_Bool elm_scroller_propagate_events_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7366 * @brief Set scrolling gravity on a scroller
7368 * @param obj The scroller object
7369 * @param x The scrolling horizontal gravity
7370 * @param y The scrolling vertical gravity
7372 * The gravity, defines how the scroller will adjust its view
7373 * when the size of the scroller contents increase.
7375 * The scroller will adjust the view to glue itself as follows.
7377 * x=0.0, for showing the left most region of the content.
7378 * x=1.0, for showing the right most region of the content.
7379 * y=0.0, for showing the bottom most region of the content.
7380 * y=1.0, for showing the top most region of the content.
7382 * Default values for x and y are 0.0
7384 EAPI void elm_scroller_gravity_set(Evas_Object *obj, double x, double y) EINA_ARG_NONNULL(1);
7386 * @brief Get scrolling gravity values for a scroller
7388 * @param obj The scroller object
7389 * @param x The scrolling horizontal gravity
7390 * @param y The scrolling vertical gravity
7392 * This gets gravity values for a scroller.
7394 * @see elm_scroller_gravity_set()
7397 EAPI void elm_scroller_gravity_get(const Evas_Object *obj, double *x, double *y) EINA_ARG_NONNULL(1);
7403 * @defgroup Label Label
7405 * @image html img/widget/label/preview-00.png
7406 * @image latex img/widget/label/preview-00.eps
7408 * @brief Widget to display text, with simple html-like markup.
7410 * The Label widget @b doesn't allow text to overflow its boundaries, if the
7411 * text doesn't fit the geometry of the label it will be ellipsized or be
7412 * cut. Elementary provides several styles for this widget:
7413 * @li default - No animation
7414 * @li marker - Centers the text in the label and make it bold by default
7415 * @li slide_long - The entire text appears from the right of the screen and
7416 * slides until it disappears in the left of the screen(reappering on the
7418 * @li slide_short - The text appears in the left of the label and slides to
7419 * the right to show the overflow. When all of the text has been shown the
7420 * position is reset.
7421 * @li slide_bounce - The text appears in the left of the label and slides to
7422 * the right to show the overflow. When all of the text has been shown the
7423 * animation reverses, moving the text to the left.
7425 * Custom themes can of course invent new markup tags and style them any way
7428 * The following signals may be emitted by the label widget:
7429 * @li "language,changed": The program's language changed.
7431 * See @ref tutorial_label for a demonstration of how to use a label widget.
7435 * @brief Add a new label to the parent
7437 * @param parent The parent object
7438 * @return The new object or NULL if it cannot be created
7440 EAPI Evas_Object *elm_label_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7442 * @brief Set the label on the label object
7444 * @param obj The label object
7445 * @param label The label will be used on the label object
7446 * @deprecated See elm_object_text_set()
7448 EINA_DEPRECATED EAPI void elm_label_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1); /* deprecated, use elm_object_text_set instead */
7450 * @brief Get the label used on the label object
7452 * @param obj The label object
7453 * @return The string inside the label
7454 * @deprecated See elm_object_text_get()
7456 EINA_DEPRECATED EAPI const char *elm_label_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1); /* deprecated, use elm_object_text_get instead */
7458 * @brief Set the wrapping behavior of the label
7460 * @param obj The label object
7461 * @param wrap To wrap text or not
7463 * By default no wrapping is done. Possible values for @p wrap are:
7464 * @li ELM_WRAP_NONE - No wrapping
7465 * @li ELM_WRAP_CHAR - wrap between characters
7466 * @li ELM_WRAP_WORD - wrap between words
7467 * @li ELM_WRAP_MIXED - Word wrap, and if that fails, char wrap
7469 EAPI void elm_label_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
7471 * @brief Get the wrapping behavior of the label
7473 * @param obj The label object
7476 * @see elm_label_line_wrap_set()
7478 EAPI Elm_Wrap_Type elm_label_line_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7480 * @brief Set wrap width of the label
7482 * @param obj The label object
7483 * @param w The wrap width in pixels at a minimum where words need to wrap
7485 * This function sets the maximum width size hint of the label.
7487 * @warning This is only relevant if the label is inside a container.
7489 EAPI void elm_label_wrap_width_set(Evas_Object *obj, Evas_Coord w) EINA_ARG_NONNULL(1);
7491 * @brief Get wrap width of the label
7493 * @param obj The label object
7494 * @return The wrap width in pixels at a minimum where words need to wrap
7496 * @see elm_label_wrap_width_set()
7498 EAPI Evas_Coord elm_label_wrap_width_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7500 * @brief Set wrap height of the label
7502 * @param obj The label object
7503 * @param h The wrap height in pixels at a minimum where words need to wrap
7505 * This function sets the maximum height size hint of the label.
7507 * @warning This is only relevant if the label is inside a container.
7509 EAPI void elm_label_wrap_height_set(Evas_Object *obj, Evas_Coord h) EINA_ARG_NONNULL(1);
7511 * @brief get wrap width of the label
7513 * @param obj The label object
7514 * @return The wrap height in pixels at a minimum where words need to wrap
7516 EAPI Evas_Coord elm_label_wrap_height_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7518 * @brief Set the font size on the label object.
7520 * @param obj The label object
7521 * @param size font size
7523 * @warning NEVER use this. It is for hyper-special cases only. use styles
7524 * instead. e.g. "default", "marker", "slide_long" etc.
7526 EAPI void elm_label_fontsize_set(Evas_Object *obj, int fontsize) EINA_ARG_NONNULL(1);
7528 * @brief Set the text color on the label object
7530 * @param obj The label object
7531 * @param r Red property background color of The label object
7532 * @param g Green property background color of The label object
7533 * @param b Blue property background color of The label object
7534 * @param a Alpha property background color of The label object
7536 * @warning NEVER use this. It is for hyper-special cases only. use styles
7537 * instead. e.g. "default", "marker", "slide_long" etc.
7539 EAPI void elm_label_text_color_set(Evas_Object *obj, unsigned int r, unsigned int g, unsigned int b, unsigned int a) EINA_ARG_NONNULL(1);
7541 * @brief Set the text align on the label object
7543 * @param obj The label object
7544 * @param align align mode ("left", "center", "right")
7546 * @warning NEVER use this. It is for hyper-special cases only. use styles
7547 * instead. e.g. "default", "marker", "slide_long" etc.
7549 EAPI void elm_label_text_align_set(Evas_Object *obj, const char *alignmode) EINA_ARG_NONNULL(1);
7551 * @brief Set background color of the label
7553 * @param obj The label object
7554 * @param r Red property background color of The label object
7555 * @param g Green property background color of The label object
7556 * @param b Blue property background color of The label object
7557 * @param a Alpha property background alpha of The label object
7559 * @warning NEVER use this. It is for hyper-special cases only. use styles
7560 * instead. e.g. "default", "marker", "slide_long" etc.
7562 EAPI void elm_label_background_color_set(Evas_Object *obj, unsigned int r, unsigned int g, unsigned int b, unsigned int a) EINA_ARG_NONNULL(1);
7564 * @brief Set the ellipsis behavior of the label
7566 * @param obj The label object
7567 * @param ellipsis To ellipsis text or not
7569 * If set to true and the text doesn't fit in the label an ellipsis("...")
7570 * will be shown at the end of the widget.
7572 * @warning This doesn't work with slide(elm_label_slide_set()) or if the
7573 * choosen wrap method was ELM_WRAP_WORD.
7575 EAPI void elm_label_ellipsis_set(Evas_Object *obj, Eina_Bool ellipsis) EINA_ARG_NONNULL(1);
7577 * @brief Set the text slide of the label
7579 * @param obj The label object
7580 * @param slide To start slide or stop
7582 * If set to true, the text of the label will slide/scroll through the length of
7585 * @warning This only works with the themes "slide_short", "slide_long" and
7588 EAPI void elm_label_slide_set(Evas_Object *obj, Eina_Bool slide) EINA_ARG_NONNULL(1);
7590 * @brief Get the text slide mode of the label
7592 * @param obj The label object
7593 * @return slide slide mode value
7595 * @see elm_label_slide_set()
7597 EAPI Eina_Bool elm_label_slide_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
7599 * @brief Set the slide duration(speed) of the label
7601 * @param obj The label object
7602 * @return The duration in seconds in moving text from slide begin position
7603 * to slide end position
7605 EAPI void elm_label_slide_duration_set(Evas_Object *obj, double duration) EINA_ARG_NONNULL(1);
7607 * @brief Get the slide duration(speed) of the label
7609 * @param obj The label object
7610 * @return The duration time in moving text from slide begin position to slide end position
7612 * @see elm_label_slide_duration_set()
7614 EAPI double elm_label_slide_duration_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
7620 * @defgroup Toggle Toggle
7622 * @image html img/widget/toggle/preview-00.png
7623 * @image latex img/widget/toggle/preview-00.eps
7625 * @brief A toggle is a slider which can be used to toggle between
7626 * two values. It has two states: on and off.
7628 * This widget is deprecated. Please use elm_check_add() instead using the
7629 * toggle style like:
7632 * obj = elm_check_add(parent);
7633 * elm_object_style_set(obj, "toggle");
7634 * elm_object_part_text_set(obj, "on", "ON");
7635 * elm_object_part_text_set(obj, "off", "OFF");
7638 * Signals that you can add callbacks for are:
7639 * @li "changed" - Whenever the toggle value has been changed. Is not called
7640 * until the toggle is released by the cursor (assuming it
7641 * has been triggered by the cursor in the first place).
7643 * Default contents parts of the toggle widget that you can use for are:
7644 * @li "icon" - A icon of the toggle
7646 * Default text parts of the toggle widget that you can use for are:
7647 * @li "elm.text" - Label of the toggle
7649 * @ref tutorial_toggle show how to use a toggle.
7653 * @brief Add a toggle to @p parent.
7655 * @param parent The parent object
7657 * @return The toggle object
7659 EINA_DEPRECATED EAPI Evas_Object *elm_toggle_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7661 * @brief Sets the label to be displayed with the toggle.
7663 * @param obj The toggle object
7664 * @param label The label to be displayed
7666 * @deprecated use elm_object_text_set() instead.
7668 EINA_DEPRECATED EAPI void elm_toggle_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
7670 * @brief Gets the label of the toggle
7672 * @param obj toggle object
7673 * @return The label of the toggle
7675 * @deprecated use elm_object_text_get() instead.
7677 EINA_DEPRECATED EAPI const char *elm_toggle_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7679 * @brief Set the icon used for the toggle
7681 * @param obj The toggle object
7682 * @param icon The icon object for the button
7684 * Once the icon object is set, a previously set one will be deleted
7685 * If you want to keep that old content object, use the
7686 * elm_toggle_icon_unset() function.
7688 * @deprecated use elm_object_part_content_set() instead.
7690 EINA_DEPRECATED EAPI void elm_toggle_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
7692 * @brief Get the icon used for the toggle
7694 * @param obj The toggle object
7695 * @return The icon object that is being used
7697 * Return the icon object which is set for this widget.
7699 * @see elm_toggle_icon_set()
7701 * @deprecated use elm_object_part_content_get() instead.
7703 EINA_DEPRECATED EAPI Evas_Object *elm_toggle_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7705 * @brief Unset the icon used for the toggle
7707 * @param obj The toggle object
7708 * @return The icon object that was being used
7710 * Unparent and return the icon object which was set for this widget.
7712 * @see elm_toggle_icon_set()
7714 * @deprecated use elm_object_part_content_unset() instead.
7716 EINA_DEPRECATED EAPI Evas_Object *elm_toggle_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
7718 * @brief Sets the labels to be associated with the on and off states of the toggle.
7720 * @param obj The toggle object
7721 * @param onlabel The label displayed when the toggle is in the "on" state
7722 * @param offlabel The label displayed when the toggle is in the "off" state
7724 * @deprecated use elm_object_part_text_set() for "on" and "off" parts
7727 EINA_DEPRECATED EAPI void elm_toggle_states_labels_set(Evas_Object *obj, const char *onlabel, const char *offlabel) EINA_ARG_NONNULL(1);
7729 * @brief Gets the labels associated with the on and off states of the
7732 * @param obj The toggle object
7733 * @param onlabel A char** to place the onlabel of @p obj into
7734 * @param offlabel A char** to place the offlabel of @p obj into
7736 * @deprecated use elm_object_part_text_get() for "on" and "off" parts
7739 EINA_DEPRECATED EAPI void elm_toggle_states_labels_get(const Evas_Object *obj, const char **onlabel, const char **offlabel) EINA_ARG_NONNULL(1);
7741 * @brief Sets the state of the toggle to @p state.
7743 * @param obj The toggle object
7744 * @param state The state of @p obj
7746 * @deprecated use elm_check_state_set() instead.
7748 EINA_DEPRECATED EAPI void elm_toggle_state_set(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
7750 * @brief Gets the state of the toggle to @p state.
7752 * @param obj The toggle object
7753 * @return The state of @p obj
7755 * @deprecated use elm_check_state_get() instead.
7757 EINA_DEPRECATED EAPI Eina_Bool elm_toggle_state_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7759 * @brief Sets the state pointer of the toggle to @p statep.
7761 * @param obj The toggle object
7762 * @param statep The state pointer of @p obj
7764 * @deprecated use elm_check_state_pointer_set() instead.
7766 EINA_DEPRECATED EAPI void elm_toggle_state_pointer_set(Evas_Object *obj, Eina_Bool *statep) EINA_ARG_NONNULL(1);
7772 * @defgroup Frame Frame
7774 * @image html img/widget/frame/preview-00.png
7775 * @image latex img/widget/frame/preview-00.eps
7777 * @brief Frame is a widget that holds some content and has a title.
7779 * The default look is a frame with a title, but Frame supports multple
7787 * @li outdent_bottom
7789 * Of all this styles only default shows the title. Frame emits no signals.
7791 * Default contents parts of the frame widget that you can use for are:
7792 * @li "default" - A content of the frame
7794 * Default text parts of the frame widget that you can use for are:
7795 * @li "elm.text" - Label of the frame
7797 * For a detailed example see the @ref tutorial_frame.
7802 * @brief Add a new frame to the parent
7804 * @param parent The parent object
7805 * @return The new object or NULL if it cannot be created
7807 EAPI Evas_Object *elm_frame_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7809 * @brief Set the frame label
7811 * @param obj The frame object
7812 * @param label The label of this frame object
7814 * @deprecated use elm_object_text_set() instead.
7816 EINA_DEPRECATED EAPI void elm_frame_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
7818 * @brief Get the frame label
7820 * @param obj The frame object
7822 * @return The label of this frame objet or NULL if unable to get frame
7824 * @deprecated use elm_object_text_get() instead.
7826 EINA_DEPRECATED EAPI const char *elm_frame_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7828 * @brief Set the content of the frame widget
7830 * Once the content object is set, a previously set one will be deleted.
7831 * If you want to keep that old content object, use the
7832 * elm_frame_content_unset() function.
7834 * @param obj The frame object
7835 * @param content The content will be filled in this frame object
7837 * @deprecated use elm_object_content_set() instead.
7839 EINA_DEPRECATED EAPI void elm_frame_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
7841 * @brief Get the content of the frame widget
7843 * Return the content object which is set for this widget
7845 * @param obj The frame object
7846 * @return The content that is being used
7848 * @deprecated use elm_object_content_get() instead.
7850 EINA_DEPRECATED EAPI Evas_Object *elm_frame_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7852 * @brief Unset the content of the frame widget
7854 * Unparent and return the content object which was set for this widget
7856 * @param obj The frame object
7857 * @return The content that was being used
7859 * @deprecated use elm_object_content_unset() instead.
7861 EINA_DEPRECATED EAPI Evas_Object *elm_frame_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
7867 * @defgroup Table Table
7869 * A container widget to arrange other widgets in a table where items can
7870 * also span multiple columns or rows - even overlap (and then be raised or
7871 * lowered accordingly to adjust stacking if they do overlap).
7873 * For a Table widget the row/column count is not fixed.
7874 * The table widget adjusts itself when subobjects are added to it dynamically.
7876 * The followin are examples of how to use a table:
7877 * @li @ref tutorial_table_01
7878 * @li @ref tutorial_table_02
7883 * @brief Add a new table to the parent
7885 * @param parent The parent object
7886 * @return The new object or NULL if it cannot be created
7888 EAPI Evas_Object *elm_table_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7890 * @brief Set the homogeneous layout in the table
7892 * @param obj The layout object
7893 * @param homogeneous A boolean to set if the layout is homogeneous in the
7894 * table (EINA_TRUE = homogeneous, EINA_FALSE = no homogeneous)
7896 EAPI void elm_table_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
7898 * @brief Get the current table homogeneous mode.
7900 * @param obj The table object
7901 * @return A boolean to indicating if the layout is homogeneous in the table
7902 * (EINA_TRUE = homogeneous, EINA_FALSE = no homogeneous)
7904 EAPI Eina_Bool elm_table_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7906 * @brief Set padding between cells.
7908 * @param obj The layout object.
7909 * @param horizontal set the horizontal padding.
7910 * @param vertical set the vertical padding.
7912 * Default value is 0.
7914 EAPI void elm_table_padding_set(Evas_Object *obj, Evas_Coord horizontal, Evas_Coord vertical) EINA_ARG_NONNULL(1);
7916 * @brief Get padding between cells.
7918 * @param obj The layout object.
7919 * @param horizontal set the horizontal padding.
7920 * @param vertical set the vertical padding.
7922 EAPI void elm_table_padding_get(const Evas_Object *obj, Evas_Coord *horizontal, Evas_Coord *vertical) EINA_ARG_NONNULL(1);
7924 * @brief Add a subobject on the table with the coordinates passed
7926 * @param obj The table object
7927 * @param subobj The subobject to be added to the table
7928 * @param x Row number
7929 * @param y Column number
7933 * @note All positioning inside the table is relative to rows and columns, so
7934 * a value of 0 for x and y, means the top left cell of the table, and a
7935 * value of 1 for w and h means @p subobj only takes that 1 cell.
7937 EAPI void elm_table_pack(Evas_Object *obj, Evas_Object *subobj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
7939 * @brief Remove child from table.
7941 * @param obj The table object
7942 * @param subobj The subobject
7944 EAPI void elm_table_unpack(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
7946 * @brief Faster way to remove all child objects from a table object.
7948 * @param obj The table object
7949 * @param clear If true, will delete children, else just remove from table.
7951 EAPI void elm_table_clear(Evas_Object *obj, Eina_Bool clear) EINA_ARG_NONNULL(1);
7953 * @brief Set the packing location of an existing child of the table
7955 * @param subobj The subobject to be modified in the table
7956 * @param x Row number
7957 * @param y Column number
7961 * Modifies the position of an object already in the table.
7963 * @note All positioning inside the table is relative to rows and columns, so
7964 * a value of 0 for x and y, means the top left cell of the table, and a
7965 * value of 1 for w and h means @p subobj only takes that 1 cell.
7967 EAPI void elm_table_pack_set(Evas_Object *subobj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
7969 * @brief Get the packing location of an existing child of the table
7971 * @param subobj The subobject to be modified in the table
7972 * @param x Row number
7973 * @param y Column number
7977 * @see elm_table_pack_set()
7979 EAPI void elm_table_pack_get(Evas_Object *subobj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
7984 /* TEMPORARY: DOCS WILL BE FILLED IN WITH CNP/SED */
7985 typedef struct Elm_Gen_Item Elm_Gen_Item;
7986 typedef struct _Elm_Gen_Item_Class Elm_Gen_Item_Class;
7987 typedef struct _Elm_Gen_Item_Class_Func Elm_Gen_Item_Class_Func; /**< Class functions for gen item classes. */
7988 typedef char *(*Elm_Gen_Item_Label_Get_Cb) (void *data, Evas_Object *obj, const char *part); /**< Label fetching class function for gen item classes. */
7989 typedef Evas_Object *(*Elm_Gen_Item_Content_Get_Cb) (void *data, Evas_Object *obj, const char *part); /**< Content(swallowed object) fetching class function for gen item classes. */
7990 typedef Eina_Bool (*Elm_Gen_Item_State_Get_Cb) (void *data, Evas_Object *obj, const char *part); /**< State fetching class function for gen item classes. */
7991 typedef void (*Elm_Gen_Item_Del_Cb) (void *data, Evas_Object *obj); /**< Deletion class function for gen item classes. */
7992 struct _Elm_Gen_Item_Class
7994 const char *item_style;
7995 struct _Elm_Gen_Item_Class_Func
7997 Elm_Gen_Item_Label_Get_Cb label_get;
7998 Elm_Gen_Item_Content_Get_Cb content_get;
7999 Elm_Gen_Item_State_Get_Cb state_get;
8000 Elm_Gen_Item_Del_Cb del;
8003 EAPI void elm_gen_clear(Evas_Object *obj);
8004 EAPI void elm_gen_item_selected_set(Elm_Gen_Item *it, Eina_Bool selected);
8005 EAPI Eina_Bool elm_gen_item_selected_get(const Elm_Gen_Item *it);
8006 EAPI void elm_gen_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select);
8007 EAPI Eina_Bool elm_gen_always_select_mode_get(const Evas_Object *obj);
8008 EAPI void elm_gen_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select);
8009 EAPI Eina_Bool elm_gen_no_select_mode_get(const Evas_Object *obj);
8010 EAPI void elm_gen_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce);
8011 EAPI void elm_gen_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce);
8012 EAPI void elm_gen_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel);
8013 EAPI void elm_gen_page_relative_get(const Evas_Object *obj, double *h_pagerel, double *v_pagerel);
8014 EAPI void elm_gen_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize);
8015 EAPI void elm_gen_current_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber);
8016 EAPI void elm_gen_last_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber);
8017 EAPI void elm_gen_page_show(const Evas_Object *obj, int h_pagenumber, int v_pagenumber);
8018 EAPI void elm_gen_page_bring_in(const Evas_Object *obj, int h_pagenumber, int v_pagenumber);
8019 EAPI Elm_Gen_Item *elm_gen_first_item_get(const Evas_Object *obj);
8020 EAPI Elm_Gen_Item *elm_gen_last_item_get(const Evas_Object *obj);
8021 EAPI Elm_Gen_Item *elm_gen_item_next_get(const Elm_Gen_Item *it);
8022 EAPI Elm_Gen_Item *elm_gen_item_prev_get(const Elm_Gen_Item *it);
8023 EAPI Evas_Object *elm_gen_item_widget_get(const Elm_Gen_Item *it);
8026 * @defgroup Gengrid Gengrid (Generic grid)
8028 * This widget aims to position objects in a grid layout while
8029 * actually creating and rendering only the visible ones, using the
8030 * same idea as the @ref Genlist "genlist": the user defines a @b
8031 * class for each item, specifying functions that will be called at
8032 * object creation, deletion, etc. When those items are selected by
8033 * the user, a callback function is issued. Users may interact with
8034 * a gengrid via the mouse (by clicking on items to select them and
8035 * clicking on the grid's viewport and swiping to pan the whole
8036 * view) or via the keyboard, navigating through item with the
8039 * @section Gengrid_Layouts Gengrid layouts
8041 * Gengrid may layout its items in one of two possible layouts:
8045 * When in "horizontal mode", items will be placed in @b columns,
8046 * from top to bottom and, when the space for a column is filled,
8047 * another one is started on the right, thus expanding the grid
8048 * horizontally, making for horizontal scrolling. When in "vertical
8049 * mode" , though, items will be placed in @b rows, from left to
8050 * right and, when the space for a row is filled, another one is
8051 * started below, thus expanding the grid vertically (and making
8052 * for vertical scrolling).
8054 * @section Gengrid_Items Gengrid items
8056 * An item in a gengrid can have 0 or more text labels (they can be
8057 * regular text or textblock Evas objects - that's up to the style
8058 * to determine), 0 or more icons (which are simply objects
8059 * swallowed into the gengrid item's theming Edje object) and 0 or
8060 * more <b>boolean states</b>, which have the behavior left to the
8061 * user to define. The Edje part names for each of these properties
8062 * will be looked up, in the theme file for the gengrid, under the
8063 * Edje (string) data items named @c "labels", @c "icons" and @c
8064 * "states", respectively. For each of those properties, if more
8065 * than one part is provided, they must have names listed separated
8066 * by spaces in the data fields. For the default gengrid item
8067 * theme, we have @b one label part (@c "elm.text"), @b two icon
8068 * parts (@c "elm.swalllow.icon" and @c "elm.swallow.end") and @b
8071 * A gengrid item may be at one of several styles. Elementary
8072 * provides one by default - "default", but this can be extended by
8073 * system or application custom themes/overlays/extensions (see
8074 * @ref Theme "themes" for more details).
8076 * @section Gengrid_Item_Class Gengrid item classes
8078 * In order to have the ability to add and delete items on the fly,
8079 * gengrid implements a class (callback) system where the
8080 * application provides a structure with information about that
8081 * type of item (gengrid may contain multiple different items with
8082 * different classes, states and styles). Gengrid will call the
8083 * functions in this struct (methods) when an item is "realized"
8084 * (i.e., created dynamically, while the user is scrolling the
8085 * grid). All objects will simply be deleted when no longer needed
8086 * with evas_object_del(). The #Elm_GenGrid_Item_Class structure
8087 * contains the following members:
8088 * - @c item_style - This is a constant string and simply defines
8089 * the name of the item style. It @b must be specified and the
8090 * default should be @c "default".
8091 * - @c func.label_get - This function is called when an item
8092 * object is actually created. The @c data parameter will point to
8093 * the same data passed to elm_gengrid_item_append() and related
8094 * item creation functions. The @c obj parameter is the gengrid
8095 * object itself, while the @c part one is the name string of one
8096 * of the existing text parts in the Edje group implementing the
8097 * item's theme. This function @b must return a strdup'()ed string,
8098 * as the caller will free() it when done. See
8099 * #Elm_Gengrid_Item_Label_Get_Cb.
8100 * - @c func.content_get - This function is called when an item object
8101 * is actually created. The @c data parameter will point to the
8102 * same data passed to elm_gengrid_item_append() and related item
8103 * creation functions. The @c obj parameter is the gengrid object
8104 * itself, while the @c part one is the name string of one of the
8105 * existing (content) swallow parts in the Edje group implementing the
8106 * item's theme. It must return @c NULL, when no content is desired,
8107 * or a valid object handle, otherwise. The object will be deleted
8108 * by the gengrid on its deletion or when the item is "unrealized".
8109 * See #Elm_Gengrid_Item_Content_Get_Cb.
8110 * - @c func.state_get - This function is called when an item
8111 * object is actually created. The @c data parameter will point to
8112 * the same data passed to elm_gengrid_item_append() and related
8113 * item creation functions. The @c obj parameter is the gengrid
8114 * object itself, while the @c part one is the name string of one
8115 * of the state parts in the Edje group implementing the item's
8116 * theme. Return @c EINA_FALSE for false/off or @c EINA_TRUE for
8117 * true/on. Gengrids will emit a signal to its theming Edje object
8118 * with @c "elm,state,XXX,active" and @c "elm" as "emission" and
8119 * "source" arguments, respectively, when the state is true (the
8120 * default is false), where @c XXX is the name of the (state) part.
8121 * See #Elm_Gengrid_Item_State_Get_Cb.
8122 * - @c func.del - This is called when elm_gengrid_item_del() is
8123 * called on an item or elm_gengrid_clear() is called on the
8124 * gengrid. This is intended for use when gengrid items are
8125 * deleted, so any data attached to the item (e.g. its data
8126 * parameter on creation) can be deleted. See #Elm_Gengrid_Item_Del_Cb.
8128 * @section Gengrid_Usage_Hints Usage hints
8130 * If the user wants to have multiple items selected at the same
8131 * time, elm_gengrid_multi_select_set() will permit it. If the
8132 * gengrid is single-selection only (the default), then
8133 * elm_gengrid_select_item_get() will return the selected item or
8134 * @c NULL, if none is selected. If the gengrid is under
8135 * multi-selection, then elm_gengrid_selected_items_get() will
8136 * return a list (that is only valid as long as no items are
8137 * modified (added, deleted, selected or unselected) of child items
8140 * If an item changes (internal (boolean) state, label or content
8141 * changes), then use elm_gengrid_item_update() to have gengrid
8142 * update the item with the new state. A gengrid will re-"realize"
8143 * the item, thus calling the functions in the
8144 * #Elm_Gengrid_Item_Class set for that item.
8146 * To programmatically (un)select an item, use
8147 * elm_gengrid_item_selected_set(). To get its selected state use
8148 * elm_gengrid_item_selected_get(). To make an item disabled
8149 * (unable to be selected and appear differently) use
8150 * elm_gengrid_item_disabled_set() to set this and
8151 * elm_gengrid_item_disabled_get() to get the disabled state.
8153 * Grid cells will only have their selection smart callbacks called
8154 * when firstly getting selected. Any further clicks will do
8155 * nothing, unless you enable the "always select mode", with
8156 * elm_gengrid_always_select_mode_set(), thus making every click to
8157 * issue selection callbacks. elm_gengrid_no_select_mode_set() will
8158 * turn off the ability to select items entirely in the widget and
8159 * they will neither appear selected nor call the selection smart
8162 * Remember that you can create new styles and add your own theme
8163 * augmentation per application with elm_theme_extension_add(). If
8164 * you absolutely must have a specific style that overrides any
8165 * theme the user or system sets up you can use
8166 * elm_theme_overlay_add() to add such a file.
8168 * @section Gengrid_Smart_Events Gengrid smart events
8170 * Smart events that you can add callbacks for are:
8171 * - @c "activated" - The user has double-clicked or pressed
8172 * (enter|return|spacebar) on an item. The @c event_info parameter
8173 * is the gengrid item that was activated.
8174 * - @c "clicked,double" - The user has double-clicked an item.
8175 * The @c event_info parameter is the gengrid item that was double-clicked.
8176 * - @c "longpressed" - This is called when the item is pressed for a certain
8177 * amount of time. By default it's 1 second.
8178 * - @c "selected" - The user has made an item selected. The
8179 * @c event_info parameter is the gengrid item that was selected.
8180 * - @c "unselected" - The user has made an item unselected. The
8181 * @c event_info parameter is the gengrid item that was unselected.
8182 * - @c "realized" - This is called when the item in the gengrid
8183 * has its implementing Evas object instantiated, de facto. @c
8184 * event_info is the gengrid item that was created. The object
8185 * may be deleted at any time, so it is highly advised to the
8186 * caller @b not to use the object pointer returned from
8187 * elm_gengrid_item_object_get(), because it may point to freed
8189 * - @c "unrealized" - This is called when the implementing Evas
8190 * object for this item is deleted. @c event_info is the gengrid
8191 * item that was deleted.
8192 * - @c "changed" - Called when an item is added, removed, resized
8193 * or moved and when the gengrid is resized or gets "horizontal"
8195 * - @c "scroll,anim,start" - This is called when scrolling animation has
8197 * - @c "scroll,anim,stop" - This is called when scrolling animation has
8199 * - @c "drag,start,up" - Called when the item in the gengrid has
8200 * been dragged (not scrolled) up.
8201 * - @c "drag,start,down" - Called when the item in the gengrid has
8202 * been dragged (not scrolled) down.
8203 * - @c "drag,start,left" - Called when the item in the gengrid has
8204 * been dragged (not scrolled) left.
8205 * - @c "drag,start,right" - Called when the item in the gengrid has
8206 * been dragged (not scrolled) right.
8207 * - @c "drag,stop" - Called when the item in the gengrid has
8208 * stopped being dragged.
8209 * - @c "drag" - Called when the item in the gengrid is being
8211 * - @c "scroll" - called when the content has been scrolled
8213 * - @c "scroll,drag,start" - called when dragging the content has
8215 * - @c "scroll,drag,stop" - called when dragging the content has
8217 * - @c "edge,top" - This is called when the gengrid is scrolled until
8219 * - @c "edge,bottom" - This is called when the gengrid is scrolled
8220 * until the bottom edge.
8221 * - @c "edge,left" - This is called when the gengrid is scrolled
8222 * until the left edge.
8223 * - @c "edge,right" - This is called when the gengrid is scrolled
8224 * until the right edge.
8226 * List of gengrid examples:
8227 * @li @ref gengrid_example
8231 * @addtogroup Gengrid
8235 typedef struct _Elm_Gengrid_Item_Class Elm_Gengrid_Item_Class; /**< Gengrid item class definition structs */
8236 #define Elm_Gengrid_Item_Class Elm_Gen_Item_Class
8237 typedef struct _Elm_Gengrid_Item Elm_Gengrid_Item; /**< Gengrid item handles */
8238 #define Elm_Gengrid_Item Elm_Gen_Item /**< Item of Elm_Genlist. Sub-type of Elm_Widget_Item */
8239 typedef struct _Elm_Gengrid_Item_Class_Func Elm_Gengrid_Item_Class_Func; /**< Class functions for gengrid item classes. */
8241 * Label fetching class function for Elm_Gen_Item_Class.
8242 * @param data The data passed in the item creation function
8243 * @param obj The base widget object
8244 * @param part The part name of the swallow
8245 * @return The allocated (NOT stringshared) string to set as the label
8247 typedef char *(*Elm_Gengrid_Item_Label_Get_Cb) (void *data, Evas_Object *obj, const char *part);
8249 * Content (swallowed object) 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 content object to swallow
8255 typedef Evas_Object *(*Elm_Gengrid_Item_Content_Get_Cb) (void *data, Evas_Object *obj, const char *part);
8257 * State 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 hell if I know
8263 typedef Eina_Bool (*Elm_Gengrid_Item_State_Get_Cb) (void *data, Evas_Object *obj, const char *part);
8265 * Deletion 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
8269 typedef void (*Elm_Gengrid_Item_Del_Cb) (void *data, Evas_Object *obj);
8272 * @struct _Elm_Gengrid_Item_Class
8274 * Gengrid item class definition. See @ref Gengrid_Item_Class for
8277 struct _Elm_Gengrid_Item_Class
8279 const char *item_style;
8280 struct _Elm_Gengrid_Item_Class_Func
8282 Elm_Gengrid_Item_Label_Get_Cb label_get;
8283 Elm_Gengrid_Item_Content_Get_Cb content_get;
8284 Elm_Gengrid_Item_State_Get_Cb state_get;
8285 Elm_Gengrid_Item_Del_Cb del;
8287 }; /**< #Elm_Gengrid_Item_Class member definitions */
8288 #define Elm_Gengrid_Item_Class_Func Elm_Gen_Item_Class_Func
8290 * Add a new gengrid widget to the given parent Elementary
8291 * (container) object
8293 * @param parent The parent object
8294 * @return a new gengrid widget handle or @c NULL, on errors
8296 * This function inserts a new gengrid widget on the canvas.
8298 * @see elm_gengrid_item_size_set()
8299 * @see elm_gengrid_group_item_size_set()
8300 * @see elm_gengrid_horizontal_set()
8301 * @see elm_gengrid_item_append()
8302 * @see elm_gengrid_item_del()
8303 * @see elm_gengrid_clear()
8307 EAPI Evas_Object *elm_gengrid_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
8310 * Set the size for the items of a given gengrid widget
8312 * @param obj The gengrid object.
8313 * @param w The items' width.
8314 * @param h The items' height;
8316 * A gengrid, after creation, has still no information on the size
8317 * to give to each of its cells. So, you most probably will end up
8318 * with squares one @ref Fingers "finger" wide, the default
8319 * size. Use this function to force a custom size for you items,
8320 * making them as big as you wish.
8322 * @see elm_gengrid_item_size_get()
8326 EAPI void elm_gengrid_item_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
8329 * Get the size set for the items of a given gengrid widget
8331 * @param obj The gengrid object.
8332 * @param w Pointer to a variable where to store the items' width.
8333 * @param h Pointer to a variable where to store the items' height.
8335 * @note Use @c NULL pointers on the size values you're not
8336 * interested in: they'll be ignored by the function.
8338 * @see elm_gengrid_item_size_get() for more details
8342 EAPI void elm_gengrid_item_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
8345 * Set the size for the group items of a given gengrid widget
8347 * @param obj The gengrid object.
8348 * @param w The group items' width.
8349 * @param h The group items' height;
8351 * A gengrid, after creation, has still no information on the size
8352 * to give to each of its cells. So, you most probably will end up
8353 * with squares one @ref Fingers "finger" wide, the default
8354 * size. Use this function to force a custom size for you group items,
8355 * making them as big as you wish.
8357 * @see elm_gengrid_group_item_size_get()
8361 EAPI void elm_gengrid_group_item_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
8364 * Get the size set for the group items of a given gengrid widget
8366 * @param obj The gengrid object.
8367 * @param w Pointer to a variable where to store the group items' width.
8368 * @param h Pointer to a variable where to store the group items' height.
8370 * @note Use @c NULL pointers on the size values you're not
8371 * interested in: they'll be ignored by the function.
8373 * @see elm_gengrid_group_item_size_get() for more details
8377 EAPI void elm_gengrid_group_item_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
8380 * Set the items grid's alignment within a given gengrid widget
8382 * @param obj The gengrid object.
8383 * @param align_x Alignment in the horizontal axis (0 <= align_x <= 1).
8384 * @param align_y Alignment in the vertical axis (0 <= align_y <= 1).
8386 * This sets the alignment of the whole grid of items of a gengrid
8387 * within its given viewport. By default, those values are both
8388 * 0.5, meaning that the gengrid will have its items grid placed
8389 * exactly in the middle of its viewport.
8391 * @note If given alignment values are out of the cited ranges,
8392 * they'll be changed to the nearest boundary values on the valid
8395 * @see elm_gengrid_align_get()
8399 EAPI void elm_gengrid_align_set(Evas_Object *obj, double align_x, double align_y) EINA_ARG_NONNULL(1);
8402 * Get the items grid's alignment values within a given gengrid
8405 * @param obj The gengrid object.
8406 * @param align_x Pointer to a variable where to store the
8407 * horizontal alignment.
8408 * @param align_y Pointer to a variable where to store the vertical
8411 * @note Use @c NULL pointers on the alignment values you're not
8412 * interested in: they'll be ignored by the function.
8414 * @see elm_gengrid_align_set() for more details
8418 EAPI void elm_gengrid_align_get(const Evas_Object *obj, double *align_x, double *align_y) EINA_ARG_NONNULL(1);
8421 * Set whether a given gengrid widget is or not able have items
8424 * @param obj The gengrid object
8425 * @param reorder_mode Use @c EINA_TRUE to turn reoderding on,
8426 * @c EINA_FALSE to turn it off
8428 * If a gengrid is set to allow reordering, a click held for more
8429 * than 0.5 over a given item will highlight it specially,
8430 * signalling the gengrid has entered the reordering state. From
8431 * that time on, the user will be able to, while still holding the
8432 * mouse button down, move the item freely in the gengrid's
8433 * viewport, replacing to said item to the locations it goes to.
8434 * The replacements will be animated and, whenever the user
8435 * releases the mouse button, the item being replaced gets a new
8436 * definitive place in the grid.
8438 * @see elm_gengrid_reorder_mode_get()
8442 EAPI void elm_gengrid_reorder_mode_set(Evas_Object *obj, Eina_Bool reorder_mode) EINA_ARG_NONNULL(1);
8445 * Get whether a given gengrid widget is or not able have items
8448 * @param obj The gengrid object
8449 * @return @c EINA_TRUE, if reoderding is on, @c EINA_FALSE if it's
8452 * @see elm_gengrid_reorder_mode_set() for more details
8456 EAPI Eina_Bool elm_gengrid_reorder_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8459 * Append a new item in a given gengrid widget.
8461 * @param obj The gengrid object.
8462 * @param gic The item class for the item.
8463 * @param data The item data.
8464 * @param func Convenience function called when the item is
8466 * @param func_data Data to be passed to @p func.
8467 * @return A handle to the item added or @c NULL, on errors.
8469 * This adds an item to the beginning of the gengrid.
8471 * @see elm_gengrid_item_prepend()
8472 * @see elm_gengrid_item_insert_before()
8473 * @see elm_gengrid_item_insert_after()
8474 * @see elm_gengrid_item_del()
8478 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);
8481 * Prepend a new item in a given gengrid widget.
8483 * @param obj The gengrid object.
8484 * @param gic The item class for the item.
8485 * @param data The item data.
8486 * @param func Convenience function called when the item is
8488 * @param func_data Data to be passed to @p func.
8489 * @return A handle to the item added or @c NULL, on errors.
8491 * This adds an item to the end of the gengrid.
8493 * @see elm_gengrid_item_append()
8494 * @see elm_gengrid_item_insert_before()
8495 * @see elm_gengrid_item_insert_after()
8496 * @see elm_gengrid_item_del()
8500 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);
8503 * Insert an item before another in a gengrid widget
8505 * @param obj The gengrid object.
8506 * @param gic The item class for the item.
8507 * @param data The item data.
8508 * @param relative The item to place this new one before.
8509 * @param func Convenience function called when the item is
8511 * @param func_data Data to be passed to @p func.
8512 * @return A handle to the item added or @c NULL, on errors.
8514 * This inserts an item before another in the gengrid.
8516 * @see elm_gengrid_item_append()
8517 * @see elm_gengrid_item_prepend()
8518 * @see elm_gengrid_item_insert_after()
8519 * @see elm_gengrid_item_del()
8523 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);
8526 * Insert an item after another in a gengrid widget
8528 * @param obj The gengrid object.
8529 * @param gic The item class for the item.
8530 * @param data The item data.
8531 * @param relative The item to place this new one after.
8532 * @param func Convenience function called when the item is
8534 * @param func_data Data to be passed to @p func.
8535 * @return A handle to the item added or @c NULL, on errors.
8537 * This inserts an item after another in the gengrid.
8539 * @see elm_gengrid_item_append()
8540 * @see elm_gengrid_item_prepend()
8541 * @see elm_gengrid_item_insert_after()
8542 * @see elm_gengrid_item_del()
8546 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);
8549 * Insert an item in a gengrid widget using a user-defined sort function.
8551 * @param obj The gengrid object.
8552 * @param gic The item class for the item.
8553 * @param data The item data.
8554 * @param comp User defined comparison function that defines the sort order based on
8555 * Elm_Gen_Item and its data param.
8556 * @param func Convenience function called when the item is selected.
8557 * @param func_data Data to be passed to @p func.
8558 * @return A handle to the item added or @c NULL, on errors.
8560 * This inserts an item in the gengrid based on user defined comparison function.
8562 * @see elm_gengrid_item_append()
8563 * @see elm_gengrid_item_prepend()
8564 * @see elm_gengrid_item_insert_after()
8565 * @see elm_gengrid_item_del()
8566 * @see elm_gengrid_item_direct_sorted_insert()
8570 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);
8573 * Insert an item in a gengrid widget using a user-defined sort function.
8575 * @param obj The gengrid object.
8576 * @param gic The item class for the item.
8577 * @param data The item data.
8578 * @param comp User defined comparison function that defines the sort order based on
8580 * @param func Convenience function called when the item is selected.
8581 * @param func_data Data to be passed to @p func.
8582 * @return A handle to the item added or @c NULL, on errors.
8584 * This inserts an item in the gengrid based on user defined comparison function.
8586 * @see elm_gengrid_item_append()
8587 * @see elm_gengrid_item_prepend()
8588 * @see elm_gengrid_item_insert_after()
8589 * @see elm_gengrid_item_del()
8590 * @see elm_gengrid_item_sorted_insert()
8594 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);
8597 * Set whether items on a given gengrid widget are to get their
8598 * selection callbacks issued for @b every subsequent selection
8599 * click on them or just for the first click.
8601 * @param obj The gengrid object
8602 * @param always_select @c EINA_TRUE to make items "always
8603 * selected", @c EINA_FALSE, otherwise
8605 * By default, grid items will only call their selection callback
8606 * function when firstly getting selected, any subsequent further
8607 * clicks will do nothing. With this call, you make those
8608 * subsequent clicks also to issue the selection callbacks.
8610 * @note <b>Double clicks</b> will @b always be reported on items.
8612 * @see elm_gengrid_always_select_mode_get()
8616 EINA_DEPRECATED EAPI void elm_gengrid_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
8619 * Get whether items on a given gengrid widget have their selection
8620 * callbacks issued for @b every subsequent selection click on them
8621 * or just for the first click.
8623 * @param obj The gengrid object.
8624 * @return @c EINA_TRUE if the gengrid items are "always selected",
8625 * @c EINA_FALSE, otherwise
8627 * @see elm_gengrid_always_select_mode_set() for more details
8631 EINA_DEPRECATED EAPI Eina_Bool elm_gengrid_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8634 * Set whether items on a given gengrid widget can be selected or not.
8636 * @param obj The gengrid object
8637 * @param no_select @c EINA_TRUE to make items selectable,
8638 * @c EINA_FALSE otherwise
8640 * This will make items in @p obj selectable or not. In the latter
8641 * case, any user interaction on the gengrid items will neither make
8642 * them appear selected nor them call their selection callback
8645 * @see elm_gengrid_no_select_mode_get()
8649 EINA_DEPRECATED EAPI void elm_gengrid_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
8652 * Get whether items on a given gengrid widget can be selected or
8655 * @param obj The gengrid object
8656 * @return @c EINA_TRUE, if items are selectable, @c EINA_FALSE
8659 * @see elm_gengrid_no_select_mode_set() for more details
8663 EINA_DEPRECATED EAPI Eina_Bool elm_gengrid_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8666 * Enable or disable multi-selection in a given gengrid widget
8668 * @param obj The gengrid object.
8669 * @param multi @c EINA_TRUE, to enable multi-selection,
8670 * @c EINA_FALSE to disable it.
8672 * Multi-selection is the ability to have @b more than one
8673 * item selected, on a given gengrid, simultaneously. When it is
8674 * enabled, a sequence of clicks on different items will make them
8675 * all selected, progressively. A click on an already selected item
8676 * will unselect it. If interacting via the keyboard,
8677 * multi-selection is enabled while holding the "Shift" key.
8679 * @note By default, multi-selection is @b disabled on gengrids
8681 * @see elm_gengrid_multi_select_get()
8685 EAPI void elm_gengrid_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
8688 * Get whether multi-selection is enabled or disabled for a given
8691 * @param obj The gengrid object.
8692 * @return @c EINA_TRUE, if multi-selection is enabled, @c
8693 * EINA_FALSE otherwise
8695 * @see elm_gengrid_multi_select_set() for more details
8699 EAPI Eina_Bool elm_gengrid_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8702 * Enable or disable bouncing effect for a given gengrid widget
8704 * @param obj The gengrid object
8705 * @param h_bounce @c EINA_TRUE, to enable @b horizontal bouncing,
8706 * @c EINA_FALSE to disable it
8707 * @param v_bounce @c EINA_TRUE, to enable @b vertical bouncing,
8708 * @c EINA_FALSE to disable it
8710 * The bouncing effect occurs whenever one reaches the gengrid's
8711 * edge's while panning it -- it will scroll past its limits a
8712 * little bit and return to the edge again, in a animated for,
8715 * @note By default, gengrids have bouncing enabled on both axis
8717 * @see elm_gengrid_bounce_get()
8721 EINA_DEPRECATED EAPI void elm_gengrid_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
8724 * Get whether bouncing effects are enabled or disabled, for a
8725 * given gengrid widget, on each axis
8727 * @param obj The gengrid object
8728 * @param h_bounce Pointer to a variable where to store the
8729 * horizontal bouncing flag.
8730 * @param v_bounce Pointer to a variable where to store the
8731 * vertical bouncing flag.
8733 * @see elm_gengrid_bounce_set() for more details
8737 EINA_DEPRECATED EAPI void elm_gengrid_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
8740 * Set a given gengrid widget's scrolling page size, relative to
8741 * its viewport size.
8743 * @param obj The gengrid object
8744 * @param h_pagerel The horizontal page (relative) size
8745 * @param v_pagerel The vertical page (relative) size
8747 * The gengrid's scroller is capable of binding scrolling by the
8748 * user to "pages". It means that, while scrolling and, specially
8749 * after releasing the mouse button, the grid will @b snap to the
8750 * nearest displaying page's area. When page sizes are set, the
8751 * grid's continuous content area is split into (equal) page sized
8754 * This function sets the size of a page <b>relatively to the
8755 * viewport dimensions</b> of the gengrid, for each axis. A value
8756 * @c 1.0 means "the exact viewport's size", in that axis, while @c
8757 * 0.0 turns paging off in that axis. Likewise, @c 0.5 means "half
8758 * a viewport". Sane usable values are, than, between @c 0.0 and @c
8759 * 1.0. Values beyond those will make it behave behave
8760 * inconsistently. If you only want one axis to snap to pages, use
8761 * the value @c 0.0 for the other one.
8763 * There is a function setting page size values in @b absolute
8764 * values, too -- elm_gengrid_page_size_set(). Naturally, its use
8765 * is mutually exclusive to this one.
8767 * @see elm_gengrid_page_relative_get()
8771 EINA_DEPRECATED EAPI void elm_gengrid_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel) EINA_ARG_NONNULL(1);
8774 * Get a given gengrid widget's scrolling page size, relative to
8775 * its viewport size.
8777 * @param obj The gengrid object
8778 * @param h_pagerel Pointer to a variable where to store the
8779 * horizontal page (relative) size
8780 * @param v_pagerel Pointer to a variable where to store the
8781 * vertical page (relative) size
8783 * @see elm_gengrid_page_relative_set() for more details
8787 EINA_DEPRECATED EAPI void elm_gengrid_page_relative_get(const Evas_Object *obj, double *h_pagerel, double *v_pagerel) EINA_ARG_NONNULL(1);
8790 * Set a given gengrid widget's scrolling page size
8792 * @param obj The gengrid object
8793 * @param h_pagerel The horizontal page size, in pixels
8794 * @param v_pagerel The vertical page size, in pixels
8796 * The gengrid's scroller is capable of binding scrolling by the
8797 * user to "pages". It means that, while scrolling and, specially
8798 * after releasing the mouse button, the grid will @b snap to the
8799 * nearest displaying page's area. When page sizes are set, the
8800 * grid's continuous content area is split into (equal) page sized
8803 * This function sets the size of a page of the gengrid, in pixels,
8804 * for each axis. Sane usable values are, between @c 0 and the
8805 * dimensions of @p obj, for each axis. Values beyond those will
8806 * make it behave behave inconsistently. If you only want one axis
8807 * to snap to pages, use the value @c 0 for the other one.
8809 * There is a function setting page size values in @b relative
8810 * values, too -- elm_gengrid_page_relative_set(). Naturally, its
8811 * use is mutually exclusive to this one.
8815 EINA_DEPRECATED EAPI void elm_gengrid_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize) EINA_ARG_NONNULL(1);
8818 * @brief Get gengrid current page number.
8820 * @param obj The gengrid object
8821 * @param h_pagenumber The horizontal page number
8822 * @param v_pagenumber The vertical page number
8824 * The page number starts from 0. 0 is the first page.
8825 * Current page means the page which meet the top-left of the viewport.
8826 * If there are two or more pages in the viewport, it returns the number of page
8827 * which meet the top-left of the viewport.
8829 * @see elm_gengrid_last_page_get()
8830 * @see elm_gengrid_page_show()
8831 * @see elm_gengrid_page_brint_in()
8833 EINA_DEPRECATED EAPI void elm_gengrid_current_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber) EINA_ARG_NONNULL(1);
8836 * @brief Get scroll last page number.
8838 * @param obj The gengrid object
8839 * @param h_pagenumber The horizontal page number
8840 * @param v_pagenumber The vertical page number
8842 * The page number starts from 0. 0 is the first page.
8843 * This returns the last page number among the pages.
8845 * @see elm_gengrid_current_page_get()
8846 * @see elm_gengrid_page_show()
8847 * @see elm_gengrid_page_brint_in()
8849 EINA_DEPRECATED EAPI void elm_gengrid_last_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber) EINA_ARG_NONNULL(1);
8852 * Show a specific virtual region within the gengrid content object by page number.
8854 * @param obj The gengrid object
8855 * @param h_pagenumber The horizontal page number
8856 * @param v_pagenumber The vertical page number
8858 * 0, 0 of the indicated page is located at the top-left of the viewport.
8859 * This will jump to the page directly without animation.
8864 * sc = elm_gengrid_add(win);
8865 * elm_gengrid_content_set(sc, content);
8866 * elm_gengrid_page_relative_set(sc, 1, 0);
8867 * elm_gengrid_current_page_get(sc, &h_page, &v_page);
8868 * elm_gengrid_page_show(sc, h_page + 1, v_page);
8871 * @see elm_gengrid_page_bring_in()
8873 EINA_DEPRECATED EAPI void elm_gengrid_page_show(const Evas_Object *obj, int h_pagenumber, int v_pagenumber) EINA_ARG_NONNULL(1);
8876 * Show a specific virtual region within the gengrid content object by page number.
8878 * @param obj The gengrid object
8879 * @param h_pagenumber The horizontal page number
8880 * @param v_pagenumber The vertical page number
8882 * 0, 0 of the indicated page is located at the top-left of the viewport.
8883 * This will slide to the page with animation.
8888 * sc = elm_gengrid_add(win);
8889 * elm_gengrid_content_set(sc, content);
8890 * elm_gengrid_page_relative_set(sc, 1, 0);
8891 * elm_gengrid_last_page_get(sc, &h_page, &v_page);
8892 * elm_gengrid_page_bring_in(sc, h_page, v_page);
8895 * @see elm_gengrid_page_show()
8897 EINA_DEPRECATED EAPI void elm_gengrid_page_bring_in(const Evas_Object *obj, int h_pagenumber, int v_pagenumber) EINA_ARG_NONNULL(1);
8900 * Set the direction in which a given gengrid widget will expand while
8901 * placing its items.
8903 * @param obj The gengrid object.
8904 * @param setting @c EINA_TRUE to make the gengrid expand
8905 * horizontally, @c EINA_FALSE to expand vertically.
8907 * When in "horizontal mode" (@c EINA_TRUE), items will be placed
8908 * in @b columns, from top to bottom and, when the space for a
8909 * column is filled, another one is started on the right, thus
8910 * expanding the grid horizontally. When in "vertical mode"
8911 * (@c EINA_FALSE), though, items will be placed in @b rows, from left
8912 * to right and, when the space for a row is filled, another one is
8913 * started below, thus expanding the grid vertically.
8915 * @see elm_gengrid_horizontal_get()
8919 EAPI void elm_gengrid_horizontal_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
8922 * Get for what direction a given gengrid widget will expand while
8923 * placing its items.
8925 * @param obj The gengrid object.
8926 * @return @c EINA_TRUE, if @p obj is set to expand horizontally,
8927 * @c EINA_FALSE if it's set to expand vertically.
8929 * @see elm_gengrid_horizontal_set() for more detais
8933 EAPI Eina_Bool elm_gengrid_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8936 * Get the first item in a given gengrid widget
8938 * @param obj The gengrid object
8939 * @return The first item's handle or @c NULL, if there are no
8940 * items in @p obj (and on errors)
8942 * This returns the first item in the @p obj's internal list of
8945 * @see elm_gengrid_last_item_get()
8949 EINA_DEPRECATED EAPI Elm_Gengrid_Item *elm_gengrid_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8952 * Get the last item in a given gengrid widget
8954 * @param obj The gengrid object
8955 * @return The last item's handle or @c NULL, if there are no
8956 * items in @p obj (and on errors)
8958 * This returns the last item in the @p obj's internal list of
8961 * @see elm_gengrid_first_item_get()
8965 EINA_DEPRECATED EAPI Elm_Gengrid_Item *elm_gengrid_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8968 * Get the @b next item in a gengrid widget's internal list of items,
8969 * given a handle to one of those items.
8971 * @param item The gengrid item to fetch next from
8972 * @return The item after @p item, or @c NULL if there's none (and
8975 * This returns the item placed after the @p item, on the container
8978 * @see elm_gengrid_item_prev_get()
8982 EINA_DEPRECATED EAPI Elm_Gengrid_Item *elm_gengrid_item_next_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8985 * Get the @b previous item in a gengrid widget's internal list of items,
8986 * given a handle to one of those items.
8988 * @param item The gengrid item to fetch previous from
8989 * @return The item before @p item, or @c NULL if there's none (and
8992 * This returns the item placed before the @p item, on the container
8995 * @see elm_gengrid_item_next_get()
8999 EINA_DEPRECATED EAPI Elm_Gengrid_Item *elm_gengrid_item_prev_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9002 * Get the gengrid object's handle which contains a given gengrid
9005 * @param item The item to fetch the container from
9006 * @return The gengrid (parent) object
9008 * This returns the gengrid object itself that an item belongs to.
9012 EINA_DEPRECATED EAPI Evas_Object *elm_gengrid_item_gengrid_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9015 * Remove a gengrid item from its parent, deleting it.
9017 * @param item The item to be removed.
9018 * @return @c EINA_TRUE on success or @c EINA_FALSE, otherwise.
9020 * @see elm_gengrid_clear(), to remove all items in a gengrid at
9025 EAPI void elm_gengrid_item_del(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9028 * Update the contents of a given gengrid item
9030 * @param item The gengrid item
9032 * This updates an item by calling all the item class functions
9033 * again to get the contents, labels and states. Use this when the
9034 * original item data has changed and you want the changes to be
9039 EAPI void elm_gengrid_item_update(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9042 * Get the Gengrid Item class for the given Gengrid Item.
9044 * @param item The gengrid item
9046 * This returns the Gengrid_Item_Class for the given item. It can be used to examine
9047 * the function pointers and item_style.
9051 EAPI const Elm_Gengrid_Item_Class *elm_gengrid_item_item_class_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9054 * Get the Gengrid Item class for the given Gengrid Item.
9056 * This sets the Gengrid_Item_Class for the given item. It can be used to examine
9057 * the function pointers and item_style.
9059 * @param item The gengrid item
9060 * @param gic The gengrid item class describing the function pointers and the item style.
9064 EAPI void elm_gengrid_item_item_class_set(Elm_Gengrid_Item *item, const Elm_Gengrid_Item_Class *gic) EINA_ARG_NONNULL(1, 2);
9067 * Return the data associated to a given gengrid item
9069 * @param item The gengrid item.
9070 * @return the data associated with this item.
9072 * This returns the @c data value passed on the
9073 * elm_gengrid_item_append() and related item addition calls.
9075 * @see elm_gengrid_item_append()
9076 * @see elm_gengrid_item_data_set()
9080 EAPI void *elm_gengrid_item_data_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9083 * Set the data associated with a given gengrid item
9085 * @param item The gengrid item
9086 * @param data The data pointer to set on it
9088 * This @b overrides the @c data value passed on the
9089 * elm_gengrid_item_append() and related item addition calls. This
9090 * function @b won't call elm_gengrid_item_update() automatically,
9091 * so you'd issue it afterwards if you want to have the item
9092 * updated to reflect the new data.
9094 * @see elm_gengrid_item_data_get()
9095 * @see elm_gengrid_item_update()
9099 EAPI void elm_gengrid_item_data_set(Elm_Gengrid_Item *item, const void *data) EINA_ARG_NONNULL(1);
9102 * Get a given gengrid item's position, relative to the whole
9103 * gengrid's grid area.
9105 * @param item The Gengrid item.
9106 * @param x Pointer to variable to store the item's <b>row number</b>.
9107 * @param y Pointer to variable to store the item's <b>column number</b>.
9109 * This returns the "logical" position of the item within the
9110 * gengrid. For example, @c (0, 1) would stand for first row,
9115 EAPI void elm_gengrid_item_pos_get(const Elm_Gengrid_Item *item, unsigned int *x, unsigned int *y) EINA_ARG_NONNULL(1);
9118 * Set whether a given gengrid item is selected or not
9120 * @param item The gengrid item
9121 * @param selected Use @c EINA_TRUE, to make it selected, @c
9122 * EINA_FALSE to make it unselected
9124 * This sets the selected state of an item. If multi-selection is
9125 * not enabled on the containing gengrid and @p selected is @c
9126 * EINA_TRUE, any other previously selected items will get
9127 * unselected in favor of this new one.
9129 * @see elm_gengrid_item_selected_get()
9133 EINA_DEPRECATED EAPI void elm_gengrid_item_selected_set(Elm_Gengrid_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
9136 * Get whether a given gengrid item is selected or not
9138 * @param item The gengrid item
9139 * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
9141 * This API returns EINA_TRUE for all the items selected in multi-select mode as well.
9143 * @see elm_gengrid_item_selected_set() for more details
9147 EINA_DEPRECATED EAPI Eina_Bool elm_gengrid_item_selected_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9150 * Get the real Evas object created to implement the view of a
9151 * given gengrid item
9153 * @param item The gengrid item.
9154 * @return the Evas object implementing this item's view.
9156 * This returns the actual Evas object used to implement the
9157 * specified gengrid item's view. This may be @c NULL, as it may
9158 * not have been created or may have been deleted, at any time, by
9159 * the gengrid. <b>Do not modify this object</b> (move, resize,
9160 * show, hide, etc.), as the gengrid is controlling it. This
9161 * function is for querying, emitting custom signals or hooking
9162 * lower level callbacks for events on that object. Do not delete
9163 * this object under any circumstances.
9165 * @see elm_gengrid_item_data_get()
9169 EAPI const Evas_Object *elm_gengrid_item_object_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9172 * Show the portion of a gengrid's internal grid containing a given
9173 * item, @b immediately.
9175 * @param item The item to display
9177 * This causes gengrid to @b redraw its viewport's contents to the
9178 * region contining the given @p item item, if it is not fully
9181 * @see elm_gengrid_item_bring_in()
9185 EAPI void elm_gengrid_item_show(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9188 * Animatedly bring in, to the visible area of a gengrid, a given
9191 * @param item The gengrid item to display
9193 * This causes gengrid to jump to the given @p item and show
9194 * it (by scrolling), if it is not fully visible. This will use
9195 * animation to do so and take a period of time to complete.
9197 * @see elm_gengrid_item_show()
9201 EAPI void elm_gengrid_item_bring_in(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9204 * Set whether a given gengrid item is disabled or not.
9206 * @param item The gengrid item
9207 * @param disabled Use @c EINA_TRUE, true disable it, @c EINA_FALSE
9208 * to enable it back.
9210 * A disabled item cannot be selected or unselected. It will also
9211 * change its appearance, to signal the user it's disabled.
9213 * @see elm_gengrid_item_disabled_get()
9217 EAPI void elm_gengrid_item_disabled_set(Elm_Gengrid_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
9220 * Get whether a given gengrid item is disabled or not.
9222 * @param item The gengrid item
9223 * @return @c EINA_TRUE, if it's disabled, @c EINA_FALSE otherwise
9226 * @see elm_gengrid_item_disabled_set() for more details
9230 EAPI Eina_Bool elm_gengrid_item_disabled_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9233 * Set the text to be shown in a given gengrid item's tooltips.
9235 * @param item The gengrid item
9236 * @param text The text to set in the content
9238 * This call will setup the text to be used as tooltip to that item
9239 * (analogous to elm_object_tooltip_text_set(), but being item
9240 * tooltips with higher precedence than object tooltips). It can
9241 * have only one tooltip at a time, so any previous tooltip data
9246 EAPI void elm_gengrid_item_tooltip_text_set(Elm_Gengrid_Item *item, const char *text) EINA_ARG_NONNULL(1);
9249 * Set the content to be shown in a given gengrid item's tooltip
9251 * @param item The gengrid item.
9252 * @param func The function returning the tooltip contents.
9253 * @param data What to provide to @a func as callback data/context.
9254 * @param del_cb Called when data is not needed anymore, either when
9255 * another callback replaces @p func, the tooltip is unset with
9256 * elm_gengrid_item_tooltip_unset() or the owner @p item
9257 * dies. This callback receives as its first parameter the
9258 * given @p data, being @c event_info the item handle.
9260 * This call will setup the tooltip's contents to @p item
9261 * (analogous to elm_object_tooltip_content_cb_set(), but being
9262 * item tooltips with higher precedence than object tooltips). It
9263 * can have only one tooltip at a time, so any previous tooltip
9264 * content will get removed. @p func (with @p data) will be called
9265 * every time Elementary needs to show the tooltip and it should
9266 * return a valid Evas object, which will be fully managed by the
9267 * tooltip system, getting deleted when the tooltip is gone.
9271 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);
9274 * Unset a tooltip from a given gengrid item
9276 * @param item gengrid item to remove a previously set tooltip from.
9278 * This call removes any tooltip set on @p item. The callback
9279 * provided as @c del_cb to
9280 * elm_gengrid_item_tooltip_content_cb_set() will be called to
9281 * notify it is not used anymore (and have resources cleaned, if
9284 * @see elm_gengrid_item_tooltip_content_cb_set()
9288 EAPI void elm_gengrid_item_tooltip_unset(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9291 * Set a different @b style for a given gengrid item's tooltip.
9293 * @param item gengrid item with tooltip set
9294 * @param style the <b>theme style</b> to use on tooltips (e.g. @c
9295 * "default", @c "transparent", etc)
9297 * Tooltips can have <b>alternate styles</b> to be displayed on,
9298 * which are defined by the theme set on Elementary. This function
9299 * works analogously as elm_object_tooltip_style_set(), but here
9300 * applied only to gengrid item objects. The default style for
9301 * tooltips is @c "default".
9303 * @note before you set a style you should define a tooltip with
9304 * elm_gengrid_item_tooltip_content_cb_set() or
9305 * elm_gengrid_item_tooltip_text_set()
9307 * @see elm_gengrid_item_tooltip_style_get()
9311 EAPI void elm_gengrid_item_tooltip_style_set(Elm_Gengrid_Item *item, const char *style) EINA_ARG_NONNULL(1);
9314 * Get the style set a given gengrid item's tooltip.
9316 * @param item gengrid item with tooltip already set on.
9317 * @return style the theme style in use, which defaults to
9318 * "default". If the object does not have a tooltip set,
9319 * then @c NULL is returned.
9321 * @see elm_gengrid_item_tooltip_style_set() for more details
9325 EAPI const char *elm_gengrid_item_tooltip_style_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9327 * @brief Disable size restrictions on an object's tooltip
9328 * @param item The tooltip's anchor object
9329 * @param disable If EINA_TRUE, size restrictions are disabled
9330 * @return EINA_FALSE on failure, EINA_TRUE on success
9332 * This function allows a tooltip to expand beyond its parant window's canvas.
9333 * It will instead be limited only by the size of the display.
9335 EAPI Eina_Bool elm_gengrid_item_tooltip_size_restrict_disable(Elm_Gengrid_Item *item, Eina_Bool disable);
9337 * @brief Retrieve size restriction state of an object's tooltip
9338 * @param item The tooltip's anchor object
9339 * @return If EINA_TRUE, size restrictions are disabled
9341 * This function returns whether a tooltip is allowed to expand beyond
9342 * its parant window's canvas.
9343 * It will instead be limited only by the size of the display.
9345 EAPI Eina_Bool elm_gengrid_item_tooltip_size_restrict_disabled_get(const Elm_Gengrid_Item *item);
9347 * Set the type of mouse pointer/cursor decoration to be shown,
9348 * when the mouse pointer is over the given gengrid widget item
9350 * @param item gengrid item to customize cursor on
9351 * @param cursor the cursor type's name
9353 * This function works analogously as elm_object_cursor_set(), but
9354 * here the cursor's changing area is restricted to the item's
9355 * area, and not the whole widget's. Note that that item cursors
9356 * have precedence over widget cursors, so that a mouse over @p
9357 * item will always show cursor @p type.
9359 * If this function is called twice for an object, a previously set
9360 * cursor will be unset on the second call.
9362 * @see elm_object_cursor_set()
9363 * @see elm_gengrid_item_cursor_get()
9364 * @see elm_gengrid_item_cursor_unset()
9368 EAPI void elm_gengrid_item_cursor_set(Elm_Gengrid_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
9371 * Get the type of mouse pointer/cursor decoration set to be shown,
9372 * when the mouse pointer is over the given gengrid widget item
9374 * @param item gengrid item with custom cursor set
9375 * @return the cursor type's name or @c NULL, if no custom cursors
9376 * were set to @p item (and on errors)
9378 * @see elm_object_cursor_get()
9379 * @see elm_gengrid_item_cursor_set() for more details
9380 * @see elm_gengrid_item_cursor_unset()
9384 EAPI const char *elm_gengrid_item_cursor_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9387 * Unset any custom mouse pointer/cursor decoration set to be
9388 * shown, when the mouse pointer is over the given gengrid widget
9389 * item, thus making it show the @b default cursor again.
9391 * @param item a gengrid item
9393 * Use this call to undo any custom settings on this item's cursor
9394 * decoration, bringing it back to defaults (no custom style set).
9396 * @see elm_object_cursor_unset()
9397 * @see elm_gengrid_item_cursor_set() for more details
9401 EAPI void elm_gengrid_item_cursor_unset(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9404 * Set a different @b style for a given custom cursor set for a
9407 * @param item gengrid item with custom cursor set
9408 * @param style the <b>theme style</b> to use (e.g. @c "default",
9409 * @c "transparent", etc)
9411 * This function only makes sense when one is using custom mouse
9412 * cursor decorations <b>defined in a theme file</b> , which can
9413 * have, given a cursor name/type, <b>alternate styles</b> on
9414 * it. It works analogously as elm_object_cursor_style_set(), but
9415 * here applied only to gengrid item objects.
9417 * @warning Before you set a cursor style you should have defined a
9418 * custom cursor previously on the item, with
9419 * elm_gengrid_item_cursor_set()
9421 * @see elm_gengrid_item_cursor_engine_only_set()
9422 * @see elm_gengrid_item_cursor_style_get()
9426 EAPI void elm_gengrid_item_cursor_style_set(Elm_Gengrid_Item *item, const char *style) EINA_ARG_NONNULL(1);
9429 * Get the current @b style set for a given gengrid item's custom
9432 * @param item gengrid item with custom cursor set.
9433 * @return style the cursor style in use. If the object does not
9434 * have a cursor set, then @c NULL is returned.
9436 * @see elm_gengrid_item_cursor_style_set() for more details
9440 EAPI const char *elm_gengrid_item_cursor_style_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9443 * Set if the (custom) cursor for a given gengrid item should be
9444 * searched in its theme, also, or should only rely on the
9447 * @param item item with custom (custom) cursor already set on
9448 * @param engine_only Use @c EINA_TRUE to have cursors looked for
9449 * only on those provided by the rendering engine, @c EINA_FALSE to
9450 * have them searched on the widget's theme, as well.
9452 * @note This call is of use only if you've set a custom cursor
9453 * for gengrid items, with elm_gengrid_item_cursor_set().
9455 * @note By default, cursors will only be looked for between those
9456 * provided by the rendering engine.
9460 EAPI void elm_gengrid_item_cursor_engine_only_set(Elm_Gengrid_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
9463 * Get if the (custom) cursor for a given gengrid item is being
9464 * searched in its theme, also, or is only relying on the rendering
9467 * @param item a gengrid item
9468 * @return @c EINA_TRUE, if cursors are being looked for only on
9469 * those provided by the rendering engine, @c EINA_FALSE if they
9470 * are being searched on the widget's theme, as well.
9472 * @see elm_gengrid_item_cursor_engine_only_set(), for more details
9476 EAPI Eina_Bool elm_gengrid_item_cursor_engine_only_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9479 * Remove all items from a given gengrid widget
9481 * @param obj The gengrid object.
9483 * This removes (and deletes) all items in @p obj, leaving it
9486 * @see elm_gengrid_item_del(), to remove just one item.
9490 EINA_DEPRECATED EAPI void elm_gengrid_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
9493 * Get the selected item in a given gengrid widget
9495 * @param obj The gengrid object.
9496 * @return The selected item's handleor @c NULL, if none is
9497 * selected at the moment (and on errors)
9499 * This returns the selected item in @p obj. If multi selection is
9500 * enabled on @p obj (@see elm_gengrid_multi_select_set()), only
9501 * the first item in the list is selected, which might not be very
9502 * useful. For that case, see elm_gengrid_selected_items_get().
9506 EAPI Elm_Gengrid_Item *elm_gengrid_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9509 * Get <b>a list</b> of selected items in a given gengrid
9511 * @param obj The gengrid object.
9512 * @return The list of selected items or @c NULL, if none is
9513 * selected at the moment (and on errors)
9515 * This returns a list of the selected items, in the order that
9516 * they appear in the grid. This list is only valid as long as no
9517 * more items are selected or unselected (or unselected implictly
9518 * by deletion). The list contains #Elm_Gengrid_Item pointers as
9521 * @see elm_gengrid_selected_item_get()
9525 EAPI const Eina_List *elm_gengrid_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9532 * @defgroup Clock Clock
9534 * @image html img/widget/clock/preview-00.png
9535 * @image latex img/widget/clock/preview-00.eps
9537 * This is a @b digital clock widget. In its default theme, it has a
9538 * vintage "flipping numbers clock" appearance, which will animate
9539 * sheets of individual algarisms individually as time goes by.
9541 * A newly created clock will fetch system's time (already
9542 * considering local time adjustments) to start with, and will tick
9543 * accondingly. It may or may not show seconds.
9545 * Clocks have an @b edition mode. When in it, the sheets will
9546 * display extra arrow indications on the top and bottom and the
9547 * user may click on them to raise or lower the time values. After
9548 * it's told to exit edition mode, it will keep ticking with that
9549 * new time set (it keeps the difference from local time).
9551 * Also, when under edition mode, user clicks on the cited arrows
9552 * which are @b held for some time will make the clock to flip the
9553 * sheet, thus editing the time, continuosly and automatically for
9554 * the user. The interval between sheet flips will keep growing in
9555 * time, so that it helps the user to reach a time which is distant
9558 * The time display is, by default, in military mode (24h), but an
9559 * am/pm indicator may be optionally shown, too, when it will
9562 * Smart callbacks one can register to:
9563 * - "changed" - the clock's user changed the time
9565 * Here is an example on its usage:
9566 * @li @ref clock_example
9575 * Identifiers for which clock digits should be editable, when a
9576 * clock widget is in edition mode. Values may be ORed together to
9577 * make a mask, naturally.
9579 * @see elm_clock_edit_set()
9580 * @see elm_clock_digit_edit_set()
9582 typedef enum _Elm_Clock_Digedit
9584 ELM_CLOCK_NONE = 0, /**< Default value. Means that all digits are editable, when in edition mode. */
9585 ELM_CLOCK_HOUR_DECIMAL = 1 << 0, /**< Decimal algarism of hours value should be editable */
9586 ELM_CLOCK_HOUR_UNIT = 1 << 1, /**< Unit algarism of hours value should be editable */
9587 ELM_CLOCK_MIN_DECIMAL = 1 << 2, /**< Decimal algarism of minutes value should be editable */
9588 ELM_CLOCK_MIN_UNIT = 1 << 3, /**< Unit algarism of minutes value should be editable */
9589 ELM_CLOCK_SEC_DECIMAL = 1 << 4, /**< Decimal algarism of seconds value should be editable */
9590 ELM_CLOCK_SEC_UNIT = 1 << 5, /**< Unit algarism of seconds value should be editable */
9591 ELM_CLOCK_ALL = (1 << 6) - 1 /**< All digits should be editable */
9592 } Elm_Clock_Digedit;
9595 * Add a new clock widget to the given parent Elementary
9596 * (container) object
9598 * @param parent The parent object
9599 * @return a new clock widget handle or @c NULL, on errors
9601 * This function inserts a new clock widget on the canvas.
9605 EAPI Evas_Object *elm_clock_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
9608 * Set a clock widget's time, programmatically
9610 * @param obj The clock widget object
9611 * @param hrs The hours to set
9612 * @param min The minutes to set
9613 * @param sec The secondes to set
9615 * This function updates the time that is showed by the clock
9618 * Values @b must be set within the following ranges:
9619 * - 0 - 23, for hours
9620 * - 0 - 59, for minutes
9621 * - 0 - 59, for seconds,
9623 * even if the clock is not in "military" mode.
9625 * @warning The behavior for values set out of those ranges is @b
9630 EAPI void elm_clock_time_set(Evas_Object *obj, int hrs, int min, int sec) EINA_ARG_NONNULL(1);
9633 * Get a clock widget's time values
9635 * @param obj The clock object
9636 * @param[out] hrs Pointer to the variable to get the hours value
9637 * @param[out] min Pointer to the variable to get the minutes value
9638 * @param[out] sec Pointer to the variable to get the seconds value
9640 * This function gets the time set for @p obj, returning
9641 * it on the variables passed as the arguments to function
9643 * @note Use @c NULL pointers on the time values you're not
9644 * interested in: they'll be ignored by the function.
9648 EAPI void elm_clock_time_get(const Evas_Object *obj, int *hrs, int *min, int *sec) EINA_ARG_NONNULL(1);
9651 * Set whether a given clock widget is under <b>edition mode</b> or
9652 * under (default) displaying-only mode.
9654 * @param obj The clock object
9655 * @param edit @c EINA_TRUE to put it in edition, @c EINA_FALSE to
9656 * put it back to "displaying only" mode
9658 * This function makes a clock's time to be editable or not <b>by
9659 * user interaction</b>. When in edition mode, clocks @b stop
9660 * ticking, until one brings them back to canonical mode. The
9661 * elm_clock_digit_edit_set() function will influence which digits
9662 * of the clock will be editable. By default, all of them will be
9663 * (#ELM_CLOCK_NONE).
9665 * @note am/pm sheets, if being shown, will @b always be editable
9666 * under edition mode.
9668 * @see elm_clock_edit_get()
9672 EAPI void elm_clock_edit_set(Evas_Object *obj, Eina_Bool edit) EINA_ARG_NONNULL(1);
9675 * Retrieve whether a given clock widget is under <b>edition
9676 * mode</b> or under (default) displaying-only mode.
9678 * @param obj The clock object
9679 * @param edit @c EINA_TRUE, if it's in edition mode, @c EINA_FALSE
9682 * This function retrieves whether the clock's time can be edited
9683 * or not by user interaction.
9685 * @see elm_clock_edit_set() for more details
9689 EAPI Eina_Bool elm_clock_edit_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9692 * Set what digits of the given clock widget should be editable
9693 * when in edition mode.
9695 * @param obj The clock object
9696 * @param digedit Bit mask indicating the digits to be editable
9697 * (values in #Elm_Clock_Digedit).
9699 * If the @p digedit param is #ELM_CLOCK_NONE, editing will be
9700 * disabled on @p obj (same effect as elm_clock_edit_set(), with @c
9703 * @see elm_clock_digit_edit_get()
9707 EAPI void elm_clock_digit_edit_set(Evas_Object *obj, Elm_Clock_Digedit digedit) EINA_ARG_NONNULL(1);
9710 * Retrieve what digits of the given clock widget should be
9711 * editable when in edition mode.
9713 * @param obj The clock object
9714 * @return Bit mask indicating the digits to be editable
9715 * (values in #Elm_Clock_Digedit).
9717 * @see elm_clock_digit_edit_set() for more details
9721 EAPI Elm_Clock_Digedit elm_clock_digit_edit_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9724 * Set if the given clock widget must show hours in military or
9727 * @param obj The clock object
9728 * @param am_pm @c EINA_TRUE to put it in am/pm mode, @c EINA_FALSE
9731 * This function sets if the clock must show hours in military or
9732 * am/pm mode. In some countries like Brazil the military mode
9733 * (00-24h-format) is used, in opposition to the USA, where the
9734 * am/pm mode is more commonly used.
9736 * @see elm_clock_show_am_pm_get()
9740 EAPI void elm_clock_show_am_pm_set(Evas_Object *obj, Eina_Bool am_pm) EINA_ARG_NONNULL(1);
9743 * Get if the given clock widget shows hours in military or am/pm
9746 * @param obj The clock object
9747 * @return @c EINA_TRUE, if in am/pm mode, @c EINA_FALSE if in
9750 * This function gets if the clock shows hours in military or am/pm
9753 * @see elm_clock_show_am_pm_set() for more details
9757 EAPI Eina_Bool elm_clock_show_am_pm_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9760 * Set if the given clock widget must show time with seconds or not
9762 * @param obj The clock object
9763 * @param seconds @c EINA_TRUE to show seconds, @c EINA_FALSE otherwise
9765 * This function sets if the given clock must show or not elapsed
9766 * seconds. By default, they are @b not shown.
9768 * @see elm_clock_show_seconds_get()
9772 EAPI void elm_clock_show_seconds_set(Evas_Object *obj, Eina_Bool seconds) EINA_ARG_NONNULL(1);
9775 * Get whether the given clock widget is showing time with seconds
9778 * @param obj The clock object
9779 * @return @c EINA_TRUE if it's showing seconds, @c EINA_FALSE otherwise
9781 * This function gets whether @p obj is showing or not the elapsed
9784 * @see elm_clock_show_seconds_set()
9788 EAPI Eina_Bool elm_clock_show_seconds_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9791 * Set the interval on time updates for an user mouse button hold
9792 * on clock widgets' time edition.
9794 * @param obj The clock object
9795 * @param interval The (first) interval value in seconds
9797 * This interval value is @b decreased while the user holds the
9798 * mouse pointer either incrementing or decrementing a given the
9799 * clock digit's value.
9801 * This helps the user to get to a given time distant from the
9802 * current one easier/faster, as it will start to flip quicker and
9803 * quicker on mouse button holds.
9805 * The calculation for the next flip interval value, starting from
9806 * the one set with this call, is the previous interval divided by
9807 * 1.05, so it decreases a little bit.
9809 * The default starting interval value for automatic flips is
9812 * @see elm_clock_interval_get()
9816 EAPI void elm_clock_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
9819 * Get the interval on time updates for an user mouse button hold
9820 * on clock widgets' time edition.
9822 * @param obj The clock object
9823 * @return The (first) interval value, in seconds, set on it
9825 * @see elm_clock_interval_set() for more details
9829 EAPI double elm_clock_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9836 * @defgroup Layout Layout
9838 * @image html img/widget/layout/preview-00.png
9839 * @image latex img/widget/layout/preview-00.eps width=\textwidth
9841 * @image html img/layout-predefined.png
9842 * @image latex img/layout-predefined.eps width=\textwidth
9844 * This is a container widget that takes a standard Edje design file and
9845 * wraps it very thinly in a widget.
9847 * An Edje design (theme) file has a very wide range of possibilities to
9848 * describe the behavior of elements added to the Layout. Check out the Edje
9849 * documentation and the EDC reference to get more information about what can
9850 * be done with Edje.
9852 * Just like @ref List, @ref Box, and other container widgets, any
9853 * object added to the Layout will become its child, meaning that it will be
9854 * deleted if the Layout is deleted, move if the Layout is moved, and so on.
9856 * The Layout widget can contain as many Contents, Boxes or Tables as
9857 * described in its theme file. For instance, objects can be added to
9858 * different Tables by specifying the respective Table part names. The same
9859 * is valid for Content and Box.
9861 * The objects added as child of the Layout will behave as described in the
9862 * part description where they were added. There are 3 possible types of
9863 * parts where a child can be added:
9865 * @section secContent Content (SWALLOW part)
9867 * Only one object can be added to the @c SWALLOW part (but you still can
9868 * have many @c SWALLOW parts and one object on each of them). Use the @c
9869 * elm_object_content_set/get/unset functions to set, retrieve and unset
9870 * objects as content of the @c SWALLOW. After being set to this part, the
9871 * object size, position, visibility, clipping and other description
9872 * properties will be totally controlled by the description of the given part
9873 * (inside the Edje theme file).
9875 * One can use @c evas_object_size_hint_* functions on the child to have some
9876 * kind of control over its behavior, but the resulting behavior will still
9877 * depend heavily on the @c SWALLOW part description.
9879 * The Edje theme also can change the part description, based on signals or
9880 * scripts running inside the theme. This change can also be animated. All of
9881 * this will affect the child object set as content accordingly. The object
9882 * size will be changed if the part size is changed, it will animate move if
9883 * the part is moving, and so on.
9885 * The following picture demonstrates a Layout widget with a child object
9886 * added to its @c SWALLOW:
9888 * @image html layout_swallow.png
9889 * @image latex layout_swallow.eps width=\textwidth
9891 * @section secBox Box (BOX part)
9893 * An Edje @c BOX part is very similar to the Elementary @ref Box widget. It
9894 * allows one to add objects to the box and have them distributed along its
9895 * area, accordingly to the specified @a layout property (now by @a layout we
9896 * mean the chosen layouting design of the Box, not the Layout widget
9899 * A similar effect for having a box with its position, size and other things
9900 * controlled by the Layout theme would be to create an Elementary @ref Box
9901 * widget and add it as a Content in the @c SWALLOW part.
9903 * The main difference of using the Layout Box is that its behavior, the box
9904 * properties like layouting format, padding, align, etc. will be all
9905 * controlled by the theme. This means, for example, that a signal could be
9906 * sent to the Layout theme (with elm_object_signal_emit()) and the theme
9907 * handled the signal by changing the box padding, or align, or both. Using
9908 * the Elementary @ref Box widget is not necessarily harder or easier, it
9909 * just depends on the circunstances and requirements.
9911 * The Layout Box can be used through the @c elm_layout_box_* set of
9914 * The following picture demonstrates a Layout widget with many child objects
9915 * added to its @c BOX part:
9917 * @image html layout_box.png
9918 * @image latex layout_box.eps width=\textwidth
9920 * @section secTable Table (TABLE part)
9922 * Just like the @ref secBox, the Layout Table is very similar to the
9923 * Elementary @ref Table widget. It allows one to add objects to the Table
9924 * specifying the row and column where the object should be added, and any
9925 * column or row span if necessary.
9927 * Again, we could have this design by adding a @ref Table widget to the @c
9928 * SWALLOW part using elm_object_part_content_set(). The same difference happens
9929 * here when choosing to use the Layout Table (a @c TABLE part) instead of
9930 * the @ref Table plus @c SWALLOW part. It's just a matter of convenience.
9932 * The Layout Table can be used through the @c elm_layout_table_* set of
9935 * The following picture demonstrates a Layout widget with many child objects
9936 * added to its @c TABLE part:
9938 * @image html layout_table.png
9939 * @image latex layout_table.eps width=\textwidth
9941 * @section secPredef Predefined Layouts
9943 * Another interesting thing about the Layout widget is that it offers some
9944 * predefined themes that come with the default Elementary theme. These
9945 * themes can be set by the call elm_layout_theme_set(), and provide some
9946 * basic functionality depending on the theme used.
9948 * Most of them already send some signals, some already provide a toolbar or
9949 * back and next buttons.
9951 * These are available predefined theme layouts. All of them have class = @c
9952 * layout, group = @c application, and style = one of the following options:
9954 * @li @c toolbar-content - application with toolbar and main content area
9955 * @li @c toolbar-content-back - application with toolbar and main content
9956 * area with a back button and title area
9957 * @li @c toolbar-content-back-next - application with toolbar and main
9958 * content area with a back and next buttons and title area
9959 * @li @c content-back - application with a main content area with a back
9960 * button and title area
9961 * @li @c content-back-next - application with a main content area with a
9962 * back and next buttons and title area
9963 * @li @c toolbar-vbox - application with toolbar and main content area as a
9965 * @li @c toolbar-table - application with toolbar and main content area as a
9968 * @section secExamples Examples
9970 * Some examples of the Layout widget can be found here:
9971 * @li @ref layout_example_01
9972 * @li @ref layout_example_02
9973 * @li @ref layout_example_03
9974 * @li @ref layout_example_edc
9979 * Add a new layout to the parent
9981 * @param parent The parent object
9982 * @return The new object or NULL if it cannot be created
9984 * @see elm_layout_file_set()
9985 * @see elm_layout_theme_set()
9989 EAPI Evas_Object *elm_layout_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
9991 * Set the file that will be used as layout
9993 * @param obj The layout object
9994 * @param file The path to file (edj) that will be used as layout
9995 * @param group The group that the layout belongs in edje file
9997 * @return (1 = success, 0 = error)
10001 EAPI Eina_Bool elm_layout_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1);
10003 * Set the edje group from the elementary theme that will be used as layout
10005 * @param obj The layout object
10006 * @param clas the clas of the group
10007 * @param group the group
10008 * @param style the style to used
10010 * @return (1 = success, 0 = error)
10014 EAPI Eina_Bool elm_layout_theme_set(Evas_Object *obj, const char *clas, const char *group, const char *style) EINA_ARG_NONNULL(1);
10016 * Set the layout content.
10018 * @param obj The layout object
10019 * @param swallow The swallow part name in the edje file
10020 * @param content The child that will be added in this layout object
10022 * Once the content object is set, a previously set one will be deleted.
10023 * If you want to keep that old content object, use the
10024 * elm_object_part_content_unset() function.
10026 * @note In an Edje theme, the part used as a content container is called @c
10027 * SWALLOW. This is why the parameter name is called @p swallow, but it is
10028 * expected to be a part name just like the second parameter of
10029 * elm_layout_box_append().
10031 * @see elm_layout_box_append()
10032 * @see elm_object_part_content_get()
10033 * @see elm_object_part_content_unset()
10035 * @deprecated use elm_object_part_content_set() instead
10039 EINA_DEPRECATED EAPI void elm_layout_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content) EINA_ARG_NONNULL(1);
10041 * Get the child object in the given content part.
10043 * @param obj The layout object
10044 * @param swallow The SWALLOW part to get its content
10046 * @return The swallowed object or NULL if none or an error occurred
10048 * @deprecated use elm_object_part_content_get() instead
10052 EINA_DEPRECATED EAPI Evas_Object *elm_layout_content_get(const Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
10054 * Unset the layout content.
10056 * @param obj The layout object
10057 * @param swallow The swallow part name in the edje file
10058 * @return The content that was being used
10060 * Unparent and return the content object which was set for this part.
10062 * @deprecated use elm_object_part_content_unset() instead
10066 EINA_DEPRECATED EAPI Evas_Object *elm_layout_content_unset(Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
10068 * Set the text of the given part
10070 * @param obj The layout object
10071 * @param part The TEXT part where to set the text
10072 * @param text The text to set
10075 * @deprecated use elm_object_part_text_set() instead.
10077 EINA_DEPRECATED EAPI void elm_layout_text_set(Evas_Object *obj, const char *part, const char *text) EINA_ARG_NONNULL(1);
10079 * Get the text set in the given part
10081 * @param obj The layout object
10082 * @param part The TEXT part to retrieve the text off
10084 * @return The text set in @p part
10087 * @deprecated use elm_object_part_text_get() instead.
10089 EINA_DEPRECATED EAPI const char *elm_layout_text_get(const Evas_Object *obj, const char *part) EINA_ARG_NONNULL(1);
10091 * Append child to layout box part.
10093 * @param obj the layout object
10094 * @param part the box part to which the object will be appended.
10095 * @param child the child object to append to box.
10097 * Once the object is appended, it will become child of the layout. Its
10098 * lifetime will be bound to the layout, whenever the layout dies the child
10099 * will be deleted automatically. One should use elm_layout_box_remove() to
10100 * make this layout forget about the object.
10102 * @see elm_layout_box_prepend()
10103 * @see elm_layout_box_insert_before()
10104 * @see elm_layout_box_insert_at()
10105 * @see elm_layout_box_remove()
10109 EAPI void elm_layout_box_append(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1);
10111 * Prepend child to layout box part.
10113 * @param obj the layout object
10114 * @param part the box part to prepend.
10115 * @param child the child object to prepend to box.
10117 * Once the object is prepended, it will become child of the layout. Its
10118 * lifetime will be bound to the layout, whenever the layout dies the child
10119 * will be deleted automatically. One should use elm_layout_box_remove() to
10120 * make this layout forget about the object.
10122 * @see elm_layout_box_append()
10123 * @see elm_layout_box_insert_before()
10124 * @see elm_layout_box_insert_at()
10125 * @see elm_layout_box_remove()
10129 EAPI void elm_layout_box_prepend(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1);
10131 * Insert child to layout box part before a reference object.
10133 * @param obj the layout object
10134 * @param part the box part to insert.
10135 * @param child the child object to insert into box.
10136 * @param reference another reference object to insert before in box.
10138 * Once the object is inserted, it will become child of the layout. Its
10139 * lifetime will be bound to the layout, whenever the layout dies the child
10140 * will be deleted automatically. One should use elm_layout_box_remove() to
10141 * make this layout forget about the object.
10143 * @see elm_layout_box_append()
10144 * @see elm_layout_box_prepend()
10145 * @see elm_layout_box_insert_before()
10146 * @see elm_layout_box_remove()
10150 EAPI void elm_layout_box_insert_before(Evas_Object *obj, const char *part, Evas_Object *child, const Evas_Object *reference) EINA_ARG_NONNULL(1);
10152 * Insert child to layout box part at a given position.
10154 * @param obj the layout object
10155 * @param part the box part to insert.
10156 * @param child the child object to insert into box.
10157 * @param pos the numeric position >=0 to insert the child.
10159 * Once the object is inserted, it will become child of the layout. Its
10160 * lifetime will be bound to the layout, whenever the layout dies the child
10161 * will be deleted automatically. One should use elm_layout_box_remove() to
10162 * make this layout forget about the object.
10164 * @see elm_layout_box_append()
10165 * @see elm_layout_box_prepend()
10166 * @see elm_layout_box_insert_before()
10167 * @see elm_layout_box_remove()
10171 EAPI void elm_layout_box_insert_at(Evas_Object *obj, const char *part, Evas_Object *child, unsigned int pos) EINA_ARG_NONNULL(1);
10173 * Remove a child of the given part box.
10175 * @param obj The layout object
10176 * @param part The box part name to remove child.
10177 * @param child The object to remove from box.
10178 * @return The object that was being used, or NULL if not found.
10180 * The object will be removed from the box part and its lifetime will
10181 * not be handled by the layout anymore. This is equivalent to
10182 * elm_object_part_content_unset() for box.
10184 * @see elm_layout_box_append()
10185 * @see elm_layout_box_remove_all()
10189 EAPI Evas_Object *elm_layout_box_remove(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1, 2, 3);
10191 * Remove all children of the given part box.
10193 * @param obj The layout object
10194 * @param part The box part name to remove child.
10195 * @param clear If EINA_TRUE, then all objects will be deleted as
10196 * well, otherwise they will just be removed and will be
10197 * dangling on the canvas.
10199 * The objects will be removed from the box part and their lifetime will
10200 * not be handled by the layout anymore. This is equivalent to
10201 * elm_layout_box_remove() for all box children.
10203 * @see elm_layout_box_append()
10204 * @see elm_layout_box_remove()
10208 EAPI void elm_layout_box_remove_all(Evas_Object *obj, const char *part, Eina_Bool clear) EINA_ARG_NONNULL(1, 2);
10210 * Insert child to layout table part.
10212 * @param obj the layout object
10213 * @param part the box part to pack child.
10214 * @param child_obj the child object to pack into table.
10215 * @param col the column to which the child should be added. (>= 0)
10216 * @param row the row to which the child should be added. (>= 0)
10217 * @param colspan how many columns should be used to store this object. (>=
10219 * @param rowspan how many rows should be used to store this object. (>= 1)
10221 * Once the object is inserted, it will become child of the table. Its
10222 * lifetime will be bound to the layout, and whenever the layout dies the
10223 * child will be deleted automatically. One should use
10224 * elm_layout_table_remove() to make this layout forget about the object.
10226 * If @p colspan or @p rowspan are bigger than 1, that object will occupy
10227 * more space than a single cell. For instance, the following code:
10229 * elm_layout_table_pack(layout, "table_part", child, 0, 1, 3, 1);
10232 * Would result in an object being added like the following picture:
10234 * @image html layout_colspan.png
10235 * @image latex layout_colspan.eps width=\textwidth
10237 * @see elm_layout_table_unpack()
10238 * @see elm_layout_table_clear()
10242 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);
10244 * Unpack (remove) a child of the given part table.
10246 * @param obj The layout object
10247 * @param part The table part name to remove child.
10248 * @param child_obj The object to remove from table.
10249 * @return The object that was being used, or NULL if not found.
10251 * The object will be unpacked from the table part and its lifetime
10252 * will not be handled by the layout anymore. This is equivalent to
10253 * elm_object_part_content_unset() for table.
10255 * @see elm_layout_table_pack()
10256 * @see elm_layout_table_clear()
10260 EAPI Evas_Object *elm_layout_table_unpack(Evas_Object *obj, const char *part, Evas_Object *child_obj) EINA_ARG_NONNULL(1, 2, 3);
10262 * Remove all the child objects of the given part table.
10264 * @param obj The layout object
10265 * @param part The table part name to remove child.
10266 * @param clear If EINA_TRUE, then all objects will be deleted as
10267 * well, otherwise they will just be removed and will be
10268 * dangling on the canvas.
10270 * The objects will be removed from the table part and their lifetime will
10271 * not be handled by the layout anymore. This is equivalent to
10272 * elm_layout_table_unpack() for all table children.
10274 * @see elm_layout_table_pack()
10275 * @see elm_layout_table_unpack()
10279 EAPI void elm_layout_table_clear(Evas_Object *obj, const char *part, Eina_Bool clear) EINA_ARG_NONNULL(1, 2);
10281 * Get the edje layout
10283 * @param obj The layout object
10285 * @return A Evas_Object with the edje layout settings loaded
10286 * with function elm_layout_file_set
10288 * This returns the edje object. It is not expected to be used to then
10289 * swallow objects via edje_object_part_swallow() for example. Use
10290 * elm_object_part_content_set() instead so child object handling and sizing is
10293 * @note This function should only be used if you really need to call some
10294 * low level Edje function on this edje object. All the common stuff (setting
10295 * text, emitting signals, hooking callbacks to signals, etc.) can be done
10296 * with proper elementary functions.
10298 * @see elm_object_signal_callback_add()
10299 * @see elm_object_signal_emit()
10300 * @see elm_object_part_text_set()
10301 * @see elm_object_part_content_set()
10302 * @see elm_layout_box_append()
10303 * @see elm_layout_table_pack()
10304 * @see elm_layout_data_get()
10308 EAPI Evas_Object *elm_layout_edje_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10310 * Get the edje data from the given layout
10312 * @param obj The layout object
10313 * @param key The data key
10315 * @return The edje data string
10317 * This function fetches data specified inside the edje theme of this layout.
10318 * This function return NULL if data is not found.
10320 * In EDC this comes from a data block within the group block that @p
10321 * obj was loaded from. E.g.
10328 * item: "key1" "value1";
10329 * item: "key2" "value2";
10337 EAPI const char *elm_layout_data_get(const Evas_Object *obj, const char *key) EINA_ARG_NONNULL(1, 2);
10341 * @param obj The layout object
10343 * Manually forces a sizing re-evaluation. This is useful when the minimum
10344 * size required by the edje theme of this layout has changed. The change on
10345 * the minimum size required by the edje theme is not immediately reported to
10346 * the elementary layout, so one needs to call this function in order to tell
10347 * the widget (layout) that it needs to reevaluate its own size.
10349 * The minimum size of the theme is calculated based on minimum size of
10350 * parts, the size of elements inside containers like box and table, etc. All
10351 * of this can change due to state changes, and that's when this function
10352 * should be called.
10354 * Also note that a standard signal of "size,eval" "elm" emitted from the
10355 * edje object will cause this to happen too.
10359 EAPI void elm_layout_sizing_eval(Evas_Object *obj) EINA_ARG_NONNULL(1);
10362 * Sets a specific cursor for an edje part.
10364 * @param obj The layout object.
10365 * @param part_name a part from loaded edje group.
10366 * @param cursor cursor name to use, see Elementary_Cursor.h
10368 * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
10369 * part not exists or it has "mouse_events: 0".
10373 EAPI Eina_Bool elm_layout_part_cursor_set(Evas_Object *obj, const char *part_name, const char *cursor) EINA_ARG_NONNULL(1, 2);
10376 * Get the cursor to be shown when mouse is over an edje part
10378 * @param obj The layout object.
10379 * @param part_name a part from loaded edje group.
10380 * @return the cursor name.
10384 EAPI const char *elm_layout_part_cursor_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
10387 * Unsets a cursor previously set with elm_layout_part_cursor_set().
10389 * @param obj The layout object.
10390 * @param part_name a part from loaded edje group, that had a cursor set
10391 * with elm_layout_part_cursor_set().
10395 EAPI void elm_layout_part_cursor_unset(Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
10398 * Sets a specific cursor style for an edje part.
10400 * @param obj The layout object.
10401 * @param part_name a part from loaded edje group.
10402 * @param style the theme style to use (default, transparent, ...)
10404 * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
10405 * part not exists or it did not had a cursor set.
10409 EAPI Eina_Bool elm_layout_part_cursor_style_set(Evas_Object *obj, const char *part_name, const char *style) EINA_ARG_NONNULL(1, 2);
10412 * Gets a specific cursor style for an edje part.
10414 * @param obj The layout object.
10415 * @param part_name a part from loaded edje group.
10417 * @return the theme style in use, defaults to "default". If the
10418 * object does not have a cursor set, then NULL is returned.
10422 EAPI const char *elm_layout_part_cursor_style_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
10425 * Sets if the cursor set should be searched on the theme or should use
10426 * the provided by the engine, only.
10428 * @note before you set if should look on theme you should define a
10429 * cursor with elm_layout_part_cursor_set(). By default it will only
10430 * look for cursors provided by the engine.
10432 * @param obj The layout object.
10433 * @param part_name a part from loaded edje group.
10434 * @param engine_only if cursors should be just provided by the engine (EINA_TRUE)
10435 * or should also search on widget's theme as well (EINA_FALSE)
10437 * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
10438 * part not exists or it did not had a cursor set.
10442 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);
10445 * Gets a specific cursor engine_only for an edje part.
10447 * @param obj The layout object.
10448 * @param part_name a part from loaded edje group.
10450 * @return whenever the cursor is just provided by engine or also from theme.
10454 EAPI Eina_Bool elm_layout_part_cursor_engine_only_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
10457 * @def elm_layout_icon_set
10458 * Convenience macro to set the icon object in a layout that follows the
10459 * Elementary naming convention for its parts.
10463 #define elm_layout_icon_set(_ly, _obj) \
10466 elm_object_part_content_set((_ly), "elm.swallow.icon", (_obj)); \
10467 if ((_obj)) sig = "elm,state,icon,visible"; \
10468 else sig = "elm,state,icon,hidden"; \
10469 elm_object_signal_emit((_ly), sig, "elm"); \
10473 * @def elm_layout_icon_get
10474 * Convienience macro to get the icon object from a layout that follows the
10475 * Elementary naming convention for its parts.
10479 #define elm_layout_icon_get(_ly) \
10480 elm_object_part_content_get((_ly), "elm.swallow.icon")
10483 * @def elm_layout_end_set
10484 * Convienience macro to set the end object in a layout that follows the
10485 * Elementary naming convention for its parts.
10489 #define elm_layout_end_set(_ly, _obj) \
10492 elm_object_part_content_set((_ly), "elm.swallow.end", (_obj)); \
10493 if ((_obj)) sig = "elm,state,end,visible"; \
10494 else sig = "elm,state,end,hidden"; \
10495 elm_object_signal_emit((_ly), sig, "elm"); \
10499 * @def elm_layout_end_get
10500 * Convienience macro to get the end object in a layout that follows the
10501 * Elementary naming convention for its parts.
10505 #define elm_layout_end_get(_ly) \
10506 elm_object_part_content_get((_ly), "elm.swallow.end")
10509 * @def elm_layout_label_set
10510 * Convienience macro to set the label in a layout that follows the
10511 * Elementary naming convention for its parts.
10514 * @deprecated use elm_object_text_set() instead.
10516 #define elm_layout_label_set(_ly, _txt) \
10517 elm_layout_text_set((_ly), "elm.text", (_txt))
10520 * @def elm_layout_label_get
10521 * Convenience macro to get the label in a layout that follows the
10522 * Elementary naming convention for its parts.
10525 * @deprecated use elm_object_text_set() instead.
10527 #define elm_layout_label_get(_ly) \
10528 elm_layout_text_get((_ly), "elm.text")
10530 /* smart callbacks called:
10531 * "theme,changed" - when elm theme is changed.
10535 * @defgroup Notify Notify
10537 * @image html img/widget/notify/preview-00.png
10538 * @image latex img/widget/notify/preview-00.eps
10540 * Display a container in a particular region of the parent(top, bottom,
10541 * etc). A timeout can be set to automatically hide the notify. This is so
10542 * that, after an evas_object_show() on a notify object, if a timeout was set
10543 * on it, it will @b automatically get hidden after that time.
10545 * Signals that you can add callbacks for are:
10546 * @li "timeout" - when timeout happens on notify and it's hidden
10547 * @li "block,clicked" - when a click outside of the notify happens
10549 * Default contents parts of the notify widget that you can use for are:
10550 * @li "default" - A content of the notify
10552 * @ref tutorial_notify show usage of the API.
10557 * @brief Possible orient values for notify.
10559 * This values should be used in conjunction to elm_notify_orient_set() to
10560 * set the position in which the notify should appear(relative to its parent)
10561 * and in conjunction with elm_notify_orient_get() to know where the notify
10564 typedef enum _Elm_Notify_Orient
10566 ELM_NOTIFY_ORIENT_TOP, /**< Notify should appear in the top of parent, default */
10567 ELM_NOTIFY_ORIENT_CENTER, /**< Notify should appear in the center of parent */
10568 ELM_NOTIFY_ORIENT_BOTTOM, /**< Notify should appear in the bottom of parent */
10569 ELM_NOTIFY_ORIENT_LEFT, /**< Notify should appear in the left of parent */
10570 ELM_NOTIFY_ORIENT_RIGHT, /**< Notify should appear in the right of parent */
10571 ELM_NOTIFY_ORIENT_TOP_LEFT, /**< Notify should appear in the top left of parent */
10572 ELM_NOTIFY_ORIENT_TOP_RIGHT, /**< Notify should appear in the top right of parent */
10573 ELM_NOTIFY_ORIENT_BOTTOM_LEFT, /**< Notify should appear in the bottom left of parent */
10574 ELM_NOTIFY_ORIENT_BOTTOM_RIGHT, /**< Notify should appear in the bottom right of parent */
10575 ELM_NOTIFY_ORIENT_LAST /**< Sentinel value, @b don't use */
10576 } Elm_Notify_Orient;
10578 * @brief Add a new notify to the parent
10580 * @param parent The parent object
10581 * @return The new object or NULL if it cannot be created
10583 EAPI Evas_Object *elm_notify_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10585 * @brief Set the content of the notify widget
10587 * @param obj The notify object
10588 * @param content The content will be filled in this notify object
10590 * Once the content object is set, a previously set one will be deleted. If
10591 * you want to keep that old content object, use the
10592 * elm_notify_content_unset() function.
10594 * @deprecated use elm_object_content_set() instead
10597 EINA_DEPRECATED EAPI void elm_notify_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
10599 * @brief Unset the content of the notify widget
10601 * @param obj The notify object
10602 * @return The content that was being used
10604 * Unparent and return the content object which was set for this widget
10606 * @see elm_notify_content_set()
10607 * @deprecated use elm_object_content_unset() instead
10610 EINA_DEPRECATED EAPI Evas_Object *elm_notify_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
10612 * @brief Return the content of the notify widget
10614 * @param obj The notify object
10615 * @return The content that is being used
10617 * @see elm_notify_content_set()
10618 * @deprecated use elm_object_content_get() instead
10621 EINA_DEPRECATED EAPI Evas_Object *elm_notify_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10623 * @brief Set the notify parent
10625 * @param obj The notify object
10626 * @param content The new parent
10628 * Once the parent object is set, a previously set one will be disconnected
10631 EAPI void elm_notify_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
10633 * @brief Get the notify parent
10635 * @param obj The notify object
10636 * @return The parent
10638 * @see elm_notify_parent_set()
10640 EAPI Evas_Object *elm_notify_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10642 * @brief Set the orientation
10644 * @param obj The notify object
10645 * @param orient The new orientation
10647 * Sets the position in which the notify will appear in its parent.
10649 * @see @ref Elm_Notify_Orient for possible values.
10651 EAPI void elm_notify_orient_set(Evas_Object *obj, Elm_Notify_Orient orient) EINA_ARG_NONNULL(1);
10653 * @brief Return the orientation
10654 * @param obj The notify object
10655 * @return The orientation of the notification
10657 * @see elm_notify_orient_set()
10658 * @see Elm_Notify_Orient
10660 EAPI Elm_Notify_Orient elm_notify_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10662 * @brief Set the time interval after which the notify window is going to be
10665 * @param obj The notify object
10666 * @param time The timeout in seconds
10668 * This function sets a timeout and starts the timer controlling when the
10669 * notify is hidden. Since calling evas_object_show() on a notify restarts
10670 * the timer controlling when the notify is hidden, setting this before the
10671 * notify is shown will in effect mean starting the timer when the notify is
10674 * @note Set a value <= 0.0 to disable a running timer.
10676 * @note If the value > 0.0 and the notify is previously visible, the
10677 * timer will be started with this value, canceling any running timer.
10679 EAPI void elm_notify_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
10681 * @brief Return the timeout value (in seconds)
10682 * @param obj the notify object
10684 * @see elm_notify_timeout_set()
10686 EAPI double elm_notify_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10688 * @brief Sets whether events should be passed to by a click outside
10691 * @param obj The notify object
10692 * @param repeats EINA_TRUE Events are repeats, else no
10694 * When true if the user clicks outside the window the events will be caught
10695 * by the others widgets, else the events are blocked.
10697 * @note The default value is EINA_TRUE.
10699 EAPI void elm_notify_repeat_events_set(Evas_Object *obj, Eina_Bool repeat) EINA_ARG_NONNULL(1);
10701 * @brief Return true if events are repeat below the notify object
10702 * @param obj the notify object
10704 * @see elm_notify_repeat_events_set()
10706 EAPI Eina_Bool elm_notify_repeat_events_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10712 * @defgroup Hover Hover
10714 * @image html img/widget/hover/preview-00.png
10715 * @image latex img/widget/hover/preview-00.eps
10717 * A Hover object will hover over its @p parent object at the @p target
10718 * location. Anything in the background will be given a darker coloring to
10719 * indicate that the hover object is on top (at the default theme). When the
10720 * hover is clicked it is dismissed(hidden), if the contents of the hover are
10721 * clicked that @b doesn't cause the hover to be dismissed.
10723 * A Hover object has two parents. One parent that owns it during creation
10724 * and the other parent being the one over which the hover object spans.
10727 * @note The hover object will take up the entire space of @p target
10730 * Elementary has the following styles for the hover widget:
10734 * @li hoversel_vertical
10736 * The following are the available position for content:
10748 * Signals that you can add callbacks for are:
10749 * @li "clicked" - the user clicked the empty space in the hover to dismiss
10750 * @li "smart,changed" - a content object placed under the "smart"
10751 * policy was replaced to a new slot direction.
10753 * See @ref tutorial_hover for more information.
10757 typedef enum _Elm_Hover_Axis
10759 ELM_HOVER_AXIS_NONE, /**< ELM_HOVER_AXIS_NONE -- no prefered orientation */
10760 ELM_HOVER_AXIS_HORIZONTAL, /**< ELM_HOVER_AXIS_HORIZONTAL -- horizontal */
10761 ELM_HOVER_AXIS_VERTICAL, /**< ELM_HOVER_AXIS_VERTICAL -- vertical */
10762 ELM_HOVER_AXIS_BOTH /**< ELM_HOVER_AXIS_BOTH -- both */
10765 * @brief Adds a hover object to @p parent
10767 * @param parent The parent object
10768 * @return The hover object or NULL if one could not be created
10770 EAPI Evas_Object *elm_hover_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10772 * @brief Sets the target object for the hover.
10774 * @param obj The hover object
10775 * @param target The object to center the hover onto.
10777 * This function will cause the hover to be centered on the target object.
10779 EAPI void elm_hover_target_set(Evas_Object *obj, Evas_Object *target) EINA_ARG_NONNULL(1);
10781 * @brief Gets the target object for the hover.
10783 * @param obj The hover object
10784 * @return The target object for the hover.
10786 * @see elm_hover_target_set()
10788 EAPI Evas_Object *elm_hover_target_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10790 * @brief Sets the parent object for the hover.
10792 * @param obj The hover object
10793 * @param parent The object to locate the hover over.
10795 * This function will cause the hover to take up the entire space that the
10796 * parent object fills.
10798 EAPI void elm_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
10800 * @brief Gets the parent object for the hover.
10802 * @param obj The hover object
10803 * @return The parent object to locate the hover over.
10805 * @see elm_hover_parent_set()
10807 EAPI Evas_Object *elm_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10809 * @brief Sets the content of the hover object and the direction in which it
10812 * @param obj The hover object
10813 * @param swallow The direction that the object will be displayed
10814 * at. Accepted values are "left", "top-left", "top", "top-right",
10815 * "right", "bottom-right", "bottom", "bottom-left", "middle" and
10817 * @param content The content to place at @p swallow
10819 * Once the content object is set for a given direction, a previously
10820 * set one (on the same direction) will be deleted. If you want to
10821 * keep that old content object, use the elm_hover_content_unset()
10824 * All directions may have contents at the same time, except for
10825 * "smart". This is a special placement hint and its use case
10826 * independs of the calculations coming from
10827 * elm_hover_best_content_location_get(). Its use is for cases when
10828 * one desires only one hover content, but with a dynamic special
10829 * placement within the hover area. The content's geometry, whenever
10830 * it changes, will be used to decide on a best location, not
10831 * extrapolating the hover's parent object view to show it in (still
10832 * being the hover's target determinant of its medium part -- move and
10833 * resize it to simulate finger sizes, for example). If one of the
10834 * directions other than "smart" are used, a previously content set
10835 * using it will be deleted, and vice-versa.
10837 EAPI void elm_hover_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content) EINA_ARG_NONNULL(1);
10839 * @brief Get the content of the hover object, in a given direction.
10841 * Return the content object which was set for this widget in the
10842 * @p swallow direction.
10844 * @param obj The hover object
10845 * @param swallow The direction that the object was display at.
10846 * @return The content that was being used
10848 * @see elm_hover_content_set()
10850 EAPI Evas_Object *elm_hover_content_get(const Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
10852 * @brief Unset the content of the hover object, in a given direction.
10854 * Unparent and return the content object set at @p swallow direction.
10856 * @param obj The hover object
10857 * @param swallow The direction that the object was display at.
10858 * @return The content that was being used.
10860 * @see elm_hover_content_set()
10862 EAPI Evas_Object *elm_hover_content_unset(Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
10864 * @brief Returns the best swallow location for content in the hover.
10866 * @param obj The hover object
10867 * @param pref_axis The preferred orientation axis for the hover object to use
10868 * @return The edje location to place content into the hover or @c
10871 * Best is defined here as the location at which there is the most available
10874 * @p pref_axis may be one of
10875 * - @c ELM_HOVER_AXIS_NONE -- no prefered orientation
10876 * - @c ELM_HOVER_AXIS_HORIZONTAL -- horizontal
10877 * - @c ELM_HOVER_AXIS_VERTICAL -- vertical
10878 * - @c ELM_HOVER_AXIS_BOTH -- both
10880 * If ELM_HOVER_AXIS_HORIZONTAL is choosen the returned position will
10881 * nescessarily be along the horizontal axis("left" or "right"). If
10882 * ELM_HOVER_AXIS_VERTICAL is choosen the returned position will nescessarily
10883 * be along the vertical axis("top" or "bottom"). Chossing
10884 * ELM_HOVER_AXIS_BOTH or ELM_HOVER_AXIS_NONE has the same effect and the
10885 * returned position may be in either axis.
10887 * @see elm_hover_content_set()
10889 EAPI const char *elm_hover_best_content_location_get(const Evas_Object *obj, Elm_Hover_Axis pref_axis) EINA_ARG_NONNULL(1);
10896 * @defgroup Entry Entry
10898 * @image html img/widget/entry/preview-00.png
10899 * @image latex img/widget/entry/preview-00.eps width=\textwidth
10900 * @image html img/widget/entry/preview-01.png
10901 * @image latex img/widget/entry/preview-01.eps width=\textwidth
10902 * @image html img/widget/entry/preview-02.png
10903 * @image latex img/widget/entry/preview-02.eps width=\textwidth
10904 * @image html img/widget/entry/preview-03.png
10905 * @image latex img/widget/entry/preview-03.eps width=\textwidth
10907 * An entry is a convenience widget which shows a box that the user can
10908 * enter text into. Entries by default don't scroll, so they grow to
10909 * accomodate the entire text, resizing the parent window as needed. This
10910 * can be changed with the elm_entry_scrollable_set() function.
10912 * They can also be single line or multi line (the default) and when set
10913 * to multi line mode they support text wrapping in any of the modes
10914 * indicated by #Elm_Wrap_Type.
10916 * Other features include password mode, filtering of inserted text with
10917 * elm_entry_text_filter_append() and related functions, inline "items" and
10918 * formatted markup text.
10920 * @section entry-markup Formatted text
10922 * The markup tags supported by the Entry are defined by the theme, but
10923 * even when writing new themes or extensions it's a good idea to stick to
10924 * a sane default, to maintain coherency and avoid application breakages.
10925 * Currently defined by the default theme are the following tags:
10926 * @li \<br\>: Inserts a line break.
10927 * @li \<ps\>: Inserts a paragraph separator. This is preferred over line
10929 * @li \<tab\>: Inserts a tab.
10930 * @li \<em\>...\</em\>: Emphasis. Sets the @em oblique style for the
10932 * @li \<b\>...\</b\>: Sets the @b bold style for the enclosed text.
10933 * @li \<link\>...\</link\>: Underlines the enclosed text.
10934 * @li \<hilight\>...\</hilight\>: Hilights the enclosed text.
10936 * @section entry-special Special markups
10938 * Besides those used to format text, entries support two special markup
10939 * tags used to insert clickable portions of text or items inlined within
10942 * @subsection entry-anchors Anchors
10944 * Anchors are similar to HTML anchors. Text can be surrounded by \<a\> and
10945 * \</a\> tags and an event will be generated when this text is clicked,
10949 * This text is outside <a href=anc-01>but this one is an anchor</a>
10952 * The @c href attribute in the opening tag gives the name that will be
10953 * used to identify the anchor and it can be any valid utf8 string.
10955 * When an anchor is clicked, an @c "anchor,clicked" signal is emitted with
10956 * an #Elm_Entry_Anchor_Info in the @c event_info parameter for the
10957 * callback function. The same applies for "anchor,in" (mouse in), "anchor,out"
10958 * (mouse out), "anchor,down" (mouse down), and "anchor,up" (mouse up) events on
10961 * @subsection entry-items Items
10963 * Inlined in the text, any other @c Evas_Object can be inserted by using
10964 * \<item\> tags this way:
10967 * <item size=16x16 vsize=full href=emoticon/haha></item>
10970 * Just like with anchors, the @c href identifies each item, but these need,
10971 * in addition, to indicate their size, which is done using any one of
10972 * @c size, @c absize or @c relsize attributes. These attributes take their
10973 * value in the WxH format, where W is the width and H the height of the
10976 * @li absize: Absolute pixel size for the item. Whatever value is set will
10977 * be the item's size regardless of any scale value the object may have
10978 * been set to. The final line height will be adjusted to fit larger items.
10979 * @li size: Similar to @c absize, but it's adjusted to the scale value set
10981 * @li relsize: Size is adjusted for the item to fit within the current
10984 * Besides their size, items are specificed a @c vsize value that affects
10985 * how their final size and position are calculated. The possible values
10987 * @li ascent: Item will be placed within the line's baseline and its
10988 * ascent. That is, the height between the line where all characters are
10989 * positioned and the highest point in the line. For @c size and @c absize
10990 * items, the descent value will be added to the total line height to make
10991 * them fit. @c relsize items will be adjusted to fit within this space.
10992 * @li full: Items will be placed between the descent and ascent, or the
10993 * lowest point in the line and its highest.
10995 * The next image shows different configurations of items and how
10996 * the previously mentioned options affect their sizes. In all cases,
10997 * the green line indicates the ascent, blue for the baseline and red for
11000 * @image html entry_item.png
11001 * @image latex entry_item.eps width=\textwidth
11003 * And another one to show how size differs from absize. In the first one,
11004 * the scale value is set to 1.0, while the second one is using one of 2.0.
11006 * @image html entry_item_scale.png
11007 * @image latex entry_item_scale.eps width=\textwidth
11009 * After the size for an item is calculated, the entry will request an
11010 * object to place in its space. For this, the functions set with
11011 * elm_entry_item_provider_append() and related functions will be called
11012 * in order until one of them returns a @c non-NULL value. If no providers
11013 * are available, or all of them return @c NULL, then the entry falls back
11014 * to one of the internal defaults, provided the name matches with one of
11017 * All of the following are currently supported:
11020 * - emoticon/angry-shout
11021 * - emoticon/crazy-laugh
11022 * - emoticon/evil-laugh
11024 * - emoticon/goggle-smile
11025 * - emoticon/grumpy
11026 * - emoticon/grumpy-smile
11027 * - emoticon/guilty
11028 * - emoticon/guilty-smile
11030 * - emoticon/half-smile
11031 * - emoticon/happy-panting
11033 * - emoticon/indifferent
11035 * - emoticon/knowing-grin
11037 * - emoticon/little-bit-sorry
11038 * - emoticon/love-lots
11040 * - emoticon/minimal-smile
11041 * - emoticon/not-happy
11042 * - emoticon/not-impressed
11044 * - emoticon/opensmile
11047 * - emoticon/squint-laugh
11048 * - emoticon/surprised
11049 * - emoticon/suspicious
11050 * - emoticon/tongue-dangling
11051 * - emoticon/tongue-poke
11053 * - emoticon/unhappy
11054 * - emoticon/very-sorry
11057 * - emoticon/worried
11060 * Alternatively, an item may reference an image by its path, using
11061 * the URI form @c file:///path/to/an/image.png and the entry will then
11062 * use that image for the item.
11064 * @section entry-files Loading and saving files
11066 * Entries have convinience functions to load text from a file and save
11067 * changes back to it after a short delay. The automatic saving is enabled
11068 * by default, but can be disabled with elm_entry_autosave_set() and files
11069 * can be loaded directly as plain text or have any markup in them
11070 * recognized. See elm_entry_file_set() for more details.
11072 * @section entry-signals Emitted signals
11074 * This widget emits the following signals:
11076 * @li "changed": The text within the entry was changed.
11077 * @li "changed,user": The text within the entry was changed because of user interaction.
11078 * @li "activated": The enter key was pressed on a single line entry.
11079 * @li "press": A mouse button has been pressed on the entry.
11080 * @li "longpressed": A mouse button has been pressed and held for a couple
11082 * @li "clicked": The entry has been clicked (mouse press and release).
11083 * @li "clicked,double": The entry has been double clicked.
11084 * @li "clicked,triple": The entry has been triple clicked.
11085 * @li "focused": The entry has received focus.
11086 * @li "unfocused": The entry has lost focus.
11087 * @li "selection,paste": A paste of the clipboard contents was requested.
11088 * @li "selection,copy": A copy of the selected text into the clipboard was
11090 * @li "selection,cut": A cut of the selected text into the clipboard was
11092 * @li "selection,start": A selection has begun and no previous selection
11094 * @li "selection,changed": The current selection has changed.
11095 * @li "selection,cleared": The current selection has been cleared.
11096 * @li "cursor,changed": The cursor has changed position.
11097 * @li "anchor,clicked": An anchor has been clicked. The event_info
11098 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
11099 * @li "anchor,in": Mouse cursor has moved into an anchor. The event_info
11100 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
11101 * @li "anchor,out": Mouse cursor has moved out of an anchor. The event_info
11102 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
11103 * @li "anchor,up": Mouse button has been unpressed on an anchor. The event_info
11104 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
11105 * @li "anchor,down": Mouse button has been pressed on an anchor. The event_info
11106 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
11107 * @li "preedit,changed": The preedit string has changed.
11108 * @li "language,changed": Program language changed.
11110 * @section entry-examples
11112 * An overview of the Entry API can be seen in @ref entry_example_01
11117 * @typedef Elm_Entry_Anchor_Info
11119 * The info sent in the callback for the "anchor,clicked" signals emitted
11122 typedef struct _Elm_Entry_Anchor_Info Elm_Entry_Anchor_Info;
11124 * @struct _Elm_Entry_Anchor_Info
11126 * The info sent in the callback for the "anchor,clicked" signals emitted
11129 struct _Elm_Entry_Anchor_Info
11131 const char *name; /**< The name of the anchor, as stated in its href */
11132 int button; /**< The mouse button used to click on it */
11133 Evas_Coord x, /**< Anchor geometry, relative to canvas */
11134 y, /**< Anchor geometry, relative to canvas */
11135 w, /**< Anchor geometry, relative to canvas */
11136 h; /**< Anchor geometry, relative to canvas */
11139 * @typedef Elm_Entry_Filter_Cb
11140 * This callback type is used by entry filters to modify text.
11141 * @param data The data specified as the last param when adding the filter
11142 * @param entry The entry object
11143 * @param text A pointer to the location of the text being filtered. This data can be modified,
11144 * but any additional allocations must be managed by the user.
11145 * @see elm_entry_text_filter_append
11146 * @see elm_entry_text_filter_prepend
11148 typedef void (*Elm_Entry_Filter_Cb)(void *data, Evas_Object *entry, char **text);
11151 * @typedef Elm_Entry_Change_Info
11152 * This corresponds to Edje_Entry_Change_Info. Includes information about
11153 * a change in the entry.
11155 typedef Edje_Entry_Change_Info Elm_Entry_Change_Info;
11159 * This adds an entry to @p parent object.
11161 * By default, entries are:
11165 * @li autosave is enabled
11167 * @param parent The parent object
11168 * @return The new object or NULL if it cannot be created
11170 EAPI Evas_Object *elm_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
11172 * Sets the entry to single line mode.
11174 * In single line mode, entries don't ever wrap when the text reaches the
11175 * edge, and instead they keep growing horizontally. Pressing the @c Enter
11176 * key will generate an @c "activate" event instead of adding a new line.
11178 * When @p single_line is @c EINA_FALSE, line wrapping takes effect again
11179 * and pressing enter will break the text into a different line
11180 * without generating any events.
11182 * @param obj The entry object
11183 * @param single_line If true, the text in the entry
11184 * will be on a single line.
11186 EAPI void elm_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line) EINA_ARG_NONNULL(1);
11188 * Gets whether the entry is set to be single line.
11190 * @param obj The entry object
11191 * @return single_line If true, the text in the entry is set to display
11192 * on a single line.
11194 * @see elm_entry_single_line_set()
11196 EAPI Eina_Bool elm_entry_single_line_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11198 * Sets the entry to password mode.
11200 * In password mode, entries are implicitly single line and the display of
11201 * any text in them is replaced with asterisks (*).
11203 * @param obj The entry object
11204 * @param password If true, password mode is enabled.
11206 EAPI void elm_entry_password_set(Evas_Object *obj, Eina_Bool password) EINA_ARG_NONNULL(1);
11208 * Gets whether the entry is set to password mode.
11210 * @param obj The entry object
11211 * @return If true, the entry is set to display all characters
11212 * as asterisks (*).
11214 * @see elm_entry_password_set()
11216 EAPI Eina_Bool elm_entry_password_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11218 * This sets the text displayed within the entry to @p entry.
11220 * @param obj The entry object
11221 * @param entry The text to be displayed
11223 * @deprecated Use elm_object_text_set() instead.
11224 * @note Using this function bypasses text filters
11226 EAPI void elm_entry_entry_set(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
11228 * This returns the text currently shown in object @p entry.
11229 * See also elm_entry_entry_set().
11231 * @param obj The entry object
11232 * @return The currently displayed text or NULL on failure
11234 * @deprecated Use elm_object_text_get() instead.
11236 EAPI const char *elm_entry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11238 * Appends @p entry to the text of the entry.
11240 * Adds the text in @p entry to the end of any text already present in the
11243 * The appended text is subject to any filters set for the widget.
11245 * @param obj The entry object
11246 * @param entry The text to be displayed
11248 * @see elm_entry_text_filter_append()
11250 EAPI void elm_entry_entry_append(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
11252 * Gets whether the entry is empty.
11254 * Empty means no text at all. If there are any markup tags, like an item
11255 * tag for which no provider finds anything, and no text is displayed, this
11256 * function still returns EINA_FALSE.
11258 * @param obj The entry object
11259 * @return EINA_TRUE if the entry is empty, EINA_FALSE otherwise.
11261 EAPI Eina_Bool elm_entry_is_empty(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11263 * Gets any selected text within the entry.
11265 * If there's any selected text in the entry, this function returns it as
11266 * a string in markup format. NULL is returned if no selection exists or
11267 * if an error occurred.
11269 * The returned value points to an internal string and should not be freed
11270 * or modified in any way. If the @p entry object is deleted or its
11271 * contents are changed, the returned pointer should be considered invalid.
11273 * @param obj The entry object
11274 * @return The selected text within the entry or NULL on failure
11276 EAPI const char *elm_entry_selection_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11278 * Returns the actual textblock object of the entry.
11280 * This function exposes the internal textblock object that actually
11281 * contains and draws the text. This should be used for low-level
11282 * manipulations that are otherwise not possible.
11284 * Changing the textblock directly from here will not notify edje/elm to
11285 * recalculate the textblock size automatically, so any modifications
11286 * done to the textblock returned by this function should be followed by
11287 * a call to elm_entry_calc_force().
11289 * The return value is marked as const as an additional warning.
11290 * One should not use the returned object with any of the generic evas
11291 * functions (geometry_get/resize/move and etc), but only with the textblock
11292 * functions; The former will either not work at all, or break the correct
11295 * IMPORTANT: Many functions may change (i.e delete and create a new one)
11296 * the internal textblock object. Do NOT cache the returned object, and try
11297 * not to mix calls on this object with regular elm_entry calls (which may
11298 * change the internal textblock object). This applies to all cursors
11299 * returned from textblock calls, and all the other derivative values.
11301 * @param obj The entry object
11302 * @return The textblock object.
11304 EAPI const Evas_Object *elm_entry_textblock_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11306 * Forces calculation of the entry size and text layouting.
11308 * This should be used after modifying the textblock object directly. See
11309 * elm_entry_textblock_get() for more information.
11311 * @param obj The entry object
11313 * @see elm_entry_textblock_get()
11315 EAPI void elm_entry_calc_force(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11317 * Inserts the given text into the entry at the current cursor position.
11319 * This inserts text at the cursor position as if it was typed
11320 * by the user (note that this also allows markup which a user
11321 * can't just "type" as it would be converted to escaped text, so this
11322 * call can be used to insert things like emoticon items or bold push/pop
11323 * tags, other font and color change tags etc.)
11325 * If any selection exists, it will be replaced by the inserted text.
11327 * The inserted text is subject to any filters set for the widget.
11329 * @param obj The entry object
11330 * @param entry The text to insert
11332 * @see elm_entry_text_filter_append()
11334 EAPI void elm_entry_entry_insert(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
11336 * Set the line wrap type to use on multi-line entries.
11338 * Sets the wrap type used by the entry to any of the specified in
11339 * #Elm_Wrap_Type. This tells how the text will be implicitly cut into a new
11340 * line (without inserting a line break or paragraph separator) when it
11341 * reaches the far edge of the widget.
11343 * Note that this only makes sense for multi-line entries. A widget set
11344 * to be single line will never wrap.
11346 * @param obj The entry object
11347 * @param wrap The wrap mode to use. See #Elm_Wrap_Type for details on them
11349 EAPI void elm_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
11351 * Gets the wrap mode the entry was set to use.
11353 * @param obj The entry object
11354 * @return Wrap type
11356 * @see also elm_entry_line_wrap_set()
11358 EAPI Elm_Wrap_Type elm_entry_line_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11360 * Sets if the entry is to be editable or not.
11362 * By default, entries are editable and when focused, any text input by the
11363 * user will be inserted at the current cursor position. But calling this
11364 * function with @p editable as EINA_FALSE will prevent the user from
11365 * inputting text into the entry.
11367 * The only way to change the text of a non-editable entry is to use
11368 * elm_object_text_set(), elm_entry_entry_insert() and other related
11371 * @param obj The entry object
11372 * @param editable If EINA_TRUE, user input will be inserted in the entry,
11373 * if not, the entry is read-only and no user input is allowed.
11375 EAPI void elm_entry_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
11377 * Gets whether the entry is editable or not.
11379 * @param obj The entry object
11380 * @return If true, the entry is editable by the user.
11381 * If false, it is not editable by the user
11383 * @see elm_entry_editable_set()
11385 EAPI Eina_Bool elm_entry_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11387 * This drops any existing text selection within the entry.
11389 * @param obj The entry object
11391 EAPI void elm_entry_select_none(Evas_Object *obj) EINA_ARG_NONNULL(1);
11393 * This selects all text within the entry.
11395 * @param obj The entry object
11397 EAPI void elm_entry_select_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
11399 * This moves the cursor one place to the right within the entry.
11401 * @param obj The entry object
11402 * @return EINA_TRUE upon success, EINA_FALSE upon failure
11404 EAPI Eina_Bool elm_entry_cursor_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
11406 * This moves the cursor one place to the left within the entry.
11408 * @param obj The entry object
11409 * @return EINA_TRUE upon success, EINA_FALSE upon failure
11411 EAPI Eina_Bool elm_entry_cursor_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
11413 * This moves the cursor one line up within the entry.
11415 * @param obj The entry object
11416 * @return EINA_TRUE upon success, EINA_FALSE upon failure
11418 EAPI Eina_Bool elm_entry_cursor_up(Evas_Object *obj) EINA_ARG_NONNULL(1);
11420 * This moves the cursor one line down within the entry.
11422 * @param obj The entry object
11423 * @return EINA_TRUE upon success, EINA_FALSE upon failure
11425 EAPI Eina_Bool elm_entry_cursor_down(Evas_Object *obj) EINA_ARG_NONNULL(1);
11427 * This moves the cursor to the beginning of the entry.
11429 * @param obj The entry object
11431 EAPI void elm_entry_cursor_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
11433 * This moves the cursor to the end of the entry.
11435 * @param obj The entry object
11437 EAPI void elm_entry_cursor_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
11439 * This moves the cursor to the beginning of the current line.
11441 * @param obj The entry object
11443 EAPI void elm_entry_cursor_line_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
11445 * This moves the cursor to the end of the current line.
11447 * @param obj The entry object
11449 EAPI void elm_entry_cursor_line_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
11451 * This begins a selection within the entry as though
11452 * the user were holding down the mouse button to make a selection.
11454 * @param obj The entry object
11456 EAPI void elm_entry_cursor_selection_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
11458 * This ends a selection within the entry as though
11459 * the user had just released the mouse button while making a selection.
11461 * @param obj The entry object
11463 EAPI void elm_entry_cursor_selection_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
11465 * Gets whether a format node exists at the current cursor position.
11467 * A format node is anything that defines how the text is rendered. It can
11468 * be a visible format node, such as a line break or a paragraph separator,
11469 * or an invisible one, such as bold begin or end tag.
11470 * This function returns whether any format node exists at the current
11473 * @param obj The entry object
11474 * @return EINA_TRUE if the current cursor position contains a format node,
11475 * EINA_FALSE otherwise.
11477 * @see elm_entry_cursor_is_visible_format_get()
11479 EAPI Eina_Bool elm_entry_cursor_is_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11481 * Gets if the current cursor position holds a visible format node.
11483 * @param obj The entry object
11484 * @return EINA_TRUE if the current cursor is a visible format, EINA_FALSE
11485 * if it's an invisible one or no format exists.
11487 * @see elm_entry_cursor_is_format_get()
11489 EAPI Eina_Bool elm_entry_cursor_is_visible_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11491 * Gets the character pointed by the cursor at its current position.
11493 * This function returns a string with the utf8 character stored at the
11494 * current cursor position.
11495 * Only the text is returned, any format that may exist will not be part
11496 * of the return value.
11498 * @param obj The entry object
11499 * @return The text pointed by the cursors.
11501 EAPI const char *elm_entry_cursor_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11503 * This function returns the geometry of the cursor.
11505 * It's useful if you want to draw something on the cursor (or where it is),
11506 * or for example in the case of scrolled entry where you want to show the
11509 * @param obj The entry object
11510 * @param x returned geometry
11511 * @param y returned geometry
11512 * @param w returned geometry
11513 * @param h returned geometry
11514 * @return EINA_TRUE upon success, EINA_FALSE upon failure
11516 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);
11518 * Sets the cursor position in the entry to the given value
11520 * The value in @p pos is the index of the character position within the
11521 * contents of the string as returned by elm_entry_cursor_pos_get().
11523 * @param obj The entry object
11524 * @param pos The position of the cursor
11526 EAPI void elm_entry_cursor_pos_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
11528 * Retrieves the current position of the cursor in the entry
11530 * @param obj The entry object
11531 * @return The cursor position
11533 EAPI int elm_entry_cursor_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11535 * This executes a "cut" action on the selected text in the entry.
11537 * @param obj The entry object
11539 EAPI void elm_entry_selection_cut(Evas_Object *obj) EINA_ARG_NONNULL(1);
11541 * This executes a "copy" action on the selected text in the entry.
11543 * @param obj The entry object
11545 EAPI void elm_entry_selection_copy(Evas_Object *obj) EINA_ARG_NONNULL(1);
11547 * This executes a "paste" action in the entry.
11549 * @param obj The entry object
11551 EAPI void elm_entry_selection_paste(Evas_Object *obj) EINA_ARG_NONNULL(1);
11553 * This clears and frees the items in a entry's contextual (longpress)
11556 * @param obj The entry object
11558 * @see elm_entry_context_menu_item_add()
11560 EAPI void elm_entry_context_menu_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
11562 * This adds an item to the entry's contextual menu.
11564 * A longpress on an entry will make the contextual menu show up, if this
11565 * hasn't been disabled with elm_entry_context_menu_disabled_set().
11566 * By default, this menu provides a few options like enabling selection mode,
11567 * which is useful on embedded devices that need to be explicit about it,
11568 * and when a selection exists it also shows the copy and cut actions.
11570 * With this function, developers can add other options to this menu to
11571 * perform any action they deem necessary.
11573 * @param obj The entry object
11574 * @param label The item's text label
11575 * @param icon_file The item's icon file
11576 * @param icon_type The item's icon type
11577 * @param func The callback to execute when the item is clicked
11578 * @param data The data to associate with the item for related functions
11580 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);
11582 * This disables the entry's contextual (longpress) menu.
11584 * @param obj The entry object
11585 * @param disabled If true, the menu is disabled
11587 EAPI void elm_entry_context_menu_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
11589 * This returns whether the entry's contextual (longpress) menu is
11592 * @param obj The entry object
11593 * @return If true, the menu is disabled
11595 EAPI Eina_Bool elm_entry_context_menu_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11597 * This appends a custom item provider to the list for that entry
11599 * This appends the given callback. The list is walked from beginning to end
11600 * with each function called given the item href string in the text. If the
11601 * function returns an object handle other than NULL (it should create an
11602 * object to do this), then this object is used to replace that item. If
11603 * not the next provider is called until one provides an item object, or the
11604 * default provider in entry does.
11606 * @param obj The entry object
11607 * @param func The function called to provide the item object
11608 * @param data The data passed to @p func
11610 * @see @ref entry-items
11612 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);
11614 * This prepends a custom item provider to the list for that entry
11616 * This prepends the given callback. See elm_entry_item_provider_append() for
11619 * @param obj The entry object
11620 * @param func The function called to provide the item object
11621 * @param data The data passed to @p func
11623 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);
11625 * This removes a custom item provider to the list for that entry
11627 * This removes the given callback. See elm_entry_item_provider_append() for
11630 * @param obj The entry object
11631 * @param func The function called to provide the item object
11632 * @param data The data passed to @p func
11634 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);
11636 * Append a filter function for text inserted in the entry
11638 * Append the given callback to the list. This functions will be called
11639 * whenever any text is inserted into the entry, with the text to be inserted
11640 * as a parameter. The callback function is free to alter the text in any way
11641 * it wants, but it must remember to free the given pointer and update it.
11642 * If the new text is to be discarded, the function can free it and set its
11643 * text parameter to NULL. This will also prevent any following filters from
11646 * @param obj The entry object
11647 * @param func The function to use as text filter
11648 * @param data User data to pass to @p func
11650 EAPI void elm_entry_text_filter_append(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
11652 * Prepend a filter function for text insdrted in the entry
11654 * Prepend the given callback to the list. See elm_entry_text_filter_append()
11655 * for more information
11657 * @param obj The entry object
11658 * @param func The function to use as text filter
11659 * @param data User data to pass to @p func
11661 EAPI void elm_entry_text_filter_prepend(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
11663 * Remove a filter from the list
11665 * Removes the given callback from the filter list. See
11666 * elm_entry_text_filter_append() for more information.
11668 * @param obj The entry object
11669 * @param func The filter function to remove
11670 * @param data The user data passed when adding the function
11672 EAPI void elm_entry_text_filter_remove(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
11674 * This converts a markup (HTML-like) string into UTF-8.
11676 * The returned string is a malloc'ed buffer and it should be freed when
11677 * not needed anymore.
11679 * @param s The string (in markup) to be converted
11680 * @return The converted string (in UTF-8). It should be freed.
11682 EAPI char *elm_entry_markup_to_utf8(const char *s) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
11684 * This converts a UTF-8 string into markup (HTML-like).
11686 * The returned string is a malloc'ed buffer and it should be freed when
11687 * not needed anymore.
11689 * @param s The string (in UTF-8) to be converted
11690 * @return The converted string (in markup). It should be freed.
11692 EAPI char *elm_entry_utf8_to_markup(const char *s) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
11694 * This sets the file (and implicitly loads it) for the text to display and
11695 * then edit. All changes are written back to the file after a short delay if
11696 * the entry object is set to autosave (which is the default).
11698 * If the entry had any other file set previously, any changes made to it
11699 * will be saved if the autosave feature is enabled, otherwise, the file
11700 * will be silently discarded and any non-saved changes will be lost.
11702 * @param obj The entry object
11703 * @param file The path to the file to load and save
11704 * @param format The file format
11706 EAPI void elm_entry_file_set(Evas_Object *obj, const char *file, Elm_Text_Format format) EINA_ARG_NONNULL(1);
11708 * Gets the file being edited by the entry.
11710 * This function can be used to retrieve any file set on the entry for
11711 * edition, along with the format used to load and save it.
11713 * @param obj The entry object
11714 * @param file The path to the file to load and save
11715 * @param format The file format
11717 EAPI void elm_entry_file_get(const Evas_Object *obj, const char **file, Elm_Text_Format *format) EINA_ARG_NONNULL(1);
11719 * This function writes any changes made to the file set with
11720 * elm_entry_file_set()
11722 * @param obj The entry object
11724 EAPI void elm_entry_file_save(Evas_Object *obj) EINA_ARG_NONNULL(1);
11726 * This sets the entry object to 'autosave' the loaded text file or not.
11728 * @param obj The entry object
11729 * @param autosave Autosave the loaded file or not
11731 * @see elm_entry_file_set()
11733 EAPI void elm_entry_autosave_set(Evas_Object *obj, Eina_Bool autosave) EINA_ARG_NONNULL(1);
11735 * This gets the entry object's 'autosave' status.
11737 * @param obj The entry object
11738 * @return Autosave the loaded file or not
11740 * @see elm_entry_file_set()
11742 EAPI Eina_Bool elm_entry_autosave_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11744 * Control pasting of text and images for the widget.
11746 * Normally the entry allows both text and images to be pasted. By setting
11747 * textonly to be true, this prevents images from being pasted.
11749 * Note this only changes the behaviour of text.
11751 * @param obj The entry object
11752 * @param textonly paste mode - EINA_TRUE is text only, EINA_FALSE is
11753 * text+image+other.
11755 EAPI void elm_entry_cnp_textonly_set(Evas_Object *obj, Eina_Bool textonly) EINA_ARG_NONNULL(1);
11757 * Getting elm_entry text paste/drop mode.
11759 * In textonly mode, only text may be pasted or dropped into the widget.
11761 * @param obj The entry object
11762 * @return If the widget only accepts text from pastes.
11764 EAPI Eina_Bool elm_entry_cnp_textonly_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11766 * Enable or disable scrolling in entry
11768 * Normally the entry is not scrollable unless you enable it with this call.
11770 * @param obj The entry object
11771 * @param scroll EINA_TRUE if it is to be scrollable, EINA_FALSE otherwise
11773 EAPI void elm_entry_scrollable_set(Evas_Object *obj, Eina_Bool scroll);
11775 * Get the scrollable state of the entry
11777 * Normally the entry is not scrollable. This gets the scrollable state
11778 * of the entry. See elm_entry_scrollable_set() for more information.
11780 * @param obj The entry object
11781 * @return The scrollable state
11783 EAPI Eina_Bool elm_entry_scrollable_get(const Evas_Object *obj);
11785 * This sets a widget to be displayed to the left of a scrolled entry.
11787 * @param obj The scrolled entry object
11788 * @param icon The widget to display on the left side of the scrolled
11791 * @note A previously set widget will be destroyed.
11792 * @note If the object being set does not have minimum size hints set,
11793 * it won't get properly displayed.
11795 * @see elm_entry_end_set()
11797 EAPI void elm_entry_icon_set(Evas_Object *obj, Evas_Object *icon);
11799 * Gets the leftmost widget of the scrolled entry. This object is
11800 * owned by the scrolled entry and should not be modified.
11802 * @param obj The scrolled entry object
11803 * @return the left widget inside the scroller
11805 EAPI Evas_Object *elm_entry_icon_get(const Evas_Object *obj);
11807 * Unset the leftmost widget of the scrolled entry, unparenting and
11810 * @param obj The scrolled entry object
11811 * @return the previously set icon sub-object of this entry, on
11814 * @see elm_entry_icon_set()
11816 EAPI Evas_Object *elm_entry_icon_unset(Evas_Object *obj);
11818 * Sets the visibility of the left-side widget of the scrolled entry,
11819 * set by elm_entry_icon_set().
11821 * @param obj The scrolled entry object
11822 * @param setting EINA_TRUE if the object should be displayed,
11823 * EINA_FALSE if not.
11825 EAPI void elm_entry_icon_visible_set(Evas_Object *obj, Eina_Bool setting);
11827 * This sets a widget to be displayed to the end of a scrolled entry.
11829 * @param obj The scrolled entry object
11830 * @param end The widget to display on the right side of the scrolled
11833 * @note A previously set widget will be destroyed.
11834 * @note If the object being set does not have minimum size hints set,
11835 * it won't get properly displayed.
11837 * @see elm_entry_icon_set
11839 EAPI void elm_entry_end_set(Evas_Object *obj, Evas_Object *end);
11841 * Gets the endmost widget of the scrolled entry. This object is owned
11842 * by the scrolled entry and should not be modified.
11844 * @param obj The scrolled entry object
11845 * @return the right widget inside the scroller
11847 EAPI Evas_Object *elm_entry_end_get(const Evas_Object *obj);
11849 * Unset the endmost widget of the scrolled entry, unparenting and
11852 * @param obj The scrolled entry object
11853 * @return the previously set icon sub-object of this entry, on
11856 * @see elm_entry_icon_set()
11858 EAPI Evas_Object *elm_entry_end_unset(Evas_Object *obj);
11860 * Sets the visibility of the end widget of the scrolled entry, set by
11861 * elm_entry_end_set().
11863 * @param obj The scrolled entry object
11864 * @param setting EINA_TRUE if the object should be displayed,
11865 * EINA_FALSE if not.
11867 EAPI void elm_entry_end_visible_set(Evas_Object *obj, Eina_Bool setting);
11869 * This sets the scrolled entry's scrollbar policy (ie. enabling/disabling
11872 * Setting an entry to single-line mode with elm_entry_single_line_set()
11873 * will automatically disable the display of scrollbars when the entry
11874 * moves inside its scroller.
11876 * @param obj The scrolled entry object
11877 * @param h The horizontal scrollbar policy to apply
11878 * @param v The vertical scrollbar policy to apply
11880 EAPI void elm_entry_scrollbar_policy_set(Evas_Object *obj, Elm_Scroller_Policy h, Elm_Scroller_Policy v);
11882 * This enables/disables bouncing within the entry.
11884 * This function sets whether the entry will bounce when scrolling reaches
11885 * the end of the contained entry.
11887 * @param obj The scrolled entry object
11888 * @param h The horizontal bounce state
11889 * @param v The vertical bounce state
11891 EAPI void elm_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce);
11893 * Get the bounce mode
11895 * @param obj The Entry object
11896 * @param h_bounce Allow bounce horizontally
11897 * @param v_bounce Allow bounce vertically
11899 EAPI void elm_entry_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce);
11901 /* pre-made filters for entries */
11903 * @typedef Elm_Entry_Filter_Limit_Size
11905 * Data for the elm_entry_filter_limit_size() entry filter.
11907 typedef struct _Elm_Entry_Filter_Limit_Size Elm_Entry_Filter_Limit_Size;
11909 * @struct _Elm_Entry_Filter_Limit_Size
11911 * Data for the elm_entry_filter_limit_size() entry filter.
11913 struct _Elm_Entry_Filter_Limit_Size
11915 int max_char_count; /**< The maximum number of characters allowed. */
11916 int max_byte_count; /**< The maximum number of bytes allowed*/
11919 * Filter inserted text based on user defined character and byte limits
11921 * Add this filter to an entry to limit the characters that it will accept
11922 * based the the contents of the provided #Elm_Entry_Filter_Limit_Size.
11923 * The funtion works on the UTF-8 representation of the string, converting
11924 * it from the set markup, thus not accounting for any format in it.
11926 * The user must create an #Elm_Entry_Filter_Limit_Size structure and pass
11927 * it as data when setting the filter. In it, it's possible to set limits
11928 * by character count or bytes (any of them is disabled if 0), and both can
11929 * be set at the same time. In that case, it first checks for characters,
11932 * The function will cut the inserted text in order to allow only the first
11933 * number of characters that are still allowed. The cut is made in
11934 * characters, even when limiting by bytes, in order to always contain
11935 * valid ones and avoid half unicode characters making it in.
11937 * This filter, like any others, does not apply when setting the entry text
11938 * directly with elm_object_text_set() (or the deprecated
11939 * elm_entry_entry_set()).
11941 EAPI void elm_entry_filter_limit_size(void *data, Evas_Object *entry, char **text) EINA_ARG_NONNULL(1, 2, 3);
11943 * @typedef Elm_Entry_Filter_Accept_Set
11945 * Data for the elm_entry_filter_accept_set() entry filter.
11947 typedef struct _Elm_Entry_Filter_Accept_Set Elm_Entry_Filter_Accept_Set;
11949 * @struct _Elm_Entry_Filter_Accept_Set
11951 * Data for the elm_entry_filter_accept_set() entry filter.
11953 struct _Elm_Entry_Filter_Accept_Set
11955 const char *accepted; /**< Set of characters accepted in the entry. */
11956 const char *rejected; /**< Set of characters rejected from the entry. */
11959 * Filter inserted text based on accepted or rejected sets of characters
11961 * Add this filter to an entry to restrict the set of accepted characters
11962 * based on the sets in the provided #Elm_Entry_Filter_Accept_Set.
11963 * This structure contains both accepted and rejected sets, but they are
11964 * mutually exclusive.
11966 * The @c accepted set takes preference, so if it is set, the filter will
11967 * only work based on the accepted characters, ignoring anything in the
11968 * @c rejected value. If @c accepted is @c NULL, then @c rejected is used.
11970 * In both cases, the function filters by matching utf8 characters to the
11971 * raw markup text, so it can be used to remove formatting tags.
11973 * This filter, like any others, does not apply when setting the entry text
11974 * directly with elm_object_text_set() (or the deprecated
11975 * elm_entry_entry_set()).
11977 EAPI void elm_entry_filter_accept_set(void *data, Evas_Object *entry, char **text) EINA_ARG_NONNULL(1, 3);
11979 * Set the input panel layout of the entry
11981 * @param obj The entry object
11982 * @param layout layout type
11984 EAPI void elm_entry_input_panel_layout_set(Evas_Object *obj, Elm_Input_Panel_Layout layout) EINA_ARG_NONNULL(1);
11986 * Get the input panel layout of the entry
11988 * @param obj The entry object
11989 * @return layout type
11991 * @see elm_entry_input_panel_layout_set
11993 EAPI Elm_Input_Panel_Layout elm_entry_input_panel_layout_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
11995 * Set the autocapitalization type on the immodule.
11997 * @param obj The entry object
11998 * @param autocapital_type The type of autocapitalization
12000 EAPI void elm_entry_autocapital_type_set(Evas_Object *obj, Elm_Autocapital_Type autocapital_type) EINA_ARG_NONNULL(1);
12002 * Retrieve the autocapitalization type on the immodule.
12004 * @param obj The entry object
12005 * @return autocapitalization type
12007 EAPI Elm_Autocapital_Type elm_entry_autocapital_type_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
12009 * Sets the attribute to show the input panel automatically.
12011 * @param obj The entry object
12012 * @param enabled If true, the input panel is appeared when entry is clicked or has a focus
12014 EAPI void elm_entry_input_panel_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
12016 * Retrieve the attribute to show the input panel automatically.
12018 * @param obj The entry object
12019 * @return EINA_TRUE if input panel will be appeared when the entry is clicked or has a focus, EINA_FALSE otherwise
12021 EAPI Eina_Bool elm_entry_input_panel_enabled_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
12027 /* composite widgets - these basically put together basic widgets above
12028 * in convenient packages that do more than basic stuff */
12032 * @defgroup Anchorview Anchorview
12034 * @image html img/widget/anchorview/preview-00.png
12035 * @image latex img/widget/anchorview/preview-00.eps
12037 * Anchorview is for displaying text that contains markup with anchors
12038 * like <c>\<a href=1234\>something\</\></c> in it.
12040 * Besides being styled differently, the anchorview widget provides the
12041 * necessary functionality so that clicking on these anchors brings up a
12042 * popup with user defined content such as "call", "add to contacts" or
12043 * "open web page". This popup is provided using the @ref Hover widget.
12045 * This widget is very similar to @ref Anchorblock, so refer to that
12046 * widget for an example. The only difference Anchorview has is that the
12047 * widget is already provided with scrolling functionality, so if the
12048 * text set to it is too large to fit in the given space, it will scroll,
12049 * whereas the @ref Anchorblock widget will keep growing to ensure all the
12050 * text can be displayed.
12052 * This widget emits the following signals:
12053 * @li "anchor,clicked": will be called when an anchor is clicked. The
12054 * @p event_info parameter on the callback will be a pointer of type
12055 * ::Elm_Entry_Anchorview_Info.
12057 * See @ref Anchorblock for an example on how to use both of them.
12066 * @typedef Elm_Entry_Anchorview_Info
12068 * The info sent in the callback for "anchor,clicked" signals emitted by
12069 * the Anchorview widget.
12071 typedef struct _Elm_Entry_Anchorview_Info Elm_Entry_Anchorview_Info;
12073 * @struct _Elm_Entry_Anchorview_Info
12075 * The info sent in the callback for "anchor,clicked" signals emitted by
12076 * the Anchorview widget.
12078 struct _Elm_Entry_Anchorview_Info
12080 const char *name; /**< Name of the anchor, as indicated in its href
12082 int button; /**< The mouse button used to click on it */
12083 Evas_Object *hover; /**< The hover object to use for the popup */
12085 Evas_Coord x, y, w, h;
12086 } anchor, /**< Geometry selection of text used as anchor */
12087 hover_parent; /**< Geometry of the object used as parent by the
12089 Eina_Bool hover_left : 1; /**< Hint indicating if there's space
12090 for content on the left side of
12091 the hover. Before calling the
12092 callback, the widget will make the
12093 necessary calculations to check
12094 which sides are fit to be set with
12095 content, based on the position the
12096 hover is activated and its distance
12097 to the edges of its parent object
12099 Eina_Bool hover_right : 1; /**< Hint indicating content fits on
12100 the right side of the hover.
12101 See @ref hover_left */
12102 Eina_Bool hover_top : 1; /**< Hint indicating content fits on top
12103 of the hover. See @ref hover_left */
12104 Eina_Bool hover_bottom : 1; /**< Hint indicating content fits
12105 below the hover. See @ref
12109 * Add a new Anchorview object
12111 * @param parent The parent object
12112 * @return The new object or NULL if it cannot be created
12114 EAPI Evas_Object *elm_anchorview_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12116 * Set the text to show in the anchorview
12118 * Sets the text of the anchorview to @p text. This text can include markup
12119 * format tags, including <c>\<a href=anchorname\></c> to begin a segment of
12120 * text that will be specially styled and react to click events, ended with
12121 * either of \</a\> or \</\>. When clicked, the anchor will emit an
12122 * "anchor,clicked" signal that you can attach a callback to with
12123 * evas_object_smart_callback_add(). The name of the anchor given in the
12124 * event info struct will be the one set in the href attribute, in this
12125 * case, anchorname.
12127 * Other markup can be used to style the text in different ways, but it's
12128 * up to the style defined in the theme which tags do what.
12129 * @deprecated use elm_object_text_set() instead.
12131 EINA_DEPRECATED EAPI void elm_anchorview_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1);
12133 * Get the markup text set for the anchorview
12135 * Retrieves the text set on the anchorview, with markup tags included.
12137 * @param obj The anchorview object
12138 * @return The markup text set or @c NULL if nothing was set or an error
12140 * @deprecated use elm_object_text_set() instead.
12142 EINA_DEPRECATED EAPI const char *elm_anchorview_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12144 * Set the parent of the hover popup
12146 * Sets the parent object to use by the hover created by the anchorview
12147 * when an anchor is clicked. See @ref Hover for more details on this.
12148 * If no parent is set, the same anchorview object will be used.
12150 * @param obj The anchorview object
12151 * @param parent The object to use as parent for the hover
12153 EAPI void elm_anchorview_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
12155 * Get the parent of the hover popup
12157 * Get the object used as parent for the hover created by the anchorview
12158 * widget. See @ref Hover for more details on this.
12160 * @param obj The anchorview object
12161 * @return The object used as parent for the hover, NULL if none is set.
12163 EAPI Evas_Object *elm_anchorview_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12165 * Set the style that the hover should use
12167 * When creating the popup hover, anchorview will request that it's
12168 * themed according to @p style.
12170 * @param obj The anchorview object
12171 * @param style The style to use for the underlying hover
12173 * @see elm_object_style_set()
12175 EAPI void elm_anchorview_hover_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
12177 * Get the style that the hover should use
12179 * Get the style the hover created by anchorview will use.
12181 * @param obj The anchorview object
12182 * @return The style to use by the hover. NULL means the default is used.
12184 * @see elm_object_style_set()
12186 EAPI const char *elm_anchorview_hover_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12188 * Ends the hover popup in the anchorview
12190 * When an anchor is clicked, the anchorview widget will create a hover
12191 * object to use as a popup with user provided content. This function
12192 * terminates this popup, returning the anchorview to its normal state.
12194 * @param obj The anchorview object
12196 EAPI void elm_anchorview_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
12198 * Set bouncing behaviour when the scrolled content reaches an edge
12200 * Tell the internal scroller object whether it should bounce or not
12201 * when it reaches the respective edges for each axis.
12203 * @param obj The anchorview object
12204 * @param h_bounce Whether to bounce or not in the horizontal axis
12205 * @param v_bounce Whether to bounce or not in the vertical axis
12207 * @see elm_scroller_bounce_set()
12209 EAPI void elm_anchorview_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
12211 * Get the set bouncing behaviour of the internal scroller
12213 * Get whether the internal scroller should bounce when the edge of each
12214 * axis is reached scrolling.
12216 * @param obj The anchorview object
12217 * @param h_bounce Pointer where to store the bounce state of the horizontal
12219 * @param v_bounce Pointer where to store the bounce state of the vertical
12222 * @see elm_scroller_bounce_get()
12224 EAPI void elm_anchorview_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
12226 * Appends a custom item provider to the given anchorview
12228 * Appends the given function to the list of items providers. This list is
12229 * called, one function at a time, with the given @p data pointer, the
12230 * anchorview object and, in the @p item parameter, the item name as
12231 * referenced in its href string. Following functions in the list will be
12232 * called in order until one of them returns something different to NULL,
12233 * which should be an Evas_Object which will be used in place of the item
12236 * Items in the markup text take the form \<item relsize=16x16 vsize=full
12237 * href=item/name\>\</item\>
12239 * @param obj The anchorview object
12240 * @param func The function to add to the list of providers
12241 * @param data User data that will be passed to the callback function
12243 * @see elm_entry_item_provider_append()
12245 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);
12247 * Prepend a custom item provider to the given anchorview
12249 * Like elm_anchorview_item_provider_append(), but it adds the function
12250 * @p func to the beginning of the list, instead of the end.
12252 * @param obj The anchorview object
12253 * @param func The function to add to the list of providers
12254 * @param data User data that will be passed to the callback function
12256 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);
12258 * Remove a custom item provider from the list of the given anchorview
12260 * Removes the function and data pairing that matches @p func and @p data.
12261 * That is, unless the same function and same user data are given, the
12262 * function will not be removed from the list. This allows us to add the
12263 * same callback several times, with different @p data pointers and be
12264 * able to remove them later without conflicts.
12266 * @param obj The anchorview object
12267 * @param func The function to remove from the list
12268 * @param data The data matching the function to remove from the list
12270 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);
12277 * @defgroup Anchorblock Anchorblock
12279 * @image html img/widget/anchorblock/preview-00.png
12280 * @image latex img/widget/anchorblock/preview-00.eps
12282 * Anchorblock is for displaying text that contains markup with anchors
12283 * like <c>\<a href=1234\>something\</\></c> in it.
12285 * Besides being styled differently, the anchorblock widget provides the
12286 * necessary functionality so that clicking on these anchors brings up a
12287 * popup with user defined content such as "call", "add to contacts" or
12288 * "open web page". This popup is provided using the @ref Hover widget.
12290 * This widget emits the following signals:
12291 * @li "anchor,clicked": will be called when an anchor is clicked. The
12292 * @p event_info parameter on the callback will be a pointer of type
12293 * ::Elm_Entry_Anchorblock_Info.
12299 * Since examples are usually better than plain words, we might as well
12300 * try @ref tutorial_anchorblock_example "one".
12303 * @addtogroup Anchorblock
12307 * @typedef Elm_Entry_Anchorblock_Info
12309 * The info sent in the callback for "anchor,clicked" signals emitted by
12310 * the Anchorblock widget.
12312 typedef struct _Elm_Entry_Anchorblock_Info Elm_Entry_Anchorblock_Info;
12314 * @struct _Elm_Entry_Anchorblock_Info
12316 * The info sent in the callback for "anchor,clicked" signals emitted by
12317 * the Anchorblock widget.
12319 struct _Elm_Entry_Anchorblock_Info
12321 const char *name; /**< Name of the anchor, as indicated in its href
12323 int button; /**< The mouse button used to click on it */
12324 Evas_Object *hover; /**< The hover object to use for the popup */
12326 Evas_Coord x, y, w, h;
12327 } anchor, /**< Geometry selection of text used as anchor */
12328 hover_parent; /**< Geometry of the object used as parent by the
12330 Eina_Bool hover_left : 1; /**< Hint indicating if there's space
12331 for content on the left side of
12332 the hover. Before calling the
12333 callback, the widget will make the
12334 necessary calculations to check
12335 which sides are fit to be set with
12336 content, based on the position the
12337 hover is activated and its distance
12338 to the edges of its parent object
12340 Eina_Bool hover_right : 1; /**< Hint indicating content fits on
12341 the right side of the hover.
12342 See @ref hover_left */
12343 Eina_Bool hover_top : 1; /**< Hint indicating content fits on top
12344 of the hover. See @ref hover_left */
12345 Eina_Bool hover_bottom : 1; /**< Hint indicating content fits
12346 below the hover. See @ref
12350 * Add a new Anchorblock object
12352 * @param parent The parent object
12353 * @return The new object or NULL if it cannot be created
12355 EAPI Evas_Object *elm_anchorblock_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12357 * Set the text to show in the anchorblock
12359 * Sets the text of the anchorblock to @p text. This text can include markup
12360 * format tags, including <c>\<a href=anchorname\></a></c> to begin a segment
12361 * of text that will be specially styled and react to click events, ended
12362 * with either of \</a\> or \</\>. When clicked, the anchor will emit an
12363 * "anchor,clicked" signal that you can attach a callback to with
12364 * evas_object_smart_callback_add(). The name of the anchor given in the
12365 * event info struct will be the one set in the href attribute, in this
12366 * case, anchorname.
12368 * Other markup can be used to style the text in different ways, but it's
12369 * up to the style defined in the theme which tags do what.
12370 * @deprecated use elm_object_text_set() instead.
12372 EINA_DEPRECATED EAPI void elm_anchorblock_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1);
12374 * Get the markup text set for the anchorblock
12376 * Retrieves the text set on the anchorblock, with markup tags included.
12378 * @param obj The anchorblock object
12379 * @return The markup text set or @c NULL if nothing was set or an error
12381 * @deprecated use elm_object_text_set() instead.
12383 EINA_DEPRECATED EAPI const char *elm_anchorblock_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12385 * Set the parent of the hover popup
12387 * Sets the parent object to use by the hover created by the anchorblock
12388 * when an anchor is clicked. See @ref Hover for more details on this.
12390 * @param obj The anchorblock object
12391 * @param parent The object to use as parent for the hover
12393 EAPI void elm_anchorblock_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
12395 * Get the parent of the hover popup
12397 * Get the object used as parent for the hover created by the anchorblock
12398 * widget. See @ref Hover for more details on this.
12399 * If no parent is set, the same anchorblock object will be used.
12401 * @param obj The anchorblock object
12402 * @return The object used as parent for the hover, NULL if none is set.
12404 EAPI Evas_Object *elm_anchorblock_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12406 * Set the style that the hover should use
12408 * When creating the popup hover, anchorblock will request that it's
12409 * themed according to @p style.
12411 * @param obj The anchorblock object
12412 * @param style The style to use for the underlying hover
12414 * @see elm_object_style_set()
12416 EAPI void elm_anchorblock_hover_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
12418 * Get the style that the hover should use
12420 * Get the style, the hover created by anchorblock will use.
12422 * @param obj The anchorblock object
12423 * @return The style to use by the hover. NULL means the default is used.
12425 * @see elm_object_style_set()
12427 EAPI const char *elm_anchorblock_hover_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12429 * Ends the hover popup in the anchorblock
12431 * When an anchor is clicked, the anchorblock widget will create a hover
12432 * object to use as a popup with user provided content. This function
12433 * terminates this popup, returning the anchorblock to its normal state.
12435 * @param obj The anchorblock object
12437 EAPI void elm_anchorblock_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
12439 * Appends a custom item provider to the given anchorblock
12441 * Appends the given function to the list of items providers. This list is
12442 * called, one function at a time, with the given @p data pointer, the
12443 * anchorblock object and, in the @p item parameter, the item name as
12444 * referenced in its href string. Following functions in the list will be
12445 * called in order until one of them returns something different to NULL,
12446 * which should be an Evas_Object which will be used in place of the item
12449 * Items in the markup text take the form \<item relsize=16x16 vsize=full
12450 * href=item/name\>\</item\>
12452 * @param obj The anchorblock object
12453 * @param func The function to add to the list of providers
12454 * @param data User data that will be passed to the callback function
12456 * @see elm_entry_item_provider_append()
12458 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);
12460 * Prepend a custom item provider to the given anchorblock
12462 * Like elm_anchorblock_item_provider_append(), but it adds the function
12463 * @p func to the beginning of the list, instead of the end.
12465 * @param obj The anchorblock object
12466 * @param func The function to add to the list of providers
12467 * @param data User data that will be passed to the callback function
12469 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);
12471 * Remove a custom item provider from the list of the given anchorblock
12473 * Removes the function and data pairing that matches @p func and @p data.
12474 * That is, unless the same function and same user data are given, the
12475 * function will not be removed from the list. This allows us to add the
12476 * same callback several times, with different @p data pointers and be
12477 * able to remove them later without conflicts.
12479 * @param obj The anchorblock object
12480 * @param func The function to remove from the list
12481 * @param data The data matching the function to remove from the list
12483 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);
12489 * @defgroup Bubble Bubble
12491 * @image html img/widget/bubble/preview-00.png
12492 * @image latex img/widget/bubble/preview-00.eps
12493 * @image html img/widget/bubble/preview-01.png
12494 * @image latex img/widget/bubble/preview-01.eps
12495 * @image html img/widget/bubble/preview-02.png
12496 * @image latex img/widget/bubble/preview-02.eps
12498 * @brief The Bubble is a widget to show text similar to how speech is
12499 * represented in comics.
12501 * The bubble widget contains 5 important visual elements:
12502 * @li The frame is a rectangle with rounded edjes and an "arrow".
12503 * @li The @p icon is an image to which the frame's arrow points to.
12504 * @li The @p label is a text which appears to the right of the icon if the
12505 * corner is "top_left" or "bottom_left" and is right aligned to the frame
12507 * @li The @p info is a text which appears to the right of the label. Info's
12508 * font is of a ligther color than label.
12509 * @li The @p content is an evas object that is shown inside the frame.
12511 * The position of the arrow, icon, label and info depends on which corner is
12512 * selected. The four available corners are:
12513 * @li "top_left" - Default
12515 * @li "bottom_left"
12516 * @li "bottom_right"
12518 * Signals that you can add callbacks for are:
12519 * @li "clicked" - This is called when a user has clicked the bubble.
12521 * Default contents parts of the bubble that you can use for are:
12522 * @li "default" - A content of the bubble
12523 * @li "icon" - An icon of the bubble
12525 * Default text parts of the button widget that you can use for are:
12526 * @li NULL - Label of the bubble
12528 * For an example of using a buble see @ref bubble_01_example_page "this".
12534 * Add a new bubble to the parent
12536 * @param parent The parent object
12537 * @return The new object or NULL if it cannot be created
12539 * This function adds a text bubble to the given parent evas object.
12541 EAPI Evas_Object *elm_bubble_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12543 * Set the label of the bubble
12545 * @param obj The bubble object
12546 * @param label The string to set in the label
12548 * This function sets the title of the bubble. Where this appears depends on
12549 * the selected corner.
12550 * @deprecated use elm_object_text_set() instead.
12552 EINA_DEPRECATED EAPI void elm_bubble_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
12554 * Get the label of the bubble
12556 * @param obj The bubble object
12557 * @return The string of set in the label
12559 * This function gets the title of the bubble.
12560 * @deprecated use elm_object_text_get() instead.
12562 EINA_DEPRECATED EAPI const char *elm_bubble_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12564 * Set the info of the bubble
12566 * @param obj The bubble object
12567 * @param info The given info about the bubble
12569 * This function sets the info of the bubble. Where this appears depends on
12570 * the selected corner.
12571 * @deprecated use elm_object_part_text_set() instead. (with "info" as the parameter).
12573 EINA_DEPRECATED EAPI void elm_bubble_info_set(Evas_Object *obj, const char *info) EINA_ARG_NONNULL(1);
12575 * Get the info of the bubble
12577 * @param obj The bubble object
12579 * @return The "info" string of the bubble
12581 * This function gets the info text.
12582 * @deprecated use elm_object_part_text_get() instead. (with "info" as the parameter).
12584 EINA_DEPRECATED EAPI const char *elm_bubble_info_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12586 * Set the content to be shown in the bubble
12588 * Once the content object is set, a previously set one will be deleted.
12589 * If you want to keep the old content object, use the
12590 * elm_bubble_content_unset() function.
12592 * @param obj The bubble object
12593 * @param content The given content of the bubble
12595 * This function sets the content shown on the middle of the bubble.
12597 * @deprecated use elm_object_content_set() instead
12600 EINA_DEPRECATED EAPI void elm_bubble_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
12602 * Get the content shown in the bubble
12604 * Return the content object which is set for this widget.
12606 * @param obj The bubble object
12607 * @return The content that is being used
12609 * @deprecated use elm_object_content_get() instead
12612 EINA_DEPRECATED EAPI Evas_Object *elm_bubble_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12614 * Unset the content shown in the bubble
12616 * Unparent and return the content object which was set for this widget.
12618 * @param obj The bubble object
12619 * @return The content that was being used
12621 * @deprecated use elm_object_content_unset() instead
12624 EINA_DEPRECATED EAPI Evas_Object *elm_bubble_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
12626 * Set the icon of the bubble
12628 * Once the icon object is set, a previously set one will be deleted.
12629 * If you want to keep the old content object, use the
12630 * elm_icon_content_unset() function.
12632 * @param obj The bubble object
12633 * @param icon The given icon for the bubble
12635 * @deprecated use elm_object_part_content_set() instead
12638 EINA_DEPRECATED EAPI void elm_bubble_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
12640 * Get the icon of the bubble
12642 * @param obj The bubble object
12643 * @return The icon for the bubble
12645 * This function gets the icon shown on the top left of bubble.
12647 * @deprecated use elm_object_part_content_get() instead
12650 EINA_DEPRECATED EAPI Evas_Object *elm_bubble_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12652 * Unset the icon of the bubble
12654 * Unparent and return the icon object which was set for this widget.
12656 * @param obj The bubble object
12657 * @return The icon that was being used
12659 * @deprecated use elm_object_part_content_unset() instead
12662 EINA_DEPRECATED EAPI Evas_Object *elm_bubble_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
12664 * Set the corner of the bubble
12666 * @param obj The bubble object.
12667 * @param corner The given corner for the bubble.
12669 * This function sets the corner of the bubble. The corner will be used to
12670 * determine where the arrow in the frame points to and where label, icon and
12673 * Possible values for corner are:
12674 * @li "top_left" - Default
12676 * @li "bottom_left"
12677 * @li "bottom_right"
12679 EAPI void elm_bubble_corner_set(Evas_Object *obj, const char *corner) EINA_ARG_NONNULL(1, 2);
12681 * Get the corner of the bubble
12683 * @param obj The bubble object.
12684 * @return The given corner for the bubble.
12686 * This function gets the selected corner of the bubble.
12688 EAPI const char *elm_bubble_corner_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12694 * @defgroup Photo Photo
12696 * For displaying the photo of a person (contact). Simple, yet
12697 * with a very specific purpose.
12699 * Signals that you can add callbacks for are:
12701 * "clicked" - This is called when a user has clicked the photo
12702 * "drag,start" - Someone started dragging the image out of the object
12703 * "drag,end" - Dragged item was dropped (somewhere)
12709 * Add a new photo to the parent
12711 * @param parent The parent object
12712 * @return The new object or NULL if it cannot be created
12716 EAPI Evas_Object *elm_photo_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12719 * Set the file that will be used as photo
12721 * @param obj The photo object
12722 * @param file The path to file that will be used as photo
12724 * @return (1 = success, 0 = error)
12728 EAPI Eina_Bool elm_photo_file_set(Evas_Object *obj, const char *file) EINA_ARG_NONNULL(1);
12731 * Set the file that will be used as thumbnail in the photo.
12733 * @param obj The photo object.
12734 * @param file The path to file that will be used as thumb.
12735 * @param group The key used in case of an EET file.
12739 EAPI void elm_photo_thumb_set(const Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
12742 * Set the size that will be used on the photo
12744 * @param obj The photo object
12745 * @param size The size that the photo will be
12749 EAPI void elm_photo_size_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
12752 * Set if the photo should be completely visible or not.
12754 * @param obj The photo object
12755 * @param fill if true the photo will be completely visible
12759 EAPI void elm_photo_fill_inside_set(Evas_Object *obj, Eina_Bool fill) EINA_ARG_NONNULL(1);
12762 * Set editability of the photo.
12764 * An editable photo can be dragged to or from, and can be cut or
12765 * pasted too. Note that pasting an image or dropping an item on
12766 * the image will delete the existing content.
12768 * @param obj The photo object.
12769 * @param set To set of clear editablity.
12771 EAPI void elm_photo_editable_set(Evas_Object *obj, Eina_Bool set) EINA_ARG_NONNULL(1);
12777 /* gesture layer */
12779 * @defgroup Elm_Gesture_Layer Gesture Layer
12780 * Gesture Layer Usage:
12782 * Use Gesture Layer to detect gestures.
12783 * The advantage is that you don't have to implement
12784 * gesture detection, just set callbacks of gesture state.
12785 * By using gesture layer we make standard interface.
12787 * In order to use Gesture Layer you start with @ref elm_gesture_layer_add
12788 * with a parent object parameter.
12789 * Next 'activate' gesture layer with a @ref elm_gesture_layer_attach
12790 * call. Usually with same object as target (2nd parameter).
12792 * Now you need to tell gesture layer what gestures you follow.
12793 * This is done with @ref elm_gesture_layer_cb_set call.
12794 * By setting the callback you actually saying to gesture layer:
12795 * I would like to know when the gesture @ref Elm_Gesture_Types
12796 * switches to state @ref Elm_Gesture_State.
12798 * Next, you need to implement the actual action that follows the input
12799 * in your callback.
12801 * Note that if you like to stop being reported about a gesture, just set
12802 * all callbacks referring this gesture to NULL.
12803 * (again with @ref elm_gesture_layer_cb_set)
12805 * The information reported by gesture layer to your callback is depending
12806 * on @ref Elm_Gesture_Types:
12807 * @ref Elm_Gesture_Taps_Info is the info reported for tap gestures:
12808 * @ref ELM_GESTURE_N_TAPS, @ref ELM_GESTURE_N_LONG_TAPS,
12809 * @ref ELM_GESTURE_N_DOUBLE_TAPS, @ref ELM_GESTURE_N_TRIPLE_TAPS.
12811 * @ref Elm_Gesture_Momentum_Info is info reported for momentum gestures:
12812 * @ref ELM_GESTURE_MOMENTUM.
12814 * @ref Elm_Gesture_Line_Info is the info reported for line gestures:
12815 * (this also contains @ref Elm_Gesture_Momentum_Info internal structure)
12816 * @ref ELM_GESTURE_N_LINES, @ref ELM_GESTURE_N_FLICKS.
12817 * Note that we consider a flick as a line-gesture that should be completed
12818 * in flick-time-limit as defined in @ref Config.
12820 * @ref Elm_Gesture_Zoom_Info is the info reported for @ref ELM_GESTURE_ZOOM gesture.
12822 * @ref Elm_Gesture_Rotate_Info is the info reported for @ref ELM_GESTURE_ROTATE gesture.
12825 * Gesture Layer Tweaks:
12827 * Note that line, flick, gestures can start without the need to remove fingers from surface.
12828 * When user fingers rests on same-spot gesture is ended and starts again when fingers moved.
12830 * Setting glayer_continues_enable to false in @ref Config will change this behavior
12831 * so gesture starts when user touches (a *DOWN event) touch-surface
12832 * and ends when no fingers touches surface (a *UP event).
12836 * @enum _Elm_Gesture_Types
12837 * Enum of supported gesture types.
12838 * @ingroup Elm_Gesture_Layer
12840 enum _Elm_Gesture_Types
12842 ELM_GESTURE_FIRST = 0,
12844 ELM_GESTURE_N_TAPS, /**< N fingers single taps */
12845 ELM_GESTURE_N_LONG_TAPS, /**< N fingers single long-taps */
12846 ELM_GESTURE_N_DOUBLE_TAPS, /**< N fingers double-single taps */
12847 ELM_GESTURE_N_TRIPLE_TAPS, /**< N fingers triple-single taps */
12849 ELM_GESTURE_MOMENTUM, /**< Reports momentum in the dircetion of move */
12851 ELM_GESTURE_N_LINES, /**< N fingers line gesture */
12852 ELM_GESTURE_N_FLICKS, /**< N fingers flick gesture */
12854 ELM_GESTURE_ZOOM, /**< Zoom */
12855 ELM_GESTURE_ROTATE, /**< Rotate */
12861 * @typedef Elm_Gesture_Types
12862 * gesture types enum
12863 * @ingroup Elm_Gesture_Layer
12865 typedef enum _Elm_Gesture_Types Elm_Gesture_Types;
12868 * @enum _Elm_Gesture_State
12869 * Enum of gesture states.
12870 * @ingroup Elm_Gesture_Layer
12872 enum _Elm_Gesture_State
12874 ELM_GESTURE_STATE_UNDEFINED = -1, /**< Gesture not STARTed */
12875 ELM_GESTURE_STATE_START, /**< Gesture STARTed */
12876 ELM_GESTURE_STATE_MOVE, /**< Gesture is ongoing */
12877 ELM_GESTURE_STATE_END, /**< Gesture completed */
12878 ELM_GESTURE_STATE_ABORT /**< Onging gesture was ABORTed */
12882 * @typedef Elm_Gesture_State
12883 * gesture states enum
12884 * @ingroup Elm_Gesture_Layer
12886 typedef enum _Elm_Gesture_State Elm_Gesture_State;
12889 * @struct _Elm_Gesture_Taps_Info
12890 * Struct holds taps info for user
12891 * @ingroup Elm_Gesture_Layer
12893 struct _Elm_Gesture_Taps_Info
12895 Evas_Coord x, y; /**< Holds center point between fingers */
12896 unsigned int n; /**< Number of fingers tapped */
12897 unsigned int timestamp; /**< event timestamp */
12901 * @typedef Elm_Gesture_Taps_Info
12902 * holds taps info for user
12903 * @ingroup Elm_Gesture_Layer
12905 typedef struct _Elm_Gesture_Taps_Info Elm_Gesture_Taps_Info;
12908 * @struct _Elm_Gesture_Momentum_Info
12909 * Struct holds momentum info for user
12910 * x1 and y1 are not necessarily in sync
12911 * x1 holds x value of x direction starting point
12912 * and same holds for y1.
12913 * This is noticeable when doing V-shape movement
12914 * @ingroup Elm_Gesture_Layer
12916 struct _Elm_Gesture_Momentum_Info
12917 { /* Report line ends, timestamps, and momentum computed */
12918 Evas_Coord x1; /**< Final-swipe direction starting point on X */
12919 Evas_Coord y1; /**< Final-swipe direction starting point on Y */
12920 Evas_Coord x2; /**< Final-swipe direction ending point on X */
12921 Evas_Coord y2; /**< Final-swipe direction ending point on Y */
12923 unsigned int tx; /**< Timestamp of start of final x-swipe */
12924 unsigned int ty; /**< Timestamp of start of final y-swipe */
12926 Evas_Coord mx; /**< Momentum on X */
12927 Evas_Coord my; /**< Momentum on Y */
12929 unsigned int n; /**< Number of fingers */
12933 * @typedef Elm_Gesture_Momentum_Info
12934 * holds momentum info for user
12935 * @ingroup Elm_Gesture_Layer
12937 typedef struct _Elm_Gesture_Momentum_Info Elm_Gesture_Momentum_Info;
12940 * @struct _Elm_Gesture_Line_Info
12941 * Struct holds line info for user
12942 * @ingroup Elm_Gesture_Layer
12944 struct _Elm_Gesture_Line_Info
12945 { /* Report line ends, timestamps, and momentum computed */
12946 Elm_Gesture_Momentum_Info momentum; /**< Line momentum info */
12947 double angle; /**< Angle (direction) of lines */
12951 * @typedef Elm_Gesture_Line_Info
12952 * Holds line info for user
12953 * @ingroup Elm_Gesture_Layer
12955 typedef struct _Elm_Gesture_Line_Info Elm_Gesture_Line_Info;
12958 * @struct _Elm_Gesture_Zoom_Info
12959 * Struct holds zoom info for user
12960 * @ingroup Elm_Gesture_Layer
12962 struct _Elm_Gesture_Zoom_Info
12964 Evas_Coord x, y; /**< Holds zoom center point reported to user */
12965 Evas_Coord radius; /**< Holds radius between fingers reported to user */
12966 double zoom; /**< Zoom value: 1.0 means no zoom */
12967 double momentum; /**< Zoom momentum: zoom growth per second (NOT YET SUPPORTED) */
12971 * @typedef Elm_Gesture_Zoom_Info
12972 * Holds zoom info for user
12973 * @ingroup Elm_Gesture_Layer
12975 typedef struct _Elm_Gesture_Zoom_Info Elm_Gesture_Zoom_Info;
12978 * @struct _Elm_Gesture_Rotate_Info
12979 * Struct holds rotation info for user
12980 * @ingroup Elm_Gesture_Layer
12982 struct _Elm_Gesture_Rotate_Info
12984 Evas_Coord x, y; /**< Holds zoom center point reported to user */
12985 Evas_Coord radius; /**< Holds radius between fingers reported to user */
12986 double base_angle; /**< Holds start-angle */
12987 double angle; /**< Rotation value: 0.0 means no rotation */
12988 double momentum; /**< Rotation momentum: rotation done per second (NOT YET SUPPORTED) */
12992 * @typedef Elm_Gesture_Rotate_Info
12993 * Holds rotation info for user
12994 * @ingroup Elm_Gesture_Layer
12996 typedef struct _Elm_Gesture_Rotate_Info Elm_Gesture_Rotate_Info;
12999 * @typedef Elm_Gesture_Event_Cb
13000 * User callback used to stream gesture info from gesture layer
13001 * @param data user data
13002 * @param event_info gesture report info
13003 * Returns a flag field to be applied on the causing event.
13004 * You should probably return EVAS_EVENT_FLAG_ON_HOLD if your widget acted
13005 * upon the event, in an irreversible way.
13007 * @ingroup Elm_Gesture_Layer
13009 typedef Evas_Event_Flags (*Elm_Gesture_Event_Cb) (void *data, void *event_info);
13012 * Use function to set callbacks to be notified about
13013 * change of state of gesture.
13014 * When a user registers a callback with this function
13015 * this means this gesture has to be tested.
13017 * When ALL callbacks for a gesture are set to NULL
13018 * it means user isn't interested in gesture-state
13019 * and it will not be tested.
13021 * @param obj Pointer to gesture-layer.
13022 * @param idx The gesture you would like to track its state.
13023 * @param cb callback function pointer.
13024 * @param cb_type what event this callback tracks: START, MOVE, END, ABORT.
13025 * @param data user info to be sent to callback (usually, Smart Data)
13027 * @ingroup Elm_Gesture_Layer
13029 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);
13032 * Call this function to get repeat-events settings.
13034 * @param obj Pointer to gesture-layer.
13036 * @return repeat events settings.
13037 * @see elm_gesture_layer_hold_events_set()
13038 * @ingroup Elm_Gesture_Layer
13040 EAPI Eina_Bool elm_gesture_layer_hold_events_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
13043 * This function called in order to make gesture-layer repeat events.
13044 * Set this of you like to get the raw events only if gestures were not detected.
13045 * Clear this if you like gesture layer to fwd events as testing gestures.
13047 * @param obj Pointer to gesture-layer.
13048 * @param r Repeat: TRUE/FALSE
13050 * @ingroup Elm_Gesture_Layer
13052 EAPI void elm_gesture_layer_hold_events_set(Evas_Object *obj, Eina_Bool r) EINA_ARG_NONNULL(1);
13055 * This function sets step-value for zoom action.
13056 * Set step to any positive value.
13057 * Cancel step setting by setting to 0.0
13059 * @param obj Pointer to gesture-layer.
13060 * @param s new zoom step value.
13062 * @ingroup Elm_Gesture_Layer
13064 EAPI void elm_gesture_layer_zoom_step_set(Evas_Object *obj, double s) EINA_ARG_NONNULL(1);
13067 * This function sets step-value for rotate action.
13068 * Set step to any positive value.
13069 * Cancel step setting by setting to 0.0
13071 * @param obj Pointer to gesture-layer.
13072 * @param s new roatate step value.
13074 * @ingroup Elm_Gesture_Layer
13076 EAPI void elm_gesture_layer_rotate_step_set(Evas_Object *obj, double s) EINA_ARG_NONNULL(1);
13079 * This function called to attach gesture-layer to an Evas_Object.
13080 * @param obj Pointer to gesture-layer.
13081 * @param t Pointer to underlying object (AKA Target)
13083 * @return TRUE, FALSE on success, failure.
13085 * @ingroup Elm_Gesture_Layer
13087 EAPI Eina_Bool elm_gesture_layer_attach(Evas_Object *obj, Evas_Object *t) EINA_ARG_NONNULL(1, 2);
13090 * Call this function to construct a new gesture-layer object.
13091 * This does not activate the gesture layer. You have to
13092 * call elm_gesture_layer_attach in order to 'activate' gesture-layer.
13094 * @param parent the parent object.
13096 * @return Pointer to new gesture-layer object.
13098 * @ingroup Elm_Gesture_Layer
13100 EAPI Evas_Object *elm_gesture_layer_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
13103 * @defgroup Thumb Thumb
13105 * @image html img/widget/thumb/preview-00.png
13106 * @image latex img/widget/thumb/preview-00.eps
13108 * A thumb object is used for displaying the thumbnail of an image or video.
13109 * You must have compiled Elementary with Ethumb_Client support and the DBus
13110 * service must be present and auto-activated in order to have thumbnails to
13113 * Once the thumbnail object becomes visible, it will check if there is a
13114 * previously generated thumbnail image for the file set on it. If not, it
13115 * will start generating this thumbnail.
13117 * Different config settings will cause different thumbnails to be generated
13118 * even on the same file.
13120 * Generated thumbnails are stored under @c $HOME/.thumbnails/. Check the
13121 * Ethumb documentation to change this path, and to see other configuration
13124 * Signals that you can add callbacks for are:
13126 * - "clicked" - This is called when a user has clicked the thumb without dragging
13128 * - "clicked,double" - This is called when a user has double-clicked the thumb.
13129 * - "press" - This is called when a user has pressed down the thumb.
13130 * - "generate,start" - The thumbnail generation started.
13131 * - "generate,stop" - The generation process stopped.
13132 * - "generate,error" - The generation failed.
13133 * - "load,error" - The thumbnail image loading failed.
13135 * available styles:
13139 * An example of use of thumbnail:
13141 * - @ref thumb_example_01
13145 * @addtogroup Thumb
13150 * @enum _Elm_Thumb_Animation_Setting
13151 * @typedef Elm_Thumb_Animation_Setting
13153 * Used to set if a video thumbnail is animating or not.
13157 typedef enum _Elm_Thumb_Animation_Setting
13159 ELM_THUMB_ANIMATION_START = 0, /**< Play animation once */
13160 ELM_THUMB_ANIMATION_LOOP, /**< Keep playing animation until stop is requested */
13161 ELM_THUMB_ANIMATION_STOP, /**< Stop playing the animation */
13162 ELM_THUMB_ANIMATION_LAST
13163 } Elm_Thumb_Animation_Setting;
13166 * Add a new thumb object to the parent.
13168 * @param parent The parent object.
13169 * @return The new object or NULL if it cannot be created.
13171 * @see elm_thumb_file_set()
13172 * @see elm_thumb_ethumb_client_get()
13176 EAPI Evas_Object *elm_thumb_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
13178 * Reload thumbnail if it was generated before.
13180 * @param obj The thumb object to reload
13182 * This is useful if the ethumb client configuration changed, like its
13183 * size, aspect or any other property one set in the handle returned
13184 * by elm_thumb_ethumb_client_get().
13186 * If the options didn't change, the thumbnail won't be generated again, but
13187 * the old one will still be used.
13189 * @see elm_thumb_file_set()
13193 EAPI void elm_thumb_reload(Evas_Object *obj) EINA_ARG_NONNULL(1);
13195 * Set the file that will be used as thumbnail.
13197 * @param obj The thumb object.
13198 * @param file The path to file that will be used as thumb.
13199 * @param key The key used in case of an EET file.
13201 * The file can be an image or a video (in that case, acceptable extensions are:
13202 * avi, mp4, ogv, mov, mpg and wmv). To start the video animation, use the
13203 * function elm_thumb_animate().
13205 * @see elm_thumb_file_get()
13206 * @see elm_thumb_reload()
13207 * @see elm_thumb_animate()
13211 EAPI void elm_thumb_file_set(Evas_Object *obj, const char *file, const char *key) EINA_ARG_NONNULL(1);
13213 * Get the image or video path and key used to generate the thumbnail.
13215 * @param obj The thumb object.
13216 * @param file Pointer to filename.
13217 * @param key Pointer to key.
13219 * @see elm_thumb_file_set()
13220 * @see elm_thumb_path_get()
13224 EAPI void elm_thumb_file_get(const Evas_Object *obj, const char **file, const char **key) EINA_ARG_NONNULL(1);
13226 * Get the path and key to the image or video generated by ethumb.
13228 * One just need to make sure that the thumbnail was generated before getting
13229 * its path; otherwise, the path will be NULL. One way to do that is by asking
13230 * for the path when/after the "generate,stop" smart callback is called.
13232 * @param obj The thumb object.
13233 * @param file Pointer to thumb path.
13234 * @param key Pointer to thumb key.
13236 * @see elm_thumb_file_get()
13240 EAPI void elm_thumb_path_get(const Evas_Object *obj, const char **file, const char **key) EINA_ARG_NONNULL(1);
13242 * Set the animation state for the thumb object. If its content is an animated
13243 * video, you may start/stop the animation or tell it to play continuously and
13246 * @param obj The thumb object.
13247 * @param setting The animation setting.
13249 * @see elm_thumb_file_set()
13253 EAPI void elm_thumb_animate_set(Evas_Object *obj, Elm_Thumb_Animation_Setting s) EINA_ARG_NONNULL(1);
13255 * Get the animation state for the thumb object.
13257 * @param obj The thumb object.
13258 * @return getting The animation setting or @c ELM_THUMB_ANIMATION_LAST,
13261 * @see elm_thumb_animate_set()
13265 EAPI Elm_Thumb_Animation_Setting elm_thumb_animate_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13267 * Get the ethumb_client handle so custom configuration can be made.
13269 * @return Ethumb_Client instance or NULL.
13271 * This must be called before the objects are created to be sure no object is
13272 * visible and no generation started.
13274 * Example of usage:
13277 * #include <Elementary.h>
13278 * #ifndef ELM_LIB_QUICKLAUNCH
13280 * elm_main(int argc, char **argv)
13282 * Ethumb_Client *client;
13284 * elm_need_ethumb();
13288 * client = elm_thumb_ethumb_client_get();
13291 * ERR("could not get ethumb_client");
13294 * ethumb_client_size_set(client, 100, 100);
13295 * ethumb_client_crop_align_set(client, 0.5, 0.5);
13298 * // Create elm_thumb objects here
13308 * @note There's only one client handle for Ethumb, so once a configuration
13309 * change is done to it, any other request for thumbnails (for any thumbnail
13310 * object) will use that configuration. Thus, this configuration is global.
13314 EAPI void *elm_thumb_ethumb_client_get(void);
13316 * Get the ethumb_client connection state.
13318 * @return EINA_TRUE if the client is connected to the server or EINA_FALSE
13321 EAPI Eina_Bool elm_thumb_ethumb_client_connected(void);
13323 * Make the thumbnail 'editable'.
13325 * @param obj Thumb object.
13326 * @param set Turn on or off editability. Default is @c EINA_FALSE.
13328 * This means the thumbnail is a valid drag target for drag and drop, and can be
13329 * cut or pasted too.
13331 * @see elm_thumb_editable_get()
13335 EAPI Eina_Bool elm_thumb_editable_set(Evas_Object *obj, Eina_Bool edit) EINA_ARG_NONNULL(1);
13337 * Make the thumbnail 'editable'.
13339 * @param obj Thumb object.
13340 * @return Editability.
13342 * This means the thumbnail is a valid drag target for drag and drop, and can be
13343 * cut or pasted too.
13345 * @see elm_thumb_editable_set()
13349 EAPI Eina_Bool elm_thumb_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13356 * @defgroup Web Web
13358 * @image html img/widget/web/preview-00.png
13359 * @image latex img/widget/web/preview-00.eps
13361 * A web object is used for displaying web pages (HTML/CSS/JS)
13362 * using WebKit-EFL. You must have compiled Elementary with
13365 * Signals that you can add callbacks for are:
13366 * @li "download,request": A file download has been requested. Event info is
13367 * a pointer to a Elm_Web_Download
13368 * @li "editorclient,contents,changed": Editor client's contents changed
13369 * @li "editorclient,selection,changed": Editor client's selection changed
13370 * @li "frame,created": A new frame was created. Event info is an
13371 * Evas_Object which can be handled with WebKit's ewk_frame API
13372 * @li "icon,received": An icon was received by the main frame
13373 * @li "inputmethod,changed": Input method changed. Event info is an
13374 * Eina_Bool indicating whether it's enabled or not
13375 * @li "js,windowobject,clear": JS window object has been cleared
13376 * @li "link,hover,in": Mouse cursor is hovering over a link. Event info
13377 * is a char *link[2], where the first string contains the URL the link
13378 * points to, and the second one the title of the link
13379 * @li "link,hover,out": Mouse cursor left the link
13380 * @li "load,document,finished": Loading of a document finished. Event info
13381 * is the frame that finished loading
13382 * @li "load,error": Load failed. Event info is a pointer to
13383 * Elm_Web_Frame_Load_Error
13384 * @li "load,finished": Load finished. Event info is NULL on success, on
13385 * error it's a pointer to Elm_Web_Frame_Load_Error
13386 * @li "load,newwindow,show": A new window was created and is ready to be
13388 * @li "load,progress": Overall load progress. Event info is a pointer to
13389 * a double containing a value between 0.0 and 1.0
13390 * @li "load,provisional": Started provisional load
13391 * @li "load,started": Loading of a document started
13392 * @li "menubar,visible,get": Queries if the menubar is visible. Event info
13393 * is a pointer to Eina_Bool where the callback should set EINA_TRUE if
13394 * the menubar is visible, or EINA_FALSE in case it's not
13395 * @li "menubar,visible,set": Informs menubar visibility. Event info is
13396 * an Eina_Bool indicating the visibility
13397 * @li "popup,created": A dropdown widget was activated, requesting its
13398 * popup menu to be created. Event info is a pointer to Elm_Web_Menu
13399 * @li "popup,willdelete": The web object is ready to destroy the popup
13400 * object created. Event info is a pointer to Elm_Web_Menu
13401 * @li "ready": Page is fully loaded
13402 * @li "scrollbars,visible,get": Queries visibility of scrollbars. Event
13403 * info is a pointer to Eina_Bool where the visibility state should be set
13404 * @li "scrollbars,visible,set": Informs scrollbars visibility. Event info
13405 * is an Eina_Bool with the visibility state set
13406 * @li "statusbar,text,set": Text of the statusbar changed. Even info is
13407 * a string with the new text
13408 * @li "statusbar,visible,get": Queries visibility of the status bar.
13409 * Event info is a pointer to Eina_Bool where the visibility state should be
13411 * @li "statusbar,visible,set": Informs statusbar visibility. Event info is
13412 * an Eina_Bool with the visibility value
13413 * @li "title,changed": Title of the main frame changed. Event info is a
13414 * string with the new title
13415 * @li "toolbars,visible,get": Queries visibility of toolbars. Event info
13416 * is a pointer to Eina_Bool where the visibility state should be set
13417 * @li "toolbars,visible,set": Informs the visibility of toolbars. Event
13418 * info is an Eina_Bool with the visibility state
13419 * @li "tooltip,text,set": Show and set text of a tooltip. Event info is
13420 * a string with the text to show
13421 * @li "uri,changed": URI of the main frame changed. Event info is a string
13423 * @li "view,resized": The web object internal's view changed sized
13424 * @li "windows,close,request": A JavaScript request to close the current
13425 * window was requested
13426 * @li "zoom,animated,end": Animated zoom finished
13428 * available styles:
13431 * An example of use of web:
13433 * - @ref web_example_01 TBD
13442 * Structure used to report load errors.
13444 * Load errors are reported as signal by elm_web. All the strings are
13445 * temporary references and should @b not be used after the signal
13446 * callback returns. If it's required, make copies with strdup() or
13447 * eina_stringshare_add() (they are not even guaranteed to be
13448 * stringshared, so must use eina_stringshare_add() and not
13449 * eina_stringshare_ref()).
13451 typedef struct _Elm_Web_Frame_Load_Error Elm_Web_Frame_Load_Error;
13453 * Structure used to report load errors.
13455 * Load errors are reported as signal by elm_web. All the strings are
13456 * temporary references and should @b not be used after the signal
13457 * callback returns. If it's required, make copies with strdup() or
13458 * eina_stringshare_add() (they are not even guaranteed to be
13459 * stringshared, so must use eina_stringshare_add() and not
13460 * eina_stringshare_ref()).
13462 struct _Elm_Web_Frame_Load_Error
13464 int code; /**< Numeric error code */
13465 Eina_Bool is_cancellation; /**< Error produced by cancelling a request */
13466 const char *domain; /**< Error domain name */
13467 const char *description; /**< Error description (already localized) */
13468 const char *failing_url; /**< The URL that failed to load */
13469 Evas_Object *frame; /**< Frame object that produced the error */
13473 * The possibles types that the items in a menu can be
13475 typedef enum _Elm_Web_Menu_Item_Type
13477 ELM_WEB_MENU_SEPARATOR,
13478 ELM_WEB_MENU_GROUP,
13479 ELM_WEB_MENU_OPTION
13480 } Elm_Web_Menu_Item_Type;
13483 * Structure describing the items in a menu
13485 typedef struct _Elm_Web_Menu_Item Elm_Web_Menu_Item;
13487 * Structure describing the items in a menu
13489 struct _Elm_Web_Menu_Item
13491 const char *text; /**< The text for the item */
13492 Elm_Web_Menu_Item_Type type; /**< The type of the item */
13496 * Structure describing the menu of a popup
13498 * This structure will be passed as the @c event_info for the "popup,create"
13499 * signal, which is emitted when a dropdown menu is opened. Users wanting
13500 * to handle these popups by themselves should listen to this signal and
13501 * set the @c handled property of the struct to @c EINA_TRUE. Leaving this
13502 * property as @c EINA_FALSE means that the user will not handle the popup
13503 * and the default implementation will be used.
13505 * When the popup is ready to be dismissed, a "popup,willdelete" signal
13506 * will be emitted to notify the user that it can destroy any objects and
13507 * free all data related to it.
13509 * @see elm_web_popup_selected_set()
13510 * @see elm_web_popup_destroy()
13512 typedef struct _Elm_Web_Menu Elm_Web_Menu;
13514 * Structure describing the menu of a popup
13516 * This structure will be passed as the @c event_info for the "popup,create"
13517 * signal, which is emitted when a dropdown menu is opened. Users wanting
13518 * to handle these popups by themselves should listen to this signal and
13519 * set the @c handled property of the struct to @c EINA_TRUE. Leaving this
13520 * property as @c EINA_FALSE means that the user will not handle the popup
13521 * and the default implementation will be used.
13523 * When the popup is ready to be dismissed, a "popup,willdelete" signal
13524 * will be emitted to notify the user that it can destroy any objects and
13525 * free all data related to it.
13527 * @see elm_web_popup_selected_set()
13528 * @see elm_web_popup_destroy()
13530 struct _Elm_Web_Menu
13532 Eina_List *items; /**< List of #Elm_Web_Menu_Item */
13533 int x; /**< The X position of the popup, relative to the elm_web object */
13534 int y; /**< The Y position of the popup, relative to the elm_web object */
13535 int width; /**< Width of the popup menu */
13536 int height; /**< Height of the popup menu */
13538 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. */
13541 typedef struct _Elm_Web_Download Elm_Web_Download;
13542 struct _Elm_Web_Download
13548 * Types of zoom available.
13550 typedef enum _Elm_Web_Zoom_Mode
13552 ELM_WEB_ZOOM_MODE_MANUAL = 0, /**< Zoom controlled normally by elm_web_zoom_set */
13553 ELM_WEB_ZOOM_MODE_AUTO_FIT, /**< Zoom until content fits in web object */
13554 ELM_WEB_ZOOM_MODE_AUTO_FILL, /**< Zoom until content fills web object */
13555 ELM_WEB_ZOOM_MODE_LAST
13556 } Elm_Web_Zoom_Mode;
13558 * Opaque handler containing the features (such as statusbar, menubar, etc)
13559 * that are to be set on a newly requested window.
13561 typedef struct _Elm_Web_Window_Features Elm_Web_Window_Features;
13563 * Callback type for the create_window hook.
13565 * The function parameters are:
13566 * @li @p data User data pointer set when setting the hook function
13567 * @li @p obj The elm_web object requesting the new window
13568 * @li @p js Set to @c EINA_TRUE if the request was originated from
13569 * JavaScript. @c EINA_FALSE otherwise.
13570 * @li @p window_features A pointer of #Elm_Web_Window_Features indicating
13571 * the features requested for the new window.
13573 * The returned value of the function should be the @c elm_web widget where
13574 * the request will be loaded. That is, if a new window or tab is created,
13575 * the elm_web widget in it should be returned, and @b NOT the window
13577 * Returning @c NULL should cancel the request.
13579 * @see elm_web_window_create_hook_set()
13581 typedef Evas_Object *(*Elm_Web_Window_Open)(void *data, Evas_Object *obj, Eina_Bool js, const Elm_Web_Window_Features *window_features);
13583 * Callback type for the JS alert hook.
13585 * The function parameters are:
13586 * @li @p data User data pointer set when setting the hook function
13587 * @li @p obj The elm_web object requesting the new window
13588 * @li @p message The message to show in the alert dialog
13590 * The function should return the object representing the alert dialog.
13591 * Elm_Web will run a second main loop to handle the dialog and normal
13592 * flow of the application will be restored when the object is deleted, so
13593 * the user should handle the popup properly in order to delete the object
13594 * when the action is finished.
13595 * If the function returns @c NULL the popup will be ignored.
13597 * @see elm_web_dialog_alert_hook_set()
13599 typedef Evas_Object *(*Elm_Web_Dialog_Alert)(void *data, Evas_Object *obj, const char *message);
13601 * Callback type for the JS confirm hook.
13603 * The function parameters are:
13604 * @li @p data User data pointer set when setting the hook function
13605 * @li @p obj The elm_web object requesting the new window
13606 * @li @p message The message to show in the confirm dialog
13607 * @li @p ret Pointer where to store the user selection. @c EINA_TRUE if
13608 * the user selected @c Ok, @c EINA_FALSE otherwise.
13610 * The function should return the object representing the confirm dialog.
13611 * Elm_Web will run a second main loop to handle the dialog and normal
13612 * flow of the application will be restored when the object is deleted, so
13613 * the user should handle the popup properly in order to delete the object
13614 * when the action is finished.
13615 * If the function returns @c NULL the popup will be ignored.
13617 * @see elm_web_dialog_confirm_hook_set()
13619 typedef Evas_Object *(*Elm_Web_Dialog_Confirm)(void *data, Evas_Object *obj, const char *message, Eina_Bool *ret);
13621 * Callback type for the JS prompt hook.
13623 * The function parameters are:
13624 * @li @p data User data pointer set when setting the hook function
13625 * @li @p obj The elm_web object requesting the new window
13626 * @li @p message The message to show in the prompt dialog
13627 * @li @p def_value The default value to present the user in the entry
13628 * @li @p value Pointer where to store the value given by the user. Must
13629 * be a malloc'ed string or @c NULL if the user cancelled the popup.
13630 * @li @p ret Pointer where to store the user selection. @c EINA_TRUE if
13631 * the user selected @c Ok, @c EINA_FALSE otherwise.
13633 * The function should return the object representing the prompt dialog.
13634 * Elm_Web will run a second main loop to handle the dialog and normal
13635 * flow of the application will be restored when the object is deleted, so
13636 * the user should handle the popup properly in order to delete the object
13637 * when the action is finished.
13638 * If the function returns @c NULL the popup will be ignored.
13640 * @see elm_web_dialog_prompt_hook_set()
13642 typedef Evas_Object *(*Elm_Web_Dialog_Prompt)(void *data, Evas_Object *obj, const char *message, const char *def_value, char **value, Eina_Bool *ret);
13644 * Callback type for the JS file selector hook.
13646 * The function parameters are:
13647 * @li @p data User data pointer set when setting the hook function
13648 * @li @p obj The elm_web object requesting the new window
13649 * @li @p allows_multiple @c EINA_TRUE if multiple files can be selected.
13650 * @li @p accept_types Mime types accepted
13651 * @li @p selected Pointer where to store the list of malloc'ed strings
13652 * containing the path to each file selected. Must be @c NULL if the file
13653 * dialog is cancelled
13654 * @li @p ret Pointer where to store the user selection. @c EINA_TRUE if
13655 * the user selected @c Ok, @c EINA_FALSE otherwise.
13657 * The function should return the object representing the file selector
13659 * Elm_Web will run a second main loop to handle the dialog and normal
13660 * flow of the application will be restored when the object is deleted, so
13661 * the user should handle the popup properly in order to delete the object
13662 * when the action is finished.
13663 * If the function returns @c NULL the popup will be ignored.
13665 * @see elm_web_dialog_file selector_hook_set()
13667 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);
13669 * Callback type for the JS console message hook.
13671 * When a console message is added from JavaScript, any set function to the
13672 * console message hook will be called for the user to handle. There is no
13673 * default implementation of this hook.
13675 * The function parameters are:
13676 * @li @p data User data pointer set when setting the hook function
13677 * @li @p obj The elm_web object that originated the message
13678 * @li @p message The message sent
13679 * @li @p line_number The line number
13680 * @li @p source_id Source id
13682 * @see elm_web_console_message_hook_set()
13684 typedef void (*Elm_Web_Console_Message)(void *data, Evas_Object *obj, const char *message, unsigned int line_number, const char *source_id);
13686 * Add a new web object to the parent.
13688 * @param parent The parent object.
13689 * @return The new object or NULL if it cannot be created.
13691 * @see elm_web_uri_set()
13692 * @see elm_web_webkit_view_get()
13694 EAPI Evas_Object *elm_web_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
13697 * Get internal ewk_view object from web object.
13699 * Elementary may not provide some low level features of EWebKit,
13700 * instead of cluttering the API with proxy methods we opted to
13701 * return the internal reference. Be careful using it as it may
13702 * interfere with elm_web behavior.
13704 * @param obj The web object.
13705 * @return The internal ewk_view object or NULL if it does not
13706 * exist. (Failure to create or Elementary compiled without
13709 * @see elm_web_add()
13711 EAPI Evas_Object *elm_web_webkit_view_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13714 * Sets the function to call when a new window is requested
13716 * This hook will be called when a request to create a new window is
13717 * issued from the web page loaded.
13718 * There is no default implementation for this feature, so leaving this
13719 * unset or passing @c NULL in @p func will prevent new windows from
13722 * @param obj The web object where to set the hook function
13723 * @param func The hook function to be called when a window is requested
13724 * @param data User data
13726 EAPI void elm_web_window_create_hook_set(Evas_Object *obj, Elm_Web_Window_Open func, void *data);
13728 * Sets the function to call when an alert dialog
13730 * This hook will be called when a JavaScript alert dialog is requested.
13731 * If no function is set or @c NULL is passed in @p func, the default
13732 * implementation will take place.
13734 * @param obj The web object where to set the hook function
13735 * @param func The callback function to be used
13736 * @param data User data
13738 * @see elm_web_inwin_mode_set()
13740 EAPI void elm_web_dialog_alert_hook_set(Evas_Object *obj, Elm_Web_Dialog_Alert func, void *data);
13742 * Sets the function to call when an confirm dialog
13744 * This hook will be called when a JavaScript confirm dialog is requested.
13745 * If no function is set or @c NULL is passed in @p func, the default
13746 * implementation will take place.
13748 * @param obj The web object where to set the hook function
13749 * @param func The callback function to be used
13750 * @param data User data
13752 * @see elm_web_inwin_mode_set()
13754 EAPI void elm_web_dialog_confirm_hook_set(Evas_Object *obj, Elm_Web_Dialog_Confirm func, void *data);
13756 * Sets the function to call when an prompt dialog
13758 * This hook will be called when a JavaScript prompt dialog is requested.
13759 * If no function is set or @c NULL is passed in @p func, the default
13760 * implementation will take place.
13762 * @param obj The web object where to set the hook function
13763 * @param func The callback function to be used
13764 * @param data User data
13766 * @see elm_web_inwin_mode_set()
13768 EAPI void elm_web_dialog_prompt_hook_set(Evas_Object *obj, Elm_Web_Dialog_Prompt func, void *data);
13770 * Sets the function to call when an file selector dialog
13772 * This hook will be called when a JavaScript file selector dialog is
13774 * If no function is set or @c NULL is passed in @p func, the default
13775 * implementation will take place.
13777 * @param obj The web object where to set the hook function
13778 * @param func The callback function to be used
13779 * @param data User data
13781 * @see elm_web_inwin_mode_set()
13783 EAPI void elm_web_dialog_file_selector_hook_set(Evas_Object *obj, Elm_Web_Dialog_File_Selector func, void *data);
13785 * Sets the function to call when a console message is emitted from JS
13787 * This hook will be called when a console message is emitted from
13788 * JavaScript. There is no default implementation for this feature.
13790 * @param obj The web object where to set the hook function
13791 * @param func The callback function to be used
13792 * @param data User data
13794 EAPI void elm_web_console_message_hook_set(Evas_Object *obj, Elm_Web_Console_Message func, void *data);
13796 * Gets the status of the tab propagation
13798 * @param obj The web object to query
13799 * @return EINA_TRUE if tab propagation is enabled, EINA_FALSE otherwise
13801 * @see elm_web_tab_propagate_set()
13803 EAPI Eina_Bool elm_web_tab_propagate_get(const Evas_Object *obj);
13805 * Sets whether to use tab propagation
13807 * If tab propagation is enabled, whenever the user presses the Tab key,
13808 * Elementary will handle it and switch focus to the next widget.
13809 * The default value is disabled, where WebKit will handle the Tab key to
13810 * cycle focus though its internal objects, jumping to the next widget
13811 * only when that cycle ends.
13813 * @param obj The web object
13814 * @param propagate Whether to propagate Tab keys to Elementary or not
13816 EAPI void elm_web_tab_propagate_set(Evas_Object *obj, Eina_Bool propagate);
13818 * Sets the URI for the web object
13820 * It must be a full URI, with resource included, in the form
13821 * http://www.enlightenment.org or file:///tmp/something.html
13823 * @param obj The web object
13824 * @param uri The URI to set
13825 * @return EINA_TRUE if the URI could be, EINA_FALSE if an error occurred
13827 EAPI Eina_Bool elm_web_uri_set(Evas_Object *obj, const char *uri);
13829 * Gets the current URI for the object
13831 * The returned string must not be freed and is guaranteed to be
13834 * @param obj The web object
13835 * @return A stringshared internal string with the current URI, or NULL on
13838 EAPI const char *elm_web_uri_get(const Evas_Object *obj);
13840 * Gets the current title
13842 * The returned string must not be freed and is guaranteed to be
13845 * @param obj The web object
13846 * @return A stringshared internal string with the current title, or NULL on
13849 EAPI const char *elm_web_title_get(const Evas_Object *obj);
13851 * Sets the background color to be used by the web object
13853 * This is the color that will be used by default when the loaded page
13854 * does not set it's own. Color values are pre-multiplied.
13856 * @param obj The web object
13857 * @param r Red component
13858 * @param g Green component
13859 * @param b Blue component
13860 * @param a Alpha component
13862 EAPI void elm_web_bg_color_set(Evas_Object *obj, int r, int g, int b, int a);
13864 * Gets the background color to be used by the web object
13866 * This is the color that will be used by default when the loaded page
13867 * does not set it's own. Color values are pre-multiplied.
13869 * @param obj The web object
13870 * @param r Red component
13871 * @param g Green component
13872 * @param b Blue component
13873 * @param a Alpha component
13875 EAPI void elm_web_bg_color_get(const Evas_Object *obj, int *r, int *g, int *b, int *a);
13877 * Gets a copy of the currently selected text
13879 * The string returned must be freed by the user when it's done with it.
13881 * @param obj The web object
13882 * @return A newly allocated string, or NULL if nothing is selected or an
13885 EAPI char *elm_view_selection_get(const Evas_Object *obj);
13887 * Tells the web object which index in the currently open popup was selected
13889 * When the user handles the popup creation from the "popup,created" signal,
13890 * it needs to tell the web object which item was selected by calling this
13891 * function with the index corresponding to the item.
13893 * @param obj The web object
13894 * @param index The index selected
13896 * @see elm_web_popup_destroy()
13898 EAPI void elm_web_popup_selected_set(Evas_Object *obj, int index);
13900 * Dismisses an open dropdown popup
13902 * When the popup from a dropdown widget is to be dismissed, either after
13903 * selecting an option or to cancel it, this function must be called, which
13904 * will later emit an "popup,willdelete" signal to notify the user that
13905 * any memory and objects related to this popup can be freed.
13907 * @param obj The web object
13908 * @return EINA_TRUE if the menu was successfully destroyed, or EINA_FALSE
13909 * if there was no menu to destroy
13911 EAPI Eina_Bool elm_web_popup_destroy(Evas_Object *obj);
13913 * Searches the given string in a document.
13915 * @param obj The web object where to search the text
13916 * @param string String to search
13917 * @param case_sensitive If search should be case sensitive or not
13918 * @param forward If search is from cursor and on or backwards
13919 * @param wrap If search should wrap at the end
13921 * @return @c EINA_TRUE if the given string was found, @c EINA_FALSE if not
13924 EAPI Eina_Bool elm_web_text_search(const Evas_Object *obj, const char *string, Eina_Bool case_sensitive, Eina_Bool forward, Eina_Bool wrap);
13926 * Marks matches of the given string in a document.
13928 * @param obj The web object where to search text
13929 * @param string String to match
13930 * @param case_sensitive If match should be case sensitive or not
13931 * @param highlight If matches should be highlighted
13932 * @param limit Maximum amount of matches, or zero to unlimited
13934 * @return number of matched @a string
13936 EAPI unsigned int elm_web_text_matches_mark(Evas_Object *obj, const char *string, Eina_Bool case_sensitive, Eina_Bool highlight, unsigned int limit);
13938 * Clears all marked matches in the document
13940 * @param obj The web object
13942 * @return EINA_TRUE on success, EINA_FALSE otherwise
13944 EAPI Eina_Bool elm_web_text_matches_unmark_all(Evas_Object *obj);
13946 * Sets whether to highlight the matched marks
13948 * If enabled, marks set with elm_web_text_matches_mark() will be
13951 * @param obj The web object
13952 * @param highlight Whether to highlight the marks or not
13954 * @return EINA_TRUE on success, EINA_FALSE otherwise
13956 EAPI Eina_Bool elm_web_text_matches_highlight_set(Evas_Object *obj, Eina_Bool highlight);
13958 * Gets whether highlighting marks is enabled
13960 * @param The web object
13962 * @return EINA_TRUE is marks are set to be highlighted, EINA_FALSE
13965 EAPI Eina_Bool elm_web_text_matches_highlight_get(const Evas_Object *obj);
13967 * Gets the overall loading progress of the page
13969 * Returns the estimated loading progress of the page, with a value between
13970 * 0.0 and 1.0. This is an estimated progress accounting for all the frames
13971 * included in the page.
13973 * @param The web object
13975 * @return A value between 0.0 and 1.0 indicating the progress, or -1.0 on
13978 EAPI double elm_web_load_progress_get(const Evas_Object *obj);
13980 * Stops loading the current page
13982 * Cancels the loading of the current page in the web object. This will
13983 * cause a "load,error" signal to be emitted, with the is_cancellation
13984 * flag set to EINA_TRUE.
13986 * @param obj The web object
13988 * @return EINA_TRUE if the cancel was successful, EINA_FALSE otherwise
13990 EAPI Eina_Bool elm_web_stop(Evas_Object *obj);
13992 * Requests a reload of the current document in the object
13994 * @param obj The web object
13996 * @return EINA_TRUE on success, EINA_FALSE otherwise
13998 EAPI Eina_Bool elm_web_reload(Evas_Object *obj);
14000 * Requests a reload of the current document, avoiding any existing caches
14002 * @param obj The web object
14004 * @return EINA_TRUE on success, EINA_FALSE otherwise
14006 EAPI Eina_Bool elm_web_reload_full(Evas_Object *obj);
14008 * Goes back one step in the browsing history
14010 * This is equivalent to calling elm_web_object_navigate(obj, -1);
14012 * @param obj The web object
14014 * @return EINA_TRUE on success, EINA_FALSE otherwise
14016 * @see elm_web_history_enable_set()
14017 * @see elm_web_back_possible()
14018 * @see elm_web_forward()
14019 * @see elm_web_navigate()
14021 EAPI Eina_Bool elm_web_back(Evas_Object *obj);
14023 * Goes forward one step in the browsing history
14025 * This is equivalent to calling elm_web_object_navigate(obj, 1);
14027 * @param obj The web object
14029 * @return EINA_TRUE on success, EINA_FALSE otherwise
14031 * @see elm_web_history_enable_set()
14032 * @see elm_web_forward_possible()
14033 * @see elm_web_back()
14034 * @see elm_web_navigate()
14036 EAPI Eina_Bool elm_web_forward(Evas_Object *obj);
14038 * Jumps the given number of steps in the browsing history
14040 * The @p steps value can be a negative integer to back in history, or a
14041 * positive to move forward.
14043 * @param obj The web object
14044 * @param steps The number of steps to jump
14046 * @return EINA_TRUE on success, EINA_FALSE on error or if not enough
14047 * history exists to jump the given number of steps
14049 * @see elm_web_history_enable_set()
14050 * @see elm_web_navigate_possible()
14051 * @see elm_web_back()
14052 * @see elm_web_forward()
14054 EAPI Eina_Bool elm_web_navigate(Evas_Object *obj, int steps);
14056 * Queries whether it's possible to go back in history
14058 * @param obj The web object
14060 * @return EINA_TRUE if it's possible to back in history, EINA_FALSE
14063 EAPI Eina_Bool elm_web_back_possible(Evas_Object *obj);
14065 * Queries whether it's possible to go forward in history
14067 * @param obj The web object
14069 * @return EINA_TRUE if it's possible to forward in history, EINA_FALSE
14072 EAPI Eina_Bool elm_web_forward_possible(Evas_Object *obj);
14074 * Queries whether it's possible to jump the given number of steps
14076 * The @p steps value can be a negative integer to back in history, or a
14077 * positive to move forward.
14079 * @param obj The web object
14080 * @param steps The number of steps to check for
14082 * @return EINA_TRUE if enough history exists to perform the given jump,
14083 * EINA_FALSE otherwise
14085 EAPI Eina_Bool elm_web_navigate_possible(Evas_Object *obj, int steps);
14087 * Gets whether browsing history is enabled for the given object
14089 * @param obj The web object
14091 * @return EINA_TRUE if history is enabled, EINA_FALSE otherwise
14093 EAPI Eina_Bool elm_web_history_enable_get(const Evas_Object *obj);
14095 * Enables or disables the browsing history
14097 * @param obj The web object
14098 * @param enable Whether to enable or disable the browsing history
14100 EAPI void elm_web_history_enable_set(Evas_Object *obj, Eina_Bool enable);
14102 * Sets the zoom level of the web object
14104 * Zoom level matches the Webkit API, so 1.0 means normal zoom, with higher
14105 * values meaning zoom in and lower meaning zoom out. This function will
14106 * only affect the zoom level if the mode set with elm_web_zoom_mode_set()
14107 * is ::ELM_WEB_ZOOM_MODE_MANUAL.
14109 * @param obj The web object
14110 * @param zoom The zoom level to set
14112 EAPI void elm_web_zoom_set(Evas_Object *obj, double zoom);
14114 * Gets the current zoom level set on the web object
14116 * Note that this is the zoom level set on the web object and not that
14117 * of the underlying Webkit one. In the ::ELM_WEB_ZOOM_MODE_MANUAL mode,
14118 * the two zoom levels should match, but for the other two modes the
14119 * Webkit zoom is calculated internally to match the chosen mode without
14120 * changing the zoom level set for the web object.
14122 * @param obj The web object
14124 * @return The zoom level set on the object
14126 EAPI double elm_web_zoom_get(const Evas_Object *obj);
14128 * Sets the zoom mode to use
14130 * The modes can be any of those defined in ::Elm_Web_Zoom_Mode, except
14131 * ::ELM_WEB_ZOOM_MODE_LAST. The default is ::ELM_WEB_ZOOM_MODE_MANUAL.
14133 * ::ELM_WEB_ZOOM_MODE_MANUAL means the zoom level will be controlled
14134 * with the elm_web_zoom_set() function.
14135 * ::ELM_WEB_ZOOM_MODE_AUTO_FIT will calculate the needed zoom level to
14136 * make sure the entirety of the web object's contents are shown.
14137 * ::ELM_WEB_ZOOM_MODE_AUTO_FILL will calculate the needed zoom level to
14138 * fit the contents in the web object's size, without leaving any space
14141 * @param obj The web object
14142 * @param mode The mode to set
14144 EAPI void elm_web_zoom_mode_set(Evas_Object *obj, Elm_Web_Zoom_Mode mode);
14146 * Gets the currently set zoom mode
14148 * @param obj The web object
14150 * @return The current zoom mode set for the object, or
14151 * ::ELM_WEB_ZOOM_MODE_LAST on error
14153 EAPI Elm_Web_Zoom_Mode elm_web_zoom_mode_get(const Evas_Object *obj);
14155 * Shows the given region in the web object
14157 * @param obj The web object
14158 * @param x The x coordinate of the region to show
14159 * @param y The y coordinate of the region to show
14160 * @param w The width of the region to show
14161 * @param h The height of the region to show
14163 EAPI void elm_web_region_show(Evas_Object *obj, int x, int y, int w, int h);
14165 * Brings in the region to the visible area
14167 * Like elm_web_region_show(), but it animates the scrolling of the object
14170 * @param obj The web object
14171 * @param x The x coordinate of the region to show
14172 * @param y The y coordinate of the region to show
14173 * @param w The width of the region to show
14174 * @param h The height of the region to show
14176 EAPI void elm_web_region_bring_in(Evas_Object *obj, int x, int y, int w, int h);
14178 * Sets the default dialogs to use an Inwin instead of a normal window
14180 * If set, then the default implementation for the JavaScript dialogs and
14181 * file selector will be opened in an Inwin. Otherwise they will use a
14182 * normal separated window.
14184 * @param obj The web object
14185 * @param value EINA_TRUE to use Inwin, EINA_FALSE to use a normal window
14187 EAPI void elm_web_inwin_mode_set(Evas_Object *obj, Eina_Bool value);
14189 * Gets whether Inwin mode is set for the current object
14191 * @param obj The web object
14193 * @return EINA_TRUE if Inwin mode is set, EINA_FALSE otherwise
14195 EAPI Eina_Bool elm_web_inwin_mode_get(const Evas_Object *obj);
14197 EAPI void elm_web_window_features_ref(Elm_Web_Window_Features *wf);
14198 EAPI void elm_web_window_features_unref(Elm_Web_Window_Features *wf);
14199 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);
14200 EAPI void elm_web_window_features_int_property_get(const Elm_Web_Window_Features *wf, int *x, int *y, int *w, int *h);
14207 * @defgroup Hoversel Hoversel
14209 * @image html img/widget/hoversel/preview-00.png
14210 * @image latex img/widget/hoversel/preview-00.eps
14212 * A hoversel is a button that pops up a list of items (automatically
14213 * choosing the direction to display) that have a label and, optionally, an
14214 * icon to select from. It is a convenience widget to avoid the need to do
14215 * all the piecing together yourself. It is intended for a small number of
14216 * items in the hoversel menu (no more than 8), though is capable of many
14219 * Signals that you can add callbacks for are:
14220 * "clicked" - the user clicked the hoversel button and popped up the sel
14221 * "selected" - an item in the hoversel list is selected. event_info is the item
14222 * "dismissed" - the hover is dismissed
14224 * See @ref tutorial_hoversel for an example.
14227 typedef struct _Elm_Hoversel_Item Elm_Hoversel_Item; /**< Item of Elm_Hoversel. Sub-type of Elm_Widget_Item */
14229 * @brief Add a new Hoversel object
14231 * @param parent The parent object
14232 * @return The new object or NULL if it cannot be created
14234 EAPI Evas_Object *elm_hoversel_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
14236 * @brief This sets the hoversel to expand horizontally.
14238 * @param obj The hoversel object
14239 * @param horizontal If true, the hover will expand horizontally to the
14242 * @note The initial button will display horizontally regardless of this
14245 EAPI void elm_hoversel_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
14247 * @brief This returns whether the hoversel is set to expand horizontally.
14249 * @param obj The hoversel object
14250 * @return If true, the hover will expand horizontally to the right.
14252 * @see elm_hoversel_horizontal_set()
14254 EAPI Eina_Bool elm_hoversel_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14256 * @brief Set the Hover parent
14258 * @param obj The hoversel object
14259 * @param parent The parent to use
14261 * Sets the hover parent object, the area that will be darkened when the
14262 * hoversel is clicked. Should probably be the window that the hoversel is
14263 * in. See @ref Hover objects for more information.
14265 EAPI void elm_hoversel_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
14267 * @brief Get the Hover parent
14269 * @param obj The hoversel object
14270 * @return The used parent
14272 * Gets the hover parent object.
14274 * @see elm_hoversel_hover_parent_set()
14276 EAPI Evas_Object *elm_hoversel_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14278 * @brief Set the hoversel button label
14280 * @param obj The hoversel object
14281 * @param label The label text.
14283 * This sets the label of the button that is always visible (before it is
14284 * clicked and expanded).
14286 * @deprecated elm_object_text_set()
14288 EINA_DEPRECATED EAPI void elm_hoversel_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
14290 * @brief Get the hoversel button label
14292 * @param obj The hoversel object
14293 * @return The label text.
14295 * @deprecated elm_object_text_get()
14297 EINA_DEPRECATED EAPI const char *elm_hoversel_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14299 * @brief Set the icon of the hoversel button
14301 * @param obj The hoversel object
14302 * @param icon The icon object
14304 * Sets the icon of the button that is always visible (before it is clicked
14305 * and expanded). Once the icon object is set, a previously set one will be
14306 * deleted, if you want to keep that old content object, use the
14307 * elm_hoversel_icon_unset() function.
14309 * @see elm_object_content_set() for the button widget
14311 EAPI void elm_hoversel_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
14313 * @brief Get the icon of the hoversel button
14315 * @param obj The hoversel object
14316 * @return The icon object
14318 * Get the icon of the button that is always visible (before it is clicked
14319 * and expanded). Also see elm_object_content_get() for the button widget.
14321 * @see elm_hoversel_icon_set()
14323 EAPI Evas_Object *elm_hoversel_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14325 * @brief Get and unparent the icon of the hoversel button
14327 * @param obj The hoversel object
14328 * @return The icon object that was being used
14330 * Unparent and return the icon of the button that is always visible
14331 * (before it is clicked and expanded).
14333 * @see elm_hoversel_icon_set()
14334 * @see elm_object_content_unset() for the button widget
14336 EAPI Evas_Object *elm_hoversel_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
14338 * @brief This triggers the hoversel popup from code, the same as if the user
14339 * had clicked the button.
14341 * @param obj The hoversel object
14343 EAPI void elm_hoversel_hover_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
14345 * @brief This dismisses the hoversel popup as if the user had clicked
14346 * outside the hover.
14348 * @param obj The hoversel object
14350 EAPI void elm_hoversel_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
14352 * @brief Returns whether the hoversel is expanded.
14354 * @param obj The hoversel object
14355 * @return This will return EINA_TRUE if the hoversel is expanded or
14356 * EINA_FALSE if it is not expanded.
14358 EAPI Eina_Bool elm_hoversel_expanded_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14360 * @brief This will remove all the children items from the hoversel.
14362 * @param obj The hoversel object
14364 * @warning Should @b not be called while the hoversel is active; use
14365 * elm_hoversel_expanded_get() to check first.
14367 * @see elm_hoversel_item_del_cb_set()
14368 * @see elm_hoversel_item_del()
14370 EAPI void elm_hoversel_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
14372 * @brief Get the list of items within the given hoversel.
14374 * @param obj The hoversel object
14375 * @return Returns a list of Elm_Hoversel_Item*
14377 * @see elm_hoversel_item_add()
14379 EAPI const Eina_List *elm_hoversel_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14381 * @brief Add an item to the hoversel button
14383 * @param obj The hoversel object
14384 * @param label The text label to use for the item (NULL if not desired)
14385 * @param icon_file An image file path on disk to use for the icon or standard
14386 * icon name (NULL if not desired)
14387 * @param icon_type The icon type if relevant
14388 * @param func Convenience function to call when this item is selected
14389 * @param data Data to pass to item-related functions
14390 * @return A handle to the item added.
14392 * This adds an item to the hoversel to show when it is clicked. Note: if you
14393 * need to use an icon from an edje file then use
14394 * elm_hoversel_item_icon_set() right after the this function, and set
14395 * icon_file to NULL here.
14397 * For more information on what @p icon_file and @p icon_type are see the
14398 * @ref Icon "icon documentation".
14400 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);
14402 * @brief Delete an item from the hoversel
14404 * @param item The item to delete
14406 * This deletes the item from the hoversel (should not be called while the
14407 * hoversel is active; use elm_hoversel_expanded_get() to check first).
14409 * @see elm_hoversel_item_add()
14410 * @see elm_hoversel_item_del_cb_set()
14412 EAPI void elm_hoversel_item_del(Elm_Hoversel_Item *item) EINA_ARG_NONNULL(1);
14414 * @brief Set the function to be called when an item from the hoversel is
14417 * @param item The item to set the callback on
14418 * @param func The function called
14420 * That function will receive these parameters:
14421 * @li void *item_data
14422 * @li Evas_Object *the_item_object
14423 * @li Elm_Hoversel_Item *the_object_struct
14425 * @see elm_hoversel_item_add()
14427 EAPI void elm_hoversel_item_del_cb_set(Elm_Hoversel_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
14429 * @brief This returns the data pointer supplied with elm_hoversel_item_add()
14430 * that will be passed to associated function callbacks.
14432 * @param item The item to get the data from
14433 * @return The data pointer set with elm_hoversel_item_add()
14435 * @see elm_hoversel_item_add()
14437 EAPI void *elm_hoversel_item_data_get(const Elm_Hoversel_Item *it) EINA_ARG_NONNULL(1);
14439 * @brief This returns the label text of the given hoversel item.
14441 * @param item The item to get the label
14442 * @return The label text of the hoversel item
14444 * @see elm_hoversel_item_add()
14446 EAPI const char *elm_hoversel_item_label_get(const Elm_Hoversel_Item *it) EINA_ARG_NONNULL(1);
14448 * @brief This sets the icon for the given hoversel item.
14450 * @param item The item to set the icon
14451 * @param icon_file An image file path on disk to use for the icon or standard
14453 * @param icon_group The edje group to use if @p icon_file is an edje file. Set this
14454 * to NULL if the icon is not an edje file
14455 * @param icon_type The icon type
14457 * The icon can be loaded from the standard set, from an image file, or from
14460 * @see elm_hoversel_item_add()
14462 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);
14464 * @brief Get the icon object of the hoversel item
14466 * @param item The item to get the icon from
14467 * @param icon_file The image file path on disk used for the icon or standard
14469 * @param icon_group The edje group used if @p icon_file is an edje file. NULL
14470 * if the icon is not an edje file
14471 * @param icon_type The icon type
14473 * @see elm_hoversel_item_icon_set()
14474 * @see elm_hoversel_item_add()
14476 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);
14482 * @defgroup Toolbar Toolbar
14483 * @ingroup Elementary
14485 * @image html img/widget/toolbar/preview-00.png
14486 * @image latex img/widget/toolbar/preview-00.eps width=\textwidth
14488 * @image html img/toolbar.png
14489 * @image latex img/toolbar.eps width=\textwidth
14491 * A toolbar is a widget that displays a list of items inside
14492 * a box. It can be scrollable, show a menu with items that don't fit
14493 * to toolbar size or even crop them.
14495 * Only one item can be selected at a time.
14497 * Items can have multiple states, or show menus when selected by the user.
14499 * Smart callbacks one can listen to:
14500 * - "clicked" - when the user clicks on a toolbar item and becomes selected.
14501 * - "language,changed" - when the program language changes
14503 * Available styles for it:
14505 * - @c "transparent" - no background or shadow, just show the content
14507 * List of examples:
14508 * @li @ref toolbar_example_01
14509 * @li @ref toolbar_example_02
14510 * @li @ref toolbar_example_03
14514 * @addtogroup Toolbar
14519 * @enum _Elm_Toolbar_Shrink_Mode
14520 * @typedef Elm_Toolbar_Shrink_Mode
14522 * Set toolbar's items display behavior, it can be scrollabel,
14523 * show a menu with exceeding items, or simply hide them.
14525 * @note Default value is #ELM_TOOLBAR_SHRINK_MENU. It reads value
14528 * Values <b> don't </b> work as bitmask, only one can be choosen.
14530 * @see elm_toolbar_mode_shrink_set()
14531 * @see elm_toolbar_mode_shrink_get()
14535 typedef enum _Elm_Toolbar_Shrink_Mode
14537 ELM_TOOLBAR_SHRINK_NONE, /**< Set toolbar minimun size to fit all the items. */
14538 ELM_TOOLBAR_SHRINK_HIDE, /**< Hide exceeding items. */
14539 ELM_TOOLBAR_SHRINK_SCROLL, /**< Allow accessing exceeding items through a scroller. */
14540 ELM_TOOLBAR_SHRINK_MENU, /**< Inserts a button to pop up a menu with exceeding items. */
14541 ELM_TOOLBAR_SHRINK_LAST /**< Indicates error if returned by elm_toolbar_shrink_mode_get() */
14542 } Elm_Toolbar_Shrink_Mode;
14544 typedef struct _Elm_Toolbar_Item Elm_Toolbar_Item; /**< Item of Elm_Toolbar. Sub-type of Elm_Widget_Item. Can be created with elm_toolbar_item_append(), elm_toolbar_item_prepend() and functions to add items in relative positions, like elm_toolbar_item_insert_before(), and deleted with elm_toolbar_item_del(). */
14546 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(). */
14549 * Add a new toolbar widget to the given parent Elementary
14550 * (container) object.
14552 * @param parent The parent object.
14553 * @return a new toolbar widget handle or @c NULL, on errors.
14555 * This function inserts a new toolbar widget on the canvas.
14559 EAPI Evas_Object *elm_toolbar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
14562 * Set the icon size, in pixels, to be used by toolbar items.
14564 * @param obj The toolbar object
14565 * @param icon_size The icon size in pixels
14567 * @note Default value is @c 32. It reads value from elm config.
14569 * @see elm_toolbar_icon_size_get()
14573 EAPI void elm_toolbar_icon_size_set(Evas_Object *obj, int icon_size) EINA_ARG_NONNULL(1);
14576 * Get the icon size, in pixels, to be used by toolbar items.
14578 * @param obj The toolbar object.
14579 * @return The icon size in pixels.
14581 * @see elm_toolbar_icon_size_set() for details.
14585 EAPI int elm_toolbar_icon_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14588 * Sets icon lookup order, for toolbar items' icons.
14590 * @param obj The toolbar object.
14591 * @param order The icon lookup order.
14593 * Icons added before calling this function will not be affected.
14594 * The default lookup order is #ELM_ICON_LOOKUP_THEME_FDO.
14596 * @see elm_toolbar_icon_order_lookup_get()
14600 EAPI void elm_toolbar_icon_order_lookup_set(Evas_Object *obj, Elm_Icon_Lookup_Order order) EINA_ARG_NONNULL(1);
14603 * Gets the icon lookup order.
14605 * @param obj The toolbar object.
14606 * @return The icon lookup order.
14608 * @see elm_toolbar_icon_order_lookup_set() for details.
14612 EAPI Elm_Icon_Lookup_Order elm_toolbar_icon_order_lookup_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14615 * Set whether the toolbar should always have an item selected.
14617 * @param obj The toolbar object.
14618 * @param wrap @c EINA_TRUE to enable always-select mode or @c EINA_FALSE to
14621 * This will cause the toolbar to always have an item selected, and clicking
14622 * the selected item will not cause a selected event to be emitted. Enabling this mode
14623 * will immediately select the first toolbar item.
14625 * Always-selected is disabled by default.
14627 * @see elm_toolbar_always_select_mode_get().
14631 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);
14647 * Set whether the toolbar items' should be selected by the user or not.
14649 * @param obj The toolbar object.
14650 * @param wrap @c EINA_TRUE to disable selection or @c EINA_FALSE to
14653 * This will turn off the ability to select items entirely and they will
14654 * neither appear selected nor emit selected signals. The clicked
14655 * callback function will still be called.
14657 * Selection is enabled by default.
14659 * @see elm_toolbar_no_select_mode_get().
14663 EAPI void elm_toolbar_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
14666 * Set whether the toolbar items' should be selected by the user or not.
14668 * @param obj The toolbar object.
14669 * @return @c EINA_TRUE means items can be selected. @c EINA_FALSE indicates
14670 * they can't. If @p obj is @c NULL, @c EINA_FALSE is returned.
14672 * @see elm_toolbar_no_select_mode_set() for details.
14676 EAPI Eina_Bool elm_toolbar_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14679 * Append item to the toolbar.
14681 * @param obj The toolbar object.
14682 * @param icon A string with icon name or the absolute path of an image file.
14683 * @param label The label of the item.
14684 * @param func The function to call when the item is clicked.
14685 * @param data The data to associate with the item for related callbacks.
14686 * @return The created item or @c NULL upon failure.
14688 * A new item will be created and appended to the toolbar, i.e., will
14689 * be set as @b last item.
14691 * Items created with this method can be deleted with
14692 * elm_toolbar_item_del().
14694 * Associated @p data can be properly freed when item is deleted if a
14695 * callback function is set with elm_toolbar_item_del_cb_set().
14697 * If a function is passed as argument, it will be called everytime this item
14698 * is selected, i.e., the user clicks over an unselected item.
14699 * If such function isn't needed, just passing
14700 * @c NULL as @p func is enough. The same should be done for @p data.
14702 * Toolbar will load icon image from fdo or current theme.
14703 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
14704 * If an absolute path is provided it will load it direct from a file.
14706 * @see elm_toolbar_item_icon_set()
14707 * @see elm_toolbar_item_del()
14708 * @see elm_toolbar_item_del_cb_set()
14712 EAPI Elm_Toolbar_Item *elm_toolbar_item_append(Evas_Object *obj, const char *icon, const char *label, Evas_Smart_Cb func, const void *data) EINA_ARG_NONNULL(1);
14715 * Prepend item to the toolbar.
14717 * @param obj The toolbar object.
14718 * @param icon A string with icon name or the absolute path of an image file.
14719 * @param label The label of the item.
14720 * @param func The function to call when the item is clicked.
14721 * @param data The data to associate with the item for related callbacks.
14722 * @return The created item or @c NULL upon failure.
14724 * A new item will be created and prepended to the toolbar, i.e., will
14725 * be set as @b first item.
14727 * Items created with this method can be deleted with
14728 * elm_toolbar_item_del().
14730 * Associated @p data can be properly freed when item is deleted if a
14731 * callback function is set with elm_toolbar_item_del_cb_set().
14733 * If a function is passed as argument, it will be called everytime this item
14734 * is selected, i.e., the user clicks over an unselected item.
14735 * If such function isn't needed, just passing
14736 * @c NULL as @p func is enough. The same should be done for @p data.
14738 * Toolbar will load icon image from fdo or current theme.
14739 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
14740 * If an absolute path is provided it will load it direct from a file.
14742 * @see elm_toolbar_item_icon_set()
14743 * @see elm_toolbar_item_del()
14744 * @see elm_toolbar_item_del_cb_set()
14748 EAPI Elm_Toolbar_Item *elm_toolbar_item_prepend(Evas_Object *obj, const char *icon, const char *label, Evas_Smart_Cb func, const void *data) EINA_ARG_NONNULL(1);
14751 * Insert a new item into the toolbar object before item @p before.
14753 * @param obj The toolbar object.
14754 * @param before The toolbar item to insert before.
14755 * @param icon A string with icon name or the absolute path of an image file.
14756 * @param label The label of the item.
14757 * @param func The function to call when the item is clicked.
14758 * @param data The data to associate with the item for related callbacks.
14759 * @return The created item or @c NULL upon failure.
14761 * A new item will be created and added to the toolbar. Its position in
14762 * this toolbar will be just before item @p before.
14764 * Items created with this method can be deleted with
14765 * elm_toolbar_item_del().
14767 * Associated @p data can be properly freed when item is deleted if a
14768 * callback function is set with elm_toolbar_item_del_cb_set().
14770 * If a function is passed as argument, it will be called everytime this item
14771 * is selected, i.e., the user clicks over an unselected item.
14772 * If such function isn't needed, just passing
14773 * @c NULL as @p func is enough. The same should be done for @p data.
14775 * Toolbar will load icon image from fdo or current theme.
14776 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
14777 * If an absolute path is provided it will load it direct from a file.
14779 * @see elm_toolbar_item_icon_set()
14780 * @see elm_toolbar_item_del()
14781 * @see elm_toolbar_item_del_cb_set()
14785 EAPI Elm_Toolbar_Item *elm_toolbar_item_insert_before(Evas_Object *obj, Elm_Toolbar_Item *before, const char *icon, const char *label, Evas_Smart_Cb func, const void *data) EINA_ARG_NONNULL(1);
14788 * Insert a new item into the toolbar object after item @p after.
14790 * @param obj The toolbar object.
14791 * @param after The toolbar item to insert after.
14792 * @param icon A string with icon name or the absolute path of an image file.
14793 * @param label The label of the item.
14794 * @param func The function to call when the item is clicked.
14795 * @param data The data to associate with the item for related callbacks.
14796 * @return The created item or @c NULL upon failure.
14798 * A new item will be created and added to the toolbar. Its position in
14799 * this toolbar will be just after item @p after.
14801 * Items created with this method can be deleted with
14802 * elm_toolbar_item_del().
14804 * Associated @p data can be properly freed when item is deleted if a
14805 * callback function is set with elm_toolbar_item_del_cb_set().
14807 * If a function is passed as argument, it will be called everytime this item
14808 * is selected, i.e., the user clicks over an unselected item.
14809 * If such function isn't needed, just passing
14810 * @c NULL as @p func is enough. The same should be done for @p data.
14812 * Toolbar will load icon image from fdo or current theme.
14813 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
14814 * If an absolute path is provided it will load it direct from a file.
14816 * @see elm_toolbar_item_icon_set()
14817 * @see elm_toolbar_item_del()
14818 * @see elm_toolbar_item_del_cb_set()
14822 EAPI Elm_Toolbar_Item *elm_toolbar_item_insert_after(Evas_Object *obj, Elm_Toolbar_Item *after, const char *icon, const char *label, Evas_Smart_Cb func, const void *data) EINA_ARG_NONNULL(1);
14825 * Get the first item in the given toolbar widget's list of
14828 * @param obj The toolbar object
14829 * @return The first item or @c NULL, if it has no items (and on
14832 * @see elm_toolbar_item_append()
14833 * @see elm_toolbar_last_item_get()
14837 EAPI Elm_Toolbar_Item *elm_toolbar_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14840 * Get the last item in the given toolbar widget's list of
14843 * @param obj The toolbar object
14844 * @return The last item or @c NULL, if it has no items (and on
14847 * @see elm_toolbar_item_prepend()
14848 * @see elm_toolbar_first_item_get()
14852 EAPI Elm_Toolbar_Item *elm_toolbar_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14855 * Get the item after @p item in toolbar.
14857 * @param item The toolbar item.
14858 * @return The item after @p item, or @c NULL if none or on failure.
14860 * @note If it is the last item, @c NULL will be returned.
14862 * @see elm_toolbar_item_append()
14866 EAPI Elm_Toolbar_Item *elm_toolbar_item_next_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14869 * Get the item before @p item in toolbar.
14871 * @param item The toolbar item.
14872 * @return The item before @p item, or @c NULL if none or on failure.
14874 * @note If it is the first item, @c NULL will be returned.
14876 * @see elm_toolbar_item_prepend()
14880 EAPI Elm_Toolbar_Item *elm_toolbar_item_prev_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14883 * Get the toolbar object from an item.
14885 * @param item The item.
14886 * @return The toolbar object.
14888 * This returns the toolbar object itself that an item belongs to.
14892 EAPI Evas_Object *elm_toolbar_item_toolbar_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14895 * Set the priority of a toolbar item.
14897 * @param item The toolbar item.
14898 * @param priority The item priority. The default is zero.
14900 * This is used only when the toolbar shrink mode is set to
14901 * #ELM_TOOLBAR_SHRINK_MENU or #ELM_TOOLBAR_SHRINK_HIDE.
14902 * When space is less than required, items with low priority
14903 * will be removed from the toolbar and added to a dynamically-created menu,
14904 * while items with higher priority will remain on the toolbar,
14905 * with the same order they were added.
14907 * @see elm_toolbar_item_priority_get()
14911 EAPI void elm_toolbar_item_priority_set(Elm_Toolbar_Item *item, int priority) EINA_ARG_NONNULL(1);
14914 * Get the priority of a toolbar item.
14916 * @param item The toolbar item.
14917 * @return The @p item priority, or @c 0 on failure.
14919 * @see elm_toolbar_item_priority_set() for details.
14923 EAPI int elm_toolbar_item_priority_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14926 * Get the label of item.
14928 * @param item The item of toolbar.
14929 * @return The label of item.
14931 * The return value is a pointer to the label associated to @p item when
14932 * it was created, with function elm_toolbar_item_append() or similar,
14934 * with function elm_toolbar_item_label_set. If no label
14935 * was passed as argument, it will return @c NULL.
14937 * @see elm_toolbar_item_label_set() for more details.
14938 * @see elm_toolbar_item_append()
14942 EAPI const char *elm_toolbar_item_label_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14945 * Set the label of item.
14947 * @param item The item of toolbar.
14948 * @param text The label of item.
14950 * The label to be displayed by the item.
14951 * Label will be placed at icons bottom (if set).
14953 * If a label was passed as argument on item creation, with function
14954 * elm_toolbar_item_append() or similar, it will be already
14955 * displayed by the item.
14957 * @see elm_toolbar_item_label_get()
14958 * @see elm_toolbar_item_append()
14962 EAPI void elm_toolbar_item_label_set(Elm_Toolbar_Item *item, const char *label) EINA_ARG_NONNULL(1);
14965 * Return the data associated with a given toolbar widget item.
14967 * @param item The toolbar widget item handle.
14968 * @return The data associated with @p item.
14970 * @see elm_toolbar_item_data_set()
14974 EAPI void *elm_toolbar_item_data_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14977 * Set the data associated with a given toolbar widget item.
14979 * @param item The toolbar widget item handle.
14980 * @param data The new data pointer to set to @p item.
14982 * This sets new item data on @p item.
14984 * @warning The old data pointer won't be touched by this function, so
14985 * the user had better to free that old data himself/herself.
14989 EAPI void elm_toolbar_item_data_set(Elm_Toolbar_Item *item, const void *data) EINA_ARG_NONNULL(1);
14992 * Returns a pointer to a toolbar item by its label.
14994 * @param obj The toolbar object.
14995 * @param label The label of the item to find.
14997 * @return The pointer to the toolbar item matching @p label or @c NULL
15002 EAPI Elm_Toolbar_Item *elm_toolbar_item_find_by_label(const Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
15005 * Get whether the @p item is selected or not.
15007 * @param item The toolbar item.
15008 * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
15009 * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
15011 * @see elm_toolbar_selected_item_set() for details.
15012 * @see elm_toolbar_item_selected_get()
15016 EAPI Eina_Bool elm_toolbar_item_selected_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15019 * Set the selected state of an item.
15021 * @param item The toolbar item
15022 * @param selected The selected state
15024 * This sets the selected state of the given item @p it.
15025 * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
15027 * If a new item is selected the previosly selected will be unselected.
15028 * Previoulsy selected item can be get with function
15029 * elm_toolbar_selected_item_get().
15031 * Selected items will be highlighted.
15033 * @see elm_toolbar_item_selected_get()
15034 * @see elm_toolbar_selected_item_get()
15038 EAPI void elm_toolbar_item_selected_set(Elm_Toolbar_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
15041 * Get the selected item.
15043 * @param obj The toolbar object.
15044 * @return The selected toolbar item.
15046 * The selected item can be unselected with function
15047 * elm_toolbar_item_selected_set().
15049 * The selected item always will be highlighted on toolbar.
15051 * @see elm_toolbar_selected_items_get()
15055 EAPI Elm_Toolbar_Item *elm_toolbar_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15058 * Set the icon associated with @p item.
15060 * @param obj The parent of this item.
15061 * @param item The toolbar item.
15062 * @param icon A string with icon name or the absolute path of an image file.
15064 * Toolbar will load icon image from fdo or current theme.
15065 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
15066 * If an absolute path is provided it will load it direct from a file.
15068 * @see elm_toolbar_icon_order_lookup_set()
15069 * @see elm_toolbar_icon_order_lookup_get()
15073 EAPI void elm_toolbar_item_icon_set(Elm_Toolbar_Item *item, const char *icon) EINA_ARG_NONNULL(1);
15076 * Get the string used to set the icon of @p item.
15078 * @param item The toolbar item.
15079 * @return The string associated with the icon object.
15081 * @see elm_toolbar_item_icon_set() for details.
15085 EAPI const char *elm_toolbar_item_icon_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15088 * Get the object of @p item.
15090 * @param item The toolbar item.
15091 * @return The object
15095 EAPI Evas_Object *elm_toolbar_item_object_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15098 * Get the icon object of @p item.
15100 * @param item The toolbar item.
15101 * @return The icon object
15103 * @see elm_toolbar_item_icon_set() or elm_toolbar_item_icon_memfile_set() for details.
15107 EAPI Evas_Object *elm_toolbar_item_icon_object_get(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15110 * Set the icon associated with @p item to an image in a binary buffer.
15112 * @param item The toolbar item.
15113 * @param img The binary data that will be used as an image
15114 * @param size The size of binary data @p img
15115 * @param format Optional format of @p img to pass to the image loader
15116 * @param key Optional key of @p img to pass to the image loader (eg. if @p img is an edje file)
15118 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
15120 * @note The icon image set by this function can be changed by
15121 * elm_toolbar_item_icon_set().
15125 EAPI Eina_Bool elm_toolbar_item_icon_memfile_set(Elm_Toolbar_Item *item, const void *img, size_t size, const char *format, const char *key) EINA_ARG_NONNULL(1);
15128 * Delete them item from the toolbar.
15130 * @param item The item of toolbar to be deleted.
15132 * @see elm_toolbar_item_append()
15133 * @see elm_toolbar_item_del_cb_set()
15137 EAPI void elm_toolbar_item_del(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15140 * Set the function called when a toolbar item is freed.
15142 * @param item The item to set the callback on.
15143 * @param func The function called.
15145 * If there is a @p func, then it will be called prior item's memory release.
15146 * That will be called with the following arguments:
15148 * @li item's Evas object;
15151 * This way, a data associated to a toolbar item could be properly freed.
15155 EAPI void elm_toolbar_item_del_cb_set(Elm_Toolbar_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
15158 * Get a value whether toolbar item is disabled or not.
15160 * @param item The item.
15161 * @return The disabled state.
15163 * @see elm_toolbar_item_disabled_set() for more details.
15167 EAPI Eina_Bool elm_toolbar_item_disabled_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15170 * Sets the disabled/enabled state of a toolbar item.
15172 * @param item The item.
15173 * @param disabled The disabled state.
15175 * A disabled item cannot be selected or unselected. It will also
15176 * change its appearance (generally greyed out). This sets the
15177 * disabled state (@c EINA_TRUE for disabled, @c EINA_FALSE for
15182 EAPI void elm_toolbar_item_disabled_set(Elm_Toolbar_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
15185 * Set or unset item as a separator.
15187 * @param item The toolbar item.
15188 * @param setting @c EINA_TRUE to set item @p item as separator or
15189 * @c EINA_FALSE to unset, i.e., item will be used as a regular item.
15191 * Items aren't set as separator by default.
15193 * If set as separator it will display separator theme, so won't display
15196 * @see elm_toolbar_item_separator_get()
15200 EAPI void elm_toolbar_item_separator_set(Elm_Toolbar_Item *item, Eina_Bool separator) EINA_ARG_NONNULL(1);
15203 * Get a value whether item is a separator or not.
15205 * @param item The toolbar item.
15206 * @return @c EINA_TRUE means item @p it is a separator. @c EINA_FALSE
15207 * indicates it's not. If @p it is @c NULL, @c EINA_FALSE is returned.
15209 * @see elm_toolbar_item_separator_set() for details.
15213 EAPI Eina_Bool elm_toolbar_item_separator_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15216 * Set the shrink state of toolbar @p obj.
15218 * @param obj The toolbar object.
15219 * @param shrink_mode Toolbar's items display behavior.
15221 * The toolbar won't scroll if #ELM_TOOLBAR_SHRINK_NONE,
15222 * but will enforce a minimun size so all the items will fit, won't scroll
15223 * and won't show the items that don't fit if #ELM_TOOLBAR_SHRINK_HIDE,
15224 * will scroll if #ELM_TOOLBAR_SHRINK_SCROLL, and will create a button to
15225 * pop up excess elements with #ELM_TOOLBAR_SHRINK_MENU.
15229 EAPI void elm_toolbar_mode_shrink_set(Evas_Object *obj, Elm_Toolbar_Shrink_Mode shrink_mode) EINA_ARG_NONNULL(1);
15232 * Get the shrink mode of toolbar @p obj.
15234 * @param obj The toolbar object.
15235 * @return Toolbar's items display behavior.
15237 * @see elm_toolbar_mode_shrink_set() for details.
15241 EAPI Elm_Toolbar_Shrink_Mode elm_toolbar_mode_shrink_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15244 * Enable/disable homogeneous mode.
15246 * @param obj The toolbar object
15247 * @param homogeneous Assume the items within the toolbar are of the
15248 * same size (EINA_TRUE = on, EINA_FALSE = off). Default is @c EINA_FALSE.
15250 * This will enable the homogeneous mode where items are of the same size.
15251 * @see elm_toolbar_homogeneous_get()
15255 EAPI void elm_toolbar_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
15258 * Get whether the homogeneous mode is enabled.
15260 * @param obj The toolbar object.
15261 * @return Assume the items within the toolbar are of the same height
15262 * and width (EINA_TRUE = on, EINA_FALSE = off).
15264 * @see elm_toolbar_homogeneous_set()
15268 EAPI Eina_Bool elm_toolbar_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15270 * Set the parent object of the toolbar items' menus.
15272 * @param obj The toolbar object.
15273 * @param parent The parent of the menu objects.
15275 * Each item can be set as item menu, with elm_toolbar_item_menu_set().
15277 * For more details about setting the parent for toolbar menus, see
15278 * elm_menu_parent_set().
15280 * @see elm_menu_parent_set() for details.
15281 * @see elm_toolbar_item_menu_set() for details.
15285 EAPI void elm_toolbar_menu_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
15288 * Get the parent object of the toolbar items' menus.
15290 * @param obj The toolbar object.
15291 * @return The parent of the menu objects.
15293 * @see elm_toolbar_menu_parent_set() for details.
15297 EAPI Evas_Object *elm_toolbar_menu_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15300 * Set the alignment of the items.
15302 * @param obj The toolbar object.
15303 * @param align The new alignment, a float between <tt> 0.0 </tt>
15304 * and <tt> 1.0 </tt>.
15306 * Alignment of toolbar items, from <tt> 0.0 </tt> to indicates to align
15307 * left, to <tt> 1.0 </tt>, to align to right. <tt> 0.5 </tt> centralize
15310 * Centered items by default.
15312 * @see elm_toolbar_align_get()
15316 EAPI void elm_toolbar_align_set(Evas_Object *obj, double align) EINA_ARG_NONNULL(1);
15319 * Get the alignment of the items.
15321 * @param obj The toolbar object.
15322 * @return toolbar items alignment, a float between <tt> 0.0 </tt> and
15325 * @see elm_toolbar_align_set() for details.
15329 EAPI double elm_toolbar_align_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15332 * Set whether the toolbar item opens a menu.
15334 * @param item The toolbar item.
15335 * @param menu If @c EINA_TRUE, @p item will opens a menu when selected.
15337 * A toolbar item can be set to be a menu, using this function.
15339 * Once it is set to be a menu, it can be manipulated through the
15340 * menu-like function elm_toolbar_menu_parent_set() and the other
15341 * elm_menu functions, using the Evas_Object @c menu returned by
15342 * elm_toolbar_item_menu_get().
15344 * So, items to be displayed in this item's menu should be added with
15345 * elm_menu_item_add().
15347 * The following code exemplifies the most basic usage:
15349 * tb = elm_toolbar_add(win)
15350 * item = elm_toolbar_item_append(tb, "refresh", "Menu", NULL, NULL);
15351 * elm_toolbar_item_menu_set(item, EINA_TRUE);
15352 * elm_toolbar_menu_parent_set(tb, win);
15353 * menu = elm_toolbar_item_menu_get(item);
15354 * elm_menu_item_add(menu, NULL, "edit-cut", "Cut", NULL, NULL);
15355 * menu_item = elm_menu_item_add(menu, NULL, "edit-copy", "Copy", NULL,
15359 * @see elm_toolbar_item_menu_get()
15363 EAPI void elm_toolbar_item_menu_set(Elm_Toolbar_Item *item, Eina_Bool menu) EINA_ARG_NONNULL(1);
15366 * Get toolbar item's menu.
15368 * @param item The toolbar item.
15369 * @return Item's menu object or @c NULL on failure.
15371 * If @p item wasn't set as menu item with elm_toolbar_item_menu_set(),
15372 * this function will set it.
15374 * @see elm_toolbar_item_menu_set() for details.
15378 EAPI Evas_Object *elm_toolbar_item_menu_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15381 * Add a new state to @p item.
15383 * @param item The item.
15384 * @param icon A string with icon name or the absolute path of an image file.
15385 * @param label The label of the new state.
15386 * @param func The function to call when the item is clicked when this
15387 * state is selected.
15388 * @param data The data to associate with the state.
15389 * @return The toolbar item state, or @c NULL upon failure.
15391 * Toolbar will load icon image from fdo or current theme.
15392 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
15393 * If an absolute path is provided it will load it direct from a file.
15395 * States created with this function can be removed with
15396 * elm_toolbar_item_state_del().
15398 * @see elm_toolbar_item_state_del()
15399 * @see elm_toolbar_item_state_sel()
15400 * @see elm_toolbar_item_state_get()
15404 EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_add(Elm_Toolbar_Item *item, const char *icon, const char *label, Evas_Smart_Cb func, const void *data) EINA_ARG_NONNULL(1);
15407 * Delete a previoulsy added state to @p item.
15409 * @param item The toolbar item.
15410 * @param state The state to be deleted.
15411 * @return @c EINA_TRUE on success or @c EINA_FALSE on failure.
15413 * @see elm_toolbar_item_state_add()
15415 EAPI Eina_Bool elm_toolbar_item_state_del(Elm_Toolbar_Item *item, Elm_Toolbar_Item_State *state) EINA_ARG_NONNULL(1);
15418 * Set @p state as the current state of @p it.
15420 * @param it The item.
15421 * @param state The state to use.
15422 * @return @c EINA_TRUE on success or @c EINA_FALSE on failure.
15424 * If @p state is @c NULL, it won't select any state and the default item's
15425 * icon and label will be used. It's the same behaviour than
15426 * elm_toolbar_item_state_unser().
15428 * @see elm_toolbar_item_state_unset()
15432 EAPI Eina_Bool elm_toolbar_item_state_set(Elm_Toolbar_Item *it, Elm_Toolbar_Item_State *state) EINA_ARG_NONNULL(1);
15435 * Unset the state of @p it.
15437 * @param it The item.
15439 * The default icon and label from this item will be displayed.
15441 * @see elm_toolbar_item_state_set() for more details.
15445 EAPI void elm_toolbar_item_state_unset(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
15448 * Get the current state of @p it.
15450 * @param item The item.
15451 * @return The selected state or @c NULL if none is selected or on failure.
15453 * @see elm_toolbar_item_state_set() for details.
15454 * @see elm_toolbar_item_state_unset()
15455 * @see elm_toolbar_item_state_add()
15459 EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_get(const Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
15462 * Get the state after selected state in toolbar's @p item.
15464 * @param it The toolbar item to change state.
15465 * @return The state after current state, or @c NULL on failure.
15467 * If last state is selected, this function will return first state.
15469 * @see elm_toolbar_item_state_set()
15470 * @see elm_toolbar_item_state_add()
15474 EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_next(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
15477 * Get the state before selected state in toolbar's @p item.
15479 * @param it The toolbar item to change state.
15480 * @return The state before current state, or @c NULL on failure.
15482 * If first state is selected, this function will return last state.
15484 * @see elm_toolbar_item_state_set()
15485 * @see elm_toolbar_item_state_add()
15489 EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_prev(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
15492 * Set the text to be shown in a given toolbar item's tooltips.
15494 * @param item Target item.
15495 * @param text The text to set in the content.
15497 * Setup the text as tooltip to object. The item can have only one tooltip,
15498 * so any previous tooltip data - set with this function or
15499 * elm_toolbar_item_tooltip_content_cb_set() - is removed.
15501 * @see elm_object_tooltip_text_set() for more details.
15505 EAPI void elm_toolbar_item_tooltip_text_set(Elm_Toolbar_Item *item, const char *text) EINA_ARG_NONNULL(1);
15508 * Set the content to be shown in the tooltip item.
15510 * Setup the tooltip to item. The item can have only one tooltip,
15511 * so any previous tooltip data is removed. @p func(with @p data) will
15512 * be called every time that need show the tooltip and it should
15513 * return a valid Evas_Object. This object is then managed fully by
15514 * tooltip system and is deleted when the tooltip is gone.
15516 * @param item the toolbar item being attached a tooltip.
15517 * @param func the function used to create the tooltip contents.
15518 * @param data what to provide to @a func as callback data/context.
15519 * @param del_cb called when data is not needed anymore, either when
15520 * another callback replaces @a func, the tooltip is unset with
15521 * elm_toolbar_item_tooltip_unset() or the owner @a item
15522 * dies. This callback receives as the first parameter the
15523 * given @a data, and @c event_info is the item.
15525 * @see elm_object_tooltip_content_cb_set() for more details.
15529 EAPI void elm_toolbar_item_tooltip_content_cb_set(Elm_Toolbar_Item *item, Elm_Tooltip_Item_Content_Cb func, const void *data, Evas_Smart_Cb del_cb) EINA_ARG_NONNULL(1);
15532 * Unset tooltip from item.
15534 * @param item toolbar item to remove previously set tooltip.
15536 * Remove tooltip from item. The callback provided as del_cb to
15537 * elm_toolbar_item_tooltip_content_cb_set() will be called to notify
15538 * it is not used anymore.
15540 * @see elm_object_tooltip_unset() for more details.
15541 * @see elm_toolbar_item_tooltip_content_cb_set()
15545 EAPI void elm_toolbar_item_tooltip_unset(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15548 * Sets a different style for this item tooltip.
15550 * @note before you set a style you should define a tooltip with
15551 * elm_toolbar_item_tooltip_content_cb_set() or
15552 * elm_toolbar_item_tooltip_text_set()
15554 * @param item toolbar item with tooltip already set.
15555 * @param style the theme style to use (default, transparent, ...)
15557 * @see elm_object_tooltip_style_set() for more details.
15561 EAPI void elm_toolbar_item_tooltip_style_set(Elm_Toolbar_Item *item, const char *style) EINA_ARG_NONNULL(1);
15564 * Get the style for this item tooltip.
15566 * @param item toolbar item with tooltip already set.
15567 * @return style the theme style in use, defaults to "default". If the
15568 * object does not have a tooltip set, then NULL is returned.
15570 * @see elm_object_tooltip_style_get() for more details.
15571 * @see elm_toolbar_item_tooltip_style_set()
15575 EAPI const char *elm_toolbar_item_tooltip_style_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15578 * Set the type of mouse pointer/cursor decoration to be shown,
15579 * when the mouse pointer is over the given toolbar widget item
15581 * @param item toolbar item to customize cursor on
15582 * @param cursor the cursor type's name
15584 * This function works analogously as elm_object_cursor_set(), but
15585 * here the cursor's changing area is restricted to the item's
15586 * area, and not the whole widget's. Note that that item cursors
15587 * have precedence over widget cursors, so that a mouse over an
15588 * item with custom cursor set will always show @b that cursor.
15590 * If this function is called twice for an object, a previously set
15591 * cursor will be unset on the second call.
15593 * @see elm_object_cursor_set()
15594 * @see elm_toolbar_item_cursor_get()
15595 * @see elm_toolbar_item_cursor_unset()
15599 EAPI void elm_toolbar_item_cursor_set(Elm_Toolbar_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
15602 * Get the type of mouse pointer/cursor decoration set to be shown,
15603 * when the mouse pointer is over the given toolbar widget item
15605 * @param item toolbar item with custom cursor set
15606 * @return the cursor type's name or @c NULL, if no custom cursors
15607 * were set to @p item (and on errors)
15609 * @see elm_object_cursor_get()
15610 * @see elm_toolbar_item_cursor_set()
15611 * @see elm_toolbar_item_cursor_unset()
15615 EAPI const char *elm_toolbar_item_cursor_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15618 * Unset any custom mouse pointer/cursor decoration set to be
15619 * shown, when the mouse pointer is over the given toolbar widget
15620 * item, thus making it show the @b default cursor again.
15622 * @param item a toolbar item
15624 * Use this call to undo any custom settings on this item's cursor
15625 * decoration, bringing it back to defaults (no custom style set).
15627 * @see elm_object_cursor_unset()
15628 * @see elm_toolbar_item_cursor_set()
15632 EAPI void elm_toolbar_item_cursor_unset(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15635 * Set a different @b style for a given custom cursor set for a
15638 * @param item toolbar item with custom cursor set
15639 * @param style the <b>theme style</b> to use (e.g. @c "default",
15640 * @c "transparent", etc)
15642 * This function only makes sense when one is using custom mouse
15643 * cursor decorations <b>defined in a theme file</b>, which can have,
15644 * given a cursor name/type, <b>alternate styles</b> on it. It
15645 * works analogously as elm_object_cursor_style_set(), but here
15646 * applyed only to toolbar item objects.
15648 * @warning Before you set a cursor style you should have definen a
15649 * custom cursor previously on the item, with
15650 * elm_toolbar_item_cursor_set()
15652 * @see elm_toolbar_item_cursor_engine_only_set()
15653 * @see elm_toolbar_item_cursor_style_get()
15657 EAPI void elm_toolbar_item_cursor_style_set(Elm_Toolbar_Item *item, const char *style) EINA_ARG_NONNULL(1);
15660 * Get the current @b style set for a given toolbar item's custom
15663 * @param item toolbar item with custom cursor set.
15664 * @return style the cursor style in use. If the object does not
15665 * have a cursor set, then @c NULL is returned.
15667 * @see elm_toolbar_item_cursor_style_set() for more details
15671 EAPI const char *elm_toolbar_item_cursor_style_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15674 * Set if the (custom)cursor for a given toolbar item should be
15675 * searched in its theme, also, or should only rely on the
15676 * rendering engine.
15678 * @param item item with custom (custom) cursor already set on
15679 * @param engine_only Use @c EINA_TRUE to have cursors looked for
15680 * only on those provided by the rendering engine, @c EINA_FALSE to
15681 * have them searched on the widget's theme, as well.
15683 * @note This call is of use only if you've set a custom cursor
15684 * for toolbar items, with elm_toolbar_item_cursor_set().
15686 * @note By default, cursors will only be looked for between those
15687 * provided by the rendering engine.
15691 EAPI void elm_toolbar_item_cursor_engine_only_set(Elm_Toolbar_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
15694 * Get if the (custom) cursor for a given toolbar item is being
15695 * searched in its theme, also, or is only relying on the rendering
15698 * @param item a toolbar item
15699 * @return @c EINA_TRUE, if cursors are being looked for only on
15700 * those provided by the rendering engine, @c EINA_FALSE if they
15701 * are being searched on the widget's theme, as well.
15703 * @see elm_toolbar_item_cursor_engine_only_set(), for more details
15707 EAPI Eina_Bool elm_toolbar_item_cursor_engine_only_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15710 * Change a toolbar's orientation
15711 * @param obj The toolbar object
15712 * @param vertical If @c EINA_TRUE, the toolbar is vertical
15713 * By default, a toolbar will be horizontal. Use this function to create a vertical toolbar.
15715 * @deprecated use elm_toolbar_horizontal_set() instead.
15717 EINA_DEPRECATED EAPI void elm_toolbar_orientation_set(Evas_Object *obj, Eina_Bool vertical) EINA_ARG_NONNULL(1);
15720 * Change a toolbar's orientation
15721 * @param obj The toolbar object
15722 * @param horizontal If @c EINA_TRUE, the toolbar is horizontal
15723 * By default, a toolbar will be horizontal. Use this function to create a vertical toolbar.
15726 EAPI void elm_toolbar_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
15729 * Get a toolbar's orientation
15730 * @param obj The toolbar object
15731 * @return If @c EINA_TRUE, the toolbar is vertical
15732 * By default, a toolbar will be horizontal. Use this function to determine whether a toolbar is vertical.
15734 * @deprecated use elm_toolbar_horizontal_get() instead.
15736 EINA_DEPRECATED EAPI Eina_Bool elm_toolbar_orientation_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15739 * Get a toolbar's orientation
15740 * @param obj The toolbar object
15741 * @return If @c EINA_TRUE, the toolbar is horizontal
15742 * By default, a toolbar will be horizontal. Use this function to determine whether a toolbar is vertical.
15745 EAPI Eina_Bool elm_toolbar_horizontal_get(const Evas_Object *obj);
15751 * @defgroup Tooltips Tooltips
15753 * The Tooltip is an (internal, for now) smart object used to show a
15754 * content in a frame on mouse hover of objects(or widgets), with
15755 * tips/information about them.
15760 EAPI double elm_tooltip_delay_get(void);
15761 EAPI Eina_Bool elm_tooltip_delay_set(double delay);
15762 EAPI void elm_object_tooltip_show(Evas_Object *obj) EINA_ARG_NONNULL(1);
15763 EAPI void elm_object_tooltip_hide(Evas_Object *obj) EINA_ARG_NONNULL(1);
15764 EAPI void elm_object_tooltip_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1, 2);
15765 EAPI void elm_object_tooltip_domain_translatable_text_set(Evas_Object *obj, const char *domain, const char *text) EINA_ARG_NONNULL(1, 3);
15766 #define elm_object_tooltip_translatable_text_set(obj, text) elm_object_tooltip_domain_translatable_text_set((obj), NULL, (text))
15767 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);
15768 EAPI void elm_object_tooltip_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
15769 EAPI void elm_object_tooltip_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
15770 EAPI const char *elm_object_tooltip_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15771 EAPI Eina_Bool elm_tooltip_size_restrict_disable(Evas_Object *obj, Eina_Bool disable) EINA_ARG_NONNULL(1);
15772 EAPI Eina_Bool elm_tooltip_size_restrict_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15779 * @defgroup Cursors Cursors
15781 * The Elementary cursor is an internal smart object used to
15782 * customize the mouse cursor displayed over objects (or
15783 * widgets). In the most common scenario, the cursor decoration
15784 * comes from the graphical @b engine Elementary is running
15785 * on. Those engines may provide different decorations for cursors,
15786 * and Elementary provides functions to choose them (think of X11
15787 * cursors, as an example).
15789 * There's also the possibility of, besides using engine provided
15790 * cursors, also use ones coming from Edje theming files. Both
15791 * globally and per widget, Elementary makes it possible for one to
15792 * make the cursors lookup to be held on engines only or on
15793 * Elementary's theme file, too. To set cursor's hot spot,
15794 * two data items should be added to cursor's theme: "hot_x" and
15795 * "hot_y", that are the offset from upper-left corner of the cursor
15796 * (coordinates 0,0).
15802 * Set the cursor to be shown when mouse is over the object
15804 * Set the cursor that will be displayed when mouse is over the
15805 * object. The object can have only one cursor set to it, so if
15806 * this function is called twice for an object, the previous set
15808 * If using X cursors, a definition of all the valid cursor names
15809 * is listed on Elementary_Cursors.h. If an invalid name is set
15810 * the default cursor will be used.
15812 * @param obj the object being set a cursor.
15813 * @param cursor the cursor name to be used.
15817 EAPI void elm_object_cursor_set(Evas_Object *obj, const char *cursor) EINA_ARG_NONNULL(1);
15820 * Get the cursor to be shown when mouse is over the object
15822 * @param obj an object with cursor already set.
15823 * @return the cursor name.
15827 EAPI const char *elm_object_cursor_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15830 * Unset cursor for object
15832 * Unset cursor for object, and set the cursor to default if the mouse
15833 * was over this object.
15835 * @param obj Target object
15836 * @see elm_object_cursor_set()
15840 EAPI void elm_object_cursor_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
15843 * Sets a different style for this object cursor.
15845 * @note before you set a style you should define a cursor with
15846 * elm_object_cursor_set()
15848 * @param obj an object with cursor already set.
15849 * @param style the theme style to use (default, transparent, ...)
15853 EAPI void elm_object_cursor_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
15856 * Get the style for this object cursor.
15858 * @param obj an object with cursor already set.
15859 * @return style the theme style in use, defaults to "default". If the
15860 * object does not have a cursor set, then NULL is returned.
15864 EAPI const char *elm_object_cursor_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15867 * Set if the cursor set should be searched on the theme or should use
15868 * the provided by the engine, only.
15870 * @note before you set if should look on theme you should define a cursor
15871 * with elm_object_cursor_set(). By default it will only look for cursors
15872 * provided by the engine.
15874 * @param obj an object with cursor already set.
15875 * @param engine_only boolean to define it cursors should be looked only
15876 * between the provided by the engine or searched on widget's theme as well.
15880 EAPI void elm_object_cursor_engine_only_set(Evas_Object *obj, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
15883 * Get the cursor engine only usage for this object cursor.
15885 * @param obj an object with cursor already set.
15886 * @return engine_only boolean to define it cursors should be
15887 * looked only between the provided by the engine or searched on
15888 * widget's theme as well. If the object does not have a cursor
15889 * set, then EINA_FALSE is returned.
15893 EAPI Eina_Bool elm_object_cursor_engine_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15896 * Get the configured cursor engine only usage
15898 * This gets the globally configured exclusive usage of engine cursors.
15900 * @return 1 if only engine cursors should be used
15903 EAPI int elm_cursor_engine_only_get(void);
15906 * Set the configured cursor engine only usage
15908 * This sets the globally configured exclusive usage of engine cursors.
15909 * It won't affect cursors set before changing this value.
15911 * @param engine_only If 1 only engine cursors will be enabled, if 0 will
15912 * look for them on theme before.
15913 * @return EINA_TRUE if value is valid and setted (0 or 1)
15916 EAPI Eina_Bool elm_cursor_engine_only_set(int engine_only);
15923 * @defgroup Menu Menu
15925 * @image html img/widget/menu/preview-00.png
15926 * @image latex img/widget/menu/preview-00.eps
15928 * A menu is a list of items displayed above its parent. When the menu is
15929 * showing its parent is darkened. Each item can have a sub-menu. The menu
15930 * object can be used to display a menu on a right click event, in a toolbar,
15933 * Signals that you can add callbacks for are:
15934 * @li "clicked" - the user clicked the empty space in the menu to dismiss.
15936 * Default contents parts of the menu items that you can use for are:
15937 * @li "default" - A main content of the menu item
15939 * Default text parts of the menu items that you can use for are:
15940 * @li "default" - label in the menu item
15942 * @see @ref tutorial_menu
15947 * @brief Add a new menu to the parent
15949 * @param parent The parent object.
15950 * @return The new object or NULL if it cannot be created.
15952 EAPI Evas_Object *elm_menu_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
15954 * @brief Set the parent for the given menu widget
15956 * @param obj The menu object.
15957 * @param parent The new parent.
15959 EAPI void elm_menu_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
15961 * @brief Get the parent for the given menu widget
15963 * @param obj The menu object.
15964 * @return The parent.
15966 * @see elm_menu_parent_set()
15968 EAPI Evas_Object *elm_menu_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15970 * @brief Move the menu to a new position
15972 * @param obj The menu object.
15973 * @param x The new position.
15974 * @param y The new position.
15976 * Sets the top-left position of the menu to (@p x,@p y).
15978 * @note @p x and @p y coordinates are relative to parent.
15980 EAPI void elm_menu_move(Evas_Object *obj, Evas_Coord x, Evas_Coord y) EINA_ARG_NONNULL(1);
15982 * @brief Close a opened menu
15984 * @param obj the menu object
15987 * Hides the menu and all it's sub-menus.
15989 EAPI void elm_menu_close(Evas_Object *obj) EINA_ARG_NONNULL(1);
15991 * @brief Returns a list of @p item's items.
15993 * @param obj The menu object
15994 * @return An Eina_List* of @p item's items
15996 EAPI const Eina_List *elm_menu_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15998 * @brief Get the Evas_Object of an Elm_Menu_Item
16000 * @param it The menu item object.
16001 * @return The edje object containing the swallowed content
16003 * @warning Don't manipulate this object!
16006 EAPI Evas_Object *elm_menu_item_object_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
16008 * @brief Add an item at the end of the given menu widget
16010 * @param obj The menu object.
16011 * @param parent The parent menu item (optional)
16012 * @param icon A icon display on the item. The icon will be destryed by the menu.
16013 * @param label The label of the item.
16014 * @param func Function called when the user select the item.
16015 * @param data Data sent by the callback.
16016 * @return Returns the new item.
16018 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);
16020 * @brief Add an object swallowed in an item at the end of the given menu
16023 * @param obj The menu object.
16024 * @param parent The parent menu item (optional)
16025 * @param subobj The object to swallow
16026 * @param func Function called when the user select the item.
16027 * @param data Data sent by the callback.
16028 * @return Returns the new item.
16030 * Add an evas object as an item to the menu.
16032 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);
16034 * @brief Set the label of a menu item
16036 * @param it The menu item object.
16037 * @param label The label to set for @p item
16039 * @warning Don't use this funcion on items created with
16040 * elm_menu_item_add_object() or elm_menu_item_separator_add().
16042 * @deprecated Use elm_object_item_text_set() instead
16044 EINA_DEPRECATED EAPI void elm_menu_item_label_set(Elm_Object_Item *it, const char *label) EINA_ARG_NONNULL(1);
16046 * @brief Get the label of a menu item
16048 * @param it The menu item object.
16049 * @return The label of @p item
16050 * @deprecated Use elm_object_item_text_get() instead
16052 EINA_DEPRECATED EAPI const char *elm_menu_item_label_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
16054 * @brief Set the icon of a menu item to the standard icon with name @p icon
16056 * @param it The menu item object.
16057 * @param icon The icon object to set for the content of @p item
16059 * Once this icon is set, any previously set icon will be deleted.
16061 EAPI void elm_menu_item_object_icon_name_set(Elm_Object_Item *it, const char *icon) EINA_ARG_NONNULL(1, 2);
16063 * @brief Get the string representation from the icon of a menu item
16065 * @param it The menu item object.
16066 * @return The string representation of @p item's icon or NULL
16068 * @see elm_menu_item_object_icon_name_set()
16070 EAPI const char *elm_menu_item_object_icon_name_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
16072 * @brief Set the content object of a menu item
16074 * @param it The menu item object
16075 * @param The content object or NULL
16076 * @return EINA_TRUE on success, else EINA_FALSE
16078 * Use this function to change the object swallowed by a menu item, deleting
16079 * any previously swallowed object.
16081 * @deprecated Use elm_object_item_content_set() instead
16083 EINA_DEPRECATED EAPI Eina_Bool elm_menu_item_object_content_set(Elm_Object_Item *it, Evas_Object *obj) EINA_ARG_NONNULL(1);
16085 * @brief Get the content object of a menu item
16087 * @param it The menu item object
16088 * @return The content object or NULL
16089 * @note If @p item was added with elm_menu_item_add_object, this
16090 * function will return the object passed, else it will return the
16093 * @see elm_menu_item_object_content_set()
16095 * @deprecated Use elm_object_item_content_get() instead
16097 EINA_DEPRECATED EAPI Evas_Object *elm_menu_item_object_content_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
16099 * @brief Set the selected state of @p item.
16101 * @param it The menu item object.
16102 * @param selected The selected/unselected state of the item
16104 EAPI void elm_menu_item_selected_set(Elm_Object_Item *it, Eina_Bool selected) EINA_ARG_NONNULL(1);
16106 * @brief Get the selected state of @p item.
16108 * @param it The menu item object.
16109 * @return The selected/unselected state of the item
16111 * @see elm_menu_item_selected_set()
16113 EAPI Eina_Bool elm_menu_item_selected_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
16115 * @brief Set the disabled state of @p item.
16117 * @param it The menu item object.
16118 * @param disabled The enabled/disabled state of the item
16119 * @deprecated Use elm_object_item_disabled_set() instead
16121 EINA_DEPRECATED EAPI void elm_menu_item_disabled_set(Elm_Object_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1);
16123 * @brief Get the disabled state of @p item.
16125 * @param it The menu item object.
16126 * @return The enabled/disabled state of the item
16128 * @see elm_menu_item_disabled_set()
16129 * @deprecated Use elm_object_item_disabled_get() instead
16131 EINA_DEPRECATED EAPI Eina_Bool elm_menu_item_disabled_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
16133 * @brief Add a separator item to menu @p obj under @p parent.
16135 * @param obj The menu object
16136 * @param parent The item to add the separator under
16137 * @return The created item or NULL on failure
16139 * This is item is a @ref Separator.
16141 EAPI Elm_Object_Item *elm_menu_item_separator_add(Evas_Object *obj, Elm_Object_Item *parent) EINA_ARG_NONNULL(1);
16143 * @brief Returns whether @p item is a separator.
16145 * @param it The item to check
16146 * @return If true, @p item is a separator
16148 * @see elm_menu_item_separator_add()
16150 EAPI Eina_Bool elm_menu_item_is_separator(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
16152 * @brief Deletes an item from the menu.
16154 * @param it The item to delete.
16156 * @see elm_menu_item_add()
16158 EAPI void elm_menu_item_del(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
16160 * @brief Set the function called when a menu item is deleted.
16162 * @param it The item to set the callback on
16163 * @param func The function called
16165 * @see elm_menu_item_add()
16166 * @see elm_menu_item_del()
16168 EAPI void elm_menu_item_del_cb_set(Elm_Object_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
16170 * @brief Returns the data associated with menu item @p item.
16172 * @param it The item
16173 * @return The data associated with @p item or NULL if none was set.
16175 * This is the data set with elm_menu_add() or elm_menu_item_data_set().
16177 * @deprecated Use elm_object_item_data_get() instead
16179 EINA_DEPRECATED EAPI void *elm_menu_item_data_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
16181 * @brief Sets the data to be associated with menu item @p item.
16183 * @param it The item
16184 * @param data The data to be associated with @p item
16186 * @deprecated Use elm_object_item_data_set() instead
16188 EINA_DEPRECATED EAPI void elm_menu_item_data_set(Elm_Object_Item *it, const void *data) EINA_ARG_NONNULL(1);
16191 * @brief Returns a list of @p item's subitems.
16193 * @param it The item
16194 * @return An Eina_List* of @p item's subitems
16196 * @see elm_menu_add()
16198 EAPI const Eina_List *elm_menu_item_subitems_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
16200 * @brief Get the position of a menu item
16202 * @param it The menu item
16203 * @return The item's index
16205 * This function returns the index position of a menu item in a menu.
16206 * For a sub-menu, this number is relative to the first item in the sub-menu.
16208 * @note Index values begin with 0
16210 EAPI unsigned int elm_menu_item_index_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1) EINA_PURE;
16212 * @brief @brief Return a menu item's owner menu
16214 * @param it The menu item
16215 * @return The menu object owning @p item, or NULL on failure
16217 * Use this function to get the menu object owning an item.
16219 EAPI Evas_Object *elm_menu_item_menu_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1) EINA_PURE;
16221 * @brief Get the selected item in the menu
16223 * @param obj The menu object
16224 * @return The selected item, or NULL if none
16226 * @see elm_menu_item_selected_get()
16227 * @see elm_menu_item_selected_set()
16229 EAPI Elm_Object_Item *elm_menu_selected_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
16231 * @brief Get the last item in the menu
16233 * @param obj The menu object
16234 * @return The last item, or NULL if none
16236 EAPI Elm_Object_Item *elm_menu_last_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
16238 * @brief Get the first item in the menu
16240 * @param obj The menu object
16241 * @return The first item, or NULL if none
16243 EAPI Elm_Object_Item *elm_menu_first_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
16245 * @brief Get the next item in the menu.
16247 * @param it The menu item object.
16248 * @return The item after it, or NULL if none
16250 EAPI Elm_Object_Item *elm_menu_item_next_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
16252 * @brief Get the previous item in the menu.
16254 * @param it The menu item object.
16255 * @return The item before it, or NULL if none
16257 EAPI Elm_Object_Item *elm_menu_item_prev_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
16263 * @defgroup List List
16264 * @ingroup Elementary
16266 * @image html img/widget/list/preview-00.png
16267 * @image latex img/widget/list/preview-00.eps width=\textwidth
16269 * @image html img/list.png
16270 * @image latex img/list.eps width=\textwidth
16272 * A list widget is a container whose children are displayed vertically or
16273 * horizontally, in order, and can be selected.
16274 * The list can accept only one or multiple items selection. Also has many
16275 * modes of items displaying.
16277 * A list is a very simple type of list widget. For more robust
16278 * lists, @ref Genlist should probably be used.
16280 * Smart callbacks one can listen to:
16281 * - @c "activated" - The user has double-clicked or pressed
16282 * (enter|return|spacebar) on an item. The @c event_info parameter
16283 * is the item that was activated.
16284 * - @c "clicked,double" - The user has double-clicked an item.
16285 * The @c event_info parameter is the item that was double-clicked.
16286 * - "selected" - when the user selected an item
16287 * - "unselected" - when the user unselected an item
16288 * - "longpressed" - an item in the list is long-pressed
16289 * - "edge,top" - the list is scrolled until the top edge
16290 * - "edge,bottom" - the list is scrolled until the bottom edge
16291 * - "edge,left" - the list is scrolled until the left edge
16292 * - "edge,right" - the list is scrolled until the right edge
16293 * - "language,changed" - the program's language changed
16295 * Available styles for it:
16298 * List of examples:
16299 * @li @ref list_example_01
16300 * @li @ref list_example_02
16301 * @li @ref list_example_03
16310 * @enum _Elm_List_Mode
16311 * @typedef Elm_List_Mode
16313 * Set list's resize behavior, transverse axis scroll and
16314 * items cropping. See each mode's description for more details.
16316 * @note Default value is #ELM_LIST_SCROLL.
16318 * Values <b> don't </b> work as bitmask, only one can be choosen.
16320 * @see elm_list_mode_set()
16321 * @see elm_list_mode_get()
16325 typedef enum _Elm_List_Mode
16327 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. */
16328 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). */
16329 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. */
16330 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. */
16331 ELM_LIST_LAST /**< Indicates error if returned by elm_list_mode_get() */
16334 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(). */
16337 * Add a new list widget to the given parent Elementary
16338 * (container) object.
16340 * @param parent The parent object.
16341 * @return a new list widget handle or @c NULL, on errors.
16343 * This function inserts a new list widget on the canvas.
16347 EAPI Evas_Object *elm_list_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
16352 * @param obj The list object
16354 * @note Call before running show() on the list object.
16355 * @warning If not called, it won't display the list properly.
16358 * li = elm_list_add(win);
16359 * elm_list_item_append(li, "First", NULL, NULL, NULL, NULL);
16360 * elm_list_item_append(li, "Second", NULL, NULL, NULL, NULL);
16362 * evas_object_show(li);
16367 EAPI void elm_list_go(Evas_Object *obj) EINA_ARG_NONNULL(1);
16370 * Enable or disable multiple items selection on the list object.
16372 * @param obj The list object
16373 * @param multi @c EINA_TRUE to enable multi selection or @c EINA_FALSE to
16376 * Disabled by default. If disabled, the user can select a single item of
16377 * the list each time. Selected items are highlighted on list.
16378 * If enabled, many items can be selected.
16380 * If a selected item is selected again, it will be unselected.
16382 * @see elm_list_multi_select_get()
16386 EAPI void elm_list_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
16389 * Get a value whether multiple items selection is enabled or not.
16391 * @see elm_list_multi_select_set() for details.
16393 * @param obj The list object.
16394 * @return @c EINA_TRUE means multiple items selection is enabled.
16395 * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
16396 * @c EINA_FALSE is returned.
16400 EAPI Eina_Bool elm_list_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16403 * Set which mode to use for the list object.
16405 * @param obj The list object
16406 * @param mode One of #Elm_List_Mode: #ELM_LIST_COMPRESS, #ELM_LIST_SCROLL,
16407 * #ELM_LIST_LIMIT or #ELM_LIST_EXPAND.
16409 * Set list's resize behavior, transverse axis scroll and
16410 * items cropping. See each mode's description for more details.
16412 * @note Default value is #ELM_LIST_SCROLL.
16414 * Only one can be set, if a previous one was set, it will be changed
16415 * by the new mode set. Bitmask won't work as well.
16417 * @see elm_list_mode_get()
16421 EAPI void elm_list_mode_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
16424 * Get the mode the list is at.
16426 * @param obj The list object
16427 * @return One of #Elm_List_Mode: #ELM_LIST_COMPRESS, #ELM_LIST_SCROLL,
16428 * #ELM_LIST_LIMIT, #ELM_LIST_EXPAND or #ELM_LIST_LAST on errors.
16430 * @note see elm_list_mode_set() for more information.
16434 EAPI Elm_List_Mode elm_list_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16437 * Enable or disable horizontal mode on the list object.
16439 * @param obj The list object.
16440 * @param horizontal @c EINA_TRUE to enable horizontal or @c EINA_FALSE to
16441 * disable it, i.e., to enable vertical mode.
16443 * @note Vertical mode is set by default.
16445 * On horizontal mode items are displayed on list from left to right,
16446 * instead of from top to bottom. Also, the list will scroll horizontally.
16447 * Each item will presents left icon on top and right icon, or end, at
16450 * @see elm_list_horizontal_get()
16454 EAPI void elm_list_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
16457 * Get a value whether horizontal mode is enabled or not.
16459 * @param obj The list object.
16460 * @return @c EINA_TRUE means horizontal mode selection is enabled.
16461 * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
16462 * @c EINA_FALSE is returned.
16464 * @see elm_list_horizontal_set() for details.
16468 EAPI Eina_Bool elm_list_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16471 * Enable or disable always select mode on the list object.
16473 * @param obj The list object
16474 * @param always_select @c EINA_TRUE to enable always select mode or
16475 * @c EINA_FALSE to disable it.
16477 * @note Always select mode is disabled by default.
16479 * Default behavior of list items is to only call its callback function
16480 * the first time it's pressed, i.e., when it is selected. If a selected
16481 * item is pressed again, and multi-select is disabled, it won't call
16482 * this function (if multi-select is enabled it will unselect the item).
16484 * If always select is enabled, it will call the callback function
16485 * everytime a item is pressed, so it will call when the item is selected,
16486 * and again when a selected item is pressed.
16488 * @see elm_list_always_select_mode_get()
16489 * @see elm_list_multi_select_set()
16493 EAPI void elm_list_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
16496 * Get a value whether always select mode is enabled or not, meaning that
16497 * an item will always call its callback function, even if already selected.
16499 * @param obj The list object
16500 * @return @c EINA_TRUE means horizontal mode selection is enabled.
16501 * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
16502 * @c EINA_FALSE is returned.
16504 * @see elm_list_always_select_mode_set() for details.
16508 EAPI Eina_Bool elm_list_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16511 * Set bouncing behaviour when the scrolled content reaches an edge.
16513 * Tell the internal scroller object whether it should bounce or not
16514 * when it reaches the respective edges for each axis.
16516 * @param obj The list object
16517 * @param h_bounce Whether to bounce or not in the horizontal axis.
16518 * @param v_bounce Whether to bounce or not in the vertical axis.
16520 * @see elm_scroller_bounce_set()
16524 EAPI void elm_list_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
16527 * Get the bouncing behaviour of the internal scroller.
16529 * Get whether the internal scroller should bounce when the edge of each
16530 * axis is reached scrolling.
16532 * @param obj The list object.
16533 * @param h_bounce Pointer where to store the bounce state of the horizontal
16535 * @param v_bounce Pointer where to store the bounce state of the vertical
16538 * @see elm_scroller_bounce_get()
16539 * @see elm_list_bounce_set()
16543 EAPI void elm_list_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
16546 * Set the scrollbar policy.
16548 * @param obj The list object
16549 * @param policy_h Horizontal scrollbar policy.
16550 * @param policy_v Vertical scrollbar policy.
16552 * This sets the scrollbar visibility policy for the given scroller.
16553 * #ELM_SCROLLER_POLICY_AUTO means the scrollbar is made visible if it
16554 * is needed, and otherwise kept hidden. #ELM_SCROLLER_POLICY_ON turns
16555 * it on all the time, and #ELM_SCROLLER_POLICY_OFF always keeps it off.
16556 * This applies respectively for the horizontal and vertical scrollbars.
16558 * The both are disabled by default, i.e., are set to
16559 * #ELM_SCROLLER_POLICY_OFF.
16563 EAPI void elm_list_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
16566 * Get the scrollbar policy.
16568 * @see elm_list_scroller_policy_get() for details.
16570 * @param obj The list object.
16571 * @param policy_h Pointer where to store horizontal scrollbar policy.
16572 * @param policy_v Pointer where to store vertical scrollbar policy.
16576 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);
16579 * Append a new item to the list object.
16581 * @param obj The list object.
16582 * @param label The label of the list item.
16583 * @param icon The icon object to use for the left side of the item. An
16584 * icon can be any Evas object, but usually it is an icon created
16585 * with elm_icon_add().
16586 * @param end The icon object to use for the right side of the item. An
16587 * icon can be any Evas object.
16588 * @param func The function to call when the item is clicked.
16589 * @param data The data to associate with the item for related callbacks.
16591 * @return The created item or @c NULL upon failure.
16593 * A new item will be created and appended to the list, i.e., will
16594 * be set as @b last item.
16596 * Items created with this method can be deleted with
16597 * elm_list_item_del().
16599 * Associated @p data can be properly freed when item is deleted if a
16600 * callback function is set with elm_list_item_del_cb_set().
16602 * If a function is passed as argument, it will be called everytime this item
16603 * is selected, i.e., the user clicks over an unselected item.
16604 * If always select is enabled it will call this function every time
16605 * user clicks over an item (already selected or not).
16606 * If such function isn't needed, just passing
16607 * @c NULL as @p func is enough. The same should be done for @p data.
16609 * Simple example (with no function callback or data associated):
16611 * li = elm_list_add(win);
16612 * ic = elm_icon_add(win);
16613 * elm_icon_file_set(ic, "path/to/image", NULL);
16614 * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
16615 * elm_list_item_append(li, "label", ic, NULL, NULL, NULL);
16617 * evas_object_show(li);
16620 * @see elm_list_always_select_mode_set()
16621 * @see elm_list_item_del()
16622 * @see elm_list_item_del_cb_set()
16623 * @see elm_list_clear()
16624 * @see elm_icon_add()
16628 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);
16631 * Prepend a new item to the list object.
16633 * @param obj The list object.
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 prepended to the list, i.e., will
16646 * be set as @b first item.
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_prepend(Evas_Object *obj, const char *label, Evas_Object *icon, Evas_Object *end, Evas_Smart_Cb func, const void *data) EINA_ARG_NONNULL(1);
16673 * Insert a new item into the list object before item @p before.
16675 * @param obj The list object.
16676 * @param before The list item to insert before.
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 before item @p before.
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_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);
16716 * Insert a new item into the list object after item @p after.
16718 * @param obj The list object.
16719 * @param after The list item to insert after.
16720 * @param label The label of the list item.
16721 * @param icon The icon object to use for the left side of the item. An
16722 * icon can be any Evas object, but usually it is an icon created
16723 * with elm_icon_add().
16724 * @param end The icon object to use for the right side of the item. An
16725 * icon can be any Evas object.
16726 * @param func The function to call when the item is clicked.
16727 * @param data The data to associate with the item for related callbacks.
16729 * @return The created item or @c NULL upon failure.
16731 * A new item will be created and added to the list. Its position in
16732 * this list will be just after item @p after.
16734 * Items created with this method can be deleted with
16735 * elm_list_item_del().
16737 * Associated @p data can be properly freed when item is deleted if a
16738 * callback function is set with elm_list_item_del_cb_set().
16740 * If a function is passed as argument, it will be called everytime this item
16741 * is selected, i.e., the user clicks over an unselected item.
16742 * If always select is enabled it will call this function every time
16743 * user clicks over an item (already selected or not).
16744 * If such function isn't needed, just passing
16745 * @c NULL as @p func is enough. The same should be done for @p data.
16747 * @see elm_list_item_append() for a simple code example.
16748 * @see elm_list_always_select_mode_set()
16749 * @see elm_list_item_del()
16750 * @see elm_list_item_del_cb_set()
16751 * @see elm_list_clear()
16752 * @see elm_icon_add()
16756 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);
16759 * Insert a new item into the sorted list object.
16761 * @param obj The list object.
16762 * @param label The label of the list item.
16763 * @param icon The icon object to use for the left side of the item. An
16764 * icon can be any Evas object, but usually it is an icon created
16765 * with elm_icon_add().
16766 * @param end The icon object to use for the right side of the item. An
16767 * icon can be any Evas object.
16768 * @param func The function to call when the item is clicked.
16769 * @param data The data to associate with the item for related callbacks.
16770 * @param cmp_func The comparing function to be used to sort list
16771 * items <b>by #Elm_List_Item item handles</b>. This function will
16772 * receive two items and compare them, returning a non-negative integer
16773 * if the second item should be place after the first, or negative value
16774 * if should be placed before.
16776 * @return The created item or @c NULL upon failure.
16778 * @note This function inserts values into a list object assuming it was
16779 * sorted and the result will be sorted.
16781 * A new item will be created and added to the list. Its position in
16782 * this list will be found comparing the new item with previously inserted
16783 * items using function @p cmp_func.
16785 * Items created with this method can be deleted with
16786 * elm_list_item_del().
16788 * Associated @p data can be properly freed when item is deleted if a
16789 * callback function is set with elm_list_item_del_cb_set().
16791 * If a function is passed as argument, it will be called everytime this item
16792 * is selected, i.e., the user clicks over an unselected item.
16793 * If always select is enabled it will call this function every time
16794 * user clicks over an item (already selected or not).
16795 * If such function isn't needed, just passing
16796 * @c NULL as @p func is enough. The same should be done for @p data.
16798 * @see elm_list_item_append() for a simple code example.
16799 * @see elm_list_always_select_mode_set()
16800 * @see elm_list_item_del()
16801 * @see elm_list_item_del_cb_set()
16802 * @see elm_list_clear()
16803 * @see elm_icon_add()
16807 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);
16810 * Remove all list's items.
16812 * @param obj The list object
16814 * @see elm_list_item_del()
16815 * @see elm_list_item_append()
16819 EAPI void elm_list_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
16822 * Get a list of all the list items.
16824 * @param obj The list object
16825 * @return An @c Eina_List of list items, #Elm_List_Item,
16826 * or @c NULL on failure.
16828 * @see elm_list_item_append()
16829 * @see elm_list_item_del()
16830 * @see elm_list_clear()
16834 EAPI const Eina_List *elm_list_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16837 * Get the selected item.
16839 * @param obj The list object.
16840 * @return The selected list item.
16842 * The selected item can be unselected with function
16843 * elm_list_item_selected_set().
16845 * The selected item always will be highlighted on list.
16847 * @see elm_list_selected_items_get()
16851 EAPI Elm_List_Item *elm_list_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16854 * Return a list of the currently selected list items.
16856 * @param obj The list object.
16857 * @return An @c Eina_List of list items, #Elm_List_Item,
16858 * or @c NULL on failure.
16860 * Multiple items can be selected if multi select is enabled. It can be
16861 * done with elm_list_multi_select_set().
16863 * @see elm_list_selected_item_get()
16864 * @see elm_list_multi_select_set()
16868 EAPI const Eina_List *elm_list_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16871 * Set the selected state of an item.
16873 * @param item The list item
16874 * @param selected The selected state
16876 * This sets the selected state of the given item @p it.
16877 * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
16879 * If a new item is selected the previosly selected will be unselected,
16880 * unless multiple selection is enabled with elm_list_multi_select_set().
16881 * Previoulsy selected item can be get with function
16882 * elm_list_selected_item_get().
16884 * Selected items will be highlighted.
16886 * @see elm_list_item_selected_get()
16887 * @see elm_list_selected_item_get()
16888 * @see elm_list_multi_select_set()
16892 EAPI void elm_list_item_selected_set(Elm_List_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
16895 * Get whether the @p item is selected or not.
16897 * @param item The list item.
16898 * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
16899 * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
16901 * @see elm_list_selected_item_set() for details.
16902 * @see elm_list_item_selected_get()
16906 EAPI Eina_Bool elm_list_item_selected_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16909 * Set or unset item as a separator.
16911 * @param it The list item.
16912 * @param setting @c EINA_TRUE to set item @p it as separator or
16913 * @c EINA_FALSE to unset, i.e., item will be used as a regular item.
16915 * Items aren't set as separator by default.
16917 * If set as separator it will display separator theme, so won't display
16920 * @see elm_list_item_separator_get()
16924 EAPI void elm_list_item_separator_set(Elm_List_Item *it, Eina_Bool setting) EINA_ARG_NONNULL(1);
16927 * Get a value whether item is a separator or not.
16929 * @see elm_list_item_separator_set() for details.
16931 * @param it The list item.
16932 * @return @c EINA_TRUE means item @p it is a separator. @c EINA_FALSE
16933 * indicates it's not. If @p it is @c NULL, @c EINA_FALSE is returned.
16937 EAPI Eina_Bool elm_list_item_separator_get(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
16940 * Show @p item in the list view.
16942 * @param item The list item to be shown.
16944 * It won't animate list until item is visible. If such behavior is wanted,
16945 * use elm_list_bring_in() intead.
16949 EAPI void elm_list_item_show(Elm_List_Item *item) EINA_ARG_NONNULL(1);
16952 * Bring in the given item to list view.
16954 * @param item The item.
16956 * This causes list to jump to the given item @p item and show it
16957 * (by scrolling), if it is not fully visible.
16959 * This may use animation to do so and take a period of time.
16961 * If animation isn't wanted, elm_list_item_show() can be used.
16965 EAPI void elm_list_item_bring_in(Elm_List_Item *item) EINA_ARG_NONNULL(1);
16968 * Delete them item from the list.
16970 * @param item The item of list to be deleted.
16972 * If deleting all list items is required, elm_list_clear()
16973 * should be used instead of getting items list and deleting each one.
16975 * @see elm_list_clear()
16976 * @see elm_list_item_append()
16977 * @see elm_list_item_del_cb_set()
16981 EAPI void elm_list_item_del(Elm_List_Item *item) EINA_ARG_NONNULL(1);
16984 * Set the function called when a list item is freed.
16986 * @param item The item to set the callback on
16987 * @param func The function called
16989 * If there is a @p func, then it will be called prior item's memory release.
16990 * That will be called with the following arguments:
16992 * @li item's Evas object;
16995 * This way, a data associated to a list item could be properly freed.
16999 EAPI void elm_list_item_del_cb_set(Elm_List_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
17002 * Get the data associated to the item.
17004 * @param item The list item
17005 * @return The data associated to @p item
17007 * The return value is a pointer to data associated to @p item when it was
17008 * created, with function elm_list_item_append() or similar. If no data
17009 * was passed as argument, it will return @c NULL.
17011 * @see elm_list_item_append()
17015 EAPI void *elm_list_item_data_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17018 * Get the left side icon associated to the item.
17020 * @param item The list item
17021 * @return The left side icon associated to @p item
17023 * The return value is a pointer to the icon associated to @p item when
17025 * created, with function elm_list_item_append() or similar, or later
17026 * with function elm_list_item_icon_set(). If no icon
17027 * was passed as argument, it will return @c NULL.
17029 * @see elm_list_item_append()
17030 * @see elm_list_item_icon_set()
17034 EAPI Evas_Object *elm_list_item_icon_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17037 * Set the left side icon associated to the item.
17039 * @param item The list item
17040 * @param icon The left side icon object to associate with @p item
17042 * The icon object to use at left side of the item. An
17043 * icon can be any Evas object, but usually it is an icon created
17044 * with elm_icon_add().
17046 * Once the icon object is set, a previously set one will be deleted.
17047 * @warning Setting the same icon for two items will cause the icon to
17048 * dissapear from the first item.
17050 * If an icon was passed as argument on item creation, with function
17051 * elm_list_item_append() or similar, it will be already
17052 * associated to the item.
17054 * @see elm_list_item_append()
17055 * @see elm_list_item_icon_get()
17059 EAPI void elm_list_item_icon_set(Elm_List_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
17062 * Get the right side icon associated to the item.
17064 * @param item The list item
17065 * @return The right side icon associated to @p item
17067 * The return value is a pointer to the icon associated to @p item when
17069 * created, with function elm_list_item_append() or similar, or later
17070 * with function elm_list_item_icon_set(). If no icon
17071 * was passed as argument, it will return @c NULL.
17073 * @see elm_list_item_append()
17074 * @see elm_list_item_icon_set()
17078 EAPI Evas_Object *elm_list_item_end_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17081 * Set the right side icon associated to the item.
17083 * @param item The list item
17084 * @param end The right side icon object to associate with @p item
17086 * The icon object to use at right side of the item. An
17087 * icon can be any Evas object, but usually it is an icon created
17088 * with elm_icon_add().
17090 * Once the icon object is set, a previously set one will be deleted.
17091 * @warning Setting the same icon for two items will cause the icon to
17092 * dissapear from the first item.
17094 * If an icon was passed as argument on item creation, with function
17095 * elm_list_item_append() or similar, it will be already
17096 * associated to the item.
17098 * @see elm_list_item_append()
17099 * @see elm_list_item_end_get()
17103 EAPI void elm_list_item_end_set(Elm_List_Item *item, Evas_Object *end) EINA_ARG_NONNULL(1);
17106 * Gets the base object of the item.
17108 * @param item The list item
17109 * @return The base object associated with @p item
17111 * Base object is the @c Evas_Object that represents that item.
17115 EAPI Evas_Object *elm_list_item_object_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17116 EINA_DEPRECATED EAPI Evas_Object *elm_list_item_base_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17119 * Get the label of item.
17121 * @param item The item of list.
17122 * @return The label of item.
17124 * The return value is a pointer to the label associated to @p item when
17125 * it was created, with function elm_list_item_append(), or later
17126 * with function elm_list_item_label_set. If no label
17127 * was passed as argument, it will return @c NULL.
17129 * @see elm_list_item_label_set() for more details.
17130 * @see elm_list_item_append()
17134 EAPI const char *elm_list_item_label_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17137 * Set the label of item.
17139 * @param item The item of list.
17140 * @param text The label of item.
17142 * The label to be displayed by the item.
17143 * Label will be placed between left and right side icons (if set).
17145 * If a label was passed as argument on item creation, with function
17146 * elm_list_item_append() or similar, it will be already
17147 * displayed by the item.
17149 * @see elm_list_item_label_get()
17150 * @see elm_list_item_append()
17154 EAPI void elm_list_item_label_set(Elm_List_Item *item, const char *text) EINA_ARG_NONNULL(1);
17158 * Get the item before @p it in list.
17160 * @param it The list item.
17161 * @return The item before @p it, or @c NULL if none or on failure.
17163 * @note If it is the first item, @c NULL will be returned.
17165 * @see elm_list_item_append()
17166 * @see elm_list_items_get()
17170 EAPI Elm_List_Item *elm_list_item_prev(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
17173 * Get the item after @p it in list.
17175 * @param it The list item.
17176 * @return The item after @p it, or @c NULL if none or on failure.
17178 * @note If it is the last item, @c NULL will be returned.
17180 * @see elm_list_item_append()
17181 * @see elm_list_items_get()
17185 EAPI Elm_List_Item *elm_list_item_next(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
17188 * Sets the disabled/enabled state of a list item.
17190 * @param it The item.
17191 * @param disabled The disabled state.
17193 * A disabled item cannot be selected or unselected. It will also
17194 * change its appearance (generally greyed out). This sets the
17195 * disabled state (@c EINA_TRUE for disabled, @c EINA_FALSE for
17200 EAPI void elm_list_item_disabled_set(Elm_List_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1);
17203 * Get a value whether list item is disabled or not.
17205 * @param it The item.
17206 * @return The disabled state.
17208 * @see elm_list_item_disabled_set() for more details.
17212 EAPI Eina_Bool elm_list_item_disabled_get(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
17215 * Set the text to be shown in a given list item's tooltips.
17217 * @param item Target item.
17218 * @param text The text to set in the content.
17220 * Setup the text as tooltip to object. The item can have only one tooltip,
17221 * so any previous tooltip data - set with this function or
17222 * elm_list_item_tooltip_content_cb_set() - is removed.
17224 * @see elm_object_tooltip_text_set() for more details.
17228 EAPI void elm_list_item_tooltip_text_set(Elm_List_Item *item, const char *text) EINA_ARG_NONNULL(1);
17232 * @brief Disable size restrictions on an object's tooltip
17233 * @param item The tooltip's anchor object
17234 * @param disable If EINA_TRUE, size restrictions are disabled
17235 * @return EINA_FALSE on failure, EINA_TRUE on success
17237 * This function allows a tooltip to expand beyond its parant window's canvas.
17238 * It will instead be limited only by the size of the display.
17240 EAPI Eina_Bool elm_list_item_tooltip_size_restrict_disable(Elm_List_Item *item, Eina_Bool disable) EINA_ARG_NONNULL(1);
17242 * @brief Retrieve size restriction state of an object's tooltip
17243 * @param obj The tooltip's anchor object
17244 * @return If EINA_TRUE, size restrictions are disabled
17246 * This function returns whether a tooltip is allowed to expand beyond
17247 * its parant window's canvas.
17248 * It will instead be limited only by the size of the display.
17250 EAPI Eina_Bool elm_list_item_tooltip_size_restrict_disabled_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17253 * Set the content to be shown in the tooltip item.
17255 * Setup the tooltip to item. The item can have only one tooltip,
17256 * so any previous tooltip data is removed. @p func(with @p data) will
17257 * be called every time that need show the tooltip and it should
17258 * return a valid Evas_Object. This object is then managed fully by
17259 * tooltip system and is deleted when the tooltip is gone.
17261 * @param item the list item being attached a tooltip.
17262 * @param func the function used to create the tooltip contents.
17263 * @param data what to provide to @a func as callback data/context.
17264 * @param del_cb called when data is not needed anymore, either when
17265 * another callback replaces @a func, the tooltip is unset with
17266 * elm_list_item_tooltip_unset() or the owner @a item
17267 * dies. This callback receives as the first parameter the
17268 * given @a data, and @c event_info is the item.
17270 * @see elm_object_tooltip_content_cb_set() for more details.
17274 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);
17277 * Unset tooltip from item.
17279 * @param item list item to remove previously set tooltip.
17281 * Remove tooltip from item. The callback provided as del_cb to
17282 * elm_list_item_tooltip_content_cb_set() will be called to notify
17283 * it is not used anymore.
17285 * @see elm_object_tooltip_unset() for more details.
17286 * @see elm_list_item_tooltip_content_cb_set()
17290 EAPI void elm_list_item_tooltip_unset(Elm_List_Item *item) EINA_ARG_NONNULL(1);
17293 * Sets a different style for this item tooltip.
17295 * @note before you set a style you should define a tooltip with
17296 * elm_list_item_tooltip_content_cb_set() or
17297 * elm_list_item_tooltip_text_set()
17299 * @param item list item with tooltip already set.
17300 * @param style the theme style to use (default, transparent, ...)
17302 * @see elm_object_tooltip_style_set() for more details.
17306 EAPI void elm_list_item_tooltip_style_set(Elm_List_Item *item, const char *style) EINA_ARG_NONNULL(1);
17309 * Get the style for this item tooltip.
17311 * @param item list item with tooltip already set.
17312 * @return style the theme style in use, defaults to "default". If the
17313 * object does not have a tooltip set, then NULL is returned.
17315 * @see elm_object_tooltip_style_get() for more details.
17316 * @see elm_list_item_tooltip_style_set()
17320 EAPI const char *elm_list_item_tooltip_style_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17323 * Set the type of mouse pointer/cursor decoration to be shown,
17324 * when the mouse pointer is over the given list widget item
17326 * @param item list item to customize cursor on
17327 * @param cursor the cursor type's name
17329 * This function works analogously as elm_object_cursor_set(), but
17330 * here the cursor's changing area is restricted to the item's
17331 * area, and not the whole widget's. Note that that item cursors
17332 * have precedence over widget cursors, so that a mouse over an
17333 * item with custom cursor set will always show @b that cursor.
17335 * If this function is called twice for an object, a previously set
17336 * cursor will be unset on the second call.
17338 * @see elm_object_cursor_set()
17339 * @see elm_list_item_cursor_get()
17340 * @see elm_list_item_cursor_unset()
17344 EAPI void elm_list_item_cursor_set(Elm_List_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
17347 * Get the type of mouse pointer/cursor decoration set to be shown,
17348 * when the mouse pointer is over the given list widget item
17350 * @param item list item with custom cursor set
17351 * @return the cursor type's name or @c NULL, if no custom cursors
17352 * were set to @p item (and on errors)
17354 * @see elm_object_cursor_get()
17355 * @see elm_list_item_cursor_set()
17356 * @see elm_list_item_cursor_unset()
17360 EAPI const char *elm_list_item_cursor_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17363 * Unset any custom mouse pointer/cursor decoration set to be
17364 * shown, when the mouse pointer is over the given list widget
17365 * item, thus making it show the @b default cursor again.
17367 * @param item a list item
17369 * Use this call to undo any custom settings on this item's cursor
17370 * decoration, bringing it back to defaults (no custom style set).
17372 * @see elm_object_cursor_unset()
17373 * @see elm_list_item_cursor_set()
17377 EAPI void elm_list_item_cursor_unset(Elm_List_Item *item) EINA_ARG_NONNULL(1);
17380 * Set a different @b style for a given custom cursor set for a
17383 * @param item list item with custom cursor set
17384 * @param style the <b>theme style</b> to use (e.g. @c "default",
17385 * @c "transparent", etc)
17387 * This function only makes sense when one is using custom mouse
17388 * cursor decorations <b>defined in a theme file</b>, which can have,
17389 * given a cursor name/type, <b>alternate styles</b> on it. It
17390 * works analogously as elm_object_cursor_style_set(), but here
17391 * applyed only to list item objects.
17393 * @warning Before you set a cursor style you should have definen a
17394 * custom cursor previously on the item, with
17395 * elm_list_item_cursor_set()
17397 * @see elm_list_item_cursor_engine_only_set()
17398 * @see elm_list_item_cursor_style_get()
17402 EAPI void elm_list_item_cursor_style_set(Elm_List_Item *item, const char *style) EINA_ARG_NONNULL(1);
17405 * Get the current @b style set for a given list item's custom
17408 * @param item list item with custom cursor set.
17409 * @return style the cursor style in use. If the object does not
17410 * have a cursor set, then @c NULL is returned.
17412 * @see elm_list_item_cursor_style_set() for more details
17416 EAPI const char *elm_list_item_cursor_style_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17419 * Set if the (custom)cursor for a given list item should be
17420 * searched in its theme, also, or should only rely on the
17421 * rendering engine.
17423 * @param item item with custom (custom) cursor already set on
17424 * @param engine_only Use @c EINA_TRUE to have cursors looked for
17425 * only on those provided by the rendering engine, @c EINA_FALSE to
17426 * have them searched on the widget's theme, as well.
17428 * @note This call is of use only if you've set a custom cursor
17429 * for list items, with elm_list_item_cursor_set().
17431 * @note By default, cursors will only be looked for between those
17432 * provided by the rendering engine.
17436 EAPI void elm_list_item_cursor_engine_only_set(Elm_List_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
17439 * Get if the (custom) cursor for a given list item is being
17440 * searched in its theme, also, or is only relying on the rendering
17443 * @param item a list item
17444 * @return @c EINA_TRUE, if cursors are being looked for only on
17445 * those provided by the rendering engine, @c EINA_FALSE if they
17446 * are being searched on the widget's theme, as well.
17448 * @see elm_list_item_cursor_engine_only_set(), for more details
17452 EAPI Eina_Bool elm_list_item_cursor_engine_only_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17459 * @defgroup Slider Slider
17460 * @ingroup Elementary
17462 * @image html img/widget/slider/preview-00.png
17463 * @image latex img/widget/slider/preview-00.eps width=\textwidth
17465 * The slider adds a dragable āsliderā widget for selecting the value of
17466 * something within a range.
17468 * A slider can be horizontal or vertical. It can contain an Icon and has a
17469 * primary label as well as a units label (that is formatted with floating
17470 * point values and thus accepts a printf-style format string, like
17471 * ā%1.2f unitsā. There is also an indicator string that may be somewhere
17472 * else (like on the slider itself) that also accepts a format string like
17473 * units. Label, Icon Unit and Indicator strings/objects are optional.
17475 * A slider may be inverted which means values invert, with high vales being
17476 * on the left or top and low values on the right or bottom (as opposed to
17477 * normally being low on the left or top and high on the bottom and right).
17479 * The slider should have its minimum and maximum values set by the
17480 * application with elm_slider_min_max_set() and value should also be set by
17481 * the application before use with elm_slider_value_set(). The span of the
17482 * slider is its length (horizontally or vertically). This will be scaled by
17483 * the object or applications scaling factor. At any point code can query the
17484 * slider for its value with elm_slider_value_get().
17486 * Smart callbacks one can listen to:
17487 * - "changed" - Whenever the slider value is changed by the user.
17488 * - "slider,drag,start" - dragging the slider indicator around has started.
17489 * - "slider,drag,stop" - dragging the slider indicator around has stopped.
17490 * - "delay,changed" - A short time after the value is changed by the user.
17491 * This will be called only when the user stops dragging for
17492 * a very short period or when they release their
17493 * finger/mouse, so it avoids possibly expensive reactions to
17494 * the value change.
17496 * Available styles for it:
17499 * Default contents parts of the slider widget that you can use for are:
17500 * @li "icon" - A icon of the slider
17501 * @li "end" - A end part content of the slider
17503 * Default text parts of the silder widget that you can use for are:
17504 * @li "default" - Label of the silder
17505 * Here is an example on its usage:
17506 * @li @ref slider_example
17510 * @addtogroup Slider
17515 * Add a new slider widget to the given parent Elementary
17516 * (container) object.
17518 * @param parent The parent object.
17519 * @return a new slider widget handle or @c NULL, on errors.
17521 * This function inserts a new slider widget on the canvas.
17525 EAPI Evas_Object *elm_slider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
17528 * Set the label of a given slider widget
17530 * @param obj The progress bar object
17531 * @param label The text label string, in UTF-8
17534 * @deprecated use elm_object_text_set() instead.
17536 EINA_DEPRECATED EAPI void elm_slider_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
17539 * Get the label of a given slider widget
17541 * @param obj The progressbar object
17542 * @return The text label string, in UTF-8
17545 * @deprecated use elm_object_text_get() instead.
17547 EINA_DEPRECATED EAPI const char *elm_slider_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17550 * Set the icon object of the slider object.
17552 * @param obj The slider object.
17553 * @param icon The icon object.
17555 * On horizontal mode, icon is placed at left, and on vertical mode,
17558 * @note Once the icon object is set, a previously set one will be deleted.
17559 * If you want to keep that old content object, use the
17560 * elm_slider_icon_unset() function.
17562 * @warning If the object being set does not have minimum size hints set,
17563 * it won't get properly displayed.
17566 * @deprecated use elm_object_part_content_set() instead.
17568 EINA_DEPRECATED EAPI void elm_slider_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
17571 * Unset an icon set on a given slider widget.
17573 * @param obj The slider object.
17574 * @return The icon object that was being used, if any was set, or
17575 * @c NULL, otherwise (and on errors).
17577 * On horizontal mode, icon is placed at left, and on vertical mode,
17580 * This call will unparent and return the icon object which was set
17581 * for this widget, previously, on success.
17583 * @see elm_slider_icon_set() for more details
17584 * @see elm_slider_icon_get()
17585 * @deprecated use elm_object_part_content_unset() instead.
17589 EINA_DEPRECATED EAPI Evas_Object *elm_slider_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
17592 * Retrieve the icon object set for a given slider widget.
17594 * @param obj The slider object.
17595 * @return The icon object's handle, if @p obj had one set, or @c NULL,
17596 * otherwise (and on errors).
17598 * On horizontal mode, icon is placed at left, and on vertical mode,
17601 * @see elm_slider_icon_set() for more details
17602 * @see elm_slider_icon_unset()
17604 * @deprecated use elm_object_part_content_get() instead.
17608 EINA_DEPRECATED EAPI Evas_Object *elm_slider_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17611 * Set the end object of the slider object.
17613 * @param obj The slider object.
17614 * @param end The end object.
17616 * On horizontal mode, end is placed at left, and on vertical mode,
17617 * placed at bottom.
17619 * @note Once the icon object is set, a previously set one will be deleted.
17620 * If you want to keep that old content object, use the
17621 * elm_slider_end_unset() function.
17623 * @warning If the object being set does not have minimum size hints set,
17624 * it won't get properly displayed.
17626 * @deprecated use elm_object_part_content_set() instead.
17630 EINA_DEPRECATED EAPI void elm_slider_end_set(Evas_Object *obj, Evas_Object *end) EINA_ARG_NONNULL(1);
17633 * Unset an end object set on a given slider widget.
17635 * @param obj The slider object.
17636 * @return The end object that was being used, if any was set, or
17637 * @c NULL, otherwise (and on errors).
17639 * On horizontal mode, end is placed at left, and on vertical mode,
17640 * placed at bottom.
17642 * This call will unparent and return the icon object which was set
17643 * for this widget, previously, on success.
17645 * @see elm_slider_end_set() for more details.
17646 * @see elm_slider_end_get()
17648 * @deprecated use elm_object_part_content_unset() instead
17653 EINA_DEPRECATED EAPI Evas_Object *elm_slider_end_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
17656 * Retrieve the end object set for a given slider widget.
17658 * @param obj The slider object.
17659 * @return The end object's handle, if @p obj had one set, or @c NULL,
17660 * otherwise (and on errors).
17662 * On horizontal mode, icon is placed at right, and on vertical mode,
17663 * placed at bottom.
17665 * @see elm_slider_end_set() for more details.
17666 * @see elm_slider_end_unset()
17669 * @deprecated use elm_object_part_content_get() instead
17674 EINA_DEPRECATED EAPI Evas_Object *elm_slider_end_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17677 * Set the (exact) length of the bar region of a given slider widget.
17679 * @param obj The slider object.
17680 * @param size The length of the slider's bar region.
17682 * This sets the minimum width (when in horizontal mode) or height
17683 * (when in vertical mode) of the actual bar area of the slider
17684 * @p obj. This in turn affects the object's minimum size. Use
17685 * this when you're not setting other size hints expanding on the
17686 * given direction (like weight and alignment hints) and you would
17687 * like it to have a specific size.
17689 * @note Icon, end, label, indicator and unit text around @p obj
17690 * will require their
17691 * own space, which will make @p obj to require more the @p size,
17694 * @see elm_slider_span_size_get()
17698 EAPI void elm_slider_span_size_set(Evas_Object *obj, Evas_Coord size) EINA_ARG_NONNULL(1);
17701 * Get the length set for the bar region of a given slider widget
17703 * @param obj The slider object.
17704 * @return The length of the slider's bar region.
17706 * If that size was not set previously, with
17707 * elm_slider_span_size_set(), this call will return @c 0.
17711 EAPI Evas_Coord elm_slider_span_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17714 * Set the format string for the unit label.
17716 * @param obj The slider object.
17717 * @param format The format string for the unit display.
17719 * Unit label is displayed all the time, if set, after slider's bar.
17720 * In horizontal mode, at right and in vertical mode, at bottom.
17722 * If @c NULL, unit label won't be visible. If not it sets the format
17723 * string for the label text. To the label text is provided a floating point
17724 * value, so the label text can display up to 1 floating point value.
17725 * Note that this is optional.
17727 * Use a format string such as "%1.2f meters" for example, and it will
17728 * display values like: "3.14 meters" for a value equal to 3.14159.
17730 * Default is unit label disabled.
17732 * @see elm_slider_indicator_format_get()
17736 EAPI void elm_slider_unit_format_set(Evas_Object *obj, const char *format) EINA_ARG_NONNULL(1);
17739 * Get the unit label format of the slider.
17741 * @param obj The slider object.
17742 * @return The unit label format string in UTF-8.
17744 * Unit label is displayed all the time, if set, after slider's bar.
17745 * In horizontal mode, at right and in vertical mode, at bottom.
17747 * @see elm_slider_unit_format_set() for more
17748 * information on how this works.
17752 EAPI const char *elm_slider_unit_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17755 * Set the format string for the indicator label.
17757 * @param obj The slider object.
17758 * @param indicator The format string for the indicator display.
17760 * The slider may display its value somewhere else then unit label,
17761 * for example, above the slider knob that is dragged around. This function
17762 * sets the format string used for this.
17764 * If @c NULL, indicator label won't be visible. If not it sets the format
17765 * string for the label text. To the label text is provided a floating point
17766 * value, so the label text can display up to 1 floating point value.
17767 * Note that this is optional.
17769 * Use a format string such as "%1.2f meters" for example, and it will
17770 * display values like: "3.14 meters" for a value equal to 3.14159.
17772 * Default is indicator label disabled.
17774 * @see elm_slider_indicator_format_get()
17778 EAPI void elm_slider_indicator_format_set(Evas_Object *obj, const char *indicator) EINA_ARG_NONNULL(1);
17781 * Get the indicator label format of the slider.
17783 * @param obj The slider object.
17784 * @return The indicator label format string in UTF-8.
17786 * The slider may display its value somewhere else then unit label,
17787 * for example, above the slider knob that is dragged around. This function
17788 * gets the format string used for this.
17790 * @see elm_slider_indicator_format_set() for more
17791 * information on how this works.
17795 EAPI const char *elm_slider_indicator_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17798 * Set the format function pointer for the indicator label
17800 * @param obj The slider object.
17801 * @param func The indicator format function.
17802 * @param free_func The freeing function for the format string.
17804 * Set the callback function to format the indicator string.
17806 * @see elm_slider_indicator_format_set() for more info on how this works.
17810 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);
17813 * Set the format function pointer for the units label
17815 * @param obj The slider object.
17816 * @param func The units format function.
17817 * @param free_func The freeing function for the format string.
17819 * Set the callback function to format the indicator string.
17821 * @see elm_slider_units_format_set() for more info on how this works.
17825 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);
17828 * Set the orientation of a given slider widget.
17830 * @param obj The slider object.
17831 * @param horizontal Use @c EINA_TRUE to make @p obj to be
17832 * @b horizontal, @c EINA_FALSE to make it @b vertical.
17834 * Use this function to change how your slider is to be
17835 * disposed: vertically or horizontally.
17837 * By default it's displayed horizontally.
17839 * @see elm_slider_horizontal_get()
17843 EAPI void elm_slider_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
17846 * Retrieve the orientation of a given slider widget
17848 * @param obj The slider object.
17849 * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
17850 * @c EINA_FALSE if it's @b vertical (and on errors).
17852 * @see elm_slider_horizontal_set() for more details.
17856 EAPI Eina_Bool elm_slider_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17859 * Set the minimum and maximum values for the slider.
17861 * @param obj The slider object.
17862 * @param min The minimum value.
17863 * @param max The maximum value.
17865 * Define the allowed range of values to be selected by the user.
17867 * If actual value is less than @p min, it will be updated to @p min. If it
17868 * is bigger then @p max, will be updated to @p max. Actual value can be
17869 * get with elm_slider_value_get().
17871 * By default, min is equal to 0.0, and max is equal to 1.0.
17873 * @warning Maximum must be greater than minimum, otherwise behavior
17876 * @see elm_slider_min_max_get()
17880 EAPI void elm_slider_min_max_set(Evas_Object *obj, double min, double max) EINA_ARG_NONNULL(1);
17883 * Get the minimum and maximum values of the slider.
17885 * @param obj The slider object.
17886 * @param min Pointer where to store the minimum value.
17887 * @param max Pointer where to store the maximum value.
17889 * @note If only one value is needed, the other pointer can be passed
17892 * @see elm_slider_min_max_set() for details.
17896 EAPI void elm_slider_min_max_get(const Evas_Object *obj, double *min, double *max) EINA_ARG_NONNULL(1);
17899 * Set the value the slider displays.
17901 * @param obj The slider object.
17902 * @param val The value to be displayed.
17904 * Value will be presented on the unit label following format specified with
17905 * elm_slider_unit_format_set() and on indicator with
17906 * elm_slider_indicator_format_set().
17908 * @warning The value must to be between min and max values. This values
17909 * are set by elm_slider_min_max_set().
17911 * @see elm_slider_value_get()
17912 * @see elm_slider_unit_format_set()
17913 * @see elm_slider_indicator_format_set()
17914 * @see elm_slider_min_max_set()
17918 EAPI void elm_slider_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
17921 * Get the value displayed by the spinner.
17923 * @param obj The spinner object.
17924 * @return The value displayed.
17926 * @see elm_spinner_value_set() for details.
17930 EAPI double elm_slider_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17933 * Invert a given slider widget's displaying values order
17935 * @param obj The slider object.
17936 * @param inverted Use @c EINA_TRUE to make @p obj inverted,
17937 * @c EINA_FALSE to bring it back to default, non-inverted values.
17939 * A slider may be @b inverted, in which state it gets its
17940 * values inverted, with high vales being on the left or top and
17941 * low values on the right or bottom, as opposed to normally have
17942 * the low values on the former and high values on the latter,
17943 * respectively, for horizontal and vertical modes.
17945 * @see elm_slider_inverted_get()
17949 EAPI void elm_slider_inverted_set(Evas_Object *obj, Eina_Bool inverted) EINA_ARG_NONNULL(1);
17952 * Get whether a given slider widget's displaying values are
17955 * @param obj The slider object.
17956 * @return @c EINA_TRUE, if @p obj has inverted values,
17957 * @c EINA_FALSE otherwise (and on errors).
17959 * @see elm_slider_inverted_set() for more details.
17963 EAPI Eina_Bool elm_slider_inverted_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17966 * Set whether to enlarge slider indicator (augmented knob) or not.
17968 * @param obj The slider object.
17969 * @param show @c EINA_TRUE will make it enlarge, @c EINA_FALSE will
17970 * let the knob always at default size.
17972 * By default, indicator will be bigger while dragged by the user.
17974 * @warning It won't display values set with
17975 * elm_slider_indicator_format_set() if you disable indicator.
17979 EAPI void elm_slider_indicator_show_set(Evas_Object *obj, Eina_Bool show) EINA_ARG_NONNULL(1);
17982 * Get whether a given slider widget's enlarging indicator or not.
17984 * @param obj The slider object.
17985 * @return @c EINA_TRUE, if @p obj is enlarging indicator, or
17986 * @c EINA_FALSE otherwise (and on errors).
17988 * @see elm_slider_indicator_show_set() for details.
17992 EAPI Eina_Bool elm_slider_indicator_show_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17999 * @addtogroup Actionslider Actionslider
18001 * @image html img/widget/actionslider/preview-00.png
18002 * @image latex img/widget/actionslider/preview-00.eps
18004 * An actionslider is a switcher for 2 or 3 labels with customizable magnet
18005 * properties. The user drags and releases the indicator, to choose a label.
18007 * Labels occupy the following positions.
18012 * Positions can be enabled or disabled.
18014 * Magnets can be set on the above positions.
18016 * When the indicator is released, it will move to its nearest "enabled and magnetized" position.
18018 * @note By default all positions are set as enabled.
18020 * Signals that you can add callbacks for are:
18022 * "selected" - when user selects an enabled position (the label is passed
18025 * "pos_changed" - when the indicator reaches any of the positions("left",
18026 * "right" or "center").
18028 * See an example of actionslider usage @ref actionslider_example_page "here"
18031 typedef enum _Elm_Actionslider_Pos
18033 ELM_ACTIONSLIDER_NONE = 0,
18034 ELM_ACTIONSLIDER_LEFT = 1 << 0,
18035 ELM_ACTIONSLIDER_CENTER = 1 << 1,
18036 ELM_ACTIONSLIDER_RIGHT = 1 << 2,
18037 ELM_ACTIONSLIDER_ALL = (1 << 3) -1
18038 } Elm_Actionslider_Pos;
18041 * Add a new actionslider to the parent.
18043 * @param parent The parent object
18044 * @return The new actionslider object or NULL if it cannot be created
18046 EAPI Evas_Object *elm_actionslider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
18048 * Set actionslider labels.
18050 * @param obj The actionslider object
18051 * @param left_label The label to be set on the left.
18052 * @param center_label The label to be set on the center.
18053 * @param right_label The label to be set on the right.
18054 * @deprecated use elm_object_text_set() instead.
18056 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);
18058 * Get actionslider labels.
18060 * @param obj The actionslider object
18061 * @param left_label A char** to place the left_label of @p obj into.
18062 * @param center_label A char** to place the center_label of @p obj into.
18063 * @param right_label A char** to place the right_label of @p obj into.
18064 * @deprecated use elm_object_text_set() instead.
18066 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);
18068 * Get actionslider selected label.
18070 * @param obj The actionslider object
18071 * @return The selected label
18073 EAPI const char *elm_actionslider_selected_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18075 * Set actionslider indicator position.
18077 * @param obj The actionslider object.
18078 * @param pos The position of the indicator.
18080 EAPI void elm_actionslider_indicator_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
18082 * Get actionslider indicator position.
18084 * @param obj The actionslider object.
18085 * @return The position of the indicator.
18087 EAPI Elm_Actionslider_Pos elm_actionslider_indicator_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18089 * Set actionslider magnet position. To make multiple positions magnets @c or
18090 * them together(e.g.: ELM_ACTIONSLIDER_LEFT | ELM_ACTIONSLIDER_RIGHT)
18092 * @param obj The actionslider object.
18093 * @param pos Bit mask indicating the magnet positions.
18095 EAPI void elm_actionslider_magnet_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
18097 * Get actionslider magnet position.
18099 * @param obj The actionslider object.
18100 * @return The positions with magnet property.
18102 EAPI Elm_Actionslider_Pos elm_actionslider_magnet_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18104 * Set actionslider enabled position. To set multiple positions as enabled @c or
18105 * them together(e.g.: ELM_ACTIONSLIDER_LEFT | ELM_ACTIONSLIDER_RIGHT).
18107 * @note All the positions are enabled by default.
18109 * @param obj The actionslider object.
18110 * @param pos Bit mask indicating the enabled positions.
18112 EAPI void elm_actionslider_enabled_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
18114 * Get actionslider enabled position.
18116 * @param obj The actionslider object.
18117 * @return The enabled positions.
18119 EAPI Elm_Actionslider_Pos elm_actionslider_enabled_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18121 * Set the label used on the indicator.
18123 * @param obj The actionslider object
18124 * @param label The label to be set on the indicator.
18125 * @deprecated use elm_object_text_set() instead.
18127 EINA_DEPRECATED EAPI void elm_actionslider_indicator_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
18129 * Get the label used on the indicator object.
18131 * @param obj The actionslider object
18132 * @return The indicator label
18133 * @deprecated use elm_object_text_get() instead.
18135 EINA_DEPRECATED EAPI const char *elm_actionslider_indicator_label_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
18141 * @defgroup Genlist Genlist
18143 * @image html img/widget/genlist/preview-00.png
18144 * @image latex img/widget/genlist/preview-00.eps
18145 * @image html img/genlist.png
18146 * @image latex img/genlist.eps
18148 * This widget aims to have more expansive list than the simple list in
18149 * Elementary that could have more flexible items and allow many more entries
18150 * while still being fast and low on memory usage. At the same time it was
18151 * also made to be able to do tree structures. But the price to pay is more
18152 * complexity when it comes to usage. If all you want is a simple list with
18153 * icons and a single label, use the normal @ref List object.
18155 * Genlist has a fairly large API, mostly because it's relatively complex,
18156 * trying to be both expansive, powerful and efficient. First we will begin
18157 * an overview on the theory behind genlist.
18159 * @section Genlist_Item_Class Genlist item classes - creating items
18161 * In order to have the ability to add and delete items on the fly, genlist
18162 * implements a class (callback) system where the application provides a
18163 * structure with information about that type of item (genlist may contain
18164 * multiple different items with different classes, states and styles).
18165 * Genlist will call the functions in this struct (methods) when an item is
18166 * "realized" (i.e., created dynamically, while the user is scrolling the
18167 * grid). All objects will simply be deleted when no longer needed with
18168 * evas_object_del(). The #Elm_Genlist_Item_Class structure contains the
18169 * following members:
18170 * - @c item_style - This is a constant string and simply defines the name
18171 * of the item style. It @b must be specified and the default should be @c
18174 * - @c func - A struct with pointers to functions that will be called when
18175 * an item is going to be actually created. All of them receive a @c data
18176 * parameter that will point to the same data passed to
18177 * elm_genlist_item_append() and related item creation functions, and a @c
18178 * obj parameter that points to the genlist object itself.
18180 * The function pointers inside @c func are @c label_get, @c icon_get, @c
18181 * state_get and @c del. The 3 first functions also receive a @c part
18182 * parameter described below. A brief description of these functions follows:
18184 * - @c label_get - The @c part parameter is the name string of one of the
18185 * existing text parts in the Edje group implementing the item's theme.
18186 * This function @b must return a strdup'()ed string, as the caller will
18187 * free() it when done. See #Elm_Genlist_Item_Label_Get_Cb.
18188 * - @c content_get - The @c part parameter is the name string of one of the
18189 * existing (content) swallow parts in the Edje group implementing the item's
18190 * theme. It must return @c NULL, when no content is desired, or a valid
18191 * object handle, otherwise. The object will be deleted by the genlist on
18192 * its deletion or when the item is "unrealized". See
18193 * #Elm_Genlist_Item_Content_Get_Cb.
18194 * - @c func.state_get - The @c part parameter is the name string of one of
18195 * the state parts in the Edje group implementing the item's theme. Return
18196 * @c EINA_FALSE for false/off or @c EINA_TRUE for true/on. Genlists will
18197 * emit a signal to its theming Edje object with @c "elm,state,XXX,active"
18198 * and @c "elm" as "emission" and "source" arguments, respectively, when
18199 * the state is true (the default is false), where @c XXX is the name of
18200 * the (state) part. See #Elm_Genlist_Item_State_Get_Cb.
18201 * - @c func.del - This is intended for use when genlist items are deleted,
18202 * so any data attached to the item (e.g. its data parameter on creation)
18203 * can be deleted. See #Elm_Genlist_Item_Del_Cb.
18205 * available item styles:
18207 * - default_style - The text part is a textblock
18209 * @image html img/widget/genlist/preview-04.png
18210 * @image latex img/widget/genlist/preview-04.eps
18214 * @image html img/widget/genlist/preview-01.png
18215 * @image latex img/widget/genlist/preview-01.eps
18217 * - icon_top_text_bottom
18219 * @image html img/widget/genlist/preview-02.png
18220 * @image latex img/widget/genlist/preview-02.eps
18224 * @image html img/widget/genlist/preview-03.png
18225 * @image latex img/widget/genlist/preview-03.eps
18227 * @section Genlist_Items Structure of items
18229 * An item in a genlist can have 0 or more text labels (they can be regular
18230 * text or textblock Evas objects - that's up to the style to determine), 0
18231 * or more contents (which are simply objects swallowed into the genlist item's
18232 * theming Edje object) and 0 or more <b>boolean states</b>, which have the
18233 * behavior left to the user to define. The Edje part names for each of
18234 * these properties will be looked up, in the theme file for the genlist,
18235 * under the Edje (string) data items named @c "labels", @c "contents" and @c
18236 * "states", respectively. For each of those properties, if more than one
18237 * part is provided, they must have names listed separated by spaces in the
18238 * data fields. For the default genlist item theme, we have @b one label
18239 * part (@c "elm.text"), @b two content parts (@c "elm.swalllow.icon" and @c
18240 * "elm.swallow.end") and @b no state parts.
18242 * A genlist item may be at one of several styles. Elementary provides one
18243 * by default - "default", but this can be extended by system or application
18244 * custom themes/overlays/extensions (see @ref Theme "themes" for more
18247 * @section Genlist_Manipulation Editing and Navigating
18249 * Items can be added by several calls. All of them return a @ref
18250 * Elm_Genlist_Item handle that is an internal member inside the genlist.
18251 * They all take a data parameter that is meant to be used for a handle to
18252 * the applications internal data (eg the struct with the original item
18253 * data). The parent parameter is the parent genlist item this belongs to if
18254 * it is a tree or an indexed group, and NULL if there is no parent. The
18255 * flags can be a bitmask of #ELM_GENLIST_ITEM_NONE,
18256 * #ELM_GENLIST_ITEM_SUBITEMS and #ELM_GENLIST_ITEM_GROUP. If
18257 * #ELM_GENLIST_ITEM_SUBITEMS is set then this item is displayed as an item
18258 * that is able to expand and have child items. If ELM_GENLIST_ITEM_GROUP
18259 * is set then this item is group index item that is displayed at the top
18260 * until the next group comes. The func parameter is a convenience callback
18261 * that is called when the item is selected and the data parameter will be
18262 * the func_data parameter, obj be the genlist object and event_info will be
18263 * the genlist item.
18265 * elm_genlist_item_append() adds an item to the end of the list, or if
18266 * there is a parent, to the end of all the child items of the parent.
18267 * elm_genlist_item_prepend() is the same but adds to the beginning of
18268 * the list or children list. elm_genlist_item_insert_before() inserts at
18269 * item before another item and elm_genlist_item_insert_after() inserts after
18270 * the indicated item.
18272 * The application can clear the list with elm_gen_clear() which deletes
18273 * all the items in the list and elm_genlist_item_del() will delete a specific
18274 * item. elm_genlist_item_subitems_clear() will clear all items that are
18275 * children of the indicated parent item.
18277 * To help inspect list items you can jump to the item at the top of the list
18278 * with elm_genlist_first_item_get() which will return the item pointer, and
18279 * similarly elm_genlist_last_item_get() gets the item at the end of the list.
18280 * elm_genlist_item_next_get() and elm_genlist_item_prev_get() get the next
18281 * and previous items respectively relative to the indicated item. Using
18282 * these calls you can walk the entire item list/tree. Note that as a tree
18283 * the items are flattened in the list, so elm_genlist_item_parent_get() will
18284 * let you know which item is the parent (and thus know how to skip them if
18287 * @section Genlist_Muti_Selection Multi-selection
18289 * If the application wants multiple items to be able to be selected,
18290 * elm_genlist_multi_select_set() can enable this. If the list is
18291 * single-selection only (the default), then elm_genlist_selected_item_get()
18292 * will return the selected item, if any, or NULL if none is selected. If the
18293 * list is multi-select then elm_genlist_selected_items_get() will return a
18294 * list (that is only valid as long as no items are modified (added, deleted,
18295 * selected or unselected)).
18297 * @section Genlist_Usage_Hints Usage hints
18299 * There are also convenience functions. elm_gen_item_genlist_get() will
18300 * return the genlist object the item belongs to. elm_genlist_item_show()
18301 * will make the scroller scroll to show that specific item so its visible.
18302 * elm_genlist_item_data_get() returns the data pointer set by the item
18303 * creation functions.
18305 * If an item changes (state of boolean changes, label or contents change),
18306 * then use elm_genlist_item_update() to have genlist update the item with
18307 * the new state. Genlist will re-realize the item thus call the functions
18308 * in the _Elm_Genlist_Item_Class for that item.
18310 * To programmatically (un)select an item use elm_genlist_item_selected_set().
18311 * To get its selected state use elm_genlist_item_selected_get(). Similarly
18312 * to expand/contract an item and get its expanded state, use
18313 * elm_genlist_item_expanded_set() and elm_genlist_item_expanded_get(). And
18314 * again to make an item disabled (unable to be selected and appear
18315 * differently) use elm_genlist_item_disabled_set() to set this and
18316 * elm_genlist_item_disabled_get() to get the disabled state.
18318 * In general to indicate how the genlist should expand items horizontally to
18319 * fill the list area, use elm_genlist_horizontal_set(). Valid modes are
18320 * ELM_LIST_LIMIT and ELM_LIST_SCROLL. The default is ELM_LIST_SCROLL. This
18321 * mode means that if items are too wide to fit, the scroller will scroll
18322 * horizontally. Otherwise items are expanded to fill the width of the
18323 * viewport of the scroller. If it is ELM_LIST_LIMIT, items will be expanded
18324 * to the viewport width and limited to that size. This can be combined with
18325 * a different style that uses edjes' ellipsis feature (cutting text off like
18328 * Items will only call their selection func and callback when first becoming
18329 * selected. Any further clicks will do nothing, unless you enable always
18330 * select with elm_gen_always_select_mode_set(). This means even if
18331 * selected, every click will make the selected callbacks be called.
18332 * elm_genlist_no_select_mode_set() will turn off the ability to select
18333 * items entirely and they will neither appear selected nor call selected
18334 * callback functions.
18336 * Remember that you can create new styles and add your own theme augmentation
18337 * per application with elm_theme_extension_add(). If you absolutely must
18338 * have a specific style that overrides any theme the user or system sets up
18339 * you can use elm_theme_overlay_add() to add such a file.
18341 * @section Genlist_Implementation Implementation
18343 * Evas tracks every object you create. Every time it processes an event
18344 * (mouse move, down, up etc.) it needs to walk through objects and find out
18345 * what event that affects. Even worse every time it renders display updates,
18346 * in order to just calculate what to re-draw, it needs to walk through many
18347 * many many objects. Thus, the more objects you keep active, the more
18348 * overhead Evas has in just doing its work. It is advisable to keep your
18349 * active objects to the minimum working set you need. Also remember that
18350 * object creation and deletion carries an overhead, so there is a
18351 * middle-ground, which is not easily determined. But don't keep massive lists
18352 * of objects you can't see or use. Genlist does this with list objects. It
18353 * creates and destroys them dynamically as you scroll around. It groups them
18354 * into blocks so it can determine the visibility etc. of a whole block at
18355 * once as opposed to having to walk the whole list. This 2-level list allows
18356 * for very large numbers of items to be in the list (tests have used up to
18357 * 2,000,000 items). Also genlist employs a queue for adding items. As items
18358 * may be different sizes, every item added needs to be calculated as to its
18359 * size and thus this presents a lot of overhead on populating the list, this
18360 * genlist employs a queue. Any item added is queued and spooled off over
18361 * time, actually appearing some time later, so if your list has many members
18362 * you may find it takes a while for them to all appear, with your process
18363 * consuming a lot of CPU while it is busy spooling.
18365 * Genlist also implements a tree structure, but it does so with callbacks to
18366 * the application, with the application filling in tree structures when
18367 * requested (allowing for efficient building of a very deep tree that could
18368 * even be used for file-management). See the above smart signal callbacks for
18371 * @section Genlist_Smart_Events Genlist smart events
18373 * Signals that you can add callbacks for are:
18374 * - @c "activated" - The user has double-clicked or pressed
18375 * (enter|return|spacebar) on an item. The @c event_info parameter is the
18376 * item that was activated.
18377 * - @c "clicked,double" - The user has double-clicked an item. The @c
18378 * event_info parameter is the item that was double-clicked.
18379 * - @c "selected" - This is called when a user has made an item selected.
18380 * The event_info parameter is the genlist item that was selected.
18381 * - @c "unselected" - This is called when a user has made an item
18382 * unselected. The event_info parameter is the genlist item that was
18384 * - @c "expanded" - This is called when elm_genlist_item_expanded_set() is
18385 * called and the item is now meant to be expanded. The event_info
18386 * parameter is the genlist item that was indicated to expand. It is the
18387 * job of this callback to then fill in the child items.
18388 * - @c "contracted" - This is called when elm_genlist_item_expanded_set() is
18389 * called and the item is now meant to be contracted. The event_info
18390 * parameter is the genlist item that was indicated to contract. It is the
18391 * job of this callback to then delete the child items.
18392 * - @c "expand,request" - This is called when a user has indicated they want
18393 * to expand a tree branch item. The callback should decide if the item can
18394 * expand (has any children) and then call elm_genlist_item_expanded_set()
18395 * appropriately to set the state. The event_info parameter is the genlist
18396 * item that was indicated to expand.
18397 * - @c "contract,request" - This is called when a user has indicated they
18398 * want to contract a tree branch item. The callback should decide if the
18399 * item can contract (has any children) and then call
18400 * elm_genlist_item_expanded_set() appropriately to set the state. The
18401 * event_info parameter is the genlist item that was indicated to contract.
18402 * - @c "realized" - This is called when the item in the list is created as a
18403 * real evas object. event_info parameter is the genlist item that was
18404 * created. The object may be deleted at any time, so it is up to the
18405 * caller to not use the object pointer from elm_genlist_item_object_get()
18406 * in a way where it may point to freed objects.
18407 * - @c "unrealized" - This is called just before an item is unrealized.
18408 * After this call content objects provided will be deleted and the item
18409 * object itself delete or be put into a floating cache.
18410 * - @c "drag,start,up" - This is called when the item in the list has been
18411 * dragged (not scrolled) up.
18412 * - @c "drag,start,down" - This is called when the item in the list has been
18413 * dragged (not scrolled) down.
18414 * - @c "drag,start,left" - This is called when the item in the list has been
18415 * dragged (not scrolled) left.
18416 * - @c "drag,start,right" - This is called when the item in the list has
18417 * been dragged (not scrolled) right.
18418 * - @c "drag,stop" - This is called when the item in the list has stopped
18420 * - @c "drag" - This is called when the item in the list is being dragged.
18421 * - @c "longpressed" - This is called when the item is pressed for a certain
18422 * amount of time. By default it's 1 second.
18423 * - @c "scroll,anim,start" - This is called when scrolling animation has
18425 * - @c "scroll,anim,stop" - This is called when scrolling animation has
18427 * - @c "scroll,drag,start" - This is called when dragging the content has
18429 * - @c "scroll,drag,stop" - This is called when dragging the content has
18431 * - @c "edge,top" - This is called when the genlist is scrolled until
18433 * - @c "edge,bottom" - This is called when the genlist is scrolled
18434 * until the bottom edge.
18435 * - @c "edge,left" - This is called when the genlist is scrolled
18436 * until the left edge.
18437 * - @c "edge,right" - This is called when the genlist is scrolled
18438 * until the right edge.
18439 * - @c "multi,swipe,left" - This is called when the genlist is multi-touch
18441 * - @c "multi,swipe,right" - This is called when the genlist is multi-touch
18443 * - @c "multi,swipe,up" - This is called when the genlist is multi-touch
18445 * - @c "multi,swipe,down" - This is called when the genlist is multi-touch
18447 * - @c "multi,pinch,out" - This is called when the genlist is multi-touch
18448 * pinched out. "- @c multi,pinch,in" - This is called when the genlist is
18449 * multi-touch pinched in.
18450 * - @c "swipe" - This is called when the genlist is swiped.
18451 * - @c "moved" - This is called when a genlist item is moved.
18452 * - @c "language,changed" - This is called when the program's language is
18455 * @section Genlist_Examples Examples
18457 * Here is a list of examples that use the genlist, trying to show some of
18458 * its capabilities:
18459 * - @ref genlist_example_01
18460 * - @ref genlist_example_02
18461 * - @ref genlist_example_03
18462 * - @ref genlist_example_04
18463 * - @ref genlist_example_05
18467 * @addtogroup Genlist
18472 * @enum _Elm_Genlist_Item_Flags
18473 * @typedef Elm_Genlist_Item_Flags
18475 * Defines if the item is of any special type (has subitems or it's the
18476 * index of a group), or is just a simple item.
18480 typedef enum _Elm_Genlist_Item_Flags
18482 ELM_GENLIST_ITEM_NONE = 0, /**< simple item */
18483 ELM_GENLIST_ITEM_SUBITEMS = (1 << 0), /**< may expand and have child items */
18484 ELM_GENLIST_ITEM_GROUP = (1 << 1) /**< index of a group of items */
18485 } Elm_Genlist_Item_Flags;
18486 typedef struct _Elm_Genlist_Item_Class Elm_Genlist_Item_Class; /**< Genlist item class definition structs */
18487 #define Elm_Genlist_Item_Class Elm_Gen_Item_Class
18488 typedef struct _Elm_Genlist_Item Elm_Genlist_Item; /**< Item of Elm_Genlist. Sub-type of Elm_Widget_Item */
18489 #define Elm_Genlist_Item Elm_Gen_Item /**< Item of Elm_Genlist. Sub-type of Elm_Widget_Item */
18490 typedef struct _Elm_Genlist_Item_Class_Func Elm_Genlist_Item_Class_Func; /**< Class functions for genlist item class */
18492 * Label fetching class function for Elm_Gen_Item_Class.
18493 * @param data The data passed in the item creation function
18494 * @param obj The base widget object
18495 * @param part The part name of the swallow
18496 * @return The allocated (NOT stringshared) string to set as the label
18498 typedef char *(*Elm_Genlist_Item_Label_Get_Cb) (void *data, Evas_Object *obj, const char *part);
18500 * Content (swallowed object) fetching class function for Elm_Gen_Item_Class.
18501 * @param data The data passed in the item creation function
18502 * @param obj The base widget object
18503 * @param part The part name of the swallow
18504 * @return The content object to swallow
18506 typedef Evas_Object *(*Elm_Genlist_Item_Content_Get_Cb) (void *data, Evas_Object *obj, const char *part);
18508 * State fetching class function for Elm_Gen_Item_Class.
18509 * @param data The data passed in the item creation function
18510 * @param obj The base widget object
18511 * @param part The part name of the swallow
18512 * @return The hell if I know
18514 typedef Eina_Bool (*Elm_Genlist_Item_State_Get_Cb) (void *data, Evas_Object *obj, const char *part);
18516 * Deletion class function for Elm_Gen_Item_Class.
18517 * @param data The data passed in the item creation function
18518 * @param obj The base widget object
18520 typedef void (*Elm_Genlist_Item_Del_Cb) (void *data, Evas_Object *obj);
18523 * @struct _Elm_Genlist_Item_Class
18525 * Genlist item class definition structs.
18527 * This struct contains the style and fetching functions that will define the
18528 * contents of each item.
18530 * @see @ref Genlist_Item_Class
18532 struct _Elm_Genlist_Item_Class
18534 const char *item_style; /**< style of this class. */
18535 struct Elm_Genlist_Item_Class_Func
18537 Elm_Genlist_Item_Label_Get_Cb label_get; /**< Label fetching class function for genlist item classes.*/
18538 Elm_Genlist_Item_Content_Get_Cb content_get; /**< Content fetching class function for genlist item classes. */
18539 Elm_Genlist_Item_State_Get_Cb state_get; /**< State fetching class function for genlist item classes. */
18540 Elm_Genlist_Item_Del_Cb del; /**< Deletion class function for genlist item classes. */
18543 #define Elm_Genlist_Item_Class_Func Elm_Gen_Item_Class_Func
18545 * Add a new genlist widget to the given parent Elementary
18546 * (container) object
18548 * @param parent The parent object
18549 * @return a new genlist widget handle or @c NULL, on errors
18551 * This function inserts a new genlist widget on the canvas.
18553 * @see elm_genlist_item_append()
18554 * @see elm_genlist_item_del()
18555 * @see elm_gen_clear()
18559 EAPI Evas_Object *elm_genlist_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
18561 * Remove all items from a given genlist widget.
18563 * @param obj The genlist object
18565 * This removes (and deletes) all items in @p obj, leaving it empty.
18567 * This is deprecated. Please use elm_gen_clear() instead.
18569 * @see elm_genlist_item_del(), to remove just one item.
18573 EINA_DEPRECATED EAPI void elm_genlist_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
18575 * Enable or disable multi-selection in the genlist
18577 * @param obj The genlist object
18578 * @param multi Multi-select enable/disable. Default is disabled.
18580 * This enables (@c EINA_TRUE) or disables (@c EINA_FALSE) multi-selection in
18581 * the list. This allows more than 1 item to be selected. To retrieve the list
18582 * of selected items, use elm_genlist_selected_items_get().
18584 * @see elm_genlist_selected_items_get()
18585 * @see elm_genlist_multi_select_get()
18589 EAPI void elm_genlist_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
18591 * Gets if multi-selection in genlist is enabled or disabled.
18593 * @param obj The genlist object
18594 * @return Multi-select enabled/disabled
18595 * (@c EINA_TRUE = enabled/@c EINA_FALSE = disabled). Default is @c EINA_FALSE.
18597 * @see elm_genlist_multi_select_set()
18601 EAPI Eina_Bool elm_genlist_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18603 * This sets the horizontal stretching mode.
18605 * @param obj The genlist object
18606 * @param mode The mode to use (one of #ELM_LIST_SCROLL or #ELM_LIST_LIMIT).
18608 * This sets the mode used for sizing items horizontally. Valid modes
18609 * are #ELM_LIST_LIMIT and #ELM_LIST_SCROLL. The default is
18610 * ELM_LIST_SCROLL. This mode means that if items are too wide to fit,
18611 * the scroller will scroll horizontally. Otherwise items are expanded
18612 * to fill the width of the viewport of the scroller. If it is
18613 * ELM_LIST_LIMIT, items will be expanded to the viewport width and
18614 * limited to that size.
18616 * @see elm_genlist_horizontal_get()
18620 EAPI void elm_genlist_horizontal_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
18621 EINA_DEPRECATED EAPI void elm_genlist_horizontal_mode_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
18623 * Gets the horizontal stretching mode.
18625 * @param obj The genlist object
18626 * @return The mode to use
18627 * (#ELM_LIST_LIMIT, #ELM_LIST_SCROLL)
18629 * @see elm_genlist_horizontal_set()
18633 EAPI Elm_List_Mode elm_genlist_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18634 EINA_DEPRECATED EAPI Elm_List_Mode elm_genlist_horizontal_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18636 * Set the always select mode.
18638 * @param obj The genlist object
18639 * @param always_select The always select mode (@c EINA_TRUE = on, @c
18640 * EINA_FALSE = off). Default is @c EINA_FALSE.
18642 * Items will only call their selection func and callback when first
18643 * becoming selected. Any further clicks will do nothing, unless you
18644 * enable always select with elm_gen_always_select_mode_set().
18645 * This means that, even if selected, every click will make the selected
18646 * callbacks be called.
18648 * This function is deprecated. please see elm_gen_always_select_mode_set()
18650 * @see elm_genlist_always_select_mode_get()
18654 EINA_DEPRECATED EAPI void elm_genlist_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
18656 * Get the always select mode.
18658 * @param obj The genlist object
18659 * @return The always select mode
18660 * (@c EINA_TRUE = on, @c EINA_FALSE = off)
18662 * @see elm_genlist_always_select_mode_set()
18666 EINA_DEPRECATED EAPI Eina_Bool elm_genlist_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18668 * Enable/disable the no select mode.
18670 * @param obj The genlist object
18671 * @param no_select The no select mode
18672 * (EINA_TRUE = on, EINA_FALSE = off)
18674 * This will turn off the ability to select items entirely and they
18675 * will neither appear selected nor call selected callback functions.
18677 * @see elm_genlist_no_select_mode_get()
18681 EINA_DEPRECATED EAPI void elm_genlist_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
18683 * Gets whether the no select mode is enabled.
18685 * @param obj The genlist object
18686 * @return The no select mode
18687 * (@c EINA_TRUE = on, @c EINA_FALSE = off)
18689 * @see elm_genlist_no_select_mode_set()
18693 EINA_DEPRECATED EAPI Eina_Bool elm_genlist_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18695 * Enable/disable compress mode.
18697 * @param obj The genlist object
18698 * @param compress The compress mode
18699 * (@c EINA_TRUE = on, @c EINA_FALSE = off). Default is @c EINA_FALSE.
18701 * This will enable the compress mode where items are "compressed"
18702 * horizontally to fit the genlist scrollable viewport width. This is
18703 * special for genlist. Do not rely on
18704 * elm_genlist_horizontal_set() being set to @c ELM_LIST_COMPRESS to
18705 * work as genlist needs to handle it specially.
18707 * @see elm_genlist_compress_mode_get()
18711 EAPI void elm_genlist_compress_mode_set(Evas_Object *obj, Eina_Bool compress) EINA_ARG_NONNULL(1);
18713 * Get whether the compress mode is enabled.
18715 * @param obj The genlist object
18716 * @return The compress mode
18717 * (@c EINA_TRUE = on, @c EINA_FALSE = off)
18719 * @see elm_genlist_compress_mode_set()
18723 EAPI Eina_Bool elm_genlist_compress_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18725 * Enable/disable height-for-width mode.
18727 * @param obj The genlist object
18728 * @param setting The height-for-width mode (@c EINA_TRUE = on,
18729 * @c EINA_FALSE = off). Default is @c EINA_FALSE.
18731 * With height-for-width mode the item width will be fixed (restricted
18732 * to a minimum of) to the list width when calculating its size in
18733 * order to allow the height to be calculated based on it. This allows,
18734 * for instance, text block to wrap lines if the Edje part is
18735 * configured with "text.min: 0 1".
18737 * @note This mode will make list resize slower as it will have to
18738 * recalculate every item height again whenever the list width
18741 * @note When height-for-width mode is enabled, it also enables
18742 * compress mode (see elm_genlist_compress_mode_set()) and
18743 * disables homogeneous (see elm_genlist_homogeneous_set()).
18747 EAPI void elm_genlist_height_for_width_mode_set(Evas_Object *obj, Eina_Bool height_for_width) EINA_ARG_NONNULL(1);
18749 * Get whether the height-for-width mode is enabled.
18751 * @param obj The genlist object
18752 * @return The height-for-width mode (@c EINA_TRUE = on, @c EINA_FALSE =
18757 EAPI Eina_Bool elm_genlist_height_for_width_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18759 * Enable/disable horizontal and vertical bouncing effect.
18761 * @param obj The genlist object
18762 * @param h_bounce Allow bounce horizontally (@c EINA_TRUE = on, @c
18763 * EINA_FALSE = off). Default is @c EINA_FALSE.
18764 * @param v_bounce Allow bounce vertically (@c EINA_TRUE = on, @c
18765 * EINA_FALSE = off). Default is @c EINA_TRUE.
18767 * This will enable or disable the scroller bouncing effect for the
18768 * genlist. See elm_scroller_bounce_set() for details.
18770 * @see elm_scroller_bounce_set()
18771 * @see elm_genlist_bounce_get()
18775 EINA_DEPRECATED EAPI void elm_genlist_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
18777 * Get whether the horizontal and vertical bouncing effect is enabled.
18779 * @param obj The genlist object
18780 * @param h_bounce Pointer to a bool to receive if the bounce horizontally
18782 * @param v_bounce Pointer to a bool to receive if the bounce vertically
18785 * @see elm_genlist_bounce_set()
18789 EINA_DEPRECATED EAPI void elm_genlist_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
18791 * Enable/disable homogeneous mode.
18793 * @param obj The genlist object
18794 * @param homogeneous Assume the items within the genlist are of the
18795 * same height and width (EINA_TRUE = on, EINA_FALSE = off). Default is @c
18798 * This will enable the homogeneous mode where items are of the same
18799 * height and width so that genlist may do the lazy-loading at its
18800 * maximum (which increases the performance for scrolling the list). This
18801 * implies 'compressed' mode.
18803 * @see elm_genlist_compress_mode_set()
18804 * @see elm_genlist_homogeneous_get()
18808 EAPI void elm_genlist_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
18810 * Get whether the homogeneous mode is enabled.
18812 * @param obj The genlist object
18813 * @return Assume the items within the genlist are of the same height
18814 * and width (EINA_TRUE = on, EINA_FALSE = off)
18816 * @see elm_genlist_homogeneous_set()
18820 EAPI Eina_Bool elm_genlist_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18822 * Set the maximum number of items within an item block
18824 * @param obj The genlist object
18825 * @param n Maximum number of items within an item block. Default is 32.
18827 * This will configure the block count to tune to the target with
18828 * particular performance matrix.
18830 * A block of objects will be used to reduce the number of operations due to
18831 * many objects in the screen. It can determine the visibility, or if the
18832 * object has changed, it theme needs to be updated, etc. doing this kind of
18833 * calculation to the entire block, instead of per object.
18835 * The default value for the block count is enough for most lists, so unless
18836 * you know you will have a lot of objects visible in the screen at the same
18837 * time, don't try to change this.
18839 * @see elm_genlist_block_count_get()
18840 * @see @ref Genlist_Implementation
18844 EAPI void elm_genlist_block_count_set(Evas_Object *obj, int n) EINA_ARG_NONNULL(1);
18846 * Get the maximum number of items within an item block
18848 * @param obj The genlist object
18849 * @return Maximum number of items within an item block
18851 * @see elm_genlist_block_count_set()
18855 EAPI int elm_genlist_block_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18857 * Set the timeout in seconds for the longpress event.
18859 * @param obj The genlist object
18860 * @param timeout timeout in seconds. Default is 1.
18862 * This option will change how long it takes to send an event "longpressed"
18863 * after the mouse down signal is sent to the list. If this event occurs, no
18864 * "clicked" event will be sent.
18866 * @see elm_genlist_longpress_timeout_set()
18870 EAPI void elm_genlist_longpress_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
18872 * Get the timeout in seconds for the longpress event.
18874 * @param obj The genlist object
18875 * @return timeout in seconds
18877 * @see elm_genlist_longpress_timeout_get()
18881 EAPI double elm_genlist_longpress_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18883 * Append a new item in a given genlist widget.
18885 * @param obj The genlist object
18886 * @param itc The item class for the item
18887 * @param data The item data
18888 * @param parent The parent item, or NULL if none
18889 * @param flags Item flags
18890 * @param func Convenience function called when the item is selected
18891 * @param func_data Data passed to @p func above.
18892 * @return A handle to the item added or @c NULL if not possible
18894 * This adds the given item to the end of the list or the end of
18895 * the children list if the @p parent is given.
18897 * @see elm_genlist_item_prepend()
18898 * @see elm_genlist_item_insert_before()
18899 * @see elm_genlist_item_insert_after()
18900 * @see elm_genlist_item_del()
18904 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);
18906 * Prepend a new item in a given genlist widget.
18908 * @param obj The genlist object
18909 * @param itc The item class for the item
18910 * @param data The item data
18911 * @param parent The parent item, or NULL if none
18912 * @param flags Item flags
18913 * @param func Convenience function called when the item is selected
18914 * @param func_data Data passed to @p func above.
18915 * @return A handle to the item added or NULL if not possible
18917 * This adds an item to the beginning of the list or beginning of the
18918 * children of the parent if given.
18920 * @see elm_genlist_item_append()
18921 * @see elm_genlist_item_insert_before()
18922 * @see elm_genlist_item_insert_after()
18923 * @see elm_genlist_item_del()
18927 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);
18929 * Insert an item before another in a genlist widget
18931 * @param obj The genlist object
18932 * @param itc The item class for the item
18933 * @param data The item data
18934 * @param before The item to place this new one before.
18935 * @param flags Item flags
18936 * @param func Convenience function called when the item is selected
18937 * @param func_data Data passed to @p func above.
18938 * @return A handle to the item added or @c NULL if not possible
18940 * This inserts an item before another in the list. It will be in the
18941 * same tree level or group as the item it is inserted before.
18943 * @see elm_genlist_item_append()
18944 * @see elm_genlist_item_prepend()
18945 * @see elm_genlist_item_insert_after()
18946 * @see elm_genlist_item_del()
18950 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);
18952 * Insert an item after another in a genlist widget
18954 * @param obj The genlist object
18955 * @param itc The item class for the item
18956 * @param data The item data
18957 * @param after The item to place this new one after.
18958 * @param flags Item flags
18959 * @param func Convenience function called when the item is selected
18960 * @param func_data Data passed to @p func above.
18961 * @return A handle to the item added or @c NULL if not possible
18963 * This inserts an item after another in the list. It will be in the
18964 * same tree level or group as the item it is inserted after.
18966 * @see elm_genlist_item_append()
18967 * @see elm_genlist_item_prepend()
18968 * @see elm_genlist_item_insert_before()
18969 * @see elm_genlist_item_del()
18973 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);
18975 * Insert a new item into the sorted genlist object
18977 * @param obj The genlist object
18978 * @param itc The item class for the item
18979 * @param data The item data
18980 * @param parent The parent item, or NULL if none
18981 * @param flags Item flags
18982 * @param comp The function called for the sort
18983 * @param func Convenience function called when item selected
18984 * @param func_data Data passed to @p func above.
18985 * @return A handle to the item added or NULL if not possible
18989 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);
18990 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);
18991 /* operations to retrieve existing items */
18993 * Get the selectd item in the genlist.
18995 * @param obj The genlist object
18996 * @return The selected item, or NULL if none is selected.
18998 * This gets the selected item in the list (if multi-selection is enabled, only
18999 * the item that was first selected in the list is returned - which is not very
19000 * useful, so see elm_genlist_selected_items_get() for when multi-selection is
19003 * If no item is selected, NULL is returned.
19005 * @see elm_genlist_selected_items_get()
19009 EAPI Elm_Genlist_Item *elm_genlist_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19011 * Get a list of selected items in the genlist.
19013 * @param obj The genlist object
19014 * @return The list of selected items, or NULL if none are selected.
19016 * It returns a list of the selected items. This list pointer is only valid so
19017 * long as the selection doesn't change (no items are selected or unselected, or
19018 * unselected implicitly by deletion). The list contains Elm_Genlist_Item
19019 * pointers. The order of the items in this list is the order which they were
19020 * selected, i.e. the first item in this list is the first item that was
19021 * selected, and so on.
19023 * @note If not in multi-select mode, consider using function
19024 * elm_genlist_selected_item_get() instead.
19026 * @see elm_genlist_multi_select_set()
19027 * @see elm_genlist_selected_item_get()
19031 EAPI const Eina_List *elm_genlist_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19033 * Get the mode item style of items in the genlist
19034 * @param obj The genlist object
19035 * @return The mode item style string, or NULL if none is specified
19037 * This is a constant string and simply defines the name of the
19038 * style that will be used for mode animations. It can be
19039 * @c NULL if you don't plan to use Genlist mode. See
19040 * elm_genlist_item_mode_set() for more info.
19044 EAPI const char *elm_genlist_mode_item_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19046 * Set the mode item style of items in the genlist
19047 * @param obj The genlist object
19048 * @param style The mode item style string, or NULL if none is desired
19050 * This is a constant string and simply defines the name of the
19051 * style that will be used for mode animations. It can be
19052 * @c NULL if you don't plan to use Genlist mode. See
19053 * elm_genlist_item_mode_set() for more info.
19057 EAPI void elm_genlist_mode_item_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
19059 * Get a list of realized items in genlist
19061 * @param obj The genlist object
19062 * @return The list of realized items, nor NULL if none are realized.
19064 * This returns a list of the realized items in the genlist. The list
19065 * contains Elm_Genlist_Item pointers. The list must be freed by the
19066 * caller when done with eina_list_free(). The item pointers in the
19067 * list are only valid so long as those items are not deleted or the
19068 * genlist is not deleted.
19070 * @see elm_genlist_realized_items_update()
19074 EAPI Eina_List *elm_genlist_realized_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19076 * Get the item that is at the x, y canvas coords.
19078 * @param obj The gelinst object.
19079 * @param x The input x coordinate
19080 * @param y The input y coordinate
19081 * @param posret The position relative to the item returned here
19082 * @return The item at the coordinates or NULL if none
19084 * This returns the item at the given coordinates (which are canvas
19085 * relative, not object-relative). If an item is at that coordinate,
19086 * that item handle is returned, and if @p posret is not NULL, the
19087 * integer pointed to is set to a value of -1, 0 or 1, depending if
19088 * the coordinate is on the upper portion of that item (-1), on the
19089 * middle section (0) or on the lower part (1). If NULL is returned as
19090 * an item (no item found there), then posret may indicate -1 or 1
19091 * based if the coordinate is above or below all items respectively in
19096 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);
19098 * Get the first item in the genlist
19100 * This returns the first item in the list.
19102 * @param obj The genlist object
19103 * @return The first item, or NULL if none
19107 EINA_DEPRECATED EAPI Elm_Genlist_Item *elm_genlist_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19109 * Get the last item in the genlist
19111 * This returns the last item in the list.
19113 * @return The last item, or NULL if none
19117 EINA_DEPRECATED EAPI Elm_Genlist_Item *elm_genlist_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19119 * Set the scrollbar policy
19121 * @param obj The genlist object
19122 * @param policy_h Horizontal scrollbar policy.
19123 * @param policy_v Vertical scrollbar policy.
19125 * This sets the scrollbar visibility policy for the given genlist
19126 * scroller. #ELM_SMART_SCROLLER_POLICY_AUTO means the scrollbar is
19127 * made visible if it is needed, and otherwise kept hidden.
19128 * #ELM_SMART_SCROLLER_POLICY_ON turns it on all the time, and
19129 * #ELM_SMART_SCROLLER_POLICY_OFF always keeps it off. This applies
19130 * respectively for the horizontal and vertical scrollbars. Default is
19131 * #ELM_SMART_SCROLLER_POLICY_AUTO
19133 * @see elm_genlist_scroller_policy_get()
19137 EAPI void elm_genlist_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
19139 * Get the scrollbar policy
19141 * @param obj The genlist object
19142 * @param policy_h Pointer to store the horizontal scrollbar policy.
19143 * @param policy_v Pointer to store the vertical scrollbar policy.
19145 * @see elm_genlist_scroller_policy_set()
19149 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);
19151 * Get the @b next item in a genlist widget's internal list of items,
19152 * given a handle to one of those items.
19154 * @param item The genlist item to fetch next from
19155 * @return The item after @p item, or @c NULL if there's none (and
19158 * This returns the item placed after the @p item, on the container
19161 * @see elm_genlist_item_prev_get()
19165 EINA_DEPRECATED EAPI Elm_Genlist_Item *elm_genlist_item_next_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19167 * Get the @b previous item in a genlist widget's internal list of items,
19168 * given a handle to one of those items.
19170 * @param item The genlist item to fetch previous from
19171 * @return The item before @p item, or @c NULL if there's none (and
19174 * This returns the item placed before the @p item, on the container
19177 * @see elm_genlist_item_next_get()
19181 EINA_DEPRECATED EAPI Elm_Genlist_Item *elm_genlist_item_prev_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19183 * Get the genlist object's handle which contains a given genlist
19186 * @param item The item to fetch the container from
19187 * @return The genlist (parent) object
19189 * This returns the genlist object itself that an item belongs to.
19191 * This function is deprecated. Please use elm_gen_item_widget_get()
19195 EINA_DEPRECATED EAPI Evas_Object *elm_genlist_item_genlist_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19197 * Get the parent item of the given item
19199 * @param it The item
19200 * @return The parent of the item or @c NULL if it has no parent.
19202 * This returns the item that was specified as parent of the item @p it on
19203 * elm_genlist_item_append() and insertion related functions.
19207 EAPI Elm_Genlist_Item *elm_genlist_item_parent_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19209 * Remove all sub-items (children) of the given item
19211 * @param it The item
19213 * This removes all items that are children (and their descendants) of the
19214 * given item @p it.
19216 * @see elm_genlist_clear()
19217 * @see elm_genlist_item_del()
19221 EAPI void elm_genlist_item_subitems_clear(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19223 * Set whether a given genlist item is selected or not
19225 * @param it The item
19226 * @param selected Use @c EINA_TRUE, to make it selected, @c
19227 * EINA_FALSE to make it unselected
19229 * This sets the selected state of an item. If multi selection is
19230 * not enabled on the containing genlist and @p selected is @c
19231 * EINA_TRUE, any other previously selected items will get
19232 * unselected in favor of this new one.
19234 * @see elm_genlist_item_selected_get()
19238 EINA_DEPRECATED EAPI void elm_genlist_item_selected_set(Elm_Genlist_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
19240 * Get whether a given genlist item is selected or not
19242 * @param it The item
19243 * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
19245 * @see elm_genlist_item_selected_set() for more details
19249 EINA_DEPRECATED EAPI Eina_Bool elm_genlist_item_selected_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19251 * Sets the expanded state of an item.
19253 * @param it The item
19254 * @param expanded The expanded state (@c EINA_TRUE expanded, @c EINA_FALSE not expanded).
19256 * This function flags the item of type #ELM_GENLIST_ITEM_SUBITEMS as
19259 * The theme will respond to this change visually, and a signal "expanded" or
19260 * "contracted" will be sent from the genlist with a pointer to the item that
19261 * has been expanded/contracted.
19263 * Calling this function won't show or hide any child of this item (if it is
19264 * a parent). You must manually delete and create them on the callbacks fo
19265 * the "expanded" or "contracted" signals.
19267 * @see elm_genlist_item_expanded_get()
19271 EAPI void elm_genlist_item_expanded_set(Elm_Genlist_Item *item, Eina_Bool expanded) EINA_ARG_NONNULL(1);
19273 * Get the expanded state of an item
19275 * @param it The item
19276 * @return The expanded state
19278 * This gets the expanded state of an item.
19280 * @see elm_genlist_item_expanded_set()
19284 EAPI Eina_Bool elm_genlist_item_expanded_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19286 * Get the depth of expanded item
19288 * @param it The genlist item object
19289 * @return The depth of expanded item
19293 EAPI int elm_genlist_item_expanded_depth_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19295 * Set whether a given genlist item is disabled or not.
19297 * @param it The item
19298 * @param disabled Use @c EINA_TRUE, true disable it, @c EINA_FALSE
19299 * to enable it back.
19301 * A disabled item cannot be selected or unselected. It will also
19302 * change its appearance, to signal the user it's disabled.
19304 * @see elm_genlist_item_disabled_get()
19308 EAPI void elm_genlist_item_disabled_set(Elm_Genlist_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
19310 * Get whether a given genlist item is disabled or not.
19312 * @param it The item
19313 * @return @c EINA_TRUE, if it's disabled, @c EINA_FALSE otherwise
19316 * @see elm_genlist_item_disabled_set() for more details
19320 EAPI Eina_Bool elm_genlist_item_disabled_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19322 * Sets the display only state of an item.
19324 * @param it The item
19325 * @param display_only @c EINA_TRUE if the item is display only, @c
19326 * EINA_FALSE otherwise.
19328 * A display only item cannot be selected or unselected. It is for
19329 * display only and not selecting or otherwise clicking, dragging
19330 * etc. by the user, thus finger size rules will not be applied to
19333 * It's good to set group index items to display only state.
19335 * @see elm_genlist_item_display_only_get()
19339 EAPI void elm_genlist_item_display_only_set(Elm_Genlist_Item *it, Eina_Bool display_only) EINA_ARG_NONNULL(1);
19341 * Get the display only state of an item
19343 * @param it The item
19344 * @return @c EINA_TRUE if the item is display only, @c
19345 * EINA_FALSE otherwise.
19347 * @see elm_genlist_item_display_only_set()
19351 EAPI Eina_Bool elm_genlist_item_display_only_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19353 * Show the portion of a genlist's internal list containing a given
19354 * item, immediately.
19356 * @param it The item to display
19358 * This causes genlist to jump to the given item @p it and show it (by
19359 * immediately scrolling to that position), if it is not fully visible.
19361 * @see elm_genlist_item_bring_in()
19362 * @see elm_genlist_item_top_show()
19363 * @see elm_genlist_item_middle_show()
19367 EAPI void elm_genlist_item_show(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19369 * Animatedly bring in, to the visible are of a genlist, a given
19372 * @param it The item to display
19374 * This causes genlist to jump to the given item @p it and show it (by
19375 * animatedly scrolling), if it is not fully visible. This may use animation
19376 * to do so and take a period of time
19378 * @see elm_genlist_item_show()
19379 * @see elm_genlist_item_top_bring_in()
19380 * @see elm_genlist_item_middle_bring_in()
19384 EAPI void elm_genlist_item_bring_in(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19386 * Show the portion of a genlist's internal list containing a given
19387 * item, immediately.
19389 * @param it The item to display
19391 * This causes genlist to jump to the given item @p it and show it (by
19392 * immediately scrolling to that position), if it is not fully visible.
19394 * The item will be positioned at the top of the genlist viewport.
19396 * @see elm_genlist_item_show()
19397 * @see elm_genlist_item_top_bring_in()
19401 EAPI void elm_genlist_item_top_show(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19403 * Animatedly bring in, to the visible are of a genlist, a given
19406 * @param it The item
19408 * This causes genlist to jump to the given item @p it and show it (by
19409 * animatedly scrolling), if it is not fully visible. This may use animation
19410 * to do so and take a period of time
19412 * The item will be positioned at the top of the genlist viewport.
19414 * @see elm_genlist_item_bring_in()
19415 * @see elm_genlist_item_top_show()
19419 EAPI void elm_genlist_item_top_bring_in(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19421 * Show the portion of a genlist's internal list containing a given
19422 * item, immediately.
19424 * @param it The item to display
19426 * This causes genlist to jump to the given item @p it and show it (by
19427 * immediately scrolling to that position), if it is not fully visible.
19429 * The item will be positioned at the middle of the genlist viewport.
19431 * @see elm_genlist_item_show()
19432 * @see elm_genlist_item_middle_bring_in()
19436 EAPI void elm_genlist_item_middle_show(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19438 * Animatedly bring in, to the visible are of a genlist, a given
19441 * @param it The item
19443 * This causes genlist to jump to the given item @p it and show it (by
19444 * animatedly scrolling), if it is not fully visible. This may use animation
19445 * to do so and take a period of time
19447 * The item will be positioned at the middle of the genlist viewport.
19449 * @see elm_genlist_item_bring_in()
19450 * @see elm_genlist_item_middle_show()
19454 EAPI void elm_genlist_item_middle_bring_in(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19456 * Remove a genlist item from the its parent, deleting it.
19458 * @param item The item to be removed.
19459 * @return @c EINA_TRUE on success or @c EINA_FALSE, otherwise.
19461 * @see elm_genlist_clear(), to remove all items in a genlist at
19466 EAPI void elm_genlist_item_del(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19468 * Return the data associated to a given genlist item
19470 * @param item The genlist item.
19471 * @return the data associated to this item.
19473 * This returns the @c data value passed on the
19474 * elm_genlist_item_append() and related item addition calls.
19476 * @see elm_genlist_item_append()
19477 * @see elm_genlist_item_data_set()
19481 EAPI void *elm_genlist_item_data_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19483 * Set the data associated to a given genlist item
19485 * @param item The genlist item
19486 * @param data The new data pointer to set on it
19488 * This @b overrides the @c data value passed on the
19489 * elm_genlist_item_append() and related item addition calls. This
19490 * function @b won't call elm_genlist_item_update() automatically,
19491 * so you'd issue it afterwards if you want to hove the item
19492 * updated to reflect the that new data.
19494 * @see elm_genlist_item_data_get()
19498 EAPI void elm_genlist_item_data_set(Elm_Genlist_Item *it, const void *data) EINA_ARG_NONNULL(1);
19500 * Tells genlist to "orphan" icons fetchs by the item class
19502 * @param it The item
19504 * This instructs genlist to release references to icons in the item,
19505 * meaning that they will no longer be managed by genlist and are
19506 * floating "orphans" that can be re-used elsewhere if the user wants
19511 EAPI void elm_genlist_item_contents_orphan(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19512 EINA_DEPRECATED EAPI void elm_genlist_item_icons_orphan(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19514 * Get the real Evas object created to implement the view of a
19515 * given genlist item
19517 * @param item The genlist item.
19518 * @return the Evas object implementing this item's view.
19520 * This returns the actual Evas object used to implement the
19521 * specified genlist item's view. This may be @c NULL, as it may
19522 * not have been created or may have been deleted, at any time, by
19523 * the genlist. <b>Do not modify this object</b> (move, resize,
19524 * show, hide, etc.), as the genlist is controlling it. This
19525 * function is for querying, emitting custom signals or hooking
19526 * lower level callbacks for events on that object. Do not delete
19527 * this object under any circumstances.
19529 * @see elm_genlist_item_data_get()
19533 EAPI const Evas_Object *elm_genlist_item_object_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19535 * Update the contents of an item
19537 * @param it The item
19539 * This updates an item by calling all the item class functions again
19540 * to get the icons, labels and states. Use this when the original
19541 * item data has changed and the changes are desired to be reflected.
19543 * Use elm_genlist_realized_items_update() to update all already realized
19546 * @see elm_genlist_realized_items_update()
19550 EAPI void elm_genlist_item_update(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19552 * Promote an item to the top of the list
19554 * @param it The item
19558 EAPI void elm_genlist_item_promote(Elm_Gen_Item *it) EINA_ARG_NONNULL(1);
19560 * Demote an item to the end of the list
19562 * @param it The item
19566 EAPI void elm_genlist_item_demote(Elm_Gen_Item *it) EINA_ARG_NONNULL(1);
19568 * Update the item class of an item
19570 * @param it The item
19571 * @param itc The item class for the item
19573 * This sets another class fo the item, changing the way that it is
19574 * displayed. After changing the item class, elm_genlist_item_update() is
19575 * called on the item @p it.
19579 EAPI void elm_genlist_item_item_class_update(Elm_Genlist_Item *it, const Elm_Genlist_Item_Class *itc) EINA_ARG_NONNULL(1, 2);
19580 EAPI const Elm_Genlist_Item_Class *elm_genlist_item_item_class_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19582 * Set the text to be shown in a given genlist item's tooltips.
19584 * @param item The genlist item
19585 * @param text The text to set in the content
19587 * This call will setup the text to be used as tooltip to that item
19588 * (analogous to elm_object_tooltip_text_set(), but being item
19589 * tooltips with higher precedence than object tooltips). It can
19590 * have only one tooltip at a time, so any previous tooltip data
19591 * will get removed.
19593 * In order to set an icon or something else as a tooltip, look at
19594 * elm_genlist_item_tooltip_content_cb_set().
19598 EAPI void elm_genlist_item_tooltip_text_set(Elm_Genlist_Item *item, const char *text) EINA_ARG_NONNULL(1);
19600 * Set the content to be shown in a given genlist item's tooltips
19602 * @param item The genlist item.
19603 * @param func The function returning the tooltip contents.
19604 * @param data What to provide to @a func as callback data/context.
19605 * @param del_cb Called when data is not needed anymore, either when
19606 * another callback replaces @p func, the tooltip is unset with
19607 * elm_genlist_item_tooltip_unset() or the owner @p item
19608 * dies. This callback receives as its first parameter the
19609 * given @p data, being @c event_info the item handle.
19611 * This call will setup the tooltip's contents to @p item
19612 * (analogous to elm_object_tooltip_content_cb_set(), but being
19613 * item tooltips with higher precedence than object tooltips). It
19614 * can have only one tooltip at a time, so any previous tooltip
19615 * content will get removed. @p func (with @p data) will be called
19616 * every time Elementary needs to show the tooltip and it should
19617 * return a valid Evas object, which will be fully managed by the
19618 * tooltip system, getting deleted when the tooltip is gone.
19620 * In order to set just a text as a tooltip, look at
19621 * elm_genlist_item_tooltip_text_set().
19625 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);
19627 * Unset a tooltip from a given genlist item
19629 * @param item genlist item to remove a previously set tooltip from.
19631 * This call removes any tooltip set on @p item. The callback
19632 * provided as @c del_cb to
19633 * elm_genlist_item_tooltip_content_cb_set() will be called to
19634 * notify it is not used anymore (and have resources cleaned, if
19637 * @see elm_genlist_item_tooltip_content_cb_set()
19641 EAPI void elm_genlist_item_tooltip_unset(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19643 * Set a different @b style for a given genlist item's tooltip.
19645 * @param item genlist item with tooltip set
19646 * @param style the <b>theme style</b> to use on tooltips (e.g. @c
19647 * "default", @c "transparent", etc)
19649 * Tooltips can have <b>alternate styles</b> to be displayed on,
19650 * which are defined by the theme set on Elementary. This function
19651 * works analogously as elm_object_tooltip_style_set(), but here
19652 * applied only to genlist item objects. The default style for
19653 * tooltips is @c "default".
19655 * @note before you set a style you should define a tooltip with
19656 * elm_genlist_item_tooltip_content_cb_set() or
19657 * elm_genlist_item_tooltip_text_set()
19659 * @see elm_genlist_item_tooltip_style_get()
19663 EAPI void elm_genlist_item_tooltip_style_set(Elm_Genlist_Item *item, const char *style) EINA_ARG_NONNULL(1);
19665 * Get the style set a given genlist item's tooltip.
19667 * @param item genlist item with tooltip already set on.
19668 * @return style the theme style in use, which defaults to
19669 * "default". If the object does not have a tooltip set,
19670 * then @c NULL is returned.
19672 * @see elm_genlist_item_tooltip_style_set() for more details
19676 EAPI const char *elm_genlist_item_tooltip_style_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19678 * @brief Disable size restrictions on an object's tooltip
19679 * @param item The tooltip's anchor object
19680 * @param disable If EINA_TRUE, size restrictions are disabled
19681 * @return EINA_FALSE on failure, EINA_TRUE on success
19683 * This function allows a tooltip to expand beyond its parant window's canvas.
19684 * It will instead be limited only by the size of the display.
19686 EAPI Eina_Bool elm_genlist_item_tooltip_size_restrict_disable(Elm_Genlist_Item *item, Eina_Bool disable);
19688 * @brief Retrieve size restriction state of an object's tooltip
19689 * @param item The tooltip's anchor object
19690 * @return If EINA_TRUE, size restrictions are disabled
19692 * This function returns whether a tooltip is allowed to expand beyond
19693 * its parant window's canvas.
19694 * It will instead be limited only by the size of the display.
19696 EAPI Eina_Bool elm_genlist_item_tooltip_size_restrict_disabled_get(const Elm_Genlist_Item *item);
19698 * Set the type of mouse pointer/cursor decoration to be shown,
19699 * when the mouse pointer is over the given genlist widget item
19701 * @param item genlist item to customize cursor on
19702 * @param cursor the cursor type's name
19704 * This function works analogously as elm_object_cursor_set(), but
19705 * here the cursor's changing area is restricted to the item's
19706 * area, and not the whole widget's. Note that that item cursors
19707 * have precedence over widget cursors, so that a mouse over @p
19708 * item will always show cursor @p type.
19710 * If this function is called twice for an object, a previously set
19711 * cursor will be unset on the second call.
19713 * @see elm_object_cursor_set()
19714 * @see elm_genlist_item_cursor_get()
19715 * @see elm_genlist_item_cursor_unset()
19719 EAPI void elm_genlist_item_cursor_set(Elm_Genlist_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
19721 * Get the type of mouse pointer/cursor decoration set to be shown,
19722 * when the mouse pointer is over the given genlist widget item
19724 * @param item genlist item with custom cursor set
19725 * @return the cursor type's name or @c NULL, if no custom cursors
19726 * were set to @p item (and on errors)
19728 * @see elm_object_cursor_get()
19729 * @see elm_genlist_item_cursor_set() for more details
19730 * @see elm_genlist_item_cursor_unset()
19734 EAPI const char *elm_genlist_item_cursor_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19736 * Unset any custom mouse pointer/cursor decoration set to be
19737 * shown, when the mouse pointer is over the given genlist widget
19738 * item, thus making it show the @b default cursor again.
19740 * @param item a genlist item
19742 * Use this call to undo any custom settings on this item's cursor
19743 * decoration, bringing it back to defaults (no custom style set).
19745 * @see elm_object_cursor_unset()
19746 * @see elm_genlist_item_cursor_set() for more details
19750 EAPI void elm_genlist_item_cursor_unset(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19752 * Set a different @b style for a given custom cursor set for a
19755 * @param item genlist item with custom cursor set
19756 * @param style the <b>theme style</b> to use (e.g. @c "default",
19757 * @c "transparent", etc)
19759 * This function only makes sense when one is using custom mouse
19760 * cursor decorations <b>defined in a theme file</b> , which can
19761 * have, given a cursor name/type, <b>alternate styles</b> on
19762 * it. It works analogously as elm_object_cursor_style_set(), but
19763 * here applied only to genlist item objects.
19765 * @warning Before you set a cursor style you should have defined a
19766 * custom cursor previously on the item, with
19767 * elm_genlist_item_cursor_set()
19769 * @see elm_genlist_item_cursor_engine_only_set()
19770 * @see elm_genlist_item_cursor_style_get()
19774 EAPI void elm_genlist_item_cursor_style_set(Elm_Genlist_Item *item, const char *style) EINA_ARG_NONNULL(1);
19776 * Get the current @b style set for a given genlist item's custom
19779 * @param item genlist item with custom cursor set.
19780 * @return style the cursor style in use. If the object does not
19781 * have a cursor set, then @c NULL is returned.
19783 * @see elm_genlist_item_cursor_style_set() for more details
19787 EAPI const char *elm_genlist_item_cursor_style_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19789 * Set if the (custom) cursor for a given genlist item should be
19790 * searched in its theme, also, or should only rely on the
19791 * rendering engine.
19793 * @param item item with custom (custom) cursor already set on
19794 * @param engine_only Use @c EINA_TRUE to have cursors looked for
19795 * only on those provided by the rendering engine, @c EINA_FALSE to
19796 * have them searched on the widget's theme, as well.
19798 * @note This call is of use only if you've set a custom cursor
19799 * for genlist items, with elm_genlist_item_cursor_set().
19801 * @note By default, cursors will only be looked for between those
19802 * provided by the rendering engine.
19806 EAPI void elm_genlist_item_cursor_engine_only_set(Elm_Genlist_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
19808 * Get if the (custom) cursor for a given genlist item is being
19809 * searched in its theme, also, or is only relying on the rendering
19812 * @param item a genlist item
19813 * @return @c EINA_TRUE, if cursors are being looked for only on
19814 * those provided by the rendering engine, @c EINA_FALSE if they
19815 * are being searched on the widget's theme, as well.
19817 * @see elm_genlist_item_cursor_engine_only_set(), for more details
19821 EAPI Eina_Bool elm_genlist_item_cursor_engine_only_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19823 * Update the contents of all realized items.
19825 * @param obj The genlist object.
19827 * This updates all realized items by calling all the item class functions again
19828 * to get the icons, labels and states. Use this when the original
19829 * item data has changed and the changes are desired to be reflected.
19831 * To update just one item, use elm_genlist_item_update().
19833 * @see elm_genlist_realized_items_get()
19834 * @see elm_genlist_item_update()
19838 EAPI void elm_genlist_realized_items_update(Evas_Object *obj) EINA_ARG_NONNULL(1);
19840 * Activate a genlist mode on an item
19842 * @param item The genlist item
19843 * @param mode Mode name
19844 * @param mode_set Boolean to define set or unset mode.
19846 * A genlist mode is a different way of selecting an item. Once a mode is
19847 * activated on an item, any other selected item is immediately unselected.
19848 * This feature provides an easy way of implementing a new kind of animation
19849 * for selecting an item, without having to entirely rewrite the item style
19850 * theme. However, the elm_genlist_selected_* API can't be used to get what
19851 * item is activate for a mode.
19853 * The current item style will still be used, but applying a genlist mode to
19854 * an item will select it using a different kind of animation.
19856 * The current active item for a mode can be found by
19857 * elm_genlist_mode_item_get().
19859 * The characteristics of genlist mode are:
19860 * - Only one mode can be active at any time, and for only one item.
19861 * - Genlist handles deactivating other items when one item is activated.
19862 * - A mode is defined in the genlist theme (edc), and more modes can easily
19864 * - A mode style and the genlist item style are different things. They
19865 * can be combined to provide a default style to the item, with some kind
19866 * of animation for that item when the mode is activated.
19868 * When a mode is activated on an item, a new view for that item is created.
19869 * The theme of this mode defines the animation that will be used to transit
19870 * the item from the old view to the new view. This second (new) view will be
19871 * active for that item while the mode is active on the item, and will be
19872 * destroyed after the mode is totally deactivated from that item.
19874 * @see elm_genlist_mode_get()
19875 * @see elm_genlist_mode_item_get()
19879 EAPI void elm_genlist_item_mode_set(Elm_Genlist_Item *it, const char *mode_type, Eina_Bool mode_set) EINA_ARG_NONNULL(1, 2);
19881 * Get the last (or current) genlist mode used.
19883 * @param obj The genlist object
19885 * This function just returns the name of the last used genlist mode. It will
19886 * be the current mode if it's still active.
19888 * @see elm_genlist_item_mode_set()
19889 * @see elm_genlist_mode_item_get()
19893 EAPI const char *elm_genlist_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19895 * Get active genlist mode item
19897 * @param obj The genlist object
19898 * @return The active item for that current mode. Or @c NULL if no item is
19899 * activated with any mode.
19901 * This function returns the item that was activated with a mode, by the
19902 * function elm_genlist_item_mode_set().
19904 * @see elm_genlist_item_mode_set()
19905 * @see elm_genlist_mode_get()
19909 EAPI const Elm_Genlist_Item *elm_genlist_mode_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19914 * @param obj The genlist object
19915 * @param reorder_mode The reorder mode
19916 * (EINA_TRUE = on, EINA_FALSE = off)
19920 EAPI void elm_genlist_reorder_mode_set(Evas_Object *obj, Eina_Bool reorder_mode) EINA_ARG_NONNULL(1);
19923 * Get the reorder mode
19925 * @param obj The genlist object
19926 * @return The reorder mode
19927 * (EINA_TRUE = on, EINA_FALSE = off)
19931 EAPI Eina_Bool elm_genlist_reorder_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19938 * @defgroup Check Check
19940 * @image html img/widget/check/preview-00.png
19941 * @image latex img/widget/check/preview-00.eps
19942 * @image html img/widget/check/preview-01.png
19943 * @image latex img/widget/check/preview-01.eps
19944 * @image html img/widget/check/preview-02.png
19945 * @image latex img/widget/check/preview-02.eps
19947 * @brief The check widget allows for toggling a value between true and
19950 * Check objects are a lot like radio objects in layout and functionality
19951 * except they do not work as a group, but independently and only toggle the
19952 * value of a boolean from false to true (0 or 1). elm_check_state_set() sets
19953 * the boolean state (1 for true, 0 for false), and elm_check_state_get()
19954 * returns the current state. For convenience, like the radio objects, you
19955 * can set a pointer to a boolean directly with elm_check_state_pointer_set()
19956 * for it to modify.
19958 * Signals that you can add callbacks for are:
19959 * "changed" - This is called whenever the user changes the state of one of
19960 * the check object(event_info is NULL).
19962 * Default contents parts of the check widget that you can use for are:
19963 * @li "icon" - A icon of the check
19965 * Default text parts of the check widget that you can use for are:
19966 * @li "elm.text" - Label of the check
19968 * @ref tutorial_check should give you a firm grasp of how to use this widget
19973 * @brief Add a new Check object
19975 * @param parent The parent object
19976 * @return The new object or NULL if it cannot be created
19978 EAPI Evas_Object *elm_check_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
19980 * @brief Set the text label of the check object
19982 * @param obj The check object
19983 * @param label The text label string in UTF-8
19985 * @deprecated use elm_object_text_set() instead.
19987 EINA_DEPRECATED EAPI void elm_check_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
19989 * @brief Get the text label of the check object
19991 * @param obj The check object
19992 * @return The text label string in UTF-8
19994 * @deprecated use elm_object_text_get() instead.
19996 EINA_DEPRECATED EAPI const char *elm_check_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19998 * @brief Set the icon object of the check object
20000 * @param obj The check object
20001 * @param icon The icon object
20003 * Once the icon object is set, a previously set one will be deleted.
20004 * If you want to keep that old content object, use the
20005 * elm_object_content_unset() function.
20007 * @deprecated use elm_object_part_content_set() instead.
20010 EINA_DEPRECATED EAPI void elm_check_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
20012 * @brief Get the icon object of the check object
20014 * @param obj The check object
20015 * @return The icon object
20017 * @deprecated use elm_object_part_content_get() instead.
20020 EINA_DEPRECATED EAPI Evas_Object *elm_check_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20022 * @brief Unset the icon used for the check object
20024 * @param obj The check object
20025 * @return The icon object that was being used
20027 * Unparent and return the icon object which was set for this widget.
20029 * @deprecated use elm_object_part_content_unset() instead.
20032 EINA_DEPRECATED EAPI Evas_Object *elm_check_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
20034 * @brief Set the on/off state of the check object
20036 * @param obj The check object
20037 * @param state The state to use (1 == on, 0 == off)
20039 * This sets the state of the check. If set
20040 * with elm_check_state_pointer_set() the state of that variable is also
20041 * changed. Calling this @b doesn't cause the "changed" signal to be emited.
20043 EAPI void elm_check_state_set(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
20045 * @brief Get the state of the check object
20047 * @param obj The check object
20048 * @return The boolean state
20050 EAPI Eina_Bool elm_check_state_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20052 * @brief Set a convenience pointer to a boolean to change
20054 * @param obj The check object
20055 * @param statep Pointer to the boolean to modify
20057 * This sets a pointer to a boolean, that, in addition to the check objects
20058 * state will also be modified directly. To stop setting the object pointed
20059 * to simply use NULL as the @p statep parameter. If @p statep is not NULL,
20060 * then when this is called, the check objects state will also be modified to
20061 * reflect the value of the boolean @p statep points to, just like calling
20062 * elm_check_state_set().
20064 EAPI void elm_check_state_pointer_set(Evas_Object *obj, Eina_Bool *statep) EINA_ARG_NONNULL(1);
20065 EINA_DEPRECATED EAPI void elm_check_states_labels_set(Evas_Object *obj, const char *ontext, const char *offtext) EINA_ARG_NONNULL(1,2,3);
20066 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);
20073 * @defgroup Radio Radio
20075 * @image html img/widget/radio/preview-00.png
20076 * @image latex img/widget/radio/preview-00.eps
20078 * @brief Radio is a widget that allows for 1 or more options to be displayed
20079 * and have the user choose only 1 of them.
20081 * A radio object contains an indicator, an optional Label and an optional
20082 * icon object. While it's possible to have a group of only one radio they,
20083 * are normally used in groups of 2 or more. To add a radio to a group use
20084 * elm_radio_group_add(). The radio object(s) will select from one of a set
20085 * of integer values, so any value they are configuring needs to be mapped to
20086 * a set of integers. To configure what value that radio object represents,
20087 * use elm_radio_state_value_set() to set the integer it represents. To set
20088 * the value the whole group(which one is currently selected) is to indicate
20089 * use elm_radio_value_set() on any group member, and to get the groups value
20090 * use elm_radio_value_get(). For convenience the radio objects are also able
20091 * to directly set an integer(int) to the value that is selected. To specify
20092 * the pointer to this integer to modify, use elm_radio_value_pointer_set().
20093 * The radio objects will modify this directly. That implies the pointer must
20094 * point to valid memory for as long as the radio objects exist.
20096 * Signals that you can add callbacks for are:
20097 * @li changed - This is called whenever the user changes the state of one of
20098 * the radio objects within the group of radio objects that work together.
20100 * Default contents parts of the radio widget that you can use for are:
20101 * @li "icon" - A icon of the radio
20103 * @ref tutorial_radio show most of this API in action.
20107 * @brief Add a new radio to the parent
20109 * @param parent The parent object
20110 * @return The new object or NULL if it cannot be created
20112 EAPI Evas_Object *elm_radio_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20114 * @brief Set the text label of the radio object
20116 * @param obj The radio object
20117 * @param label The text label string in UTF-8
20119 * @deprecated use elm_object_text_set() instead.
20121 EINA_DEPRECATED EAPI void elm_radio_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
20123 * @brief Get the text label of the radio object
20125 * @param obj The radio object
20126 * @return The text label string in UTF-8
20128 * @deprecated use elm_object_text_set() instead.
20130 EINA_DEPRECATED EAPI const char *elm_radio_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20132 * @brief Set the icon object of the radio object
20134 * @param obj The radio object
20135 * @param icon The icon object
20137 * Once the icon object is set, a previously set one will be deleted. If you
20138 * want to keep that old content object, use the elm_radio_icon_unset()
20141 * @deprecated use elm_object_part_content_set() instead.
20144 EINA_DEPRECATED EAPI void elm_radio_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
20146 * @brief Get the icon object of the radio object
20148 * @param obj The radio object
20149 * @return The icon object
20151 * @see elm_radio_icon_set()
20153 * @deprecated use elm_object_part_content_get() instead.
20156 EINA_DEPRECATED EAPI Evas_Object *elm_radio_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20158 * @brief Unset the icon used for the radio object
20160 * @param obj The radio object
20161 * @return The icon object that was being used
20163 * Unparent and return the icon object which was set for this widget.
20165 * @see elm_radio_icon_set()
20166 * @deprecated use elm_object_part_content_unset() instead.
20169 EINA_DEPRECATED EAPI Evas_Object *elm_radio_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
20171 * @brief Add this radio to a group of other radio objects
20173 * @param obj The radio object
20174 * @param group Any object whose group the @p obj is to join.
20176 * Radio objects work in groups. Each member should have a different integer
20177 * value assigned. In order to have them work as a group, they need to know
20178 * about each other. This adds the given radio object to the group of which
20179 * the group object indicated is a member.
20181 EAPI void elm_radio_group_add(Evas_Object *obj, Evas_Object *group) EINA_ARG_NONNULL(1);
20183 * @brief Set the integer value that this radio object represents
20185 * @param obj The radio object
20186 * @param value The value to use if this radio object is selected
20188 * This sets the value of the radio.
20190 EAPI void elm_radio_state_value_set(Evas_Object *obj, int value) EINA_ARG_NONNULL(1);
20192 * @brief Get the integer value that this radio object represents
20194 * @param obj The radio object
20195 * @return The value used if this radio object is selected
20197 * This gets the value of the radio.
20199 * @see elm_radio_value_set()
20201 EAPI int elm_radio_state_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20203 * @brief Set the value of the radio.
20205 * @param obj The radio object
20206 * @param value The value to use for the group
20208 * This sets the value of the radio group and will also set the value if
20209 * pointed to, to the value supplied, but will not call any callbacks.
20211 EAPI void elm_radio_value_set(Evas_Object *obj, int value) EINA_ARG_NONNULL(1);
20213 * @brief Get the state of the radio object
20215 * @param obj The radio object
20216 * @return The integer state
20218 EAPI int elm_radio_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20220 * @brief Set a convenience pointer to a integer to change
20222 * @param obj The radio object
20223 * @param valuep Pointer to the integer to modify
20225 * This sets a pointer to a integer, that, in addition to the radio objects
20226 * state will also be modified directly. To stop setting the object pointed
20227 * to simply use NULL as the @p valuep argument. If valuep is not NULL, then
20228 * when this is called, the radio objects state will also be modified to
20229 * reflect the value of the integer valuep points to, just like calling
20230 * elm_radio_value_set().
20232 EAPI void elm_radio_value_pointer_set(Evas_Object *obj, int *valuep) EINA_ARG_NONNULL(1);
20238 * @defgroup Pager Pager
20240 * @image html img/widget/pager/preview-00.png
20241 * @image latex img/widget/pager/preview-00.eps
20243 * @brief Widget that allows flipping between one or more āpagesā
20246 * The flipping between pages of objects is animated. All content
20247 * in the pager is kept in a stack, being the last content added
20248 * (visible one) on the top of that stack.
20250 * Objects can be pushed or popped from the stack or deleted as
20251 * well. Pushes and pops will animate the widget accordingly to its
20252 * style (a pop will also delete the child object once the
20253 * animation is finished). Any object already in the pager can be
20254 * promoted to the top (from its current stacking position) through
20255 * the use of elm_pager_content_promote(). New objects are pushed
20256 * to the top with elm_pager_content_push(). When the top item is
20257 * no longer wanted, simply pop it with elm_pager_content_pop() and
20258 * it will also be deleted. If an object is no longer needed and is
20259 * not the top item, just delete it as normal. You can query which
20260 * objects are the top and bottom with
20261 * elm_pager_content_bottom_get() and elm_pager_content_top_get().
20263 * Signals that you can add callbacks for are:
20264 * - @c "show,finished" - when a new page is actually shown on the top
20265 * - @c "hide,finished" - when a previous page is hidden
20267 * Only after the first of that signals the child object is
20268 * guaranteed to be visible, as in @c evas_object_visible_get().
20270 * This widget has the following styles available:
20273 * - @c "fade_translucide"
20274 * - @c "fade_invisible"
20276 * @note These styles affect only the flipping animations on the
20277 * default theme; the appearance when not animating is unaffected
20280 * @ref tutorial_pager gives a good overview of the usage of the API.
20285 * Add a new pager to the parent
20287 * @param parent The parent object
20288 * @return The new object or NULL if it cannot be created
20292 EAPI Evas_Object *elm_pager_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20295 * @brief Push an object to the top of the pager stack (and show it).
20297 * @param obj The pager object
20298 * @param content The object to push
20300 * The object pushed becomes a child of the pager, it will be controlled and
20301 * deleted when the pager is deleted.
20303 * @note If the content is already in the stack use
20304 * elm_pager_content_promote().
20305 * @warning Using this function on @p content already in the stack results in
20306 * undefined behavior.
20308 EAPI void elm_pager_content_push(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
20311 * @brief Pop the object that is on top of the stack
20313 * @param obj The pager object
20315 * This pops the object that is on the top(visible) of the pager, makes it
20316 * disappear, then deletes the object. The object that was underneath it on
20317 * the stack will become visible.
20319 EAPI void elm_pager_content_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
20322 * @brief Moves an object already in the pager stack to the top of the stack.
20324 * @param obj The pager object
20325 * @param content The object to promote
20327 * This will take the @p content and move it to the top of the stack as
20328 * if it had been pushed there.
20330 * @note If the content isn't already in the stack use
20331 * elm_pager_content_push().
20332 * @warning Using this function on @p content not already in the stack
20333 * results in undefined behavior.
20335 EAPI void elm_pager_content_promote(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
20338 * @brief Return the object at the bottom of the pager stack
20340 * @param obj The pager object
20341 * @return The bottom object or NULL if none
20343 EAPI Evas_Object *elm_pager_content_bottom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20346 * @brief Return the object at the top of the pager stack
20348 * @param obj The pager object
20349 * @return The top object or NULL if none
20351 EAPI Evas_Object *elm_pager_content_top_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20358 * @defgroup Slideshow Slideshow
20360 * @image html img/widget/slideshow/preview-00.png
20361 * @image latex img/widget/slideshow/preview-00.eps
20363 * This widget, as the name indicates, is a pre-made image
20364 * slideshow panel, with API functions acting on (child) image
20365 * items presentation. Between those actions, are:
20366 * - advance to next/previous image
20367 * - select the style of image transition animation
20368 * - set the exhibition time for each image
20369 * - start/stop the slideshow
20371 * The transition animations are defined in the widget's theme,
20372 * consequently new animations can be added without having to
20373 * update the widget's code.
20375 * @section Slideshow_Items Slideshow items
20377 * For slideshow items, just like for @ref Genlist "genlist" ones,
20378 * the user defines a @b classes, specifying functions that will be
20379 * called on the item's creation and deletion times.
20381 * The #Elm_Slideshow_Item_Class structure contains the following
20384 * - @c func.get - When an item is displayed, this function is
20385 * called, and it's where one should create the item object, de
20386 * facto. For example, the object can be a pure Evas image object
20387 * or an Elementary @ref Photocam "photocam" widget. See
20388 * #SlideshowItemGetFunc.
20389 * - @c func.del - When an item is no more displayed, this function
20390 * is called, where the user must delete any data associated to
20391 * the item. See #SlideshowItemDelFunc.
20393 * @section Slideshow_Caching Slideshow caching
20395 * The slideshow provides facilities to have items adjacent to the
20396 * one being displayed <b>already "realized"</b> (i.e. loaded) for
20397 * you, so that the system does not have to decode image data
20398 * anymore at the time it has to actually switch images on its
20399 * viewport. The user is able to set the numbers of items to be
20400 * cached @b before and @b after the current item, in the widget's
20403 * Smart events one can add callbacks for are:
20405 * - @c "changed" - when the slideshow switches its view to a new
20408 * List of examples for the slideshow widget:
20409 * @li @ref slideshow_example
20413 * @addtogroup Slideshow
20417 typedef struct _Elm_Slideshow_Item_Class Elm_Slideshow_Item_Class; /**< Slideshow item class definition struct */
20418 typedef struct _Elm_Slideshow_Item_Class_Func Elm_Slideshow_Item_Class_Func; /**< Class functions for slideshow item classes. */
20419 typedef struct _Elm_Slideshow_Item Elm_Slideshow_Item; /**< Slideshow item handle */
20420 typedef Evas_Object *(*SlideshowItemGetFunc) (void *data, Evas_Object *obj); /**< Image fetching class function for slideshow item classes. */
20421 typedef void (*SlideshowItemDelFunc) (void *data, Evas_Object *obj); /**< Deletion class function for slideshow item classes. */
20424 * @struct _Elm_Slideshow_Item_Class
20426 * Slideshow item class definition. See @ref Slideshow_Items for
20429 struct _Elm_Slideshow_Item_Class
20431 struct _Elm_Slideshow_Item_Class_Func
20433 SlideshowItemGetFunc get;
20434 SlideshowItemDelFunc del;
20436 }; /**< #Elm_Slideshow_Item_Class member definitions */
20439 * Add a new slideshow widget to the given parent Elementary
20440 * (container) object
20442 * @param parent The parent object
20443 * @return A new slideshow widget handle or @c NULL, on errors
20445 * This function inserts a new slideshow widget on the canvas.
20447 * @ingroup Slideshow
20449 EAPI Evas_Object *elm_slideshow_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20452 * Add (append) a new item in a given slideshow widget.
20454 * @param obj The slideshow object
20455 * @param itc The item class for the item
20456 * @param data The item's data
20457 * @return A handle to the item added or @c NULL, on errors
20459 * Add a new item to @p obj's internal list of items, appending it.
20460 * The item's class must contain the function really fetching the
20461 * image object to show for this item, which could be an Evas image
20462 * object or an Elementary photo, for example. The @p data
20463 * parameter is going to be passed to both class functions of the
20466 * @see #Elm_Slideshow_Item_Class
20467 * @see elm_slideshow_item_sorted_insert()
20469 * @ingroup Slideshow
20471 EAPI Elm_Slideshow_Item *elm_slideshow_item_add(Evas_Object *obj, const Elm_Slideshow_Item_Class *itc, const void *data) EINA_ARG_NONNULL(1);
20474 * Insert a new item into the given slideshow widget, using the @p func
20475 * function to sort items (by item handles).
20477 * @param obj The slideshow object
20478 * @param itc The item class for the item
20479 * @param data The item's data
20480 * @param func The comparing function to be used to sort slideshow
20481 * items <b>by #Elm_Slideshow_Item item handles</b>
20482 * @return Returns The slideshow item handle, on success, or
20483 * @c NULL, on errors
20485 * Add a new item to @p obj's internal list of items, in a position
20486 * determined by the @p func comparing function. The item's class
20487 * must contain the function really fetching the image object to
20488 * show for this item, which could be an Evas image object or an
20489 * Elementary photo, for example. The @p data parameter is going to
20490 * be passed to both class functions of the item.
20492 * @see #Elm_Slideshow_Item_Class
20493 * @see elm_slideshow_item_add()
20495 * @ingroup Slideshow
20497 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);
20500 * Display a given slideshow widget's item, programmatically.
20502 * @param obj The slideshow object
20503 * @param item The item to display on @p obj's viewport
20505 * The change between the current item and @p item will use the
20506 * transition @p obj is set to use (@see
20507 * elm_slideshow_transition_set()).
20509 * @ingroup Slideshow
20511 EAPI void elm_slideshow_show(Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
20514 * Slide to the @b next item, in a given slideshow widget
20516 * @param obj The slideshow object
20518 * The sliding animation @p obj is set to use will be the
20519 * transition effect used, after this call is issued.
20521 * @note If the end of the slideshow's internal list of items is
20522 * reached, it'll wrap around to the list's beginning, again.
20524 * @ingroup Slideshow
20526 EAPI void elm_slideshow_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
20529 * Slide to the @b previous item, in a given slideshow widget
20531 * @param obj The slideshow object
20533 * The sliding animation @p obj is set to use will be the
20534 * transition effect used, after this call is issued.
20536 * @note If the beginning of the slideshow's internal list of items
20537 * is reached, it'll wrap around to the list's end, again.
20539 * @ingroup Slideshow
20541 EAPI void elm_slideshow_previous(Evas_Object *obj) EINA_ARG_NONNULL(1);
20544 * Returns the list of sliding transition/effect names available, for a
20545 * given slideshow widget.
20547 * @param obj The slideshow object
20548 * @return The list of transitions (list of @b stringshared strings
20551 * The transitions, which come from @p obj's theme, must be an EDC
20552 * data item named @c "transitions" on the theme file, with (prefix)
20553 * names of EDC programs actually implementing them.
20555 * The available transitions for slideshows on the default theme are:
20556 * - @c "fade" - the current item fades out, while the new one
20557 * fades in to the slideshow's viewport.
20558 * - @c "black_fade" - the current item fades to black, and just
20559 * then, the new item will fade in.
20560 * - @c "horizontal" - the current item slides horizontally, until
20561 * it gets out of the slideshow's viewport, while the new item
20562 * comes from the left to take its place.
20563 * - @c "vertical" - the current item slides vertically, until it
20564 * gets out of the slideshow's viewport, while the new item comes
20565 * from the bottom to take its place.
20566 * - @c "square" - the new item starts to appear from the middle of
20567 * the current one, but with a tiny size, growing until its
20568 * target (full) size and covering the old one.
20570 * @warning The stringshared strings get no new references
20571 * exclusive to the user grabbing the list, here, so if you'd like
20572 * to use them out of this call's context, you'd better @c
20573 * eina_stringshare_ref() them.
20575 * @see elm_slideshow_transition_set()
20577 * @ingroup Slideshow
20579 EAPI const Eina_List *elm_slideshow_transitions_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20582 * Set the current slide transition/effect in use for a given
20585 * @param obj The slideshow object
20586 * @param transition The new transition's name string
20588 * If @p transition is implemented in @p obj's theme (i.e., is
20589 * contained in the list returned by
20590 * elm_slideshow_transitions_get()), this new sliding effect will
20591 * be used on the widget.
20593 * @see elm_slideshow_transitions_get() for more details
20595 * @ingroup Slideshow
20597 EAPI void elm_slideshow_transition_set(Evas_Object *obj, const char *transition) EINA_ARG_NONNULL(1);
20600 * Get the current slide transition/effect in use for a given
20603 * @param obj The slideshow object
20604 * @return The current transition's name
20606 * @see elm_slideshow_transition_set() for more details
20608 * @ingroup Slideshow
20610 EAPI const char *elm_slideshow_transition_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20613 * Set the interval between each image transition on a given
20614 * slideshow widget, <b>and start the slideshow, itself</b>
20616 * @param obj The slideshow object
20617 * @param timeout The new displaying timeout for images
20619 * After this call, the slideshow widget will start cycling its
20620 * view, sequentially and automatically, with the images of the
20621 * items it has. The time between each new image displayed is going
20622 * to be @p timeout, in @b seconds. If a different timeout was set
20623 * previously and an slideshow was in progress, it will continue
20624 * with the new time between transitions, after this call.
20626 * @note A value less than or equal to 0 on @p timeout will disable
20627 * the widget's internal timer, thus halting any slideshow which
20628 * could be happening on @p obj.
20630 * @see elm_slideshow_timeout_get()
20632 * @ingroup Slideshow
20634 EAPI void elm_slideshow_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
20637 * Get the interval set for image transitions on a given slideshow
20640 * @param obj The slideshow object
20641 * @return Returns the timeout set on it
20643 * @see elm_slideshow_timeout_set() for more details
20645 * @ingroup Slideshow
20647 EAPI double elm_slideshow_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20650 * Set if, after a slideshow is started, for a given slideshow
20651 * widget, its items should be displayed cyclically or not.
20653 * @param obj The slideshow object
20654 * @param loop Use @c EINA_TRUE to make it cycle through items or
20655 * @c EINA_FALSE for it to stop at the end of @p obj's internal
20658 * @note elm_slideshow_next() and elm_slideshow_previous() will @b
20659 * ignore what is set by this functions, i.e., they'll @b always
20660 * cycle through items. This affects only the "automatic"
20661 * slideshow, as set by elm_slideshow_timeout_set().
20663 * @see elm_slideshow_loop_get()
20665 * @ingroup Slideshow
20667 EAPI void elm_slideshow_loop_set(Evas_Object *obj, Eina_Bool loop) EINA_ARG_NONNULL(1);
20670 * Get if, after a slideshow is started, for a given slideshow
20671 * widget, its items are to be displayed cyclically or not.
20673 * @param obj The slideshow object
20674 * @return @c EINA_TRUE, if the items in @p obj will be cycled
20675 * through or @c EINA_FALSE, otherwise
20677 * @see elm_slideshow_loop_set() for more details
20679 * @ingroup Slideshow
20681 EAPI Eina_Bool elm_slideshow_loop_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20684 * Remove all items from a given slideshow widget
20686 * @param obj The slideshow object
20688 * This removes (and deletes) all items in @p obj, leaving it
20691 * @see elm_slideshow_item_del(), to remove just one item.
20693 * @ingroup Slideshow
20695 EAPI void elm_slideshow_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
20698 * Get the internal list of items in a given slideshow widget.
20700 * @param obj The slideshow object
20701 * @return The list of items (#Elm_Slideshow_Item as data) or
20702 * @c NULL on errors.
20704 * This list is @b not to be modified in any way and must not be
20705 * freed. Use the list members with functions like
20706 * elm_slideshow_item_del(), elm_slideshow_item_data_get().
20708 * @warning This list is only valid until @p obj object's internal
20709 * items list is changed. It should be fetched again with another
20710 * call to this function when changes happen.
20712 * @ingroup Slideshow
20714 EAPI const Eina_List *elm_slideshow_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20717 * Delete a given item from a slideshow widget.
20719 * @param item The slideshow item
20721 * @ingroup Slideshow
20723 EAPI void elm_slideshow_item_del(Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
20726 * Return the data associated with a given slideshow item
20728 * @param item The slideshow item
20729 * @return Returns the data associated to this item
20731 * @ingroup Slideshow
20733 EAPI void *elm_slideshow_item_data_get(const Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
20736 * Returns the currently displayed item, in a given slideshow widget
20738 * @param obj The slideshow object
20739 * @return A handle to the item being displayed in @p obj or
20740 * @c NULL, if none is (and on errors)
20742 * @ingroup Slideshow
20744 EAPI Elm_Slideshow_Item *elm_slideshow_item_current_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20747 * Get the real Evas object created to implement the view of a
20748 * given slideshow item
20750 * @param item The slideshow item.
20751 * @return the Evas object implementing this item's view.
20753 * This returns the actual Evas object used to implement the
20754 * specified slideshow item's view. This may be @c NULL, as it may
20755 * not have been created or may have been deleted, at any time, by
20756 * the slideshow. <b>Do not modify this object</b> (move, resize,
20757 * show, hide, etc.), as the slideshow is controlling it. This
20758 * function is for querying, emitting custom signals or hooking
20759 * lower level callbacks for events on that object. Do not delete
20760 * this object under any circumstances.
20762 * @see elm_slideshow_item_data_get()
20764 * @ingroup Slideshow
20766 EAPI Evas_Object* elm_slideshow_item_object_get(const Elm_Slideshow_Item* item) EINA_ARG_NONNULL(1);
20769 * Get the the item, in a given slideshow widget, placed at
20770 * position @p nth, in its internal items list
20772 * @param obj The slideshow object
20773 * @param nth The number of the item to grab a handle to (0 being
20775 * @return The item stored in @p obj at position @p nth or @c NULL,
20776 * if there's no item with that index (and on errors)
20778 * @ingroup Slideshow
20780 EAPI Elm_Slideshow_Item *elm_slideshow_item_nth_get(const Evas_Object *obj, unsigned int nth) EINA_ARG_NONNULL(1);
20783 * Set the current slide layout in use for a given slideshow widget
20785 * @param obj The slideshow object
20786 * @param layout The new layout's name string
20788 * If @p layout is implemented in @p obj's theme (i.e., is contained
20789 * in the list returned by elm_slideshow_layouts_get()), this new
20790 * images layout will be used on the widget.
20792 * @see elm_slideshow_layouts_get() for more details
20794 * @ingroup Slideshow
20796 EAPI void elm_slideshow_layout_set(Evas_Object *obj, const char *layout) EINA_ARG_NONNULL(1);
20799 * Get the current slide layout in use for a given slideshow widget
20801 * @param obj The slideshow object
20802 * @return The current layout's name
20804 * @see elm_slideshow_layout_set() for more details
20806 * @ingroup Slideshow
20808 EAPI const char *elm_slideshow_layout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20811 * Returns the list of @b layout names available, for a given
20812 * slideshow widget.
20814 * @param obj The slideshow object
20815 * @return The list of layouts (list of @b stringshared strings
20818 * Slideshow layouts will change how the widget is to dispose each
20819 * image item in its viewport, with regard to cropping, scaling,
20822 * The layouts, which come from @p obj's theme, must be an EDC
20823 * data item name @c "layouts" on the theme file, with (prefix)
20824 * names of EDC programs actually implementing them.
20826 * The available layouts for slideshows on the default theme are:
20827 * - @c "fullscreen" - item images with original aspect, scaled to
20828 * touch top and down slideshow borders or, if the image's heigh
20829 * is not enough, left and right slideshow borders.
20830 * - @c "not_fullscreen" - the same behavior as the @c "fullscreen"
20831 * one, but always leaving 10% of the slideshow's dimensions of
20832 * distance between the item image's borders and the slideshow
20833 * borders, for each axis.
20835 * @warning The stringshared strings get no new references
20836 * exclusive to the user grabbing the list, here, so if you'd like
20837 * to use them out of this call's context, you'd better @c
20838 * eina_stringshare_ref() them.
20840 * @see elm_slideshow_layout_set()
20842 * @ingroup Slideshow
20844 EAPI const Eina_List *elm_slideshow_layouts_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20847 * Set the number of items to cache, on a given slideshow widget,
20848 * <b>before the current item</b>
20850 * @param obj The slideshow object
20851 * @param count Number of items to cache before the current one
20853 * The default value for this property is @c 2. See
20854 * @ref Slideshow_Caching "slideshow caching" for more details.
20856 * @see elm_slideshow_cache_before_get()
20858 * @ingroup Slideshow
20860 EAPI void elm_slideshow_cache_before_set(Evas_Object *obj, int count) EINA_ARG_NONNULL(1);
20863 * Retrieve the number of items to cache, on a given slideshow widget,
20864 * <b>before the current item</b>
20866 * @param obj The slideshow object
20867 * @return The number of items set to be cached before the current one
20869 * @see elm_slideshow_cache_before_set() for more details
20871 * @ingroup Slideshow
20873 EAPI int elm_slideshow_cache_before_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20876 * Set the number of items to cache, on a given slideshow widget,
20877 * <b>after the current item</b>
20879 * @param obj The slideshow object
20880 * @param count Number of items to cache after the current one
20882 * The default value for this property is @c 2. See
20883 * @ref Slideshow_Caching "slideshow caching" for more details.
20885 * @see elm_slideshow_cache_after_get()
20887 * @ingroup Slideshow
20889 EAPI void elm_slideshow_cache_after_set(Evas_Object *obj, int count) EINA_ARG_NONNULL(1);
20892 * Retrieve the number of items to cache, on a given slideshow widget,
20893 * <b>after the current item</b>
20895 * @param obj The slideshow object
20896 * @return The number of items set to be cached after the current one
20898 * @see elm_slideshow_cache_after_set() for more details
20900 * @ingroup Slideshow
20902 EAPI int elm_slideshow_cache_after_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20905 * Get the number of items stored in a given slideshow widget
20907 * @param obj The slideshow object
20908 * @return The number of items on @p obj, at the moment of this call
20910 * @ingroup Slideshow
20912 EAPI unsigned int elm_slideshow_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20919 * @defgroup Fileselector File Selector
20921 * @image html img/widget/fileselector/preview-00.png
20922 * @image latex img/widget/fileselector/preview-00.eps
20924 * A file selector is a widget that allows a user to navigate
20925 * through a file system, reporting file selections back via its
20928 * It contains shortcut buttons for home directory (@c ~) and to
20929 * jump one directory upwards (..), as well as cancel/ok buttons to
20930 * confirm/cancel a given selection. After either one of those two
20931 * former actions, the file selector will issue its @c "done" smart
20934 * There's a text entry on it, too, showing the name of the current
20935 * selection. There's the possibility of making it editable, so it
20936 * is useful on file saving dialogs on applications, where one
20937 * gives a file name to save contents to, in a given directory in
20938 * the system. This custom file name will be reported on the @c
20939 * "done" smart callback (explained in sequence).
20941 * Finally, it has a view to display file system items into in two
20946 * If Elementary is built with support of the Ethumb thumbnailing
20947 * library, the second form of view will display preview thumbnails
20948 * of files which it supports.
20950 * Smart callbacks one can register to:
20952 * - @c "selected" - the user has clicked on a file (when not in
20953 * folders-only mode) or directory (when in folders-only mode)
20954 * - @c "directory,open" - the list has been populated with new
20955 * content (@c event_info is a pointer to the directory's
20956 * path, a @b stringshared string)
20957 * - @c "done" - the user has clicked on the "ok" or "cancel"
20958 * buttons (@c event_info is a pointer to the selection's
20959 * path, a @b stringshared string)
20961 * Here is an example on its usage:
20962 * @li @ref fileselector_example
20966 * @addtogroup Fileselector
20971 * Defines how a file selector widget is to layout its contents
20972 * (file system entries).
20974 typedef enum _Elm_Fileselector_Mode
20976 ELM_FILESELECTOR_LIST = 0, /**< layout as a list */
20977 ELM_FILESELECTOR_GRID, /**< layout as a grid */
20978 ELM_FILESELECTOR_LAST /**< sentinel (helper) value, not used */
20979 } Elm_Fileselector_Mode;
20982 * Add a new file selector widget to the given parent Elementary
20983 * (container) object
20985 * @param parent The parent object
20986 * @return a new file selector widget handle or @c NULL, on errors
20988 * This function inserts a new file selector widget on the canvas.
20990 * @ingroup Fileselector
20992 EAPI Evas_Object *elm_fileselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20995 * Enable/disable the file name entry box where the user can type
20996 * in a name for a file, in a given file selector widget
20998 * @param obj The file selector object
20999 * @param is_save @c EINA_TRUE to make the file selector a "saving
21000 * dialog", @c EINA_FALSE otherwise
21002 * Having the entry editable is useful on file saving dialogs on
21003 * applications, where one gives a file name to save contents to,
21004 * in a given directory in the system. This custom file name will
21005 * be reported on the @c "done" smart callback.
21007 * @see elm_fileselector_is_save_get()
21009 * @ingroup Fileselector
21011 EAPI void elm_fileselector_is_save_set(Evas_Object *obj, Eina_Bool is_save) EINA_ARG_NONNULL(1);
21014 * Get whether the given file selector is in "saving dialog" mode
21016 * @param obj The file selector object
21017 * @return @c EINA_TRUE, if the file selector is in "saving dialog"
21018 * mode, @c EINA_FALSE otherwise (and on errors)
21020 * @see elm_fileselector_is_save_set() for more details
21022 * @ingroup Fileselector
21024 EAPI Eina_Bool elm_fileselector_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21027 * Enable/disable folder-only view for a given file selector widget
21029 * @param obj The file selector object
21030 * @param only @c EINA_TRUE to make @p obj only display
21031 * directories, @c EINA_FALSE to make files to be displayed in it
21034 * If enabled, the widget's view will only display folder items,
21037 * @see elm_fileselector_folder_only_get()
21039 * @ingroup Fileselector
21041 EAPI void elm_fileselector_folder_only_set(Evas_Object *obj, Eina_Bool only) EINA_ARG_NONNULL(1);
21044 * Get whether folder-only view is set for a given file selector
21047 * @param obj The file selector object
21048 * @return only @c EINA_TRUE if @p obj is only displaying
21049 * directories, @c EINA_FALSE if files are being displayed in it
21050 * too (and on errors)
21052 * @see elm_fileselector_folder_only_get()
21054 * @ingroup Fileselector
21056 EAPI Eina_Bool elm_fileselector_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21059 * Enable/disable the "ok" and "cancel" buttons on a given file
21062 * @param obj The file selector object
21063 * @param only @c EINA_TRUE to show them, @c EINA_FALSE to hide.
21065 * @note A file selector without those buttons will never emit the
21066 * @c "done" smart event, and is only usable if one is just hooking
21067 * to the other two events.
21069 * @see elm_fileselector_buttons_ok_cancel_get()
21071 * @ingroup Fileselector
21073 EAPI void elm_fileselector_buttons_ok_cancel_set(Evas_Object *obj, Eina_Bool buttons) EINA_ARG_NONNULL(1);
21076 * Get whether the "ok" and "cancel" buttons on a given file
21077 * selector widget are being shown.
21079 * @param obj The file selector object
21080 * @return @c EINA_TRUE if they are being shown, @c EINA_FALSE
21081 * otherwise (and on errors)
21083 * @see elm_fileselector_buttons_ok_cancel_set() for more details
21085 * @ingroup Fileselector
21087 EAPI Eina_Bool elm_fileselector_buttons_ok_cancel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21090 * Enable/disable a tree view in the given file selector widget,
21091 * <b>if it's in @c #ELM_FILESELECTOR_LIST mode</b>
21093 * @param obj The file selector object
21094 * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
21097 * In a tree view, arrows are created on the sides of directories,
21098 * allowing them to expand in place.
21100 * @note If it's in other mode, the changes made by this function
21101 * will only be visible when one switches back to "list" mode.
21103 * @see elm_fileselector_expandable_get()
21105 * @ingroup Fileselector
21107 EAPI void elm_fileselector_expandable_set(Evas_Object *obj, Eina_Bool expand) EINA_ARG_NONNULL(1);
21110 * Get whether tree view is enabled for the given file selector
21113 * @param obj The file selector object
21114 * @return @c EINA_TRUE if @p obj is in tree view, @c EINA_FALSE
21115 * otherwise (and or errors)
21117 * @see elm_fileselector_expandable_set() for more details
21119 * @ingroup Fileselector
21121 EAPI Eina_Bool elm_fileselector_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21124 * Set, programmatically, the @b directory that a given file
21125 * selector widget will display contents from
21127 * @param obj The file selector object
21128 * @param path The path to display in @p obj
21130 * This will change the @b directory that @p obj is displaying. It
21131 * will also clear the text entry area on the @p obj object, which
21132 * displays select files' names.
21134 * @see elm_fileselector_path_get()
21136 * @ingroup Fileselector
21138 EAPI void elm_fileselector_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
21141 * Get the parent directory's path that a given file selector
21142 * widget is displaying
21144 * @param obj The file selector object
21145 * @return The (full) path of the directory the file selector is
21146 * displaying, a @b stringshared string
21148 * @see elm_fileselector_path_set()
21150 * @ingroup Fileselector
21152 EAPI const char *elm_fileselector_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21155 * Set, programmatically, the currently selected file/directory in
21156 * the given file selector widget
21158 * @param obj The file selector object
21159 * @param path The (full) path to a file or directory
21160 * @return @c EINA_TRUE on success, @c EINA_FALSE on failure. The
21161 * latter case occurs if the directory or file pointed to do not
21164 * @see elm_fileselector_selected_get()
21166 * @ingroup Fileselector
21168 EAPI Eina_Bool elm_fileselector_selected_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
21171 * Get the currently selected item's (full) path, in the given file
21174 * @param obj The file selector object
21175 * @return The absolute path of the selected item, a @b
21176 * stringshared string
21178 * @note Custom editions on @p obj object's text entry, if made,
21179 * will appear on the return string of this function, naturally.
21181 * @see elm_fileselector_selected_set() for more details
21183 * @ingroup Fileselector
21185 EAPI const char *elm_fileselector_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21188 * Set the mode in which a given file selector widget will display
21189 * (layout) file system entries in its view
21191 * @param obj The file selector object
21192 * @param mode The mode of the fileselector, being it one of
21193 * #ELM_FILESELECTOR_LIST (default) or #ELM_FILESELECTOR_GRID. The
21194 * first one, naturally, will display the files in a list. The
21195 * latter will make the widget to display its entries in a grid
21198 * @note By using elm_fileselector_expandable_set(), the user may
21199 * trigger a tree view for that list.
21201 * @note If Elementary is built with support of the Ethumb
21202 * thumbnailing library, the second form of view will display
21203 * preview thumbnails of files which it supports. You must have
21204 * elm_need_ethumb() called in your Elementary for thumbnailing to
21207 * @see elm_fileselector_expandable_set().
21208 * @see elm_fileselector_mode_get().
21210 * @ingroup Fileselector
21212 EAPI void elm_fileselector_mode_set(Evas_Object *obj, Elm_Fileselector_Mode mode) EINA_ARG_NONNULL(1);
21215 * Get the mode in which a given file selector widget is displaying
21216 * (layouting) file system entries in its view
21218 * @param obj The fileselector object
21219 * @return The mode in which the fileselector is at
21221 * @see elm_fileselector_mode_set() for more details
21223 * @ingroup Fileselector
21225 EAPI Elm_Fileselector_Mode elm_fileselector_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21232 * @defgroup Progressbar Progress bar
21234 * The progress bar is a widget for visually representing the
21235 * progress status of a given job/task.
21237 * A progress bar may be horizontal or vertical. It may display an
21238 * icon besides it, as well as primary and @b units labels. The
21239 * former is meant to label the widget as a whole, while the
21240 * latter, which is formatted with floating point values (and thus
21241 * accepts a <c>printf</c>-style format string, like <c>"%1.2f
21242 * units"</c>), is meant to label the widget's <b>progress
21243 * value</b>. Label, icon and unit strings/objects are @b optional
21244 * for progress bars.
21246 * A progress bar may be @b inverted, in which state it gets its
21247 * values inverted, with high values being on the left or top and
21248 * low values on the right or bottom, as opposed to normally have
21249 * the low values on the former and high values on the latter,
21250 * respectively, for horizontal and vertical modes.
21252 * The @b span of the progress, as set by
21253 * elm_progressbar_span_size_set(), is its length (horizontally or
21254 * vertically), unless one puts size hints on the widget to expand
21255 * on desired directions, by any container. That length will be
21256 * scaled by the object or applications scaling factor. At any
21257 * point code can query the progress bar for its value with
21258 * elm_progressbar_value_get().
21260 * Available widget styles for progress bars:
21262 * - @c "wheel" (simple style, no text, no progression, only
21263 * "pulse" effect is available)
21265 * Default contents parts of the progressbar widget that you can use for are:
21266 * @li "icon" - A icon of the progressbar
21268 * Here is an example on its usage:
21269 * @li @ref progressbar_example
21273 * Add a new progress bar widget to the given parent Elementary
21274 * (container) object
21276 * @param parent The parent object
21277 * @return a new progress bar widget handle or @c NULL, on errors
21279 * This function inserts a new progress bar widget on the canvas.
21281 * @ingroup Progressbar
21283 EAPI Evas_Object *elm_progressbar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21286 * Set whether a given progress bar widget is at "pulsing mode" or
21289 * @param obj The progress bar object
21290 * @param pulse @c EINA_TRUE to put @p obj in pulsing mode,
21291 * @c EINA_FALSE to put it back to its default one
21293 * By default, progress bars will display values from the low to
21294 * high value boundaries. There are, though, contexts in which the
21295 * state of progression of a given task is @b unknown. For those,
21296 * one can set a progress bar widget to a "pulsing state", to give
21297 * the user an idea that some computation is being held, but
21298 * without exact progress values. In the default theme it will
21299 * animate its bar with the contents filling in constantly and back
21300 * to non-filled, in a loop. To start and stop this pulsing
21301 * animation, one has to explicitly call elm_progressbar_pulse().
21303 * @see elm_progressbar_pulse_get()
21304 * @see elm_progressbar_pulse()
21306 * @ingroup Progressbar
21308 EAPI void elm_progressbar_pulse_set(Evas_Object *obj, Eina_Bool pulse) EINA_ARG_NONNULL(1);
21311 * Get whether a given progress bar widget is at "pulsing mode" or
21314 * @param obj The progress bar object
21315 * @return @c EINA_TRUE, if @p obj is in pulsing mode, @c EINA_FALSE
21316 * if it's in the default one (and on errors)
21318 * @ingroup Progressbar
21320 EAPI Eina_Bool elm_progressbar_pulse_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21323 * Start/stop a given progress bar "pulsing" animation, if its
21326 * @param obj The progress bar object
21327 * @param state @c EINA_TRUE, to @b start the pulsing animation,
21328 * @c EINA_FALSE to @b stop it
21330 * @note This call won't do anything if @p obj is not under "pulsing mode".
21332 * @see elm_progressbar_pulse_set() for more details.
21334 * @ingroup Progressbar
21336 EAPI void elm_progressbar_pulse(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
21339 * Set the progress value (in percentage) on a given progress bar
21342 * @param obj The progress bar object
21343 * @param val The progress value (@b must be between @c 0.0 and @c
21346 * Use this call to set progress bar levels.
21348 * @note If you passes a value out of the specified range for @p
21349 * val, it will be interpreted as the @b closest of the @b boundary
21350 * values in the range.
21352 * @ingroup Progressbar
21354 EAPI void elm_progressbar_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
21357 * Get the progress value (in percentage) on a given progress bar
21360 * @param obj The progress bar object
21361 * @return The value of the progressbar
21363 * @see elm_progressbar_value_set() for more details
21365 * @ingroup Progressbar
21367 EAPI double elm_progressbar_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21370 * Set the label of a given progress bar widget
21372 * @param obj The progress bar object
21373 * @param label The text label string, in UTF-8
21375 * @ingroup Progressbar
21376 * @deprecated use elm_object_text_set() instead.
21378 EINA_DEPRECATED EAPI void elm_progressbar_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
21381 * Get the label of a given progress bar widget
21383 * @param obj The progressbar object
21384 * @return The text label string, in UTF-8
21386 * @ingroup Progressbar
21387 * @deprecated use elm_object_text_set() instead.
21389 EINA_DEPRECATED EAPI const char *elm_progressbar_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21392 * Set the icon object of a given progress bar widget
21394 * @param obj The progress bar object
21395 * @param icon The icon object
21397 * Use this call to decorate @p obj with an icon next to it.
21399 * @note Once the icon object is set, a previously set one will be
21400 * deleted. If you want to keep that old content object, use the
21401 * elm_progressbar_icon_unset() function.
21403 * @see elm_progressbar_icon_get()
21404 * @deprecated use elm_object_part_content_set() instead.
21406 * @ingroup Progressbar
21408 EINA_DEPRECATED EAPI void elm_progressbar_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
21411 * Retrieve the icon object set for a given progress bar widget
21413 * @param obj The progress bar object
21414 * @return The icon object's handle, if @p obj had one set, or @c NULL,
21415 * otherwise (and on errors)
21417 * @see elm_progressbar_icon_set() for more details
21418 * @deprecated use elm_object_part_content_get() instead.
21420 * @ingroup Progressbar
21422 EINA_DEPRECATED EAPI Evas_Object *elm_progressbar_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21425 * Unset an icon set on a given progress bar widget
21427 * @param obj The progress bar object
21428 * @return The icon object that was being used, if any was set, or
21429 * @c NULL, otherwise (and on errors)
21431 * This call will unparent and return the icon object which was set
21432 * for this widget, previously, on success.
21434 * @see elm_progressbar_icon_set() for more details
21435 * @deprecated use elm_object_part_content_unset() instead.
21437 * @ingroup Progressbar
21439 EINA_DEPRECATED EAPI Evas_Object *elm_progressbar_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
21442 * Set the (exact) length of the bar region of a given progress bar
21445 * @param obj The progress bar object
21446 * @param size The length of the progress bar's bar region
21448 * This sets the minimum width (when in horizontal mode) or height
21449 * (when in vertical mode) of the actual bar area of the progress
21450 * bar @p obj. This in turn affects the object's minimum size. Use
21451 * this when you're not setting other size hints expanding on the
21452 * given direction (like weight and alignment hints) and you would
21453 * like it to have a specific size.
21455 * @note Icon, label and unit text around @p obj will require their
21456 * own space, which will make @p obj to require more the @p size,
21459 * @see elm_progressbar_span_size_get()
21461 * @ingroup Progressbar
21463 EAPI void elm_progressbar_span_size_set(Evas_Object *obj, Evas_Coord size) EINA_ARG_NONNULL(1);
21466 * Get the length set for the bar region of a given progress bar
21469 * @param obj The progress bar object
21470 * @return The length of the progress bar's bar region
21472 * If that size was not set previously, with
21473 * elm_progressbar_span_size_set(), this call will return @c 0.
21475 * @ingroup Progressbar
21477 EAPI Evas_Coord elm_progressbar_span_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21480 * Set the format string for a given progress bar widget's units
21483 * @param obj The progress bar object
21484 * @param format The format string for @p obj's units label
21486 * If @c NULL is passed on @p format, it will make @p obj's units
21487 * area to be hidden completely. If not, it'll set the <b>format
21488 * string</b> for the units label's @b text. The units label is
21489 * provided a floating point value, so the units text is up display
21490 * at most one floating point falue. Note that the units label is
21491 * optional. Use a format string such as "%1.2f meters" for
21494 * @note The default format string for a progress bar is an integer
21495 * percentage, as in @c "%.0f %%".
21497 * @see elm_progressbar_unit_format_get()
21499 * @ingroup Progressbar
21501 EAPI void elm_progressbar_unit_format_set(Evas_Object *obj, const char *format) EINA_ARG_NONNULL(1);
21504 * Retrieve the format string set for a given progress bar widget's
21507 * @param obj The progress bar object
21508 * @return The format set string for @p obj's units label or
21509 * @c NULL, if none was set (and on errors)
21511 * @see elm_progressbar_unit_format_set() for more details
21513 * @ingroup Progressbar
21515 EAPI const char *elm_progressbar_unit_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21518 * Set the orientation of a given progress bar widget
21520 * @param obj The progress bar object
21521 * @param horizontal Use @c EINA_TRUE to make @p obj to be
21522 * @b horizontal, @c EINA_FALSE to make it @b vertical
21524 * Use this function to change how your progress bar is to be
21525 * disposed: vertically or horizontally.
21527 * @see elm_progressbar_horizontal_get()
21529 * @ingroup Progressbar
21531 EAPI void elm_progressbar_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
21534 * Retrieve the orientation of a given progress bar widget
21536 * @param obj The progress bar object
21537 * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
21538 * @c EINA_FALSE if it's @b vertical (and on errors)
21540 * @see elm_progressbar_horizontal_set() for more details
21542 * @ingroup Progressbar
21544 EAPI Eina_Bool elm_progressbar_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21547 * Invert a given progress bar widget's displaying values order
21549 * @param obj The progress bar object
21550 * @param inverted Use @c EINA_TRUE to make @p obj inverted,
21551 * @c EINA_FALSE to bring it back to default, non-inverted values.
21553 * A progress bar may be @b inverted, in which state it gets its
21554 * values inverted, with high values being on the left or top and
21555 * low values on the right or bottom, as opposed to normally have
21556 * the low values on the former and high values on the latter,
21557 * respectively, for horizontal and vertical modes.
21559 * @see elm_progressbar_inverted_get()
21561 * @ingroup Progressbar
21563 EAPI void elm_progressbar_inverted_set(Evas_Object *obj, Eina_Bool inverted) EINA_ARG_NONNULL(1);
21566 * Get whether a given progress bar widget's displaying values are
21569 * @param obj The progress bar object
21570 * @return @c EINA_TRUE, if @p obj has inverted values,
21571 * @c EINA_FALSE otherwise (and on errors)
21573 * @see elm_progressbar_inverted_set() for more details
21575 * @ingroup Progressbar
21577 EAPI Eina_Bool elm_progressbar_inverted_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21580 * @defgroup Separator Separator
21582 * @brief Separator is a very thin object used to separate other objects.
21584 * A separator can be vertical or horizontal.
21586 * @ref tutorial_separator is a good example of how to use a separator.
21590 * @brief Add a separator object to @p parent
21592 * @param parent The parent object
21594 * @return The separator object, or NULL upon failure
21596 EAPI Evas_Object *elm_separator_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21598 * @brief Set the horizontal mode of a separator object
21600 * @param obj The separator object
21601 * @param horizontal If true, the separator is horizontal
21603 EAPI void elm_separator_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
21605 * @brief Get the horizontal mode of a separator object
21607 * @param obj The separator object
21608 * @return If true, the separator is horizontal
21610 * @see elm_separator_horizontal_set()
21612 EAPI Eina_Bool elm_separator_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21618 * @defgroup Spinner Spinner
21619 * @ingroup Elementary
21621 * @image html img/widget/spinner/preview-00.png
21622 * @image latex img/widget/spinner/preview-00.eps
21624 * A spinner is a widget which allows the user to increase or decrease
21625 * numeric values using arrow buttons, or edit values directly, clicking
21626 * over it and typing the new value.
21628 * By default the spinner will not wrap and has a label
21629 * of "%.0f" (just showing the integer value of the double).
21631 * A spinner has a label that is formatted with floating
21632 * point values and thus accepts a printf-style format string, like
21633 * ā%1.2f unitsā.
21635 * It also allows specific values to be replaced by pre-defined labels.
21637 * Smart callbacks one can register to:
21639 * - "changed" - Whenever the spinner value is changed.
21640 * - "delay,changed" - A short time after the value is changed by the user.
21641 * This will be called only when the user stops dragging for a very short
21642 * period or when they release their finger/mouse, so it avoids possibly
21643 * expensive reactions to the value change.
21645 * Available styles for it:
21647 * - @c "vertical": up/down buttons at the right side and text left aligned.
21649 * Here is an example on its usage:
21650 * @ref spinner_example
21654 * @addtogroup Spinner
21659 * Add a new spinner widget to the given parent Elementary
21660 * (container) object.
21662 * @param parent The parent object.
21663 * @return a new spinner widget handle or @c NULL, on errors.
21665 * This function inserts a new spinner widget on the canvas.
21670 EAPI Evas_Object *elm_spinner_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21673 * Set the format string of the displayed label.
21675 * @param obj The spinner object.
21676 * @param fmt The format string for the label display.
21678 * If @c NULL, this sets the format to "%.0f". If not it sets the format
21679 * string for the label text. The label text is provided a floating point
21680 * value, so the label text can display up to 1 floating point value.
21681 * Note that this is optional.
21683 * Use a format string such as "%1.2f meters" for example, and it will
21684 * display values like: "3.14 meters" for a value equal to 3.14159.
21686 * Default is "%0.f".
21688 * @see elm_spinner_label_format_get()
21692 EAPI void elm_spinner_label_format_set(Evas_Object *obj, const char *fmt) EINA_ARG_NONNULL(1);
21695 * Get the label format of the spinner.
21697 * @param obj The spinner object.
21698 * @return The text label format string in UTF-8.
21700 * @see elm_spinner_label_format_set() for details.
21704 EAPI const char *elm_spinner_label_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21707 * Set the minimum and maximum values for the spinner.
21709 * @param obj The spinner object.
21710 * @param min The minimum value.
21711 * @param max The maximum value.
21713 * Define the allowed range of values to be selected by the user.
21715 * If actual value is less than @p min, it will be updated to @p min. If it
21716 * is bigger then @p max, will be updated to @p max. Actual value can be
21717 * get with elm_spinner_value_get().
21719 * By default, min is equal to 0, and max is equal to 100.
21721 * @warning Maximum must be greater than minimum.
21723 * @see elm_spinner_min_max_get()
21727 EAPI void elm_spinner_min_max_set(Evas_Object *obj, double min, double max) EINA_ARG_NONNULL(1);
21730 * Get the minimum and maximum values of the spinner.
21732 * @param obj The spinner object.
21733 * @param min Pointer where to store the minimum value.
21734 * @param max Pointer where to store the maximum value.
21736 * @note If only one value is needed, the other pointer can be passed
21739 * @see elm_spinner_min_max_set() for details.
21743 EAPI void elm_spinner_min_max_get(const Evas_Object *obj, double *min, double *max) EINA_ARG_NONNULL(1);
21746 * Set the step used to increment or decrement the spinner value.
21748 * @param obj The spinner object.
21749 * @param step The step value.
21751 * This value will be incremented or decremented to the displayed value.
21752 * It will be incremented while the user keep right or top arrow pressed,
21753 * and will be decremented while the user keep left or bottom arrow pressed.
21755 * The interval to increment / decrement can be set with
21756 * elm_spinner_interval_set().
21758 * By default step value is equal to 1.
21760 * @see elm_spinner_step_get()
21764 EAPI void elm_spinner_step_set(Evas_Object *obj, double step) EINA_ARG_NONNULL(1);
21767 * Get the step used to increment or decrement the spinner value.
21769 * @param obj The spinner object.
21770 * @return The step value.
21772 * @see elm_spinner_step_get() for more details.
21776 EAPI double elm_spinner_step_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21779 * Set the value the spinner displays.
21781 * @param obj The spinner object.
21782 * @param val The value to be displayed.
21784 * Value will be presented on the label following format specified with
21785 * elm_spinner_format_set().
21787 * @warning The value must to be between min and max values. This values
21788 * are set by elm_spinner_min_max_set().
21790 * @see elm_spinner_value_get().
21791 * @see elm_spinner_format_set().
21792 * @see elm_spinner_min_max_set().
21796 EAPI void elm_spinner_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
21799 * Get the value displayed by the spinner.
21801 * @param obj The spinner object.
21802 * @return The value displayed.
21804 * @see elm_spinner_value_set() for details.
21808 EAPI double elm_spinner_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21811 * Set whether the spinner should wrap when it reaches its
21812 * minimum or maximum value.
21814 * @param obj The spinner object.
21815 * @param wrap @c EINA_TRUE to enable wrap or @c EINA_FALSE to
21818 * Disabled by default. If disabled, when the user tries to increment the
21820 * but displayed value plus step value is bigger than maximum value,
21822 * won't allow it. The same happens when the user tries to decrement it,
21823 * but the value less step is less than minimum value.
21825 * When wrap is enabled, in such situations it will allow these changes,
21826 * but will get the value that would be less than minimum and subtracts
21827 * from maximum. Or add the value that would be more than maximum to
21831 * @li min value = 10
21832 * @li max value = 50
21833 * @li step value = 20
21834 * @li displayed value = 20
21836 * When the user decrement value (using left or bottom arrow), it will
21837 * displays @c 40, because max - (min - (displayed - step)) is
21838 * @c 50 - (@c 10 - (@c 20 - @c 20)) = @c 40.
21840 * @see elm_spinner_wrap_get().
21844 EAPI void elm_spinner_wrap_set(Evas_Object *obj, Eina_Bool wrap) EINA_ARG_NONNULL(1);
21847 * Get whether the spinner should wrap when it reaches its
21848 * minimum or maximum value.
21850 * @param obj The spinner object
21851 * @return @c EINA_TRUE means wrap is enabled. @c EINA_FALSE indicates
21852 * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
21854 * @see elm_spinner_wrap_set() for details.
21858 EAPI Eina_Bool elm_spinner_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21861 * Set whether the spinner can be directly edited by the user or not.
21863 * @param obj The spinner object.
21864 * @param editable @c EINA_TRUE to allow users to edit it or @c EINA_FALSE to
21865 * don't allow users to edit it directly.
21867 * Spinner objects can have edition @b disabled, in which state they will
21868 * be changed only by arrows.
21869 * Useful for contexts
21870 * where you don't want your users to interact with it writting the value.
21872 * when using special values, the user can see real value instead
21873 * of special label on edition.
21875 * It's enabled by default.
21877 * @see elm_spinner_editable_get()
21881 EAPI void elm_spinner_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
21884 * Get whether the spinner can be directly edited by the user or not.
21886 * @param obj The spinner object.
21887 * @return @c EINA_TRUE means edition is enabled. @c EINA_FALSE indicates
21888 * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
21890 * @see elm_spinner_editable_set() for details.
21894 EAPI Eina_Bool elm_spinner_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21897 * Set a special string to display in the place of the numerical value.
21899 * @param obj The spinner object.
21900 * @param value The value to be replaced.
21901 * @param label The label to be used.
21903 * It's useful for cases when a user should select an item that is
21904 * better indicated by a label than a value. For example, weekdays or months.
21908 * sp = elm_spinner_add(win);
21909 * elm_spinner_min_max_set(sp, 1, 3);
21910 * elm_spinner_special_value_add(sp, 1, "January");
21911 * elm_spinner_special_value_add(sp, 2, "February");
21912 * elm_spinner_special_value_add(sp, 3, "March");
21913 * evas_object_show(sp);
21918 EAPI void elm_spinner_special_value_add(Evas_Object *obj, double value, const char *label) EINA_ARG_NONNULL(1);
21921 * Set the interval on time updates for an user mouse button hold
21922 * on spinner widgets' arrows.
21924 * @param obj The spinner object.
21925 * @param interval The (first) interval value in seconds.
21927 * This interval value is @b decreased while the user holds the
21928 * mouse pointer either incrementing or decrementing spinner's value.
21930 * This helps the user to get to a given value distant from the
21931 * current one easier/faster, as it will start to change quicker and
21932 * quicker on mouse button holds.
21934 * The calculation for the next change interval value, starting from
21935 * the one set with this call, is the previous interval divided by
21936 * @c 1.05, so it decreases a little bit.
21938 * The default starting interval value for automatic changes is
21941 * @see elm_spinner_interval_get()
21945 EAPI void elm_spinner_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
21948 * Get the interval on time updates for an user mouse button hold
21949 * on spinner widgets' arrows.
21951 * @param obj The spinner object.
21952 * @return The (first) interval value, in seconds, set on it.
21954 * @see elm_spinner_interval_set() for more details.
21958 EAPI double elm_spinner_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21965 * @defgroup Index Index
21967 * @image html img/widget/index/preview-00.png
21968 * @image latex img/widget/index/preview-00.eps
21970 * An index widget gives you an index for fast access to whichever
21971 * group of other UI items one might have. It's a list of text
21972 * items (usually letters, for alphabetically ordered access).
21974 * Index widgets are by default hidden and just appear when the
21975 * user clicks over it's reserved area in the canvas. In its
21976 * default theme, it's an area one @ref Fingers "finger" wide on
21977 * the right side of the index widget's container.
21979 * When items on the index are selected, smart callbacks get
21980 * called, so that its user can make other container objects to
21981 * show a given area or child object depending on the index item
21982 * selected. You'd probably be using an index together with @ref
21983 * List "lists", @ref Genlist "generic lists" or @ref Gengrid
21986 * Smart events one can add callbacks for are:
21987 * - @c "changed" - When the selected index item changes. @c
21988 * event_info is the selected item's data pointer.
21989 * - @c "delay,changed" - When the selected index item changes, but
21990 * after a small idling period. @c event_info is the selected
21991 * item's data pointer.
21992 * - @c "selected" - When the user releases a mouse button and
21993 * selects an item. @c event_info is the selected item's data
21995 * - @c "level,up" - when the user moves a finger from the first
21996 * level to the second level
21997 * - @c "level,down" - when the user moves a finger from the second
21998 * level to the first level
22000 * The @c "delay,changed" event is so that it'll wait a small time
22001 * before actually reporting those events and, moreover, just the
22002 * last event happening on those time frames will actually be
22005 * Here are some examples on its usage:
22006 * @li @ref index_example_01
22007 * @li @ref index_example_02
22011 * @addtogroup Index
22015 typedef struct _Elm_Index_Item Elm_Index_Item; /**< Opaque handle for items of Elementary index widgets */
22018 * Add a new index widget to the given parent Elementary
22019 * (container) object
22021 * @param parent The parent object
22022 * @return a new index widget handle or @c NULL, on errors
22024 * This function inserts a new index widget on the canvas.
22028 EAPI Evas_Object *elm_index_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22031 * Set whether a given index widget is or not visible,
22034 * @param obj The index object
22035 * @param active @c EINA_TRUE to show it, @c EINA_FALSE to hide it
22037 * Not to be confused with visible as in @c evas_object_show() --
22038 * visible with regard to the widget's auto hiding feature.
22040 * @see elm_index_active_get()
22044 EAPI void elm_index_active_set(Evas_Object *obj, Eina_Bool active) EINA_ARG_NONNULL(1);
22047 * Get whether a given index widget is currently visible or not.
22049 * @param obj The index object
22050 * @return @c EINA_TRUE, if it's shown, @c EINA_FALSE otherwise
22052 * @see elm_index_active_set() for more details
22056 EAPI Eina_Bool elm_index_active_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22059 * Set the items level for a given index widget.
22061 * @param obj The index object.
22062 * @param level @c 0 or @c 1, the currently implemented levels.
22064 * @see elm_index_item_level_get()
22068 EAPI void elm_index_item_level_set(Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
22071 * Get the items level set for a given index widget.
22073 * @param obj The index object.
22074 * @return @c 0 or @c 1, which are the levels @p obj might be at.
22076 * @see elm_index_item_level_set() for more information
22080 EAPI int elm_index_item_level_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22083 * Returns the last selected item's data, for a given index widget.
22085 * @param obj The index object.
22086 * @return The item @b data associated to the last selected item on
22087 * @p obj (or @c NULL, on errors).
22089 * @warning The returned value is @b not an #Elm_Index_Item item
22090 * handle, but the data associated to it (see the @c item parameter
22091 * in elm_index_item_append(), as an example).
22095 EAPI void *elm_index_item_selected_get(const Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
22098 * Append a new item on a given index widget.
22100 * @param obj The index object.
22101 * @param letter Letter under which the item should be indexed
22102 * @param item The item data to set for the index's item
22104 * Despite the most common usage of the @p letter argument is for
22105 * single char strings, one could use arbitrary strings as index
22108 * @c item will be the pointer returned back on @c "changed", @c
22109 * "delay,changed" and @c "selected" smart events.
22113 EAPI void elm_index_item_append(Evas_Object *obj, const char *letter, const void *item) EINA_ARG_NONNULL(1);
22116 * Prepend a new item on a given index widget.
22118 * @param obj The index object.
22119 * @param letter Letter under which the item should be indexed
22120 * @param item The item data to set for the index's item
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.
22131 EAPI void elm_index_item_prepend(Evas_Object *obj, const char *letter, const void *item) EINA_ARG_NONNULL(1);
22134 * Append a new item, on a given index widget, <b>after the item
22135 * having @p relative as data</b>.
22137 * @param obj The index object.
22138 * @param letter Letter under which the item should be indexed
22139 * @param item The item data to set for the index's item
22140 * @param relative The item data of the index item to be the
22141 * predecessor of this new one
22143 * Despite the most common usage of the @p letter argument is for
22144 * single char strings, one could use arbitrary strings as index
22147 * @c item will be the pointer returned back on @c "changed", @c
22148 * "delay,changed" and @c "selected" smart events.
22150 * @note If @p relative is @c NULL or if it's not found to be data
22151 * set on any previous item on @p obj, this function will behave as
22152 * elm_index_item_append().
22156 EAPI void elm_index_item_append_relative(Evas_Object *obj, const char *letter, const void *item, const void *relative) EINA_ARG_NONNULL(1);
22159 * Prepend a new item, on a given index widget, <b>after the item
22160 * having @p relative as data</b>.
22162 * @param obj The index object.
22163 * @param letter Letter under which the item should be indexed
22164 * @param item The item data to set for the index's item
22165 * @param relative The item data of the index item to be the
22166 * successor of this new one
22168 * Despite the most common usage of the @p letter argument is for
22169 * single char strings, one could use arbitrary strings as index
22172 * @c item will be the pointer returned back on @c "changed", @c
22173 * "delay,changed" and @c "selected" smart events.
22175 * @note If @p relative is @c NULL or if it's not found to be data
22176 * set on any previous item on @p obj, this function will behave as
22177 * elm_index_item_prepend().
22181 EAPI void elm_index_item_prepend_relative(Evas_Object *obj, const char *letter, const void *item, const void *relative) EINA_ARG_NONNULL(1);
22184 * Insert a new item into the given index widget, using @p cmp_func
22185 * function to sort items (by item handles).
22187 * @param obj The index object.
22188 * @param letter Letter under which the item should be indexed
22189 * @param item The item data to set for the index's item
22190 * @param cmp_func The comparing function to be used to sort index
22191 * items <b>by #Elm_Index_Item item handles</b>
22192 * @param cmp_data_func A @b fallback function to be called for the
22193 * sorting of index items <b>by item data</b>). It will be used
22194 * when @p cmp_func returns @c 0 (equality), which means an index
22195 * item with provided item data already exists. To decide which
22196 * data item should be pointed to by the index item in question, @p
22197 * cmp_data_func will be used. If @p cmp_data_func returns a
22198 * non-negative value, the previous index item data will be
22199 * replaced by the given @p item pointer. If the previous data need
22200 * to be freed, it should be done by the @p cmp_data_func function,
22201 * because all references to it will be lost. If this function is
22202 * not provided (@c NULL is given), index items will be @b
22203 * duplicated, if @p cmp_func returns @c 0.
22205 * Despite the most common usage of the @p letter argument is for
22206 * single char strings, one could use arbitrary strings as index
22209 * @c item will be the pointer returned back on @c "changed", @c
22210 * "delay,changed" and @c "selected" smart events.
22214 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);
22217 * Remove an item from a given index widget, <b>to be referenced by
22218 * it's data value</b>.
22220 * @param obj The index object
22221 * @param item The item's data pointer for the item to be removed
22224 * If a deletion callback is set, via elm_index_item_del_cb_set(),
22225 * that callback function will be called by this one.
22227 * @warning The item to be removed from @p obj will be found via
22228 * its item data pointer, and not by an #Elm_Index_Item handle.
22232 EAPI void elm_index_item_del(Evas_Object *obj, const void *item) EINA_ARG_NONNULL(1);
22235 * Find a given index widget's item, <b>using item data</b>.
22237 * @param obj The index object
22238 * @param item The item data pointed to by the desired index item
22239 * @return The index item handle, if found, or @c NULL otherwise
22243 EAPI Elm_Index_Item *elm_index_item_find(Evas_Object *obj, const void *item) EINA_ARG_NONNULL(1);
22246 * Removes @b all items from a given index widget.
22248 * @param obj The index object.
22250 * If deletion callbacks are set, via elm_index_item_del_cb_set(),
22251 * that callback function will be called for each item in @p obj.
22255 EAPI void elm_index_item_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
22258 * Go to a given items level on a index widget
22260 * @param obj The index object
22261 * @param level The index level (one of @c 0 or @c 1)
22265 EAPI void elm_index_item_go(Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
22268 * Return the data associated with a given index widget item
22270 * @param it The index widget item handle
22271 * @return The data associated with @p it
22273 * @see elm_index_item_data_set()
22277 EAPI void *elm_index_item_data_get(const Elm_Index_Item *item) EINA_ARG_NONNULL(1);
22280 * Set the data associated with a given index widget item
22282 * @param it The index widget item handle
22283 * @param data The new data pointer to set to @p it
22285 * This sets new item data on @p it.
22287 * @warning The old data pointer won't be touched by this function, so
22288 * the user had better to free that old data himself/herself.
22292 EAPI void elm_index_item_data_set(Elm_Index_Item *it, const void *data) EINA_ARG_NONNULL(1);
22295 * Set the function to be called when a given index widget item is freed.
22297 * @param it The item to set the callback on
22298 * @param func The function to call on the item's deletion
22300 * When called, @p func will have both @c data and @c event_info
22301 * arguments with the @p it item's data value and, naturally, the
22302 * @c obj argument with a handle to the parent index widget.
22306 EAPI void elm_index_item_del_cb_set(Elm_Index_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
22309 * Get the letter (string) set on a given index widget item.
22311 * @param it The index item handle
22312 * @return The letter string set on @p it
22316 EAPI const char *elm_index_item_letter_get(const Elm_Index_Item *item) EINA_ARG_NONNULL(1);
22323 * @defgroup Photocam Photocam
22325 * @image html img/widget/photocam/preview-00.png
22326 * @image latex img/widget/photocam/preview-00.eps
22328 * This is a widget specifically for displaying high-resolution digital
22329 * camera photos giving speedy feedback (fast load), low memory footprint
22330 * and zooming and panning as well as fitting logic. It is entirely focused
22331 * on jpeg images, and takes advantage of properties of the jpeg format (via
22332 * evas loader features in the jpeg loader).
22334 * Signals that you can add callbacks for are:
22335 * @li "clicked" - This is called when a user has clicked the photo without
22337 * @li "press" - This is called when a user has pressed down on the photo.
22338 * @li "longpressed" - This is called when a user has pressed down on the
22339 * photo for a long time without dragging around.
22340 * @li "clicked,double" - This is called when a user has double-clicked the
22342 * @li "load" - Photo load begins.
22343 * @li "loaded" - This is called when the image file load is complete for the
22344 * first view (low resolution blurry version).
22345 * @li "load,detail" - Photo detailed data load begins.
22346 * @li "loaded,detail" - This is called when the image file load is complete
22347 * for the detailed image data (full resolution needed).
22348 * @li "zoom,start" - Zoom animation started.
22349 * @li "zoom,stop" - Zoom animation stopped.
22350 * @li "zoom,change" - Zoom changed when using an auto zoom mode.
22351 * @li "scroll" - the content has been scrolled (moved)
22352 * @li "scroll,anim,start" - scrolling animation has started
22353 * @li "scroll,anim,stop" - scrolling animation has stopped
22354 * @li "scroll,drag,start" - dragging the contents around has started
22355 * @li "scroll,drag,stop" - dragging the contents around has stopped
22357 * @ref tutorial_photocam shows the API in action.
22361 * @brief Types of zoom available.
22363 typedef enum _Elm_Photocam_Zoom_Mode
22365 ELM_PHOTOCAM_ZOOM_MODE_MANUAL = 0, /**< Zoom controlled normally by elm_photocam_zoom_set */
22366 ELM_PHOTOCAM_ZOOM_MODE_AUTO_FIT, /**< Zoom until photo fits in photocam */
22367 ELM_PHOTOCAM_ZOOM_MODE_AUTO_FILL, /**< Zoom until photo fills photocam */
22368 ELM_PHOTOCAM_ZOOM_MODE_LAST
22369 } Elm_Photocam_Zoom_Mode;
22371 * @brief Add a new Photocam object
22373 * @param parent The parent object
22374 * @return The new object or NULL if it cannot be created
22376 EAPI Evas_Object *elm_photocam_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22378 * @brief Set the photo file to be shown
22380 * @param obj The photocam object
22381 * @param file The photo file
22382 * @return The return error (see EVAS_LOAD_ERROR_NONE, EVAS_LOAD_ERROR_GENERIC etc.)
22384 * This sets (and shows) the specified file (with a relative or absolute
22385 * path) and will return a load error (same error that
22386 * evas_object_image_load_error_get() will return). The image will change and
22387 * adjust its size at this point and begin a background load process for this
22388 * photo that at some time in the future will be displayed at the full
22391 EAPI Evas_Load_Error elm_photocam_file_set(Evas_Object *obj, const char *file) EINA_ARG_NONNULL(1);
22393 * @brief Returns the path of the current image file
22395 * @param obj The photocam object
22396 * @return Returns the path
22398 * @see elm_photocam_file_set()
22400 EAPI const char *elm_photocam_file_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22402 * @brief Set the zoom level of the photo
22404 * @param obj The photocam object
22405 * @param zoom The zoom level to set
22407 * This sets the zoom level. 1 will be 1:1 pixel for pixel. 2 will be 2:1
22408 * (that is 2x2 photo pixels will display as 1 on-screen pixel). 4:1 will be
22409 * 4x4 photo pixels as 1 screen pixel, and so on. The @p zoom parameter must
22410 * be greater than 0. It is usggested to stick to powers of 2. (1, 2, 4, 8,
22413 EAPI void elm_photocam_zoom_set(Evas_Object *obj, double zoom) EINA_ARG_NONNULL(1);
22415 * @brief Get the zoom level of the photo
22417 * @param obj The photocam object
22418 * @return The current zoom level
22420 * This returns the current zoom level of the photocam object. Note that if
22421 * you set the fill mode to other than ELM_PHOTOCAM_ZOOM_MODE_MANUAL
22422 * (which is the default), the zoom level may be changed at any time by the
22423 * photocam object itself to account for photo size and photocam viewpoer
22426 * @see elm_photocam_zoom_set()
22427 * @see elm_photocam_zoom_mode_set()
22429 EAPI double elm_photocam_zoom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22431 * @brief Set the zoom mode
22433 * @param obj The photocam object
22434 * @param mode The desired mode
22436 * This sets the zoom mode to manual or one of several automatic levels.
22437 * Manual (ELM_PHOTOCAM_ZOOM_MODE_MANUAL) means that zoom is set manually by
22438 * elm_photocam_zoom_set() and will stay at that level until changed by code
22439 * or until zoom mode is changed. This is the default mode. The Automatic
22440 * modes will allow the photocam object to automatically adjust zoom mode
22441 * based on properties. ELM_PHOTOCAM_ZOOM_MODE_AUTO_FIT) will adjust zoom so
22442 * the photo fits EXACTLY inside the scroll frame with no pixels outside this
22443 * area. ELM_PHOTOCAM_ZOOM_MODE_AUTO_FILL will be similar but ensure no
22444 * pixels within the frame are left unfilled.
22446 EAPI void elm_photocam_zoom_mode_set(Evas_Object *obj, Elm_Photocam_Zoom_Mode mode) EINA_ARG_NONNULL(1);
22448 * @brief Get the zoom mode
22450 * @param obj The photocam object
22451 * @return The current zoom mode
22453 * This gets the current zoom mode of the photocam object.
22455 * @see elm_photocam_zoom_mode_set()
22457 EAPI Elm_Photocam_Zoom_Mode elm_photocam_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22459 * @brief Get the current image pixel width and height
22461 * @param obj The photocam object
22462 * @param w A pointer to the width return
22463 * @param h A pointer to the height return
22465 * This gets the current photo pixel width and height (for the original).
22466 * The size will be returned in the integers @p w and @p h that are pointed
22469 EAPI void elm_photocam_image_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
22471 * @brief Get the area of the image that is currently shown
22474 * @param x A pointer to the X-coordinate of region
22475 * @param y A pointer to the Y-coordinate of region
22476 * @param w A pointer to the width
22477 * @param h A pointer to the height
22479 * @see elm_photocam_image_region_show()
22480 * @see elm_photocam_image_region_bring_in()
22482 EAPI void elm_photocam_region_get(const Evas_Object *obj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
22484 * @brief Set the viewed portion of the image
22486 * @param obj The photocam object
22487 * @param x X-coordinate of region in image original pixels
22488 * @param y Y-coordinate of region in image original pixels
22489 * @param w Width of region in image original pixels
22490 * @param h Height of region in image original pixels
22492 * This shows the region of the image without using animation.
22494 EAPI void elm_photocam_image_region_show(Evas_Object *obj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
22496 * @brief Bring in the viewed portion of the image
22498 * @param obj The photocam object
22499 * @param x X-coordinate of region in image original pixels
22500 * @param y Y-coordinate of region in image original pixels
22501 * @param w Width of region in image original pixels
22502 * @param h Height of region in image original pixels
22504 * This shows the region of the image using animation.
22506 EAPI void elm_photocam_image_region_bring_in(Evas_Object *obj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
22508 * @brief Set the paused state for photocam
22510 * @param obj The photocam object
22511 * @param paused The pause state to set
22513 * This sets the paused state to on(EINA_TRUE) or off (EINA_FALSE) for
22514 * photocam. The default is off. This will stop zooming using animation on
22515 * zoom levels changes and change instantly. This will stop any existing
22516 * animations that are running.
22518 EAPI void elm_photocam_paused_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
22520 * @brief Get the paused state for photocam
22522 * @param obj The photocam object
22523 * @return The current paused state
22525 * This gets the current paused state for the photocam object.
22527 * @see elm_photocam_paused_set()
22529 EAPI Eina_Bool elm_photocam_paused_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22531 * @brief Get the internal low-res image used for photocam
22533 * @param obj The photocam object
22534 * @return The internal image object handle, or NULL if none exists
22536 * This gets the internal image object inside photocam. Do not modify it. It
22537 * is for inspection only, and hooking callbacks to. Nothing else. It may be
22538 * deleted at any time as well.
22540 EAPI Evas_Object *elm_photocam_internal_image_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22542 * @brief Set the photocam scrolling bouncing.
22544 * @param obj The photocam object
22545 * @param h_bounce bouncing for horizontal
22546 * @param v_bounce bouncing for vertical
22548 EAPI void elm_photocam_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
22550 * @brief Get the photocam scrolling bouncing.
22552 * @param obj The photocam object
22553 * @param h_bounce bouncing for horizontal
22554 * @param v_bounce bouncing for vertical
22556 * @see elm_photocam_bounce_set()
22558 EAPI void elm_photocam_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
22564 * @defgroup Map Map
22565 * @ingroup Elementary
22567 * @image html img/widget/map/preview-00.png
22568 * @image latex img/widget/map/preview-00.eps
22570 * This is a widget specifically for displaying a map. It uses basically
22571 * OpenStreetMap provider http://www.openstreetmap.org/,
22572 * but custom providers can be added.
22574 * It supports some basic but yet nice features:
22575 * @li zoom and scroll
22576 * @li markers with content to be displayed when user clicks over it
22577 * @li group of markers
22580 * Smart callbacks one can listen to:
22582 * - "clicked" - This is called when a user has clicked the map without
22584 * - "press" - This is called when a user has pressed down on the map.
22585 * - "longpressed" - This is called when a user has pressed down on the map
22586 * for a long time without dragging around.
22587 * - "clicked,double" - This is called when a user has double-clicked
22589 * - "load,detail" - Map detailed data load begins.
22590 * - "loaded,detail" - This is called when all currently visible parts of
22591 * the map are loaded.
22592 * - "zoom,start" - Zoom animation started.
22593 * - "zoom,stop" - Zoom animation stopped.
22594 * - "zoom,change" - Zoom changed when using an auto zoom mode.
22595 * - "scroll" - the content has been scrolled (moved).
22596 * - "scroll,anim,start" - scrolling animation has started.
22597 * - "scroll,anim,stop" - scrolling animation has stopped.
22598 * - "scroll,drag,start" - dragging the contents around has started.
22599 * - "scroll,drag,stop" - dragging the contents around has stopped.
22600 * - "downloaded" - This is called when all currently required map images
22602 * - "route,load" - This is called when route request begins.
22603 * - "route,loaded" - This is called when route request ends.
22604 * - "name,load" - This is called when name request begins.
22605 * - "name,loaded- This is called when name request ends.
22607 * Available style for map widget:
22610 * Available style for markers:
22615 * Available style for marker bubble:
22618 * List of examples:
22619 * @li @ref map_example_01
22620 * @li @ref map_example_02
22621 * @li @ref map_example_03
22630 * @enum _Elm_Map_Zoom_Mode
22631 * @typedef Elm_Map_Zoom_Mode
22633 * Set map's zoom behavior. It can be set to manual or automatic.
22635 * Default value is #ELM_MAP_ZOOM_MODE_MANUAL.
22637 * Values <b> don't </b> work as bitmask, only one can be choosen.
22639 * @note Valid sizes are 2^zoom, consequently the map may be smaller
22640 * than the scroller view.
22642 * @see elm_map_zoom_mode_set()
22643 * @see elm_map_zoom_mode_get()
22647 typedef enum _Elm_Map_Zoom_Mode
22649 ELM_MAP_ZOOM_MODE_MANUAL, /**< Zoom controlled manually by elm_map_zoom_set(). It's set by default. */
22650 ELM_MAP_ZOOM_MODE_AUTO_FIT, /**< Zoom until map fits inside the scroll frame with no pixels outside this area. */
22651 ELM_MAP_ZOOM_MODE_AUTO_FILL, /**< Zoom until map fills scroll, ensuring no pixels are left unfilled. */
22652 ELM_MAP_ZOOM_MODE_LAST
22653 } Elm_Map_Zoom_Mode;
22656 * @enum _Elm_Map_Route_Sources
22657 * @typedef Elm_Map_Route_Sources
22659 * Set route service to be used. By default used source is
22660 * #ELM_MAP_ROUTE_SOURCE_YOURS.
22662 * @see elm_map_route_source_set()
22663 * @see elm_map_route_source_get()
22667 typedef enum _Elm_Map_Route_Sources
22669 ELM_MAP_ROUTE_SOURCE_YOURS, /**< Routing service http://www.yournavigation.org/ . Set by default.*/
22670 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. */
22671 ELM_MAP_ROUTE_SOURCE_ORS, /**< Open Route Service: http://www.openrouteservice.org/ . It's not working with Map yet. */
22672 ELM_MAP_ROUTE_SOURCE_LAST
22673 } Elm_Map_Route_Sources;
22675 typedef enum _Elm_Map_Name_Sources
22677 ELM_MAP_NAME_SOURCE_NOMINATIM,
22678 ELM_MAP_NAME_SOURCE_LAST
22679 } Elm_Map_Name_Sources;
22682 * @enum _Elm_Map_Route_Type
22683 * @typedef Elm_Map_Route_Type
22685 * Set type of transport used on route.
22687 * @see elm_map_route_add()
22691 typedef enum _Elm_Map_Route_Type
22693 ELM_MAP_ROUTE_TYPE_MOTOCAR, /**< Route should consider an automobile will be used. */
22694 ELM_MAP_ROUTE_TYPE_BICYCLE, /**< Route should consider a bicycle will be used by the user. */
22695 ELM_MAP_ROUTE_TYPE_FOOT, /**< Route should consider user will be walking. */
22696 ELM_MAP_ROUTE_TYPE_LAST
22697 } Elm_Map_Route_Type;
22700 * @enum _Elm_Map_Route_Method
22701 * @typedef Elm_Map_Route_Method
22703 * Set the routing method, what should be priorized, time or distance.
22705 * @see elm_map_route_add()
22709 typedef enum _Elm_Map_Route_Method
22711 ELM_MAP_ROUTE_METHOD_FASTEST, /**< Route should priorize time. */
22712 ELM_MAP_ROUTE_METHOD_SHORTEST, /**< Route should priorize distance. */
22713 ELM_MAP_ROUTE_METHOD_LAST
22714 } Elm_Map_Route_Method;
22716 typedef enum _Elm_Map_Name_Method
22718 ELM_MAP_NAME_METHOD_SEARCH,
22719 ELM_MAP_NAME_METHOD_REVERSE,
22720 ELM_MAP_NAME_METHOD_LAST
22721 } Elm_Map_Name_Method;
22723 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(). */
22724 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(). */
22725 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(). */
22726 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(). */
22727 typedef struct _Elm_Map_Name Elm_Map_Name; /**< A handle for specific coordinates. */
22728 typedef struct _Elm_Map_Track Elm_Map_Track;
22730 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. */
22731 typedef void (*ElmMapMarkerDelFunc) (Evas_Object *obj, Elm_Map_Marker *marker, void *data, Evas_Object *o); /**< Function to delete bubble content for marker classes. */
22732 typedef Evas_Object *(*ElmMapMarkerIconGetFunc) (Evas_Object *obj, Elm_Map_Marker *marker, void *data); /**< Icon fetching class function for marker classes. */
22733 typedef Evas_Object *(*ElmMapGroupIconGetFunc) (Evas_Object *obj, void *data); /**< Icon fetching class function for markers group classes. */
22735 typedef char *(*ElmMapModuleSourceFunc) (void);
22736 typedef int (*ElmMapModuleZoomMinFunc) (void);
22737 typedef int (*ElmMapModuleZoomMaxFunc) (void);
22738 typedef char *(*ElmMapModuleUrlFunc) (Evas_Object *obj, int x, int y, int zoom);
22739 typedef int (*ElmMapModuleRouteSourceFunc) (void);
22740 typedef char *(*ElmMapModuleRouteUrlFunc) (Evas_Object *obj, char *type_name, int method, double flon, double flat, double tlon, double tlat);
22741 typedef char *(*ElmMapModuleNameUrlFunc) (Evas_Object *obj, int method, char *name, double lon, double lat);
22742 typedef Eina_Bool (*ElmMapModuleGeoIntoCoordFunc) (const Evas_Object *obj, int zoom, double lon, double lat, int size, int *x, int *y);
22743 typedef Eina_Bool (*ElmMapModuleCoordIntoGeoFunc) (const Evas_Object *obj, int zoom, int x, int y, int size, double *lon, double *lat);
22746 * Add a new map widget to the given parent Elementary (container) object.
22748 * @param parent The parent object.
22749 * @return a new map widget handle or @c NULL, on errors.
22751 * This function inserts a new map widget on the canvas.
22755 EAPI Evas_Object *elm_map_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22758 * Set the zoom level of the map.
22760 * @param obj The map object.
22761 * @param zoom The zoom level to set.
22763 * This sets the zoom level.
22765 * It will respect limits defined by elm_map_source_zoom_min_set() and
22766 * elm_map_source_zoom_max_set().
22768 * By default these values are 0 (world map) and 18 (maximum zoom).
22770 * This function should be used when zoom mode is set to
22771 * #ELM_MAP_ZOOM_MODE_MANUAL. This is the default mode, and can be set
22772 * with elm_map_zoom_mode_set().
22774 * @see elm_map_zoom_mode_set().
22775 * @see elm_map_zoom_get().
22779 EAPI void elm_map_zoom_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
22782 * Get the zoom level of the map.
22784 * @param obj The map object.
22785 * @return The current zoom level.
22787 * This returns the current zoom level of the map object.
22789 * Note that if you set the fill mode to other than #ELM_MAP_ZOOM_MODE_MANUAL
22790 * (which is the default), the zoom level may be changed at any time by the
22791 * map object itself to account for map size and map viewport size.
22793 * @see elm_map_zoom_set() for details.
22797 EAPI int elm_map_zoom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22800 * Set the zoom mode used by the map object.
22802 * @param obj The map object.
22803 * @param mode The zoom mode of the map, being it one of
22804 * #ELM_MAP_ZOOM_MODE_MANUAL (default), #ELM_MAP_ZOOM_MODE_AUTO_FIT,
22805 * or #ELM_MAP_ZOOM_MODE_AUTO_FILL.
22807 * This sets the zoom mode to manual or one of the automatic levels.
22808 * Manual (#ELM_MAP_ZOOM_MODE_MANUAL) means that zoom is set manually by
22809 * elm_map_zoom_set() and will stay at that level until changed by code
22810 * or until zoom mode is changed. This is the default mode.
22812 * The Automatic modes will allow the map object to automatically
22813 * adjust zoom mode based on properties. #ELM_MAP_ZOOM_MODE_AUTO_FIT will
22814 * adjust zoom so the map fits inside the scroll frame with no pixels
22815 * outside this area. #ELM_MAP_ZOOM_MODE_AUTO_FILL will be similar but
22816 * ensure no pixels within the frame are left unfilled. Do not forget that
22817 * the valid sizes are 2^zoom, consequently the map may be smaller than
22818 * the scroller view.
22820 * @see elm_map_zoom_set()
22824 EAPI void elm_map_zoom_mode_set(Evas_Object *obj, Elm_Map_Zoom_Mode mode) EINA_ARG_NONNULL(1);
22827 * Get the zoom mode used by the map object.
22829 * @param obj The map object.
22830 * @return The zoom mode of the map, being it one of
22831 * #ELM_MAP_ZOOM_MODE_MANUAL (default), #ELM_MAP_ZOOM_MODE_AUTO_FIT,
22832 * or #ELM_MAP_ZOOM_MODE_AUTO_FILL.
22834 * This function returns the current zoom mode used by the map object.
22836 * @see elm_map_zoom_mode_set() for more details.
22840 EAPI Elm_Map_Zoom_Mode elm_map_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22843 * Get the current coordinates of the map.
22845 * @param obj The map object.
22846 * @param lon Pointer where to store longitude.
22847 * @param lat Pointer where to store latitude.
22849 * This gets the current center coordinates of the map object. It can be
22850 * set by elm_map_geo_region_bring_in() and elm_map_geo_region_show().
22852 * @see elm_map_geo_region_bring_in()
22853 * @see elm_map_geo_region_show()
22857 EAPI void elm_map_geo_region_get(const Evas_Object *obj, double *lon, double *lat) EINA_ARG_NONNULL(1);
22860 * Animatedly bring in given coordinates to the center of the map.
22862 * @param obj The map object.
22863 * @param lon Longitude to center at.
22864 * @param lat Latitude to center at.
22866 * This causes map to jump to the given @p lat and @p lon coordinates
22867 * and show it (by scrolling) in the center of the viewport, if it is not
22868 * already centered. This will use animation to do so and take a period
22869 * of time to complete.
22871 * @see elm_map_geo_region_show() for a function to avoid animation.
22872 * @see elm_map_geo_region_get()
22876 EAPI void elm_map_geo_region_bring_in(Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
22879 * Show the given coordinates at the center of the map, @b immediately.
22881 * @param obj The map object.
22882 * @param lon Longitude to center at.
22883 * @param lat Latitude to center at.
22885 * This causes map to @b redraw its viewport's contents to the
22886 * region contining the given @p lat and @p lon, that will be moved to the
22887 * center of the map.
22889 * @see elm_map_geo_region_bring_in() for a function to move with animation.
22890 * @see elm_map_geo_region_get()
22894 EAPI void elm_map_geo_region_show(Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
22897 * Pause or unpause the map.
22899 * @param obj The map object.
22900 * @param paused Use @c EINA_TRUE to pause the map @p obj or @c EINA_FALSE
22903 * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
22906 * The default is off.
22908 * This will stop zooming using animation, changing zoom levels will
22909 * change instantly. This will stop any existing animations that are running.
22911 * @see elm_map_paused_get()
22915 EAPI void elm_map_paused_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
22918 * Get a value whether map is paused or not.
22920 * @param obj The map object.
22921 * @return @c EINA_TRUE means map is pause. @c EINA_FALSE indicates
22922 * it is not. If @p obj is @c NULL, @c EINA_FALSE is returned.
22924 * This gets the current paused state for the map object.
22926 * @see elm_map_paused_set() for details.
22930 EAPI Eina_Bool elm_map_paused_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22933 * Set to show markers during zoom level changes or not.
22935 * @param obj The map object.
22936 * @param paused Use @c EINA_TRUE to @b not show markers or @c EINA_FALSE
22939 * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
22942 * The default is off.
22944 * This will stop zooming using animation, changing zoom levels will
22945 * change instantly. This will stop any existing animations that are running.
22947 * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
22950 * The default is off.
22952 * Enabling it will force the map to stop displaying the markers during
22953 * zoom level changes. Set to on if you have a large number of markers.
22955 * @see elm_map_paused_markers_get()
22959 EAPI void elm_map_paused_markers_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
22962 * Get a value whether markers will be displayed on zoom level changes or not
22964 * @param obj The map object.
22965 * @return @c EINA_TRUE means map @b won't display markers or @c EINA_FALSE
22966 * indicates it will. If @p obj is @c NULL, @c EINA_FALSE is returned.
22968 * This gets the current markers paused state for the map object.
22970 * @see elm_map_paused_markers_set() for details.
22974 EAPI Eina_Bool elm_map_paused_markers_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22977 * Get the information of downloading status.
22979 * @param obj The map object.
22980 * @param try_num Pointer where to store number of tiles being downloaded.
22981 * @param finish_num Pointer where to store number of tiles successfully
22984 * This gets the current downloading status for the map object, the number
22985 * of tiles being downloaded and the number of tiles already downloaded.
22989 EAPI void elm_map_utils_downloading_status_get(const Evas_Object *obj, int *try_num, int *finish_num) EINA_ARG_NONNULL(1, 2, 3);
22992 * Convert a pixel coordinate (x,y) into a geographic coordinate
22993 * (longitude, latitude).
22995 * @param obj The map object.
22996 * @param x the coordinate.
22997 * @param y the coordinate.
22998 * @param size the size in pixels of the map.
22999 * The map is a square and generally his size is : pow(2.0, zoom)*256.
23000 * @param lon Pointer where to store the longitude that correspond to x.
23001 * @param lat Pointer where to store the latitude that correspond to y.
23003 * @note Origin pixel point is the top left corner of the viewport.
23004 * Map zoom and size are taken on account.
23006 * @see elm_map_utils_convert_geo_into_coord() if you need the inverse.
23010 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);
23013 * Convert a geographic coordinate (longitude, latitude) into a pixel
23014 * coordinate (x, y).
23016 * @param obj The map object.
23017 * @param lon the longitude.
23018 * @param lat the latitude.
23019 * @param size the size in pixels of the map. The map is a square
23020 * and generally his size is : pow(2.0, zoom)*256.
23021 * @param x Pointer where to store the horizontal pixel coordinate that
23022 * correspond to the longitude.
23023 * @param y Pointer where to store the vertical pixel coordinate that
23024 * correspond to the latitude.
23026 * @note Origin pixel point is the top left corner of the viewport.
23027 * Map zoom and size are taken on account.
23029 * @see elm_map_utils_convert_coord_into_geo() if you need the inverse.
23033 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);
23036 * Convert a geographic coordinate (longitude, latitude) into a name
23039 * @param obj The map object.
23040 * @param lon the longitude.
23041 * @param lat the latitude.
23042 * @return name A #Elm_Map_Name handle for this coordinate.
23044 * To get the string for this address, elm_map_name_address_get()
23047 * @see elm_map_utils_convert_name_into_coord() if you need the inverse.
23051 EAPI Elm_Map_Name *elm_map_utils_convert_coord_into_name(const Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
23054 * Convert a name (address) into a geographic coordinate
23055 * (longitude, latitude).
23057 * @param obj The map object.
23058 * @param name The address.
23059 * @return name A #Elm_Map_Name handle for this address.
23061 * To get the longitude and latitude, elm_map_name_region_get()
23064 * @see elm_map_utils_convert_coord_into_name() if you need the inverse.
23068 EAPI Elm_Map_Name *elm_map_utils_convert_name_into_coord(const Evas_Object *obj, char *address) EINA_ARG_NONNULL(1, 2);
23071 * Convert a pixel coordinate into a rotated pixel coordinate.
23073 * @param obj The map object.
23074 * @param x horizontal coordinate of the point to rotate.
23075 * @param y vertical coordinate of the point to rotate.
23076 * @param cx rotation's center horizontal position.
23077 * @param cy rotation's center vertical position.
23078 * @param degree amount of degrees from 0.0 to 360.0 to rotate arount Z axis.
23079 * @param xx Pointer where to store rotated x.
23080 * @param yy Pointer where to store rotated y.
23084 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);
23087 * Add a new marker to the map object.
23089 * @param obj The map object.
23090 * @param lon The longitude of the marker.
23091 * @param lat The latitude of the marker.
23092 * @param clas The class, to use when marker @b isn't grouped to others.
23093 * @param clas_group The class group, to use when marker is grouped to others
23094 * @param data The data passed to the callbacks.
23096 * @return The created marker or @c NULL upon failure.
23098 * A marker will be created and shown in a specific point of the map, defined
23099 * by @p lon and @p lat.
23101 * It will be displayed using style defined by @p class when this marker
23102 * is displayed alone (not grouped). A new class can be created with
23103 * elm_map_marker_class_new().
23105 * If the marker is grouped to other markers, it will be displayed with
23106 * style defined by @p class_group. Markers with the same group are grouped
23107 * if they are close. A new group class can be created with
23108 * elm_map_marker_group_class_new().
23110 * Markers created with this method can be deleted with
23111 * elm_map_marker_remove().
23113 * A marker can have associated content to be displayed by a bubble,
23114 * when a user click over it, as well as an icon. These objects will
23115 * be fetch using class' callback functions.
23117 * @see elm_map_marker_class_new()
23118 * @see elm_map_marker_group_class_new()
23119 * @see elm_map_marker_remove()
23123 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);
23126 * Set the maximum numbers of markers' content to be displayed in a group.
23128 * @param obj The map object.
23129 * @param max The maximum numbers of items displayed in a bubble.
23131 * A bubble will be displayed when the user clicks over the group,
23132 * and will place the content of markers that belong to this group
23135 * A group can have a long list of markers, consequently the creation
23136 * of the content of the bubble can be very slow.
23138 * In order to avoid this, a maximum number of items is displayed
23141 * By default this number is 30.
23143 * Marker with the same group class are grouped if they are close.
23145 * @see elm_map_marker_add()
23149 EAPI void elm_map_max_marker_per_group_set(Evas_Object *obj, int max) EINA_ARG_NONNULL(1);
23152 * Remove a marker from the map.
23154 * @param marker The marker to remove.
23156 * @see elm_map_marker_add()
23160 EAPI void elm_map_marker_remove(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
23163 * Get the current coordinates of the marker.
23165 * @param marker marker.
23166 * @param lat Pointer where to store the marker's latitude.
23167 * @param lon Pointer where to store the marker's longitude.
23169 * These values are set when adding markers, with function
23170 * elm_map_marker_add().
23172 * @see elm_map_marker_add()
23176 EAPI void elm_map_marker_region_get(const Elm_Map_Marker *marker, double *lon, double *lat) EINA_ARG_NONNULL(1);
23179 * Animatedly bring in given marker to the center of the map.
23181 * @param marker The marker to center at.
23183 * This causes map to jump to the given @p marker's coordinates
23184 * and show it (by scrolling) in the center of the viewport, if it is not
23185 * already centered. This will use animation to do so and take a period
23186 * of time to complete.
23188 * @see elm_map_marker_show() for a function to avoid animation.
23189 * @see elm_map_marker_region_get()
23193 EAPI void elm_map_marker_bring_in(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
23196 * Show the given marker at the center of the map, @b immediately.
23198 * @param marker The marker to center at.
23200 * This causes map to @b redraw its viewport's contents to the
23201 * region contining the given @p marker's coordinates, that will be
23202 * moved to the center of the map.
23204 * @see elm_map_marker_bring_in() for a function to move with animation.
23205 * @see elm_map_markers_list_show() if more than one marker need to be
23207 * @see elm_map_marker_region_get()
23211 EAPI void elm_map_marker_show(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
23214 * Move and zoom the map to display a list of markers.
23216 * @param markers A list of #Elm_Map_Marker handles.
23218 * The map will be centered on the center point of the markers in the list.
23219 * Then the map will be zoomed in order to fit the markers using the maximum
23220 * zoom which allows display of all the markers.
23222 * @warning All the markers should belong to the same map object.
23224 * @see elm_map_marker_show() to show a single marker.
23225 * @see elm_map_marker_bring_in()
23229 EAPI void elm_map_markers_list_show(Eina_List *markers) EINA_ARG_NONNULL(1);
23232 * Get the Evas object returned by the ElmMapMarkerGetFunc callback
23234 * @param marker The marker wich content should be returned.
23235 * @return Return the evas object if it exists, else @c NULL.
23237 * To set callback function #ElmMapMarkerGetFunc for the marker class,
23238 * elm_map_marker_class_get_cb_set() should be used.
23240 * This content is what will be inside the bubble that will be displayed
23241 * when an user clicks over the marker.
23243 * This returns the actual Evas object used to be placed inside
23244 * the bubble. This may be @c NULL, as it may
23245 * not have been created or may have been deleted, at any time, by
23246 * the map. <b>Do not modify this object</b> (move, resize,
23247 * show, hide, etc.), as the map is controlling it. This
23248 * function is for querying, emitting custom signals or hooking
23249 * lower level callbacks for events on that object. Do not delete
23250 * this object under any circumstances.
23254 EAPI Evas_Object *elm_map_marker_object_get(const Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
23257 * Update the marker
23259 * @param marker The marker to be updated.
23261 * If a content is set to this marker, it will call function to delete it,
23262 * #ElmMapMarkerDelFunc, and then will fetch the content again with
23263 * #ElmMapMarkerGetFunc.
23265 * These functions are set for the marker class with
23266 * elm_map_marker_class_get_cb_set() and elm_map_marker_class_del_cb_set().
23270 EAPI void elm_map_marker_update(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
23273 * Close all the bubbles opened by the user.
23275 * @param obj The map object.
23277 * A bubble is displayed with a content fetched with #ElmMapMarkerGetFunc
23278 * when the user clicks on a marker.
23280 * This functions is set for the marker class with
23281 * elm_map_marker_class_get_cb_set().
23285 EAPI void elm_map_bubbles_close(Evas_Object *obj) EINA_ARG_NONNULL(1);
23288 * Create a new group class.
23290 * @param obj The map object.
23291 * @return Returns the new group class.
23293 * Each marker must be associated to a group class. Markers in the same
23294 * group are grouped if they are close.
23296 * The group class defines the style of the marker when a marker is grouped
23297 * to others markers. When it is alone, another class will be used.
23299 * A group class will need to be provided when creating a marker with
23300 * elm_map_marker_add().
23302 * Some properties and functions can be set by class, as:
23303 * - style, with elm_map_group_class_style_set()
23304 * - data - to be associated to the group class. It can be set using
23305 * elm_map_group_class_data_set().
23306 * - min zoom to display markers, set with
23307 * elm_map_group_class_zoom_displayed_set().
23308 * - max zoom to group markers, set using
23309 * elm_map_group_class_zoom_grouped_set().
23310 * - visibility - set if markers will be visible or not, set with
23311 * elm_map_group_class_hide_set().
23312 * - #ElmMapGroupIconGetFunc - used to fetch icon for markers group classes.
23313 * It can be set using elm_map_group_class_icon_cb_set().
23315 * @see elm_map_marker_add()
23316 * @see elm_map_group_class_style_set()
23317 * @see elm_map_group_class_data_set()
23318 * @see elm_map_group_class_zoom_displayed_set()
23319 * @see elm_map_group_class_zoom_grouped_set()
23320 * @see elm_map_group_class_hide_set()
23321 * @see elm_map_group_class_icon_cb_set()
23325 EAPI Elm_Map_Group_Class *elm_map_group_class_new(Evas_Object *obj) EINA_ARG_NONNULL(1);
23328 * Set the marker's style of a group class.
23330 * @param clas The group class.
23331 * @param style The style to be used by markers.
23333 * Each marker must be associated to a group class, and will use the style
23334 * defined by such class when grouped to other markers.
23336 * The following styles are provided by default theme:
23337 * @li @c radio - blue circle
23338 * @li @c radio2 - green circle
23341 * @see elm_map_group_class_new() for more details.
23342 * @see elm_map_marker_add()
23346 EAPI void elm_map_group_class_style_set(Elm_Map_Group_Class *clas, const char *style) EINA_ARG_NONNULL(1);
23349 * Set the icon callback function of a group class.
23351 * @param clas The group class.
23352 * @param icon_get The callback function that will return the icon.
23354 * Each marker must be associated to a group class, and it can display a
23355 * custom icon. The function @p icon_get must return this icon.
23357 * @see elm_map_group_class_new() for more details.
23358 * @see elm_map_marker_add()
23362 EAPI void elm_map_group_class_icon_cb_set(Elm_Map_Group_Class *clas, ElmMapGroupIconGetFunc icon_get) EINA_ARG_NONNULL(1);
23365 * Set the data associated to the group class.
23367 * @param clas The group class.
23368 * @param data The new user data.
23370 * This data will be passed for callback functions, like icon get callback,
23371 * that can be set with elm_map_group_class_icon_cb_set().
23373 * If a data was previously set, the object will lose the pointer for it,
23374 * so if needs to be freed, you must do it yourself.
23376 * @see elm_map_group_class_new() for more details.
23377 * @see elm_map_group_class_icon_cb_set()
23378 * @see elm_map_marker_add()
23382 EAPI void elm_map_group_class_data_set(Elm_Map_Group_Class *clas, void *data) EINA_ARG_NONNULL(1);
23385 * Set the minimum zoom from where the markers are displayed.
23387 * @param clas The group class.
23388 * @param zoom The minimum zoom.
23390 * Markers only will be displayed when the map is displayed at @p zoom
23393 * @see elm_map_group_class_new() for more details.
23394 * @see elm_map_marker_add()
23398 EAPI void elm_map_group_class_zoom_displayed_set(Elm_Map_Group_Class *clas, int zoom) EINA_ARG_NONNULL(1);
23401 * Set the zoom from where the markers are no more grouped.
23403 * @param clas The group class.
23404 * @param zoom The maximum zoom.
23406 * Markers only will be grouped when the map is displayed at
23407 * less than @p zoom.
23409 * @see elm_map_group_class_new() for more details.
23410 * @see elm_map_marker_add()
23414 EAPI void elm_map_group_class_zoom_grouped_set(Elm_Map_Group_Class *clas, int zoom) EINA_ARG_NONNULL(1);
23417 * Set if the markers associated to the group class @clas are hidden or not.
23419 * @param clas The group class.
23420 * @param hide Use @c EINA_TRUE to hide markers or @c EINA_FALSE
23423 * If @p hide is @c EINA_TRUE the markers will be hidden, but default
23428 EAPI void elm_map_group_class_hide_set(Evas_Object *obj, Elm_Map_Group_Class *clas, Eina_Bool hide) EINA_ARG_NONNULL(1, 2);
23431 * Create a new marker class.
23433 * @param obj The map object.
23434 * @return Returns the new group class.
23436 * Each marker must be associated to a class.
23438 * The marker class defines the style of the marker when a marker is
23439 * displayed alone, i.e., not grouped to to others markers. When grouped
23440 * it will use group class style.
23442 * A marker class will need to be provided when creating a marker with
23443 * elm_map_marker_add().
23445 * Some properties and functions can be set by class, as:
23446 * - style, with elm_map_marker_class_style_set()
23447 * - #ElmMapMarkerIconGetFunc - used to fetch icon for markers classes.
23448 * It can be set using elm_map_marker_class_icon_cb_set().
23449 * - #ElmMapMarkerGetFunc - used to fetch bubble content for marker classes.
23450 * Set using elm_map_marker_class_get_cb_set().
23451 * - #ElmMapMarkerDelFunc - used to delete bubble content for marker classes.
23452 * Set using elm_map_marker_class_del_cb_set().
23454 * @see elm_map_marker_add()
23455 * @see elm_map_marker_class_style_set()
23456 * @see elm_map_marker_class_icon_cb_set()
23457 * @see elm_map_marker_class_get_cb_set()
23458 * @see elm_map_marker_class_del_cb_set()
23462 EAPI Elm_Map_Marker_Class *elm_map_marker_class_new(Evas_Object *obj) EINA_ARG_NONNULL(1);
23465 * Set the marker's style of a marker class.
23467 * @param clas The marker class.
23468 * @param style The style to be used by markers.
23470 * Each marker must be associated to a marker class, and will use the style
23471 * defined by such class when alone, i.e., @b not grouped to other markers.
23473 * The following styles are provided by default theme:
23478 * @see elm_map_marker_class_new() for more details.
23479 * @see elm_map_marker_add()
23483 EAPI void elm_map_marker_class_style_set(Elm_Map_Marker_Class *clas, const char *style) EINA_ARG_NONNULL(1);
23486 * Set the icon callback function of a marker class.
23488 * @param clas The marker class.
23489 * @param icon_get The callback function that will return the icon.
23491 * Each marker must be associated to a marker class, and it can display a
23492 * custom icon. The function @p icon_get must return this icon.
23494 * @see elm_map_marker_class_new() for more details.
23495 * @see elm_map_marker_add()
23499 EAPI void elm_map_marker_class_icon_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerIconGetFunc icon_get) EINA_ARG_NONNULL(1);
23502 * Set the bubble content callback function of a marker class.
23504 * @param clas The marker class.
23505 * @param get The callback function that will return 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 @p get must return this content object.
23511 * If this content will need to be deleted, elm_map_marker_class_del_cb_set()
23514 * @see elm_map_marker_class_new() for more details.
23515 * @see elm_map_marker_class_del_cb_set()
23516 * @see elm_map_marker_add()
23520 EAPI void elm_map_marker_class_get_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerGetFunc get) EINA_ARG_NONNULL(1);
23523 * Set the callback function used to delete bubble content of a marker class.
23525 * @param clas The marker class.
23526 * @param del The callback function that will delete the content.
23528 * Each marker must be associated to a marker class, and it can display a
23529 * a content on a bubble that opens when the user click over the marker.
23530 * The function to return such content can be set with
23531 * elm_map_marker_class_get_cb_set().
23533 * If this content must be freed, a callback function need to be
23534 * set for that task with this function.
23536 * If this callback is defined it will have to delete (or not) the
23537 * object inside, but if the callback is not defined the object will be
23538 * destroyed with evas_object_del().
23540 * @see elm_map_marker_class_new() for more details.
23541 * @see elm_map_marker_class_get_cb_set()
23542 * @see elm_map_marker_add()
23546 EAPI void elm_map_marker_class_del_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerDelFunc del) EINA_ARG_NONNULL(1);
23549 * Get the list of available sources.
23551 * @param obj The map object.
23552 * @return The source names list.
23554 * It will provide a list with all available sources, that can be set as
23555 * current source with elm_map_source_name_set(), or get with
23556 * elm_map_source_name_get().
23558 * Available sources:
23564 * @see elm_map_source_name_set() for more details.
23565 * @see elm_map_source_name_get()
23569 EAPI const char **elm_map_source_names_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23572 * Set the source of the map.
23574 * @param obj The map object.
23575 * @param source The source to be used.
23577 * Map widget retrieves images that composes the map from a web service.
23578 * This web service can be set with this method.
23580 * A different service can return a different maps with different
23581 * information and it can use different zoom values.
23583 * The @p source_name need to match one of the names provided by
23584 * elm_map_source_names_get().
23586 * The current source can be get using elm_map_source_name_get().
23588 * @see elm_map_source_names_get()
23589 * @see elm_map_source_name_get()
23594 EAPI void elm_map_source_name_set(Evas_Object *obj, const char *source_name) EINA_ARG_NONNULL(1);
23597 * Get the name of currently used source.
23599 * @param obj The map object.
23600 * @return Returns the name of the source in use.
23602 * @see elm_map_source_name_set() for more details.
23606 EAPI const char *elm_map_source_name_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23609 * Set the source of the route service to be used by the map.
23611 * @param obj The map object.
23612 * @param source The route service to be used, being it one of
23613 * #ELM_MAP_ROUTE_SOURCE_YOURS (default), #ELM_MAP_ROUTE_SOURCE_MONAV,
23614 * and #ELM_MAP_ROUTE_SOURCE_ORS.
23616 * Each one has its own algorithm, so the route retrieved may
23617 * differ depending on the source route. Now, only the default is working.
23619 * #ELM_MAP_ROUTE_SOURCE_YOURS is the routing service provided at
23620 * http://www.yournavigation.org/.
23622 * #ELM_MAP_ROUTE_SOURCE_MONAV, offers exact routing without heuristic
23623 * assumptions. Its routing core is based on Contraction Hierarchies.
23625 * #ELM_MAP_ROUTE_SOURCE_ORS, is provided at http://www.openrouteservice.org/
23627 * @see elm_map_route_source_get().
23631 EAPI void elm_map_route_source_set(Evas_Object *obj, Elm_Map_Route_Sources source) EINA_ARG_NONNULL(1);
23634 * Get the current route source.
23636 * @param obj The map object.
23637 * @return The source of the route service used by the map.
23639 * @see elm_map_route_source_set() for details.
23643 EAPI Elm_Map_Route_Sources elm_map_route_source_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23646 * Set the minimum zoom of the source.
23648 * @param obj The map object.
23649 * @param zoom New minimum zoom value to be used.
23651 * By default, it's 0.
23655 EAPI void elm_map_source_zoom_min_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
23658 * Get the minimum zoom of the source.
23660 * @param obj The map object.
23661 * @return Returns the minimum zoom of the source.
23663 * @see elm_map_source_zoom_min_set() for details.
23667 EAPI int elm_map_source_zoom_min_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23670 * Set the maximum zoom of the source.
23672 * @param obj The map object.
23673 * @param zoom New maximum zoom value to be used.
23675 * By default, it's 18.
23679 EAPI void elm_map_source_zoom_max_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
23682 * Get the maximum zoom of the source.
23684 * @param obj The map object.
23685 * @return Returns the maximum zoom of the source.
23687 * @see elm_map_source_zoom_min_set() for details.
23691 EAPI int elm_map_source_zoom_max_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23694 * Set the user agent used by the map object to access routing services.
23696 * @param obj The map object.
23697 * @param user_agent The user agent to be used by the map.
23699 * User agent is a client application implementing a network protocol used
23700 * in communications within a clientāserver distributed computing system
23702 * The @p user_agent identification string will transmitted in a header
23703 * field @c User-Agent.
23705 * @see elm_map_user_agent_get()
23709 EAPI void elm_map_user_agent_set(Evas_Object *obj, const char *user_agent) EINA_ARG_NONNULL(1, 2);
23712 * Get the user agent used by the map object.
23714 * @param obj The map object.
23715 * @return The user agent identification string used by the map.
23717 * @see elm_map_user_agent_set() for details.
23721 EAPI const char *elm_map_user_agent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23724 * Add a new route to the map object.
23726 * @param obj The map object.
23727 * @param type The type of transport to be considered when tracing a route.
23728 * @param method The routing method, what should be priorized.
23729 * @param flon The start longitude.
23730 * @param flat The start latitude.
23731 * @param tlon The destination longitude.
23732 * @param tlat The destination latitude.
23734 * @return The created route or @c NULL upon failure.
23736 * A route will be traced by point on coordinates (@p flat, @p flon)
23737 * to point on coordinates (@p tlat, @p tlon), using the route service
23738 * set with elm_map_route_source_set().
23740 * It will take @p type on consideration to define the route,
23741 * depending if the user will be walking or driving, the route may vary.
23742 * One of #ELM_MAP_ROUTE_TYPE_MOTOCAR, #ELM_MAP_ROUTE_TYPE_BICYCLE, or
23743 * #ELM_MAP_ROUTE_TYPE_FOOT need to be used.
23745 * Another parameter is what the route should priorize, the minor distance
23746 * or the less time to be spend on the route. So @p method should be one
23747 * of #ELM_MAP_ROUTE_METHOD_SHORTEST or #ELM_MAP_ROUTE_METHOD_FASTEST.
23749 * Routes created with this method can be deleted with
23750 * elm_map_route_remove(), colored with elm_map_route_color_set(),
23751 * and distance can be get with elm_map_route_distance_get().
23753 * @see elm_map_route_remove()
23754 * @see elm_map_route_color_set()
23755 * @see elm_map_route_distance_get()
23756 * @see elm_map_route_source_set()
23760 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);
23763 * Remove a route from the map.
23765 * @param route The route to remove.
23767 * @see elm_map_route_add()
23771 EAPI void elm_map_route_remove(Elm_Map_Route *route) EINA_ARG_NONNULL(1);
23774 * Set the route color.
23776 * @param route The route object.
23777 * @param r Red channel value, from 0 to 255.
23778 * @param g Green channel value, from 0 to 255.
23779 * @param b Blue channel value, from 0 to 255.
23780 * @param a Alpha channel value, from 0 to 255.
23782 * It uses an additive color model, so each color channel represents
23783 * how much of each primary colors must to be used. 0 represents
23784 * ausence of this color, so if all of the three are set to 0,
23785 * the color will be black.
23787 * These component values should be integers in the range 0 to 255,
23788 * (single 8-bit byte).
23790 * This sets the color used for the route. By default, it is set to
23791 * solid red (r = 255, g = 0, b = 0, a = 255).
23793 * For alpha channel, 0 represents completely transparent, and 255, opaque.
23795 * @see elm_map_route_color_get()
23799 EAPI void elm_map_route_color_set(Elm_Map_Route *route, int r, int g , int b, int a) EINA_ARG_NONNULL(1);
23802 * Get the route color.
23804 * @param route The route object.
23805 * @param r Pointer where to store the red channel value.
23806 * @param g Pointer where to store the green channel value.
23807 * @param b Pointer where to store the blue channel value.
23808 * @param a Pointer where to store the alpha channel value.
23810 * @see elm_map_route_color_set() for details.
23814 EAPI void elm_map_route_color_get(const Elm_Map_Route *route, int *r, int *g , int *b, int *a) EINA_ARG_NONNULL(1);
23817 * Get the route distance in kilometers.
23819 * @param route The route object.
23820 * @return The distance of route (unit : km).
23824 EAPI double elm_map_route_distance_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
23827 * Get the information of route nodes.
23829 * @param route The route object.
23830 * @return Returns a string with the nodes of route.
23834 EAPI const char *elm_map_route_node_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
23837 * Get the information of route waypoint.
23839 * @param route the route object.
23840 * @return Returns a string with information about waypoint of route.
23844 EAPI const char *elm_map_route_waypoint_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
23847 * Get the address of the name.
23849 * @param name The name handle.
23850 * @return Returns the address string of @p name.
23852 * This gets the coordinates of the @p name, created with one of the
23853 * conversion functions.
23855 * @see elm_map_utils_convert_name_into_coord()
23856 * @see elm_map_utils_convert_coord_into_name()
23860 EAPI const char *elm_map_name_address_get(const Elm_Map_Name *name) EINA_ARG_NONNULL(1);
23863 * Get the current coordinates of the name.
23865 * @param name The name handle.
23866 * @param lat Pointer where to store the latitude.
23867 * @param lon Pointer where to store The longitude.
23869 * This gets the coordinates of the @p name, created with one of the
23870 * conversion functions.
23872 * @see elm_map_utils_convert_name_into_coord()
23873 * @see elm_map_utils_convert_coord_into_name()
23877 EAPI void elm_map_name_region_get(const Elm_Map_Name *name, double *lon, double *lat) EINA_ARG_NONNULL(1);
23880 * Remove a name from the map.
23882 * @param name The name to remove.
23884 * Basically the struct handled by @p name will be freed, so convertions
23885 * between address and coordinates will be lost.
23887 * @see elm_map_utils_convert_name_into_coord()
23888 * @see elm_map_utils_convert_coord_into_name()
23892 EAPI void elm_map_name_remove(Elm_Map_Name *name) EINA_ARG_NONNULL(1);
23897 * @param obj The map object.
23898 * @param degree Angle from 0.0 to 360.0 to rotate arount Z axis.
23899 * @param cx Rotation's center horizontal position.
23900 * @param cy Rotation's center vertical position.
23902 * @see elm_map_rotate_get()
23906 EAPI void elm_map_rotate_set(Evas_Object *obj, double degree, Evas_Coord cx, Evas_Coord cy) EINA_ARG_NONNULL(1);
23909 * Get the rotate degree of the map
23911 * @param obj The map object
23912 * @param degree Pointer where to store degrees from 0.0 to 360.0
23913 * to rotate arount Z axis.
23914 * @param cx Pointer where to store rotation's center horizontal position.
23915 * @param cy Pointer where to store rotation's center vertical position.
23917 * @see elm_map_rotate_set() to set map rotation.
23921 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);
23924 * Enable or disable mouse wheel to be used to zoom in / out the map.
23926 * @param obj The map object.
23927 * @param disabled Use @c EINA_TRUE to disable mouse wheel or @c EINA_FALSE
23930 * Mouse wheel can be used for the user to zoom in or zoom out the map.
23932 * It's disabled by default.
23934 * @see elm_map_wheel_disabled_get()
23938 EAPI void elm_map_wheel_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
23941 * Get a value whether mouse wheel is enabled or not.
23943 * @param obj The map object.
23944 * @return @c EINA_TRUE means map is disabled. @c EINA_FALSE indicates
23945 * it is enabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
23947 * Mouse wheel can be used for the user to zoom in or zoom out the map.
23949 * @see elm_map_wheel_disabled_set() for details.
23953 EAPI Eina_Bool elm_map_wheel_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23957 * Add a track on the map
23959 * @param obj The map object.
23960 * @param emap The emap route object.
23961 * @return The route object. This is an elm object of type Route.
23963 * @see elm_route_add() for details.
23967 EAPI Evas_Object *elm_map_track_add(Evas_Object *obj, EMap_Route *emap) EINA_ARG_NONNULL(1);
23971 * Remove a track from the map
23973 * @param obj The map object.
23974 * @param route The track to remove.
23978 EAPI void elm_map_track_remove(Evas_Object *obj, Evas_Object *route) EINA_ARG_NONNULL(1);
23985 EAPI Evas_Object *elm_route_add(Evas_Object *parent);
23987 EAPI void elm_route_emap_set(Evas_Object *obj, EMap_Route *emap);
23989 EAPI double elm_route_lon_min_get(Evas_Object *obj);
23990 EAPI double elm_route_lat_min_get(Evas_Object *obj);
23991 EAPI double elm_route_lon_max_get(Evas_Object *obj);
23992 EAPI double elm_route_lat_max_get(Evas_Object *obj);
23996 * @defgroup Panel Panel
23998 * @image html img/widget/panel/preview-00.png
23999 * @image latex img/widget/panel/preview-00.eps
24001 * @brief A panel is a type of animated container that contains subobjects.
24002 * It can be expanded or contracted by clicking the button on it's edge.
24004 * Orientations are as follows:
24005 * @li ELM_PANEL_ORIENT_TOP
24006 * @li ELM_PANEL_ORIENT_LEFT
24007 * @li ELM_PANEL_ORIENT_RIGHT
24009 * Default contents parts of the panel widget that you can use for are:
24010 * @li "default" - A content of the panel
24012 * @ref tutorial_panel shows one way to use this widget.
24015 typedef enum _Elm_Panel_Orient
24017 ELM_PANEL_ORIENT_TOP, /**< Panel (dis)appears from the top */
24018 ELM_PANEL_ORIENT_BOTTOM, /**< Not implemented */
24019 ELM_PANEL_ORIENT_LEFT, /**< Panel (dis)appears from the left */
24020 ELM_PANEL_ORIENT_RIGHT, /**< Panel (dis)appears from the right */
24021 } Elm_Panel_Orient;
24023 * @brief Adds a panel object
24025 * @param parent The parent object
24027 * @return The panel object, or NULL on failure
24029 EAPI Evas_Object *elm_panel_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24031 * @brief Sets the orientation of the panel
24033 * @param parent The parent object
24034 * @param orient The panel orientation. Can be one of the following:
24035 * @li ELM_PANEL_ORIENT_TOP
24036 * @li ELM_PANEL_ORIENT_LEFT
24037 * @li ELM_PANEL_ORIENT_RIGHT
24039 * Sets from where the panel will (dis)appear.
24041 EAPI void elm_panel_orient_set(Evas_Object *obj, Elm_Panel_Orient orient) EINA_ARG_NONNULL(1);
24043 * @brief Get the orientation of the panel.
24045 * @param obj The panel object
24046 * @return The Elm_Panel_Orient, or ELM_PANEL_ORIENT_LEFT on failure.
24048 EAPI Elm_Panel_Orient elm_panel_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24050 * @brief Set the content of the panel.
24052 * @param obj The panel object
24053 * @param content The panel content
24055 * Once the content object is set, a previously set one will be deleted.
24056 * If you want to keep that old content object, use the
24057 * elm_panel_content_unset() function.
24059 * @deprecated use elm_object_content_set() instead
24062 EINA_DEPRECATED EAPI void elm_panel_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
24064 * @brief Get the content of the panel.
24066 * @param obj The panel object
24067 * @return The content that is being used
24069 * Return the content object which is set for this widget.
24071 * @see elm_panel_content_set()
24073 * @deprecated use elm_object_content_get() instead
24076 EINA_DEPRECATED EAPI Evas_Object *elm_panel_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24078 * @brief Unset the content of the panel.
24080 * @param obj The panel object
24081 * @return The content that was being used
24083 * Unparent and return the content object which was set for this widget.
24085 * @see elm_panel_content_set()
24087 * @deprecated use elm_object_content_unset() instead
24090 EINA_DEPRECATED EAPI Evas_Object *elm_panel_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24092 * @brief Set the state of the panel.
24094 * @param obj The panel object
24095 * @param hidden If true, the panel will run the animation to contract
24097 EAPI void elm_panel_hidden_set(Evas_Object *obj, Eina_Bool hidden) EINA_ARG_NONNULL(1);
24099 * @brief Get the state of the panel.
24101 * @param obj The panel object
24102 * @param hidden If true, the panel is in the "hide" state
24104 EAPI Eina_Bool elm_panel_hidden_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24106 * @brief Toggle the hidden state of the panel from code
24108 * @param obj The panel object
24110 EAPI void elm_panel_toggle(Evas_Object *obj) EINA_ARG_NONNULL(1);
24116 * @defgroup Panes Panes
24117 * @ingroup Elementary
24119 * @image html img/widget/panes/preview-00.png
24120 * @image latex img/widget/panes/preview-00.eps width=\textwidth
24122 * @image html img/panes.png
24123 * @image latex img/panes.eps width=\textwidth
24125 * The panes adds a dragable bar between two contents. When dragged
24126 * this bar will resize contents size.
24128 * Panes can be displayed vertically or horizontally, and contents
24129 * size proportion can be customized (homogeneous by default).
24131 * Smart callbacks one can listen to:
24132 * - "press" - The panes has been pressed (button wasn't released yet).
24133 * - "unpressed" - The panes was released after being pressed.
24134 * - "clicked" - The panes has been clicked>
24135 * - "clicked,double" - The panes has been double clicked
24137 * Available styles for it:
24140 * Default contents parts of the panes widget that you can use for are:
24141 * @li "left" - A leftside content of the panes
24142 * @li "right" - A rightside content of the panes
24144 * If panes is displayed vertically, left content will be displayed at
24147 * Here is an example on its usage:
24148 * @li @ref panes_example
24152 * @addtogroup Panes
24157 * Add a new panes widget to the given parent Elementary
24158 * (container) object.
24160 * @param parent The parent object.
24161 * @return a new panes widget handle or @c NULL, on errors.
24163 * This function inserts a new panes widget on the canvas.
24167 EAPI Evas_Object *elm_panes_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24170 * Set the left content of the panes widget.
24172 * @param obj The panes object.
24173 * @param content The new left content object.
24175 * Once the content object is set, a previously set one will be deleted.
24176 * If you want to keep that old content object, use the
24177 * elm_panes_content_left_unset() function.
24179 * If panes is displayed vertically, left content will be displayed at
24182 * @see elm_panes_content_left_get()
24183 * @see elm_panes_content_right_set() to set content on the other side.
24185 * @deprecated use elm_object_part_content_set() instead
24189 EINA_DEPRECATED EAPI void elm_panes_content_left_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
24192 * Set the right content of the panes widget.
24194 * @param obj The panes object.
24195 * @param content The new right content object.
24197 * Once the content object is set, a previously set one will be deleted.
24198 * If you want to keep that old content object, use the
24199 * elm_panes_content_right_unset() function.
24201 * If panes is displayed vertically, left content will be displayed at
24204 * @see elm_panes_content_right_get()
24205 * @see elm_panes_content_left_set() to set content on the other side.
24207 * @deprecated use elm_object_part_content_set() instead
24211 EINA_DEPRECATED EAPI void elm_panes_content_right_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
24214 * Get the left content of the panes.
24216 * @param obj The panes object.
24217 * @return The left content object that is being used.
24219 * Return the left content object which is set for this widget.
24221 * @see elm_panes_content_left_set() for details.
24223 * @deprecated use elm_object_part_content_get() instead
24227 EINA_DEPRECATED EAPI Evas_Object *elm_panes_content_left_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24230 * Get the right content of the panes.
24232 * @param obj The panes object
24233 * @return The right content object that is being used
24235 * Return the right content object which is set for this widget.
24237 * @see elm_panes_content_right_set() for details.
24239 * @deprecated use elm_object_part_content_get() instead
24243 EINA_DEPRECATED EAPI Evas_Object *elm_panes_content_right_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24246 * Unset the left content used for the panes.
24248 * @param obj The panes object.
24249 * @return The left content object that was being used.
24251 * Unparent and return the left content object which was set for this widget.
24253 * @see elm_panes_content_left_set() for details.
24254 * @see elm_panes_content_left_get().
24256 * @deprecated use elm_object_part_content_unset() instead
24260 EINA_DEPRECATED EAPI Evas_Object *elm_panes_content_left_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24263 * Unset the right content used for the panes.
24265 * @param obj The panes object.
24266 * @return The right content object that was being used.
24268 * Unparent and return the right content object which was set for this
24271 * @see elm_panes_content_right_set() for details.
24272 * @see elm_panes_content_right_get().
24274 * @deprecated use elm_object_part_content_unset() instead
24278 EINA_DEPRECATED EAPI Evas_Object *elm_panes_content_right_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24281 * Get the size proportion of panes widget's left side.
24283 * @param obj The panes object.
24284 * @return float value between 0.0 and 1.0 representing size proportion
24287 * @see elm_panes_content_left_size_set() for more details.
24291 EAPI double elm_panes_content_left_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24294 * Set the size proportion of panes widget's left side.
24296 * @param obj The panes object.
24297 * @param size Value between 0.0 and 1.0 representing size proportion
24300 * By default it's homogeneous, i.e., both sides have the same size.
24302 * If something different is required, it can be set with this function.
24303 * For example, if the left content should be displayed over
24304 * 75% of the panes size, @p size should be passed as @c 0.75.
24305 * This way, right content will be resized to 25% of panes size.
24307 * If displayed vertically, left content is displayed at top, and
24308 * right content at bottom.
24310 * @note This proportion will change when user drags the panes bar.
24312 * @see elm_panes_content_left_size_get()
24316 EAPI void elm_panes_content_left_size_set(Evas_Object *obj, double size) EINA_ARG_NONNULL(1);
24319 * Set the orientation of a given panes widget.
24321 * @param obj The panes object.
24322 * @param horizontal Use @c EINA_TRUE to make @p obj to be
24323 * @b horizontal, @c EINA_FALSE to make it @b vertical.
24325 * Use this function to change how your panes is to be
24326 * disposed: vertically or horizontally.
24328 * By default it's displayed horizontally.
24330 * @see elm_panes_horizontal_get()
24334 EAPI void elm_panes_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
24337 * Retrieve the orientation of a given panes widget.
24339 * @param obj The panes object.
24340 * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
24341 * @c EINA_FALSE if it's @b vertical (and on errors).
24343 * @see elm_panes_horizontal_set() for more details.
24347 EAPI Eina_Bool elm_panes_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24348 EAPI void elm_panes_fixed_set(Evas_Object *obj, Eina_Bool fixed) EINA_ARG_NONNULL(1);
24349 EAPI Eina_Bool elm_panes_fixed_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24356 * @defgroup Flip Flip
24358 * @image html img/widget/flip/preview-00.png
24359 * @image latex img/widget/flip/preview-00.eps
24361 * This widget holds 2 content objects(Evas_Object): one on the front and one
24362 * on the back. It allows you to flip from front to back and vice-versa using
24363 * various animations.
24365 * If either the front or back contents are not set the flip will treat that
24366 * as transparent. So if you wore to set the front content but not the back,
24367 * and then call elm_flip_go() you would see whatever is below the flip.
24369 * For a list of supported animations see elm_flip_go().
24371 * Signals that you can add callbacks for are:
24372 * "animate,begin" - when a flip animation was started
24373 * "animate,done" - when a flip animation is finished
24375 * @ref tutorial_flip show how to use most of the API.
24379 typedef enum _Elm_Flip_Mode
24381 ELM_FLIP_ROTATE_Y_CENTER_AXIS,
24382 ELM_FLIP_ROTATE_X_CENTER_AXIS,
24383 ELM_FLIP_ROTATE_XZ_CENTER_AXIS,
24384 ELM_FLIP_ROTATE_YZ_CENTER_AXIS,
24385 ELM_FLIP_CUBE_LEFT,
24386 ELM_FLIP_CUBE_RIGHT,
24388 ELM_FLIP_CUBE_DOWN,
24389 ELM_FLIP_PAGE_LEFT,
24390 ELM_FLIP_PAGE_RIGHT,
24394 typedef enum _Elm_Flip_Interaction
24396 ELM_FLIP_INTERACTION_NONE,
24397 ELM_FLIP_INTERACTION_ROTATE,
24398 ELM_FLIP_INTERACTION_CUBE,
24399 ELM_FLIP_INTERACTION_PAGE
24400 } Elm_Flip_Interaction;
24401 typedef enum _Elm_Flip_Direction
24403 ELM_FLIP_DIRECTION_UP, /**< Allows interaction with the top of the widget */
24404 ELM_FLIP_DIRECTION_DOWN, /**< Allows interaction with the bottom of the widget */
24405 ELM_FLIP_DIRECTION_LEFT, /**< Allows interaction with the left portion of the widget */
24406 ELM_FLIP_DIRECTION_RIGHT /**< Allows interaction with the right portion of the widget */
24407 } Elm_Flip_Direction;
24409 * @brief Add a new flip to the parent
24411 * @param parent The parent object
24412 * @return The new object or NULL if it cannot be created
24414 EAPI Evas_Object *elm_flip_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24416 * @brief Set the front content of the flip widget.
24418 * @param obj The flip object
24419 * @param content The new front content object
24421 * Once the content object is set, a previously set one will be deleted.
24422 * If you want to keep that old content object, use the
24423 * elm_flip_content_front_unset() function.
24425 EAPI void elm_flip_content_front_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
24427 * @brief Set the back content of the flip widget.
24429 * @param obj The flip object
24430 * @param content The new back content object
24432 * Once the content object is set, a previously set one will be deleted.
24433 * If you want to keep that old content object, use the
24434 * elm_flip_content_back_unset() function.
24436 EAPI void elm_flip_content_back_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
24438 * @brief Get the front content used for the flip
24440 * @param obj The flip object
24441 * @return The front content object that is being used
24443 * Return the front content object which is set for this widget.
24445 EAPI Evas_Object *elm_flip_content_front_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24447 * @brief Get the back content used for the flip
24449 * @param obj The flip object
24450 * @return The back content object that is being used
24452 * Return the back content object which is set for this widget.
24454 EAPI Evas_Object *elm_flip_content_back_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24456 * @brief Unset the front content used for the flip
24458 * @param obj The flip object
24459 * @return The front content object that was being used
24461 * Unparent and return the front content object which was set for this widget.
24463 EAPI Evas_Object *elm_flip_content_front_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24465 * @brief Unset the back content used for the flip
24467 * @param obj The flip object
24468 * @return The back content object that was being used
24470 * Unparent and return the back content object which was set for this widget.
24472 EAPI Evas_Object *elm_flip_content_back_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24474 * @brief Get flip front visibility state
24476 * @param obj The flip objct
24477 * @return EINA_TRUE if front front is showing, EINA_FALSE if the back is
24480 EAPI Eina_Bool elm_flip_front_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24482 * @brief Set flip perspective
24484 * @param obj The flip object
24485 * @param foc The coordinate to set the focus on
24486 * @param x The X coordinate
24487 * @param y The Y coordinate
24489 * @warning This function currently does nothing.
24491 EAPI void elm_flip_perspective_set(Evas_Object *obj, Evas_Coord foc, Evas_Coord x, Evas_Coord y) EINA_ARG_NONNULL(1);
24493 * @brief Runs the flip animation
24495 * @param obj The flip object
24496 * @param mode The mode type
24498 * Flips the front and back contents using the @p mode animation. This
24499 * efectively hides the currently visible content and shows the hidden one.
24501 * There a number of possible animations to use for the flipping:
24502 * @li ELM_FLIP_ROTATE_X_CENTER_AXIS - Rotate the currently visible content
24503 * around a horizontal axis in the middle of its height, the other content
24504 * is shown as the other side of the flip.
24505 * @li ELM_FLIP_ROTATE_Y_CENTER_AXIS - Rotate the currently visible content
24506 * around a vertical axis in the middle of its width, the other content is
24507 * shown as the other side of the flip.
24508 * @li ELM_FLIP_ROTATE_XZ_CENTER_AXIS - Rotate the currently visible content
24509 * around a diagonal axis in the middle of its width, the other content is
24510 * shown as the other side of the flip.
24511 * @li ELM_FLIP_ROTATE_YZ_CENTER_AXIS - Rotate the currently visible content
24512 * around a diagonal axis in the middle of its height, the other content is
24513 * shown as the other side of the flip.
24514 * @li ELM_FLIP_CUBE_LEFT - Rotate the currently visible content to the left
24515 * as if the flip was a cube, the other content is show as the right face of
24517 * @li ELM_FLIP_CUBE_RIGHT - Rotate the currently visible content to the
24518 * right as if the flip was a cube, the other content is show as the left
24519 * face of the cube.
24520 * @li ELM_FLIP_CUBE_UP - Rotate the currently visible content up as if the
24521 * flip was a cube, the other content is show as the bottom face of the cube.
24522 * @li ELM_FLIP_CUBE_DOWN - Rotate the currently visible content down as if
24523 * the flip was a cube, the other content is show as the upper face of the
24525 * @li ELM_FLIP_PAGE_LEFT - Move the currently visible content to the left as
24526 * if the flip was a book, the other content is shown as the page below that.
24527 * @li ELM_FLIP_PAGE_RIGHT - Move the currently visible content to the right
24528 * as if the flip was a book, the other content is shown as the page below
24530 * @li ELM_FLIP_PAGE_UP - Move the currently visible content up as if the
24531 * flip was a book, the other content is shown as the page below that.
24532 * @li ELM_FLIP_PAGE_DOWN - Move the currently visible content down as if the
24533 * flip was a book, the other content is shown as the page below that.
24535 * @image html elm_flip.png
24536 * @image latex elm_flip.eps width=\textwidth
24538 EAPI void elm_flip_go(Evas_Object *obj, Elm_Flip_Mode mode) EINA_ARG_NONNULL(1);
24540 * @brief Set the interactive flip mode
24542 * @param obj The flip object
24543 * @param mode The interactive flip mode to use
24545 * This sets if the flip should be interactive (allow user to click and
24546 * drag a side of the flip to reveal the back page and cause it to flip).
24547 * By default a flip is not interactive. You may also need to set which
24548 * sides of the flip are "active" for flipping and how much space they use
24549 * (a minimum of a finger size) with elm_flip_interacton_direction_enabled_set()
24550 * and elm_flip_interacton_direction_hitsize_set()
24552 * The four avilable mode of interaction are:
24553 * @li ELM_FLIP_INTERACTION_NONE - No interaction is allowed
24554 * @li ELM_FLIP_INTERACTION_ROTATE - Interaction will cause rotate animation
24555 * @li ELM_FLIP_INTERACTION_CUBE - Interaction will cause cube animation
24556 * @li ELM_FLIP_INTERACTION_PAGE - Interaction will cause page animation
24558 * @note ELM_FLIP_INTERACTION_ROTATE won't cause
24559 * ELM_FLIP_ROTATE_XZ_CENTER_AXIS or ELM_FLIP_ROTATE_YZ_CENTER_AXIS to
24560 * happen, those can only be acheived with elm_flip_go();
24562 EAPI void elm_flip_interaction_set(Evas_Object *obj, Elm_Flip_Interaction mode);
24564 * @brief Get the interactive flip mode
24566 * @param obj The flip object
24567 * @return The interactive flip mode
24569 * Returns the interactive flip mode set by elm_flip_interaction_set()
24571 EAPI Elm_Flip_Interaction elm_flip_interaction_get(const Evas_Object *obj);
24573 * @brief Set which directions of the flip respond to interactive flip
24575 * @param obj The flip object
24576 * @param dir The direction to change
24577 * @param enabled If that direction is enabled or not
24579 * By default all directions are disabled, so you may want to enable the
24580 * desired directions for flipping if you need interactive flipping. You must
24581 * call this function once for each direction that should be enabled.
24583 * @see elm_flip_interaction_set()
24585 EAPI void elm_flip_interacton_direction_enabled_set(Evas_Object *obj, Elm_Flip_Direction dir, Eina_Bool enabled);
24587 * @brief Get the enabled state of that flip direction
24589 * @param obj The flip object
24590 * @param dir The direction to check
24591 * @return If that direction is enabled or not
24593 * Gets the enabled state set by elm_flip_interacton_direction_enabled_set()
24595 * @see elm_flip_interaction_set()
24597 EAPI Eina_Bool elm_flip_interacton_direction_enabled_get(Evas_Object *obj, Elm_Flip_Direction dir);
24599 * @brief Set the amount of the flip that is sensitive to interactive flip
24601 * @param obj The flip object
24602 * @param dir The direction to modify
24603 * @param hitsize The amount of that dimension (0.0 to 1.0) to use
24605 * Set the amount of the flip that is sensitive to interactive flip, with 0
24606 * representing no area in the flip and 1 representing the entire flip. There
24607 * is however a consideration to be made in that the area will never be
24608 * smaller than the finger size set(as set in your Elementary configuration).
24610 * @see elm_flip_interaction_set()
24612 EAPI void elm_flip_interacton_direction_hitsize_set(Evas_Object *obj, Elm_Flip_Direction dir, double hitsize);
24614 * @brief Get the amount of the flip that is sensitive to interactive flip
24616 * @param obj The flip object
24617 * @param dir The direction to check
24618 * @return The size set for that direction
24620 * Returns the amount os sensitive area set by
24621 * elm_flip_interacton_direction_hitsize_set().
24623 EAPI double elm_flip_interacton_direction_hitsize_get(Evas_Object *obj, Elm_Flip_Direction dir);
24628 /* scrolledentry */
24629 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24630 EINA_DEPRECATED EAPI void elm_scrolled_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line) EINA_ARG_NONNULL(1);
24631 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_single_line_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24632 EINA_DEPRECATED EAPI void elm_scrolled_entry_password_set(Evas_Object *obj, Eina_Bool password) EINA_ARG_NONNULL(1);
24633 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_password_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24634 EINA_DEPRECATED EAPI void elm_scrolled_entry_entry_set(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
24635 EINA_DEPRECATED EAPI const char *elm_scrolled_entry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24636 EINA_DEPRECATED EAPI void elm_scrolled_entry_entry_append(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
24637 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_is_empty(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24638 EINA_DEPRECATED EAPI const char *elm_scrolled_entry_selection_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24639 EINA_DEPRECATED EAPI void elm_scrolled_entry_entry_insert(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
24640 EINA_DEPRECATED EAPI void elm_scrolled_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
24641 EINA_DEPRECATED EAPI void elm_scrolled_entry_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
24642 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24643 EINA_DEPRECATED EAPI void elm_scrolled_entry_select_none(Evas_Object *obj) EINA_ARG_NONNULL(1);
24644 EINA_DEPRECATED EAPI void elm_scrolled_entry_select_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
24645 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
24646 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
24647 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_up(Evas_Object *obj) EINA_ARG_NONNULL(1);
24648 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_down(Evas_Object *obj) EINA_ARG_NONNULL(1);
24649 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
24650 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
24651 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_line_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
24652 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_line_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
24653 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_selection_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
24654 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_selection_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
24655 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_is_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24656 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_is_visible_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24657 EINA_DEPRECATED EAPI const char *elm_scrolled_entry_cursor_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24658 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_pos_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
24659 EINA_DEPRECATED EAPI int elm_scrolled_entry_cursor_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24660 EINA_DEPRECATED EAPI void elm_scrolled_entry_selection_cut(Evas_Object *obj) EINA_ARG_NONNULL(1);
24661 EINA_DEPRECATED EAPI void elm_scrolled_entry_selection_copy(Evas_Object *obj) EINA_ARG_NONNULL(1);
24662 EINA_DEPRECATED EAPI void elm_scrolled_entry_selection_paste(Evas_Object *obj) EINA_ARG_NONNULL(1);
24663 EINA_DEPRECATED EAPI void elm_scrolled_entry_context_menu_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
24664 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);
24665 EINA_DEPRECATED EAPI void elm_scrolled_entry_context_menu_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
24666 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_context_menu_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24667 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);
24668 EINA_DEPRECATED EAPI void elm_scrolled_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
24669 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);
24670 EINA_DEPRECATED EAPI void elm_scrolled_entry_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1, 2);
24671 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24672 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24673 EINA_DEPRECATED EAPI void elm_scrolled_entry_icon_visible_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
24674 EINA_DEPRECATED EAPI void elm_scrolled_entry_end_set(Evas_Object *obj, Evas_Object *end) EINA_ARG_NONNULL(1, 2);
24675 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_end_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24676 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_end_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24677 EINA_DEPRECATED EAPI void elm_scrolled_entry_end_visible_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
24678 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);
24679 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);
24680 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);
24681 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);
24682 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);
24683 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);
24684 EINA_DEPRECATED EAPI void elm_scrolled_entry_file_set(Evas_Object *obj, const char *file, Elm_Text_Format format) EINA_ARG_NONNULL(1);
24685 EINA_DEPRECATED EAPI void elm_scrolled_entry_file_get(const Evas_Object *obj, const char **file, Elm_Text_Format *format) EINA_ARG_NONNULL(1);
24686 EINA_DEPRECATED EAPI void elm_scrolled_entry_file_save(Evas_Object *obj) EINA_ARG_NONNULL(1);
24687 EINA_DEPRECATED EAPI void elm_scrolled_entry_autosave_set(Evas_Object *obj, Eina_Bool autosave) EINA_ARG_NONNULL(1);
24688 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_autosave_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24689 EINA_DEPRECATED EAPI void elm_scrolled_entry_cnp_textonly_set(Evas_Object *obj, Eina_Bool textonly) EINA_ARG_NONNULL(1);
24690 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cnp_textonly_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
24693 * @defgroup Conformant Conformant
24694 * @ingroup Elementary
24696 * @image html img/widget/conformant/preview-00.png
24697 * @image latex img/widget/conformant/preview-00.eps width=\textwidth
24699 * @image html img/conformant.png
24700 * @image latex img/conformant.eps width=\textwidth
24702 * The aim is to provide a widget that can be used in elementary apps to
24703 * account for space taken up by the indicator, virtual keypad & softkey
24704 * windows when running the illume2 module of E17.
24706 * So conformant content will be sized and positioned considering the
24707 * space required for such stuff, and when they popup, as a keyboard
24708 * shows when an entry is selected, conformant content won't change.
24710 * Available styles for it:
24713 * Default contents parts of the conformant widget that you can use for are:
24714 * @li "default" - A content of the conformant
24716 * See how to use this widget in this example:
24717 * @ref conformant_example
24721 * @addtogroup Conformant
24726 * Add a new conformant widget to the given parent Elementary
24727 * (container) object.
24729 * @param parent The parent object.
24730 * @return A new conformant widget handle or @c NULL, on errors.
24732 * This function inserts a new conformant widget on the canvas.
24734 * @ingroup Conformant
24736 EAPI Evas_Object *elm_conformant_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24739 * Set the content of the conformant widget.
24741 * @param obj The conformant object.
24742 * @param content The content to be displayed by the conformant.
24744 * Content will be sized and positioned considering the space required
24745 * to display a virtual keyboard. So it won't fill all the conformant
24746 * size. This way is possible to be sure that content won't resize
24747 * or be re-positioned after the keyboard is displayed.
24749 * Once the content object is set, a previously set one will be deleted.
24750 * If you want to keep that old content object, use the
24751 * elm_object_content_unset() function.
24753 * @see elm_object_content_unset()
24754 * @see elm_object_content_get()
24756 * @deprecated use elm_object_content_set() instead
24758 * @ingroup Conformant
24760 EINA_DEPRECATED EAPI void elm_conformant_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
24763 * Get the content of the conformant widget.
24765 * @param obj The conformant object.
24766 * @return The content that is being used.
24768 * Return the content object which is set for this widget.
24769 * It won't be unparent from conformant. For that, use
24770 * elm_object_content_unset().
24772 * @see elm_object_content_set().
24773 * @see elm_object_content_unset()
24775 * @deprecated use elm_object_content_get() instead
24777 * @ingroup Conformant
24779 EINA_DEPRECATED EAPI Evas_Object *elm_conformant_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24782 * Unset the content of the conformant widget.
24784 * @param obj The conformant object.
24785 * @return The content that was being used.
24787 * Unparent and return the content object which was set for this widget.
24789 * @see elm_object_content_set().
24791 * @deprecated use elm_object_content_unset() instead
24793 * @ingroup Conformant
24795 EINA_DEPRECATED EAPI Evas_Object *elm_conformant_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24798 * Returns the Evas_Object that represents the content area.
24800 * @param obj The conformant object.
24801 * @return The content area of the widget.
24803 * @ingroup Conformant
24805 EAPI Evas_Object *elm_conformant_content_area_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24812 * @defgroup Mapbuf Mapbuf
24813 * @ingroup Elementary
24815 * @image html img/widget/mapbuf/preview-00.png
24816 * @image latex img/widget/mapbuf/preview-00.eps width=\textwidth
24818 * This holds one content object and uses an Evas Map of transformation
24819 * points to be later used with this content. So the content will be
24820 * moved, resized, etc as a single image. So it will improve performance
24821 * when you have a complex interafce, with a lot of elements, and will
24822 * need to resize or move it frequently (the content object and its
24825 * Default contents parts of the mapbuf widget that you can use for are:
24826 * @li "default" - A content of the mapbuf
24828 * To enable map, elm_mapbuf_enabled_set() should be used.
24830 * See how to use this widget in this example:
24831 * @ref mapbuf_example
24835 * @addtogroup Mapbuf
24840 * Add a new mapbuf widget to the given parent Elementary
24841 * (container) object.
24843 * @param parent The parent object.
24844 * @return A new mapbuf widget handle or @c NULL, on errors.
24846 * This function inserts a new mapbuf widget on the canvas.
24850 EAPI Evas_Object *elm_mapbuf_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24853 * Set the content of the mapbuf.
24855 * @param obj The mapbuf object.
24856 * @param content The content that will be filled in this mapbuf object.
24858 * Once the content object is set, a previously set one will be deleted.
24859 * If you want to keep that old content object, use the
24860 * elm_mapbuf_content_unset() function.
24862 * To enable map, elm_mapbuf_enabled_set() should be used.
24864 * @deprecated use elm_object_content_set() instead
24868 EINA_DEPRECATED EAPI void elm_mapbuf_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
24871 * Get the content of the mapbuf.
24873 * @param obj The mapbuf object.
24874 * @return The content that is being used.
24876 * Return the content object which is set for this widget.
24878 * @see elm_mapbuf_content_set() for details.
24880 * @deprecated use elm_object_content_get() instead
24884 EINA_DEPRECATED EAPI Evas_Object *elm_mapbuf_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24887 * Unset the content of the mapbuf.
24889 * @param obj The mapbuf object.
24890 * @return The content that was being used.
24892 * Unparent and return the content object which was set for this widget.
24894 * @see elm_mapbuf_content_set() for details.
24896 * @deprecated use elm_object_content_unset() instead
24900 EINA_DEPRECATED EAPI Evas_Object *elm_mapbuf_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24903 * Enable or disable the map.
24905 * @param obj The mapbuf object.
24906 * @param enabled @c EINA_TRUE to enable map or @c EINA_FALSE to disable it.
24908 * This enables the map that is set or disables it. On enable, the object
24909 * geometry will be saved, and the new geometry will change (position and
24910 * size) to reflect the map geometry set.
24912 * Also, when enabled, alpha and smooth states will be used, so if the
24913 * content isn't solid, alpha should be enabled, for example, otherwise
24914 * a black retangle will fill the content.
24916 * When disabled, the stored map will be freed and geometry prior to
24917 * enabling the map will be restored.
24919 * It's disabled by default.
24921 * @see elm_mapbuf_alpha_set()
24922 * @see elm_mapbuf_smooth_set()
24926 EAPI void elm_mapbuf_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
24929 * Get a value whether map is enabled or not.
24931 * @param obj The mapbuf object.
24932 * @return @c EINA_TRUE means map is enabled. @c EINA_FALSE indicates
24933 * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
24935 * @see elm_mapbuf_enabled_set() for details.
24939 EAPI Eina_Bool elm_mapbuf_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24942 * Enable or disable smooth map rendering.
24944 * @param obj The mapbuf object.
24945 * @param smooth @c EINA_TRUE to enable smooth map rendering or @c EINA_FALSE
24948 * This sets smoothing for map rendering. If the object is a type that has
24949 * its own smoothing settings, then both the smooth settings for this object
24950 * and the map must be turned off.
24952 * By default smooth maps are enabled.
24956 EAPI void elm_mapbuf_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
24959 * Get a value whether smooth map rendering is enabled or not.
24961 * @param obj The mapbuf object.
24962 * @return @c EINA_TRUE means smooth map rendering is enabled. @c EINA_FALSE
24963 * indicates it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
24965 * @see elm_mapbuf_smooth_set() for details.
24969 EAPI Eina_Bool elm_mapbuf_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24972 * Set or unset alpha flag for map rendering.
24974 * @param obj The mapbuf object.
24975 * @param alpha @c EINA_TRUE to enable alpha blending or @c EINA_FALSE
24978 * This sets alpha flag for map rendering. If the object is a type that has
24979 * its own alpha settings, then this will take precedence. Only image objects
24980 * have this currently. It stops alpha blending of the map area, and is
24981 * useful if you know the object and/or all sub-objects is 100% solid.
24983 * Alpha is enabled by default.
24987 EAPI void elm_mapbuf_alpha_set(Evas_Object *obj, Eina_Bool alpha) EINA_ARG_NONNULL(1);
24990 * Get a value whether alpha blending is enabled or not.
24992 * @param obj The mapbuf object.
24993 * @return @c EINA_TRUE means alpha blending is enabled. @c EINA_FALSE
24994 * indicates it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
24996 * @see elm_mapbuf_alpha_set() for details.
25000 EAPI Eina_Bool elm_mapbuf_alpha_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25007 * @defgroup Flipselector Flip Selector
25009 * @image html img/widget/flipselector/preview-00.png
25010 * @image latex img/widget/flipselector/preview-00.eps
25012 * A flip selector is a widget to show a set of @b text items, one
25013 * at a time, with the same sheet switching style as the @ref Clock
25014 * "clock" widget, when one changes the current displaying sheet
25015 * (thus, the "flip" in the name).
25017 * User clicks to flip sheets which are @b held for some time will
25018 * make the flip selector to flip continuosly and automatically for
25019 * the user. The interval between flips will keep growing in time,
25020 * so that it helps the user to reach an item which is distant from
25021 * the current selection.
25023 * Smart callbacks one can register to:
25024 * - @c "selected" - when the widget's selected text item is changed
25025 * - @c "overflowed" - when the widget's current selection is changed
25026 * from the first item in its list to the last
25027 * - @c "underflowed" - when the widget's current selection is changed
25028 * from the last item in its list to the first
25030 * Available styles for it:
25033 * To set/get the label of the flipselector item, you can use
25034 * elm_object_item_text_set/get APIs.
25035 * Once the text is set, a previously set one will be deleted.
25037 * Here is an example on its usage:
25038 * @li @ref flipselector_example
25042 * @addtogroup Flipselector
25047 * Add a new flip selector widget to the given parent Elementary
25048 * (container) widget
25050 * @param parent The parent object
25051 * @return a new flip selector widget handle or @c NULL, on errors
25053 * This function inserts a new flip selector widget on the canvas.
25055 * @ingroup Flipselector
25057 EAPI Evas_Object *elm_flipselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
25060 * Programmatically select the next item of a flip selector widget
25062 * @param obj The flipselector object
25064 * @note The selection will be animated. Also, if it reaches the
25065 * end of its list of member items, it will continue with the first
25068 * @ingroup Flipselector
25070 EAPI void elm_flipselector_flip_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
25073 * Programmatically select the previous item of a flip selector
25076 * @param obj The flipselector object
25078 * @note The selection will be animated. Also, if it reaches the
25079 * beginning of its list of member items, it will continue with the
25080 * last one backwards.
25082 * @ingroup Flipselector
25084 EAPI void elm_flipselector_flip_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
25087 * Append a (text) item to a flip selector widget
25089 * @param obj The flipselector object
25090 * @param label The (text) label of the new item
25091 * @param func Convenience callback function to take place when
25093 * @param data Data passed to @p func, above
25094 * @return A handle to the item added or @c NULL, on errors
25096 * The widget's list of labels to show will be appended with the
25097 * given value. If the user wishes so, a callback function pointer
25098 * can be passed, which will get called when this same item is
25101 * @note The current selection @b won't be modified by appending an
25102 * element to the list.
25104 * @note The maximum length of the text label is going to be
25105 * determined <b>by the widget's theme</b>. Strings larger than
25106 * that value are going to be @b truncated.
25108 * @ingroup Flipselector
25110 EAPI Elm_Object_Item *elm_flipselector_item_append(Evas_Object *obj, const char *label, Evas_Smart_Cb func, void *data) EINA_ARG_NONNULL(1);
25113 * Prepend a (text) item to a flip selector widget
25115 * @param obj The flipselector object
25116 * @param label The (text) label of the new item
25117 * @param func Convenience callback function to take place when
25119 * @param data Data passed to @p func, above
25120 * @return A handle to the item added or @c NULL, on errors
25122 * The widget's list of labels to show will be prepended with the
25123 * given value. If the user wishes so, a callback function pointer
25124 * can be passed, which will get called when this same item is
25127 * @note The current selection @b won't be modified by prepending
25128 * an element to the list.
25130 * @note The maximum length of the text label is going to be
25131 * determined <b>by the widget's theme</b>. Strings larger than
25132 * that value are going to be @b truncated.
25134 * @ingroup Flipselector
25136 EAPI Elm_Object_Item *elm_flipselector_item_prepend(Evas_Object *obj, const char *label, Evas_Smart_Cb func, void *data) EINA_ARG_NONNULL(1);
25139 * Get the internal list of items in a given flip selector widget.
25141 * @param obj The flipselector object
25142 * @return The list of items (#Elm_Object_Item as data) or
25143 * @c NULL on errors.
25145 * This list is @b not to be modified in any way and must not be
25146 * freed. Use the list members with functions like
25147 * elm_object_item_text_set(),
25148 * elm_object_item_text_get(),
25149 * elm_flipselector_item_del(),
25150 * elm_flipselector_item_selected_get(),
25151 * elm_flipselector_item_selected_set().
25153 * @warning This list is only valid until @p obj object's internal
25154 * items list is changed. It should be fetched again with another
25155 * call to this function when changes happen.
25157 * @ingroup Flipselector
25159 EAPI const Eina_List *elm_flipselector_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25162 * Get the first item in the given flip selector widget's list of
25165 * @param obj The flipselector object
25166 * @return The first item or @c NULL, if it has no items (and on
25169 * @see elm_flipselector_item_append()
25170 * @see elm_flipselector_last_item_get()
25172 * @ingroup Flipselector
25174 EAPI Elm_Object_Item *elm_flipselector_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25177 * Get the last item in the given flip selector widget's list of
25180 * @param obj The flipselector object
25181 * @return The last item or @c NULL, if it has no items (and on
25184 * @see elm_flipselector_item_prepend()
25185 * @see elm_flipselector_first_item_get()
25187 * @ingroup Flipselector
25189 EAPI Elm_Object_Item *elm_flipselector_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25192 * Get the currently selected item in a flip selector widget.
25194 * @param obj The flipselector object
25195 * @return The selected item or @c NULL, if the widget has no items
25198 * @ingroup Flipselector
25200 EAPI Elm_Object_Item *elm_flipselector_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25203 * Set whether a given flip selector widget's item should be the
25204 * currently selected one.
25206 * @param it The flip selector item
25207 * @param selected @c EINA_TRUE to select it, @c EINA_FALSE to unselect.
25209 * This sets whether @p item is or not the selected (thus, under
25210 * display) one. If @p item is different than one under display,
25211 * the latter will be unselected. If the @p item is set to be
25212 * unselected, on the other hand, the @b first item in the widget's
25213 * internal members list will be the new selected one.
25215 * @see elm_flipselector_item_selected_get()
25217 * @ingroup Flipselector
25219 EAPI void elm_flipselector_item_selected_set(Elm_Object_Item *it, Eina_Bool selected) EINA_ARG_NONNULL(1);
25222 * Get whether a given flip selector widget's item is the currently
25225 * @param it The flip selector item
25226 * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
25229 * @see elm_flipselector_item_selected_set()
25231 * @ingroup Flipselector
25233 EAPI Eina_Bool elm_flipselector_item_selected_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
25236 * Delete a given item from a flip selector widget.
25238 * @param it The item to delete
25240 * @ingroup Flipselector
25242 EAPI void elm_flipselector_item_del(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
25245 * Get the label of a given flip selector widget's item.
25247 * @param it The item to get label from
25248 * @return The text label of @p item or @c NULL, on errors
25250 * @see elm_object_item_text_set()
25252 * @deprecated see elm_object_item_text_get() instead
25253 * @ingroup Flipselector
25255 EINA_DEPRECATED EAPI const char *elm_flipselector_item_label_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
25258 * Set the label of a given flip selector widget's item.
25260 * @param it The item to set label on
25261 * @param label The text label string, in UTF-8 encoding
25263 * @see elm_object_item_text_get()
25265 * @deprecated see elm_object_item_text_set() instead
25266 * @ingroup Flipselector
25268 EINA_DEPRECATED EAPI void elm_flipselector_item_label_set(Elm_Object_Item *it, const char *label) EINA_ARG_NONNULL(1);
25271 * Gets the item before @p item in a flip selector widget's
25272 * internal list of items.
25274 * @param it The item to fetch previous from
25275 * @return The item before the @p item, in its parent's list. If
25276 * there is no previous item for @p item or there's an
25277 * error, @c NULL is returned.
25279 * @see elm_flipselector_item_next_get()
25281 * @ingroup Flipselector
25283 EAPI Elm_Object_Item *elm_flipselector_item_prev_get(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
25286 * Gets the item after @p item in a flip selector widget's
25287 * internal list of items.
25289 * @param it The item to fetch next from
25290 * @return The item after the @p item, in its parent's list. If
25291 * there is no next item for @p item or there's an
25292 * error, @c NULL is returned.
25294 * @see elm_flipselector_item_next_get()
25296 * @ingroup Flipselector
25298 EAPI Elm_Object_Item *elm_flipselector_item_next_get(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
25301 * Set the interval on time updates for an user mouse button hold
25302 * on a flip selector widget.
25304 * @param obj The flip selector object
25305 * @param interval The (first) interval value in seconds
25307 * This interval value is @b decreased while the user holds the
25308 * mouse pointer either flipping up or flipping doww a given flip
25311 * This helps the user to get to a given item distant from the
25312 * current one easier/faster, as it will start to flip quicker and
25313 * quicker on mouse button holds.
25315 * The calculation for the next flip interval value, starting from
25316 * the one set with this call, is the previous interval divided by
25317 * 1.05, so it decreases a little bit.
25319 * The default starting interval value for automatic flips is
25322 * @see elm_flipselector_interval_get()
25324 * @ingroup Flipselector
25326 EAPI void elm_flipselector_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
25329 * Get the interval on time updates for an user mouse button hold
25330 * on a flip selector widget.
25332 * @param obj The flip selector object
25333 * @return The (first) interval value, in seconds, set on it
25335 * @see elm_flipselector_interval_set() for more details
25337 * @ingroup Flipselector
25339 EAPI double elm_flipselector_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25345 * @addtogroup Calendar
25350 * @enum _Elm_Calendar_Mark_Repeat
25351 * @typedef Elm_Calendar_Mark_Repeat
25353 * Event periodicity, used to define if a mark should be repeated
25354 * @b beyond event's day. It's set when a mark is added.
25356 * So, for a mark added to 13th May with periodicity set to WEEKLY,
25357 * there will be marks every week after this date. Marks will be displayed
25358 * at 13th, 20th, 27th, 3rd June ...
25360 * Values don't work as bitmask, only one can be choosen.
25362 * @see elm_calendar_mark_add()
25364 * @ingroup Calendar
25366 typedef enum _Elm_Calendar_Mark_Repeat
25368 ELM_CALENDAR_UNIQUE, /**< Default value. Marks will be displayed only on event day. */
25369 ELM_CALENDAR_DAILY, /**< Marks will be displayed everyday after event day (inclusive). */
25370 ELM_CALENDAR_WEEKLY, /**< Marks will be displayed every week after event day (inclusive) - i.e. each seven days. */
25371 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*/
25372 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. */
25373 } Elm_Calendar_Mark_Repeat;
25375 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(). */
25378 * Add a new calendar widget to the given parent Elementary
25379 * (container) object.
25381 * @param parent The parent object.
25382 * @return a new calendar widget handle or @c NULL, on errors.
25384 * This function inserts a new calendar widget on the canvas.
25386 * @ref calendar_example_01
25388 * @ingroup Calendar
25390 EAPI Evas_Object *elm_calendar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
25393 * Get weekdays names displayed by the calendar.
25395 * @param obj The calendar object.
25396 * @return Array of seven strings to be used as weekday names.
25398 * By default, weekdays abbreviations get from system are displayed:
25399 * E.g. for an en_US locale: "Sun, Mon, Tue, Wed, Thu, Fri, Sat"
25400 * The first string is related to Sunday, the second to Monday...
25402 * @see elm_calendar_weekdays_name_set()
25404 * @ref calendar_example_05
25406 * @ingroup Calendar
25408 EAPI const char **elm_calendar_weekdays_names_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25411 * Set weekdays names to be displayed by the calendar.
25413 * @param obj The calendar object.
25414 * @param weekdays Array of seven strings to be used as weekday names.
25415 * @warning It must have 7 elements, or it will access invalid memory.
25416 * @warning The strings must be NULL terminated ('@\0').
25418 * By default, weekdays abbreviations get from system are displayed:
25419 * E.g. for an en_US locale: "Sun, Mon, Tue, Wed, Thu, Fri, Sat"
25421 * The first string should be related to Sunday, the second to Monday...
25423 * The usage should be like this:
25425 * const char *weekdays[] =
25427 * "Sunday", "Monday", "Tuesday", "Wednesday",
25428 * "Thursday", "Friday", "Saturday"
25430 * elm_calendar_weekdays_names_set(calendar, weekdays);
25433 * @see elm_calendar_weekdays_name_get()
25435 * @ref calendar_example_02
25437 * @ingroup Calendar
25439 EAPI void elm_calendar_weekdays_names_set(Evas_Object *obj, const char *weekdays[]) EINA_ARG_NONNULL(1, 2);
25442 * Set the minimum and maximum values for the year
25444 * @param obj The calendar object
25445 * @param min The minimum year, greater than 1901;
25446 * @param max The maximum year;
25448 * Maximum must be greater than minimum, except if you don't wan't to set
25450 * Default values are 1902 and -1.
25452 * If the maximum year is a negative value, it will be limited depending
25453 * on the platform architecture (year 2037 for 32 bits);
25455 * @see elm_calendar_min_max_year_get()
25457 * @ref calendar_example_03
25459 * @ingroup Calendar
25461 EAPI void elm_calendar_min_max_year_set(Evas_Object *obj, int min, int max) EINA_ARG_NONNULL(1);
25464 * Get the minimum and maximum values for the year
25466 * @param obj The calendar object.
25467 * @param min The minimum year.
25468 * @param max The maximum year.
25470 * Default values are 1902 and -1.
25472 * @see elm_calendar_min_max_year_get() for more details.
25474 * @ref calendar_example_05
25476 * @ingroup Calendar
25478 EAPI void elm_calendar_min_max_year_get(const Evas_Object *obj, int *min, int *max) EINA_ARG_NONNULL(1);
25481 * Enable or disable day selection
25483 * @param obj The calendar object.
25484 * @param enabled @c EINA_TRUE to enable selection or @c EINA_FALSE to
25487 * Enabled by default. If disabled, the user still can select months,
25488 * but not days. Selected days are highlighted on calendar.
25489 * It should be used if you won't need such selection for the widget usage.
25491 * When a day is selected, or month is changed, smart callbacks for
25492 * signal "changed" will be called.
25494 * @see elm_calendar_day_selection_enable_get()
25496 * @ref calendar_example_04
25498 * @ingroup Calendar
25500 EAPI void elm_calendar_day_selection_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
25503 * Get a value whether day selection is enabled or not.
25505 * @see elm_calendar_day_selection_enable_set() for details.
25507 * @param obj The calendar object.
25508 * @return EINA_TRUE means day selection is enabled. EINA_FALSE indicates
25509 * it's disabled. If @p obj is NULL, EINA_FALSE is returned.
25511 * @ref calendar_example_05
25513 * @ingroup Calendar
25515 EAPI Eina_Bool elm_calendar_day_selection_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25519 * Set selected date to be highlighted on calendar.
25521 * @param obj The calendar object.
25522 * @param selected_time A @b tm struct to represent the selected date.
25524 * Set the selected date, changing the displayed month if needed.
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_04
25532 * @ingroup Calendar
25534 EAPI void elm_calendar_selected_time_set(Evas_Object *obj, struct tm *selected_time) EINA_ARG_NONNULL(1);
25537 * Get selected date.
25539 * @param obj The calendar object
25540 * @param selected_time A @b tm struct to point to selected date
25541 * @return EINA_FALSE means an error ocurred and returned time shouldn't
25544 * Get date selected by the user or set by function
25545 * elm_calendar_selected_time_set().
25546 * Selected date changes when the user goes to next/previous month or
25547 * select a day pressing over it on calendar.
25549 * @see elm_calendar_selected_time_get()
25551 * @ref calendar_example_05
25553 * @ingroup Calendar
25555 EAPI Eina_Bool elm_calendar_selected_time_get(const Evas_Object *obj, struct tm *selected_time) EINA_ARG_NONNULL(1, 2);
25558 * Set a function to format the string that will be used to display
25561 * @param obj The calendar object
25562 * @param format_function Function to set the month-year string given
25563 * the selected date
25565 * By default it uses strftime with "%B %Y" format string.
25566 * It should allocate the memory that will be used by the string,
25567 * that will be freed by the widget after usage.
25568 * A pointer to the string and a pointer to the time struct will be provided.
25573 * _format_month_year(struct tm *selected_time)
25576 * if (!strftime(buf, sizeof(buf), "%B %Y", selected_time)) return NULL;
25577 * return strdup(buf);
25580 * elm_calendar_format_function_set(calendar, _format_month_year);
25583 * @ref calendar_example_02
25585 * @ingroup Calendar
25587 EAPI void elm_calendar_format_function_set(Evas_Object *obj, char * (*format_function) (struct tm *stime)) EINA_ARG_NONNULL(1);
25590 * Add a new mark to the calendar
25592 * @param obj The calendar object
25593 * @param mark_type A string used to define the type of mark. It will be
25594 * emitted to the theme, that should display a related modification on these
25595 * days representation.
25596 * @param mark_time A time struct to represent the date of inclusion of the
25597 * mark. For marks that repeats it will just be displayed after the inclusion
25598 * date in the calendar.
25599 * @param repeat Repeat the event following this periodicity. Can be a unique
25600 * mark (that don't repeat), daily, weekly, monthly or annually.
25601 * @return The created mark or @p NULL upon failure.
25603 * Add a mark that will be drawn in the calendar respecting the insertion
25604 * time and periodicity. It will emit the type as signal to the widget theme.
25605 * Default theme supports "holiday" and "checked", but it can be extended.
25607 * It won't immediately update the calendar, drawing the marks.
25608 * For this, call elm_calendar_marks_draw(). However, when user selects
25609 * next or previous month calendar forces marks drawn.
25611 * Marks created with this method can be deleted with
25612 * elm_calendar_mark_del().
25616 * struct tm selected_time;
25617 * time_t current_time;
25619 * current_time = time(NULL) + 5 * 84600;
25620 * localtime_r(¤t_time, &selected_time);
25621 * elm_calendar_mark_add(cal, "holiday", selected_time,
25622 * ELM_CALENDAR_ANNUALLY);
25624 * current_time = time(NULL) + 1 * 84600;
25625 * localtime_r(¤t_time, &selected_time);
25626 * elm_calendar_mark_add(cal, "checked", selected_time, ELM_CALENDAR_UNIQUE);
25628 * elm_calendar_marks_draw(cal);
25631 * @see elm_calendar_marks_draw()
25632 * @see elm_calendar_mark_del()
25634 * @ref calendar_example_06
25636 * @ingroup Calendar
25638 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);
25641 * Delete mark from the calendar.
25643 * @param mark The mark to be deleted.
25645 * If deleting all calendar marks is required, elm_calendar_marks_clear()
25646 * should be used instead of getting marks list and deleting each one.
25648 * @see elm_calendar_mark_add()
25650 * @ref calendar_example_06
25652 * @ingroup Calendar
25654 EAPI void elm_calendar_mark_del(Elm_Calendar_Mark *mark) EINA_ARG_NONNULL(1);
25657 * Remove all calendar's marks
25659 * @param obj The calendar object.
25661 * @see elm_calendar_mark_add()
25662 * @see elm_calendar_mark_del()
25664 * @ingroup Calendar
25666 EAPI void elm_calendar_marks_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
25670 * Get a list of all the calendar marks.
25672 * @param obj The calendar object.
25673 * @return An @c Eina_List of calendar marks objects, or @c NULL on failure.
25675 * @see elm_calendar_mark_add()
25676 * @see elm_calendar_mark_del()
25677 * @see elm_calendar_marks_clear()
25679 * @ingroup Calendar
25681 EAPI const Eina_List *elm_calendar_marks_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25684 * Draw calendar marks.
25686 * @param obj The calendar object.
25688 * Should be used after adding, removing or clearing marks.
25689 * It will go through the entire marks list updating the calendar.
25690 * If lots of marks will be added, add all the marks and then call
25693 * When the month is changed, i.e. user selects next or previous month,
25694 * marks will be drawed.
25696 * @see elm_calendar_mark_add()
25697 * @see elm_calendar_mark_del()
25698 * @see elm_calendar_marks_clear()
25700 * @ref calendar_example_06
25702 * @ingroup Calendar
25704 EAPI void elm_calendar_marks_draw(Evas_Object *obj) EINA_ARG_NONNULL(1);
25707 * Set a day text color to the same that represents Saturdays.
25709 * @param obj The calendar object.
25710 * @param pos The text position. Position is the cell counter, from left
25711 * to right, up to down. It starts on 0 and ends on 41.
25713 * @deprecated use elm_calendar_mark_add() instead like:
25716 * struct tm t = { 0, 0, 12, 6, 0, 0, 6, 6, -1 };
25717 * elm_calendar_mark_add(obj, "sat", &t, ELM_CALENDAR_WEEKLY);
25720 * @see elm_calendar_mark_add()
25722 * @ingroup Calendar
25724 EINA_DEPRECATED EAPI void elm_calendar_text_saturday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
25727 * Set a day text color to the same that represents Sundays.
25729 * @param obj The calendar object.
25730 * @param pos The text position. Position is the cell counter, from left
25731 * to right, up to down. It starts on 0 and ends on 41.
25733 * @deprecated use elm_calendar_mark_add() instead like:
25736 * struct tm t = { 0, 0, 12, 7, 0, 0, 0, 0, -1 };
25737 * elm_calendar_mark_add(obj, "sat", &t, ELM_CALENDAR_WEEKLY);
25740 * @see elm_calendar_mark_add()
25742 * @ingroup Calendar
25744 EINA_DEPRECATED EAPI void elm_calendar_text_sunday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
25747 * Set a day text color to the same that represents Weekdays.
25749 * @param obj The calendar object
25750 * @param pos The text position. Position is the cell counter, from left
25751 * to right, up to down. It starts on 0 and ends on 41.
25753 * @deprecated use elm_calendar_mark_add() instead like:
25756 * struct tm t = { 0, 0, 12, 1, 0, 0, 0, 0, -1 };
25758 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // monday
25759 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
25760 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // tuesday
25761 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
25762 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // wednesday
25763 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
25764 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // thursday
25765 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
25766 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // friday
25769 * @see elm_calendar_mark_add()
25771 * @ingroup Calendar
25773 EINA_DEPRECATED EAPI void elm_calendar_text_weekday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
25776 * Set the interval on time updates for an user mouse button hold
25777 * on calendar widgets' month selection.
25779 * @param obj The calendar object
25780 * @param interval The (first) interval value in seconds
25782 * This interval value is @b decreased while the user holds the
25783 * mouse pointer either selecting next or previous month.
25785 * This helps the user to get to a given month distant from the
25786 * current one easier/faster, as it will start to change quicker and
25787 * quicker on mouse button holds.
25789 * The calculation for the next change interval value, starting from
25790 * the one set with this call, is the previous interval divided by
25791 * 1.05, so it decreases a little bit.
25793 * The default starting interval value for automatic changes is
25796 * @see elm_calendar_interval_get()
25798 * @ingroup Calendar
25800 EAPI void elm_calendar_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
25803 * Get the interval on time updates for an user mouse button hold
25804 * on calendar widgets' month selection.
25806 * @param obj The calendar object
25807 * @return The (first) interval value, in seconds, set on it
25809 * @see elm_calendar_interval_set() for more details
25811 * @ingroup Calendar
25813 EAPI double elm_calendar_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25820 * @defgroup Diskselector Diskselector
25821 * @ingroup Elementary
25823 * @image html img/widget/diskselector/preview-00.png
25824 * @image latex img/widget/diskselector/preview-00.eps
25826 * A diskselector is a kind of list widget. It scrolls horizontally,
25827 * and can contain label and icon objects. Three items are displayed
25828 * with the selected one in the middle.
25830 * It can act like a circular list with round mode and labels can be
25831 * reduced for a defined length for side items.
25833 * Smart callbacks one can listen to:
25834 * - "selected" - when item is selected, i.e. scroller stops.
25836 * Available styles for it:
25839 * List of examples:
25840 * @li @ref diskselector_example_01
25841 * @li @ref diskselector_example_02
25845 * @addtogroup Diskselector
25849 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(). */
25852 * Add a new diskselector widget to the given parent Elementary
25853 * (container) object.
25855 * @param parent The parent object.
25856 * @return a new diskselector widget handle or @c NULL, on errors.
25858 * This function inserts a new diskselector widget on the canvas.
25860 * @ingroup Diskselector
25862 EAPI Evas_Object *elm_diskselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
25865 * Enable or disable round mode.
25867 * @param obj The diskselector object.
25868 * @param round @c EINA_TRUE to enable round mode or @c EINA_FALSE to
25871 * Disabled by default. If round mode is enabled the items list will
25872 * work like a circle list, so when the user reaches the last item,
25873 * the first one will popup.
25875 * @see elm_diskselector_round_get()
25877 * @ingroup Diskselector
25879 EAPI void elm_diskselector_round_set(Evas_Object *obj, Eina_Bool round) EINA_ARG_NONNULL(1);
25882 * Get a value whether round mode is enabled or not.
25884 * @see elm_diskselector_round_set() for details.
25886 * @param obj The diskselector object.
25887 * @return @c EINA_TRUE means round mode is enabled. @c EINA_FALSE indicates
25888 * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
25890 * @ingroup Diskselector
25892 EAPI Eina_Bool elm_diskselector_round_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25895 * Get the side labels max length.
25897 * @deprecated use elm_diskselector_side_label_length_get() instead:
25899 * @param obj The diskselector object.
25900 * @return The max length defined for side labels, or 0 if not a valid
25903 * @ingroup Diskselector
25905 EINA_DEPRECATED EAPI int elm_diskselector_side_label_lenght_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25908 * Set the side labels max length.
25910 * @deprecated use elm_diskselector_side_label_length_set() instead:
25912 * @param obj The diskselector object.
25913 * @param len The max length defined for side labels.
25915 * @ingroup Diskselector
25917 EINA_DEPRECATED EAPI void elm_diskselector_side_label_lenght_set(Evas_Object *obj, int len) EINA_ARG_NONNULL(1);
25920 * Get the side labels max length.
25922 * @see elm_diskselector_side_label_length_set() for details.
25924 * @param obj The diskselector object.
25925 * @return The max length defined for side labels, or 0 if not a valid
25928 * @ingroup Diskselector
25930 EAPI int elm_diskselector_side_label_length_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25933 * Set the side labels max length.
25935 * @param obj The diskselector object.
25936 * @param len The max length defined for side labels.
25938 * Length is the number of characters of items' label that will be
25939 * visible when it's set on side positions. It will just crop
25940 * the string after defined size. E.g.:
25942 * An item with label "January" would be displayed on side position as
25943 * "Jan" if max length is set to 3, or "Janu", if this property
25946 * When it's selected, the entire label will be displayed, except for
25947 * width restrictions. In this case label will be cropped and "..."
25948 * will be concatenated.
25950 * Default side label max length is 3.
25952 * This property will be applyed over all items, included before or
25953 * later this function call.
25955 * @ingroup Diskselector
25957 EAPI void elm_diskselector_side_label_length_set(Evas_Object *obj, int len) EINA_ARG_NONNULL(1);
25960 * Set the number of items to be displayed.
25962 * @param obj The diskselector object.
25963 * @param num The number of items the diskselector will display.
25965 * Default value is 3, and also it's the minimun. If @p num is less
25966 * than 3, it will be set to 3.
25968 * Also, it can be set on theme, using data item @c display_item_num
25969 * on group "elm/diskselector/item/X", where X is style set.
25972 * group { name: "elm/diskselector/item/X";
25974 * item: "display_item_num" "5";
25977 * @ingroup Diskselector
25979 EAPI void elm_diskselector_display_item_num_set(Evas_Object *obj, int num) EINA_ARG_NONNULL(1);
25982 * Get the number of items in the diskselector object.
25984 * @param obj The diskselector object.
25986 * @ingroup Diskselector
25988 EAPI int elm_diskselector_display_item_num_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25991 * Set bouncing behaviour when the scrolled content reaches an edge.
25993 * Tell the internal scroller object whether it should bounce or not
25994 * when it reaches the respective edges for each axis.
25996 * @param obj The diskselector object.
25997 * @param h_bounce Whether to bounce or not in the horizontal axis.
25998 * @param v_bounce Whether to bounce or not in the vertical axis.
26000 * @see elm_scroller_bounce_set()
26002 * @ingroup Diskselector
26004 EAPI void elm_diskselector_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
26007 * Get the bouncing behaviour of the internal scroller.
26009 * Get whether the internal scroller should bounce when the edge of each
26010 * axis is reached scrolling.
26012 * @param obj The diskselector object.
26013 * @param h_bounce Pointer where to store the bounce state of the horizontal
26015 * @param v_bounce Pointer where to store the bounce state of the vertical
26018 * @see elm_scroller_bounce_get()
26019 * @see elm_diskselector_bounce_set()
26021 * @ingroup Diskselector
26023 EAPI void elm_diskselector_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
26026 * Get the scrollbar policy.
26028 * @see elm_diskselector_scroller_policy_get() for details.
26030 * @param obj The diskselector object.
26031 * @param policy_h Pointer where to store horizontal scrollbar policy.
26032 * @param policy_v Pointer where to store vertical scrollbar policy.
26034 * @ingroup Diskselector
26036 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);
26039 * Set the scrollbar policy.
26041 * @param obj The diskselector object.
26042 * @param policy_h Horizontal scrollbar policy.
26043 * @param policy_v Vertical scrollbar policy.
26045 * This sets the scrollbar visibility policy for the given scroller.
26046 * #ELM_SCROLLER_POLICY_AUTO means the scrollbar is made visible if it
26047 * is needed, and otherwise kept hidden. #ELM_SCROLLER_POLICY_ON turns
26048 * it on all the time, and #ELM_SCROLLER_POLICY_OFF always keeps it off.
26049 * This applies respectively for the horizontal and vertical scrollbars.
26051 * The both are disabled by default, i.e., are set to
26052 * #ELM_SCROLLER_POLICY_OFF.
26054 * @ingroup Diskselector
26056 EAPI void elm_diskselector_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
26059 * Remove all diskselector's items.
26061 * @param obj The diskselector object.
26063 * @see elm_diskselector_item_del()
26064 * @see elm_diskselector_item_append()
26066 * @ingroup Diskselector
26068 EAPI void elm_diskselector_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
26071 * Get a list of all the diskselector items.
26073 * @param obj The diskselector object.
26074 * @return An @c Eina_List of diskselector items, #Elm_Diskselector_Item,
26075 * or @c NULL on failure.
26077 * @see elm_diskselector_item_append()
26078 * @see elm_diskselector_item_del()
26079 * @see elm_diskselector_clear()
26081 * @ingroup Diskselector
26083 EAPI const Eina_List *elm_diskselector_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26086 * Appends a new item to the diskselector object.
26088 * @param obj The diskselector object.
26089 * @param label The label of the diskselector item.
26090 * @param icon The icon object to use at left side of the item. An
26091 * icon can be any Evas object, but usually it is an icon created
26092 * with elm_icon_add().
26093 * @param func The function to call when the item is selected.
26094 * @param data The data to associate with the item for related callbacks.
26096 * @return The created item or @c NULL upon failure.
26098 * A new item will be created and appended to the diskselector, i.e., will
26099 * be set as last item. Also, if there is no selected item, it will
26100 * be selected. This will always happens for the first appended item.
26102 * If no icon is set, label will be centered on item position, otherwise
26103 * the icon will be placed at left of the label, that will be shifted
26106 * Items created with this method can be deleted with
26107 * elm_diskselector_item_del().
26109 * Associated @p data can be properly freed when item is deleted if a
26110 * callback function is set with elm_diskselector_item_del_cb_set().
26112 * If a function is passed as argument, it will be called everytime this item
26113 * is selected, i.e., the user stops the diskselector with this
26114 * item on center position. If such function isn't needed, just passing
26115 * @c NULL as @p func is enough. The same should be done for @p data.
26117 * Simple example (with no function callback or data associated):
26119 * disk = elm_diskselector_add(win);
26120 * ic = elm_icon_add(win);
26121 * elm_icon_file_set(ic, "path/to/image", NULL);
26122 * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
26123 * elm_diskselector_item_append(disk, "label", ic, NULL, NULL);
26126 * @see elm_diskselector_item_del()
26127 * @see elm_diskselector_item_del_cb_set()
26128 * @see elm_diskselector_clear()
26129 * @see elm_icon_add()
26131 * @ingroup Diskselector
26133 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);
26137 * Delete them item from the diskselector.
26139 * @param it The item of diskselector to be deleted.
26141 * If deleting all diskselector items is required, elm_diskselector_clear()
26142 * should be used instead of getting items list and deleting each one.
26144 * @see elm_diskselector_clear()
26145 * @see elm_diskselector_item_append()
26146 * @see elm_diskselector_item_del_cb_set()
26148 * @ingroup Diskselector
26150 EAPI void elm_diskselector_item_del(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26153 * Set the function called when a diskselector item is freed.
26155 * @param it The item to set the callback on
26156 * @param func The function called
26158 * If there is a @p func, then it will be called prior item's memory release.
26159 * That will be called with the following arguments:
26161 * @li item's Evas object;
26164 * This way, a data associated to a diskselector item could be properly
26167 * @ingroup Diskselector
26169 EAPI void elm_diskselector_item_del_cb_set(Elm_Diskselector_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
26172 * Get the data associated to the item.
26174 * @param it The diskselector item
26175 * @return The data associated to @p it
26177 * The return value is a pointer to data associated to @p item when it was
26178 * created, with function elm_diskselector_item_append(). If no data
26179 * was passed as argument, it will return @c NULL.
26181 * @see elm_diskselector_item_append()
26183 * @ingroup Diskselector
26185 EAPI void *elm_diskselector_item_data_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26188 * Set the icon associated to the item.
26190 * @param it The diskselector item
26191 * @param icon The icon object to associate with @p it
26193 * The icon object to use at left side of the item. An
26194 * icon can be any Evas object, but usually it is an icon created
26195 * with elm_icon_add().
26197 * Once the icon object is set, a previously set one will be deleted.
26198 * @warning Setting the same icon for two items will cause the icon to
26199 * dissapear from the first item.
26201 * If an icon was passed as argument on item creation, with function
26202 * elm_diskselector_item_append(), it will be already
26203 * associated to the item.
26205 * @see elm_diskselector_item_append()
26206 * @see elm_diskselector_item_icon_get()
26208 * @ingroup Diskselector
26210 EAPI void elm_diskselector_item_icon_set(Elm_Diskselector_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
26213 * Get the icon associated to the item.
26215 * @param it The diskselector item
26216 * @return The icon associated to @p it
26218 * The return value is a pointer to the icon associated to @p item when it was
26219 * created, with function elm_diskselector_item_append(), or later
26220 * with function elm_diskselector_item_icon_set. If no icon
26221 * was passed as argument, it will return @c NULL.
26223 * @see elm_diskselector_item_append()
26224 * @see elm_diskselector_item_icon_set()
26226 * @ingroup Diskselector
26228 EAPI Evas_Object *elm_diskselector_item_icon_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26231 * Set the label of item.
26233 * @param it The item of diskselector.
26234 * @param label The label of item.
26236 * The label to be displayed by the item.
26238 * If no icon is set, label will be centered on item position, otherwise
26239 * the icon will be placed at left of the label, that will be shifted
26242 * An item with label "January" would be displayed on side position as
26243 * "Jan" if max length is set to 3 with function
26244 * elm_diskselector_side_label_lenght_set(), or "Janu", if this property
26247 * When this @p item is selected, the entire label will be displayed,
26248 * except for width restrictions.
26249 * In this case label will be cropped and "..." will be concatenated,
26250 * but only for display purposes. It will keep the entire string, so
26251 * if diskselector is resized the remaining characters will be displayed.
26253 * If a label was passed as argument on item creation, with function
26254 * elm_diskselector_item_append(), it will be already
26255 * displayed by the item.
26257 * @see elm_diskselector_side_label_lenght_set()
26258 * @see elm_diskselector_item_label_get()
26259 * @see elm_diskselector_item_append()
26261 * @ingroup Diskselector
26263 EAPI void elm_diskselector_item_label_set(Elm_Diskselector_Item *item, const char *label) EINA_ARG_NONNULL(1);
26266 * Get the label of item.
26268 * @param it The item of diskselector.
26269 * @return The label of item.
26271 * The return value is a pointer to the label associated to @p item when it was
26272 * created, with function elm_diskselector_item_append(), or later
26273 * with function elm_diskselector_item_label_set. If no label
26274 * was passed as argument, it will return @c NULL.
26276 * @see elm_diskselector_item_label_set() for more details.
26277 * @see elm_diskselector_item_append()
26279 * @ingroup Diskselector
26281 EAPI const char *elm_diskselector_item_label_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26284 * Get the selected item.
26286 * @param obj The diskselector object.
26287 * @return The selected diskselector item.
26289 * The selected item can be unselected with function
26290 * elm_diskselector_item_selected_set(), and the first item of
26291 * diskselector will be selected.
26293 * The selected item always will be centered on diskselector, with
26294 * full label displayed, i.e., max lenght set to side labels won't
26295 * apply on the selected item. More details on
26296 * elm_diskselector_side_label_length_set().
26298 * @ingroup Diskselector
26300 EAPI Elm_Diskselector_Item *elm_diskselector_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26303 * Set the selected state of an item.
26305 * @param it The diskselector item
26306 * @param selected The selected state
26308 * This sets the selected state of the given item @p it.
26309 * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
26311 * If a new item is selected the previosly selected will be unselected.
26312 * Previoulsy selected item can be get with function
26313 * elm_diskselector_selected_item_get().
26315 * If the item @p it is unselected, the first item of diskselector will
26318 * Selected items will be visible on center position of diskselector.
26319 * So if it was on another position before selected, or was invisible,
26320 * diskselector will animate items until the selected item reaches center
26323 * @see elm_diskselector_item_selected_get()
26324 * @see elm_diskselector_selected_item_get()
26326 * @ingroup Diskselector
26328 EAPI void elm_diskselector_item_selected_set(Elm_Diskselector_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
26331 * Get whether the @p item is selected or not.
26333 * @param it The diskselector item.
26334 * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
26335 * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
26337 * @see elm_diskselector_selected_item_set() for details.
26338 * @see elm_diskselector_item_selected_get()
26340 * @ingroup Diskselector
26342 EAPI Eina_Bool elm_diskselector_item_selected_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26345 * Get the first item of the diskselector.
26347 * @param obj The diskselector object.
26348 * @return The first item, or @c NULL if none.
26350 * The list of items follows append order. So it will return the first
26351 * item appended to the widget that wasn't deleted.
26353 * @see elm_diskselector_item_append()
26354 * @see elm_diskselector_items_get()
26356 * @ingroup Diskselector
26358 EAPI Elm_Diskselector_Item *elm_diskselector_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26361 * Get the last item of the diskselector.
26363 * @param obj The diskselector object.
26364 * @return The last item, or @c NULL if none.
26366 * The list of items follows append order. So it will return last first
26367 * item appended to the widget that wasn't deleted.
26369 * @see elm_diskselector_item_append()
26370 * @see elm_diskselector_items_get()
26372 * @ingroup Diskselector
26374 EAPI Elm_Diskselector_Item *elm_diskselector_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26377 * Get the item before @p item in diskselector.
26379 * @param it The diskselector item.
26380 * @return The item before @p item, or @c NULL if none or on failure.
26382 * The list of items follows append order. So it will return item appended
26383 * just before @p item and that wasn't deleted.
26385 * If it is the first item, @c NULL will be returned.
26386 * First item can be get by elm_diskselector_first_item_get().
26388 * @see elm_diskselector_item_append()
26389 * @see elm_diskselector_items_get()
26391 * @ingroup Diskselector
26393 EAPI Elm_Diskselector_Item *elm_diskselector_item_prev_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26396 * Get the item after @p item in diskselector.
26398 * @param it The diskselector item.
26399 * @return The item after @p item, or @c NULL if none or on failure.
26401 * The list of items follows append order. So it will return item appended
26402 * just after @p item and that wasn't deleted.
26404 * If it is the last item, @c NULL will be returned.
26405 * Last item can be get by elm_diskselector_last_item_get().
26407 * @see elm_diskselector_item_append()
26408 * @see elm_diskselector_items_get()
26410 * @ingroup Diskselector
26412 EAPI Elm_Diskselector_Item *elm_diskselector_item_next_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26415 * Set the text to be shown in the diskselector item.
26417 * @param item Target item
26418 * @param text The text to set in the content
26420 * Setup the text as tooltip to object. The item can have only one tooltip,
26421 * so any previous tooltip data is removed.
26423 * @see elm_object_tooltip_text_set() for more details.
26425 * @ingroup Diskselector
26427 EAPI void elm_diskselector_item_tooltip_text_set(Elm_Diskselector_Item *item, const char *text) EINA_ARG_NONNULL(1);
26430 * Set the content to be shown in the tooltip item.
26432 * Setup the tooltip to item. The item can have only one tooltip,
26433 * so any previous tooltip data is removed. @p func(with @p data) will
26434 * be called every time that need show the tooltip and it should
26435 * return a valid Evas_Object. This object is then managed fully by
26436 * tooltip system and is deleted when the tooltip is gone.
26438 * @param item the diskselector item being attached a tooltip.
26439 * @param func the function used to create the tooltip contents.
26440 * @param data what to provide to @a func as callback data/context.
26441 * @param del_cb called when data is not needed anymore, either when
26442 * another callback replaces @p func, the tooltip is unset with
26443 * elm_diskselector_item_tooltip_unset() or the owner @a item
26444 * dies. This callback receives as the first parameter the
26445 * given @a data, and @c event_info is the item.
26447 * @see elm_object_tooltip_content_cb_set() for more details.
26449 * @ingroup Diskselector
26451 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);
26454 * Unset tooltip from item.
26456 * @param item diskselector item to remove previously set tooltip.
26458 * Remove tooltip from item. The callback provided as del_cb to
26459 * elm_diskselector_item_tooltip_content_cb_set() will be called to notify
26460 * it is not used anymore.
26462 * @see elm_object_tooltip_unset() for more details.
26463 * @see elm_diskselector_item_tooltip_content_cb_set()
26465 * @ingroup Diskselector
26467 EAPI void elm_diskselector_item_tooltip_unset(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26471 * Sets a different style for this item tooltip.
26473 * @note before you set a style you should define a tooltip with
26474 * elm_diskselector_item_tooltip_content_cb_set() or
26475 * elm_diskselector_item_tooltip_text_set()
26477 * @param item diskselector item with tooltip already set.
26478 * @param style the theme style to use (default, transparent, ...)
26480 * @see elm_object_tooltip_style_set() for more details.
26482 * @ingroup Diskselector
26484 EAPI void elm_diskselector_item_tooltip_style_set(Elm_Diskselector_Item *item, const char *style) EINA_ARG_NONNULL(1);
26487 * Get the style for this item tooltip.
26489 * @param item diskselector item with tooltip already set.
26490 * @return style the theme style in use, defaults to "default". If the
26491 * object does not have a tooltip set, then NULL is returned.
26493 * @see elm_object_tooltip_style_get() for more details.
26494 * @see elm_diskselector_item_tooltip_style_set()
26496 * @ingroup Diskselector
26498 EAPI const char *elm_diskselector_item_tooltip_style_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26501 * Set the cursor to be shown when mouse is over the diskselector item
26503 * @param item Target item
26504 * @param cursor the cursor name to be used.
26506 * @see elm_object_cursor_set() for more details.
26508 * @ingroup Diskselector
26510 EAPI void elm_diskselector_item_cursor_set(Elm_Diskselector_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
26513 * Get the cursor to be shown when mouse is over the diskselector item
26515 * @param item diskselector item with cursor already set.
26516 * @return the cursor name.
26518 * @see elm_object_cursor_get() for more details.
26519 * @see elm_diskselector_cursor_set()
26521 * @ingroup Diskselector
26523 EAPI const char *elm_diskselector_item_cursor_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26527 * Unset the cursor to be shown when mouse is over the diskselector item
26529 * @param item Target item
26531 * @see elm_object_cursor_unset() for more details.
26532 * @see elm_diskselector_cursor_set()
26534 * @ingroup Diskselector
26536 EAPI void elm_diskselector_item_cursor_unset(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26539 * Sets a different style for this item cursor.
26541 * @note before you set a style you should define a cursor with
26542 * elm_diskselector_item_cursor_set()
26544 * @param item diskselector item with cursor already set.
26545 * @param style the theme style to use (default, transparent, ...)
26547 * @see elm_object_cursor_style_set() for more details.
26549 * @ingroup Diskselector
26551 EAPI void elm_diskselector_item_cursor_style_set(Elm_Diskselector_Item *item, const char *style) EINA_ARG_NONNULL(1);
26555 * Get the style for this item cursor.
26557 * @param item diskselector item with cursor already set.
26558 * @return style the theme style in use, defaults to "default". If the
26559 * object does not have a cursor set, then @c NULL is returned.
26561 * @see elm_object_cursor_style_get() for more details.
26562 * @see elm_diskselector_item_cursor_style_set()
26564 * @ingroup Diskselector
26566 EAPI const char *elm_diskselector_item_cursor_style_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26570 * Set if the cursor set should be searched on the theme or should use
26571 * the provided by the engine, only.
26573 * @note before you set if should look on theme you should define a cursor
26574 * with elm_diskselector_item_cursor_set().
26575 * By default it will only look for cursors provided by the engine.
26577 * @param item widget item with cursor already set.
26578 * @param engine_only boolean to define if cursors set with
26579 * elm_diskselector_item_cursor_set() should be searched only
26580 * between cursors provided by the engine or searched on widget's
26583 * @see elm_object_cursor_engine_only_set() for more details.
26585 * @ingroup Diskselector
26587 EAPI void elm_diskselector_item_cursor_engine_only_set(Elm_Diskselector_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
26590 * Get the cursor engine only usage for this item cursor.
26592 * @param item widget item with cursor already set.
26593 * @return engine_only boolean to define it cursors should be looked only
26594 * between the provided by the engine or searched on widget's theme as well.
26595 * If the item does not have a cursor set, then @c EINA_FALSE is returned.
26597 * @see elm_object_cursor_engine_only_get() for more details.
26598 * @see elm_diskselector_item_cursor_engine_only_set()
26600 * @ingroup Diskselector
26602 EAPI Eina_Bool elm_diskselector_item_cursor_engine_only_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26609 * @defgroup Colorselector Colorselector
26613 * @image html img/widget/colorselector/preview-00.png
26614 * @image latex img/widget/colorselector/preview-00.eps
26616 * @brief Widget for user to select a color.
26618 * Signals that you can add callbacks for are:
26619 * "changed" - When the color value changes(event_info is NULL).
26621 * See @ref tutorial_colorselector.
26624 * @brief Add a new colorselector to the parent
26626 * @param parent The parent object
26627 * @return The new object or NULL if it cannot be created
26629 * @ingroup Colorselector
26631 EAPI Evas_Object *elm_colorselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
26633 * Set a color for the colorselector
26635 * @param obj Colorselector object
26636 * @param r r-value of color
26637 * @param g g-value of color
26638 * @param b b-value of color
26639 * @param a a-value of color
26641 * @ingroup Colorselector
26643 EAPI void elm_colorselector_color_set(Evas_Object *obj, int r, int g , int b, int a) EINA_ARG_NONNULL(1);
26645 * Get a color from the colorselector
26647 * @param obj Colorselector object
26648 * @param r integer pointer for r-value of color
26649 * @param g integer pointer for g-value of color
26650 * @param b integer pointer for b-value of color
26651 * @param a integer pointer for a-value of color
26653 * @ingroup Colorselector
26655 EAPI void elm_colorselector_color_get(const Evas_Object *obj, int *r, int *g , int *b, int *a) EINA_ARG_NONNULL(1);
26661 * @defgroup Ctxpopup Ctxpopup
26663 * @image html img/widget/ctxpopup/preview-00.png
26664 * @image latex img/widget/ctxpopup/preview-00.eps
26666 * @brief Context popup widet.
26668 * A ctxpopup is a widget that, when shown, pops up a list of items.
26669 * It automatically chooses an area inside its parent object's view
26670 * (set via elm_ctxpopup_add() and elm_ctxpopup_hover_parent_set()) to
26671 * optimally fit into it. In the default theme, it will also point an
26672 * arrow to it's top left position at the time one shows it. Ctxpopup
26673 * items have a label and/or an icon. It is intended for a small
26674 * number of items (hence the use of list, not genlist).
26676 * @note Ctxpopup is a especialization of @ref Hover.
26678 * Signals that you can add callbacks for are:
26679 * "dismissed" - the ctxpopup was dismissed
26681 * Default contents parts of the ctxpopup widget that you can use for are:
26682 * @li "default" - A content of the ctxpopup
26684 * Default contents parts of the naviframe items that you can use for are:
26685 * @li "icon" - A icon in the title area
26687 * Default text parts of the naviframe items that you can use for are:
26688 * @li "default" - Title label in the title area
26690 * @ref tutorial_ctxpopup shows the usage of a good deal of the API.
26693 typedef enum _Elm_Ctxpopup_Direction
26695 ELM_CTXPOPUP_DIRECTION_DOWN, /**< ctxpopup show appear below clicked
26697 ELM_CTXPOPUP_DIRECTION_RIGHT, /**< ctxpopup show appear to the right of
26698 the clicked area */
26699 ELM_CTXPOPUP_DIRECTION_LEFT, /**< ctxpopup show appear to the left of
26700 the clicked area */
26701 ELM_CTXPOPUP_DIRECTION_UP, /**< ctxpopup show appear above the clicked
26703 ELM_CTXPOPUP_DIRECTION_UNKNOWN, /**< ctxpopup does not determine it's direction yet*/
26704 } Elm_Ctxpopup_Direction;
26707 * @brief Add a new Ctxpopup object to the parent.
26709 * @param parent Parent object
26710 * @return New object or @c NULL, if it cannot be created
26712 EAPI Evas_Object *elm_ctxpopup_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
26714 * @brief Set the Ctxpopup's parent
26716 * @param obj The ctxpopup object
26717 * @param area The parent to use
26719 * Set the parent object.
26721 * @note elm_ctxpopup_add() will automatically call this function
26722 * with its @c parent argument.
26724 * @see elm_ctxpopup_add()
26725 * @see elm_hover_parent_set()
26727 EAPI void elm_ctxpopup_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1, 2);
26729 * @brief Get the Ctxpopup's parent
26731 * @param obj The ctxpopup object
26733 * @see elm_ctxpopup_hover_parent_set() for more information
26735 EAPI Evas_Object *elm_ctxpopup_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26737 * @brief Clear all items in the given ctxpopup object.
26739 * @param obj Ctxpopup object
26741 EAPI void elm_ctxpopup_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
26743 * @brief Change the ctxpopup's orientation to horizontal or vertical.
26745 * @param obj Ctxpopup object
26746 * @param horizontal @c EINA_TRUE for horizontal mode, @c EINA_FALSE for vertical
26748 EAPI void elm_ctxpopup_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
26750 * @brief Get the value of current ctxpopup object's orientation.
26752 * @param obj Ctxpopup object
26753 * @return @c EINA_TRUE for horizontal mode, @c EINA_FALSE for vertical mode (or errors)
26755 * @see elm_ctxpopup_horizontal_set()
26757 EAPI Eina_Bool elm_ctxpopup_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26759 * @brief Add a new item to a ctxpopup object.
26761 * @param obj Ctxpopup object
26762 * @param icon Icon to be set on new item
26763 * @param label The Label of the new item
26764 * @param func Convenience function called when item selected
26765 * @param data Data passed to @p func
26766 * @return A handle to the item added or @c NULL, on errors
26768 * @warning Ctxpopup can't hold both an item list and a content at the same
26769 * time. When an item is added, any previous content will be removed.
26771 * @see elm_ctxpopup_content_set()
26773 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);
26775 * @brief Delete the given item in a ctxpopup object.
26777 * @param it Ctxpopup item to be deleted
26779 * @see elm_ctxpopup_item_append()
26781 EAPI void elm_ctxpopup_item_del(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26783 * @brief Set the ctxpopup item's state as disabled or enabled.
26785 * @param it Ctxpopup item to be enabled/disabled
26786 * @param disabled @c EINA_TRUE to disable it, @c EINA_FALSE to enable it
26788 * When disabled the item is greyed out to indicate it's state.
26789 * @deprecated use elm_object_item_disabled_set() instead
26791 EINA_DEPRECATED EAPI void elm_ctxpopup_item_disabled_set(Elm_Object_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1);
26793 * @brief Get the ctxpopup item's disabled/enabled state.
26795 * @param it Ctxpopup item to be enabled/disabled
26796 * @return disabled @c EINA_TRUE, if disabled, @c EINA_FALSE otherwise
26798 * @see elm_ctxpopup_item_disabled_set()
26799 * @deprecated use elm_object_item_disabled_get() instead
26801 EAPI Eina_Bool elm_ctxpopup_item_disabled_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26803 * @brief Get the icon object for the given ctxpopup item.
26805 * @param it Ctxpopup item
26806 * @return icon object or @c NULL, if the item does not have icon or an error
26809 * @see elm_ctxpopup_item_append()
26810 * @see elm_ctxpopup_item_icon_set()
26812 * @deprecated use elm_object_item_part_content_get() instead
26814 EINA_DEPRECATED EAPI Evas_Object *elm_ctxpopup_item_icon_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26816 * @brief Sets the side icon associated with the ctxpopup item
26818 * @param it Ctxpopup item
26819 * @param icon Icon object to be set
26821 * Once the icon object is set, a previously set one will be deleted.
26822 * @warning Setting the same icon for two items will cause the icon to
26823 * dissapear from the first item.
26825 * @see elm_ctxpopup_item_append()
26827 * @deprecated use elm_object_item_part_content_set() instead
26830 EINA_DEPRECATED EAPI void elm_ctxpopup_item_icon_set(Elm_Object_Item *it, Evas_Object *icon) EINA_ARG_NONNULL(1);
26832 * @brief Get the label for the given ctxpopup item.
26834 * @param it Ctxpopup item
26835 * @return label string or @c NULL, if the item does not have label or an
26838 * @see elm_ctxpopup_item_append()
26839 * @see elm_ctxpopup_item_label_set()
26841 * @deprecated use elm_object_item_text_get() instead
26843 EINA_DEPRECATED EAPI const char *elm_ctxpopup_item_label_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26845 * @brief (Re)set the label on the given ctxpopup item.
26847 * @param it Ctxpopup item
26848 * @param label String to set as label
26850 * @deprecated use elm_object_item_text_set() instead
26852 EINA_DEPRECATED EAPI void elm_ctxpopup_item_label_set(Elm_Object_Item *it, const char *label) EINA_ARG_NONNULL(1);
26854 * @brief Set an elm widget as the content of the ctxpopup.
26856 * @param obj Ctxpopup object
26857 * @param content Content to be swallowed
26859 * If the content object is already set, a previous one will bedeleted. If
26860 * you want to keep that old content object, use the
26861 * elm_ctxpopup_content_unset() function.
26863 * @warning Ctxpopup can't hold both a item list and a content at the same
26864 * time. When a content is set, any previous items will be removed.
26866 * @deprecated use elm_object_content_set() instead
26869 EINA_DEPRECATED EAPI void elm_ctxpopup_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1, 2);
26871 * @brief Unset the ctxpopup content
26873 * @param obj Ctxpopup object
26874 * @return The content that was being used
26876 * Unparent and return the content object which was set for this widget.
26878 * @deprecated use elm_object_content_unset()
26880 * @see elm_ctxpopup_content_set()
26882 * @deprecated use elm_object_content_unset() instead
26885 EINA_DEPRECATED EAPI Evas_Object *elm_ctxpopup_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
26887 * @brief Set the direction priority of a ctxpopup.
26889 * @param obj Ctxpopup object
26890 * @param first 1st priority of direction
26891 * @param second 2nd priority of direction
26892 * @param third 3th priority of direction
26893 * @param fourth 4th priority of direction
26895 * This functions gives a chance to user to set the priority of ctxpopup
26896 * showing direction. This doesn't guarantee the ctxpopup will appear in the
26897 * requested direction.
26899 * @see Elm_Ctxpopup_Direction
26901 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);
26903 * @brief Get the direction priority of a ctxpopup.
26905 * @param obj Ctxpopup object
26906 * @param first 1st priority of direction to be returned
26907 * @param second 2nd priority of direction to be returned
26908 * @param third 3th priority of direction to be returned
26909 * @param fourth 4th priority of direction to be returned
26911 * @see elm_ctxpopup_direction_priority_set() for more information.
26913 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);
26916 * @brief Get the current direction of a ctxpopup.
26918 * @param obj Ctxpopup object
26919 * @return current direction of a ctxpopup
26921 * @warning Once the ctxpopup showed up, the direction would be determined
26923 EAPI Elm_Ctxpopup_Direction elm_ctxpopup_direction_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26932 * @defgroup Transit Transit
26933 * @ingroup Elementary
26935 * Transit is designed to apply various animated transition effects to @c
26936 * Evas_Object, such like translation, rotation, etc. For using these
26937 * effects, create an @ref Elm_Transit and add the desired transition effects.
26939 * Once the effects are added into transit, they will be automatically
26940 * managed (their callback will be called until the duration is ended, and
26941 * they will be deleted on completion).
26945 * Elm_Transit *trans = elm_transit_add();
26946 * elm_transit_object_add(trans, obj);
26947 * elm_transit_effect_translation_add(trans, 0, 0, 280, 280
26948 * elm_transit_duration_set(transit, 1);
26949 * elm_transit_auto_reverse_set(transit, EINA_TRUE);
26950 * elm_transit_tween_mode_set(transit, ELM_TRANSIT_TWEEN_MODE_DECELERATE);
26951 * elm_transit_repeat_times_set(transit, 3);
26954 * Some transition effects are used to change the properties of objects. They
26956 * @li @ref elm_transit_effect_translation_add
26957 * @li @ref elm_transit_effect_color_add
26958 * @li @ref elm_transit_effect_rotation_add
26959 * @li @ref elm_transit_effect_wipe_add
26960 * @li @ref elm_transit_effect_zoom_add
26961 * @li @ref elm_transit_effect_resizing_add
26963 * Other transition effects are used to make one object disappear and another
26964 * object appear on its old place. These effects are:
26966 * @li @ref elm_transit_effect_flip_add
26967 * @li @ref elm_transit_effect_resizable_flip_add
26968 * @li @ref elm_transit_effect_fade_add
26969 * @li @ref elm_transit_effect_blend_add
26971 * It's also possible to make a transition chain with @ref
26972 * elm_transit_chain_transit_add.
26974 * @warning We strongly recommend to use elm_transit just when edje can not do
26975 * the trick. Edje has more advantage than Elm_Transit, it has more flexibility and
26976 * animations can be manipulated inside the theme.
26978 * List of examples:
26979 * @li @ref transit_example_01_explained
26980 * @li @ref transit_example_02_explained
26981 * @li @ref transit_example_03_c
26982 * @li @ref transit_example_04_c
26988 * @enum Elm_Transit_Tween_Mode
26990 * The type of acceleration used in the transition.
26994 ELM_TRANSIT_TWEEN_MODE_LINEAR, /**< Constant speed */
26995 ELM_TRANSIT_TWEEN_MODE_SINUSOIDAL, /**< Starts slow, increase speed
26996 over time, then decrease again
26998 ELM_TRANSIT_TWEEN_MODE_DECELERATE, /**< Starts fast and decrease
27000 ELM_TRANSIT_TWEEN_MODE_ACCELERATE /**< Starts slow and increase speed
27002 } Elm_Transit_Tween_Mode;
27005 * @enum Elm_Transit_Effect_Flip_Axis
27007 * The axis where flip effect should be applied.
27011 ELM_TRANSIT_EFFECT_FLIP_AXIS_X, /**< Flip on X axis */
27012 ELM_TRANSIT_EFFECT_FLIP_AXIS_Y /**< Flip on Y axis */
27013 } Elm_Transit_Effect_Flip_Axis;
27015 * @enum Elm_Transit_Effect_Wipe_Dir
27017 * The direction where the wipe effect should occur.
27021 ELM_TRANSIT_EFFECT_WIPE_DIR_LEFT, /**< Wipe to the left */
27022 ELM_TRANSIT_EFFECT_WIPE_DIR_RIGHT, /**< Wipe to the right */
27023 ELM_TRANSIT_EFFECT_WIPE_DIR_UP, /**< Wipe up */
27024 ELM_TRANSIT_EFFECT_WIPE_DIR_DOWN /**< Wipe down */
27025 } Elm_Transit_Effect_Wipe_Dir;
27026 /** @enum Elm_Transit_Effect_Wipe_Type
27028 * Whether the wipe effect should show or hide the object.
27032 ELM_TRANSIT_EFFECT_WIPE_TYPE_HIDE, /**< Hide the object during the
27034 ELM_TRANSIT_EFFECT_WIPE_TYPE_SHOW /**< Show the object during the
27036 } Elm_Transit_Effect_Wipe_Type;
27039 * @typedef Elm_Transit
27041 * The Transit created with elm_transit_add(). This type has the information
27042 * about the objects which the transition will be applied, and the
27043 * transition effects that will be used. It also contains info about
27044 * duration, number of repetitions, auto-reverse, etc.
27046 typedef struct _Elm_Transit Elm_Transit;
27047 typedef void Elm_Transit_Effect;
27049 * @typedef Elm_Transit_Effect_Transition_Cb
27051 * Transition callback called for this effect on each transition iteration.
27053 typedef void (*Elm_Transit_Effect_Transition_Cb) (Elm_Transit_Effect *effect, Elm_Transit *transit, double progress);
27055 * Elm_Transit_Effect_End_Cb
27057 * Transition callback called for this effect when the transition is over.
27059 typedef void (*Elm_Transit_Effect_End_Cb) (Elm_Transit_Effect *effect, Elm_Transit *transit);
27062 * Elm_Transit_Del_Cb
27064 * A callback called when the transit is deleted.
27066 typedef void (*Elm_Transit_Del_Cb) (void *data, Elm_Transit *transit);
27071 * @note Is not necessary to delete the transit object, it will be deleted at
27072 * the end of its operation.
27073 * @note The transit will start playing when the program enter in the main loop, is not
27074 * necessary to give a start to the transit.
27076 * @return The transit object.
27080 EAPI Elm_Transit *elm_transit_add(void);
27083 * Stops the animation and delete the @p transit object.
27085 * Call this function if you wants to stop the animation before the duration
27086 * time. Make sure the @p transit object is still alive with
27087 * elm_transit_del_cb_set() function.
27088 * All added effects will be deleted, calling its repective data_free_cb
27089 * functions. The function setted by elm_transit_del_cb_set() will be called.
27091 * @see elm_transit_del_cb_set()
27093 * @param transit The transit object to be deleted.
27096 * @warning Just call this function if you are sure the transit is alive.
27098 EAPI void elm_transit_del(Elm_Transit *transit) EINA_ARG_NONNULL(1);
27101 * Add a new effect to the transit.
27103 * @note The cb function and the data are the key to the effect. If you try to
27104 * add an already added effect, nothing is done.
27105 * @note After the first addition of an effect in @p transit, if its
27106 * effect list become empty again, the @p transit will be killed by
27107 * elm_transit_del(transit) function.
27111 * Elm_Transit *transit = elm_transit_add();
27112 * elm_transit_effect_add(transit,
27113 * elm_transit_effect_blend_op,
27114 * elm_transit_effect_blend_context_new(),
27115 * elm_transit_effect_blend_context_free);
27118 * @param transit The transit object.
27119 * @param transition_cb The operation function. It is called when the
27120 * animation begins, it is the function that actually performs the animation.
27121 * It is called with the @p data, @p transit and the time progression of the
27122 * animation (a double value between 0.0 and 1.0).
27123 * @param effect The context data of the effect.
27124 * @param end_cb The function to free the context data, it will be called
27125 * at the end of the effect, it must finalize the animation and free the
27129 * @warning The transit free the context data at the and of the transition with
27130 * the data_free_cb function, do not use the context data in another transit.
27132 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);
27135 * Delete an added effect.
27137 * This function will remove the effect from the @p transit, calling the
27138 * data_free_cb to free the @p data.
27140 * @see elm_transit_effect_add()
27142 * @note If the effect is not found, nothing is done.
27143 * @note If the effect list become empty, this function will call
27144 * elm_transit_del(transit), that is, it will kill the @p transit.
27146 * @param transit The transit object.
27147 * @param transition_cb The operation function.
27148 * @param effect The context data of the effect.
27152 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);
27155 * Add new object to apply the effects.
27157 * @note After the first addition of an object in @p transit, if its
27158 * object list become empty again, the @p transit will be killed by
27159 * elm_transit_del(transit) function.
27160 * @note If the @p obj belongs to another transit, the @p obj will be
27161 * removed from it and it will only belong to the @p transit. If the old
27162 * transit stays without objects, it will die.
27163 * @note When you add an object into the @p transit, its state from
27164 * evas_object_pass_events_get(obj) is saved, and it is applied when the
27165 * transit ends, if you change this state whith evas_object_pass_events_set()
27166 * after add the object, this state will change again when @p transit stops to
27169 * @param transit The transit object.
27170 * @param obj Object to be animated.
27173 * @warning It is not allowed to add a new object after transit begins to go.
27175 EAPI void elm_transit_object_add(Elm_Transit *transit, Evas_Object *obj) EINA_ARG_NONNULL(1, 2);
27178 * Removes an added object from the transit.
27180 * @note If the @p obj is not in the @p transit, nothing is done.
27181 * @note If the list become empty, this function will call
27182 * elm_transit_del(transit), that is, it will kill the @p transit.
27184 * @param transit The transit object.
27185 * @param obj Object to be removed from @p transit.
27188 * @warning It is not allowed to remove objects after transit begins to go.
27190 EAPI void elm_transit_object_remove(Elm_Transit *transit, Evas_Object *obj) EINA_ARG_NONNULL(1, 2);
27193 * Get the objects of the transit.
27195 * @param transit The transit object.
27196 * @return a Eina_List with the objects from the transit.
27200 EAPI const Eina_List *elm_transit_objects_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27203 * Enable/disable keeping up the objects states.
27204 * If it is not kept, the objects states will be reset when transition ends.
27206 * @note @p transit can not be NULL.
27207 * @note One state includes geometry, color, map data.
27209 * @param transit The transit object.
27210 * @param state_keep Keeping or Non Keeping.
27214 EAPI void elm_transit_objects_final_state_keep_set(Elm_Transit *transit, Eina_Bool state_keep) EINA_ARG_NONNULL(1);
27217 * Get a value whether the objects states will be reset or not.
27219 * @note @p transit can not be NULL
27221 * @see elm_transit_objects_final_state_keep_set()
27223 * @param transit The transit object.
27224 * @return EINA_TRUE means the states of the objects will be reset.
27225 * If @p transit is NULL, EINA_FALSE is returned
27229 EAPI Eina_Bool elm_transit_objects_final_state_keep_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27232 * Set the event enabled when transit is operating.
27234 * If @p enabled is EINA_TRUE, the objects of the transit will receives
27235 * events from mouse and keyboard during the animation.
27236 * @note When you add an object with elm_transit_object_add(), its state from
27237 * evas_object_pass_events_get(obj) is saved, and it is applied when the
27238 * transit ends, if you change this state with evas_object_pass_events_set()
27239 * after adding the object, this state will change again when @p transit stops
27242 * @param transit The transit object.
27243 * @param enabled Events are received when enabled is @c EINA_TRUE, and
27244 * ignored otherwise.
27248 EAPI void elm_transit_event_enabled_set(Elm_Transit *transit, Eina_Bool enabled) EINA_ARG_NONNULL(1);
27251 * Get the value of event enabled status.
27253 * @see elm_transit_event_enabled_set()
27255 * @param transit The Transit object
27256 * @return EINA_TRUE, when event is enabled. If @p transit is NULL
27257 * EINA_FALSE is returned
27261 EAPI Eina_Bool elm_transit_event_enabled_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27264 * Set the user-callback function when the transit is deleted.
27266 * @note Using this function twice will overwrite the first function setted.
27267 * @note the @p transit object will be deleted after call @p cb function.
27269 * @param transit The transit object.
27270 * @param cb Callback function pointer. This function will be called before
27271 * the deletion of the transit.
27272 * @param data Callback funtion user data. It is the @p op parameter.
27276 EAPI void elm_transit_del_cb_set(Elm_Transit *transit, Elm_Transit_Del_Cb cb, void *data) EINA_ARG_NONNULL(1);
27279 * Set reverse effect automatically.
27281 * If auto reverse is setted, after running the effects with the progress
27282 * parameter from 0 to 1, it will call the effecs again with the progress
27283 * from 1 to 0. The transit will last for a time iqual to (2 * duration * repeat),
27284 * where the duration was setted with the function elm_transit_add and
27285 * the repeat with the function elm_transit_repeat_times_set().
27287 * @param transit The transit object.
27288 * @param reverse EINA_TRUE means the auto_reverse is on.
27292 EAPI void elm_transit_auto_reverse_set(Elm_Transit *transit, Eina_Bool reverse) EINA_ARG_NONNULL(1);
27295 * Get if the auto reverse is on.
27297 * @see elm_transit_auto_reverse_set()
27299 * @param transit The transit object.
27300 * @return EINA_TRUE means auto reverse is on. If @p transit is NULL
27301 * EINA_FALSE is returned
27305 EAPI Eina_Bool elm_transit_auto_reverse_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27308 * Set the transit repeat count. Effect will be repeated by repeat count.
27310 * This function sets the number of repetition the transit will run after
27311 * the first one, that is, if @p repeat is 1, the transit will run 2 times.
27312 * If the @p repeat is a negative number, it will repeat infinite times.
27314 * @note If this function is called during the transit execution, the transit
27315 * will run @p repeat times, ignoring the times it already performed.
27317 * @param transit The transit object
27318 * @param repeat Repeat count
27322 EAPI void elm_transit_repeat_times_set(Elm_Transit *transit, int repeat) EINA_ARG_NONNULL(1);
27325 * Get the transit repeat count.
27327 * @see elm_transit_repeat_times_set()
27329 * @param transit The Transit object.
27330 * @return The repeat count. If @p transit is NULL
27335 EAPI int elm_transit_repeat_times_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27338 * Set the transit animation acceleration type.
27340 * This function sets the tween mode of the transit that can be:
27341 * ELM_TRANSIT_TWEEN_MODE_LINEAR - The default mode.
27342 * ELM_TRANSIT_TWEEN_MODE_SINUSOIDAL - Starts in accelerate mode and ends decelerating.
27343 * ELM_TRANSIT_TWEEN_MODE_DECELERATE - The animation will be slowed over time.
27344 * ELM_TRANSIT_TWEEN_MODE_ACCELERATE - The animation will accelerate over time.
27346 * @param transit The transit object.
27347 * @param tween_mode The tween type.
27351 EAPI void elm_transit_tween_mode_set(Elm_Transit *transit, Elm_Transit_Tween_Mode tween_mode) EINA_ARG_NONNULL(1);
27354 * Get the transit animation acceleration type.
27356 * @note @p transit can not be NULL
27358 * @param transit The transit object.
27359 * @return The tween type. If @p transit is NULL
27360 * ELM_TRANSIT_TWEEN_MODE_LINEAR is returned.
27364 EAPI Elm_Transit_Tween_Mode elm_transit_tween_mode_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27367 * Set the transit animation time
27369 * @note @p transit can not be NULL
27371 * @param transit The transit object.
27372 * @param duration The animation time.
27376 EAPI void elm_transit_duration_set(Elm_Transit *transit, double duration) EINA_ARG_NONNULL(1);
27379 * Get the transit animation time
27381 * @note @p transit can not be NULL
27383 * @param transit The transit object.
27385 * @return The transit animation time.
27389 EAPI double elm_transit_duration_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27392 * Starts the transition.
27393 * Once this API is called, the transit begins to measure the time.
27395 * @note @p transit can not be NULL
27397 * @param transit The transit object.
27401 EAPI void elm_transit_go(Elm_Transit *transit) EINA_ARG_NONNULL(1);
27404 * Pause/Resume the transition.
27406 * If you call elm_transit_go again, the transit will be started from the
27407 * beginning, and will be unpaused.
27409 * @note @p transit can not be NULL
27411 * @param transit The transit object.
27412 * @param paused Whether the transition should be paused or not.
27416 EAPI void elm_transit_paused_set(Elm_Transit *transit, Eina_Bool paused) EINA_ARG_NONNULL(1);
27419 * Get the value of paused status.
27421 * @see elm_transit_paused_set()
27423 * @note @p transit can not be NULL
27425 * @param transit The transit object.
27426 * @return EINA_TRUE means transition is paused. If @p transit is NULL
27427 * EINA_FALSE is returned
27431 EAPI Eina_Bool elm_transit_paused_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27434 * Get the time progression of the animation (a double value between 0.0 and 1.0).
27436 * The value returned is a fraction (current time / total time). It
27437 * represents the progression position relative to the total.
27439 * @note @p transit can not be NULL
27441 * @param transit The transit object.
27443 * @return The time progression value. If @p transit is NULL
27448 EAPI double elm_transit_progress_value_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27451 * Makes the chain relationship between two transits.
27453 * @note @p transit can not be NULL. Transit would have multiple chain transits.
27454 * @note @p chain_transit can not be NULL. Chain transits could be chained to the only one transit.
27456 * @param transit The transit object.
27457 * @param chain_transit The chain transit object. This transit will be operated
27458 * after transit is done.
27460 * This function adds @p chain_transit transition to a chain after the @p
27461 * transit, and will be started as soon as @p transit ends. See @ref
27462 * transit_example_02_explained for a full example.
27466 EAPI void elm_transit_chain_transit_add(Elm_Transit *transit, Elm_Transit *chain_transit) EINA_ARG_NONNULL(1, 2);
27469 * Cut off the chain relationship between two transits.
27471 * @note @p transit can not be NULL. Transit would have the chain relationship with @p chain transit.
27472 * @note @p chain_transit can not be NULL. Chain transits should be chained to the @p transit.
27474 * @param transit The transit object.
27475 * @param chain_transit The chain transit object.
27477 * This function remove the @p chain_transit transition from the @p transit.
27481 EAPI void elm_transit_chain_transit_del(Elm_Transit *transit, Elm_Transit *chain_transit) EINA_ARG_NONNULL(1,2);
27484 * Get the current chain transit list.
27486 * @note @p transit can not be NULL.
27488 * @param transit The transit object.
27489 * @return chain transit list.
27493 EAPI Eina_List *elm_transit_chain_transits_get(const Elm_Transit *transit);
27496 * Add the Resizing Effect to Elm_Transit.
27498 * @note This API is one of the facades. It creates resizing effect context
27499 * and add it's required APIs to elm_transit_effect_add.
27501 * @see elm_transit_effect_add()
27503 * @param transit Transit object.
27504 * @param from_w Object width size when effect begins.
27505 * @param from_h Object height size when effect begins.
27506 * @param to_w Object width size when effect ends.
27507 * @param to_h Object height size when effect ends.
27508 * @return Resizing effect context data.
27512 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);
27515 * Add the Translation Effect to Elm_Transit.
27517 * @note This API is one of the facades. It creates translation effect context
27518 * and add it's required APIs to elm_transit_effect_add.
27520 * @see elm_transit_effect_add()
27522 * @param transit Transit object.
27523 * @param from_dx X Position variation when effect begins.
27524 * @param from_dy Y Position variation when effect begins.
27525 * @param to_dx X Position variation when effect ends.
27526 * @param to_dy Y Position variation when effect ends.
27527 * @return Translation 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_translation_add(Elm_Transit* transit, Evas_Coord from_dx, Evas_Coord from_dy, Evas_Coord to_dx, Evas_Coord to_dy);
27538 * Add the Zoom Effect to Elm_Transit.
27540 * @note This API is one of the facades. It creates zoom effect context
27541 * and add it's required APIs to elm_transit_effect_add.
27543 * @see elm_transit_effect_add()
27545 * @param transit Transit object.
27546 * @param from_rate Scale rate when effect begins (1 is current rate).
27547 * @param to_rate Scale rate when effect ends.
27548 * @return Zoom effect context data.
27551 * @warning It is highly recommended just create a transit with this effect when
27552 * the window that the objects of the transit belongs has already been created.
27553 * This is because this effect needs the geometry information about the objects,
27554 * and if the window was not created yet, it can get a wrong information.
27556 EAPI Elm_Transit_Effect *elm_transit_effect_zoom_add(Elm_Transit *transit, float from_rate, float to_rate);
27559 * Add the Flip Effect to Elm_Transit.
27561 * @note This API is one of the facades. It creates flip effect context
27562 * and add it's required APIs to elm_transit_effect_add.
27563 * @note This effect is applied to each pair of objects in the order they are listed
27564 * in the transit list of objects. The first object in the pair will be the
27565 * "front" object and the second will be the "back" object.
27567 * @see elm_transit_effect_add()
27569 * @param transit Transit object.
27570 * @param axis Flipping Axis(X or Y).
27571 * @param cw Flipping Direction. EINA_TRUE is clock-wise.
27572 * @return Flip effect context data.
27575 * @warning It is highly recommended just create a transit with this effect when
27576 * the window that the objects of the transit belongs has already been created.
27577 * This is because this effect needs the geometry information about the objects,
27578 * and if the window was not created yet, it can get a wrong information.
27580 EAPI Elm_Transit_Effect *elm_transit_effect_flip_add(Elm_Transit *transit, Elm_Transit_Effect_Flip_Axis axis, Eina_Bool cw);
27583 * Add the Resizable Flip Effect to Elm_Transit.
27585 * @note This API is one of the facades. It creates resizable flip effect context
27586 * and add it's required APIs to elm_transit_effect_add.
27587 * @note This effect is applied to each pair of objects in the order they are listed
27588 * in the transit list of objects. The first object in the pair will be the
27589 * "front" object and the second will be the "back" object.
27591 * @see elm_transit_effect_add()
27593 * @param transit Transit object.
27594 * @param axis Flipping Axis(X or Y).
27595 * @param cw Flipping Direction. EINA_TRUE is clock-wise.
27596 * @return Resizable flip 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_resizable_flip_add(Elm_Transit *transit, Elm_Transit_Effect_Flip_Axis axis, Eina_Bool cw);
27607 * Add the Wipe Effect to Elm_Transit.
27609 * @note This API is one of the facades. It creates wipe 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 type Wipe type. Hide or show.
27616 * @param dir Wipe Direction.
27617 * @return Wipe effect context data.
27620 * @warning It is highly recommended just create a transit with this effect when
27621 * the window that the objects of the transit belongs has already been created.
27622 * This is because this effect needs the geometry information about the objects,
27623 * and if the window was not created yet, it can get a wrong information.
27625 EAPI Elm_Transit_Effect *elm_transit_effect_wipe_add(Elm_Transit *transit, Elm_Transit_Effect_Wipe_Type type, Elm_Transit_Effect_Wipe_Dir dir);
27628 * Add the Color Effect to Elm_Transit.
27630 * @note This API is one of the facades. It creates color effect context
27631 * and add it's required APIs to elm_transit_effect_add.
27633 * @see elm_transit_effect_add()
27635 * @param transit Transit object.
27636 * @param from_r RGB R when effect begins.
27637 * @param from_g RGB G when effect begins.
27638 * @param from_b RGB B when effect begins.
27639 * @param from_a RGB A when effect begins.
27640 * @param to_r RGB R when effect ends.
27641 * @param to_g RGB G when effect ends.
27642 * @param to_b RGB B when effect ends.
27643 * @param to_a RGB A when effect ends.
27644 * @return Color effect context data.
27648 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);
27651 * Add the Fade Effect to Elm_Transit.
27653 * @note This API is one of the facades. It creates fade effect context
27654 * and add it's required APIs to elm_transit_effect_add.
27655 * @note This effect is applied to each pair of objects in the order they are listed
27656 * in the transit list of objects. The first object in the pair will be the
27657 * "before" object and the second will be the "after" object.
27659 * @see elm_transit_effect_add()
27661 * @param transit Transit object.
27662 * @return Fade effect context data.
27665 * @warning It is highly recommended just create a transit with this effect when
27666 * the window that the objects of the transit belongs has already been created.
27667 * This is because this effect needs the color information about the objects,
27668 * and if the window was not created yet, it can get a wrong information.
27670 EAPI Elm_Transit_Effect *elm_transit_effect_fade_add(Elm_Transit *transit);
27673 * Add the Blend Effect to Elm_Transit.
27675 * @note This API is one of the facades. It creates blend effect context
27676 * and add it's required APIs to elm_transit_effect_add.
27677 * @note This effect is applied to each pair of objects in the order they are listed
27678 * in the transit list of objects. The first object in the pair will be the
27679 * "before" object and the second will be the "after" object.
27681 * @see elm_transit_effect_add()
27683 * @param transit Transit object.
27684 * @return Blend 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 color 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_blend_add(Elm_Transit *transit);
27695 * Add the Rotation Effect to Elm_Transit.
27697 * @note This API is one of the facades. It creates rotation effect context
27698 * and add it's required APIs to elm_transit_effect_add.
27700 * @see elm_transit_effect_add()
27702 * @param transit Transit object.
27703 * @param from_degree Degree when effect begins.
27704 * @param to_degree Degree when effect is ends.
27705 * @return Rotation effect context data.
27708 * @warning It is highly recommended just create a transit with this effect when
27709 * the window that the objects of the transit belongs has already been created.
27710 * This is because this effect needs the geometry information about the objects,
27711 * and if the window was not created yet, it can get a wrong information.
27713 EAPI Elm_Transit_Effect *elm_transit_effect_rotation_add(Elm_Transit *transit, float from_degree, float to_degree);
27716 * Add the ImageAnimation Effect to Elm_Transit.
27718 * @note This API is one of the facades. It creates image animation effect context
27719 * and add it's required APIs to elm_transit_effect_add.
27720 * The @p images parameter is a list images paths. This list and
27721 * its contents will be deleted at the end of the effect by
27722 * elm_transit_effect_image_animation_context_free() function.
27726 * char buf[PATH_MAX];
27727 * Eina_List *images = NULL;
27728 * Elm_Transit *transi = elm_transit_add();
27730 * snprintf(buf, sizeof(buf), "%s/images/icon_11.png", PACKAGE_DATA_DIR);
27731 * images = eina_list_append(images, eina_stringshare_add(buf));
27733 * snprintf(buf, sizeof(buf), "%s/images/logo_small.png", PACKAGE_DATA_DIR);
27734 * images = eina_list_append(images, eina_stringshare_add(buf));
27735 * elm_transit_effect_image_animation_add(transi, images);
27739 * @see elm_transit_effect_add()
27741 * @param transit Transit object.
27742 * @param images Eina_List of images file paths. This list and
27743 * its contents will be deleted at the end of the effect by
27744 * elm_transit_effect_image_animation_context_free() function.
27745 * @return Image Animation effect context data.
27749 EAPI Elm_Transit_Effect *elm_transit_effect_image_animation_add(Elm_Transit *transit, Eina_List *images);
27754 typedef struct _Elm_Store Elm_Store;
27755 typedef struct _Elm_Store_Filesystem Elm_Store_Filesystem;
27756 typedef struct _Elm_Store_Item Elm_Store_Item;
27757 typedef struct _Elm_Store_Item_Filesystem Elm_Store_Item_Filesystem;
27758 typedef struct _Elm_Store_Item_Info Elm_Store_Item_Info;
27759 typedef struct _Elm_Store_Item_Info_Filesystem Elm_Store_Item_Info_Filesystem;
27760 typedef struct _Elm_Store_Item_Mapping Elm_Store_Item_Mapping;
27761 typedef struct _Elm_Store_Item_Mapping_Empty Elm_Store_Item_Mapping_Empty;
27762 typedef struct _Elm_Store_Item_Mapping_Icon Elm_Store_Item_Mapping_Icon;
27763 typedef struct _Elm_Store_Item_Mapping_Photo Elm_Store_Item_Mapping_Photo;
27764 typedef struct _Elm_Store_Item_Mapping_Custom Elm_Store_Item_Mapping_Custom;
27766 typedef Eina_Bool (*Elm_Store_Item_List_Cb) (void *data, Elm_Store_Item_Info *info);
27767 typedef void (*Elm_Store_Item_Fetch_Cb) (void *data, Elm_Store_Item *sti);
27768 typedef void (*Elm_Store_Item_Unfetch_Cb) (void *data, Elm_Store_Item *sti);
27769 typedef void *(*Elm_Store_Item_Mapping_Cb) (void *data, Elm_Store_Item *sti, const char *part);
27773 ELM_STORE_ITEM_MAPPING_NONE = 0,
27774 ELM_STORE_ITEM_MAPPING_LABEL, // const char * -> label
27775 ELM_STORE_ITEM_MAPPING_STATE, // Eina_Bool -> state
27776 ELM_STORE_ITEM_MAPPING_ICON, // char * -> icon path
27777 ELM_STORE_ITEM_MAPPING_PHOTO, // char * -> photo path
27778 ELM_STORE_ITEM_MAPPING_CUSTOM, // item->custom(it->data, it, part) -> void * (-> any)
27779 // can add more here as needed by common apps
27780 ELM_STORE_ITEM_MAPPING_LAST
27781 } Elm_Store_Item_Mapping_Type;
27783 struct _Elm_Store_Item_Mapping_Icon
27785 // FIXME: allow edje file icons
27787 Elm_Icon_Lookup_Order lookup_order;
27788 Eina_Bool standard_name : 1;
27789 Eina_Bool no_scale : 1;
27790 Eina_Bool smooth : 1;
27791 Eina_Bool scale_up : 1;
27792 Eina_Bool scale_down : 1;
27795 struct _Elm_Store_Item_Mapping_Empty
27800 struct _Elm_Store_Item_Mapping_Photo
27805 struct _Elm_Store_Item_Mapping_Custom
27807 Elm_Store_Item_Mapping_Cb func;
27810 struct _Elm_Store_Item_Mapping
27812 Elm_Store_Item_Mapping_Type type;
27817 Elm_Store_Item_Mapping_Empty empty;
27818 Elm_Store_Item_Mapping_Icon icon;
27819 Elm_Store_Item_Mapping_Photo photo;
27820 Elm_Store_Item_Mapping_Custom custom;
27821 // add more types here
27825 struct _Elm_Store_Item_Info
27827 Elm_Genlist_Item_Class *item_class;
27828 const Elm_Store_Item_Mapping *mapping;
27833 struct _Elm_Store_Item_Info_Filesystem
27835 Elm_Store_Item_Info base;
27839 #define ELM_STORE_ITEM_MAPPING_END { ELM_STORE_ITEM_MAPPING_NONE, NULL, 0, { .empty = { EINA_TRUE } } }
27840 #define ELM_STORE_ITEM_MAPPING_OFFSET(st, it) offsetof(st, it)
27842 EAPI void elm_store_free(Elm_Store *st);
27844 EAPI Elm_Store *elm_store_filesystem_new(void);
27845 EAPI void elm_store_filesystem_directory_set(Elm_Store *st, const char *dir) EINA_ARG_NONNULL(1);
27846 EAPI const char *elm_store_filesystem_directory_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
27847 EAPI const char *elm_store_item_filesystem_path_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27849 EAPI void elm_store_target_genlist_set(Elm_Store *st, Evas_Object *obj) EINA_ARG_NONNULL(1);
27851 EAPI void elm_store_cache_set(Elm_Store *st, int max) EINA_ARG_NONNULL(1);
27852 EAPI int elm_store_cache_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
27853 EAPI void elm_store_list_func_set(Elm_Store *st, Elm_Store_Item_List_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
27854 EAPI void elm_store_fetch_func_set(Elm_Store *st, Elm_Store_Item_Fetch_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
27855 EAPI void elm_store_fetch_thread_set(Elm_Store *st, Eina_Bool use_thread) EINA_ARG_NONNULL(1);
27856 EAPI Eina_Bool elm_store_fetch_thread_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
27858 EAPI void elm_store_unfetch_func_set(Elm_Store *st, Elm_Store_Item_Unfetch_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
27859 EAPI void elm_store_sorted_set(Elm_Store *st, Eina_Bool sorted) EINA_ARG_NONNULL(1);
27860 EAPI Eina_Bool elm_store_sorted_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
27861 EAPI void elm_store_item_data_set(Elm_Store_Item *sti, void *data) EINA_ARG_NONNULL(1);
27862 EAPI void *elm_store_item_data_get(Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27863 EAPI const Elm_Store *elm_store_item_store_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27864 EAPI const Elm_Genlist_Item *elm_store_item_genlist_item_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27867 * @defgroup SegmentControl SegmentControl
27868 * @ingroup Elementary
27870 * @image html img/widget/segment_control/preview-00.png
27871 * @image latex img/widget/segment_control/preview-00.eps width=\textwidth
27873 * @image html img/segment_control.png
27874 * @image latex img/segment_control.eps width=\textwidth
27876 * Segment control widget is a horizontal control made of multiple segment
27877 * items, each segment item functioning similar to discrete two state button.
27878 * A segment control groups the items together and provides compact
27879 * single button with multiple equal size segments.
27881 * Segment item size is determined by base widget
27882 * size and the number of items added.
27883 * Only one segment item can be at selected state. A segment item can display
27884 * combination of Text and any Evas_Object like Images or other widget.
27886 * Smart callbacks one can listen to:
27887 * - "changed" - When the user clicks on a segment item which is not
27888 * previously selected and get selected. The event_info parameter is the
27889 * segment item pointer.
27891 * Available styles for it:
27894 * Here is an example on its usage:
27895 * @li @ref segment_control_example
27899 * @addtogroup SegmentControl
27903 typedef struct _Elm_Segment_Item Elm_Segment_Item; /**< Item handle for a segment control widget. */
27906 * Add a new segment control widget to the given parent Elementary
27907 * (container) object.
27909 * @param parent The parent object.
27910 * @return a new segment control widget handle or @c NULL, on errors.
27912 * This function inserts a new segment control widget on the canvas.
27914 * @ingroup SegmentControl
27916 EAPI Evas_Object *elm_segment_control_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
27919 * Append a new item to the segment control object.
27921 * @param obj The segment control object.
27922 * @param icon The icon object to use for the left side of the item. An
27923 * icon can be any Evas object, but usually it is an icon created
27924 * with elm_icon_add().
27925 * @param label The label of the item.
27926 * Note that, NULL is different from empty string "".
27927 * @return The created item or @c NULL upon failure.
27929 * A new item will be created and appended to the segment control, i.e., will
27930 * be set as @b last item.
27932 * If it should be inserted at another position,
27933 * elm_segment_control_item_insert_at() should be used instead.
27935 * Items created with this function can be deleted with function
27936 * elm_segment_control_item_del() or elm_segment_control_item_del_at().
27938 * @note @p label set to @c NULL is different from empty string "".
27940 * only has icon, it will be displayed bigger and centered. If it has
27941 * icon and label, even that an empty string, icon will be smaller and
27942 * positioned at left.
27946 * sc = elm_segment_control_add(win);
27947 * ic = elm_icon_add(win);
27948 * elm_icon_file_set(ic, "path/to/image", NULL);
27949 * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
27950 * elm_segment_control_item_add(sc, ic, "label");
27951 * evas_object_show(sc);
27954 * @see elm_segment_control_item_insert_at()
27955 * @see elm_segment_control_item_del()
27957 * @ingroup SegmentControl
27959 EAPI Elm_Segment_Item *elm_segment_control_item_add(Evas_Object *obj, Evas_Object *icon, const char *label) EINA_ARG_NONNULL(1);
27962 * Insert a new item to the segment control object at specified position.
27964 * @param obj The segment control object.
27965 * @param icon The icon object to use for the left side of the item. An
27966 * icon can be any Evas object, but usually it is an icon created
27967 * with elm_icon_add().
27968 * @param label The label of the item.
27969 * @param index Item position. Value should be between 0 and items count.
27970 * @return The created item or @c NULL upon failure.
27972 * Index values must be between @c 0, when item will be prepended to
27973 * segment control, and items count, that can be get with
27974 * elm_segment_control_item_count_get(), case when item will be appended
27975 * to segment control, just like elm_segment_control_item_add().
27977 * Items created with this function can be deleted with function
27978 * elm_segment_control_item_del() or elm_segment_control_item_del_at().
27980 * @note @p label set to @c NULL is different from empty string "".
27982 * only has icon, it will be displayed bigger and centered. If it has
27983 * icon and label, even that an empty string, icon will be smaller and
27984 * positioned at left.
27986 * @see elm_segment_control_item_add()
27987 * @see elm_segment_control_item_count_get()
27988 * @see elm_segment_control_item_del()
27990 * @ingroup SegmentControl
27992 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);
27995 * Remove a segment control item from its parent, deleting it.
27997 * @param it The item to be removed.
27999 * Items can be added with elm_segment_control_item_add() or
28000 * elm_segment_control_item_insert_at().
28002 * @ingroup SegmentControl
28004 EAPI void elm_segment_control_item_del(Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
28007 * Remove a segment control item at given index from its parent,
28010 * @param obj The segment control object.
28011 * @param index The position of the segment control item to be deleted.
28013 * Items can be added with elm_segment_control_item_add() or
28014 * elm_segment_control_item_insert_at().
28016 * @ingroup SegmentControl
28018 EAPI void elm_segment_control_item_del_at(Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
28021 * Get the Segment items count from segment control.
28023 * @param obj The segment control object.
28024 * @return Segment items count.
28026 * It will just return the number of items added to segment control @p obj.
28028 * @ingroup SegmentControl
28030 EAPI int elm_segment_control_item_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
28033 * Get the item placed at specified index.
28035 * @param obj The segment control object.
28036 * @param index The index of the segment item.
28037 * @return The segment control item or @c NULL on failure.
28039 * Index is the position of an item in segment control widget. Its
28040 * range is from @c 0 to <tt> count - 1 </tt>.
28041 * Count is the number of items, that can be get with
28042 * elm_segment_control_item_count_get().
28044 * @ingroup SegmentControl
28046 EAPI Elm_Segment_Item *elm_segment_control_item_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
28049 * Get the label of item.
28051 * @param obj The segment control object.
28052 * @param index The index of the segment item.
28053 * @return The label of the item at @p index.
28055 * The return value is a pointer to the label associated to the item when
28056 * it was created, with function elm_segment_control_item_add(), or later
28057 * with function elm_segment_control_item_label_set. If no label
28058 * was passed as argument, it will return @c NULL.
28060 * @see elm_segment_control_item_label_set() for more details.
28061 * @see elm_segment_control_item_add()
28063 * @ingroup SegmentControl
28065 EAPI const char *elm_segment_control_item_label_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
28068 * Set the label of item.
28070 * @param it The item of segment control.
28071 * @param text The label of item.
28073 * The label to be displayed by the item.
28074 * Label will be at right of the icon (if set).
28076 * If a label was passed as argument on item creation, with function
28077 * elm_control_segment_item_add(), it will be already
28078 * displayed by the item.
28080 * @see elm_segment_control_item_label_get()
28081 * @see elm_segment_control_item_add()
28083 * @ingroup SegmentControl
28085 EAPI void elm_segment_control_item_label_set(Elm_Segment_Item* it, const char* label) EINA_ARG_NONNULL(1);
28088 * Get the icon associated to the item.
28090 * @param obj The segment control object.
28091 * @param index The index of the segment item.
28092 * @return The left side icon associated to the item at @p index.
28094 * The return value is a pointer to the icon associated to the item when
28095 * it was created, with function elm_segment_control_item_add(), or later
28096 * with function elm_segment_control_item_icon_set(). If no icon
28097 * was passed as argument, it will return @c NULL.
28099 * @see elm_segment_control_item_add()
28100 * @see elm_segment_control_item_icon_set()
28102 * @ingroup SegmentControl
28104 EAPI Evas_Object *elm_segment_control_item_icon_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
28107 * Set the icon associated to the item.
28109 * @param it The segment control item.
28110 * @param icon The icon object to associate with @p it.
28112 * The icon object to use at left side of the item. An
28113 * icon can be any Evas object, but usually it is an icon created
28114 * with elm_icon_add().
28116 * Once the icon object is set, a previously set one will be deleted.
28117 * @warning Setting the same icon for two items will cause the icon to
28118 * dissapear from the first item.
28120 * If an icon was passed as argument on item creation, with function
28121 * elm_segment_control_item_add(), it will be already
28122 * associated to the item.
28124 * @see elm_segment_control_item_add()
28125 * @see elm_segment_control_item_icon_get()
28127 * @ingroup SegmentControl
28129 EAPI void elm_segment_control_item_icon_set(Elm_Segment_Item *it, Evas_Object *icon) EINA_ARG_NONNULL(1);
28132 * Get the index of an item.
28134 * @param it The segment control item.
28135 * @return The position of item in segment control widget.
28137 * Index is the position of an item in segment control widget. Its
28138 * range is from @c 0 to <tt> count - 1 </tt>.
28139 * Count is the number of items, that can be get with
28140 * elm_segment_control_item_count_get().
28142 * @ingroup SegmentControl
28144 EAPI int elm_segment_control_item_index_get(const Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
28147 * Get the base object of the item.
28149 * @param it The segment control item.
28150 * @return The base object associated with @p it.
28152 * Base object is the @c Evas_Object that represents that item.
28154 * @ingroup SegmentControl
28156 EAPI Evas_Object *elm_segment_control_item_object_get(const Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
28159 * Get the selected item.
28161 * @param obj The segment control object.
28162 * @return The selected item or @c NULL if none of segment items is
28165 * The selected item can be unselected with function
28166 * elm_segment_control_item_selected_set().
28168 * The selected item always will be highlighted on segment control.
28170 * @ingroup SegmentControl
28172 EAPI Elm_Segment_Item *elm_segment_control_item_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
28175 * Set the selected state of an item.
28177 * @param it The segment control item
28178 * @param select The selected state
28180 * This sets the selected state of the given item @p it.
28181 * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
28183 * If a new item is selected the previosly selected will be unselected.
28184 * Previoulsy selected item can be get with function
28185 * elm_segment_control_item_selected_get().
28187 * The selected item always will be highlighted on segment control.
28189 * @see elm_segment_control_item_selected_get()
28191 * @ingroup SegmentControl
28193 EAPI void elm_segment_control_item_selected_set(Elm_Segment_Item *it, Eina_Bool select) EINA_ARG_NONNULL(1);
28200 * @defgroup Grid Grid
28202 * The grid is a grid layout widget that lays out a series of children as a
28203 * fixed "grid" of widgets using a given percentage of the grid width and
28204 * height each using the child object.
28206 * The Grid uses a "Virtual resolution" that is stretched to fill the grid
28207 * widgets size itself. The default is 100 x 100, so that means the
28208 * position and sizes of children will effectively be percentages (0 to 100)
28209 * of the width or height of the grid widget
28215 * Add a new grid to the parent
28217 * @param parent The parent object
28218 * @return The new object or NULL if it cannot be created
28222 EAPI Evas_Object *elm_grid_add(Evas_Object *parent);
28225 * Set the virtual size of the grid
28227 * @param obj The grid object
28228 * @param w The virtual width of the grid
28229 * @param h The virtual height of the grid
28233 EAPI void elm_grid_size_set(Evas_Object *obj, int w, int h);
28236 * Get the virtual size of the grid
28238 * @param obj The grid object
28239 * @param w Pointer to integer to store the virtual width of the grid
28240 * @param h Pointer to integer to store the virtual height of the grid
28244 EAPI void elm_grid_size_get(Evas_Object *obj, int *w, int *h);
28247 * Pack child at given position and size
28249 * @param obj The grid object
28250 * @param subobj The child to pack
28251 * @param x The virtual x coord at which to pack it
28252 * @param y The virtual y coord at which to pack it
28253 * @param w The virtual width at which to pack it
28254 * @param h The virtual height at which to pack it
28258 EAPI void elm_grid_pack(Evas_Object *obj, Evas_Object *subobj, int x, int y, int w, int h);
28261 * Unpack a child from a grid object
28263 * @param obj The grid object
28264 * @param subobj The child to unpack
28268 EAPI void elm_grid_unpack(Evas_Object *obj, Evas_Object *subobj);
28271 * Faster way to remove all child objects from a grid object.
28273 * @param obj The grid object
28274 * @param clear If true, it will delete just removed children
28278 EAPI void elm_grid_clear(Evas_Object *obj, Eina_Bool clear);
28281 * Set packing of an existing child at to position and size
28283 * @param subobj The child to set packing of
28284 * @param x The virtual x coord at which to pack it
28285 * @param y The virtual y coord at which to pack it
28286 * @param w The virtual width at which to pack it
28287 * @param h The virtual height at which to pack it
28291 EAPI void elm_grid_pack_set(Evas_Object *subobj, int x, int y, int w, int h);
28294 * get packing of a child
28296 * @param subobj The child to query
28297 * @param x Pointer to integer to store the virtual x coord
28298 * @param y Pointer to integer to store the virtual y coord
28299 * @param w Pointer to integer to store the virtual width
28300 * @param h Pointer to integer to store the virtual height
28304 EAPI void elm_grid_pack_get(Evas_Object *subobj, int *x, int *y, int *w, int *h);
28310 EAPI Evas_Object *elm_factory_add(Evas_Object *parent);
28311 EINA_DEPRECATED EAPI void elm_factory_content_set(Evas_Object *obj, Evas_Object *content);
28312 EINA_DEPRECATED EAPI Evas_Object *elm_factory_content_get(const Evas_Object *obj);
28313 EAPI void elm_factory_maxmin_mode_set(Evas_Object *obj, Eina_Bool enabled);
28314 EAPI Eina_Bool elm_factory_maxmin_mode_get(const Evas_Object *obj);
28315 EAPI void elm_factory_maxmin_reset_set(Evas_Object *obj);
28318 * @defgroup Video Video
28320 * @addtogroup Video
28323 * Elementary comes with two object that help design application that need
28324 * to display video. The main one, Elm_Video, display a video by using Emotion.
28325 * It does embedded the video inside an Edje object, so you can do some
28326 * animation depending on the video state change. It does also implement a
28327 * ressource management policy to remove this burden from the application writer.
28329 * The second one, Elm_Player is a video player that need to be linked with and Elm_Video.
28330 * It take care of updating its content according to Emotion event and provide a
28331 * way to theme itself. It also does automatically raise the priority of the
28332 * linked Elm_Video so it will use the video decoder if available. It also does
28333 * activate the remember function on the linked Elm_Video object.
28335 * Signals that you can add callback for are :
28337 * "forward,clicked" - the user clicked the forward button.
28338 * "info,clicked" - the user clicked the info button.
28339 * "next,clicked" - the user clicked the next button.
28340 * "pause,clicked" - the user clicked the pause button.
28341 * "play,clicked" - the user clicked the play button.
28342 * "prev,clicked" - the user clicked the prev button.
28343 * "rewind,clicked" - the user clicked the rewind button.
28344 * "stop,clicked" - the user clicked the stop button.
28346 * Default contents parts of the player widget that you can use for are:
28347 * @li "video" - A video of the player
28352 * @brief Add a new Elm_Player object to the given parent Elementary (container) object.
28354 * @param parent The parent object
28355 * @return a new player widget handle or @c NULL, on errors.
28357 * This function inserts a new player widget on the canvas.
28359 * @see elm_object_part_content_set()
28363 EAPI Evas_Object *elm_player_add(Evas_Object *parent);
28366 * @brief Link a Elm_Payer with an Elm_Video object.
28368 * @param player the Elm_Player object.
28369 * @param video The Elm_Video object.
28371 * This mean that action on the player widget will affect the
28372 * video object and the state of the video will be reflected in
28373 * the player itself.
28375 * @see elm_player_add()
28376 * @see elm_video_add()
28377 * @deprecated use elm_object_part_content_set() instead
28381 EINA_DEPRECATED EAPI void elm_player_video_set(Evas_Object *player, Evas_Object *video);
28384 * @brief Add a new Elm_Video object to the given parent Elementary (container) object.
28386 * @param parent The parent object
28387 * @return a new video widget handle or @c NULL, on errors.
28389 * This function inserts a new video widget on the canvas.
28391 * @seeelm_video_file_set()
28392 * @see elm_video_uri_set()
28396 EAPI Evas_Object *elm_video_add(Evas_Object *parent);
28399 * @brief Define the file that will be the video source.
28401 * @param video The video object to define the file for.
28402 * @param filename The file to target.
28404 * This function will explicitly define a filename as a source
28405 * for the video of the Elm_Video object.
28407 * @see elm_video_uri_set()
28408 * @see elm_video_add()
28409 * @see elm_player_add()
28413 EAPI void elm_video_file_set(Evas_Object *video, const char *filename);
28416 * @brief Define the uri that will be the video source.
28418 * @param video The video object to define the file for.
28419 * @param uri The uri to target.
28421 * This function will define an uri as a source for the video of the
28422 * Elm_Video object. URI could be remote source of video, like http:// or local source
28423 * like for example WebCam who are most of the time v4l2:// (but that depend and
28424 * you should use Emotion API to request and list the available Webcam on your system).
28426 * @see elm_video_file_set()
28427 * @see elm_video_add()
28428 * @see elm_player_add()
28432 EAPI void elm_video_uri_set(Evas_Object *video, const char *uri);
28435 * @brief Get the underlying Emotion object.
28437 * @param video The video object to proceed the request on.
28438 * @return the underlying Emotion object.
28442 EAPI Evas_Object *elm_video_emotion_get(const Evas_Object *video);
28445 * @brief Start to play the video
28447 * @param video The video object to proceed the request on.
28449 * Start to play the video and cancel all suspend state.
28453 EAPI void elm_video_play(Evas_Object *video);
28456 * @brief Pause the video
28458 * @param video The video object to proceed the request on.
28460 * Pause the video and start a timer to trigger suspend mode.
28464 EAPI void elm_video_pause(Evas_Object *video);
28467 * @brief Stop the video
28469 * @param video The video object to proceed the request on.
28471 * Stop the video and put the emotion in deep sleep mode.
28475 EAPI void elm_video_stop(Evas_Object *video);
28478 * @brief Is the video actually playing.
28480 * @param video The video object to proceed the request on.
28481 * @return EINA_TRUE if the video is actually playing.
28483 * You should consider watching event on the object instead of polling
28484 * the object state.
28488 EAPI Eina_Bool elm_video_is_playing(const Evas_Object *video);
28491 * @brief Is it possible to seek inside the video.
28493 * @param video The video object to proceed the request on.
28494 * @return EINA_TRUE if is possible to seek inside the video.
28498 EAPI Eina_Bool elm_video_is_seekable(const Evas_Object *video);
28501 * @brief Is the audio muted.
28503 * @param video The video object to proceed the request on.
28504 * @return EINA_TRUE if the audio is muted.
28508 EAPI Eina_Bool elm_video_audio_mute_get(const Evas_Object *video);
28511 * @brief Change the mute state of the Elm_Video object.
28513 * @param video The video object to proceed the request on.
28514 * @param mute The new mute state.
28518 EAPI void elm_video_audio_mute_set(Evas_Object *video, Eina_Bool mute);
28521 * @brief Get the audio level of the current video.
28523 * @param video The video object to proceed the request on.
28524 * @return the current audio level.
28528 EAPI double elm_video_audio_level_get(const Evas_Object *video);
28531 * @brief Set the audio level of anElm_Video object.
28533 * @param video The video object to proceed the request on.
28534 * @param volume The new audio volume.
28538 EAPI void elm_video_audio_level_set(Evas_Object *video, double volume);
28540 EAPI double elm_video_play_position_get(const Evas_Object *video);
28541 EAPI void elm_video_play_position_set(Evas_Object *video, double position);
28542 EAPI double elm_video_play_length_get(const Evas_Object *video);
28543 EAPI void elm_video_remember_position_set(Evas_Object *video, Eina_Bool remember);
28544 EAPI Eina_Bool elm_video_remember_position_get(const Evas_Object *video);
28545 EAPI const char *elm_video_title_get(const Evas_Object *video);
28551 * @defgroup Naviframe Naviframe
28552 * @ingroup Elementary
28554 * @brief Naviframe is a kind of view manager for the applications.
28556 * Naviframe provides functions to switch different pages with stack
28557 * mechanism. It means if one page(item) needs to be changed to the new one,
28558 * then naviframe would push the new page to it's internal stack. Of course,
28559 * it can be back to the previous page by popping the top page. Naviframe
28560 * provides some transition effect while the pages are switching (same as
28563 * Since each item could keep the different styles, users could keep the
28564 * same look & feel for the pages or different styles for the items in it's
28567 * Signals that you can add callback for are:
28568 * @li "transition,finished" - When the transition is finished in changing
28570 * @li "title,clicked" - User clicked title area
28572 * Default contents parts of the naviframe items that you can use for are:
28573 * @li "default" - A main content of the page
28574 * @li "icon" - A icon in the title area
28575 * @li "prev_btn" - A button to go to the previous page
28576 * @li "next_btn" - A button to go to the next page
28578 * Default text parts of the naviframe items that you can use for are:
28579 * @li "default" - Title label in the title area
28580 * @li "subtitle" - Sub-title label in the title area
28582 * @ref tutorial_naviframe gives a good overview of the usage of the API.
28586 * @addtogroup Naviframe
28591 * @brief Add a new Naviframe object to the parent.
28593 * @param parent Parent object
28594 * @return New object or @c NULL, if it cannot be created
28596 * @ingroup Naviframe
28598 EAPI Evas_Object *elm_naviframe_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
28600 * @brief Push a new item to the top of the naviframe stack (and show it).
28602 * @param obj The naviframe object
28603 * @param title_label The label in the title area. The name of the title
28604 * label part is "elm.text.title"
28605 * @param prev_btn The button to go to the previous item. If it is NULL,
28606 * then naviframe will create a back button automatically. The name of
28607 * the prev_btn part is "elm.swallow.prev_btn"
28608 * @param next_btn The button to go to the next item. Or It could be just an
28609 * extra function button. The name of the next_btn part is
28610 * "elm.swallow.next_btn"
28611 * @param content The main content object. The name of content part is
28612 * "elm.swallow.content"
28613 * @param item_style The current item style name. @c NULL would be default.
28614 * @return The created item or @c NULL upon failure.
28616 * The item pushed becomes one page of the naviframe, this item will be
28617 * deleted when it is popped.
28619 * @see also elm_naviframe_item_style_set()
28620 * @see also elm_naviframe_item_insert_before()
28621 * @see also elm_naviframe_item_insert_after()
28623 * The following styles are available for this item:
28626 * @ingroup Naviframe
28628 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);
28630 * @brief Insert a new item into the naviframe before item @p before.
28632 * @param before The naviframe item to insert before.
28633 * @param title_label The label in the title area. The name of the title
28634 * label part is "elm.text.title"
28635 * @param prev_btn The button to go to the previous item. If it is NULL,
28636 * then naviframe will create a back button automatically. The name of
28637 * the prev_btn part is "elm.swallow.prev_btn"
28638 * @param next_btn The button to go to the next item. Or It could be just an
28639 * extra function button. The name of the next_btn part is
28640 * "elm.swallow.next_btn"
28641 * @param content The main content object. The name of content part is
28642 * "elm.swallow.content"
28643 * @param item_style The current item style name. @c NULL would be default.
28644 * @return The created item or @c NULL upon failure.
28646 * The item is inserted into the naviframe straight away without any
28647 * transition operations. This item will be deleted when it is popped.
28649 * @see also elm_naviframe_item_style_set()
28650 * @see also elm_naviframe_item_push()
28651 * @see also elm_naviframe_item_insert_after()
28653 * The following styles are available for this item:
28656 * @ingroup Naviframe
28658 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);
28660 * @brief Insert a new item into the naviframe after item @p after.
28662 * @param after The naviframe item to insert after.
28663 * @param title_label The label in the title area. The name of the title
28664 * label part is "elm.text.title"
28665 * @param prev_btn The button to go to the previous item. If it is NULL,
28666 * then naviframe will create a back button automatically. The name of
28667 * the prev_btn part is "elm.swallow.prev_btn"
28668 * @param next_btn The button to go to the next item. Or It could be just an
28669 * extra function button. The name of the next_btn part is
28670 * "elm.swallow.next_btn"
28671 * @param content The main content object. The name of content part is
28672 * "elm.swallow.content"
28673 * @param item_style The current item style name. @c NULL would be default.
28674 * @return The created item or @c NULL upon failure.
28676 * The item is inserted into the naviframe straight away without any
28677 * transition operations. This item will be deleted when it is popped.
28679 * @see also elm_naviframe_item_style_set()
28680 * @see also elm_naviframe_item_push()
28681 * @see also elm_naviframe_item_insert_before()
28683 * The following styles are available for this item:
28686 * @ingroup Naviframe
28688 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);
28690 * @brief Pop an item that is on top of the stack
28692 * @param obj The naviframe object
28693 * @return @c NULL or the content object(if the
28694 * elm_naviframe_content_preserve_on_pop_get is true).
28696 * This pops an item that is on the top(visible) of the naviframe, makes it
28697 * disappear, then deletes the item. The item that was underneath it on the
28698 * stack will become visible.
28700 * @see also elm_naviframe_content_preserve_on_pop_get()
28702 * @ingroup Naviframe
28704 EAPI Evas_Object *elm_naviframe_item_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
28706 * @brief Pop the items between the top and the above one on the given item.
28708 * @param it The naviframe item
28710 * @ingroup Naviframe
28712 EAPI void elm_naviframe_item_pop_to(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
28714 * Promote an item already in the naviframe stack to the top of the stack
28716 * @param it The naviframe item
28718 * This will take the indicated item and promote it to the top of the stack
28719 * as if it had been pushed there. The item must already be inside the
28720 * naviframe stack to work.
28723 EAPI void elm_naviframe_item_promote(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
28725 * @brief Delete the given item instantly.
28727 * @param it The naviframe item
28729 * This just deletes the given item from the naviframe item list instantly.
28730 * So this would not emit any signals for view transitions but just change
28731 * the current view if the given item is a top one.
28733 * @ingroup Naviframe
28735 EAPI void elm_naviframe_item_del(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
28737 * @brief preserve the content objects when items are popped.
28739 * @param obj The naviframe object
28740 * @param preserve Enable the preserve mode if EINA_TRUE, disable otherwise
28742 * @see also elm_naviframe_content_preserve_on_pop_get()
28744 * @ingroup Naviframe
28746 EAPI void elm_naviframe_content_preserve_on_pop_set(Evas_Object *obj, Eina_Bool preserve) EINA_ARG_NONNULL(1);
28748 * @brief Get a value whether preserve mode is enabled or not.
28750 * @param obj The naviframe object
28751 * @return If @c EINA_TRUE, preserve mode is enabled
28753 * @see also elm_naviframe_content_preserve_on_pop_set()
28755 * @ingroup Naviframe
28757 EAPI Eina_Bool elm_naviframe_content_preserve_on_pop_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
28759 * @brief Get a top item on the naviframe stack
28761 * @param obj The naviframe object
28762 * @return The top item on the naviframe stack or @c NULL, if the stack is
28765 * @ingroup Naviframe
28767 EAPI Elm_Object_Item *elm_naviframe_top_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
28769 * @brief Get a bottom item on the naviframe stack
28771 * @param obj The naviframe object
28772 * @return The bottom item on the naviframe stack or @c NULL, if the stack is
28775 * @ingroup Naviframe
28777 EAPI Elm_Object_Item *elm_naviframe_bottom_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
28779 * @brief Set an item style
28781 * @param obj The naviframe item
28782 * @param item_style The current item style name. @c NULL would be default
28784 * The following styles are available for this item:
28787 * @see also elm_naviframe_item_style_get()
28789 * @ingroup Naviframe
28791 EAPI void elm_naviframe_item_style_set(Elm_Object_Item *it, const char *item_style) EINA_ARG_NONNULL(1);
28793 * @brief Get an item style
28795 * @param obj The naviframe item
28796 * @return The current item style name
28798 * @see also elm_naviframe_item_style_set()
28800 * @ingroup Naviframe
28802 EAPI const char *elm_naviframe_item_style_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
28804 * @brief Show/Hide the title area
28806 * @param it The naviframe item
28807 * @param visible If @c EINA_TRUE, title area will be visible, hidden
28810 * When the title area is invisible, then the controls would be hidden so as * to expand the content area to full-size.
28812 * @see also elm_naviframe_item_title_visible_get()
28814 * @ingroup Naviframe
28816 EAPI void elm_naviframe_item_title_visible_set(Elm_Object_Item *it, Eina_Bool visible) EINA_ARG_NONNULL(1);
28818 * @brief Get a value whether title area is visible or not.
28820 * @param it The naviframe item
28821 * @return If @c EINA_TRUE, title area is visible
28823 * @see also elm_naviframe_item_title_visible_set()
28825 * @ingroup Naviframe
28827 EAPI Eina_Bool elm_naviframe_item_title_visible_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
28830 * @brief Set creating prev button automatically or not
28832 * @param obj The naviframe object
28833 * @param auto_pushed If @c EINA_TRUE, the previous button(back button) will
28834 * be created internally when you pass the @c NULL to the prev_btn
28835 * parameter in elm_naviframe_item_push
28837 * @see also elm_naviframe_item_push()
28839 EAPI void elm_naviframe_prev_btn_auto_pushed_set(Evas_Object *obj, Eina_Bool auto_pushed) EINA_ARG_NONNULL(1);
28841 * @brief Get a value whether prev button(back button) will be auto pushed or
28844 * @param obj The naviframe object
28845 * @return If @c EINA_TRUE, prev button will be auto pushed.
28847 * @see also elm_naviframe_item_push()
28848 * elm_naviframe_prev_btn_auto_pushed_set()
28850 EAPI Eina_Bool elm_naviframe_prev_btn_auto_pushed_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
28852 * @brief Get a list of all the naviframe items.
28854 * @param obj The naviframe object
28855 * @return An Eina_Inlist* of naviframe items, #Elm_Object_Item,
28856 * or @c NULL on failure.
28858 EAPI Eina_Inlist *elm_naviframe_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
28865 * @defgroup Multibuttonentry Multibuttonentry
28867 * A Multibuttonentry is a widget to allow a user enter text and manage it as a number of buttons
28868 * Each text button is inserted by pressing the "return" key. If there is no space in the current row,
28869 * a new button is added to the next row. When a text button is pressed, it will become focused.
28870 * Backspace removes the focus.
28871 * When the Multibuttonentry loses focus items longer than 1 lines are shrunk to one line.
28873 * Smart callbacks one can register:
28874 * - @c "item,selected" - when item is selected. May be called on backspace key.
28875 * - @c "item,added" - when a new multibuttonentry item is added.
28876 * - @c "item,deleted" - when a multibuttonentry item is deleted.
28877 * - @c "item,clicked" - selected item of multibuttonentry is clicked.
28878 * - @c "clicked" - when multibuttonentry is clicked.
28879 * - @c "focused" - when multibuttonentry is focused.
28880 * - @c "unfocused" - when multibuttonentry is unfocused.
28881 * - @c "expanded" - when multibuttonentry is expanded.
28882 * - @c "shrank" - when multibuttonentry is shrank.
28883 * - @c "shrank,state,changed" - when shrink mode state of multibuttonentry is changed.
28885 * Here is an example on its usage:
28886 * @li @ref multibuttonentry_example
28889 * @addtogroup Multibuttonentry
28893 typedef struct _Multibuttonentry_Item Elm_Multibuttonentry_Item;
28894 typedef Eina_Bool (*Elm_Multibuttonentry_Item_Filter_callback) (Evas_Object *obj, const char *item_label, void *item_data, void *data);
28897 * @brief Add a new multibuttonentry to the parent
28899 * @param parent The parent object
28900 * @return The new object or NULL if it cannot be created
28903 EAPI Evas_Object *elm_multibuttonentry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
28907 * @param obj The multibuttonentry object
28908 * @return The label, or NULL if none
28911 EAPI const char *elm_multibuttonentry_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
28915 * @param obj The multibuttonentry object
28916 * @param label The text label string
28919 EAPI void elm_multibuttonentry_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
28921 * Get the entry of the multibuttonentry object
28923 * @param obj The multibuttonentry object
28924 * @return The entry object, or NULL if none
28927 EAPI Evas_Object *elm_multibuttonentry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
28929 * Get the guide text
28931 * @param obj The multibuttonentry object
28932 * @return The guide text, or NULL if none
28935 EAPI const char * elm_multibuttonentry_guide_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
28937 * Set the guide text
28939 * @param obj The multibuttonentry object
28940 * @param label The guide text string
28943 EAPI void elm_multibuttonentry_guide_text_set(Evas_Object *obj, const char *guidetext) EINA_ARG_NONNULL(1);
28945 * Get the value of shrink_mode state.
28947 * @param obj The multibuttonentry object
28948 * @param the value of shrink mode state.
28951 EAPI int elm_multibuttonentry_shrink_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
28953 * Set/Unset the multibuttonentry to shrink mode state of single line
28955 * @param obj The multibuttonentry object
28956 * @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.
28959 EAPI void elm_multibuttonentry_shrink_mode_set(Evas_Object *obj, int shrink) EINA_ARG_NONNULL(1);
28961 * Prepend a new item to the multibuttonentry
28963 * @param obj The multibuttonentry object
28964 * @param label The label of new item
28965 * @param data The ponter to the data to be attached
28966 * @return A handle to the item added or NULL if not possible
28969 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_prepend(Evas_Object *obj, const char *label, void *data) EINA_ARG_NONNULL(1);
28971 * Append a new item to the multibuttonentry
28973 * @param obj The multibuttonentry object
28974 * @param label The label of new item
28975 * @param data The ponter to the data to be attached
28976 * @return A handle to the item added or NULL if not possible
28979 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_append(Evas_Object *obj, const char *label, void *data) EINA_ARG_NONNULL(1);
28981 * Add a new item to the multibuttonentry before the indicated object
28984 * @param obj The multibuttonentry object
28985 * @param before The item before which to add it
28986 * @param label The label of new item
28987 * @param data The ponter to the data to be attached
28988 * @return A handle to the item added or NULL if not possible
28991 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);
28993 * Add a new item to the multibuttonentry after the indicated object
28995 * @param obj The multibuttonentry object
28996 * @param after The item after which to add it
28997 * @param label The label of new item
28998 * @param data The ponter to the data to be attached
28999 * @return A handle to the item added or NULL if not possible
29002 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);
29004 * Get a list of items in the multibuttonentry
29006 * @param obj The multibuttonentry object
29007 * @return The list of items, or NULL if none
29010 EAPI const Eina_List *elm_multibuttonentry_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
29012 * Get the first item in the multibuttonentry
29014 * @param obj The multibuttonentry object
29015 * @return The first item, or NULL if none
29018 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
29020 * Get the last item in the multibuttonentry
29022 * @param obj The multibuttonentry object
29023 * @return The last item, or NULL if none
29026 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
29028 * Get the selected item in the multibuttonentry
29030 * @param obj The multibuttonentry object
29031 * @return The selected item, or NULL if none
29034 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
29036 * Set the selected state of an item
29038 * @param item The item
29039 * @param selected if it's EINA_TRUE, select the item otherwise, unselect the item
29042 EAPI void elm_multibuttonentry_item_select(Elm_Multibuttonentry_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
29044 * unselect all items.
29046 * @param obj The multibuttonentry object
29049 EAPI void elm_multibuttonentry_item_unselect_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
29051 * Delete a given item
29053 * @param item The item
29056 EAPI void elm_multibuttonentry_item_del(Elm_Multibuttonentry_Item *item) EINA_ARG_NONNULL(1);
29058 * Remove all items in the multibuttonentry.
29060 * @param obj The multibuttonentry object
29063 EAPI void elm_multibuttonentry_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
29065 * Get the label of a given item
29067 * @param item The item
29068 * @return The label of a given item, or NULL if none
29071 EAPI const char *elm_multibuttonentry_item_label_get(const Elm_Multibuttonentry_Item *item) EINA_ARG_NONNULL(1);
29073 * Set the label of a given item
29075 * @param item The item
29076 * @param label The text label string
29079 EAPI void elm_multibuttonentry_item_label_set(Elm_Multibuttonentry_Item *item, const char *str) EINA_ARG_NONNULL(1);
29081 * Get the previous item in the multibuttonentry
29083 * @param item The item
29084 * @return The item before the item @p item
29087 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_prev_get(const Elm_Multibuttonentry_Item *item) EINA_ARG_NONNULL(1);
29089 * Get the next item in the multibuttonentry
29091 * @param item The item
29092 * @return The item after the item @p item
29095 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_next_get(const Elm_Multibuttonentry_Item *item) EINA_ARG_NONNULL(1);
29097 * Append a item filter function for text inserted in the Multibuttonentry
29099 * Append the given callback to the list. This functions will be called
29100 * whenever any text is inserted into the Multibuttonentry, with the text to be inserted
29101 * as a parameter. The callback function is free to alter the text in any way
29102 * it wants, but it must remember to free the given pointer and update it.
29103 * If the new text is to be discarded, the function can free it and set it text
29104 * parameter to NULL. This will also prevent any following filters from being
29107 * @param obj The multibuttonentryentry object
29108 * @param func The function to use as item filter
29109 * @param data User data to pass to @p func
29112 EAPI void elm_multibuttonentry_item_filter_append(Evas_Object *obj, Elm_Multibuttonentry_Item_Filter_callback func, void *data) EINA_ARG_NONNULL(1);
29114 * Prepend a filter function for text inserted in the Multibuttentry
29116 * Prepend the given callback to the list. See elm_multibuttonentry_item_filter_append()
29117 * for more information
29119 * @param obj The multibuttonentry object
29120 * @param func The function to use as text filter
29121 * @param data User data to pass to @p func
29124 EAPI void elm_multibuttonentry_item_filter_prepend(Evas_Object *obj, Elm_Multibuttonentry_Item_Filter_callback func, void *data) EINA_ARG_NONNULL(1);
29126 * Remove a filter from the list
29128 * Removes the given callback from the filter list. See elm_multibuttonentry_item_filter_append()
29129 * for more information.
29131 * @param obj The multibuttonentry object
29132 * @param func The filter function to remove
29133 * @param data The user data passed when adding the function
29136 EAPI void elm_multibuttonentry_item_filter_remove(Evas_Object *obj, Elm_Multibuttonentry_Item_Filter_callback func, void *data) EINA_ARG_NONNULL(1);