3 * vim:ts=8:sw=3:sts=3:expandtab:cino=>5n-3f0^-2{2(0W1st0
8 @brief Elementary Widget Library
13 @image html elementary.png
17 @section intro What is Elementary?
19 This is a VERY SIMPLE toolkit. It is not meant for writing extensive desktop
20 applications (yet). Small simple ones with simple needs.
22 It is meant to make the programmers work almost brainless but give them lots
25 @li @ref Start - Go here to quickly get started with writing Apps
27 @section organization Organization
29 One can divide Elemementary into three main groups:
30 @li @ref infralist - These are modules that deal with Elementary as a whole.
31 @li @ref widgetslist - These are the widgets you'll compose your UI out of.
32 @li @ref containerslist - These are the containers which hold the widgets.
34 @section license License
36 LGPL v2 (see COPYING in the base of Elementary's source). This applies to
37 all files in the source tree.
39 @section ack Acknowledgements
40 There is a lot that goes into making a widget set, and they don't happen out of
41 nothing. It's like trying to make everyone everywhere happy, regardless of age,
42 gender, race or nationality - and that is really tough. So thanks to people and
43 organisations behind this, as listed in the @ref authors page.
48 * @defgroup Start Getting Started
50 * To write an Elementary app, you can get started with the following:
53 #include <Elementary.h>
55 elm_main(int argc, char **argv)
57 // create window(s) here and do any application init
58 elm_run(); // run main loop
59 elm_shutdown(); // after mainloop finishes running, shutdown
60 return 0; // exit 0 for exit code
65 * To use autotools (which helps in many ways in the long run, like being able
66 * to immediately create releases of your software directly from your tree
67 * and ensure everything needed to build it is there) you will need a
68 * configure.ac, Makefile.am and autogen.sh file.
73 AC_INIT(myapp, 0.0.0, myname@mydomain.com)
75 AC_CONFIG_SRCDIR(configure.ac)
76 AM_CONFIG_HEADER(config.h)
78 AM_INIT_AUTOMAKE(1.6 dist-bzip2)
79 PKG_CHECK_MODULES([ELEMENTARY], elementary)
86 AUTOMAKE_OPTIONS = 1.4 foreign
87 MAINTAINERCLEANFILES = Makefile.in aclocal.m4 config.h.in configure depcomp install-sh missing
89 INCLUDES = -I$(top_srcdir)
93 myapp_SOURCES = main.c
94 myapp_LDADD = @ELEMENTARY_LIBS@
95 myapp_CFLAGS = @ELEMENTARY_CFLAGS@
102 echo "Running aclocal..." ; aclocal $ACLOCAL_FLAGS || exit 1
103 echo "Running autoheader..." ; autoheader || exit 1
104 echo "Running autoconf..." ; autoconf || exit 1
105 echo "Running automake..." ; automake --add-missing --copy --gnu || exit 1
109 * To generate all the things needed to bootstrap just run:
115 * This will generate Makefile.in's, the confgure script and everything else.
116 * After this it works like all normal autotools projects:
123 * Note sudo was assumed to get root permissions, as this would install in
124 * /usr/local which is system-owned. Use any way you like to gain root, or
125 * specify a different prefix with configure:
128 ./confiugre --prefix=$HOME/mysoftware
131 * Also remember that autotools buys you some useful commands like:
136 * This uninstalls the software after it was installed with "make install".
137 * It is very useful to clear up what you built if you wish to clean the
144 * This firstly checks if your build tree is "clean" and ready for
145 * distribution. It also builds a tarball (myapp-0.0.0.tar.gz) that is
146 * ready to upload and distribute to the world, that contains the generated
147 * Makefile.in's and configure script. The users do not need to run
148 * autogen.sh - just configure and on. They don't need autotools installed.
149 * This tarball also builds cleanly, has all the sources it needs to build
150 * included (that is sources for your application, not libraries it depends
151 * on like Elementary). It builds cleanly in a buildroot and does not
152 * contain any files that are temporarily generated like binaries and other
153 * build-generated files, so the tarball is clean, and no need to worry
154 * about cleaning up your tree before packaging.
160 * This cleans up all build files (binaries, objects etc.) from the tree.
166 * This cleans out all files from the build and from configure's output too.
169 make maintainer-clean
172 * This deletes all the files autogen.sh will produce so the tree is clean
173 * to be put into a revision-control system (like CVS, SVN or GIT for example).
175 * There is a more advanced way of making use of the quicklaunch infrastructure
176 * in Elementary (which will not be covered here due to its more advanced
179 * Now let's actually create an interactive "Hello World" gui that you can
180 * click the ok button to exit. It's more code because this now does something
181 * much more significant, but it's still very simple:
184 #include <Elementary.h>
187 on_done(void *data, Evas_Object *obj, void *event_info)
189 // quit the mainloop (elm_run function will return)
194 elm_main(int argc, char **argv)
196 Evas_Object *win, *bg, *box, *lab, *btn;
198 // new window - do the usual and give it a name (hello) and title (Hello)
199 win = elm_win_util_standard_add("hello", "Hello");
200 // when the user clicks "close" on a window there is a request to delete
201 evas_object_smart_callback_add(win, "delete,request", on_done, NULL);
203 // add a box object - default is vertical. a box holds children in a row,
204 // either horizontally or vertically. nothing more.
205 box = elm_box_add(win);
206 // make the box hotizontal
207 elm_box_horizontal_set(box, EINA_TRUE);
208 // add object as a resize object for the window (controls window minimum
209 // size as well as gets resized if window is resized)
210 elm_win_resize_object_add(win, box);
211 evas_object_show(box);
213 // add a label widget, set the text and put it in the pad frame
214 lab = elm_label_add(win);
215 // set default text of the label
216 elm_object_text_set(lab, "Hello out there world!");
217 // pack the label at the end of the box
218 elm_box_pack_end(box, lab);
219 evas_object_show(lab);
222 btn = elm_button_add(win);
223 // set default text of button to "OK"
224 elm_object_text_set(btn, "OK");
225 // pack the button at the end of the box
226 elm_box_pack_end(box, btn);
227 evas_object_show(btn);
228 // call on_done when button is clicked
229 evas_object_smart_callback_add(btn, "clicked", on_done, NULL);
231 // now we are done, show the window
232 evas_object_show(win);
234 // run the mainloop and process events and callbacks
245 @page authors Authors
246 @author Carsten Haitzler <raster@@rasterman.com>
247 @author Gustavo Sverzut Barbieri <barbieri@@profusion.mobi>
248 @author Cedric Bail <cedric.bail@@free.fr>
249 @author Vincent Torri <vtorri@@univ-evry.fr>
250 @author Daniel Kolesa <quaker66@@gmail.com>
251 @author Jaime Thomas <avi.thomas@@gmail.com>
252 @author Swisscom - http://www.swisscom.ch/
253 @author Christopher Michael <devilhorns@@comcast.net>
254 @author Marco Trevisan (TreviƱo) <mail@@3v1n0.net>
255 @author Michael Bouchaud <michael.bouchaud@@gmail.com>
256 @author Jonathan Atton (Watchwolf) <jonathan.atton@@gmail.com>
257 @author Brian Wang <brian.wang.0721@@gmail.com>
258 @author Mike Blumenkrantz (discomfitor/zmike) <michael.blumenkrantz@@gmail.com>
259 @author Samsung Electronics <tbd>
260 @author Samsung SAIT <tbd>
261 @author Brett Nash <nash@@nash.id.au>
262 @author Bruno Dilly <bdilly@@profusion.mobi>
263 @author Rafael Fonseca <rfonseca@@profusion.mobi>
264 @author Chuneon Park <hermet@@hermet.pe.kr>
265 @author Woohyun Jung <wh0705.jung@@samsung.com>
266 @author Jaehwan Kim <jae.hwan.kim@@samsung.com>
267 @author Wonguk Jeong <wonguk.jeong@@samsung.com>
268 @author Leandro A. F. Pereira <leandro@@profusion.mobi>
269 @author Helen Fornazier <helen.fornazier@@profusion.mobi>
270 @author Gustavo Lima Chaves <glima@@profusion.mobi>
271 @author Fabiano FidĆŖncio <fidencio@@profusion.mobi>
272 @author Tiago FalcĆ£o <tiago@@profusion.mobi>
273 @author Otavio Pontes <otavio@@profusion.mobi>
274 @author Viktor Kojouharov <vkojouharov@@gmail.com>
275 @author Daniel Juyung Seo (SeoZ) <juyung.seo@@samsung.com> <seojuyung2@@gmail.com>
276 @author Sangho Park <sangho.g.park@@samsung.com> <gouache95@@gmail.com>
277 @author Rajeev Ranjan (Rajeev) <rajeev.r@@samsung.com> <rajeev.jnnce@@gmail.com>
278 @author Seunggyun Kim <sgyun.kim@@samsung.com> <tmdrbs@@gmail.com>
279 @author Sohyun Kim <anna1014.kim@@samsung.com> <sohyun.anna@@gmail.com>
280 @author Jihoon Kim <jihoon48.kim@@samsung.com>
281 @author Jeonghyun Yun (arosis) <jh0506.yun@@samsung.com>
282 @author Tom Hacohen <tom@@stosb.com>
283 @author Aharon Hillel <a.hillel@@partner.samsung.com>
284 @author Jonathan Atton (Watchwolf) <jonathan.atton@@gmail.com>
285 @author Shinwoo Kim <kimcinoo@@gmail.com>
286 @author Govindaraju SM <govi.sm@@samsung.com> <govism@@gmail.com>
287 @author Prince Kumar Dubey <prince.dubey@@samsung.com> <prince.dubey@@gmail.com>
288 @author Sung W. Park <sungwoo@@gmail.com>
289 @author Thierry el Borgi <thierry@@substantiel.fr>
290 @author Shilpa Singh <shilpa.singh@@samsung.com> <shilpasingh.o@@gmail.com>
291 @author Chanwook Jung <joey.jung@@samsung.com>
292 @author Hyoyoung Chang <hyoyoung.chang@@samsung.com>
293 @author Guillaume "Kuri" Friloux <guillaume.friloux@@asp64.com>
294 @author Kim Yunhan <spbear@@gmail.com>
295 @author Bluezery <ohpowel@@gmail.com>
296 @author Nicolas Aguirre <aguirre.nicolas@@gmail.com>
297 @author Sanjeev BA <iamsanjeev@@gmail.com>
299 Please contact <enlightenment-devel@lists.sourceforge.net> to get in
300 contact with the developers and maintainers.
308 * @brief Elementary's API
313 @ELM_UNIX_DEF@ ELM_UNIX
314 @ELM_WIN32_DEF@ ELM_WIN32
315 @ELM_WINCE_DEF@ ELM_WINCE
316 @ELM_EDBUS_DEF@ ELM_EDBUS
317 @ELM_EFREET_DEF@ ELM_EFREET
318 @ELM_ETHUMB_DEF@ ELM_ETHUMB
319 @ELM_WEB_DEF@ ELM_WEB
320 @ELM_EMAP_DEF@ ELM_EMAP
321 @ELM_DEBUG_DEF@ ELM_DEBUG
322 @ELM_ALLOCA_H_DEF@ ELM_ALLOCA_H
323 @ELM_LIBINTL_H_DEF@ ELM_LIBINTL_H
324 @ELM_DIRENT_H_DEF@ ELM_DIRENT_H
326 /* Standard headers for standard system calls etc. */
331 #include <sys/types.h>
332 #include <sys/stat.h>
333 #include <sys/time.h>
334 #include <sys/param.h>
348 # ifdef ELM_LIBINTL_H
349 # include <libintl.h>
360 #if defined (ELM_WIN32) || defined (ELM_WINCE)
363 # define alloca _alloca
374 #include <Ecore_Evas.h>
375 #include <Ecore_File.h>
376 @ELEMENTARY_ECORE_IMF_INC@
377 @ELEMENTARY_ECORE_CON_INC@
386 # include <Efreet_Mime.h>
387 # include <Efreet_Trash.h>
391 # include <Ethumb_Client.h>
403 # ifdef ELEMENTARY_BUILD
405 # define EAPI __declspec(dllexport)
408 # endif /* ! DLL_EXPORT */
410 # define EAPI __declspec(dllimport)
411 # endif /* ! EFL_EVAS_BUILD */
415 # define EAPI __attribute__ ((visibility("default")))
422 #endif /* ! _WIN32 */
427 # define EAPI_MAIN EAPI
430 /* allow usage from c++ */
435 #define ELM_VERSION_MAJOR @VMAJ@
436 #define ELM_VERSION_MINOR @VMIN@
438 typedef struct _Elm_Version
446 EAPI extern Elm_Version *elm_version;
449 #define ELM_RECTS_INTERSECT(x, y, w, h, xx, yy, ww, hh) (((x) < ((xx) + (ww))) && ((y) < ((yy) + (hh))) && (((x) + (w)) > (xx)) && (((y) + (h)) > (yy)))
450 #define ELM_PI 3.14159265358979323846
453 * @defgroup General General
455 * @brief General Elementary API. Functions that don't relate to
456 * Elementary objects specifically.
458 * Here are documented functions which init/shutdown the library,
459 * that apply to generic Elementary objects, that deal with
460 * configuration, et cetera.
462 * @ref general_functions_example_page "This" example contemplates
463 * some of these functions.
467 * @addtogroup General
472 * Defines couple of standard Evas_Object layers to be used
473 * with evas_object_layer_set().
475 * @note whenever extending with new values, try to keep some padding
476 * to siblings so there is room for further extensions.
478 typedef enum _Elm_Object_Layer
480 ELM_OBJECT_LAYER_BACKGROUND = EVAS_LAYER_MIN + 64, /**< where to place backgrounds */
481 ELM_OBJECT_LAYER_DEFAULT = 0, /**< Evas_Object default layer (and thus for Elementary) */
482 ELM_OBJECT_LAYER_FOCUS = EVAS_LAYER_MAX - 128, /**< where focus object visualization is */
483 ELM_OBJECT_LAYER_TOOLTIP = EVAS_LAYER_MAX - 64, /**< where to show tooltips */
484 ELM_OBJECT_LAYER_CURSOR = EVAS_LAYER_MAX - 32, /**< where to show cursors */
485 ELM_OBJECT_LAYER_LAST /**< last layer known by Elementary */
488 /**************************************************************************/
489 EAPI extern int ELM_ECORE_EVENT_ETHUMB_CONNECT;
492 * Emitted when the application has reconfigured elementary settings due
493 * to an external configuration tool asking it to.
495 EAPI extern int ELM_EVENT_CONFIG_ALL_CHANGED;
498 * Emitted when any Elementary's policy value is changed.
500 EAPI extern int ELM_EVENT_POLICY_CHANGED;
503 * @typedef Elm_Event_Policy_Changed
505 * Data on the event when an Elementary policy has changed
507 typedef struct _Elm_Event_Policy_Changed Elm_Event_Policy_Changed;
510 * @struct _Elm_Event_Policy_Changed
512 * Data on the event when an Elementary policy has changed
514 struct _Elm_Event_Policy_Changed
516 unsigned int policy; /**< the policy identifier */
517 int new_value; /**< value the policy had before the change */
518 int old_value; /**< new value the policy got */
522 * Policy identifiers.
524 typedef enum _Elm_Policy
526 ELM_POLICY_QUIT, /**< under which circumstances the application
527 * should quit automatically. @see
531 } Elm_Policy; /**< Elementary policy identifiers/groups enumeration. @see elm_policy_set()
534 typedef enum _Elm_Policy_Quit
536 ELM_POLICY_QUIT_NONE = 0, /**< never quit the application
538 ELM_POLICY_QUIT_LAST_WINDOW_CLOSED /**< quit when the
540 * window is closed */
541 } Elm_Policy_Quit; /**< Possible values for the #ELM_POLICY_QUIT policy */
543 typedef enum _Elm_Focus_Direction
547 } Elm_Focus_Direction;
549 typedef enum _Elm_Text_Format
551 ELM_TEXT_FORMAT_PLAIN_UTF8,
552 ELM_TEXT_FORMAT_MARKUP_UTF8
556 * Line wrapping types.
558 typedef enum _Elm_Wrap_Type
560 ELM_WRAP_NONE = 0, /**< No wrap - value is zero */
561 ELM_WRAP_CHAR, /**< Char wrap - wrap between characters */
562 ELM_WRAP_WORD, /**< Word wrap - wrap in allowed wrapping points (as defined in the unicode standard) */
563 ELM_WRAP_MIXED, /**< Mixed wrap - Word wrap, and if that fails, char wrap. */
569 ELM_INPUT_PANEL_LAYOUT_NORMAL, /**< Default layout */
570 ELM_INPUT_PANEL_LAYOUT_NUMBER, /**< Number layout */
571 ELM_INPUT_PANEL_LAYOUT_EMAIL, /**< Email layout */
572 ELM_INPUT_PANEL_LAYOUT_URL, /**< URL layout */
573 ELM_INPUT_PANEL_LAYOUT_PHONENUMBER, /**< Phone Number layout */
574 ELM_INPUT_PANEL_LAYOUT_IP, /**< IP layout */
575 ELM_INPUT_PANEL_LAYOUT_MONTH, /**< Month layout */
576 ELM_INPUT_PANEL_LAYOUT_NUMBERONLY, /**< Number Only layout */
577 ELM_INPUT_PANEL_LAYOUT_INVALID
578 } Elm_Input_Panel_Layout;
582 ELM_AUTOCAPITAL_TYPE_NONE,
583 ELM_AUTOCAPITAL_TYPE_WORD,
584 ELM_AUTOCAPITAL_TYPE_SENTENCE,
585 ELM_AUTOCAPITAL_TYPE_ALLCHARACTER,
586 } Elm_Autocapital_Type;
589 * @typedef Elm_Object_Item
590 * An Elementary Object item handle.
593 typedef struct _Elm_Object_Item Elm_Object_Item;
597 * Called back when a widget's tooltip is activated and needs content.
598 * @param data user-data given to elm_object_tooltip_content_cb_set()
599 * @param obj owner widget.
600 * @param tooltip The tooltip object (affix content to this!)
602 typedef Evas_Object *(*Elm_Tooltip_Content_Cb) (void *data, Evas_Object *obj, Evas_Object *tooltip);
605 * Called back when a widget's item tooltip is activated and needs content.
606 * @param data user-data given to elm_object_tooltip_content_cb_set()
607 * @param obj owner widget.
608 * @param tooltip The tooltip object (affix content to this!)
609 * @param item context dependent item. As an example, if tooltip was
610 * set on Elm_List_Item, then it is of this type.
612 typedef Evas_Object *(*Elm_Tooltip_Item_Content_Cb) (void *data, Evas_Object *obj, Evas_Object *tooltip, void *item);
614 typedef Eina_Bool (*Elm_Event_Cb) (void *data, Evas_Object *obj, Evas_Object *src, Evas_Callback_Type type, void *event_info); /**< Function prototype definition for callbacks on input events happening on Elementary widgets. @a data will receive the user data pointer passed to elm_object_event_callback_add(). @a src will be a pointer to the widget on which the input event took place. @a type will get the type of this event and @a event_info, the struct with details on this event. */
616 #ifndef ELM_LIB_QUICKLAUNCH
617 #define ELM_MAIN() int main(int argc, char **argv) {elm_init(argc, argv); return elm_main(argc, argv);} /**< macro to be used after the elm_main() function */
619 #define ELM_MAIN() int main(int argc, char **argv) {return elm_quicklaunch_fallback(argc, argv);} /**< macro to be used after the elm_main() function */
622 /**************************************************************************/
626 * Initialize Elementary
628 * @param[in] argc System's argument count value
629 * @param[in] argv System's pointer to array of argument strings
630 * @return The init counter value.
632 * This function initializes Elementary and increments a counter of
633 * the number of calls to it. It returns the new counter's value.
635 * @warning This call is exported only for use by the @c ELM_MAIN()
636 * macro. There is no need to use this if you use this macro (which
637 * is highly advisable). An elm_main() should contain the entry
638 * point code for your application, having the same prototype as
639 * elm_init(), and @b not being static (putting the @c EAPI symbol
640 * in front of its type declaration is advisable). The @c
641 * ELM_MAIN() call should be placed just after it.
644 * @dontinclude bg_example_01.c
648 * See the full @ref bg_example_01_c "example".
650 * @see elm_shutdown().
653 EAPI int elm_init(int argc, char **argv);
656 * Shut down Elementary
658 * @return The init counter value.
660 * This should be called at the end of your application, just
661 * before it ceases to do any more processing. This will clean up
662 * any permanent resources your application may have allocated via
663 * Elementary that would otherwise persist.
665 * @see elm_init() for an example
669 EAPI int elm_shutdown(void);
672 * Run Elementary's main loop
674 * This call should be issued just after all initialization is
675 * completed. This function will not return until elm_exit() is
676 * called. It will keep looping, running the main
677 * (event/processing) loop for Elementary.
679 * @see elm_init() for an example
683 EAPI void elm_run(void);
686 * Exit Elementary's main loop
688 * If this call is issued, it will flag the main loop to cease
689 * processing and return back to its parent function (usually your
690 * elm_main() function).
692 * @see elm_init() for an example. There, just after a request to
693 * close the window comes, the main loop will be left.
695 * @note By using the appropriate #ELM_POLICY_QUIT on your Elementary
696 * applications, you'll be able to get this function called automatically for you.
700 EAPI void elm_exit(void);
703 * Provide information in order to make Elementary determine the @b
704 * run time location of the software in question, so other data files
705 * such as images, sound files, executable utilities, libraries,
706 * modules and locale files can be found.
708 * @param mainfunc This is your application's main function name,
709 * whose binary's location is to be found. Providing @c NULL
710 * will make Elementary not to use it
711 * @param dom This will be used as the application's "domain", in the
712 * form of a prefix to any environment variables that may
713 * override prefix detection and the directory name, inside the
714 * standard share or data directories, where the software's
715 * data files will be looked for.
716 * @param checkfile This is an (optional) magic file's path to check
717 * for existence (and it must be located in the data directory,
718 * under the share directory provided above). Its presence will
719 * help determine the prefix found was correct. Pass @c NULL if
720 * the check is not to be done.
722 * This function allows one to re-locate the application somewhere
723 * else after compilation, if the developer wishes for easier
724 * distribution of pre-compiled binaries.
726 * The prefix system is designed to locate where the given software is
727 * installed (under a common path prefix) at run time and then report
728 * specific locations of this prefix and common directories inside
729 * this prefix like the binary, library, data and locale directories,
730 * through the @c elm_app_*_get() family of functions.
732 * Call elm_app_info_set() early on before you change working
733 * directory or anything about @c argv[0], so it gets accurate
736 * It will then try and trace back which file @p mainfunc comes from,
737 * if provided, to determine the application's prefix directory.
739 * The @p dom parameter provides a string prefix to prepend before
740 * environment variables, allowing a fallback to @b specific
741 * environment variables to locate the software. You would most
742 * probably provide a lowercase string there, because it will also
743 * serve as directory domain, explained next. For environment
744 * variables purposes, this string is made uppercase. For example if
745 * @c "myapp" is provided as the prefix, then the program would expect
746 * @c "MYAPP_PREFIX" as a master environment variable to specify the
747 * exact install prefix for the software, or more specific environment
748 * variables like @c "MYAPP_BIN_DIR", @c "MYAPP_LIB_DIR", @c
749 * "MYAPP_DATA_DIR" and @c "MYAPP_LOCALE_DIR", which could be set by
750 * the user or scripts before launching. If not provided (@c NULL),
751 * environment variables will not be used to override compiled-in
752 * defaults or auto detections.
754 * The @p dom string also provides a subdirectory inside the system
755 * shared data directory for data files. For example, if the system
756 * directory is @c /usr/local/share, then this directory name is
757 * appended, creating @c /usr/local/share/myapp, if it @p was @c
758 * "myapp". It is expected that the application installs data files in
761 * The @p checkfile is a file name or path of something inside the
762 * share or data directory to be used to test that the prefix
763 * detection worked. For example, your app will install a wallpaper
764 * image as @c /usr/local/share/myapp/images/wallpaper.jpg and so to
765 * check that this worked, provide @c "images/wallpaper.jpg" as the @p
768 * @see elm_app_compile_bin_dir_set()
769 * @see elm_app_compile_lib_dir_set()
770 * @see elm_app_compile_data_dir_set()
771 * @see elm_app_compile_locale_set()
772 * @see elm_app_prefix_dir_get()
773 * @see elm_app_bin_dir_get()
774 * @see elm_app_lib_dir_get()
775 * @see elm_app_data_dir_get()
776 * @see elm_app_locale_dir_get()
778 EAPI void elm_app_info_set(void *mainfunc, const char *dom, const char *checkfile);
781 * Provide information on the @b fallback application's binaries
782 * directory, in scenarios where they get overriden by
783 * elm_app_info_set().
785 * @param dir The path to the default binaries directory (compile time
788 * @note Elementary will as well use this path to determine actual
789 * names of binaries' directory paths, maybe changing it to be @c
790 * something/local/bin instead of @c something/bin, only, for
793 * @warning You should call this function @b before
794 * elm_app_info_set().
796 EAPI void elm_app_compile_bin_dir_set(const char *dir);
799 * Provide information on the @b fallback application's libraries
800 * directory, on scenarios where they get overriden by
801 * elm_app_info_set().
803 * @param dir The path to the default libraries directory (compile
806 * @note Elementary will as well use this path to determine actual
807 * names of libraries' directory paths, maybe changing it to be @c
808 * something/lib32 or @c something/lib64 instead of @c something/lib,
811 * @warning You should call this function @b before
812 * elm_app_info_set().
814 EAPI void elm_app_compile_lib_dir_set(const char *dir);
817 * Provide information on the @b fallback application's data
818 * directory, on scenarios where they get overriden by
819 * elm_app_info_set().
821 * @param dir The path to the default data directory (compile time
824 * @note Elementary will as well use this path to determine actual
825 * names of data directory paths, maybe changing it to be @c
826 * something/local/share instead of @c something/share, only, for
829 * @warning You should call this function @b before
830 * elm_app_info_set().
832 EAPI void elm_app_compile_data_dir_set(const char *dir);
835 * Provide information on the @b fallback application's locale
836 * directory, on scenarios where they get overriden by
837 * elm_app_info_set().
839 * @param dir The path to the default locale directory (compile time
842 * @warning You should call this function @b before
843 * elm_app_info_set().
845 EAPI void elm_app_compile_locale_set(const char *dir);
848 * Retrieve the application's run time prefix directory, as set by
849 * elm_app_info_set() and the way (environment) the application was
852 * @return The directory prefix the application is actually using.
854 EAPI const char *elm_app_prefix_dir_get(void);
857 * Retrieve the application's run time binaries prefix directory, as
858 * set by elm_app_info_set() and the way (environment) the application
861 * @return The binaries directory prefix the application is actually
864 EAPI const char *elm_app_bin_dir_get(void);
867 * Retrieve the application's run time libraries prefix directory, as
868 * set by elm_app_info_set() and the way (environment) the application
871 * @return The libraries directory prefix the application is actually
874 EAPI const char *elm_app_lib_dir_get(void);
877 * Retrieve the application's run time data prefix directory, as
878 * set by elm_app_info_set() and the way (environment) the application
881 * @return The data directory prefix the application is actually
884 EAPI const char *elm_app_data_dir_get(void);
887 * Retrieve the application's run time locale prefix directory, as
888 * set by elm_app_info_set() and the way (environment) the application
891 * @return The locale directory prefix the application is actually
894 EAPI const char *elm_app_locale_dir_get(void);
897 * Exposed symbol used only by macros and should not be used by apps
899 EAPI void elm_quicklaunch_mode_set(Eina_Bool ql_on);
902 * Exposed symbol used only by macros and should not be used by apps
904 EAPI Eina_Bool elm_quicklaunch_mode_get(void);
907 * Exposed symbol used only by macros and should not be used by apps
909 EAPI int elm_quicklaunch_init(int argc, char **argv);
912 * Exposed symbol used only by macros and should not be used by apps
914 EAPI int elm_quicklaunch_sub_init(int argc, char **argv);
917 * Exposed symbol used only by macros and should not be used by apps
919 EAPI int elm_quicklaunch_sub_shutdown(void);
922 * Exposed symbol used only by macros and should not be used by apps
924 EAPI int elm_quicklaunch_shutdown(void);
927 * Exposed symbol used only by macros and should not be used by apps
929 EAPI void elm_quicklaunch_seed(void);
932 * Exposed symbol used only by macros and should not be used by apps
934 EAPI Eina_Bool elm_quicklaunch_prepare(int argc, char **argv);
937 * Exposed symbol used only by macros and should not be used by apps
939 EAPI Eina_Bool elm_quicklaunch_fork(int argc, char **argv, char *cwd, void (postfork_func) (void *data), void *postfork_data);
942 * Exposed symbol used only by macros and should not be used by apps
944 EAPI void elm_quicklaunch_cleanup(void);
947 * Exposed symbol used only by macros and should not be used by apps
949 EAPI int elm_quicklaunch_fallback(int argc, char **argv);
952 * Exposed symbol used only by macros and should not be used by apps
954 EAPI char *elm_quicklaunch_exe_path_get(const char *exe);
957 * Request that your elementary application needs efreet
959 * This initializes the Efreet library when called and if support exists
960 * it returns EINA_TRUE, otherwise returns EINA_FALSE. This must be called
961 * before any efreet calls.
963 * @return EINA_TRUE if support exists and initialization succeeded.
967 EAPI Eina_Bool elm_need_efreet(void);
970 * Request that your elementary application needs e_dbus
972 * This initializes the E_dbus library when called and if support exists
973 * it returns EINA_TRUE, otherwise returns EINA_FALSE. This must be called
974 * before any e_dbus calls.
976 * @return EINA_TRUE if support exists and initialization succeeded.
980 EAPI Eina_Bool elm_need_e_dbus(void);
983 * Request that your elementary application needs ethumb
985 * This initializes the Ethumb library when called and if support exists
986 * it returns EINA_TRUE, otherwise returns EINA_FALSE.
987 * This must be called before any other function that deals with
988 * elm_thumb objects or ethumb_client instances.
992 EAPI Eina_Bool elm_need_ethumb(void);
995 * Request that your elementary application needs web support
997 * This initializes the Ewebkit library when called and if support exists
998 * it returns EINA_TRUE, otherwise returns EINA_FALSE.
999 * This must be called before any other function that deals with
1000 * elm_web objects or ewk_view instances.
1004 EAPI Eina_Bool elm_need_web(void);
1007 * Set a new policy's value (for a given policy group/identifier).
1009 * @param policy policy identifier, as in @ref Elm_Policy.
1010 * @param value policy value, which depends on the identifier
1012 * @return @c EINA_TRUE on success or @c EINA_FALSE, on error.
1014 * Elementary policies define applications' behavior,
1015 * somehow. These behaviors are divided in policy groups (see
1016 * #Elm_Policy enumeration). This call will emit the Ecore event
1017 * #ELM_EVENT_POLICY_CHANGED, which can be hooked at with
1018 * handlers. An #Elm_Event_Policy_Changed struct will be passed,
1021 * @note Currently, we have only one policy identifier/group
1022 * (#ELM_POLICY_QUIT), which has two possible values.
1026 EAPI Eina_Bool elm_policy_set(unsigned int policy, int value);
1029 * Gets the policy value for given policy identifier.
1031 * @param policy policy identifier, as in #Elm_Policy.
1032 * @return The currently set policy value, for that
1033 * identifier. Will be @c 0 if @p policy passed is invalid.
1037 EAPI int elm_policy_get(unsigned int policy);
1040 * Change the language of the current application
1042 * The @p lang passed must be the full name of the locale to use, for
1043 * example "en_US.utf8" or "es_ES@euro".
1045 * Changing language with this function will make Elementary run through
1046 * all its widgets, translating strings set with
1047 * elm_object_domain_translatable_text_part_set(). This way, an entire
1048 * UI can have its language changed without having to restart the program.
1050 * For more complex cases, like having formatted strings that need
1051 * translation, widgets will also emit a "language,changed" signal that
1052 * the user can listen to to manually translate the text.
1054 * @param lang Language to set, must be the full name of the locale
1058 EAPI void elm_language_set(const char *lang);
1061 * Set a label of an object
1063 * @param obj The Elementary object
1064 * @param part The text part name to set (NULL for the default label)
1065 * @param label The new text of the label
1067 * @note Elementary objects may have many labels (e.g. Action Slider)
1068 * @deprecated Use elm_object_part_text_set() instead.
1071 EINA_DEPRECATED EAPI void elm_object_text_part_set(Evas_Object *obj, const char *part, const char *label);
1074 * Set a label of an object
1076 * @param obj The Elementary object
1077 * @param part The text part name to set (NULL for the default label)
1078 * @param label The new text of the label
1080 * @note Elementary objects may have many labels (e.g. Action Slider)
1084 EAPI void elm_object_part_text_set(Evas_Object *obj, const char *part, const char *label);
1086 #define elm_object_text_set(obj, label) elm_object_part_text_set((obj), NULL, (label))
1089 * Get a label of an object
1091 * @param obj The Elementary object
1092 * @param part The text part name to get (NULL for the default label)
1093 * @return text of the label or NULL for any error
1095 * @note Elementary objects may have many labels (e.g. Action Slider)
1096 * @deprecated Use elm_object_part_text_get() instead.
1099 EINA_DEPRECATED EAPI const char *elm_object_text_part_get(const Evas_Object *obj, const char *part);
1102 * Get a label of an object
1104 * @param obj The Elementary object
1105 * @param part The text part name to get (NULL for the default label)
1106 * @return text of the label or NULL for any error
1108 * @note Elementary objects may have many labels (e.g. Action Slider)
1112 EAPI const char *elm_object_part_text_get(const Evas_Object *obj, const char *part);
1114 #define elm_object_text_get(obj) elm_object_part_text_get((obj), NULL)
1117 * Set the text for an objects' part, marking it as translatable.
1119 * The string to set as @p text must be the original one. Do not pass the
1120 * return of @c gettext() here. Elementary will translate the string
1121 * internally and set it on the object using elm_object_part_text_set(),
1122 * also storing the original string so that it can be automatically
1123 * translated when the language is changed with elm_language_set().
1125 * The @p domain will be stored along to find the translation in the
1126 * correct catalog. It can be NULL, in which case it will use whatever
1127 * domain was set by the application with @c textdomain(). This is useful
1128 * in case you are building a library on top of Elementary that will have
1129 * its own translatable strings, that should not be mixed with those of
1130 * programs using the library.
1132 * @param obj The object containing the text part
1133 * @param part The name of the part to set
1134 * @param domain The translation domain to use
1135 * @param text The original, non-translated text to set
1139 EAPI void elm_object_domain_translatable_text_part_set(Evas_Object *obj, const char *part, const char *domain, const char *text);
1141 #define elm_object_domain_translatable_text_set(obj, domain, text) elm_object_domain_translatable_text_part_set((obj), NULL, (domain), (text))
1143 #define elm_object_translatable_text_set(obj, text) elm_object_domain_translatable_text_part_set((obj), NULL, NULL, (text))
1146 * Gets the original string set as translatable for an object
1148 * When setting translated strings, the function elm_object_part_text_get()
1149 * will return the translation returned by @c gettext(). To get the
1150 * original string use this function.
1152 * @param obj The object
1153 * @param part The name of the part that was set
1155 * @return The original, untranslated string
1159 EAPI const char *elm_object_translatable_text_part_get(const Evas_Object *obj, const char *part);
1161 #define elm_object_translatable_text_get(obj) elm_object_translatable_text_part_get((obj), NULL)
1164 * Set a content of an object
1166 * @param obj The Elementary object
1167 * @param part The content part name to set (NULL for the default content)
1168 * @param content The new content of the object
1170 * @note Elementary objects may have many contents
1171 * @deprecated Use elm_object_part_content_set instead.
1174 EINA_DEPRECATED EAPI void elm_object_content_part_set(Evas_Object *obj, const char *part, Evas_Object *content);
1177 * Set a content of an object
1179 * @param obj The Elementary object
1180 * @param part The content part name to set (NULL for the default content)
1181 * @param content The new content of the object
1183 * @note Elementary objects may have many contents
1187 EAPI void elm_object_part_content_set(Evas_Object *obj, const char *part, Evas_Object *content);
1189 #define elm_object_content_set(obj, content) elm_object_part_content_set((obj), NULL, (content))
1192 * Get a content of an object
1194 * @param obj The Elementary object
1195 * @param item The content part name to get (NULL for the default content)
1196 * @return content of the object or NULL for any error
1198 * @note Elementary objects may have many contents
1199 * @deprecated Use elm_object_part_content_get instead.
1202 EINA_DEPRECATED EAPI Evas_Object *elm_object_content_part_get(const Evas_Object *obj, const char *part);
1205 * Get a content of an object
1207 * @param obj The Elementary object
1208 * @param item The content part name to get (NULL for the default content)
1209 * @return content of the object or NULL for any error
1211 * @note Elementary objects may have many contents
1215 EAPI Evas_Object *elm_object_part_content_get(const Evas_Object *obj, const char *part);
1217 #define elm_object_content_get(obj) elm_object_part_content_get((obj), NULL)
1220 * Unset a content of an object
1222 * @param obj The Elementary object
1223 * @param item The content part name to unset (NULL for the default content)
1225 * @note Elementary objects may have many contents
1226 * @deprecated Use elm_object_part_content_unset instead.
1229 EINA_DEPRECATED EAPI Evas_Object *elm_object_content_part_unset(Evas_Object *obj, const char *part);
1232 * Unset a content of an object
1234 * @param obj The Elementary object
1235 * @param item The content part name to unset (NULL for the default content)
1237 * @note Elementary objects may have many contents
1241 EAPI Evas_Object *elm_object_part_content_unset(Evas_Object *obj, const char *part);
1243 #define elm_object_content_unset(obj) elm_object_part_content_unset((obj), NULL)
1246 * Set the text to read out when in accessibility mode
1248 * @param obj The object which is to be described
1249 * @param txt The text that describes the widget to people with poor or no vision
1253 EAPI void elm_object_access_info_set(Evas_Object *obj, const char *txt);
1256 * Get the widget object's handle which contains a given item
1258 * @param item The Elementary object item
1259 * @return The widget object
1261 * @note This returns the widget object itself that an item belongs to.
1265 EAPI Evas_Object *elm_object_item_object_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
1268 * Set a content of an object item
1270 * @param it The Elementary object item
1271 * @param part The content part name to set (NULL for the default content)
1272 * @param content The new content of the object item
1274 * @note Elementary object items may have many contents
1275 * @deprecated Use elm_object_item_part_content_set instead.
1278 EINA_DEPRECATED EAPI void elm_object_item_content_part_set(Elm_Object_Item *it, const char *part, Evas_Object *content);
1281 * Set a content of an object item
1283 * @param it The Elementary object item
1284 * @param part The content part name to set (NULL for the default content)
1285 * @param content The new content of the object item
1287 * @note Elementary object items may have many contents
1291 EAPI void elm_object_item_part_content_set(Elm_Object_Item *it, const char *part, Evas_Object *content);
1293 #define elm_object_item_content_set(it, content) elm_object_item_part_content_set((it), NULL, (content))
1296 * Get a content of an object item
1298 * @param it The Elementary object item
1299 * @param part The content part name to unset (NULL for the default content)
1300 * @return content of the object item or NULL for any error
1302 * @note Elementary object items may have many contents
1303 * @deprecated Use elm_object_item_part_content_get instead.
1306 EAPI Evas_Object *elm_object_item_content_part_get(const Elm_Object_Item *it, const char *part);
1309 * Get a content of an object item
1311 * @param it The Elementary object item
1312 * @param part The content part name to unset (NULL for the default content)
1313 * @return content of the object item or NULL for any error
1315 * @note Elementary object items may have many contents
1319 EAPI Evas_Object *elm_object_item_part_content_get(const Elm_Object_Item *it, const char *part);
1321 #define elm_object_item_content_get(it) elm_object_item_part_content_get((it), NULL)
1324 * Unset a content of an object item
1326 * @param it The Elementary object item
1327 * @param part The content part name to unset (NULL for the default content)
1329 * @note Elementary object items may have many contents
1330 * @deprecated Use elm_object_item_part_content_unset instead.
1333 EINA_DEPRECATED EAPI Evas_Object *elm_object_item_content_part_unset(Elm_Object_Item *it, const char *part);
1336 * Unset a content of an object item
1338 * @param it The Elementary object item
1339 * @param part The content part name to unset (NULL for the default content)
1341 * @note Elementary object items may have many contents
1345 EAPI Evas_Object *elm_object_item_part_content_unset(Elm_Object_Item *it, const char *part);
1347 #define elm_object_item_content_unset(it) elm_object_item_part_content_unset((it), NULL)
1350 * Set a label of an object item
1352 * @param it The Elementary object item
1353 * @param part The text part name to set (NULL for the default label)
1354 * @param label The new text of the label
1356 * @note Elementary object items may have many labels
1357 * @deprecated Use elm_object_item_part_text_set instead.
1360 EINA_DEPRECATED EAPI void elm_object_item_text_part_set(Elm_Object_Item *it, const char *part, const char *label);
1363 * Set a label of an object item
1365 * @param it The Elementary object item
1366 * @param part The text part name to set (NULL for the default label)
1367 * @param label The new text of the label
1369 * @note Elementary object items may have many labels
1373 EAPI void elm_object_item_part_text_set(Elm_Object_Item *it, const char *part, const char *label);
1375 #define elm_object_item_text_set(it, label) elm_object_item_part_text_set((it), NULL, (label))
1378 * Get a label of an object item
1380 * @param it The Elementary object item
1381 * @param part The text part name to get (NULL for the default label)
1382 * @return text of the label or NULL for any error
1384 * @note Elementary object items may have many labels
1385 * @deprecated Use elm_object_item_part_text_get instead.
1388 EINA_DEPRECATED EAPI const char *elm_object_item_text_part_get(const Elm_Object_Item *it, const char *part);
1390 * Get a label of an object item
1392 * @param it The Elementary object item
1393 * @param part The text part name to get (NULL for the default label)
1394 * @return text of the label or NULL for any error
1396 * @note Elementary object items may have many labels
1400 EAPI const char *elm_object_item_part_text_get(const Elm_Object_Item *it, const char *part);
1402 #define elm_object_item_text_get(it) elm_object_item_part_text_get((it), NULL)
1405 * Set the text to read out when in accessibility mode
1407 * @param it The object item which is to be described
1408 * @param txt The text that describes the widget to people with poor or no vision
1412 EAPI void elm_object_item_access_info_set(Elm_Object_Item *it, const char *txt);
1415 * Get the data associated with an object item
1416 * @param it The Elementary object item
1417 * @return The data associated with @p it
1421 EAPI void *elm_object_item_data_get(const Elm_Object_Item *it);
1424 * Set the data associated with an object item
1425 * @param it The Elementary object item
1426 * @param data The data to be associated with @p it
1430 EAPI void elm_object_item_data_set(Elm_Object_Item *it, void *data);
1433 * Send a signal to the edje object of the widget item.
1435 * This function sends a signal to the edje object of the obj item. An
1436 * edje program can respond to a signal by specifying matching
1437 * 'signal' and 'source' fields.
1439 * @param it The Elementary object item
1440 * @param emission The signal's name.
1441 * @param source The signal's source.
1444 EAPI void elm_object_item_signal_emit(Elm_Object_Item *it, const char *emission, const char *source) EINA_ARG_NONNULL(1);
1447 * Set the disabled state of an widget item.
1449 * @param obj The Elementary object item
1450 * @param disabled The state to put in in: @c EINA_TRUE for
1451 * disabled, @c EINA_FALSE for enabled
1453 * Elementary object item can be @b disabled, in which state they won't
1454 * receive input and, in general, will be themed differently from
1455 * their normal state, usually greyed out. Useful for contexts
1456 * where you don't want your users to interact with some of the
1457 * parts of you interface.
1459 * This sets the state for the widget item, either disabling it or
1464 EAPI void elm_object_item_disabled_set(Elm_Object_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1);
1467 * Get the disabled state of an widget item.
1469 * @param obj The Elementary object
1470 * @return @c EINA_TRUE, if the widget item is disabled, @c EINA_FALSE
1471 * if it's enabled (or on errors)
1473 * This gets the state of the widget, which might be enabled or disabled.
1477 EAPI Eina_Bool elm_object_item_disabled_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
1484 * @defgroup Caches Caches
1486 * These are functions which let one fine-tune some cache values for
1487 * Elementary applications, thus allowing for performance adjustments.
1493 * @brief Flush all caches.
1495 * Frees all data that was in cache and is not currently being used to reduce
1496 * memory usage. This frees Edje's, Evas' and Eet's cache. This is equivalent
1497 * to calling all of the following functions:
1498 * @li edje_file_cache_flush()
1499 * @li edje_collection_cache_flush()
1500 * @li eet_clearcache()
1501 * @li evas_image_cache_flush()
1502 * @li evas_font_cache_flush()
1503 * @li evas_render_dump()
1504 * @note Evas caches are flushed for every canvas associated with a window.
1508 EAPI void elm_all_flush(void);
1511 * Get the configured cache flush interval time
1513 * This gets the globally configured cache flush interval time, in
1516 * @return The cache flush interval time
1519 * @see elm_all_flush()
1521 EAPI int elm_cache_flush_interval_get(void);
1524 * Set the configured cache flush interval time
1526 * This sets the globally configured cache flush interval time, in ticks
1528 * @param size The cache flush interval time
1531 * @see elm_all_flush()
1533 EAPI void elm_cache_flush_interval_set(int size);
1536 * Set the configured cache flush interval time for all applications on the
1539 * This sets the globally configured cache flush interval time -- in ticks
1540 * -- for all applications on the display.
1542 * @param size The cache flush interval time
1545 EAPI void elm_cache_flush_interval_all_set(int size);
1548 * Get the configured cache flush enabled state
1550 * This gets the globally configured cache flush state - if it is enabled
1551 * or not. When cache flushing is enabled, elementary will regularly
1552 * (see elm_cache_flush_interval_get() ) flush caches and dump data out of
1553 * memory and allow usage to re-seed caches and data in memory where it
1554 * can do so. An idle application will thus minimise its memory usage as
1555 * data will be freed from memory and not be re-loaded as it is idle and
1556 * not rendering or doing anything graphically right now.
1558 * @return The cache flush state
1561 * @see elm_all_flush()
1563 EAPI Eina_Bool elm_cache_flush_enabled_get(void);
1566 * Set the configured cache flush enabled state
1568 * This sets the globally configured cache flush enabled state.
1570 * @param size The cache flush enabled state
1573 * @see elm_all_flush()
1575 EAPI void elm_cache_flush_enabled_set(Eina_Bool enabled);
1578 * Set the configured cache flush enabled state for all applications on the
1581 * This sets the globally configured cache flush enabled state for all
1582 * applications on the display.
1584 * @param size The cache flush enabled state
1587 EAPI void elm_cache_flush_enabled_all_set(Eina_Bool enabled);
1590 * Get the configured font cache size
1592 * This gets the globally configured font cache size, in bytes.
1594 * @return The font cache size
1597 EAPI int elm_font_cache_get(void);
1600 * Set the configured font cache size
1602 * This sets the globally configured font cache size, in bytes
1604 * @param size The font cache size
1607 EAPI void elm_font_cache_set(int size);
1610 * Set the configured font cache size for all applications on the
1613 * This sets the globally configured font cache size -- in bytes
1614 * -- for all applications on the display.
1616 * @param size The font cache size
1619 EAPI void elm_font_cache_all_set(int size);
1622 * Get the configured image cache size
1624 * This gets the globally configured image cache size, in bytes
1626 * @return The image cache size
1629 EAPI int elm_image_cache_get(void);
1632 * Set the configured image cache size
1634 * This sets the globally configured image cache size, in bytes
1636 * @param size The image cache size
1639 EAPI void elm_image_cache_set(int size);
1642 * Set the configured image cache size for all applications on the
1645 * This sets the globally configured image cache size -- in bytes
1646 * -- for all applications on the display.
1648 * @param size The image cache size
1651 EAPI void elm_image_cache_all_set(int size);
1654 * Get the configured edje file cache size.
1656 * This gets the globally configured edje file cache size, in number
1659 * @return The edje file cache size
1662 EAPI int elm_edje_file_cache_get(void);
1665 * Set the configured edje file cache size
1667 * This sets the globally configured edje file cache size, in number
1670 * @param size The edje file cache size
1673 EAPI void elm_edje_file_cache_set(int size);
1676 * Set the configured edje file cache size for all applications on the
1679 * This sets the globally configured edje file cache size -- in number
1680 * of files -- for all applications on the display.
1682 * @param size The edje file cache size
1685 EAPI void elm_edje_file_cache_all_set(int size);
1688 * Get the configured edje collections (groups) cache size.
1690 * This gets the globally configured edje collections cache size, in
1691 * number of collections.
1693 * @return The edje collections cache size
1696 EAPI int elm_edje_collection_cache_get(void);
1699 * Set the configured edje collections (groups) cache size
1701 * This sets the globally configured edje collections cache size, in
1702 * number of collections.
1704 * @param size The edje collections cache size
1707 EAPI void elm_edje_collection_cache_set(int size);
1710 * Set the configured edje collections (groups) cache size for all
1711 * applications on the display
1713 * This sets the globally configured edje collections cache size -- in
1714 * number of collections -- for all applications on the display.
1716 * @param size The edje collections cache size
1719 EAPI void elm_edje_collection_cache_all_set(int size);
1726 * @defgroup Scaling Widget Scaling
1728 * Different widgets can be scaled independently. These functions
1729 * allow you to manipulate this scaling on a per-widget basis. The
1730 * object and all its children get their scaling factors multiplied
1731 * by the scale factor set. This is multiplicative, in that if a
1732 * child also has a scale size set it is in turn multiplied by its
1733 * parent's scale size. @c 1.0 means ādon't scaleā, @c 2.0 is
1734 * double size, @c 0.5 is half, etc.
1736 * @ref general_functions_example_page "This" example contemplates
1737 * some of these functions.
1741 * Get the global scaling factor
1743 * This gets the globally configured scaling factor that is applied to all
1746 * @return The scaling factor
1749 EAPI double elm_scale_get(void);
1752 * Set the global scaling factor
1754 * This sets the globally configured scaling factor that is applied to all
1757 * @param scale The scaling factor to set
1760 EAPI void elm_scale_set(double scale);
1763 * Set the global scaling factor for all applications on the display
1765 * This sets the globally configured scaling factor that is applied to all
1766 * objects for all applications.
1767 * @param scale The scaling factor to set
1770 EAPI void elm_scale_all_set(double scale);
1773 * Set the scaling factor for a given Elementary object
1775 * @param obj The Elementary to operate on
1776 * @param scale Scale factor (from @c 0.0 up, with @c 1.0 meaning
1781 EAPI void elm_object_scale_set(Evas_Object *obj, double scale) EINA_ARG_NONNULL(1);
1784 * Get the scaling factor for a given Elementary object
1786 * @param obj The object
1787 * @return The scaling factor set by elm_object_scale_set()
1791 EAPI double elm_object_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1794 * @defgroup Password_last_show Password last input show
1796 * Last show feature of password mode enables user to view
1797 * the last input entered for few seconds before masking it.
1798 * These functions allow to set this feature in password mode
1799 * of entry widget and also allow to manipulate the duration
1800 * for which the input has to be visible.
1806 * Get show last setting of password mode.
1808 * This gets the show last input setting of password mode which might be
1809 * enabled or disabled.
1811 * @return @c EINA_TRUE, if the last input show setting is enabled, @c EINA_FALSE
1813 * @ingroup Password_last_show
1815 EAPI Eina_Bool elm_password_show_last_get(void);
1818 * Set show last setting in password mode.
1820 * This enables or disables show last setting of password mode.
1822 * @param password_show_last If EINA_TRUE enable's last input show in password mode.
1823 * @see elm_password_show_last_timeout_set()
1824 * @ingroup Password_last_show
1826 EAPI void elm_password_show_last_set(Eina_Bool password_show_last);
1829 * Get's the timeout value in last show password mode.
1831 * This gets the time out value for which the last input entered in password
1832 * mode will be visible.
1834 * @return The timeout value of last show password mode.
1835 * @ingroup Password_last_show
1837 EAPI double elm_password_show_last_timeout_get(void);
1840 * Set's the timeout value in last show password mode.
1842 * This sets the time out value for which the last input entered in password
1843 * mode will be visible.
1845 * @param password_show_last_timeout The timeout value.
1846 * @see elm_password_show_last_set()
1847 * @ingroup Password_last_show
1849 EAPI void elm_password_show_last_timeout_set(double password_show_last_timeout);
1856 * @defgroup UI-Mirroring Selective Widget mirroring
1858 * These functions allow you to set ui-mirroring on specific
1859 * widgets or the whole interface. Widgets can be in one of two
1860 * modes, automatic and manual. Automatic means they'll be changed
1861 * according to the system mirroring mode and manual means only
1862 * explicit changes will matter. You are not supposed to change
1863 * mirroring state of a widget set to automatic, will mostly work,
1864 * but the behavior is not really defined.
1869 EAPI Eina_Bool elm_mirrored_get(void);
1870 EAPI void elm_mirrored_set(Eina_Bool mirrored);
1873 * Get the system mirrored mode. This determines the default mirrored mode
1876 * @return EINA_TRUE if mirrored is set, EINA_FALSE otherwise
1878 EAPI Eina_Bool elm_object_mirrored_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1881 * Set the system mirrored mode. This determines the default mirrored mode
1884 * @param mirrored EINA_TRUE to set mirrored mode, EINA_FALSE to unset it.
1886 EAPI void elm_object_mirrored_set(Evas_Object *obj, Eina_Bool mirrored) EINA_ARG_NONNULL(1);
1889 * Returns the widget's mirrored mode setting.
1891 * @param obj The widget.
1892 * @return mirrored mode setting of the object.
1895 EAPI Eina_Bool elm_object_mirrored_automatic_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1898 * Sets the widget's mirrored mode setting.
1899 * When widget in automatic mode, it follows the system mirrored mode set by
1900 * elm_mirrored_set().
1901 * @param obj The widget.
1902 * @param automatic EINA_TRUE for auto mirrored mode. EINA_FALSE for manual.
1904 EAPI void elm_object_mirrored_automatic_set(Evas_Object *obj, Eina_Bool automatic) EINA_ARG_NONNULL(1);
1911 * Set the style to use by a widget
1913 * Sets the style name that will define the appearance of a widget. Styles
1914 * vary from widget to widget and may also be defined by other themes
1915 * by means of extensions and overlays.
1917 * @param obj The Elementary widget to style
1918 * @param style The style name to use
1920 * @see elm_theme_extension_add()
1921 * @see elm_theme_extension_del()
1922 * @see elm_theme_overlay_add()
1923 * @see elm_theme_overlay_del()
1927 EAPI void elm_object_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
1929 * Get the style used by the widget
1931 * This gets the style being used for that widget. Note that the string
1932 * pointer is only valid as longas the object is valid and the style doesn't
1935 * @param obj The Elementary widget to query for its style
1936 * @return The style name used
1938 * @see elm_object_style_set()
1942 EAPI const char *elm_object_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1945 * @defgroup Styles Styles
1947 * Widgets can have different styles of look. These generic API's
1948 * set styles of widgets, if they support them (and if the theme(s)
1951 * @ref general_functions_example_page "This" example contemplates
1952 * some of these functions.
1956 * Set the disabled state of an Elementary object.
1958 * @param obj The Elementary object to operate on
1959 * @param disabled The state to put in in: @c EINA_TRUE for
1960 * disabled, @c EINA_FALSE for enabled
1962 * Elementary objects can be @b disabled, in which state they won't
1963 * receive input and, in general, will be themed differently from
1964 * their normal state, usually greyed out. Useful for contexts
1965 * where you don't want your users to interact with some of the
1966 * parts of you interface.
1968 * This sets the state for the widget, either disabling it or
1973 EAPI void elm_object_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
1976 * Get the disabled state of an Elementary object.
1978 * @param obj The Elementary object to operate on
1979 * @return @c EINA_TRUE, if the widget is disabled, @c EINA_FALSE
1980 * if it's enabled (or on errors)
1982 * This gets the state of the widget, which might be enabled or disabled.
1986 EAPI Eina_Bool elm_object_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1989 * @defgroup WidgetNavigation Widget Tree Navigation.
1991 * How to check if an Evas Object is an Elementary widget? How to
1992 * get the first elementary widget that is parent of the given
1993 * object? These are all covered in widget tree navigation.
1995 * @ref general_functions_example_page "This" example contemplates
1996 * some of these functions.
2000 * Check if the given Evas Object is an Elementary widget.
2002 * @param obj the object to query.
2003 * @return @c EINA_TRUE if it is an elementary widget variant,
2004 * @c EINA_FALSE otherwise
2005 * @ingroup WidgetNavigation
2007 EAPI Eina_Bool elm_object_widget_check(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2010 * Get the first parent of the given object that is an Elementary
2013 * @param obj the Elementary object to query parent from.
2014 * @return the parent object that is an Elementary widget, or @c
2015 * NULL, if it was not found.
2017 * Use this to query for an object's parent widget.
2019 * @note Most of Elementary users wouldn't be mixing non-Elementary
2020 * smart objects in the objects tree of an application, as this is
2021 * an advanced usage of Elementary with Evas. So, except for the
2022 * application's window, which is the root of that tree, all other
2023 * objects would have valid Elementary widget parents.
2025 * @ingroup WidgetNavigation
2027 EAPI Evas_Object *elm_object_parent_widget_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2030 * Get the top level parent of an Elementary widget.
2032 * @param obj The object to query.
2033 * @return The top level Elementary widget, or @c NULL if parent cannot be
2035 * @ingroup WidgetNavigation
2037 EAPI Evas_Object *elm_object_top_widget_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2040 * Get the string that represents this Elementary widget.
2042 * @note Elementary is weird and exposes itself as a single
2043 * Evas_Object_Smart_Class of type "elm_widget", so
2044 * evas_object_type_get() always return that, making debug and
2045 * language bindings hard. This function tries to mitigate this
2046 * problem, but the solution is to change Elementary to use
2047 * proper inheritance.
2049 * @param obj the object to query.
2050 * @return Elementary widget name, or @c NULL if not a valid widget.
2051 * @ingroup WidgetNavigation
2053 EAPI const char *elm_object_widget_type_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2056 * @defgroup Config Elementary Config
2058 * Elementary configuration is formed by a set options bounded to a
2059 * given @ref Profile profile, like @ref Theme theme, @ref Fingers
2060 * "finger size", etc. These are functions with which one syncronizes
2061 * changes made to those values to the configuration storing files, de
2062 * facto. You most probably don't want to use the functions in this
2063 * group unlees you're writing an elementary configuration manager.
2069 * Save back Elementary's configuration, so that it will persist on
2072 * @return @c EINA_TRUE, when sucessful. @c EINA_FALSE, otherwise.
2075 * This function will take effect -- thus, do I/O -- immediately. Use
2076 * it when you want to apply all configuration changes at once. The
2077 * current configuration set will get saved onto the current profile
2078 * configuration file.
2081 EAPI Eina_Bool elm_config_save(void);
2084 * Reload Elementary's configuration, bounded to current selected
2087 * @return @c EINA_TRUE, when sucessful. @c EINA_FALSE, otherwise.
2090 * Useful when you want to force reloading of configuration values for
2091 * a profile. If one removes user custom configuration directories,
2092 * for example, it will force a reload with system values instead.
2095 EAPI void elm_config_reload(void);
2102 * @defgroup Profile Elementary Profile
2104 * Profiles are pre-set options that affect the whole look-and-feel of
2105 * Elementary-based applications. There are, for example, profiles
2106 * aimed at desktop computer applications and others aimed at mobile,
2107 * touchscreen-based ones. You most probably don't want to use the
2108 * functions in this group unlees you're writing an elementary
2109 * configuration manager.
2115 * Get Elementary's profile in use.
2117 * This gets the global profile that is applied to all Elementary
2120 * @return The profile's name
2123 EAPI const char *elm_profile_current_get(void);
2126 * Get an Elementary's profile directory path in the filesystem. One
2127 * may want to fetch a system profile's dir or an user one (fetched
2130 * @param profile The profile's name
2131 * @param is_user Whether to lookup for an user profile (@c EINA_TRUE)
2132 * or a system one (@c EINA_FALSE)
2133 * @return The profile's directory path.
2136 * @note You must free it with elm_profile_dir_free().
2138 EAPI const char *elm_profile_dir_get(const char *profile, Eina_Bool is_user);
2141 * Free an Elementary's profile directory path, as returned by
2142 * elm_profile_dir_get().
2144 * @param p_dir The profile's path
2148 EAPI void elm_profile_dir_free(const char *p_dir);
2151 * Get Elementary's list of available profiles.
2153 * @return The profiles list. List node data are the profile name
2157 * @note One must free this list, after usage, with the function
2158 * elm_profile_list_free().
2160 EAPI Eina_List *elm_profile_list_get(void);
2163 * Free Elementary's list of available profiles.
2165 * @param l The profiles list, as returned by elm_profile_list_get().
2169 EAPI void elm_profile_list_free(Eina_List *l);
2172 * Set Elementary's profile.
2174 * This sets the global profile that is applied to Elementary
2175 * applications. Just the process the call comes from will be
2178 * @param profile The profile's name
2182 EAPI void elm_profile_set(const char *profile);
2185 * Set Elementary's profile.
2187 * This sets the global profile that is applied to all Elementary
2188 * applications. All running Elementary windows will be affected.
2190 * @param profile The profile's name
2194 EAPI void elm_profile_all_set(const char *profile);
2201 * @defgroup Engine Elementary Engine
2203 * These are functions setting and querying which rendering engine
2204 * Elementary will use for drawing its windows' pixels.
2206 * The following are the available engines:
2207 * @li "software_x11"
2210 * @li "software_16_x11"
2211 * @li "software_8_x11"
2214 * @li "software_gdi"
2215 * @li "software_16_wince_gdi"
2217 * @li "software_16_sdl"
2221 * @li "opengl_cocoa"
2228 * @brief Get Elementary's rendering engine in use.
2230 * @return The rendering engine's name
2231 * @note there's no need to free the returned string, here.
2233 * This gets the global rendering engine that is applied to all Elementary
2236 * @see elm_engine_set()
2238 EAPI const char *elm_engine_current_get(void);
2241 * @brief Set Elementary's rendering engine for use.
2243 * @param engine The rendering engine's name
2245 * This sets global rendering engine that is applied to all Elementary
2246 * applications. Note that it will take effect only to Elementary windows
2247 * created after this is called.
2249 * @see elm_win_add()
2251 EAPI void elm_engine_set(const char *engine);
2258 * @defgroup Fonts Elementary Fonts
2260 * These are functions dealing with font rendering, selection and the
2261 * like for Elementary applications. One might fetch which system
2262 * fonts are there to use and set custom fonts for individual classes
2263 * of UI items containing text (text classes).
2268 typedef struct _Elm_Text_Class
2274 typedef struct _Elm_Font_Overlay
2276 const char *text_class;
2278 Evas_Font_Size size;
2281 typedef struct _Elm_Font_Properties
2285 } Elm_Font_Properties;
2288 * Get Elementary's list of supported text classes.
2290 * @return The text classes list, with @c Elm_Text_Class blobs as data.
2293 * Release the list with elm_text_classes_list_free().
2295 EAPI const Eina_List *elm_text_classes_list_get(void);
2298 * Free Elementary's list of supported text classes.
2302 * @see elm_text_classes_list_get().
2304 EAPI void elm_text_classes_list_free(const Eina_List *list);
2307 * Get Elementary's list of font overlays, set with
2308 * elm_font_overlay_set().
2310 * @return The font overlays list, with @c Elm_Font_Overlay blobs as
2315 * For each text class, one can set a <b>font overlay</b> for it,
2316 * overriding the default font properties for that class coming from
2317 * the theme in use. There is no need to free this list.
2319 * @see elm_font_overlay_set() and elm_font_overlay_unset().
2321 EAPI const Eina_List *elm_font_overlay_list_get(void);
2324 * Set a font overlay for a given Elementary text class.
2326 * @param text_class Text class name
2327 * @param font Font name and style string
2328 * @param size Font size
2332 * @p font has to be in the format returned by
2333 * elm_font_fontconfig_name_get(). @see elm_font_overlay_list_get()
2334 * and elm_font_overlay_unset().
2336 EAPI void elm_font_overlay_set(const char *text_class, const char *font, Evas_Font_Size size);
2339 * Unset a font overlay for a given Elementary text class.
2341 * @param text_class Text class name
2345 * This will bring back text elements belonging to text class
2346 * @p text_class back to their default font settings.
2348 EAPI void elm_font_overlay_unset(const char *text_class);
2351 * Apply the changes made with elm_font_overlay_set() and
2352 * elm_font_overlay_unset() on the current Elementary window.
2356 * This applies all font overlays set to all objects in the UI.
2358 EAPI void elm_font_overlay_apply(void);
2361 * Apply the changes made with elm_font_overlay_set() and
2362 * elm_font_overlay_unset() on all Elementary application windows.
2366 * This applies all font overlays set to all objects in the UI.
2368 EAPI void elm_font_overlay_all_apply(void);
2371 * Translate a font (family) name string in fontconfig's font names
2372 * syntax into an @c Elm_Font_Properties struct.
2374 * @param font The font name and styles string
2375 * @return the font properties struct
2379 * @note The reverse translation can be achived with
2380 * elm_font_fontconfig_name_get(), for one style only (single font
2381 * instance, not family).
2383 EAPI Elm_Font_Properties *elm_font_properties_get(const char *font) EINA_ARG_NONNULL(1);
2386 * Free font properties return by elm_font_properties_get().
2388 * @param efp the font properties struct
2392 EAPI void elm_font_properties_free(Elm_Font_Properties *efp) EINA_ARG_NONNULL(1);
2395 * Translate a font name, bound to a style, into fontconfig's font names
2398 * @param name The font (family) name
2399 * @param style The given style (may be @c NULL)
2401 * @return the font name and style string
2405 * @note The reverse translation can be achived with
2406 * elm_font_properties_get(), for one style only (single font
2407 * instance, not family).
2409 EAPI const char *elm_font_fontconfig_name_get(const char *name, const char *style) EINA_ARG_NONNULL(1);
2412 * Free the font string return by elm_font_fontconfig_name_get().
2414 * @param efp the font properties struct
2418 EAPI void elm_font_fontconfig_name_free(const char *name) EINA_ARG_NONNULL(1);
2421 * Create a font hash table of available system fonts.
2423 * One must call it with @p list being the return value of
2424 * evas_font_available_list(). The hash will be indexed by font
2425 * (family) names, being its values @c Elm_Font_Properties blobs.
2427 * @param list The list of available system fonts, as returned by
2428 * evas_font_available_list().
2429 * @return the font hash.
2433 * @note The user is supposed to get it populated at least with 3
2434 * default font families (Sans, Serif, Monospace), which should be
2435 * present on most systems.
2437 EAPI Eina_Hash *elm_font_available_hash_add(Eina_List *list);
2440 * Free the hash return by elm_font_available_hash_add().
2442 * @param hash the hash to be freed.
2446 EAPI void elm_font_available_hash_del(Eina_Hash *hash);
2453 * @defgroup Fingers Fingers
2455 * Elementary is designed to be finger-friendly for touchscreens,
2456 * and so in addition to scaling for display resolution, it can
2457 * also scale based on finger "resolution" (or size). You can then
2458 * customize the granularity of the areas meant to receive clicks
2461 * Different profiles may have pre-set values for finger sizes.
2463 * @ref general_functions_example_page "This" example contemplates
2464 * some of these functions.
2470 * Get the configured "finger size"
2472 * @return The finger size
2474 * This gets the globally configured finger size, <b>in pixels</b>
2478 EAPI Evas_Coord elm_finger_size_get(void);
2481 * Set the configured finger size
2483 * This sets the globally configured finger size in pixels
2485 * @param size The finger size
2488 EAPI void elm_finger_size_set(Evas_Coord size);
2491 * Set the configured finger size for all applications on the display
2493 * This sets the globally configured finger size in pixels for all
2494 * applications on the display
2496 * @param size The finger size
2499 EAPI void elm_finger_size_all_set(Evas_Coord size);
2506 * @defgroup Focus Focus
2508 * An Elementary application has, at all times, one (and only one)
2509 * @b focused object. This is what determines where the input
2510 * events go to within the application's window. Also, focused
2511 * objects can be decorated differently, in order to signal to the
2512 * user where the input is, at a given moment.
2514 * Elementary applications also have the concept of <b>focus
2515 * chain</b>: one can cycle through all the windows' focusable
2516 * objects by input (tab key) or programmatically. The default
2517 * focus chain for an application is the one define by the order in
2518 * which the widgets where added in code. One will cycle through
2519 * top level widgets, and, for each one containg sub-objects, cycle
2520 * through them all, before returning to the level
2521 * above. Elementary also allows one to set @b custom focus chains
2522 * for their applications.
2524 * Besides the focused decoration a widget may exhibit, when it
2525 * gets focus, Elementary has a @b global focus highlight object
2526 * that can be enabled for a window. If one chooses to do so, this
2527 * extra highlight effect will surround the current focused object,
2530 * @note Some Elementary widgets are @b unfocusable, after
2531 * creation, by their very nature: they are not meant to be
2532 * interacted with input events, but are there just for visual
2535 * @ref general_functions_example_page "This" example contemplates
2536 * some of these functions.
2540 * Get the enable status of the focus highlight
2542 * This gets whether the highlight on focused objects is enabled or not
2545 EAPI Eina_Bool elm_focus_highlight_enabled_get(void);
2548 * Set the enable status of the focus highlight
2550 * Set whether to show or not the highlight on focused objects
2551 * @param enable Enable highlight if EINA_TRUE, disable otherwise
2554 EAPI void elm_focus_highlight_enabled_set(Eina_Bool enable);
2557 * Get the enable status of the highlight animation
2559 * Get whether the focus highlight, if enabled, will animate its switch from
2560 * one object to the next
2563 EAPI Eina_Bool elm_focus_highlight_animate_get(void);
2566 * Set the enable status of the highlight animation
2568 * Set whether the focus highlight, if enabled, will animate its switch from
2569 * one object to the next
2570 * @param animate Enable animation if EINA_TRUE, disable otherwise
2573 EAPI void elm_focus_highlight_animate_set(Eina_Bool animate);
2576 * Get the whether an Elementary object has the focus or not.
2578 * @param obj The Elementary object to get the information from
2579 * @return @c EINA_TRUE, if the object is focused, @c EINA_FALSE if
2580 * not (and on errors).
2582 * @see elm_object_focus_set()
2586 EAPI Eina_Bool elm_object_focus_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2589 * Set/unset focus to a given Elementary object.
2591 * @param obj The Elementary object to operate on.
2592 * @param enable @c EINA_TRUE Set focus to a given object,
2593 * @c EINA_FALSE Unset focus to a given object.
2595 * @note When you set focus to this object, if it can handle focus, will
2596 * take the focus away from the one who had it previously and will, for
2597 * now on, be the one receiving input events. Unsetting focus will remove
2598 * the focus from @p obj, passing it back to the previous element in the
2601 * @see elm_object_focus_get(), elm_object_focus_custom_chain_get()
2605 EAPI void elm_object_focus_set(Evas_Object *obj, Eina_Bool focus) EINA_ARG_NONNULL(1);
2608 * Make a given Elementary object the focused one.
2610 * @param obj The Elementary object to make focused.
2612 * @note This object, if it can handle focus, will take the focus
2613 * away from the one who had it previously and will, for now on, be
2614 * the one receiving input events.
2616 * @see elm_object_focus_get()
2617 * @deprecated use elm_object_focus_set() instead.
2621 EINA_DEPRECATED EAPI void elm_object_focus(Evas_Object *obj) EINA_ARG_NONNULL(1);
2624 * Remove the focus from an Elementary object
2626 * @param obj The Elementary to take focus from
2628 * This removes the focus from @p obj, passing it back to the
2629 * previous element in the focus chain list.
2631 * @see elm_object_focus() and elm_object_focus_custom_chain_get()
2632 * @deprecated use elm_object_focus_set() instead.
2636 EINA_DEPRECATED EAPI void elm_object_unfocus(Evas_Object *obj) EINA_ARG_NONNULL(1);
2639 * Set the ability for an Element object to be focused
2641 * @param obj The Elementary object to operate on
2642 * @param enable @c EINA_TRUE if the object can be focused, @c
2643 * EINA_FALSE if not (and on errors)
2645 * This sets whether the object @p obj is able to take focus or
2646 * not. Unfocusable objects do nothing when programmatically
2647 * focused, being the nearest focusable parent object the one
2648 * really getting focus. Also, when they receive mouse input, they
2649 * will get the event, but not take away the focus from where it
2654 EAPI void elm_object_focus_allow_set(Evas_Object *obj, Eina_Bool enable) EINA_ARG_NONNULL(1);
2657 * Get whether an Elementary object is focusable or not
2659 * @param obj The Elementary object to operate on
2660 * @return @c EINA_TRUE if the object is allowed to be focused, @c
2661 * EINA_FALSE if not (and on errors)
2663 * @note Objects which are meant to be interacted with by input
2664 * events are created able to be focused, by default. All the
2669 EAPI Eina_Bool elm_object_focus_allow_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2672 * Set custom focus chain.
2674 * This function overwrites any previous custom focus chain within
2675 * the list of objects. The previous list will be deleted and this list
2676 * will be managed by elementary. After it is set, don't modify it.
2678 * @note On focus cycle, only will be evaluated children of this container.
2680 * @param obj The container object
2681 * @param objs Chain of objects to pass focus
2684 EAPI void elm_object_focus_custom_chain_set(Evas_Object *obj, Eina_List *objs) EINA_ARG_NONNULL(1);
2687 * Unset a custom focus chain on a given Elementary widget
2689 * @param obj The container object to remove focus chain from
2691 * Any focus chain previously set on @p obj (for its child objects)
2692 * is removed entirely after this call.
2696 EAPI void elm_object_focus_custom_chain_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
2699 * Get custom focus chain
2701 * @param obj The container object
2704 EAPI const Eina_List *elm_object_focus_custom_chain_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2707 * Append object to custom focus chain.
2709 * @note If relative_child equal to NULL or not in custom chain, the object
2710 * will be added in end.
2712 * @note On focus cycle, only will be evaluated children of this container.
2714 * @param obj The container object
2715 * @param child The child to be added in custom chain
2716 * @param relative_child The relative object to position the child
2719 EAPI void elm_object_focus_custom_chain_append(Evas_Object *obj, Evas_Object *child, Evas_Object *relative_child) EINA_ARG_NONNULL(1, 2);
2722 * Prepend object to custom focus chain.
2724 * @note If relative_child equal to NULL or not in custom chain, the object
2725 * will be added in begin.
2727 * @note On focus cycle, only will be evaluated children of this container.
2729 * @param obj The container object
2730 * @param child The child to be added in custom chain
2731 * @param relative_child The relative object to position the child
2734 EAPI void elm_object_focus_custom_chain_prepend(Evas_Object *obj, Evas_Object *child, Evas_Object *relative_child) EINA_ARG_NONNULL(1, 2);
2737 * Give focus to next object in object tree.
2739 * Give focus to next object in focus chain of one object sub-tree.
2740 * If the last object of chain already have focus, the focus will go to the
2741 * first object of chain.
2743 * @param obj The object root of sub-tree
2744 * @param dir Direction to cycle the focus
2748 EAPI void elm_object_focus_cycle(Evas_Object *obj, Elm_Focus_Direction dir) EINA_ARG_NONNULL(1);
2751 * Give focus to near object in one direction.
2753 * Give focus to near object in direction of one object.
2754 * If none focusable object in given direction, the focus will not change.
2756 * @param obj The reference object
2757 * @param x Horizontal component of direction to focus
2758 * @param y Vertical component of direction to focus
2762 EAPI void elm_object_focus_direction_go(Evas_Object *obj, int x, int y) EINA_ARG_NONNULL(1);
2765 * Make the elementary object and its children to be unfocusable
2768 * @param obj The Elementary object to operate on
2769 * @param tree_unfocusable @c EINA_TRUE for unfocusable,
2770 * @c EINA_FALSE for focusable.
2772 * This sets whether the object @p obj and its children objects
2773 * are able to take focus or not. If the tree is set as unfocusable,
2774 * newest focused object which is not in this tree will get focus.
2775 * This API can be helpful for an object to be deleted.
2776 * When an object will be deleted soon, it and its children may not
2777 * want to get focus (by focus reverting or by other focus controls).
2778 * Then, just use this API before deleting.
2780 * @see elm_object_tree_unfocusable_get()
2784 EAPI void elm_object_tree_unfocusable_set(Evas_Object *obj, Eina_Bool tree_unfocusable) EINA_ARG_NONNULL(1);
2787 * Get whether an Elementary object and its children are unfocusable or not.
2789 * @param obj The Elementary object to get the information from
2790 * @return @c EINA_TRUE, if the tree is unfocussable,
2791 * @c EINA_FALSE if not (and on errors).
2793 * @see elm_object_tree_unfocusable_set()
2797 EAPI Eina_Bool elm_object_tree_unfocusable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2800 * @defgroup Scrolling Scrolling
2802 * These are functions setting how scrollable views in Elementary
2803 * widgets should behave on user interaction.
2809 * Get whether scrollers should bounce when they reach their
2810 * viewport's edge during a scroll.
2812 * @return the thumb scroll bouncing state
2814 * This is the default behavior for touch screens, in general.
2815 * @ingroup Scrolling
2817 EAPI Eina_Bool elm_scroll_bounce_enabled_get(void);
2820 * Set whether scrollers should bounce when they reach their
2821 * viewport's edge during a scroll.
2823 * @param enabled the thumb scroll bouncing state
2825 * @see elm_thumbscroll_bounce_enabled_get()
2826 * @ingroup Scrolling
2828 EAPI void elm_scroll_bounce_enabled_set(Eina_Bool enabled);
2831 * Set whether scrollers should bounce when they reach their
2832 * viewport's edge during a scroll, for all Elementary application
2835 * @param enabled the thumb scroll bouncing state
2837 * @see elm_thumbscroll_bounce_enabled_get()
2838 * @ingroup Scrolling
2840 EAPI void elm_scroll_bounce_enabled_all_set(Eina_Bool enabled);
2843 * Get the amount of inertia a scroller will impose at bounce
2846 * @return the thumb scroll bounce friction
2848 * @ingroup Scrolling
2850 EAPI double elm_scroll_bounce_friction_get(void);
2853 * Set the amount of inertia a scroller will impose at bounce
2856 * @param friction the thumb scroll bounce friction
2858 * @see elm_thumbscroll_bounce_friction_get()
2859 * @ingroup Scrolling
2861 EAPI void elm_scroll_bounce_friction_set(double friction);
2864 * Set the amount of inertia a scroller will impose at bounce
2865 * animations, for all Elementary application windows.
2867 * @param friction the thumb scroll bounce friction
2869 * @see elm_thumbscroll_bounce_friction_get()
2870 * @ingroup Scrolling
2872 EAPI void elm_scroll_bounce_friction_all_set(double friction);
2875 * Get the amount of inertia a <b>paged</b> scroller will impose at
2876 * page fitting animations.
2878 * @return the page scroll friction
2880 * @ingroup Scrolling
2882 EAPI double elm_scroll_page_scroll_friction_get(void);
2885 * Set the amount of inertia a <b>paged</b> scroller will impose at
2886 * page fitting animations.
2888 * @param friction the page scroll friction
2890 * @see elm_thumbscroll_page_scroll_friction_get()
2891 * @ingroup Scrolling
2893 EAPI void elm_scroll_page_scroll_friction_set(double friction);
2896 * Set the amount of inertia a <b>paged</b> scroller will impose at
2897 * page fitting animations, for all Elementary application windows.
2899 * @param friction the page scroll friction
2901 * @see elm_thumbscroll_page_scroll_friction_get()
2902 * @ingroup Scrolling
2904 EAPI void elm_scroll_page_scroll_friction_all_set(double friction);
2907 * Get the amount of inertia a scroller will impose at region bring
2910 * @return the bring in scroll friction
2912 * @ingroup Scrolling
2914 EAPI double elm_scroll_bring_in_scroll_friction_get(void);
2917 * Set the amount of inertia a scroller will impose at region bring
2920 * @param friction the bring in scroll friction
2922 * @see elm_thumbscroll_bring_in_scroll_friction_get()
2923 * @ingroup Scrolling
2925 EAPI void elm_scroll_bring_in_scroll_friction_set(double friction);
2928 * Set the amount of inertia a scroller will impose at region bring
2929 * animations, for all Elementary application windows.
2931 * @param friction the bring in scroll friction
2933 * @see elm_thumbscroll_bring_in_scroll_friction_get()
2934 * @ingroup Scrolling
2936 EAPI void elm_scroll_bring_in_scroll_friction_all_set(double friction);
2939 * Get the amount of inertia scrollers will impose at animations
2940 * triggered by Elementary widgets' zooming API.
2942 * @return the zoom friction
2944 * @ingroup Scrolling
2946 EAPI double elm_scroll_zoom_friction_get(void);
2949 * Set the amount of inertia scrollers will impose at animations
2950 * triggered by Elementary widgets' zooming API.
2952 * @param friction the zoom friction
2954 * @see elm_thumbscroll_zoom_friction_get()
2955 * @ingroup Scrolling
2957 EAPI void elm_scroll_zoom_friction_set(double friction);
2960 * Set the amount of inertia scrollers will impose at animations
2961 * triggered by Elementary widgets' zooming API, for all Elementary
2962 * application windows.
2964 * @param friction the zoom friction
2966 * @see elm_thumbscroll_zoom_friction_get()
2967 * @ingroup Scrolling
2969 EAPI void elm_scroll_zoom_friction_all_set(double friction);
2972 * Get whether scrollers should be draggable from any point in their
2975 * @return the thumb scroll state
2977 * @note This is the default behavior for touch screens, in general.
2978 * @note All other functions namespaced with "thumbscroll" will only
2979 * have effect if this mode is enabled.
2981 * @ingroup Scrolling
2983 EAPI Eina_Bool elm_scroll_thumbscroll_enabled_get(void);
2986 * Set whether scrollers should be draggable from any point in their
2989 * @param enabled the thumb scroll state
2991 * @see elm_thumbscroll_enabled_get()
2992 * @ingroup Scrolling
2994 EAPI void elm_scroll_thumbscroll_enabled_set(Eina_Bool enabled);
2997 * Set whether scrollers should be draggable from any point in their
2998 * views, for all Elementary application windows.
3000 * @param enabled the thumb scroll state
3002 * @see elm_thumbscroll_enabled_get()
3003 * @ingroup Scrolling
3005 EAPI void elm_scroll_thumbscroll_enabled_all_set(Eina_Bool enabled);
3008 * Get the number of pixels one should travel while dragging a
3009 * scroller's view to actually trigger scrolling.
3011 * @return the thumb scroll threshould
3013 * One would use higher values for touch screens, in general, because
3014 * of their inherent imprecision.
3015 * @ingroup Scrolling
3017 EAPI unsigned int elm_scroll_thumbscroll_threshold_get(void);
3020 * Set the number of pixels one should travel while dragging a
3021 * scroller's view to actually trigger scrolling.
3023 * @param threshold the thumb scroll threshould
3025 * @see elm_thumbscroll_threshould_get()
3026 * @ingroup Scrolling
3028 EAPI void elm_scroll_thumbscroll_threshold_set(unsigned int threshold);
3031 * Set the number of pixels one should travel while dragging a
3032 * scroller's view to actually trigger scrolling, for all Elementary
3033 * application windows.
3035 * @param threshold the thumb scroll threshould
3037 * @see elm_thumbscroll_threshould_get()
3038 * @ingroup Scrolling
3040 EAPI void elm_scroll_thumbscroll_threshold_all_set(unsigned int threshold);
3043 * Get the minimum speed of mouse cursor movement which will trigger
3044 * list self scrolling animation after a mouse up event
3047 * @return the thumb scroll momentum threshould
3049 * @ingroup Scrolling
3051 EAPI double elm_scroll_thumbscroll_momentum_threshold_get(void);
3054 * Set the minimum speed of mouse cursor movement which will trigger
3055 * list self scrolling animation after a mouse up event
3058 * @param threshold the thumb scroll momentum threshould
3060 * @see elm_thumbscroll_momentum_threshould_get()
3061 * @ingroup Scrolling
3063 EAPI void elm_scroll_thumbscroll_momentum_threshold_set(double threshold);
3066 * Set the minimum speed of mouse cursor movement which will trigger
3067 * list self scrolling animation after a mouse up event
3068 * (pixels/second), for all Elementary application windows.
3070 * @param threshold the thumb scroll momentum threshould
3072 * @see elm_thumbscroll_momentum_threshould_get()
3073 * @ingroup Scrolling
3075 EAPI void elm_scroll_thumbscroll_momentum_threshold_all_set(double threshold);
3078 * Get the amount of inertia a scroller will impose at self scrolling
3081 * @return the thumb scroll friction
3083 * @ingroup Scrolling
3085 EAPI double elm_scroll_thumbscroll_friction_get(void);
3088 * Set the amount of inertia a scroller will impose at self scrolling
3091 * @param friction the thumb scroll friction
3093 * @see elm_thumbscroll_friction_get()
3094 * @ingroup Scrolling
3096 EAPI void elm_scroll_thumbscroll_friction_set(double friction);
3099 * Set the amount of inertia a scroller will impose at self scrolling
3100 * animations, for all Elementary application windows.
3102 * @param friction the thumb scroll friction
3104 * @see elm_thumbscroll_friction_get()
3105 * @ingroup Scrolling
3107 EAPI void elm_scroll_thumbscroll_friction_all_set(double friction);
3110 * Get the amount of lag between your actual mouse cursor dragging
3111 * movement and a scroller's view movement itself, while pushing it
3112 * into bounce state manually.
3114 * @return the thumb scroll border friction
3116 * @ingroup Scrolling
3118 EAPI double elm_scroll_thumbscroll_border_friction_get(void);
3121 * Set the amount of lag between your actual mouse cursor dragging
3122 * movement and a scroller's view movement itself, while pushing it
3123 * into bounce state manually.
3125 * @param friction the thumb scroll border friction. @c 0.0 for
3126 * perfect synchrony between two movements, @c 1.0 for maximum
3129 * @see elm_thumbscroll_border_friction_get()
3130 * @note parameter value will get bound to 0.0 - 1.0 interval, always
3132 * @ingroup Scrolling
3134 EAPI void elm_scroll_thumbscroll_border_friction_set(double friction);
3137 * Set the amount of lag between your actual mouse cursor dragging
3138 * movement and a scroller's view movement itself, while pushing it
3139 * into bounce state manually, for all Elementary application windows.
3141 * @param friction the thumb scroll border friction. @c 0.0 for
3142 * perfect synchrony between two movements, @c 1.0 for maximum
3145 * @see elm_thumbscroll_border_friction_get()
3146 * @note parameter value will get bound to 0.0 - 1.0 interval, always
3148 * @ingroup Scrolling
3150 EAPI void elm_scroll_thumbscroll_border_friction_all_set(double friction);
3153 * Get the sensitivity amount which is be multiplied by the length of
3156 * @return the thumb scroll sensitivity friction
3158 * @ingroup Scrolling
3160 EAPI double elm_scroll_thumbscroll_sensitivity_friction_get(void);
3163 * Set the sensitivity amount which is be multiplied by the length of
3166 * @param friction the thumb scroll sensitivity friction. @c 0.1 for
3167 * minimun sensitivity, @c 1.0 for maximum sensitivity. 0.25
3170 * @see elm_thumbscroll_sensitivity_friction_get()
3171 * @note parameter value will get bound to 0.1 - 1.0 interval, always
3173 * @ingroup Scrolling
3175 EAPI void elm_scroll_thumbscroll_sensitivity_friction_set(double friction);
3178 * Set the sensitivity amount which is be multiplied by the length of
3179 * mouse dragging, for all Elementary application windows.
3181 * @param friction the thumb scroll sensitivity friction. @c 0.1 for
3182 * minimun sensitivity, @c 1.0 for maximum sensitivity. 0.25
3185 * @see elm_thumbscroll_sensitivity_friction_get()
3186 * @note parameter value will get bound to 0.1 - 1.0 interval, always
3188 * @ingroup Scrolling
3190 EAPI void elm_scroll_thumbscroll_sensitivity_friction_all_set(double friction);
3197 * @defgroup Scrollhints Scrollhints
3199 * Objects when inside a scroller can scroll, but this may not always be
3200 * desirable in certain situations. This allows an object to hint to itself
3201 * and parents to "not scroll" in one of 2 ways. If any child object of a
3202 * scroller has pushed a scroll freeze or hold then it affects all parent
3203 * scrollers until all children have released them.
3205 * 1. To hold on scrolling. This means just flicking and dragging may no
3206 * longer scroll, but pressing/dragging near an edge of the scroller will
3207 * still scroll. This is automatically used by the entry object when
3210 * 2. To totally freeze scrolling. This means it stops. until
3217 * Push the scroll hold by 1
3219 * This increments the scroll hold count by one. If it is more than 0 it will
3220 * take effect on the parents of the indicated object.
3222 * @param obj The object
3223 * @ingroup Scrollhints
3225 EAPI void elm_object_scroll_hold_push(Evas_Object *obj) EINA_ARG_NONNULL(1);
3228 * Pop the scroll hold by 1
3230 * This decrements the scroll hold count by one. If it is more than 0 it will
3231 * take effect on the parents of the indicated object.
3233 * @param obj The object
3234 * @ingroup Scrollhints
3236 EAPI void elm_object_scroll_hold_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
3239 * Push the scroll freeze by 1
3241 * This increments the scroll freeze count by one. If it is more
3242 * than 0 it will take effect on the parents of the indicated
3245 * @param obj The object
3246 * @ingroup Scrollhints
3248 EAPI void elm_object_scroll_freeze_push(Evas_Object *obj) EINA_ARG_NONNULL(1);
3251 * Pop the scroll freeze by 1
3253 * This decrements the scroll freeze count by one. If it is more
3254 * than 0 it will take effect on the parents of the indicated
3257 * @param obj The object
3258 * @ingroup Scrollhints
3260 EAPI void elm_object_scroll_freeze_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
3263 * Lock the scrolling of the given widget (and thus all parents)
3265 * This locks the given object from scrolling in the X axis (and implicitly
3266 * also locks all parent scrollers too from doing the same).
3268 * @param obj The object
3269 * @param lock The lock state (1 == locked, 0 == unlocked)
3270 * @ingroup Scrollhints
3272 EAPI void elm_object_scroll_lock_x_set(Evas_Object *obj, Eina_Bool lock) EINA_ARG_NONNULL(1);
3275 * Lock the scrolling of the given widget (and thus all parents)
3277 * This locks the given object from scrolling in the Y axis (and implicitly
3278 * also locks all parent scrollers too from doing the same).
3280 * @param obj The object
3281 * @param lock The lock state (1 == locked, 0 == unlocked)
3282 * @ingroup Scrollhints
3284 EAPI void elm_object_scroll_lock_y_set(Evas_Object *obj, Eina_Bool lock) EINA_ARG_NONNULL(1);
3287 * Get the scrolling lock of the given widget
3289 * This gets the lock for X axis scrolling.
3291 * @param obj The object
3292 * @ingroup Scrollhints
3294 EAPI Eina_Bool elm_object_scroll_lock_x_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3297 * Get the scrolling lock of the given widget
3299 * This gets the lock for X axis scrolling.
3301 * @param obj The object
3302 * @ingroup Scrollhints
3304 EAPI Eina_Bool elm_object_scroll_lock_y_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3311 * Send a signal to the widget edje object.
3313 * This function sends a signal to the edje object of the obj. An
3314 * edje program can respond to a signal by specifying matching
3315 * 'signal' and 'source' fields.
3317 * @param obj The object
3318 * @param emission The signal's name.
3319 * @param source The signal's source.
3322 EAPI void elm_object_signal_emit(Evas_Object *obj, const char *emission, const char *source) EINA_ARG_NONNULL(1);
3325 * Add a callback for a signal emitted by widget edje object.
3327 * This function connects a callback function to a signal emitted by the
3328 * edje object of the obj.
3329 * Globs can occur in either the emission or source name.
3331 * @param obj The object
3332 * @param emission The signal's name.
3333 * @param source The signal's source.
3334 * @param func The callback function to be executed when the signal is
3336 * @param data A pointer to data to pass in to the callback function.
3339 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);
3342 * Remove a signal-triggered callback from a widget edje object.
3344 * This function removes a callback, previoulsy attached to a
3345 * signal emitted by the edje object of the obj. The parameters
3346 * emission, source and func must match exactly those passed to a
3347 * previous call to elm_object_signal_callback_add(). The data
3348 * pointer that was passed to this call will be returned.
3350 * @param obj The object
3351 * @param emission The signal's name.
3352 * @param source The signal's source.
3353 * @param func The callback function to be executed when the signal is
3355 * @return The data pointer
3358 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);
3361 * Add a callback for input events (key up, key down, mouse wheel)
3362 * on a given Elementary widget
3364 * @param obj The widget to add an event callback on
3365 * @param func The callback function to be executed when the event
3367 * @param data Data to pass in to @p func
3369 * Every widget in an Elementary interface set to receive focus,
3370 * with elm_object_focus_allow_set(), will propagate @b all of its
3371 * key up, key down and mouse wheel input events up to its parent
3372 * object, and so on. All of the focusable ones in this chain which
3373 * had an event callback set, with this call, will be able to treat
3374 * those events. There are two ways of making the propagation of
3375 * these event upwards in the tree of widgets to @b cease:
3376 * - Just return @c EINA_TRUE on @p func. @c EINA_FALSE will mean
3377 * the event was @b not processed, so the propagation will go on.
3378 * - The @c event_info pointer passed to @p func will contain the
3379 * event's structure and, if you OR its @c event_flags inner
3380 * value to @c EVAS_EVENT_FLAG_ON_HOLD, you're telling Elementary
3381 * one has already handled it, thus killing the event's
3384 * @note Your event callback will be issued on those events taking
3385 * place only if no other child widget of @obj has consumed the
3388 * @note Not to be confused with @c
3389 * evas_object_event_callback_add(), which will add event callbacks
3390 * per type on general Evas objects (no event propagation
3391 * infrastructure taken in account).
3393 * @note Not to be confused with @c
3394 * elm_object_signal_callback_add(), which will add callbacks to @b
3395 * signals coming from a widget's theme, not input events.
3397 * @note Not to be confused with @c
3398 * edje_object_signal_callback_add(), which does the same as
3399 * elm_object_signal_callback_add(), but directly on an Edje
3402 * @note Not to be confused with @c
3403 * evas_object_smart_callback_add(), which adds callbacks to smart
3404 * objects' <b>smart events</b>, and not input events.
3406 * @see elm_object_event_callback_del()
3410 EAPI void elm_object_event_callback_add(Evas_Object *obj, Elm_Event_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
3413 * Remove an event callback from a widget.
3415 * This function removes a callback, previoulsy attached to event emission
3417 * The parameters func and data must match exactly those passed to
3418 * a previous call to elm_object_event_callback_add(). The data pointer that
3419 * was passed to this call will be returned.
3421 * @param obj The object
3422 * @param func The callback function to be executed when the event is
3424 * @param data Data to pass in to the callback function.
3425 * @return The data pointer
3428 EAPI void *elm_object_event_callback_del(Evas_Object *obj, Elm_Event_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
3431 * Adjust size of an element for finger usage.
3433 * @param times_w How many fingers should fit horizontally
3434 * @param w Pointer to the width size to adjust
3435 * @param times_h How many fingers should fit vertically
3436 * @param h Pointer to the height size to adjust
3438 * This takes width and height sizes (in pixels) as input and a
3439 * size multiple (which is how many fingers you want to place
3440 * within the area, being "finger" the size set by
3441 * elm_finger_size_set()), and adjusts the size to be large enough
3442 * to accommodate the resulting size -- if it doesn't already
3443 * accommodate it. On return the @p w and @p h sizes pointed to by
3444 * these parameters will be modified, on those conditions.
3446 * @note This is kind of a low level Elementary call, most useful
3447 * on size evaluation times for widgets. An external user wouldn't
3448 * be calling, most of the time.
3452 EAPI void elm_coords_finger_size_adjust(int times_w, Evas_Coord *w, int times_h, Evas_Coord *h);
3455 * Get the duration for occuring long press event.
3457 * @return Timeout for long press event
3458 * @ingroup Longpress
3460 EAPI double elm_longpress_timeout_get(void);
3463 * Set the duration for occuring long press event.
3465 * @param lonpress_timeout Timeout for long press event
3466 * @ingroup Longpress
3468 EAPI void elm_longpress_timeout_set(double longpress_timeout);
3471 * @defgroup Debug Debug
3472 * don't use it unless you are sure
3478 * Print Tree object hierarchy in stdout
3480 * @param obj The root object
3483 EAPI void elm_object_tree_dump(const Evas_Object *top);
3486 * Print Elm Objects tree hierarchy in file as dot(graphviz) syntax.
3488 * @param obj The root object
3489 * @param file The path of output file
3492 EAPI void elm_object_tree_dot_dump(const Evas_Object *top, const char *file);
3499 * @defgroup Theme Theme
3501 * Elementary uses Edje to theme its widgets, naturally. But for the most
3502 * part this is hidden behind a simpler interface that lets the user set
3503 * extensions and choose the style of widgets in a much easier way.
3505 * Instead of thinking in terms of paths to Edje files and their groups
3506 * each time you want to change the appearance of a widget, Elementary
3507 * works so you can add any theme file with extensions or replace the
3508 * main theme at one point in the application, and then just set the style
3509 * of widgets with elm_object_style_set() and related functions. Elementary
3510 * will then look in its list of themes for a matching group and apply it,
3511 * and when the theme changes midway through the application, all widgets
3512 * will be updated accordingly.
3514 * There are three concepts you need to know to understand how Elementary
3515 * theming works: default theme, extensions and overlays.
3517 * Default theme, obviously enough, is the one that provides the default
3518 * look of all widgets. End users can change the theme used by Elementary
3519 * by setting the @c ELM_THEME environment variable before running an
3520 * application, or globally for all programs using the @c elementary_config
3521 * utility. Applications can change the default theme using elm_theme_set(),
3522 * but this can go against the user wishes, so it's not an adviced practice.
3524 * Ideally, applications should find everything they need in the already
3525 * provided theme, but there may be occasions when that's not enough and
3526 * custom styles are required to correctly express the idea. For this
3527 * cases, Elementary has extensions.
3529 * Extensions allow the application developer to write styles of its own
3530 * to apply to some widgets. This requires knowledge of how each widget
3531 * is themed, as extensions will always replace the entire group used by
3532 * the widget, so important signals and parts need to be there for the
3533 * object to behave properly (see documentation of Edje for details).
3534 * Once the theme for the extension is done, the application needs to add
3535 * it to the list of themes Elementary will look into, using
3536 * elm_theme_extension_add(), and set the style of the desired widgets as
3537 * he would normally with elm_object_style_set().
3539 * Overlays, on the other hand, can replace the look of all widgets by
3540 * overriding the default style. Like extensions, it's up to the application
3541 * developer to write the theme for the widgets it wants, the difference
3542 * being that when looking for the theme, Elementary will check first the
3543 * list of overlays, then the set theme and lastly the list of extensions,
3544 * so with overlays it's possible to replace the default view and every
3545 * widget will be affected. This is very much alike to setting the whole
3546 * theme for the application and will probably clash with the end user
3547 * options, not to mention the risk of ending up with not matching styles
3548 * across the program. Unless there's a very special reason to use them,
3549 * overlays should be avoided for the resons exposed before.
3551 * All these theme lists are handled by ::Elm_Theme instances. Elementary
3552 * keeps one default internally and every function that receives one of
3553 * these can be called with NULL to refer to this default (except for
3554 * elm_theme_free()). It's possible to create a new instance of a
3555 * ::Elm_Theme to set other theme for a specific widget (and all of its
3556 * children), but this is as discouraged, if not even more so, than using
3557 * overlays. Don't use this unless you really know what you are doing.
3559 * But to be less negative about things, you can look at the following
3561 * @li @ref theme_example_01 "Using extensions"
3562 * @li @ref theme_example_02 "Using overlays"
3567 * @typedef Elm_Theme
3569 * Opaque handler for the list of themes Elementary looks for when
3570 * rendering widgets.
3572 * Stay out of this unless you really know what you are doing. For most
3573 * cases, sticking to the default is all a developer needs.
3575 typedef struct _Elm_Theme Elm_Theme;
3578 * Create a new specific theme
3580 * This creates an empty specific theme that only uses the default theme. A
3581 * specific theme has its own private set of extensions and overlays too
3582 * (which are empty by default). Specific themes do not fall back to themes
3583 * of parent objects. They are not intended for this use. Use styles, overlays
3584 * and extensions when needed, but avoid specific themes unless there is no
3585 * other way (example: you want to have a preview of a new theme you are
3586 * selecting in a "theme selector" window. The preview is inside a scroller
3587 * and should display what the theme you selected will look like, but not
3588 * actually apply it yet. The child of the scroller will have a specific
3589 * theme set to show this preview before the user decides to apply it to all
3592 EAPI Elm_Theme *elm_theme_new(void);
3594 * Free a specific theme
3596 * @param th The theme to free
3598 * This frees a theme created with elm_theme_new().
3600 EAPI void elm_theme_free(Elm_Theme *th);
3602 * Copy the theme fom the source to the destination theme
3604 * @param th The source theme to copy from
3605 * @param thdst The destination theme to copy data to
3607 * This makes a one-time static copy of all the theme config, extensions
3608 * and overlays from @p th to @p thdst. If @p th references a theme, then
3609 * @p thdst is also set to reference it, with all the theme settings,
3610 * overlays and extensions that @p th had.
3612 EAPI void elm_theme_copy(Elm_Theme *th, Elm_Theme *thdst);
3614 * Tell the source theme to reference the ref theme
3616 * @param th The theme that will do the referencing
3617 * @param thref The theme that is the reference source
3619 * This clears @p th to be empty and then sets it to refer to @p thref
3620 * so @p th acts as an override to @p thref, but where its overrides
3621 * don't apply, it will fall through to @p thref for configuration.
3623 EAPI void elm_theme_ref_set(Elm_Theme *th, Elm_Theme *thref);
3625 * Return the theme referred to
3627 * @param th The theme to get the reference from
3628 * @return The referenced theme handle
3630 * This gets the theme set as the reference theme by elm_theme_ref_set().
3631 * If no theme is set as a reference, NULL is returned.
3633 EAPI Elm_Theme *elm_theme_ref_get(Elm_Theme *th);
3635 * Return the default theme
3637 * @return The default theme handle
3639 * This returns the internal default theme setup handle that all widgets
3640 * use implicitly unless a specific theme is set. This is also often use
3641 * as a shorthand of NULL.
3643 EAPI Elm_Theme *elm_theme_default_get(void);
3645 * Prepends a theme overlay to the list of overlays
3647 * @param th The theme to add to, or if NULL, the default theme
3648 * @param item The Edje file path to be used
3650 * Use this if your application needs to provide some custom overlay theme
3651 * (An Edje file that replaces some default styles of widgets) where adding
3652 * new styles, or changing system theme configuration is not possible. Do
3653 * NOT use this instead of a proper system theme configuration. Use proper
3654 * configuration files, profiles, environment variables etc. to set a theme
3655 * so that the theme can be altered by simple confiugration by a user. Using
3656 * this call to achieve that effect is abusing the API and will create lots
3659 * @see elm_theme_extension_add()
3661 EAPI void elm_theme_overlay_add(Elm_Theme *th, const char *item);
3663 * Delete a theme overlay from the list of overlays
3665 * @param th The theme to delete from, or if NULL, the default theme
3666 * @param item The name of the theme overlay
3668 * @see elm_theme_overlay_add()
3670 EAPI void elm_theme_overlay_del(Elm_Theme *th, const char *item);
3672 * Appends a theme extension to the list of extensions.
3674 * @param th The theme to add to, or if NULL, the default theme
3675 * @param item The Edje file path to be used
3677 * This is intended when an application needs more styles of widgets or new
3678 * widget themes that the default does not provide (or may not provide). The
3679 * application has "extended" usage by coming up with new custom style names
3680 * for widgets for specific uses, but as these are not "standard", they are
3681 * not guaranteed to be provided by a default theme. This means the
3682 * application is required to provide these extra elements itself in specific
3683 * Edje files. This call adds one of those Edje files to the theme search
3684 * path to be search after the default theme. The use of this call is
3685 * encouraged when default styles do not meet the needs of the application.
3686 * Use this call instead of elm_theme_overlay_add() for almost all cases.
3688 * @see elm_object_style_set()
3690 EAPI void elm_theme_extension_add(Elm_Theme *th, const char *item);
3692 * Deletes a theme extension from the list of extensions.
3694 * @param th The theme to delete from, or if NULL, the default theme
3695 * @param item The name of the theme extension
3697 * @see elm_theme_extension_add()
3699 EAPI void elm_theme_extension_del(Elm_Theme *th, const char *item);
3701 * Set the theme search order for the given theme
3703 * @param th The theme to set the search order, or if NULL, the default theme
3704 * @param theme Theme search string
3706 * This sets the search string for the theme in path-notation from first
3707 * theme to search, to last, delimited by the : character. Example:
3709 * "shiny:/path/to/file.edj:default"
3711 * See the ELM_THEME environment variable for more information.
3713 * @see elm_theme_get()
3714 * @see elm_theme_list_get()
3716 EAPI void elm_theme_set(Elm_Theme *th, const char *theme);
3718 * Return the theme search order
3720 * @param th The theme to get the search order, or if NULL, the default theme
3721 * @return The internal search order path
3723 * This function returns a colon separated string of theme elements as
3724 * returned by elm_theme_list_get().
3726 * @see elm_theme_set()
3727 * @see elm_theme_list_get()
3729 EAPI const char *elm_theme_get(Elm_Theme *th);
3731 * Return a list of theme elements to be used in a theme.
3733 * @param th Theme to get the list of theme elements from.
3734 * @return The internal list of theme elements
3736 * This returns the internal list of theme elements (will only be valid as
3737 * long as the theme is not modified by elm_theme_set() or theme is not
3738 * freed by elm_theme_free(). This is a list of strings which must not be
3739 * altered as they are also internal. If @p th is NULL, then the default
3740 * theme element list is returned.
3742 * A theme element can consist of a full or relative path to a .edj file,
3743 * or a name, without extension, for a theme to be searched in the known
3744 * theme paths for Elemementary.
3746 * @see elm_theme_set()
3747 * @see elm_theme_get()
3749 EAPI const Eina_List *elm_theme_list_get(const Elm_Theme *th);
3751 * Return the full patrh for a theme element
3753 * @param f The theme element name
3754 * @param in_search_path Pointer to a boolean to indicate if item is in the search path or not
3755 * @return The full path to the file found.
3757 * This returns a string you should free with free() on success, NULL on
3758 * failure. This will search for the given theme element, and if it is a
3759 * full or relative path element or a simple searchable name. The returned
3760 * path is the full path to the file, if searched, and the file exists, or it
3761 * is simply the full path given in the element or a resolved path if
3762 * relative to home. The @p in_search_path boolean pointed to is set to
3763 * EINA_TRUE if the file was a searchable file andis in the search path,
3764 * and EINA_FALSE otherwise.
3766 EAPI char *elm_theme_list_item_path_get(const char *f, Eina_Bool *in_search_path);
3768 * Flush the current theme.
3770 * @param th Theme to flush
3772 * This flushes caches that let elementary know where to find theme elements
3773 * in the given theme. If @p th is NULL, then the default theme is flushed.
3774 * Call this function if source theme data has changed in such a way as to
3775 * make any caches Elementary kept invalid.
3777 EAPI void elm_theme_flush(Elm_Theme *th);
3779 * This flushes all themes (default and specific ones).
3781 * This will flush all themes in the current application context, by calling
3782 * elm_theme_flush() on each of them.
3784 EAPI void elm_theme_full_flush(void);
3786 * Set the theme for all elementary using applications on the current display
3788 * @param theme The name of the theme to use. Format same as the ELM_THEME
3789 * environment variable.
3791 EAPI void elm_theme_all_set(const char *theme);
3793 * Return a list of theme elements in the theme search path
3795 * @return A list of strings that are the theme element names.
3797 * This lists all available theme files in the standard Elementary search path
3798 * for theme elements, and returns them in alphabetical order as theme
3799 * element names in a list of strings. Free this with
3800 * elm_theme_name_available_list_free() when you are done with the list.
3802 EAPI Eina_List *elm_theme_name_available_list_new(void);
3804 * Free the list returned by elm_theme_name_available_list_new()
3806 * This frees the list of themes returned by
3807 * elm_theme_name_available_list_new(). Once freed the list should no longer
3808 * be used. a new list mys be created.
3810 EAPI void elm_theme_name_available_list_free(Eina_List *list);
3812 * Set a specific theme to be used for this object and its children
3814 * @param obj The object to set the theme on
3815 * @param th The theme to set
3817 * This sets a specific theme that will be used for the given object and any
3818 * child objects it has. If @p th is NULL then the theme to be used is
3819 * cleared and the object will inherit its theme from its parent (which
3820 * ultimately will use the default theme if no specific themes are set).
3822 * Use special themes with great care as this will annoy users and make
3823 * configuration difficult. Avoid any custom themes at all if it can be
3826 EAPI void elm_object_theme_set(Evas_Object *obj, Elm_Theme *th) EINA_ARG_NONNULL(1);
3828 * Get the specific theme to be used
3830 * @param obj The object to get the specific theme from
3831 * @return The specifc theme set.
3833 * This will return a specific theme set, or NULL if no specific theme is
3834 * set on that object. It will not return inherited themes from parents, only
3835 * the specific theme set for that specific object. See elm_object_theme_set()
3836 * for more information.
3838 EAPI Elm_Theme *elm_object_theme_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3841 * Get a data item from a theme
3843 * @param th The theme, or NULL for default theme
3844 * @param key The data key to search with
3845 * @return The data value, or NULL on failure
3847 * This function is used to return data items from edc in @p th, an overlay, or an extension.
3848 * It works the same way as edje_file_data_get() except that the return is stringshared.
3850 EAPI const char *elm_theme_data_get(Elm_Theme *th, const char *key) EINA_ARG_NONNULL(2);
3856 /** @defgroup Win Win
3858 * @image html img/widget/win/preview-00.png
3859 * @image latex img/widget/win/preview-00.eps
3861 * The window class of Elementary. Contains functions to manipulate
3862 * windows. The Evas engine used to render the window contents is specified
3863 * in the system or user elementary config files (whichever is found last),
3864 * and can be overridden with the ELM_ENGINE environment variable for
3865 * testing. Engines that may be supported (depending on Evas and Ecore-Evas
3866 * compilation setup and modules actually installed at runtime) are (listed
3867 * in order of best supported and most likely to be complete and work to
3870 * @li "x11", "x", "software-x11", "software_x11" (Software rendering in X11)
3871 * @li "gl", "opengl", "opengl-x11", "opengl_x11" (OpenGL or OpenGL-ES2
3873 * @li "shot:..." (Virtual screenshot renderer - renders to output file and
3875 * @li "fb", "software-fb", "software_fb" (Linux framebuffer direct software
3877 * @li "sdl", "software-sdl", "software_sdl" (SDL software rendering to SDL
3879 * @li "gl-sdl", "gl_sdl", "opengl-sdl", "opengl_sdl" (OpenGL or OpenGL-ES2
3880 * rendering using SDL as the buffer)
3881 * @li "gdi", "software-gdi", "software_gdi" (Windows WIN32 rendering via
3882 * GDI with software)
3883 * @li "dfb", "directfb" (Rendering to a DirectFB window)
3884 * @li "x11-8", "x8", "software-8-x11", "software_8_x11" (Rendering in
3885 * grayscale using dedicated 8bit software engine in X11)
3886 * @li "x11-16", "x16", "software-16-x11", "software_16_x11" (Rendering in
3887 * X11 using 16bit software engine)
3888 * @li "wince-gdi", "software-16-wince-gdi", "software_16_wince_gdi"
3889 * (Windows CE rendering via GDI with 16bit software renderer)
3890 * @li "sdl-16", "software-16-sdl", "software_16_sdl" (Rendering to SDL
3891 * buffer with 16bit software renderer)
3892 * @li "ews" (rendering to EWS - Ecore + Evas Single Process Windowing System)
3893 * @li "gl-cocoa", "gl_cocoa", "opengl-cocoa", "opengl_cocoa" (OpenGL rendering in Cocoa)
3894 * @li "psl1ght" (PS3 rendering using PSL1GHT)
3896 * All engines use a simple string to select the engine to render, EXCEPT
3897 * the "shot" engine. This actually encodes the output of the virtual
3898 * screenshot and how long to delay in the engine string. The engine string
3899 * is encoded in the following way:
3901 * "shot:[delay=XX][:][repeat=DDD][:][file=XX]"
3903 * Where options are separated by a ":" char if more than one option is
3904 * given, with delay, if provided being the first option and file the last
3905 * (order is important). The delay specifies how long to wait after the
3906 * window is shown before doing the virtual "in memory" rendering and then
3907 * save the output to the file specified by the file option (and then exit).
3908 * If no delay is given, the default is 0.5 seconds. If no file is given the
3909 * default output file is "out.png". Repeat option is for continous
3910 * capturing screenshots. Repeat range is from 1 to 999 and filename is
3911 * fixed to "out001.png" Some examples of using the shot engine:
3913 * ELM_ENGINE="shot:delay=1.0:repeat=5:file=elm_test.png" elementary_test
3914 * ELM_ENGINE="shot:delay=1.0:file=elm_test.png" elementary_test
3915 * ELM_ENGINE="shot:file=elm_test2.png" elementary_test
3916 * ELM_ENGINE="shot:delay=2.0" elementary_test
3917 * ELM_ENGINE="shot:" elementary_test
3919 * Signals that you can add callbacks for are:
3921 * @li "delete,request": the user requested to close the window. See
3922 * elm_win_autodel_set().
3923 * @li "focus,in": window got focus
3924 * @li "focus,out": window lost focus
3925 * @li "moved": window that holds the canvas was moved
3928 * @li @ref win_example_01
3933 * Defines the types of window that can be created
3935 * These are hints set on the window so that a running Window Manager knows
3936 * how the window should be handled and/or what kind of decorations it
3939 * Currently, only the X11 backed engines use them.
3941 typedef enum _Elm_Win_Type
3943 ELM_WIN_BASIC, /**< A normal window. Indicates a normal, top-level
3944 window. Almost every window will be created with this
3946 ELM_WIN_DIALOG_BASIC, /**< Used for simple dialog windows/ */
3947 ELM_WIN_DESKTOP, /**< For special desktop windows, like a background
3948 window holding desktop icons. */
3949 ELM_WIN_DOCK, /**< The window is used as a dock or panel. Usually would
3950 be kept on top of any other window by the Window
3952 ELM_WIN_TOOLBAR, /**< The window is used to hold a floating toolbar, or
3954 ELM_WIN_MENU, /**< Similar to #ELM_WIN_TOOLBAR. */
3955 ELM_WIN_UTILITY, /**< A persistent utility window, like a toolbox or
3957 ELM_WIN_SPLASH, /**< Splash window for a starting up application. */
3958 ELM_WIN_DROPDOWN_MENU, /**< The window is a dropdown menu, as when an
3959 entry in a menubar is clicked. Typically used
3960 with elm_win_override_set(). This hint exists
3961 for completion only, as the EFL way of
3962 implementing a menu would not normally use a
3963 separate window for its contents. */
3964 ELM_WIN_POPUP_MENU, /**< Like #ELM_WIN_DROPDOWN_MENU, but for the menu
3965 triggered by right-clicking an object. */
3966 ELM_WIN_TOOLTIP, /**< The window is a tooltip. A short piece of
3967 explanatory text that typically appear after the
3968 mouse cursor hovers over an object for a while.
3969 Typically used with elm_win_override_set() and also
3970 not very commonly used in the EFL. */
3971 ELM_WIN_NOTIFICATION, /**< A notification window, like a warning about
3972 battery life or a new E-Mail received. */
3973 ELM_WIN_COMBO, /**< A window holding the contents of a combo box. Not
3974 usually used in the EFL. */
3975 ELM_WIN_DND, /**< Used to indicate the window is a representation of an
3976 object being dragged across different windows, or even
3977 applications. Typically used with
3978 elm_win_override_set(). */
3979 ELM_WIN_INLINED_IMAGE, /**< The window is rendered onto an image
3980 buffer. No actual window is created for this
3981 type, instead the window and all of its
3982 contents will be rendered to an image buffer.
3983 This allows to have children window inside a
3984 parent one just like any other object would
3985 be, and do other things like applying @c
3986 Evas_Map effects to it. This is the only type
3987 of window that requires the @c parent
3988 parameter of elm_win_add() to be a valid @c
3993 * The differents layouts that can be requested for the virtual keyboard.
3995 * When the application window is being managed by Illume, it may request
3996 * any of the following layouts for the virtual keyboard.
3998 typedef enum _Elm_Win_Keyboard_Mode
4000 ELM_WIN_KEYBOARD_UNKNOWN, /**< Unknown keyboard state */
4001 ELM_WIN_KEYBOARD_OFF, /**< Request to deactivate the keyboard */
4002 ELM_WIN_KEYBOARD_ON, /**< Enable keyboard with default layout */
4003 ELM_WIN_KEYBOARD_ALPHA, /**< Alpha (a-z) keyboard layout */
4004 ELM_WIN_KEYBOARD_NUMERIC, /**< Numeric keyboard layout */
4005 ELM_WIN_KEYBOARD_PIN, /**< PIN keyboard layout */
4006 ELM_WIN_KEYBOARD_PHONE_NUMBER, /**< Phone keyboard layout */
4007 ELM_WIN_KEYBOARD_HEX, /**< Hexadecimal numeric keyboard layout */
4008 ELM_WIN_KEYBOARD_TERMINAL, /**< Full (QUERTY) keyboard layout */
4009 ELM_WIN_KEYBOARD_PASSWORD, /**< Password keyboard layout */
4010 ELM_WIN_KEYBOARD_IP, /**< IP keyboard layout */
4011 ELM_WIN_KEYBOARD_HOST, /**< Host keyboard layout */
4012 ELM_WIN_KEYBOARD_FILE, /**< File keyboard layout */
4013 ELM_WIN_KEYBOARD_URL, /**< URL keyboard layout */
4014 ELM_WIN_KEYBOARD_KEYPAD, /**< Keypad layout */
4015 ELM_WIN_KEYBOARD_J2ME /**< J2ME keyboard layout */
4016 } Elm_Win_Keyboard_Mode;
4019 * Available commands that can be sent to the Illume manager.
4021 * When running under an Illume session, a window may send commands to the
4022 * Illume manager to perform different actions.
4024 typedef enum _Elm_Illume_Command
4026 ELM_ILLUME_COMMAND_FOCUS_BACK, /**< Reverts focus to the previous
4028 ELM_ILLUME_COMMAND_FOCUS_FORWARD, /**< Sends focus to the next window\
4030 ELM_ILLUME_COMMAND_FOCUS_HOME, /**< Hides all windows to show the Home
4032 ELM_ILLUME_COMMAND_CLOSE /**< Closes the currently active window */
4033 } Elm_Illume_Command;
4036 * Adds a window object. If this is the first window created, pass NULL as
4039 * @param parent Parent object to add the window to, or NULL
4040 * @param name The name of the window
4041 * @param type The window type, one of #Elm_Win_Type.
4043 * The @p parent paramter can be @c NULL for every window @p type except
4044 * #ELM_WIN_INLINED_IMAGE, which needs a parent to retrieve the canvas on
4045 * which the image object will be created.
4047 * @return The created object, or NULL on failure
4049 EAPI Evas_Object *elm_win_add(Evas_Object *parent, const char *name, Elm_Win_Type type);
4051 * Adds a window object with standard setup
4053 * @param name The name of the window
4054 * @param title The title for the window
4056 * This creates a window like elm_win_add() but also puts in a standard
4057 * background with elm_bg_add(), as well as setting the window title to
4058 * @p title. The window type created is of type ELM_WIN_BASIC, with NULL
4059 * as the parent widget.
4061 * @return The created object, or NULL on failure
4063 * @see elm_win_add()
4065 EAPI Evas_Object *elm_win_util_standard_add(const char *name, const char *title);
4067 * Add @p subobj as a resize object of window @p obj.
4070 * Setting an object as a resize object of the window means that the
4071 * @p subobj child's size and position will be controlled by the window
4072 * directly. That is, the object will be resized to match the window size
4073 * and should never be moved or resized manually by the developer.
4075 * In addition, resize objects of the window control what the minimum size
4076 * of it will be, as well as whether it can or not be resized by the user.
4078 * For the end user to be able to resize a window by dragging the handles
4079 * or borders provided by the Window Manager, or using any other similar
4080 * mechanism, all of the resize objects in the window should have their
4081 * evas_object_size_hint_weight_set() set to EVAS_HINT_EXPAND.
4083 * Also notice that the window can get resized to the current size of the
4084 * object if the EVAS_HINT_EXPAND is set @b after the call to
4085 * elm_win_resize_object_add(). So if the object should get resized to the
4086 * size of the window, set this hint @b before adding it as a resize object
4087 * (this happens because the size of the window and the object are evaluated
4088 * as soon as the object is added to the window).
4090 * @param obj The window object
4091 * @param subobj The resize object to add
4093 EAPI void elm_win_resize_object_add(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
4095 * Delete @p subobj as a resize object of window @p obj.
4097 * This function removes the object @p subobj from the resize objects of
4098 * the window @p obj. It will not delete the object itself, which will be
4099 * left unmanaged and should be deleted by the developer, manually handled
4100 * or set as child of some other container.
4102 * @param obj The window object
4103 * @param subobj The resize object to add
4105 EAPI void elm_win_resize_object_del(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
4107 * Set the title of the window
4109 * @param obj The window object
4110 * @param title The title to set
4112 EAPI void elm_win_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
4114 * Get the title of the window
4116 * The returned string is an internal one and should not be freed or
4117 * modified. It will also be rendered invalid if a new title is set or if
4118 * the window is destroyed.
4120 * @param obj The window object
4123 EAPI const char *elm_win_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4125 * Set the window's autodel state.
4127 * When closing the window in any way outside of the program control, like
4128 * pressing the X button in the titlebar or using a command from the
4129 * Window Manager, a "delete,request" signal is emitted to indicate that
4130 * this event occurred and the developer can take any action, which may
4131 * include, or not, destroying the window object.
4133 * When the @p autodel parameter is set, the window will be automatically
4134 * destroyed when this event occurs, after the signal is emitted.
4135 * If @p autodel is @c EINA_FALSE, then the window will not be destroyed
4136 * and is up to the program to do so when it's required.
4138 * @param obj The window object
4139 * @param autodel If true, the window will automatically delete itself when
4142 EAPI void elm_win_autodel_set(Evas_Object *obj, Eina_Bool autodel) EINA_ARG_NONNULL(1);
4144 * Get the window's autodel state.
4146 * @param obj The window object
4147 * @return If the window will automatically delete itself when closed
4149 * @see elm_win_autodel_set()
4151 EAPI Eina_Bool elm_win_autodel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4153 * Activate a window object.
4155 * This function sends a request to the Window Manager to activate the
4156 * window pointed by @p obj. If honored by the WM, the window will receive
4157 * the keyboard focus.
4159 * @note This is just a request that a Window Manager may ignore, so calling
4160 * this function does not ensure in any way that the window will be the
4161 * active one after it.
4163 * @param obj The window object
4165 EAPI void elm_win_activate(Evas_Object *obj) EINA_ARG_NONNULL(1);
4167 * Lower a window object.
4169 * Places the window pointed by @p obj at the bottom of the stack, so that
4170 * no other window is covered by it.
4172 * If elm_win_override_set() is not set, the Window Manager may ignore this
4175 * @param obj The window object
4177 EAPI void elm_win_lower(Evas_Object *obj) EINA_ARG_NONNULL(1);
4179 * Raise a window object.
4181 * Places the window pointed by @p obj at the top of the stack, so that it's
4182 * not covered by any other window.
4184 * If elm_win_override_set() is not set, the Window Manager may ignore this
4187 * @param obj The window object
4189 EAPI void elm_win_raise(Evas_Object *obj) EINA_ARG_NONNULL(1);
4191 * Set the borderless state of a window.
4193 * This function requests the Window Manager to not draw any decoration
4194 * around the window.
4196 * @param obj The window object
4197 * @param borderless If true, the window is borderless
4199 EAPI void elm_win_borderless_set(Evas_Object *obj, Eina_Bool borderless) EINA_ARG_NONNULL(1);
4201 * Get the borderless state of a window.
4203 * @param obj The window object
4204 * @return If true, the window is borderless
4206 EAPI Eina_Bool elm_win_borderless_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4208 * Set the shaped state of a window.
4210 * Shaped windows, when supported, will render the parts of the window that
4211 * has no content, transparent.
4213 * If @p shaped is EINA_FALSE, then it is strongly adviced to have some
4214 * background object or cover the entire window in any other way, or the
4215 * parts of the canvas that have no data will show framebuffer artifacts.
4217 * @param obj The window object
4218 * @param shaped If true, the window is shaped
4220 * @see elm_win_alpha_set()
4222 EAPI void elm_win_shaped_set(Evas_Object *obj, Eina_Bool shaped) EINA_ARG_NONNULL(1);
4224 * Get the shaped state of a window.
4226 * @param obj The window object
4227 * @return If true, the window is shaped
4229 * @see elm_win_shaped_set()
4231 EAPI Eina_Bool elm_win_shaped_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4233 * Set the alpha channel state of a window.
4235 * If @p alpha is EINA_TRUE, the alpha channel of the canvas will be enabled
4236 * possibly making parts of the window completely or partially transparent.
4237 * This is also subject to the underlying system supporting it, like for
4238 * example, running under a compositing manager. If no compositing is
4239 * available, enabling this option will instead fallback to using shaped
4240 * windows, with elm_win_shaped_set().
4242 * @param obj The window object
4243 * @param alpha If true, the window has an alpha channel
4245 * @see elm_win_alpha_set()
4247 EAPI void elm_win_alpha_set(Evas_Object *obj, Eina_Bool alpha) EINA_ARG_NONNULL(1);
4249 * Get the transparency state of a window.
4251 * @param obj The window object
4252 * @return If true, the window is transparent
4254 * @see elm_win_transparent_set()
4256 EAPI Eina_Bool elm_win_transparent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4258 * Set the transparency state of a window.
4260 * Use elm_win_alpha_set() instead.
4262 * @param obj The window object
4263 * @param transparent If true, the window is transparent
4265 * @see elm_win_alpha_set()
4267 EAPI void elm_win_transparent_set(Evas_Object *obj, Eina_Bool transparent) EINA_ARG_NONNULL(1);
4269 * Get the alpha channel state of a window.
4271 * @param obj The window object
4272 * @return If true, the window has an alpha channel
4274 EAPI Eina_Bool elm_win_alpha_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4276 * Set the override state of a window.
4278 * A window with @p override set to EINA_TRUE will not be managed by the
4279 * Window Manager. This means that no decorations of any kind will be shown
4280 * for it, moving and resizing must be handled by the application, as well
4281 * as the window visibility.
4283 * This should not be used for normal windows, and even for not so normal
4284 * ones, it should only be used when there's a good reason and with a lot
4285 * of care. Mishandling override windows may result situations that
4286 * disrupt the normal workflow of the end user.
4288 * @param obj The window object
4289 * @param override If true, the window is overridden
4291 EAPI void elm_win_override_set(Evas_Object *obj, Eina_Bool override) EINA_ARG_NONNULL(1);
4293 * Get the override state of a window.
4295 * @param obj The window object
4296 * @return If true, the window is overridden
4298 * @see elm_win_override_set()
4300 EAPI Eina_Bool elm_win_override_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4302 * Set the fullscreen state of a window.
4304 * @param obj The window object
4305 * @param fullscreen If true, the window is fullscreen
4307 EAPI void elm_win_fullscreen_set(Evas_Object *obj, Eina_Bool fullscreen) EINA_ARG_NONNULL(1);
4309 * Get the fullscreen state of a window.
4311 * @param obj The window object
4312 * @return If true, the window is fullscreen
4314 EAPI Eina_Bool elm_win_fullscreen_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4316 * Set the maximized state of a window.
4318 * @param obj The window object
4319 * @param maximized If true, the window is maximized
4321 EAPI void elm_win_maximized_set(Evas_Object *obj, Eina_Bool maximized) EINA_ARG_NONNULL(1);
4323 * Get the maximized state of a window.
4325 * @param obj The window object
4326 * @return If true, the window is maximized
4328 EAPI Eina_Bool elm_win_maximized_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4330 * Set the iconified state of a window.
4332 * @param obj The window object
4333 * @param iconified If true, the window is iconified
4335 EAPI void elm_win_iconified_set(Evas_Object *obj, Eina_Bool iconified) EINA_ARG_NONNULL(1);
4337 * Get the iconified state of a window.
4339 * @param obj The window object
4340 * @return If true, the window is iconified
4342 EAPI Eina_Bool elm_win_iconified_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4344 * Set the layer of the window.
4346 * What this means exactly will depend on the underlying engine used.
4348 * In the case of X11 backed engines, the value in @p layer has the
4349 * following meanings:
4350 * @li < 3: The window will be placed below all others.
4351 * @li > 5: The window will be placed above all others.
4352 * @li other: The window will be placed in the default layer.
4354 * @param obj The window object
4355 * @param layer The layer of the window
4357 EAPI void elm_win_layer_set(Evas_Object *obj, int layer) EINA_ARG_NONNULL(1);
4359 * Get the layer of the window.
4361 * @param obj The window object
4362 * @return The layer of the window
4364 * @see elm_win_layer_set()
4366 EAPI int elm_win_layer_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4368 * Set the rotation of the window.
4370 * Most engines only work with multiples of 90.
4372 * This function is used to set the orientation of the window @p obj to
4373 * match that of the screen. The window itself will be resized to adjust
4374 * to the new geometry of its contents. If you want to keep the window size,
4375 * see elm_win_rotation_with_resize_set().
4377 * @param obj The window object
4378 * @param rotation The rotation of the window, in degrees (0-360),
4379 * counter-clockwise.
4381 EAPI void elm_win_rotation_set(Evas_Object *obj, int rotation) EINA_ARG_NONNULL(1);
4383 * Rotates the window and resizes it.
4385 * Like elm_win_rotation_set(), but it also resizes the window's contents so
4386 * that they fit inside the current window geometry.
4388 * @param obj The window object
4389 * @param layer The rotation of the window in degrees (0-360),
4390 * counter-clockwise.
4392 EAPI void elm_win_rotation_with_resize_set(Evas_Object *obj, int rotation) EINA_ARG_NONNULL(1);
4394 * Get the rotation of the window.
4396 * @param obj The window object
4397 * @return The rotation of the window in degrees (0-360)
4399 * @see elm_win_rotation_set()
4400 * @see elm_win_rotation_with_resize_set()
4402 EAPI int elm_win_rotation_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4404 * Set the sticky state of the window.
4406 * Hints the Window Manager that the window in @p obj should be left fixed
4407 * at its position even when the virtual desktop it's on moves or changes.
4409 * @param obj The window object
4410 * @param sticky If true, the window's sticky state is enabled
4412 EAPI void elm_win_sticky_set(Evas_Object *obj, Eina_Bool sticky) EINA_ARG_NONNULL(1);
4414 * Get the sticky state of the window.
4416 * @param obj The window object
4417 * @return If true, the window's sticky state is enabled
4419 * @see elm_win_sticky_set()
4421 EAPI Eina_Bool elm_win_sticky_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4423 * Set if this window is an illume conformant window
4425 * @param obj The window object
4426 * @param conformant The conformant flag (1 = conformant, 0 = non-conformant)
4428 EAPI void elm_win_conformant_set(Evas_Object *obj, Eina_Bool conformant) EINA_ARG_NONNULL(1);
4430 * Get if this window is an illume conformant window
4432 * @param obj The window object
4433 * @return A boolean if this window is illume conformant or not
4435 EAPI Eina_Bool elm_win_conformant_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4437 * Set a window to be an illume quickpanel window
4439 * By default window objects are not quickpanel windows.
4441 * @param obj The window object
4442 * @param quickpanel The quickpanel flag (1 = quickpanel, 0 = normal window)
4444 EAPI void elm_win_quickpanel_set(Evas_Object *obj, Eina_Bool quickpanel) EINA_ARG_NONNULL(1);
4446 * Get if this window is a quickpanel or not
4448 * @param obj The window object
4449 * @return A boolean if this window is a quickpanel or not
4451 EAPI Eina_Bool elm_win_quickpanel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4453 * Set the major priority of a quickpanel window
4455 * @param obj The window object
4456 * @param priority The major priority for this quickpanel
4458 EAPI void elm_win_quickpanel_priority_major_set(Evas_Object *obj, int priority) EINA_ARG_NONNULL(1);
4460 * Get the major priority of a quickpanel window
4462 * @param obj The window object
4463 * @return The major priority of this quickpanel
4465 EAPI int elm_win_quickpanel_priority_major_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4467 * Set the minor priority of a quickpanel window
4469 * @param obj The window object
4470 * @param priority The minor priority for this quickpanel
4472 EAPI void elm_win_quickpanel_priority_minor_set(Evas_Object *obj, int priority) EINA_ARG_NONNULL(1);
4474 * Get the minor priority of a quickpanel window
4476 * @param obj The window object
4477 * @return The minor priority of this quickpanel
4479 EAPI int elm_win_quickpanel_priority_minor_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4481 * Set which zone this quickpanel should appear in
4483 * @param obj The window object
4484 * @param zone The requested zone for this quickpanel
4486 EAPI void elm_win_quickpanel_zone_set(Evas_Object *obj, int zone) EINA_ARG_NONNULL(1);
4488 * Get which zone this quickpanel should appear in
4490 * @param obj The window object
4491 * @return The requested zone for this quickpanel
4493 EAPI int elm_win_quickpanel_zone_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4495 * Set the window to be skipped by keyboard focus
4497 * This sets the window to be skipped by normal keyboard input. This means
4498 * a window manager will be asked to not focus this window as well as omit
4499 * it from things like the taskbar, pager, "alt-tab" list etc. etc.
4501 * Call this and enable it on a window BEFORE you show it for the first time,
4502 * otherwise it may have no effect.
4504 * Use this for windows that have only output information or might only be
4505 * interacted with by the mouse or fingers, and never for typing input.
4506 * Be careful that this may have side-effects like making the window
4507 * non-accessible in some cases unless the window is specially handled. Use
4510 * @param obj The window object
4511 * @param skip The skip flag state (EINA_TRUE if it is to be skipped)
4513 EAPI void elm_win_prop_focus_skip_set(Evas_Object *obj, Eina_Bool skip) EINA_ARG_NONNULL(1);
4515 * Send a command to the windowing environment
4517 * This is intended to work in touchscreen or small screen device
4518 * environments where there is a more simplistic window management policy in
4519 * place. This uses the window object indicated to select which part of the
4520 * environment to control (the part that this window lives in), and provides
4521 * a command and an optional parameter structure (use NULL for this if not
4524 * @param obj The window object that lives in the environment to control
4525 * @param command The command to send
4526 * @param params Optional parameters for the command
4528 EAPI void elm_win_illume_command_send(Evas_Object *obj, Elm_Illume_Command command, void *params) EINA_ARG_NONNULL(1);
4530 * Get the inlined image object handle
4532 * When you create a window with elm_win_add() of type ELM_WIN_INLINED_IMAGE,
4533 * then the window is in fact an evas image object inlined in the parent
4534 * canvas. You can get this object (be careful to not manipulate it as it
4535 * is under control of elementary), and use it to do things like get pixel
4536 * data, save the image to a file, etc.
4538 * @param obj The window object to get the inlined image from
4539 * @return The inlined image object, or NULL if none exists
4541 EAPI Evas_Object *elm_win_inlined_image_object_get(Evas_Object *obj);
4543 * Determine whether a window has focus
4544 * @param obj The window to query
4545 * @return EINA_TRUE if the window exists and has focus, else EINA_FALSE
4547 EAPI Eina_Bool elm_win_focus_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4549 * Get screen geometry details for the screen that a window is on
4550 * @param obj The window to query
4551 * @param x where to return the horizontal offset value. May be NULL.
4552 * @param y where to return the vertical offset value. May be NULL.
4553 * @param w where to return the width value. May be NULL.
4554 * @param h where to return the height value. May be NULL.
4556 EAPI void elm_win_screen_size_get(const Evas_Object *obj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
4558 * Set the enabled status for the focus highlight in a window
4560 * This function will enable or disable the focus highlight only for the
4561 * given window, regardless of the global setting for it
4563 * @param obj The window where to enable the highlight
4564 * @param enabled The enabled value for the highlight
4566 EAPI void elm_win_focus_highlight_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
4568 * Get the enabled value of the focus highlight for this window
4570 * @param obj The window in which to check if the focus highlight is enabled
4572 * @return EINA_TRUE if enabled, EINA_FALSE otherwise
4574 EAPI Eina_Bool elm_win_focus_highlight_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4576 * Set the style for the focus highlight on this window
4578 * Sets the style to use for theming the highlight of focused objects on
4579 * the given window. If @p style is NULL, the default will be used.
4581 * @param obj The window where to set the style
4582 * @param style The style to set
4584 EAPI void elm_win_focus_highlight_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
4586 * Get the style set for the focus highlight object
4588 * Gets the style set for this windows highilght object, or NULL if none
4591 * @param obj The window to retrieve the highlights style from
4593 * @return The style set or NULL if none was. Default is used in that case.
4595 EAPI const char *elm_win_focus_highlight_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4597 * ecore_x_icccm_hints_set -> accepts_focus (add to ecore_evas)
4598 * ecore_x_icccm_hints_set -> window_group (add to ecore_evas)
4599 * ecore_x_icccm_size_pos_hints_set -> request_pos (add to ecore_evas)
4600 * ecore_x_icccm_client_leader_set -> l (add to ecore_evas)
4601 * ecore_x_icccm_window_role_set -> role (add to ecore_evas)
4602 * ecore_x_icccm_transient_for_set -> forwin (add to ecore_evas)
4603 * ecore_x_netwm_window_type_set -> type (add to ecore_evas)
4605 * (add to ecore_x) set netwm argb icon! (add to ecore_evas)
4606 * (blank mouse, private mouse obj, defaultmouse)
4610 * Sets the keyboard mode of the window.
4612 * @param obj The window object
4613 * @param mode The mode to set, one of #Elm_Win_Keyboard_Mode
4615 EAPI void elm_win_keyboard_mode_set(Evas_Object *obj, Elm_Win_Keyboard_Mode mode) EINA_ARG_NONNULL(1);
4617 * Gets the keyboard mode of the window.
4619 * @param obj The window object
4620 * @return The mode, one of #Elm_Win_Keyboard_Mode
4622 EAPI Elm_Win_Keyboard_Mode elm_win_keyboard_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4624 * Sets whether the window is a keyboard.
4626 * @param obj The window object
4627 * @param is_keyboard If true, the window is a virtual keyboard
4629 EAPI void elm_win_keyboard_win_set(Evas_Object *obj, Eina_Bool is_keyboard) EINA_ARG_NONNULL(1);
4631 * Gets whether the window is a keyboard.
4633 * @param obj The window object
4634 * @return If the window is a virtual keyboard
4636 EAPI Eina_Bool elm_win_keyboard_win_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4639 * Get the screen position of a window.
4641 * @param obj The window object
4642 * @param x The int to store the x coordinate to
4643 * @param y The int to store the y coordinate to
4645 EAPI void elm_win_screen_position_get(const Evas_Object *obj, int *x, int *y) EINA_ARG_NONNULL(1);
4651 * @defgroup Inwin Inwin
4653 * @image html img/widget/inwin/preview-00.png
4654 * @image latex img/widget/inwin/preview-00.eps
4655 * @image html img/widget/inwin/preview-01.png
4656 * @image latex img/widget/inwin/preview-01.eps
4657 * @image html img/widget/inwin/preview-02.png
4658 * @image latex img/widget/inwin/preview-02.eps
4660 * An inwin is a window inside a window that is useful for a quick popup.
4661 * It does not hover.
4663 * It works by creating an object that will occupy the entire window, so it
4664 * must be created using an @ref Win "elm_win" as parent only. The inwin
4665 * object can be hidden or restacked below every other object if it's
4666 * needed to show what's behind it without destroying it. If this is done,
4667 * the elm_win_inwin_activate() function can be used to bring it back to
4668 * full visibility again.
4670 * There are three styles available in the default theme. These are:
4671 * @li default: The inwin is sized to take over most of the window it's
4673 * @li minimal: The size of the inwin will be the minimum necessary to show
4675 * @li minimal_vertical: Horizontally, the inwin takes as much space as
4676 * possible, but it's sized vertically the most it needs to fit its\
4679 * Some examples of Inwin can be found in the following:
4680 * @li @ref inwin_example_01
4685 * Adds an inwin to the current window
4687 * The @p obj used as parent @b MUST be an @ref Win "Elementary Window".
4688 * Never call this function with anything other than the top-most window
4689 * as its parameter, unless you are fond of undefined behavior.
4691 * After creating the object, the widget will set itself as resize object
4692 * for the window with elm_win_resize_object_add(), so when shown it will
4693 * appear to cover almost the entire window (how much of it depends on its
4694 * content and the style used). It must not be added into other container
4695 * objects and it needs not be moved or resized manually.
4697 * @param parent The parent object
4698 * @return The new object or NULL if it cannot be created
4700 EAPI Evas_Object *elm_win_inwin_add(Evas_Object *obj) EINA_ARG_NONNULL(1);
4702 * Activates an inwin object, ensuring its visibility
4704 * This function will make sure that the inwin @p obj is completely visible
4705 * by calling evas_object_show() and evas_object_raise() on it, to bring it
4706 * to the front. It also sets the keyboard focus to it, which will be passed
4709 * The object's theme will also receive the signal "elm,action,show" with
4712 * @param obj The inwin to activate
4714 EAPI void elm_win_inwin_activate(Evas_Object *obj) EINA_ARG_NONNULL(1);
4716 * Set the content of an inwin object.
4718 * Once the content object is set, a previously set one will be deleted.
4719 * If you want to keep that old content object, use the
4720 * elm_win_inwin_content_unset() function.
4722 * @param obj The inwin object
4723 * @param content The object to set as content
4725 EAPI void elm_win_inwin_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
4727 * Get the content of an inwin object.
4729 * Return the content object which is set for this widget.
4731 * The returned object is valid as long as the inwin is still alive and no
4732 * other content is set on it. Deleting the object will notify the inwin
4733 * about it and this one will be left empty.
4735 * If you need to remove an inwin's content to be reused somewhere else,
4736 * see elm_win_inwin_content_unset().
4738 * @param obj The inwin object
4739 * @return The content that is being used
4741 EAPI Evas_Object *elm_win_inwin_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4743 * Unset the content of an inwin object.
4745 * Unparent and return the content object which was set for this widget.
4747 * @param obj The inwin object
4748 * @return The content that was being used
4750 EAPI Evas_Object *elm_win_inwin_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4754 /* X specific calls - won't work on non-x engines (return 0) */
4757 * Get the Ecore_X_Window of an Evas_Object
4759 * @param obj The object
4761 * @return The Ecore_X_Window of @p obj
4765 EAPI Ecore_X_Window elm_win_xwindow_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4767 /* smart callbacks called:
4768 * "delete,request" - the user requested to delete the window
4769 * "focus,in" - window got focus
4770 * "focus,out" - window lost focus
4771 * "moved" - window that holds the canvas was moved
4777 * @image html img/widget/bg/preview-00.png
4778 * @image latex img/widget/bg/preview-00.eps
4780 * @brief Background object, used for setting a solid color, image or Edje
4781 * group as background to a window or any container object.
4783 * The bg object is used for setting a solid background to a window or
4784 * packing into any container object. It works just like an image, but has
4785 * some properties useful to a background, like setting it to tiled,
4786 * centered, scaled or stretched.
4788 * Default contents parts of the bg widget that you can use for are:
4789 * @li "overlay" - overlay of the bg
4791 * Here is some sample code using it:
4792 * @li @ref bg_01_example_page
4793 * @li @ref bg_02_example_page
4794 * @li @ref bg_03_example_page
4798 typedef enum _Elm_Bg_Option
4800 ELM_BG_OPTION_CENTER, /**< center the background */
4801 ELM_BG_OPTION_SCALE, /**< scale the background retaining aspect ratio */
4802 ELM_BG_OPTION_STRETCH, /**< stretch the background to fill */
4803 ELM_BG_OPTION_TILE /**< tile background at its original size */
4807 * Add a new background to the parent
4809 * @param parent The parent object
4810 * @return The new object or NULL if it cannot be created
4814 EAPI Evas_Object *elm_bg_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4817 * Set the file (image or edje) used for the background
4819 * @param obj The bg object
4820 * @param file The file path
4821 * @param group Optional key (group in Edje) within the file
4823 * This sets the image file used in the background object. The image (or edje)
4824 * will be stretched (retaining aspect if its an image file) to completely fill
4825 * the bg object. This may mean some parts are not visible.
4827 * @note Once the image of @p obj is set, a previously set one will be deleted,
4828 * even if @p file is NULL.
4832 EAPI void elm_bg_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1);
4835 * Get the file (image or edje) used for the background
4837 * @param obj The bg object
4838 * @param file The file path
4839 * @param group Optional key (group in Edje) within the file
4843 EAPI void elm_bg_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
4846 * Set the option used for the background image
4848 * @param obj The bg object
4849 * @param option The desired background option (TILE, SCALE)
4851 * This sets the option used for manipulating the display of the background
4852 * image. The image can be tiled or scaled.
4856 EAPI void elm_bg_option_set(Evas_Object *obj, Elm_Bg_Option option) EINA_ARG_NONNULL(1);
4859 * Get the option used for the background image
4861 * @param obj The bg object
4862 * @return The desired background option (CENTER, SCALE, STRETCH or TILE)
4866 EAPI Elm_Bg_Option elm_bg_option_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4868 * Set the option used for the background color
4870 * @param obj The bg object
4875 * This sets the color used for the background rectangle. Its range goes
4880 EAPI void elm_bg_color_set(Evas_Object *obj, int r, int g, int b) EINA_ARG_NONNULL(1);
4882 * Get the option used for the background color
4884 * @param obj The bg object
4891 EAPI void elm_bg_color_get(const Evas_Object *obj, int *r, int *g, int *b) EINA_ARG_NONNULL(1);
4894 * Set the overlay object used for the background object.
4896 * @param obj The bg object
4897 * @param overlay The overlay object
4899 * This provides a way for elm_bg to have an 'overlay' that will be on top
4900 * of the bg. Once the over object is set, a previously set one will be
4901 * deleted, even if you set the new one to NULL. If you want to keep that
4902 * old content object, use the elm_bg_overlay_unset() function.
4904 * @deprecated use elm_object_part_content_set() instead
4909 EINA_DEPRECATED EAPI void elm_bg_overlay_set(Evas_Object *obj, Evas_Object *overlay) EINA_ARG_NONNULL(1);
4912 * Get the overlay object used for the background object.
4914 * @param obj The bg object
4915 * @return The content that is being used
4917 * Return the content object which is set for this widget
4919 * @deprecated use elm_object_part_content_get() instead
4923 EINA_DEPRECATED EAPI Evas_Object *elm_bg_overlay_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4926 * Get the overlay object used for the background object.
4928 * @param obj The bg object
4929 * @return The content that was being used
4931 * Unparent and return the overlay object which was set for this widget
4933 * @deprecated use elm_object_part_content_unset() instead
4937 EINA_DEPRECATED EAPI Evas_Object *elm_bg_overlay_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4940 * Set the size of the pixmap representation of the image.
4942 * This option just makes sense if an image is going to be set in the bg.
4944 * @param obj The bg object
4945 * @param w The new width of the image pixmap representation.
4946 * @param h The new height of the image pixmap representation.
4948 * This function sets a new size for pixmap representation of the given bg
4949 * image. It allows the image to be loaded already in the specified size,
4950 * reducing the memory usage and load time when loading a big image with load
4951 * size set to a smaller size.
4953 * NOTE: this is just a hint, the real size of the pixmap may differ
4954 * depending on the type of image being loaded, being bigger than requested.
4958 EAPI void elm_bg_load_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
4959 /* smart callbacks called:
4963 * @defgroup Icon Icon
4965 * @image html img/widget/icon/preview-00.png
4966 * @image latex img/widget/icon/preview-00.eps
4968 * An object that provides standard icon images (delete, edit, arrows, etc.)
4969 * or a custom file (PNG, JPG, EDJE, etc.) used for an icon.
4971 * The icon image requested can be in the elementary theme, or in the
4972 * freedesktop.org paths. It's possible to set the order of preference from
4973 * where the image will be used.
4975 * This API is very similar to @ref Image, but with ready to use images.
4977 * Default images provided by the theme are described below.
4979 * The first list contains icons that were first intended to be used in
4980 * toolbars, but can be used in many other places too:
4996 * Now some icons that were designed to be used in menus (but again, you can
4997 * use them anywhere else):
5002 * @li menu/arrow_down
5003 * @li menu/arrow_left
5004 * @li menu/arrow_right
5013 * And here we have some media player specific icons:
5014 * @li media_player/forward
5015 * @li media_player/info
5016 * @li media_player/next
5017 * @li media_player/pause
5018 * @li media_player/play
5019 * @li media_player/prev
5020 * @li media_player/rewind
5021 * @li media_player/stop
5023 * Signals that you can add callbacks for are:
5025 * "clicked" - This is called when a user has clicked the icon
5027 * An example of usage for this API follows:
5028 * @li @ref tutorial_icon
5036 typedef enum _Elm_Icon_Type
5043 * @enum _Elm_Icon_Lookup_Order
5044 * @typedef Elm_Icon_Lookup_Order
5046 * Lookup order used by elm_icon_standard_set(). Should look for icons in the
5047 * theme, FDO paths, or both?
5051 typedef enum _Elm_Icon_Lookup_Order
5053 ELM_ICON_LOOKUP_FDO_THEME, /**< icon look up order: freedesktop, theme */
5054 ELM_ICON_LOOKUP_THEME_FDO, /**< icon look up order: theme, freedesktop */
5055 ELM_ICON_LOOKUP_FDO, /**< icon look up order: freedesktop */
5056 ELM_ICON_LOOKUP_THEME /**< icon look up order: theme */
5057 } Elm_Icon_Lookup_Order;
5060 * Add a new icon object to the parent.
5062 * @param parent The parent object
5063 * @return The new object or NULL if it cannot be created
5065 * @see elm_icon_file_set()
5069 EAPI Evas_Object *elm_icon_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5071 * Set the file that will be used as icon.
5073 * @param obj The icon object
5074 * @param file The path to file that will be used as icon image
5075 * @param group The group that the icon belongs to an edje file
5077 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
5079 * @note The icon image set by this function can be changed by
5080 * elm_icon_standard_set().
5082 * @see elm_icon_file_get()
5086 EAPI Eina_Bool elm_icon_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
5088 * Set a location in memory to be used as an icon
5090 * @param obj The icon object
5091 * @param img The binary data that will be used as an image
5092 * @param size The size of binary data @p img
5093 * @param format Optional format of @p img to pass to the image loader
5094 * @param key Optional key of @p img to pass to the image loader (eg. if @p img is an edje file)
5096 * The @p format string should be something like "png", "jpg", "tga",
5097 * "tiff", "bmp" etc. if it is provided (NULL if not). This improves
5098 * the loader performance as it tries the "correct" loader first before
5099 * trying a range of other possible loaders until one succeeds.
5101 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
5103 * @note The icon image set by this function can be changed by
5104 * elm_icon_standard_set().
5108 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);
5110 * Get the file that will be used as icon.
5112 * @param obj The icon object
5113 * @param file The path to file that will be used as the icon image
5114 * @param group The group that the icon belongs to, in edje file
5116 * @see elm_icon_file_set()
5120 EAPI void elm_icon_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
5122 * Set the file that will be used, but use a generated thumbnail.
5124 * @param obj The icon object
5125 * @param file The path to file that will be used as icon image
5126 * @param group The group that the icon belongs to an edje file
5128 * This functions like elm_icon_file_set() but requires the Ethumb library
5129 * support to be enabled successfully with elm_need_ethumb(). When set
5130 * the file indicated has a thumbnail generated and cached on disk for
5131 * future use or will directly use an existing cached thumbnail if it
5134 * @see elm_icon_file_set()
5138 EAPI void elm_icon_thumb_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
5140 * Set the icon by icon standards names.
5142 * @param obj The icon object
5143 * @param name The icon name
5145 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
5147 * For example, freedesktop.org defines standard icon names such as "home",
5148 * "network", etc. There can be different icon sets to match those icon
5149 * keys. The @p name given as parameter is one of these "keys", and will be
5150 * used to look in the freedesktop.org paths and elementary theme. One can
5151 * change the lookup order with elm_icon_order_lookup_set().
5153 * If name is not found in any of the expected locations and it is the
5154 * absolute path of an image file, this image will be used.
5156 * @note The icon image set by this function can be changed by
5157 * elm_icon_file_set().
5159 * @see elm_icon_standard_get()
5160 * @see elm_icon_file_set()
5164 EAPI Eina_Bool elm_icon_standard_set(Evas_Object *obj, const char *name) EINA_ARG_NONNULL(1);
5166 * Get the icon name set by icon standard names.
5168 * @param obj The icon object
5169 * @return The icon name
5171 * If the icon image was set using elm_icon_file_set() instead of
5172 * elm_icon_standard_set(), then this function will return @c NULL.
5174 * @see elm_icon_standard_set()
5178 EAPI const char *elm_icon_standard_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5180 * Set the smooth scaling for an icon object.
5182 * @param obj The icon object
5183 * @param smooth @c EINA_TRUE if smooth scaling should be used, @c EINA_FALSE
5184 * otherwise. Default is @c EINA_TRUE.
5186 * Set the scaling algorithm to be used when scaling the icon image. Smooth
5187 * scaling provides a better resulting image, but is slower.
5189 * The smooth scaling should be disabled when making animations that change
5190 * the icon size, since they will be faster. Animations that don't require
5191 * resizing of the icon can keep the smooth scaling enabled (even if the icon
5192 * is already scaled, since the scaled icon image will be cached).
5194 * @see elm_icon_smooth_get()
5198 EAPI void elm_icon_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
5200 * Get whether smooth scaling is enabled for an icon object.
5202 * @param obj The icon object
5203 * @return @c EINA_TRUE if smooth scaling is enabled, @c EINA_FALSE otherwise.
5205 * @see elm_icon_smooth_set()
5209 EAPI Eina_Bool elm_icon_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5211 * Disable scaling of this object.
5213 * @param obj The icon object.
5214 * @param no_scale @c EINA_TRUE if the object is not scalable, @c EINA_FALSE
5215 * otherwise. Default is @c EINA_FALSE.
5217 * This function disables scaling of the icon object through the function
5218 * elm_object_scale_set(). However, this does not affect the object
5219 * size/resize in any way. For that effect, take a look at
5220 * elm_icon_scale_set().
5222 * @see elm_icon_no_scale_get()
5223 * @see elm_icon_scale_set()
5224 * @see elm_object_scale_set()
5228 EAPI void elm_icon_no_scale_set(Evas_Object *obj, Eina_Bool no_scale) EINA_ARG_NONNULL(1);
5230 * Get whether scaling is disabled on the object.
5232 * @param obj The icon object
5233 * @return @c EINA_TRUE if scaling is disabled, @c EINA_FALSE otherwise
5235 * @see elm_icon_no_scale_set()
5239 EAPI Eina_Bool elm_icon_no_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5241 * Set if the object is (up/down) resizable.
5243 * @param obj The icon object
5244 * @param scale_up A bool to set if the object is resizable up. Default is
5246 * @param scale_down A bool to set if the object is resizable down. Default
5249 * This function limits the icon object resize ability. If @p scale_up is set to
5250 * @c EINA_FALSE, the object can't have its height or width resized to a value
5251 * higher than the original icon size. Same is valid for @p scale_down.
5253 * @see elm_icon_scale_get()
5257 EAPI void elm_icon_scale_set(Evas_Object *obj, Eina_Bool scale_up, Eina_Bool scale_down) EINA_ARG_NONNULL(1);
5259 * Get if the object is (up/down) resizable.
5261 * @param obj The icon object
5262 * @param scale_up A bool to set if the object is resizable up
5263 * @param scale_down A bool to set if the object is resizable down
5265 * @see elm_icon_scale_set()
5269 EAPI void elm_icon_scale_get(const Evas_Object *obj, Eina_Bool *scale_up, Eina_Bool *scale_down) EINA_ARG_NONNULL(1);
5271 * Get the object's image size
5273 * @param obj The icon object
5274 * @param w A pointer to store the width in
5275 * @param h A pointer to store the height in
5279 EAPI void elm_icon_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
5281 * Set if the icon fill the entire object area.
5283 * @param obj The icon object
5284 * @param fill_outside @c EINA_TRUE if the object is filled outside,
5285 * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
5287 * When the icon object is resized to a different aspect ratio from the
5288 * original icon image, the icon image will still keep its aspect. This flag
5289 * tells how the image should fill the object's area. They are: keep the
5290 * entire icon inside the limits of height and width of the object (@p
5291 * fill_outside is @c EINA_FALSE) or let the extra width or height go outside
5292 * of the object, and the icon will fill the entire object (@p fill_outside
5295 * @note Unlike @ref Image, there's no option in icon to set the aspect ratio
5296 * retain property to false. Thus, the icon image will always keep its
5297 * original aspect ratio.
5299 * @see elm_icon_fill_outside_get()
5300 * @see elm_image_fill_outside_set()
5304 EAPI void elm_icon_fill_outside_set(Evas_Object *obj, Eina_Bool fill_outside) EINA_ARG_NONNULL(1);
5306 * Get if the object is filled outside.
5308 * @param obj The icon object
5309 * @return @c EINA_TRUE if the object is filled outside, @c EINA_FALSE otherwise.
5311 * @see elm_icon_fill_outside_set()
5315 EAPI Eina_Bool elm_icon_fill_outside_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5317 * Set the prescale size for the icon.
5319 * @param obj The icon object
5320 * @param size The prescale size. This value is used for both width and
5323 * This function sets a new size for pixmap representation of the given
5324 * icon. It allows the icon to be loaded already in the specified size,
5325 * reducing the memory usage and load time when loading a big icon with load
5326 * size set to a smaller size.
5328 * It's equivalent to the elm_bg_load_size_set() function for bg.
5330 * @note this is just a hint, the real size of the pixmap may differ
5331 * depending on the type of icon being loaded, being bigger than requested.
5333 * @see elm_icon_prescale_get()
5334 * @see elm_bg_load_size_set()
5338 EAPI void elm_icon_prescale_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
5340 * Get the prescale size for the icon.
5342 * @param obj The icon object
5343 * @return The prescale size
5345 * @see elm_icon_prescale_set()
5349 EAPI int elm_icon_prescale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5351 * Gets the image object of the icon. DO NOT MODIFY THIS.
5353 * @param obj The icon object
5354 * @return The internal icon object
5358 EAPI Evas_Object *elm_icon_object_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
5360 * Sets the icon lookup order used by elm_icon_standard_set().
5362 * @param obj The icon object
5363 * @param order The icon lookup order (can be one of
5364 * ELM_ICON_LOOKUP_FDO_THEME, ELM_ICON_LOOKUP_THEME_FDO, ELM_ICON_LOOKUP_FDO
5365 * or ELM_ICON_LOOKUP_THEME)
5367 * @see elm_icon_order_lookup_get()
5368 * @see Elm_Icon_Lookup_Order
5372 EAPI void elm_icon_order_lookup_set(Evas_Object *obj, Elm_Icon_Lookup_Order order) EINA_ARG_NONNULL(1);
5374 * Gets the icon lookup order.
5376 * @param obj The icon object
5377 * @return The icon lookup order
5379 * @see elm_icon_order_lookup_set()
5380 * @see Elm_Icon_Lookup_Order
5384 EAPI Elm_Icon_Lookup_Order elm_icon_order_lookup_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5386 * Enable or disable preloading of the icon
5388 * @param obj The icon object
5389 * @param disable If EINA_TRUE, preloading will be disabled
5392 EAPI void elm_icon_preload_set(Evas_Object *obj, Eina_Bool disable) EINA_ARG_NONNULL(1);
5394 * Get if the icon supports animation or not.
5396 * @param obj The icon object
5397 * @return @c EINA_TRUE if the icon supports animation,
5398 * @c EINA_FALSE otherwise.
5400 * Return if this elm icon's image can be animated. Currently Evas only
5401 * supports gif animation. If the return value is EINA_FALSE, other
5402 * elm_icon_animated_XXX APIs won't work.
5405 EAPI Eina_Bool elm_icon_animated_available_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5407 * Set animation mode of the icon.
5409 * @param obj The icon object
5410 * @param anim @c EINA_TRUE if the object do animation job,
5411 * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
5413 * Since the default animation mode is set to EINA_FALSE,
5414 * the icon is shown without animation. Files like animated GIF files
5415 * can animate, and this is supported if you enable animated support
5417 * Set it to EINA_TRUE when the icon needs to be animated.
5420 EAPI void elm_icon_animated_set(Evas_Object *obj, Eina_Bool animated) EINA_ARG_NONNULL(1);
5422 * Get animation mode of the icon.
5424 * @param obj The icon object
5425 * @return The animation mode of the icon object
5426 * @see elm_icon_animated_set
5429 EAPI Eina_Bool elm_icon_animated_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5431 * Set animation play mode of the icon.
5433 * @param obj The icon object
5434 * @param play @c EINA_TRUE the object play animation images,
5435 * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
5437 * To play elm icon's animation, set play to EINA_TURE.
5438 * For example, you make gif player using this set/get API and click event.
5439 * This literally lets you control current play or paused state. To have
5440 * this work with animated GIF files for example, you first, before
5441 * setting the file have to use elm_icon_animated_set() to enable animation
5442 * at all on the icon.
5444 * 1. Click event occurs
5445 * 2. Check play flag using elm_icon_animaged_play_get
5446 * 3. If elm icon was playing, set play to EINA_FALSE.
5447 * Then animation will be stopped and vice versa
5450 EAPI void elm_icon_animated_play_set(Evas_Object *obj, Eina_Bool play) EINA_ARG_NONNULL(1);
5452 * Get animation play mode of the icon.
5454 * @param obj The icon object
5455 * @return The play mode of the icon object
5457 * @see elm_icon_animated_play_get
5460 EAPI Eina_Bool elm_icon_animated_play_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5467 * @defgroup Image Image
5469 * @image html img/widget/image/preview-00.png
5470 * @image latex img/widget/image/preview-00.eps
5473 * An object that allows one to load an image file to it. It can be used
5474 * anywhere like any other elementary widget.
5476 * This widget provides most of the functionality provided from @ref Bg or @ref
5477 * Icon, but with a slightly different API (use the one that fits better your
5480 * The features not provided by those two other image widgets are:
5481 * @li allowing to get the basic @c Evas_Object with elm_image_object_get();
5482 * @li change the object orientation with elm_image_orient_set();
5483 * @li and turning the image editable with elm_image_editable_set().
5485 * Signals that you can add callbacks for are:
5487 * @li @c "clicked" - This is called when a user has clicked the image
5489 * An example of usage for this API follows:
5490 * @li @ref tutorial_image
5499 * @enum _Elm_Image_Orient
5500 * @typedef Elm_Image_Orient
5502 * Possible orientation options for elm_image_orient_set().
5504 * @image html elm_image_orient_set.png
5505 * @image latex elm_image_orient_set.eps width=\textwidth
5509 typedef enum _Elm_Image_Orient
5511 ELM_IMAGE_ORIENT_NONE = 0, /**< no orientation change */
5512 ELM_IMAGE_ORIENT_0 = 0, /**< no orientation change */
5513 ELM_IMAGE_ROTATE_90 = 1, /**< rotate 90 degrees clockwise */
5514 ELM_IMAGE_ROTATE_180 = 2, /**< rotate 180 degrees clockwise */
5515 ELM_IMAGE_ROTATE_270 = 3, /**< rotate 90 degrees counter-clockwise (i.e. 270 degrees clockwise) */
5516 /*EINA_DEPRECATED*/ELM_IMAGE_ROTATE_90_CW = 1, /**< rotate 90 degrees clockwise */
5517 /*EINA_DEPRECATED*/ELM_IMAGE_ROTATE_180_CW = 2, /**< rotate 180 degrees clockwise */
5518 /*EINA_DEPRECATED*/ELM_IMAGE_ROTATE_90_CCW = 3, /**< rotate 90 degrees counter-clockwise (i.e. 270 degrees clockwise) */
5519 ELM_IMAGE_FLIP_HORIZONTAL = 4, /**< flip image horizontally */
5520 ELM_IMAGE_FLIP_VERTICAL = 5, /**< flip image vertically */
5521 ELM_IMAGE_FLIP_TRANSPOSE = 6, /**< flip the image along the y = (width - x) line (bottom-left to top-right) */
5522 ELM_IMAGE_FLIP_TRANSVERSE = 7 /**< flip the image along the y = x line (top-left to bottom-right) */
5526 * Add a new image to the parent.
5528 * @param parent The parent object
5529 * @return The new object or NULL if it cannot be created
5531 * @see elm_image_file_set()
5535 EAPI Evas_Object *elm_image_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5537 * Set the file that will be used as image.
5539 * @param obj The image object
5540 * @param file The path to file that will be used as image
5541 * @param group The group that the image belongs in edje file (if it's an
5544 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
5546 * @see elm_image_file_get()
5550 EAPI Eina_Bool elm_image_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
5552 * Get the file that will be used as image.
5554 * @param obj The image object
5555 * @param file The path to file
5556 * @param group The group that the image belongs in edje file
5558 * @see elm_image_file_set()
5562 EAPI void elm_image_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
5564 * Set the smooth effect for an image.
5566 * @param obj The image object
5567 * @param smooth @c EINA_TRUE if smooth scaling should be used, @c EINA_FALSE
5568 * otherwise. Default is @c EINA_TRUE.
5570 * Set the scaling algorithm to be used when scaling the image. Smooth
5571 * scaling provides a better resulting image, but is slower.
5573 * The smooth scaling should be disabled when making animations that change
5574 * the image size, since it will be faster. Animations that don't require
5575 * resizing of the image can keep the smooth scaling enabled (even if the
5576 * image is already scaled, since the scaled image will be cached).
5578 * @see elm_image_smooth_get()
5582 EAPI void elm_image_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
5584 * Get the smooth effect for an image.
5586 * @param obj The image object
5587 * @return @c EINA_TRUE if smooth scaling is enabled, @c EINA_FALSE otherwise.
5589 * @see elm_image_smooth_get()
5593 EAPI Eina_Bool elm_image_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5596 * Gets the current size of the image.
5598 * @param obj The image object.
5599 * @param w Pointer to store width, or NULL.
5600 * @param h Pointer to store height, or NULL.
5602 * This is the real size of the image, not the size of the object.
5604 * On error, neither w and h will be fileld with 0.
5608 EAPI void elm_image_object_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
5610 * Disable scaling of this object.
5612 * @param obj The image object.
5613 * @param no_scale @c EINA_TRUE if the object is not scalable, @c EINA_FALSE
5614 * otherwise. Default is @c EINA_FALSE.
5616 * This function disables scaling of the elm_image widget through the
5617 * function elm_object_scale_set(). However, this does not affect the widget
5618 * size/resize in any way. For that effect, take a look at
5619 * elm_image_scale_set().
5621 * @see elm_image_no_scale_get()
5622 * @see elm_image_scale_set()
5623 * @see elm_object_scale_set()
5627 EAPI void elm_image_no_scale_set(Evas_Object *obj, Eina_Bool no_scale) EINA_ARG_NONNULL(1);
5629 * Get whether scaling is disabled on the object.
5631 * @param obj The image object
5632 * @return @c EINA_TRUE if scaling is disabled, @c EINA_FALSE otherwise
5634 * @see elm_image_no_scale_set()
5638 EAPI Eina_Bool elm_image_no_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5640 * Set if the object is (up/down) resizable.
5642 * @param obj The image object
5643 * @param scale_up A bool to set if the object is resizable up. Default is
5645 * @param scale_down A bool to set if the object is resizable down. Default
5648 * This function limits the image resize ability. If @p scale_up is set to
5649 * @c EINA_FALSE, the object can't have its height or width resized to a value
5650 * higher than the original image size. Same is valid for @p scale_down.
5652 * @see elm_image_scale_get()
5656 EAPI void elm_image_scale_set(Evas_Object *obj, Eina_Bool scale_up, Eina_Bool scale_down) EINA_ARG_NONNULL(1);
5658 * Get if the object is (up/down) resizable.
5660 * @param obj The image object
5661 * @param scale_up A bool to set if the object is resizable up
5662 * @param scale_down A bool to set if the object is resizable down
5664 * @see elm_image_scale_set()
5668 EAPI void elm_image_scale_get(const Evas_Object *obj, Eina_Bool *scale_up, Eina_Bool *scale_down) EINA_ARG_NONNULL(1);
5670 * Set if the image fills the entire object area, when keeping the aspect ratio.
5672 * @param obj The image object
5673 * @param fill_outside @c EINA_TRUE if the object is filled outside,
5674 * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
5676 * When the image should keep its aspect ratio even if resized to another
5677 * aspect ratio, there are two possibilities to resize it: keep the entire
5678 * image inside the limits of height and width of the object (@p fill_outside
5679 * is @c EINA_FALSE) or let the extra width or height go outside of the object,
5680 * and the image will fill the entire object (@p fill_outside is @c EINA_TRUE).
5682 * @note This option will have no effect if
5683 * elm_image_aspect_ratio_retained_set() is set to @c EINA_FALSE.
5685 * @see elm_image_fill_outside_get()
5686 * @see elm_image_aspect_ratio_retained_set()
5690 EAPI void elm_image_fill_outside_set(Evas_Object *obj, Eina_Bool fill_outside) EINA_ARG_NONNULL(1);
5692 * Get if the object is filled outside
5694 * @param obj The image object
5695 * @return @c EINA_TRUE if the object is filled outside, @c EINA_FALSE otherwise.
5697 * @see elm_image_fill_outside_set()
5701 EAPI Eina_Bool elm_image_fill_outside_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5703 * Set the prescale size for the image
5705 * @param obj The image object
5706 * @param size The prescale size. This value is used for both width and
5709 * This function sets a new size for pixmap representation of the given
5710 * image. It allows the image to be loaded already in the specified size,
5711 * reducing the memory usage and load time when loading a big image with load
5712 * size set to a smaller size.
5714 * It's equivalent to the elm_bg_load_size_set() function for bg.
5716 * @note this is just a hint, the real size of the pixmap may differ
5717 * depending on the type of image being loaded, being bigger than requested.
5719 * @see elm_image_prescale_get()
5720 * @see elm_bg_load_size_set()
5724 EAPI void elm_image_prescale_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
5726 * Get the prescale size for the image
5728 * @param obj The image object
5729 * @return The prescale size
5731 * @see elm_image_prescale_set()
5735 EAPI int elm_image_prescale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5737 * Set the image orientation.
5739 * @param obj The image object
5740 * @param orient The image orientation @ref Elm_Image_Orient
5741 * Default is #ELM_IMAGE_ORIENT_NONE.
5743 * This function allows to rotate or flip the given image.
5745 * @see elm_image_orient_get()
5746 * @see @ref Elm_Image_Orient
5750 EAPI void elm_image_orient_set(Evas_Object *obj, Elm_Image_Orient orient) EINA_ARG_NONNULL(1);
5752 * Get the image orientation.
5754 * @param obj The image object
5755 * @return The image orientation @ref Elm_Image_Orient
5757 * @see elm_image_orient_set()
5758 * @see @ref Elm_Image_Orient
5762 EAPI Elm_Image_Orient elm_image_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5764 * Make the image 'editable'.
5766 * @param obj Image object.
5767 * @param set Turn on or off editability. Default is @c EINA_FALSE.
5769 * This means the image is a valid drag target for drag and drop, and can be
5770 * cut or pasted too.
5774 EAPI void elm_image_editable_set(Evas_Object *obj, Eina_Bool set) EINA_ARG_NONNULL(1);
5776 * Check if the image 'editable'.
5778 * @param obj Image object.
5779 * @return Editability.
5781 * A return value of EINA_TRUE means the image is a valid drag target
5782 * for drag and drop, and can be cut or pasted too.
5786 EAPI Eina_Bool elm_image_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5788 * Get the basic Evas_Image object from this object (widget).
5790 * @param obj The image object to get the inlined image from
5791 * @return The inlined image object, or NULL if none exists
5793 * This function allows one to get the underlying @c Evas_Object of type
5794 * Image from this elementary widget. It can be useful to do things like get
5795 * the pixel data, save the image to a file, etc.
5797 * @note Be careful to not manipulate it, as it is under control of
5802 EAPI Evas_Object *elm_image_object_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5804 * Set whether the original aspect ratio of the image should be kept on resize.
5806 * @param obj The image object.
5807 * @param retained @c EINA_TRUE if the image should retain the aspect,
5808 * @c EINA_FALSE otherwise.
5810 * The original aspect ratio (width / height) of the image is usually
5811 * distorted to match the object's size. Enabling this option will retain
5812 * this original aspect, and the way that the image is fit into the object's
5813 * area depends on the option set by elm_image_fill_outside_set().
5815 * @see elm_image_aspect_ratio_retained_get()
5816 * @see elm_image_fill_outside_set()
5820 EAPI void elm_image_aspect_ratio_retained_set(Evas_Object *obj, Eina_Bool retained) EINA_ARG_NONNULL(1);
5822 * Get if the object retains the original aspect ratio.
5824 * @param obj The image object.
5825 * @return @c EINA_TRUE if the object keeps the original aspect, @c EINA_FALSE
5830 EAPI Eina_Bool elm_image_aspect_ratio_retained_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5837 typedef void (*Elm_GLView_Func_Cb)(Evas_Object *obj);
5839 typedef enum _Elm_GLView_Mode
5841 ELM_GLVIEW_ALPHA = 1,
5842 ELM_GLVIEW_DEPTH = 2,
5843 ELM_GLVIEW_STENCIL = 4
5847 * Defines a policy for the glview resizing.
5849 * @note Default is ELM_GLVIEW_RESIZE_POLICY_RECREATE
5851 typedef enum _Elm_GLView_Resize_Policy
5853 ELM_GLVIEW_RESIZE_POLICY_RECREATE = 1, /**< Resize the internal surface along with the image */
5854 ELM_GLVIEW_RESIZE_POLICY_SCALE = 2 /**< Only reize the internal image and not the surface */
5855 } Elm_GLView_Resize_Policy;
5857 typedef enum _Elm_GLView_Render_Policy
5859 ELM_GLVIEW_RENDER_POLICY_ON_DEMAND = 1, /**< Render only when there is a need for redrawing */
5860 ELM_GLVIEW_RENDER_POLICY_ALWAYS = 2 /**< Render always even when it is not visible */
5861 } Elm_GLView_Render_Policy;
5866 * A simple GLView widget that allows GL rendering.
5868 * Signals that you can add callbacks for are:
5874 * Add a new glview to the parent
5876 * @param parent The parent object
5877 * @return The new object or NULL if it cannot be created
5881 EAPI Evas_Object *elm_glview_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5884 * Sets the size of the glview
5886 * @param obj The glview object
5887 * @param width width of the glview object
5888 * @param height height of the glview object
5892 EAPI void elm_glview_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
5895 * Gets the size of the glview.
5897 * @param obj The glview object
5898 * @param width width of the glview object
5899 * @param height height of the glview object
5901 * Note that this function returns the actual image size of the
5902 * glview. This means that when the scale policy is set to
5903 * ELM_GLVIEW_RESIZE_POLICY_SCALE, it'll return the non-scaled
5908 EAPI void elm_glview_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
5911 * Gets the gl api struct for gl rendering
5913 * @param obj The glview object
5914 * @return The api object or NULL if it cannot be created
5918 EAPI Evas_GL_API *elm_glview_gl_api_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5921 * Set the mode of the GLView. Supports Three simple modes.
5923 * @param obj The glview object
5924 * @param mode The mode Options OR'ed enabling Alpha, Depth, Stencil.
5925 * @return True if set properly.
5929 EAPI Eina_Bool elm_glview_mode_set(Evas_Object *obj, Elm_GLView_Mode mode) EINA_ARG_NONNULL(1);
5932 * Set the resize policy for the glview object.
5934 * @param obj The glview object.
5935 * @param policy The scaling policy.
5937 * By default, the resize policy is set to
5938 * ELM_GLVIEW_RESIZE_POLICY_RECREATE. When resize is called it
5939 * destroys the previous surface and recreates the newly specified
5940 * size. If the policy is set to ELM_GLVIEW_RESIZE_POLICY_SCALE,
5941 * however, glview only scales the image object and not the underlying
5946 EAPI Eina_Bool elm_glview_resize_policy_set(Evas_Object *obj, Elm_GLView_Resize_Policy policy) EINA_ARG_NONNULL(1);
5949 * Set the render policy for the glview object.
5951 * @param obj The glview object.
5952 * @param policy The render policy.
5954 * By default, the render policy is set to
5955 * ELM_GLVIEW_RENDER_POLICY_ON_DEMAND. This policy is set such
5956 * that during the render loop, glview is only redrawn if it needs
5957 * to be redrawn. (i.e. When it is visible) If the policy is set to
5958 * ELM_GLVIEWW_RENDER_POLICY_ALWAYS, it redraws regardless of
5959 * whether it is visible/need redrawing or not.
5963 EAPI Eina_Bool elm_glview_render_policy_set(Evas_Object *obj, Elm_GLView_Render_Policy policy) EINA_ARG_NONNULL(1);
5966 * Set the init function that runs once in the main loop.
5968 * @param obj The glview object.
5969 * @param func The init function to be registered.
5971 * The registered init function gets called once during the render loop.
5975 EAPI void elm_glview_init_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
5978 * Set the render function that runs in the main loop.
5980 * @param obj The glview object.
5981 * @param func The delete function to be registered.
5983 * The registered del function gets called when GLView object is deleted.
5987 EAPI void elm_glview_del_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
5990 * Set the resize function that gets called when resize happens.
5992 * @param obj The glview object.
5993 * @param func The resize function to be registered.
5997 EAPI void elm_glview_resize_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
6000 * Set the render function that runs in the main loop.
6002 * @param obj The glview object.
6003 * @param func The render function to be registered.
6007 EAPI void elm_glview_render_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
6010 * Notifies that there has been changes in the GLView.
6012 * @param obj The glview object.
6016 EAPI void elm_glview_changed_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
6026 * @image html img/widget/box/preview-00.png
6027 * @image latex img/widget/box/preview-00.eps width=\textwidth
6029 * @image html img/box.png
6030 * @image latex img/box.eps width=\textwidth
6032 * A box arranges objects in a linear fashion, governed by a layout function
6033 * that defines the details of this arrangement.
6035 * By default, the box will use an internal function to set the layout to
6036 * a single row, either vertical or horizontal. This layout is affected
6037 * by a number of parameters, such as the homogeneous flag set by
6038 * elm_box_homogeneous_set(), the values given by elm_box_padding_set() and
6039 * elm_box_align_set() and the hints set to each object in the box.
6041 * For this default layout, it's possible to change the orientation with
6042 * elm_box_horizontal_set(). The box will start in the vertical orientation,
6043 * placing its elements ordered from top to bottom. When horizontal is set,
6044 * the order will go from left to right. If the box is set to be
6045 * homogeneous, every object in it will be assigned the same space, that
6046 * of the largest object. Padding can be used to set some spacing between
6047 * the cell given to each object. The alignment of the box, set with
6048 * elm_box_align_set(), determines how the bounding box of all the elements
6049 * will be placed within the space given to the box widget itself.
6051 * The size hints of each object also affect how they are placed and sized
6052 * within the box. evas_object_size_hint_min_set() will give the minimum
6053 * size the object can have, and the box will use it as the basis for all
6054 * latter calculations. Elementary widgets set their own minimum size as
6055 * needed, so there's rarely any need to use it manually.
6057 * evas_object_size_hint_weight_set(), when not in homogeneous mode, is
6058 * used to tell whether the object will be allocated the minimum size it
6059 * needs or if the space given to it should be expanded. It's important
6060 * to realize that expanding the size given to the object is not the same
6061 * thing as resizing the object. It could very well end being a small
6062 * widget floating in a much larger empty space. If not set, the weight
6063 * for objects will normally be 0.0 for both axis, meaning the widget will
6064 * not be expanded. To take as much space possible, set the weight to
6065 * EVAS_HINT_EXPAND (defined to 1.0) for the desired axis to expand.
6067 * Besides how much space each object is allocated, it's possible to control
6068 * how the widget will be placed within that space using
6069 * evas_object_size_hint_align_set(). By default, this value will be 0.5
6070 * for both axis, meaning the object will be centered, but any value from
6071 * 0.0 (left or top, for the @c x and @c y axis, respectively) to 1.0
6072 * (right or bottom) can be used. The special value EVAS_HINT_FILL, which
6073 * is -1.0, means the object will be resized to fill the entire space it
6076 * In addition, customized functions to define the layout can be set, which
6077 * allow the application developer to organize the objects within the box
6078 * in any number of ways.
6080 * The special elm_box_layout_transition() function can be used
6081 * to switch from one layout to another, animating the motion of the
6082 * children of the box.
6084 * @note Objects should not be added to box objects using _add() calls.
6086 * Some examples on how to use boxes follow:
6087 * @li @ref box_example_01
6088 * @li @ref box_example_02
6093 * @typedef Elm_Box_Transition
6095 * Opaque handler containing the parameters to perform an animated
6096 * transition of the layout the box uses.
6098 * @see elm_box_transition_new()
6099 * @see elm_box_layout_set()
6100 * @see elm_box_layout_transition()
6102 typedef struct _Elm_Box_Transition Elm_Box_Transition;
6105 * Add a new box to the parent
6107 * By default, the box will be in vertical mode and non-homogeneous.
6109 * @param parent The parent object
6110 * @return The new object or NULL if it cannot be created
6112 EAPI Evas_Object *elm_box_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6114 * Set the horizontal orientation
6116 * By default, box object arranges their contents vertically from top to
6118 * By calling this function with @p horizontal as EINA_TRUE, the box will
6119 * become horizontal, arranging contents from left to right.
6121 * @note This flag is ignored if a custom layout function is set.
6123 * @param obj The box object
6124 * @param horizontal The horizontal flag (EINA_TRUE = horizontal,
6125 * EINA_FALSE = vertical)
6127 EAPI void elm_box_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
6129 * Get the horizontal orientation
6131 * @param obj The box object
6132 * @return EINA_TRUE if the box is set to horizontal mode, EINA_FALSE otherwise
6134 EAPI Eina_Bool elm_box_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6136 * Set the box to arrange its children homogeneously
6138 * If enabled, homogeneous layout makes all items the same size, according
6139 * to the size of the largest of its children.
6141 * @note This flag is ignored if a custom layout function is set.
6143 * @param obj The box object
6144 * @param homogeneous The homogeneous flag
6146 EAPI void elm_box_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
6148 * Get whether the box is using homogeneous mode or not
6150 * @param obj The box object
6151 * @return EINA_TRUE if it's homogeneous, EINA_FALSE otherwise
6153 EAPI Eina_Bool elm_box_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6155 * Add an object to the beginning of the pack list
6157 * Pack @p subobj into the box @p obj, placing it first in the list of
6158 * children objects. The actual position the object will get on screen
6159 * depends on the layout used. If no custom layout is set, it will be at
6160 * the top or left, depending if the box is vertical or horizontal,
6163 * @param obj The box object
6164 * @param subobj The object to add to the box
6166 * @see elm_box_pack_end()
6167 * @see elm_box_pack_before()
6168 * @see elm_box_pack_after()
6169 * @see elm_box_unpack()
6170 * @see elm_box_unpack_all()
6171 * @see elm_box_clear()
6173 EAPI void elm_box_pack_start(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
6175 * Add an object at the end of the pack list
6177 * Pack @p subobj into the box @p obj, placing it last in the list of
6178 * children objects. The actual position the object will get on screen
6179 * depends on the layout used. If no custom layout is set, it will be at
6180 * the bottom or right, depending if the box is vertical or horizontal,
6183 * @param obj The box object
6184 * @param subobj The object to add to the box
6186 * @see elm_box_pack_start()
6187 * @see elm_box_pack_before()
6188 * @see elm_box_pack_after()
6189 * @see elm_box_unpack()
6190 * @see elm_box_unpack_all()
6191 * @see elm_box_clear()
6193 EAPI void elm_box_pack_end(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
6195 * Adds an object to the box before the indicated object
6197 * This will add the @p subobj to the box indicated before the object
6198 * indicated with @p before. If @p before is not already in the box, results
6199 * are undefined. Before means either to the left of the indicated object or
6200 * above it depending on orientation.
6202 * @param obj The box object
6203 * @param subobj The object to add to the box
6204 * @param before The object before which to add it
6206 * @see elm_box_pack_start()
6207 * @see elm_box_pack_end()
6208 * @see elm_box_pack_after()
6209 * @see elm_box_unpack()
6210 * @see elm_box_unpack_all()
6211 * @see elm_box_clear()
6213 EAPI void elm_box_pack_before(Evas_Object *obj, Evas_Object *subobj, Evas_Object *before) EINA_ARG_NONNULL(1);
6215 * Adds an object to the box after the indicated object
6217 * This will add the @p subobj to the box indicated after the object
6218 * indicated with @p after. If @p after is not already in the box, results
6219 * are undefined. After means either to the right of the indicated object or
6220 * below it depending on orientation.
6222 * @param obj The box object
6223 * @param subobj The object to add to the box
6224 * @param after The object after which to add it
6226 * @see elm_box_pack_start()
6227 * @see elm_box_pack_end()
6228 * @see elm_box_pack_before()
6229 * @see elm_box_unpack()
6230 * @see elm_box_unpack_all()
6231 * @see elm_box_clear()
6233 EAPI void elm_box_pack_after(Evas_Object *obj, Evas_Object *subobj, Evas_Object *after) EINA_ARG_NONNULL(1);
6235 * Clear the box of all children
6237 * Remove all the elements contained by the box, deleting the respective
6240 * @param obj The box object
6242 * @see elm_box_unpack()
6243 * @see elm_box_unpack_all()
6245 EAPI void elm_box_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
6249 * Remove the object given by @p subobj from the box @p obj without
6252 * @param obj The box object
6254 * @see elm_box_unpack_all()
6255 * @see elm_box_clear()
6257 EAPI void elm_box_unpack(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
6259 * Remove all items from the box, without deleting them
6261 * Clear the box from all children, but don't delete the respective objects.
6262 * If no other references of the box children exist, the objects will never
6263 * be deleted, and thus the application will leak the memory. Make sure
6264 * when using this function that you hold a reference to all the objects
6265 * in the box @p obj.
6267 * @param obj The box object
6269 * @see elm_box_clear()
6270 * @see elm_box_unpack()
6272 EAPI void elm_box_unpack_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
6274 * Retrieve a list of the objects packed into the box
6276 * Returns a new @c Eina_List with a pointer to @c Evas_Object in its nodes.
6277 * The order of the list corresponds to the packing order the box uses.
6279 * You must free this list with eina_list_free() once you are done with it.
6281 * @param obj The box object
6283 EAPI const Eina_List *elm_box_children_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6285 * Set the space (padding) between the box's elements.
6287 * Extra space in pixels that will be added between a box child and its
6288 * neighbors after its containing cell has been calculated. This padding
6289 * is set for all elements in the box, besides any possible padding that
6290 * individual elements may have through their size hints.
6292 * @param obj The box object
6293 * @param horizontal The horizontal space between elements
6294 * @param vertical The vertical space between elements
6296 EAPI void elm_box_padding_set(Evas_Object *obj, Evas_Coord horizontal, Evas_Coord vertical) EINA_ARG_NONNULL(1);
6298 * Get the space (padding) between the box's elements.
6300 * @param obj The box object
6301 * @param horizontal The horizontal space between elements
6302 * @param vertical The vertical space between elements
6304 * @see elm_box_padding_set()
6306 EAPI void elm_box_padding_get(const Evas_Object *obj, Evas_Coord *horizontal, Evas_Coord *vertical) EINA_ARG_NONNULL(1);
6308 * Set the alignment of the whole bouding box of contents.
6310 * Sets how the bounding box containing all the elements of the box, after
6311 * their sizes and position has been calculated, will be aligned within
6312 * the space given for the whole box widget.
6314 * @param obj The box object
6315 * @param horizontal The horizontal alignment of elements
6316 * @param vertical The vertical alignment of elements
6318 EAPI void elm_box_align_set(Evas_Object *obj, double horizontal, double vertical) EINA_ARG_NONNULL(1);
6320 * Get the alignment of the whole bouding box of contents.
6322 * @param obj The box object
6323 * @param horizontal The horizontal alignment of elements
6324 * @param vertical The vertical alignment of elements
6326 * @see elm_box_align_set()
6328 EAPI void elm_box_align_get(const Evas_Object *obj, double *horizontal, double *vertical) EINA_ARG_NONNULL(1);
6331 * Force the box to recalculate its children packing.
6333 * If any children was added or removed, box will not calculate the
6334 * values immediately rather leaving it to the next main loop
6335 * iteration. While this is great as it would save lots of
6336 * recalculation, whenever you need to get the position of a just
6337 * added item you must force recalculate before doing so.
6339 * @param obj The box object.
6341 EAPI void elm_box_recalculate(Evas_Object *obj);
6344 * Set the layout defining function to be used by the box
6346 * Whenever anything changes that requires the box in @p obj to recalculate
6347 * the size and position of its elements, the function @p cb will be called
6348 * to determine what the layout of the children will be.
6350 * Once a custom function is set, everything about the children layout
6351 * is defined by it. The flags set by elm_box_horizontal_set() and
6352 * elm_box_homogeneous_set() no longer have any meaning, and the values
6353 * given by elm_box_padding_set() and elm_box_align_set() are up to this
6354 * layout function to decide if they are used and how. These last two
6355 * will be found in the @c priv parameter, of type @c Evas_Object_Box_Data,
6356 * passed to @p cb. The @c Evas_Object the function receives is not the
6357 * Elementary widget, but the internal Evas Box it uses, so none of the
6358 * functions described here can be used on it.
6360 * Any of the layout functions in @c Evas can be used here, as well as the
6361 * special elm_box_layout_transition().
6363 * The final @p data argument received by @p cb is the same @p data passed
6364 * here, and the @p free_data function will be called to free it
6365 * whenever the box is destroyed or another layout function is set.
6367 * Setting @p cb to NULL will revert back to the default layout function.
6369 * @param obj The box object
6370 * @param cb The callback function used for layout
6371 * @param data Data that will be passed to layout function
6372 * @param free_data Function called to free @p data
6374 * @see elm_box_layout_transition()
6376 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);
6378 * Special layout function that animates the transition from one layout to another
6380 * Normally, when switching the layout function for a box, this will be
6381 * reflected immediately on screen on the next render, but it's also
6382 * possible to do this through an animated transition.
6384 * This is done by creating an ::Elm_Box_Transition and setting the box
6385 * layout to this function.
6389 * Elm_Box_Transition *t = elm_box_transition_new(1.0,
6390 * evas_object_box_layout_vertical, // start
6391 * NULL, // data for initial layout
6392 * NULL, // free function for initial data
6393 * evas_object_box_layout_horizontal, // end
6394 * NULL, // data for final layout
6395 * NULL, // free function for final data
6396 * anim_end, // will be called when animation ends
6397 * NULL); // data for anim_end function\
6398 * elm_box_layout_set(box, elm_box_layout_transition, t,
6399 * elm_box_transition_free);
6402 * @note This function can only be used with elm_box_layout_set(). Calling
6403 * it directly will not have the expected results.
6405 * @see elm_box_transition_new
6406 * @see elm_box_transition_free
6407 * @see elm_box_layout_set
6409 EAPI void elm_box_layout_transition(Evas_Object *obj, Evas_Object_Box_Data *priv, void *data);
6411 * Create a new ::Elm_Box_Transition to animate the switch of layouts
6413 * If you want to animate the change from one layout to another, you need
6414 * to set the layout function of the box to elm_box_layout_transition(),
6415 * passing as user data to it an instance of ::Elm_Box_Transition with the
6416 * necessary information to perform this animation. The free function to
6417 * set for the layout is elm_box_transition_free().
6419 * The parameters to create an ::Elm_Box_Transition sum up to how long
6420 * will it be, in seconds, a layout function to describe the initial point,
6421 * another for the final position of the children and one function to be
6422 * called when the whole animation ends. This last function is useful to
6423 * set the definitive layout for the box, usually the same as the end
6424 * layout for the animation, but could be used to start another transition.
6426 * @param start_layout The layout function that will be used to start the animation
6427 * @param start_layout_data The data to be passed the @p start_layout function
6428 * @param start_layout_free_data Function to free @p start_layout_data
6429 * @param end_layout The layout function that will be used to end the animation
6430 * @param end_layout_free_data The data to be passed the @p end_layout function
6431 * @param end_layout_free_data Function to free @p end_layout_data
6432 * @param transition_end_cb Callback function called when animation ends
6433 * @param transition_end_data Data to be passed to @p transition_end_cb
6434 * @return An instance of ::Elm_Box_Transition
6436 * @see elm_box_transition_new
6437 * @see elm_box_layout_transition
6439 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);
6441 * Free a Elm_Box_Transition instance created with elm_box_transition_new().
6443 * This function is mostly useful as the @c free_data parameter in
6444 * elm_box_layout_set() when elm_box_layout_transition().
6446 * @param data The Elm_Box_Transition instance to be freed.
6448 * @see elm_box_transition_new
6449 * @see elm_box_layout_transition
6451 EAPI void elm_box_transition_free(void *data);
6458 * @defgroup Button Button
6460 * @image html img/widget/button/preview-00.png
6461 * @image latex img/widget/button/preview-00.eps
6462 * @image html img/widget/button/preview-01.png
6463 * @image latex img/widget/button/preview-01.eps
6464 * @image html img/widget/button/preview-02.png
6465 * @image latex img/widget/button/preview-02.eps
6467 * This is a push-button. Press it and run some function. It can contain
6468 * a simple label and icon object and it also has an autorepeat feature.
6470 * This widgets emits the following signals:
6471 * @li "clicked": the user clicked the button (press/release).
6472 * @li "repeated": the user pressed the button without releasing it.
6473 * @li "pressed": button was pressed.
6474 * @li "unpressed": button was released after being pressed.
6475 * In all three cases, the @c event parameter of the callback will be
6478 * Also, defined in the default theme, the button has the following styles
6480 * @li default: a normal button.
6481 * @li anchor: Like default, but the button fades away when the mouse is not
6482 * over it, leaving only the text or icon.
6483 * @li hoversel_vertical: Internally used by @ref Hoversel to give a
6484 * continuous look across its options.
6485 * @li hoversel_vertical_entry: Another internal for @ref Hoversel.
6487 * Default contents parts of the button widget that you can use for are:
6488 * @li "icon" - An icon of the button
6490 * Default text parts of the button widget that you can use for are:
6491 * @li "default" - Label of the button
6493 * Follow through a complete example @ref button_example_01 "here".
6497 * Add a new button to the parent's canvas
6499 * @param parent The parent object
6500 * @return The new object or NULL if it cannot be created
6502 EAPI Evas_Object *elm_button_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6504 * Set the label used in the button
6506 * The passed @p label can be NULL to clean any existing text in it and
6507 * leave the button as an icon only object.
6509 * @param obj The button object
6510 * @param label The text will be written on the button
6511 * @deprecated use elm_object_text_set() instead.
6513 EINA_DEPRECATED EAPI void elm_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
6515 * Get the label set for the button
6517 * The string returned is an internal pointer and should not be freed or
6518 * altered. It will also become invalid when the button is destroyed.
6519 * The string returned, if not NULL, is a stringshare, so if you need to
6520 * keep it around even after the button is destroyed, you can use
6521 * eina_stringshare_ref().
6523 * @param obj The button object
6524 * @return The text set to the label, or NULL if nothing is set
6525 * @deprecated use elm_object_text_set() instead.
6527 EINA_DEPRECATED EAPI const char *elm_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6529 * Set the icon used for the button
6531 * Setting a new icon will delete any other that was previously set, making
6532 * any reference to them invalid. If you need to maintain the previous
6533 * object alive, unset it first with elm_button_icon_unset().
6535 * @param obj The button object
6536 * @param icon The icon object for the button
6537 * @deprecated use elm_object_part_content_set() instead.
6539 EINA_DEPRECATED EAPI void elm_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
6541 * Get the icon used for the button
6543 * Return the icon object which is set for this widget. If the button is
6544 * destroyed or another icon is set, the returned object will be deleted
6545 * and any reference to it will be invalid.
6547 * @param obj The button object
6548 * @return The icon object that is being used
6550 * @deprecated use elm_object_part_content_get() instead
6552 EINA_DEPRECATED EAPI Evas_Object *elm_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6554 * Remove the icon set without deleting it and return the object
6556 * This function drops the reference the button holds of the icon object
6557 * and returns this last object. It is used in case you want to remove any
6558 * icon, or set another one, without deleting the actual object. The button
6559 * will be left without an icon set.
6561 * @param obj The button object
6562 * @return The icon object that was being used
6563 * @deprecated use elm_object_part_content_unset() instead.
6565 EINA_DEPRECATED EAPI Evas_Object *elm_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6567 * Turn on/off the autorepeat event generated when the button is kept pressed
6569 * When off, no autorepeat is performed and buttons emit a normal @c clicked
6570 * signal when they are clicked.
6572 * When on, keeping a button pressed will continuously emit a @c repeated
6573 * signal until the button is released. The time it takes until it starts
6574 * emitting the signal is given by
6575 * elm_button_autorepeat_initial_timeout_set(), and the time between each
6576 * new emission by elm_button_autorepeat_gap_timeout_set().
6578 * @param obj The button object
6579 * @param on A bool to turn on/off the event
6581 EAPI void elm_button_autorepeat_set(Evas_Object *obj, Eina_Bool on) EINA_ARG_NONNULL(1);
6583 * Get whether the autorepeat feature is enabled
6585 * @param obj The button object
6586 * @return EINA_TRUE if autorepeat is on, EINA_FALSE otherwise
6588 * @see elm_button_autorepeat_set()
6590 EAPI Eina_Bool elm_button_autorepeat_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6592 * Set the initial timeout before the autorepeat event is generated
6594 * Sets the timeout, in seconds, since the button is pressed until the
6595 * first @c repeated signal is emitted. If @p t is 0.0 or less, there
6596 * won't be any delay and the even will be fired the moment the button is
6599 * @param obj The button object
6600 * @param t Timeout in seconds
6602 * @see elm_button_autorepeat_set()
6603 * @see elm_button_autorepeat_gap_timeout_set()
6605 EAPI void elm_button_autorepeat_initial_timeout_set(Evas_Object *obj, double t) EINA_ARG_NONNULL(1);
6607 * Get the initial timeout before the autorepeat event is generated
6609 * @param obj The button object
6610 * @return Timeout in seconds
6612 * @see elm_button_autorepeat_initial_timeout_set()
6614 EAPI double elm_button_autorepeat_initial_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6616 * Set the interval between each generated autorepeat event
6618 * After the first @c repeated event is fired, all subsequent ones will
6619 * follow after a delay of @p t seconds for each.
6621 * @param obj The button object
6622 * @param t Interval in seconds
6624 * @see elm_button_autorepeat_initial_timeout_set()
6626 EAPI void elm_button_autorepeat_gap_timeout_set(Evas_Object *obj, double t) EINA_ARG_NONNULL(1);
6628 * Get the interval between each generated autorepeat event
6630 * @param obj The button object
6631 * @return Interval in seconds
6633 EAPI double elm_button_autorepeat_gap_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6639 * @defgroup File_Selector_Button File Selector Button
6641 * @image html img/widget/fileselector_button/preview-00.png
6642 * @image latex img/widget/fileselector_button/preview-00.eps
6643 * @image html img/widget/fileselector_button/preview-01.png
6644 * @image latex img/widget/fileselector_button/preview-01.eps
6645 * @image html img/widget/fileselector_button/preview-02.png
6646 * @image latex img/widget/fileselector_button/preview-02.eps
6648 * This is a button that, when clicked, creates an Elementary
6649 * window (or inner window) <b> with a @ref Fileselector "file
6650 * selector widget" within</b>. When a file is chosen, the (inner)
6651 * window is closed and the button emits a signal having the
6652 * selected file as it's @c event_info.
6654 * This widget encapsulates operations on its internal file
6655 * selector on its own API. There is less control over its file
6656 * selector than that one would have instatiating one directly.
6658 * The following styles are available for this button:
6661 * @li @c "hoversel_vertical"
6662 * @li @c "hoversel_vertical_entry"
6664 * Smart callbacks one can register to:
6665 * - @c "file,chosen" - the user has selected a path, whose string
6666 * pointer comes as the @c event_info data (a stringshared
6669 * Here is an example on its usage:
6670 * @li @ref fileselector_button_example
6672 * @see @ref File_Selector_Entry for a similar widget.
6677 * Add a new file selector button widget to the given parent
6678 * Elementary (container) object
6680 * @param parent The parent object
6681 * @return a new file selector button widget handle or @c NULL, on
6684 EAPI Evas_Object *elm_fileselector_button_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6687 * Set the label for a given file selector button widget
6689 * @param obj The file selector button widget
6690 * @param label The text label to be displayed on @p obj
6692 * @deprecated use elm_object_text_set() instead.
6694 EINA_DEPRECATED EAPI void elm_fileselector_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
6697 * Get the label set for a given file selector button widget
6699 * @param obj The file selector button widget
6700 * @return The button label
6702 * @deprecated use elm_object_text_set() instead.
6704 EINA_DEPRECATED EAPI const char *elm_fileselector_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6707 * Set the icon on a given file selector button widget
6709 * @param obj The file selector button widget
6710 * @param icon The icon object for the button
6712 * Once the icon object is set, a previously set one will be
6713 * deleted. If you want to keep the latter, use the
6714 * elm_fileselector_button_icon_unset() function.
6716 * @see elm_fileselector_button_icon_get()
6718 EAPI void elm_fileselector_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
6721 * Get the icon set for a given file selector button widget
6723 * @param obj The file selector button widget
6724 * @return The icon object currently set on @p obj or @c NULL, if
6727 * @see elm_fileselector_button_icon_set()
6729 EAPI Evas_Object *elm_fileselector_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6732 * Unset the icon used in a given file selector button widget
6734 * @param obj The file selector button widget
6735 * @return The icon object that was being used on @p obj or @c
6738 * Unparent and return the icon object which was set for this
6741 * @see elm_fileselector_button_icon_set()
6743 EAPI Evas_Object *elm_fileselector_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6746 * Set the title for a given file selector button widget's window
6748 * @param obj The file selector button widget
6749 * @param title The title string
6751 * This will change the window's title, when the file selector pops
6752 * out after a click on the button. Those windows have the default
6753 * (unlocalized) value of @c "Select a file" as titles.
6755 * @note It will only take any effect if the file selector
6756 * button widget is @b not under "inwin mode".
6758 * @see elm_fileselector_button_window_title_get()
6760 EAPI void elm_fileselector_button_window_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
6763 * Get the title set for a given file selector button widget's
6766 * @param obj The file selector button widget
6767 * @return Title of the file selector button's window
6769 * @see elm_fileselector_button_window_title_get() for more details
6771 EAPI const char *elm_fileselector_button_window_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6774 * Set the size of a given file selector button widget's window,
6775 * holding the file selector itself.
6777 * @param obj The file selector button widget
6778 * @param width The window's width
6779 * @param height The window's height
6781 * @note it will only take any effect if the file selector button
6782 * widget is @b not under "inwin mode". The default size for the
6783 * window (when applicable) is 400x400 pixels.
6785 * @see elm_fileselector_button_window_size_get()
6787 EAPI void elm_fileselector_button_window_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
6790 * Get the size of a given file selector button widget's window,
6791 * holding the file selector itself.
6793 * @param obj The file selector button widget
6794 * @param width Pointer into which to store the width value
6795 * @param height Pointer into which to store the height value
6797 * @note Use @c NULL pointers on the size values you're not
6798 * interested in: they'll be ignored by the function.
6800 * @see elm_fileselector_button_window_size_set(), for more details
6802 EAPI void elm_fileselector_button_window_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
6805 * Set the initial file system path for a given file selector
6808 * @param obj The file selector button widget
6809 * @param path The path string
6811 * It must be a <b>directory</b> path, which will have the contents
6812 * displayed initially in the file selector's view, when invoked
6813 * from @p obj. The default initial path is the @c "HOME"
6814 * environment variable's value.
6816 * @see elm_fileselector_button_path_get()
6818 EAPI void elm_fileselector_button_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
6821 * Get the initial file system path set for a given file selector
6824 * @param obj The file selector button widget
6825 * @return path The path string
6827 * @see elm_fileselector_button_path_set() for more details
6829 EAPI const char *elm_fileselector_button_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6832 * Enable/disable a tree view in the given file selector button
6833 * widget's internal file selector
6835 * @param obj The file selector button widget
6836 * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
6839 * This has the same effect as elm_fileselector_expandable_set(),
6840 * but now applied to a file selector button's internal file
6843 * @note There's no way to put a file selector button's internal
6844 * file selector in "grid mode", as one may do with "pure" file
6847 * @see elm_fileselector_expandable_get()
6849 EAPI void elm_fileselector_button_expandable_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6852 * Get whether tree view is enabled for the given file selector
6853 * button widget's internal file selector
6855 * @param obj The file selector button widget
6856 * @return @c EINA_TRUE if @p obj widget's internal file selector
6857 * is in tree view, @c EINA_FALSE otherwise (and or errors)
6859 * @see elm_fileselector_expandable_set() for more details
6861 EAPI Eina_Bool elm_fileselector_button_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6864 * Set whether a given file selector button widget's internal file
6865 * selector is to display folders only or the directory contents,
6868 * @param obj The file selector button widget
6869 * @param only @c EINA_TRUE to make @p obj widget's internal file
6870 * selector only display directories, @c EINA_FALSE to make files
6871 * to be displayed in it too
6873 * This has the same effect as elm_fileselector_folder_only_set(),
6874 * but now applied to a file selector button's internal file
6877 * @see elm_fileselector_folder_only_get()
6879 EAPI void elm_fileselector_button_folder_only_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6882 * Get whether a given file selector button widget's internal file
6883 * selector is displaying folders only or the directory contents,
6886 * @param obj The file selector button widget
6887 * @return @c EINA_TRUE if @p obj widget's internal file
6888 * selector is only displaying directories, @c EINA_FALSE if files
6889 * are being displayed in it too (and on errors)
6891 * @see elm_fileselector_button_folder_only_set() for more details
6893 EAPI Eina_Bool elm_fileselector_button_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6896 * Enable/disable the file name entry box where the user can type
6897 * in a name for a file, in a given file selector button widget's
6898 * internal file selector.
6900 * @param obj The file selector button widget
6901 * @param is_save @c EINA_TRUE to make @p obj widget's internal
6902 * file selector a "saving dialog", @c EINA_FALSE otherwise
6904 * This has the same effect as elm_fileselector_is_save_set(),
6905 * but now applied to a file selector button's internal file
6908 * @see elm_fileselector_is_save_get()
6910 EAPI void elm_fileselector_button_is_save_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6913 * Get whether the given file selector button widget's internal
6914 * file selector is in "saving dialog" mode
6916 * @param obj The file selector button widget
6917 * @return @c EINA_TRUE, if @p obj widget's internal file selector
6918 * is in "saving dialog" mode, @c EINA_FALSE otherwise (and on
6921 * @see elm_fileselector_button_is_save_set() for more details
6923 EAPI Eina_Bool elm_fileselector_button_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6926 * Set whether a given file selector button widget's internal file
6927 * selector will raise an Elementary "inner window", instead of a
6928 * dedicated Elementary window. By default, it won't.
6930 * @param obj The file selector button widget
6931 * @param value @c EINA_TRUE to make it use an inner window, @c
6932 * EINA_TRUE to make it use a dedicated window
6934 * @see elm_win_inwin_add() for more information on inner windows
6935 * @see elm_fileselector_button_inwin_mode_get()
6937 EAPI void elm_fileselector_button_inwin_mode_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6940 * Get whether a given file selector button widget's internal file
6941 * selector will raise an Elementary "inner window", instead of a
6942 * dedicated Elementary window.
6944 * @param obj The file selector button widget
6945 * @return @c EINA_TRUE if will use an inner window, @c EINA_TRUE
6946 * if it will use a dedicated window
6948 * @see elm_fileselector_button_inwin_mode_set() for more details
6950 EAPI Eina_Bool elm_fileselector_button_inwin_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6957 * @defgroup File_Selector_Entry File Selector Entry
6959 * @image html img/widget/fileselector_entry/preview-00.png
6960 * @image latex img/widget/fileselector_entry/preview-00.eps
6962 * This is an entry made to be filled with or display a <b>file
6963 * system path string</b>. Besides the entry itself, the widget has
6964 * a @ref File_Selector_Button "file selector button" on its side,
6965 * which will raise an internal @ref Fileselector "file selector widget",
6966 * when clicked, for path selection aided by file system
6969 * This file selector may appear in an Elementary window or in an
6970 * inner window. When a file is chosen from it, the (inner) window
6971 * is closed and the selected file's path string is exposed both as
6972 * an smart event and as the new text on the entry.
6974 * This widget encapsulates operations on its internal file
6975 * selector on its own API. There is less control over its file
6976 * selector than that one would have instatiating one directly.
6978 * Smart callbacks one can register to:
6979 * - @c "changed" - The text within the entry was changed
6980 * - @c "activated" - The entry has had editing finished and
6981 * changes are to be "committed"
6982 * - @c "press" - The entry has been clicked
6983 * - @c "longpressed" - The entry has been clicked (and held) for a
6985 * - @c "clicked" - The entry has been clicked
6986 * - @c "clicked,double" - The entry has been double clicked
6987 * - @c "focused" - The entry has received focus
6988 * - @c "unfocused" - The entry has lost focus
6989 * - @c "selection,paste" - A paste action has occurred on the
6991 * - @c "selection,copy" - A copy action has occurred on the entry
6992 * - @c "selection,cut" - A cut action has occurred on the entry
6993 * - @c "unpressed" - The file selector entry's button was released
6994 * after being pressed.
6995 * - @c "file,chosen" - The user has selected a path via the file
6996 * selector entry's internal file selector, whose string pointer
6997 * comes as the @c event_info data (a stringshared string)
6999 * Here is an example on its usage:
7000 * @li @ref fileselector_entry_example
7002 * @see @ref File_Selector_Button for a similar widget.
7007 * Add a new file selector entry widget to the given parent
7008 * Elementary (container) object
7010 * @param parent The parent object
7011 * @return a new file selector entry widget handle or @c NULL, on
7014 EAPI Evas_Object *elm_fileselector_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7017 * Set the label for a given file selector entry widget's button
7019 * @param obj The file selector entry widget
7020 * @param label The text label to be displayed on @p obj widget's
7023 * @deprecated use elm_object_text_set() instead.
7025 EINA_DEPRECATED EAPI void elm_fileselector_entry_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
7028 * Get the label set for a given file selector entry widget's button
7030 * @param obj The file selector entry widget
7031 * @return The widget button's label
7033 * @deprecated use elm_object_text_set() instead.
7035 EINA_DEPRECATED EAPI const char *elm_fileselector_entry_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7038 * Set the icon on a given file selector entry widget's button
7040 * @param obj The file selector entry widget
7041 * @param icon The icon object for the entry's button
7043 * Once the icon object is set, a previously set one will be
7044 * deleted. If you want to keep the latter, use the
7045 * elm_fileselector_entry_button_icon_unset() function.
7047 * @see elm_fileselector_entry_button_icon_get()
7049 EAPI void elm_fileselector_entry_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
7052 * Get the icon set for a given file selector entry widget's button
7054 * @param obj The file selector entry widget
7055 * @return The icon object currently set on @p obj widget's button
7056 * or @c NULL, if none is
7058 * @see elm_fileselector_entry_button_icon_set()
7060 EAPI Evas_Object *elm_fileselector_entry_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7063 * Unset the icon used in a given file selector entry widget's
7066 * @param obj The file selector entry widget
7067 * @return The icon object that was being used on @p obj widget's
7068 * button or @c NULL, on errors
7070 * Unparent and return the icon object which was set for this
7073 * @see elm_fileselector_entry_button_icon_set()
7075 EAPI Evas_Object *elm_fileselector_entry_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
7078 * Set the title for a given file selector entry widget's window
7080 * @param obj The file selector entry widget
7081 * @param title The title string
7083 * This will change the window's title, when the file selector pops
7084 * out after a click on the entry's button. Those windows have the
7085 * default (unlocalized) value of @c "Select a file" as titles.
7087 * @note It will only take any effect if the file selector
7088 * entry widget is @b not under "inwin mode".
7090 * @see elm_fileselector_entry_window_title_get()
7092 EAPI void elm_fileselector_entry_window_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
7095 * Get the title set for a given file selector entry widget's
7098 * @param obj The file selector entry widget
7099 * @return Title of the file selector entry's window
7101 * @see elm_fileselector_entry_window_title_get() for more details
7103 EAPI const char *elm_fileselector_entry_window_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7106 * Set the size of a given file selector entry widget's window,
7107 * holding the file selector itself.
7109 * @param obj The file selector entry widget
7110 * @param width The window's width
7111 * @param height The window's height
7113 * @note it will only take any effect if the file selector entry
7114 * widget is @b not under "inwin mode". The default size for the
7115 * window (when applicable) is 400x400 pixels.
7117 * @see elm_fileselector_entry_window_size_get()
7119 EAPI void elm_fileselector_entry_window_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
7122 * Get the size of a given file selector entry widget's window,
7123 * holding the file selector itself.
7125 * @param obj The file selector entry widget
7126 * @param width Pointer into which to store the width value
7127 * @param height Pointer into which to store the height value
7129 * @note Use @c NULL pointers on the size values you're not
7130 * interested in: they'll be ignored by the function.
7132 * @see elm_fileselector_entry_window_size_set(), for more details
7134 EAPI void elm_fileselector_entry_window_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
7137 * Set the initial file system path and the entry's path string for
7138 * a given file selector entry widget
7140 * @param obj The file selector entry widget
7141 * @param path The path string
7143 * It must be a <b>directory</b> path, which will have the contents
7144 * displayed initially in the file selector's view, when invoked
7145 * from @p obj. The default initial path is the @c "HOME"
7146 * environment variable's value.
7148 * @see elm_fileselector_entry_path_get()
7150 EAPI void elm_fileselector_entry_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
7153 * Get the entry's path string for a given file selector entry
7156 * @param obj The file selector entry widget
7157 * @return path The path string
7159 * @see elm_fileselector_entry_path_set() for more details
7161 EAPI const char *elm_fileselector_entry_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7164 * Enable/disable a tree view in the given file selector entry
7165 * widget's internal file selector
7167 * @param obj The file selector entry widget
7168 * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
7171 * This has the same effect as elm_fileselector_expandable_set(),
7172 * but now applied to a file selector entry's internal file
7175 * @note There's no way to put a file selector entry's internal
7176 * file selector in "grid mode", as one may do with "pure" file
7179 * @see elm_fileselector_expandable_get()
7181 EAPI void elm_fileselector_entry_expandable_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
7184 * Get whether tree view is enabled for the given file selector
7185 * entry widget's internal file selector
7187 * @param obj The file selector entry widget
7188 * @return @c EINA_TRUE if @p obj widget's internal file selector
7189 * is in tree view, @c EINA_FALSE otherwise (and or errors)
7191 * @see elm_fileselector_expandable_set() for more details
7193 EAPI Eina_Bool elm_fileselector_entry_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7196 * Set whether a given file selector entry widget's internal file
7197 * selector is to display folders only or the directory contents,
7200 * @param obj The file selector entry widget
7201 * @param only @c EINA_TRUE to make @p obj widget's internal file
7202 * selector only display directories, @c EINA_FALSE to make files
7203 * to be displayed in it too
7205 * This has the same effect as elm_fileselector_folder_only_set(),
7206 * but now applied to a file selector entry's internal file
7209 * @see elm_fileselector_folder_only_get()
7211 EAPI void elm_fileselector_entry_folder_only_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
7214 * Get whether a given file selector entry widget's internal file
7215 * selector is displaying folders only or the directory contents,
7218 * @param obj The file selector entry widget
7219 * @return @c EINA_TRUE if @p obj widget's internal file
7220 * selector is only displaying directories, @c EINA_FALSE if files
7221 * are being displayed in it too (and on errors)
7223 * @see elm_fileselector_entry_folder_only_set() for more details
7225 EAPI Eina_Bool elm_fileselector_entry_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7228 * Enable/disable the file name entry box where the user can type
7229 * in a name for a file, in a given file selector entry widget's
7230 * internal file selector.
7232 * @param obj The file selector entry widget
7233 * @param is_save @c EINA_TRUE to make @p obj widget's internal
7234 * file selector a "saving dialog", @c EINA_FALSE otherwise
7236 * This has the same effect as elm_fileselector_is_save_set(),
7237 * but now applied to a file selector entry's internal file
7240 * @see elm_fileselector_is_save_get()
7242 EAPI void elm_fileselector_entry_is_save_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
7245 * Get whether the given file selector entry widget's internal
7246 * file selector is in "saving dialog" mode
7248 * @param obj The file selector entry widget
7249 * @return @c EINA_TRUE, if @p obj widget's internal file selector
7250 * is in "saving dialog" mode, @c EINA_FALSE otherwise (and on
7253 * @see elm_fileselector_entry_is_save_set() for more details
7255 EAPI Eina_Bool elm_fileselector_entry_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7258 * Set whether a given file selector entry widget's internal file
7259 * selector will raise an Elementary "inner window", instead of a
7260 * dedicated Elementary window. By default, it won't.
7262 * @param obj The file selector entry widget
7263 * @param value @c EINA_TRUE to make it use an inner window, @c
7264 * EINA_TRUE to make it use a dedicated window
7266 * @see elm_win_inwin_add() for more information on inner windows
7267 * @see elm_fileselector_entry_inwin_mode_get()
7269 EAPI void elm_fileselector_entry_inwin_mode_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
7272 * Get whether a given file selector entry widget's internal file
7273 * selector will raise an Elementary "inner window", instead of a
7274 * dedicated Elementary window.
7276 * @param obj The file selector entry widget
7277 * @return @c EINA_TRUE if will use an inner window, @c EINA_TRUE
7278 * if it will use a dedicated window
7280 * @see elm_fileselector_entry_inwin_mode_set() for more details
7282 EAPI Eina_Bool elm_fileselector_entry_inwin_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7285 * Set the initial file system path for a given file selector entry
7288 * @param obj The file selector entry widget
7289 * @param path The path string
7291 * It must be a <b>directory</b> path, which will have the contents
7292 * displayed initially in the file selector's view, when invoked
7293 * from @p obj. The default initial path is the @c "HOME"
7294 * environment variable's value.
7296 * @see elm_fileselector_entry_path_get()
7298 EAPI void elm_fileselector_entry_selected_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
7301 * Get the parent directory's path to the latest file selection on
7302 * a given filer selector entry widget
7304 * @param obj The file selector object
7305 * @return The (full) path of the directory of the last selection
7306 * on @p obj widget, a @b stringshared string
7308 * @see elm_fileselector_entry_path_set()
7310 EAPI const char *elm_fileselector_entry_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7317 * @defgroup Scroller Scroller
7319 * A scroller holds a single object and "scrolls it around". This means that
7320 * it allows the user to use a scrollbar (or a finger) to drag the viewable
7321 * region around, allowing to move through a much larger object that is
7322 * contained in the scroller. The scroller will always have a small minimum
7323 * size by default as it won't be limited by the contents of the scroller.
7325 * Signals that you can add callbacks for are:
7326 * @li "edge,left" - the left edge of the content has been reached
7327 * @li "edge,right" - the right edge of the content has been reached
7328 * @li "edge,top" - the top edge of the content has been reached
7329 * @li "edge,bottom" - the bottom edge of the content has been reached
7330 * @li "scroll" - the content has been scrolled (moved)
7331 * @li "scroll,anim,start" - scrolling animation has started
7332 * @li "scroll,anim,stop" - scrolling animation has stopped
7333 * @li "scroll,drag,start" - dragging the contents around has started
7334 * @li "scroll,drag,stop" - dragging the contents around has stopped
7335 * @note The "scroll,anim,*" and "scroll,drag,*" signals are only emitted by
7338 * @note When Elemementary is in embedded mode the scrollbars will not be
7339 * dragable, they appear merely as indicators of how much has been scrolled.
7340 * @note When Elementary is in desktop mode the thumbscroll(a.k.a.
7341 * fingerscroll) won't work.
7343 * Default contents parts of the scroller widget that you can use for are:
7344 * @li "default" - A content of the scroller
7346 * In @ref tutorial_scroller you'll find an example of how to use most of
7351 * @brief Type that controls when scrollbars should appear.
7353 * @see elm_scroller_policy_set()
7355 typedef enum _Elm_Scroller_Policy
7357 ELM_SCROLLER_POLICY_AUTO = 0, /**< Show scrollbars as needed */
7358 ELM_SCROLLER_POLICY_ON, /**< Always show scrollbars */
7359 ELM_SCROLLER_POLICY_OFF, /**< Never show scrollbars */
7360 ELM_SCROLLER_POLICY_LAST
7361 } Elm_Scroller_Policy;
7363 * @brief Add a new scroller to the parent
7365 * @param parent The parent object
7366 * @return The new object or NULL if it cannot be created
7368 EAPI Evas_Object *elm_scroller_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7370 * @brief Set the content of the scroller widget (the object to be scrolled around).
7372 * @param obj The scroller object
7373 * @param content The new content object
7375 * Once the content object is set, a previously set one will be deleted.
7376 * If you want to keep that old content object, use the
7377 * elm_scroller_content_unset() function.
7378 * @deprecated use elm_object_content_set() instead
7380 EINA_DEPRECATED EAPI void elm_scroller_content_set(Evas_Object *obj, Evas_Object *child) EINA_ARG_NONNULL(1);
7382 * @brief Get the content of the scroller widget
7384 * @param obj The slider object
7385 * @return The content that is being used
7387 * Return the content object which is set for this widget
7389 * @see elm_scroller_content_set()
7390 * @deprecated use elm_object_content_get() instead.
7392 EINA_DEPRECATED EAPI Evas_Object *elm_scroller_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7394 * @brief Unset the content of the scroller widget
7396 * @param obj The slider object
7397 * @return The content that was being used
7399 * Unparent and return the content object which was set for this widget
7401 * @see elm_scroller_content_set()
7402 * @deprecated use elm_object_content_unset() instead.
7404 EINA_DEPRECATED EAPI Evas_Object *elm_scroller_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
7406 * @brief Set custom theme elements for the scroller
7408 * @param obj The scroller object
7409 * @param widget The widget name to use (default is "scroller")
7410 * @param base The base name to use (default is "base")
7412 EAPI void elm_scroller_custom_widget_base_theme_set(Evas_Object *obj, const char *widget, const char *base) EINA_ARG_NONNULL(1, 2, 3);
7414 * @brief Make the scroller minimum size limited to the minimum size of the content
7416 * @param obj The scroller object
7417 * @param w Enable limiting minimum size horizontally
7418 * @param h Enable limiting minimum size vertically
7420 * By default the scroller will be as small as its design allows,
7421 * irrespective of its content. This will make the scroller minimum size the
7422 * right size horizontally and/or vertically to perfectly fit its content in
7425 EAPI void elm_scroller_content_min_limit(Evas_Object *obj, Eina_Bool w, Eina_Bool h) EINA_ARG_NONNULL(1);
7427 * @brief Show a specific virtual region within the scroller content object
7429 * @param obj The scroller object
7430 * @param x X coordinate of the region
7431 * @param y Y coordinate of the region
7432 * @param w Width of the region
7433 * @param h Height of the region
7435 * This will ensure all (or part if it does not fit) of the designated
7436 * region in the virtual content object (0, 0 starting at the top-left of the
7437 * virtual content object) is shown within the scroller.
7439 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);
7441 * @brief Set the scrollbar visibility policy
7443 * @param obj The scroller object
7444 * @param policy_h Horizontal scrollbar policy
7445 * @param policy_v Vertical scrollbar policy
7447 * This sets the scrollbar visibility policy for the given scroller.
7448 * ELM_SCROLLER_POLICY_AUTO means the scrollbar is made visible if it is
7449 * needed, and otherwise kept hidden. ELM_SCROLLER_POLICY_ON turns it on all
7450 * the time, and ELM_SCROLLER_POLICY_OFF always keeps it off. This applies
7451 * respectively for the horizontal and vertical scrollbars.
7453 EAPI void elm_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
7455 * @brief Gets scrollbar visibility policy
7457 * @param obj The scroller object
7458 * @param policy_h Horizontal scrollbar policy
7459 * @param policy_v Vertical scrollbar policy
7461 * @see elm_scroller_policy_set()
7463 EAPI void elm_scroller_policy_get(const Evas_Object *obj, Elm_Scroller_Policy *policy_h, Elm_Scroller_Policy *policy_v) EINA_ARG_NONNULL(1);
7465 * @brief Get the currently visible content region
7467 * @param obj The scroller object
7468 * @param x X coordinate of the region
7469 * @param y Y coordinate of the region
7470 * @param w Width of the region
7471 * @param h Height of the region
7473 * This gets the current region in the content object that is visible through
7474 * the scroller. The region co-ordinates are returned in the @p x, @p y, @p
7475 * w, @p h values pointed to.
7477 * @note All coordinates are relative to the content.
7479 * @see elm_scroller_region_show()
7481 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);
7483 * @brief Get the size of the content object
7485 * @param obj The scroller object
7486 * @param w Width of the content object.
7487 * @param h Height of the content object.
7489 * This gets the size of the content object of the scroller.
7491 EAPI void elm_scroller_child_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
7493 * @brief Set bouncing behavior
7495 * @param obj The scroller object
7496 * @param h_bounce Allow bounce horizontally
7497 * @param v_bounce Allow bounce vertically
7499 * When scrolling, the scroller may "bounce" when reaching an edge of the
7500 * content object. This is a visual way to indicate the end has been reached.
7501 * This is enabled by default for both axis. This API will set if it is enabled
7502 * for the given axis with the boolean parameters for each axis.
7504 EAPI void elm_scroller_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
7506 * @brief Get the bounce behaviour
7508 * @param obj The Scroller object
7509 * @param h_bounce Will the scroller bounce horizontally or not
7510 * @param v_bounce Will the scroller bounce vertically or not
7512 * @see elm_scroller_bounce_set()
7514 EAPI void elm_scroller_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
7516 * @brief Set scroll page size relative to viewport size.
7518 * @param obj The scroller object
7519 * @param h_pagerel The horizontal page relative size
7520 * @param v_pagerel The vertical page relative size
7522 * The scroller is capable of limiting scrolling by the user to "pages". That
7523 * is to jump by and only show a "whole page" at a time as if the continuous
7524 * area of the scroller content is split into page sized pieces. This sets
7525 * the size of a page relative to the viewport of the scroller. 1.0 is "1
7526 * viewport" is size (horizontally or vertically). 0.0 turns it off in that
7527 * axis. This is mutually exclusive with page size
7528 * (see elm_scroller_page_size_set() for more information). Likewise 0.5
7529 * is "half a viewport". Sane usable values are normally between 0.0 and 1.0
7530 * including 1.0. If you only want 1 axis to be page "limited", use 0.0 for
7533 EAPI void elm_scroller_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel) EINA_ARG_NONNULL(1);
7535 * @brief Set scroll page size.
7537 * @param obj The scroller object
7538 * @param h_pagesize The horizontal page size
7539 * @param v_pagesize The vertical page size
7541 * This sets the page size to an absolute fixed value, with 0 turning it off
7544 * @see elm_scroller_page_relative_set()
7546 EAPI void elm_scroller_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize) EINA_ARG_NONNULL(1);
7548 * @brief Get scroll current page number.
7550 * @param obj The scroller object
7551 * @param h_pagenumber The horizontal page number
7552 * @param v_pagenumber The vertical page number
7554 * The page number starts from 0. 0 is the first page.
7555 * Current page means the page which meets the top-left of the viewport.
7556 * If there are two or more pages in the viewport, it returns the number of the page
7557 * which meets the top-left of the viewport.
7559 * @see elm_scroller_last_page_get()
7560 * @see elm_scroller_page_show()
7561 * @see elm_scroller_page_brint_in()
7563 EAPI void elm_scroller_current_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber) EINA_ARG_NONNULL(1);
7565 * @brief Get scroll last page number.
7567 * @param obj The scroller object
7568 * @param h_pagenumber The horizontal page number
7569 * @param v_pagenumber The vertical page number
7571 * The page number starts from 0. 0 is the first page.
7572 * This returns the last page number among the pages.
7574 * @see elm_scroller_current_page_get()
7575 * @see elm_scroller_page_show()
7576 * @see elm_scroller_page_brint_in()
7578 EAPI void elm_scroller_last_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber) EINA_ARG_NONNULL(1);
7580 * Show a specific virtual region within the scroller content object by page number.
7582 * @param obj The scroller object
7583 * @param h_pagenumber The horizontal page number
7584 * @param v_pagenumber The vertical page number
7586 * 0, 0 of the indicated page is located at the top-left of the viewport.
7587 * This will jump to the page directly without animation.
7592 * sc = elm_scroller_add(win);
7593 * elm_scroller_content_set(sc, content);
7594 * elm_scroller_page_relative_set(sc, 1, 0);
7595 * elm_scroller_current_page_get(sc, &h_page, &v_page);
7596 * elm_scroller_page_show(sc, h_page + 1, v_page);
7599 * @see elm_scroller_page_bring_in()
7601 EAPI void elm_scroller_page_show(Evas_Object *obj, int h_pagenumber, int v_pagenumber) EINA_ARG_NONNULL(1);
7603 * Show a specific virtual region within the scroller content object by page number.
7605 * @param obj The scroller object
7606 * @param h_pagenumber The horizontal page number
7607 * @param v_pagenumber The vertical page number
7609 * 0, 0 of the indicated page is located at the top-left of the viewport.
7610 * This will slide to the page with animation.
7615 * sc = elm_scroller_add(win);
7616 * elm_scroller_content_set(sc, content);
7617 * elm_scroller_page_relative_set(sc, 1, 0);
7618 * elm_scroller_last_page_get(sc, &h_page, &v_page);
7619 * elm_scroller_page_bring_in(sc, h_page, v_page);
7622 * @see elm_scroller_page_show()
7624 EAPI void elm_scroller_page_bring_in(Evas_Object *obj, int h_pagenumber, int v_pagenumber) EINA_ARG_NONNULL(1);
7626 * @brief Show a specific virtual region within the scroller content object.
7628 * @param obj The scroller object
7629 * @param x X coordinate of the region
7630 * @param y Y coordinate of the region
7631 * @param w Width of the region
7632 * @param h Height of the region
7634 * This will ensure all (or part if it does not fit) of the designated
7635 * region in the virtual content object (0, 0 starting at the top-left of the
7636 * virtual content object) is shown within the scroller. Unlike
7637 * elm_scroller_region_show(), this allow the scroller to "smoothly slide"
7638 * to this location (if configuration in general calls for transitions). It
7639 * may not jump immediately to the new location and make take a while and
7640 * show other content along the way.
7642 * @see elm_scroller_region_show()
7644 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);
7646 * @brief Set event propagation on a scroller
7648 * @param obj The scroller object
7649 * @param propagation If propagation is enabled or not
7651 * This enables or disabled event propagation from the scroller content to
7652 * the scroller and its parent. By default event propagation is disabled.
7654 EAPI void elm_scroller_propagate_events_set(Evas_Object *obj, Eina_Bool propagation) EINA_ARG_NONNULL(1);
7656 * @brief Get event propagation for a scroller
7658 * @param obj The scroller object
7659 * @return The propagation state
7661 * This gets the event propagation for a scroller.
7663 * @see elm_scroller_propagate_events_set()
7665 EAPI Eina_Bool elm_scroller_propagate_events_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7667 * @brief Set scrolling gravity on a scroller
7669 * @param obj The scroller object
7670 * @param x The scrolling horizontal gravity
7671 * @param y The scrolling vertical gravity
7673 * The gravity, defines how the scroller will adjust its view
7674 * when the size of the scroller contents increase.
7676 * The scroller will adjust the view to glue itself as follows.
7678 * x=0.0, for showing the left most region of the content.
7679 * x=1.0, for showing the right most region of the content.
7680 * y=0.0, for showing the bottom most region of the content.
7681 * y=1.0, for showing the top most region of the content.
7683 * Default values for x and y are 0.0
7685 EAPI void elm_scroller_gravity_set(Evas_Object *obj, double x, double y) EINA_ARG_NONNULL(1);
7687 * @brief Get scrolling gravity values for a scroller
7689 * @param obj The scroller object
7690 * @param x The scrolling horizontal gravity
7691 * @param y The scrolling vertical gravity
7693 * This gets gravity values for a scroller.
7695 * @see elm_scroller_gravity_set()
7698 EAPI void elm_scroller_gravity_get(const Evas_Object *obj, double *x, double *y) EINA_ARG_NONNULL(1);
7704 * @defgroup Label Label
7706 * @image html img/widget/label/preview-00.png
7707 * @image latex img/widget/label/preview-00.eps
7709 * @brief Widget to display text, with simple html-like markup.
7711 * The Label widget @b doesn't allow text to overflow its boundaries, if the
7712 * text doesn't fit the geometry of the label it will be ellipsized or be
7713 * cut. Elementary provides several styles for this widget:
7714 * @li default - No animation
7715 * @li marker - Centers the text in the label and make it bold by default
7716 * @li slide_long - The entire text appears from the right of the screen and
7717 * slides until it disappears in the left of the screen(reappering on the
7719 * @li slide_short - The text appears in the left of the label and slides to
7720 * the right to show the overflow. When all of the text has been shown the
7721 * position is reset.
7722 * @li slide_bounce - The text appears in the left of the label and slides to
7723 * the right to show the overflow. When all of the text has been shown the
7724 * animation reverses, moving the text to the left.
7726 * Custom themes can of course invent new markup tags and style them any way
7729 * The following signals may be emitted by the label widget:
7730 * @li "language,changed": The program's language changed.
7732 * See @ref tutorial_label for a demonstration of how to use a label widget.
7736 * @brief Add a new label to the parent
7738 * @param parent The parent object
7739 * @return The new object or NULL if it cannot be created
7741 EAPI Evas_Object *elm_label_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7743 * @brief Set the label on the label object
7745 * @param obj The label object
7746 * @param label The label will be used on the label object
7747 * @deprecated See elm_object_text_set()
7749 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 */
7751 * @brief Get the label used on the label object
7753 * @param obj The label object
7754 * @return The string inside the label
7755 * @deprecated See elm_object_text_get()
7757 EINA_DEPRECATED EAPI const char *elm_label_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1); /* deprecated, use elm_object_text_get instead */
7759 * @brief Set the wrapping behavior of the label
7761 * @param obj The label object
7762 * @param wrap To wrap text or not
7764 * By default no wrapping is done. Possible values for @p wrap are:
7765 * @li ELM_WRAP_NONE - No wrapping
7766 * @li ELM_WRAP_CHAR - wrap between characters
7767 * @li ELM_WRAP_WORD - wrap between words
7768 * @li ELM_WRAP_MIXED - Word wrap, and if that fails, char wrap
7770 EAPI void elm_label_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
7772 * @brief Get the wrapping behavior of the label
7774 * @param obj The label object
7777 * @see elm_label_line_wrap_set()
7779 EAPI Elm_Wrap_Type elm_label_line_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7781 * @brief Set wrap width of the label
7783 * @param obj The label object
7784 * @param w The wrap width in pixels at a minimum where words need to wrap
7786 * This function sets the maximum width size hint of the label.
7788 * @warning This is only relevant if the label is inside a container.
7790 EAPI void elm_label_wrap_width_set(Evas_Object *obj, Evas_Coord w) EINA_ARG_NONNULL(1);
7792 * @brief Get wrap width of the label
7794 * @param obj The label object
7795 * @return The wrap width in pixels at a minimum where words need to wrap
7797 * @see elm_label_wrap_width_set()
7799 EAPI Evas_Coord elm_label_wrap_width_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7801 * @brief Set wrap height of the label
7803 * @param obj The label object
7804 * @param h The wrap height in pixels at a minimum where words need to wrap
7806 * This function sets the maximum height size hint of the label.
7808 * @warning This is only relevant if the label is inside a container.
7810 EAPI void elm_label_wrap_height_set(Evas_Object *obj, Evas_Coord h) EINA_ARG_NONNULL(1);
7812 * @brief get wrap width of the label
7814 * @param obj The label object
7815 * @return The wrap height in pixels at a minimum where words need to wrap
7817 EAPI Evas_Coord elm_label_wrap_height_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7819 * @brief Set the font size on the label object.
7821 * @param obj The label object
7822 * @param size font size
7824 * @warning NEVER use this. It is for hyper-special cases only. use styles
7825 * instead. e.g. "default", "marker", "slide_long" etc.
7827 EAPI void elm_label_fontsize_set(Evas_Object *obj, int fontsize) EINA_ARG_NONNULL(1);
7829 * @brief Set the text color on the label object
7831 * @param obj The label object
7832 * @param r Red property background color of The label object
7833 * @param g Green property background color of The label object
7834 * @param b Blue property background color of The label object
7835 * @param a Alpha property background color of The label object
7837 * @warning NEVER use this. It is for hyper-special cases only. use styles
7838 * instead. e.g. "default", "marker", "slide_long" etc.
7840 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);
7842 * @brief Set the text align on the label object
7844 * @param obj The label object
7845 * @param align align mode ("left", "center", "right")
7847 * @warning NEVER use this. It is for hyper-special cases only. use styles
7848 * instead. e.g. "default", "marker", "slide_long" etc.
7850 EAPI void elm_label_text_align_set(Evas_Object *obj, const char *alignmode) EINA_ARG_NONNULL(1);
7852 * @brief Set background color of the label
7854 * @param obj The label object
7855 * @param r Red property background color of The label object
7856 * @param g Green property background color of The label object
7857 * @param b Blue property background color of The label object
7858 * @param a Alpha property background alpha of The label object
7860 * @warning NEVER use this. It is for hyper-special cases only. use styles
7861 * instead. e.g. "default", "marker", "slide_long" etc.
7863 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);
7865 * @brief Set the ellipsis behavior of the label
7867 * @param obj The label object
7868 * @param ellipsis To ellipsis text or not
7870 * If set to true and the text doesn't fit in the label an ellipsis("...")
7871 * will be shown at the end of the widget.
7873 * @warning This doesn't work with slide(elm_label_slide_set()) or if the
7874 * choosen wrap method was ELM_WRAP_WORD.
7876 EAPI void elm_label_ellipsis_set(Evas_Object *obj, Eina_Bool ellipsis) EINA_ARG_NONNULL(1);
7878 * @brief Set the text slide of the label
7880 * @param obj The label object
7881 * @param slide To start slide or stop
7883 * If set to true, the text of the label will slide/scroll through the length of
7886 * @warning This only works with the themes "slide_short", "slide_long" and
7889 EAPI void elm_label_slide_set(Evas_Object *obj, Eina_Bool slide) EINA_ARG_NONNULL(1);
7891 * @brief Get the text slide mode of the label
7893 * @param obj The label object
7894 * @return slide slide mode value
7896 * @see elm_label_slide_set()
7898 EAPI Eina_Bool elm_label_slide_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
7900 * @brief Set the slide duration(speed) of the label
7902 * @param obj The label object
7903 * @return The duration in seconds in moving text from slide begin position
7904 * to slide end position
7906 EAPI void elm_label_slide_duration_set(Evas_Object *obj, double duration) EINA_ARG_NONNULL(1);
7908 * @brief Get the slide duration(speed) of the label
7910 * @param obj The label object
7911 * @return The duration time in moving text from slide begin position to slide end position
7913 * @see elm_label_slide_duration_set()
7915 EAPI double elm_label_slide_duration_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
7921 * @defgroup Toggle Toggle
7923 * @image html img/widget/toggle/preview-00.png
7924 * @image latex img/widget/toggle/preview-00.eps
7926 * @brief A toggle is a slider which can be used to toggle between
7927 * two values. It has two states: on and off.
7929 * This widget is deprecated. Please use elm_check_add() instead using the
7930 * toggle style like:
7933 * obj = elm_check_add(parent);
7934 * elm_object_style_set(obj, "toggle");
7935 * elm_object_part_text_set(obj, "on", "ON");
7936 * elm_object_part_text_set(obj, "off", "OFF");
7939 * Signals that you can add callbacks for are:
7940 * @li "changed" - Whenever the toggle value has been changed. Is not called
7941 * until the toggle is released by the cursor (assuming it
7942 * has been triggered by the cursor in the first place).
7944 * Default contents parts of the toggle widget that you can use for are:
7945 * @li "icon" - An icon of the toggle
7947 * Default text parts of the toggle widget that you can use for are:
7948 * @li "elm.text" - Label of the toggle
7950 * @ref tutorial_toggle show how to use a toggle.
7954 * @brief Add a toggle to @p parent.
7956 * @param parent The parent object
7958 * @return The toggle object
7960 EINA_DEPRECATED EAPI Evas_Object *elm_toggle_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7962 * @brief Sets the label to be displayed with the toggle.
7964 * @param obj The toggle object
7965 * @param label The label to be displayed
7967 * @deprecated use elm_object_text_set() instead.
7969 EINA_DEPRECATED EAPI void elm_toggle_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
7971 * @brief Gets the label of the toggle
7973 * @param obj toggle object
7974 * @return The label of the toggle
7976 * @deprecated use elm_object_text_get() instead.
7978 EINA_DEPRECATED EAPI const char *elm_toggle_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7980 * @brief Set the icon used for the toggle
7982 * @param obj The toggle object
7983 * @param icon The icon object for the button
7985 * Once the icon object is set, a previously set one will be deleted
7986 * If you want to keep that old content object, use the
7987 * elm_toggle_icon_unset() function.
7989 * @deprecated use elm_object_part_content_set() instead.
7991 EINA_DEPRECATED EAPI void elm_toggle_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
7993 * @brief Get the icon used for the toggle
7995 * @param obj The toggle object
7996 * @return The icon object that is being used
7998 * Return the icon object which is set for this widget.
8000 * @see elm_toggle_icon_set()
8002 * @deprecated use elm_object_part_content_get() instead.
8004 EINA_DEPRECATED EAPI Evas_Object *elm_toggle_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8006 * @brief Unset the icon used for the toggle
8008 * @param obj The toggle object
8009 * @return The icon object that was being used
8011 * Unparent and return the icon object which was set for this widget.
8013 * @see elm_toggle_icon_set()
8015 * @deprecated use elm_object_part_content_unset() instead.
8017 EINA_DEPRECATED EAPI Evas_Object *elm_toggle_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
8019 * @brief Sets the labels to be associated with the on and off states of the toggle.
8021 * @param obj The toggle object
8022 * @param onlabel The label displayed when the toggle is in the "on" state
8023 * @param offlabel The label displayed when the toggle is in the "off" state
8025 * @deprecated use elm_object_part_text_set() for "on" and "off" parts
8028 EINA_DEPRECATED EAPI void elm_toggle_states_labels_set(Evas_Object *obj, const char *onlabel, const char *offlabel) EINA_ARG_NONNULL(1);
8030 * @brief Gets the labels associated with the on and off states of the
8033 * @param obj The toggle object
8034 * @param onlabel A char** to place the onlabel of @p obj into
8035 * @param offlabel A char** to place the offlabel of @p obj into
8037 * @deprecated use elm_object_part_text_get() for "on" and "off" parts
8040 EINA_DEPRECATED EAPI void elm_toggle_states_labels_get(const Evas_Object *obj, const char **onlabel, const char **offlabel) EINA_ARG_NONNULL(1);
8042 * @brief Sets the state of the toggle to @p state.
8044 * @param obj The toggle object
8045 * @param state The state of @p obj
8047 * @deprecated use elm_check_state_set() instead.
8049 EINA_DEPRECATED EAPI void elm_toggle_state_set(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
8051 * @brief Gets the state of the toggle to @p state.
8053 * @param obj The toggle object
8054 * @return The state of @p obj
8056 * @deprecated use elm_check_state_get() instead.
8058 EINA_DEPRECATED EAPI Eina_Bool elm_toggle_state_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8060 * @brief Sets the state pointer of the toggle to @p statep.
8062 * @param obj The toggle object
8063 * @param statep The state pointer of @p obj
8065 * @deprecated use elm_check_state_pointer_set() instead.
8067 EINA_DEPRECATED EAPI void elm_toggle_state_pointer_set(Evas_Object *obj, Eina_Bool *statep) EINA_ARG_NONNULL(1);
8073 * @defgroup Frame Frame
8075 * @image html img/widget/frame/preview-00.png
8076 * @image latex img/widget/frame/preview-00.eps
8078 * @brief Frame is a widget that holds some content and has a title.
8080 * The default look is a frame with a title, but Frame supports multple
8088 * @li outdent_bottom
8090 * Of all this styles only default shows the title. Frame emits no signals.
8092 * Default contents parts of the frame widget that you can use for are:
8093 * @li "default" - A content of the frame
8095 * Default text parts of the frame widget that you can use for are:
8096 * @li "elm.text" - Label of the frame
8098 * For a detailed example see the @ref tutorial_frame.
8103 * @brief Add a new frame to the parent
8105 * @param parent The parent object
8106 * @return The new object or NULL if it cannot be created
8108 EAPI Evas_Object *elm_frame_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
8110 * @brief Set the frame label
8112 * @param obj The frame object
8113 * @param label The label of this frame object
8115 * @deprecated use elm_object_text_set() instead.
8117 EINA_DEPRECATED EAPI void elm_frame_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
8119 * @brief Get the frame label
8121 * @param obj The frame object
8123 * @return The label of this frame objet or NULL if unable to get frame
8125 * @deprecated use elm_object_text_get() instead.
8127 EINA_DEPRECATED EAPI const char *elm_frame_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8129 * @brief Set the content of the frame widget
8131 * Once the content object is set, a previously set one will be deleted.
8132 * If you want to keep that old content object, use the
8133 * elm_frame_content_unset() function.
8135 * @param obj The frame object
8136 * @param content The content will be filled in this frame object
8138 * @deprecated use elm_object_content_set() instead.
8140 EINA_DEPRECATED EAPI void elm_frame_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
8142 * @brief Get the content of the frame widget
8144 * Return the content object which is set for this widget
8146 * @param obj The frame object
8147 * @return The content that is being used
8149 * @deprecated use elm_object_content_get() instead.
8151 EINA_DEPRECATED EAPI Evas_Object *elm_frame_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8153 * @brief Unset the content of the frame widget
8155 * Unparent and return the content object which was set for this widget
8157 * @param obj The frame object
8158 * @return The content that was being used
8160 * @deprecated use elm_object_content_unset() instead.
8162 EINA_DEPRECATED EAPI Evas_Object *elm_frame_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
8168 * @defgroup Table Table
8170 * A container widget to arrange other widgets in a table where items can
8171 * also span multiple columns or rows - even overlap (and then be raised or
8172 * lowered accordingly to adjust stacking if they do overlap).
8174 * For a Table widget the row/column count is not fixed.
8175 * The table widget adjusts itself when subobjects are added to it dynamically.
8177 * The followin are examples of how to use a table:
8178 * @li @ref tutorial_table_01
8179 * @li @ref tutorial_table_02
8184 * @brief Add a new table to the parent
8186 * @param parent The parent object
8187 * @return The new object or NULL if it cannot be created
8189 EAPI Evas_Object *elm_table_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
8191 * @brief Set the homogeneous layout in the table
8193 * @param obj The layout object
8194 * @param homogeneous A boolean to set if the layout is homogeneous in the
8195 * table (EINA_TRUE = homogeneous, EINA_FALSE = no homogeneous)
8197 EAPI void elm_table_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
8199 * @brief Get the current table homogeneous mode.
8201 * @param obj The table object
8202 * @return A boolean to indicating if the layout is homogeneous in the table
8203 * (EINA_TRUE = homogeneous, EINA_FALSE = no homogeneous)
8205 EAPI Eina_Bool elm_table_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8207 * @brief Set padding between cells.
8209 * @param obj The layout object.
8210 * @param horizontal set the horizontal padding.
8211 * @param vertical set the vertical padding.
8213 * Default value is 0.
8215 EAPI void elm_table_padding_set(Evas_Object *obj, Evas_Coord horizontal, Evas_Coord vertical) EINA_ARG_NONNULL(1);
8217 * @brief Get padding between cells.
8219 * @param obj The layout object.
8220 * @param horizontal set the horizontal padding.
8221 * @param vertical set the vertical padding.
8223 EAPI void elm_table_padding_get(const Evas_Object *obj, Evas_Coord *horizontal, Evas_Coord *vertical) EINA_ARG_NONNULL(1);
8225 * @brief Add a subobject on the table with the coordinates passed
8227 * @param obj The table object
8228 * @param subobj The subobject to be added to the table
8229 * @param x Row number
8230 * @param y Column number
8234 * @note All positioning inside the table is relative to rows and columns, so
8235 * a value of 0 for x and y, means the top left cell of the table, and a
8236 * value of 1 for w and h means @p subobj only takes that 1 cell.
8238 EAPI void elm_table_pack(Evas_Object *obj, Evas_Object *subobj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
8240 * @brief Remove child from table.
8242 * @param obj The table object
8243 * @param subobj The subobject
8245 EAPI void elm_table_unpack(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
8247 * @brief Faster way to remove all child objects from a table object.
8249 * @param obj The table object
8250 * @param clear If true, will delete children, else just remove from table.
8252 EAPI void elm_table_clear(Evas_Object *obj, Eina_Bool clear) EINA_ARG_NONNULL(1);
8254 * @brief Set the packing location of an existing child of the table
8256 * @param subobj The subobject to be modified in the table
8257 * @param x Row number
8258 * @param y Column number
8262 * Modifies the position of an object already in the table.
8264 * @note All positioning inside the table is relative to rows and columns, so
8265 * a value of 0 for x and y, means the top left cell of the table, and a
8266 * value of 1 for w and h means @p subobj only takes that 1 cell.
8268 EAPI void elm_table_pack_set(Evas_Object *subobj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
8270 * @brief Get the packing location of an existing child of the table
8272 * @param subobj The subobject to be modified in the table
8273 * @param x Row number
8274 * @param y Column number
8278 * @see elm_table_pack_set()
8280 EAPI void elm_table_pack_get(Evas_Object *subobj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
8285 /* TEMPORARY: DOCS WILL BE FILLED IN WITH CNP/SED */
8286 typedef struct Elm_Gen_Item Elm_Gen_Item;
8287 typedef struct _Elm_Gen_Item_Class Elm_Gen_Item_Class;
8288 typedef struct _Elm_Gen_Item_Class_Func Elm_Gen_Item_Class_Func; /**< Class functions for gen item classes. */
8289 typedef char *(*Elm_Gen_Item_Text_Get_Cb) (void *data, Evas_Object *obj, const char *part); /**< Label fetching class function for gen item classes. */
8290 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. */
8291 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. */
8292 typedef void (*Elm_Gen_Item_Del_Cb) (void *data, Evas_Object *obj); /**< Deletion class function for gen item classes. */
8293 struct _Elm_Gen_Item_Class
8295 const char *item_style;
8296 struct _Elm_Gen_Item_Class_Func
8298 Elm_Gen_Item_Text_Get_Cb text_get;
8299 Elm_Gen_Item_Content_Get_Cb content_get;
8300 Elm_Gen_Item_State_Get_Cb state_get;
8301 Elm_Gen_Item_Del_Cb del;
8304 EINA_DEPRECATED EAPI void elm_gen_clear(Evas_Object *obj);
8305 EINA_DEPRECATED EAPI void elm_gen_item_selected_set(Elm_Gen_Item *it, Eina_Bool selected);
8306 EINA_DEPRECATED EAPI Eina_Bool elm_gen_item_selected_get(const Elm_Gen_Item *it);
8307 EINA_DEPRECATED EAPI void elm_gen_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select);
8308 EINA_DEPRECATED EAPI Eina_Bool elm_gen_always_select_mode_get(const Evas_Object *obj);
8309 EINA_DEPRECATED EAPI void elm_gen_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select);
8310 EINA_DEPRECATED EAPI Eina_Bool elm_gen_no_select_mode_get(const Evas_Object *obj);
8311 EINA_DEPRECATED EAPI void elm_gen_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce);
8312 EINA_DEPRECATED EAPI void elm_gen_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce);
8313 EINA_DEPRECATED EAPI void elm_gen_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel);
8314 EINA_DEPRECATED EAPI void elm_gen_page_relative_get(const Evas_Object *obj, double *h_pagerel, double *v_pagerel);
8316 EINA_DEPRECATED EAPI void elm_gen_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize);
8317 EINA_DEPRECATED EAPI void elm_gen_current_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber);
8318 EINA_DEPRECATED EAPI void elm_gen_last_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber);
8319 EINA_DEPRECATED EAPI void elm_gen_page_show(const Evas_Object *obj, int h_pagenumber, int v_pagenumber);
8320 EINA_DEPRECATED EAPI void elm_gen_page_bring_in(const Evas_Object *obj, int h_pagenumber, int v_pagenumber);
8321 EINA_DEPRECATED EAPI Elm_Gen_Item *elm_gen_first_item_get(const Evas_Object *obj);
8322 EINA_DEPRECATED EAPI Elm_Gen_Item *elm_gen_last_item_get(const Evas_Object *obj);
8323 EINA_DEPRECATED EAPI Elm_Gen_Item *elm_gen_item_next_get(const Elm_Gen_Item *it);
8324 EINA_DEPRECATED EAPI Elm_Gen_Item *elm_gen_item_prev_get(const Elm_Gen_Item *it);
8325 EINA_DEPRECATED EAPI Evas_Object *elm_gen_item_widget_get(const Elm_Gen_Item *it);
8328 * @defgroup Gengrid Gengrid (Generic grid)
8330 * This widget aims to position objects in a grid layout while
8331 * actually creating and rendering only the visible ones, using the
8332 * same idea as the @ref Genlist "genlist": the user defines a @b
8333 * class for each item, specifying functions that will be called at
8334 * object creation, deletion, etc. When those items are selected by
8335 * the user, a callback function is issued. Users may interact with
8336 * a gengrid via the mouse (by clicking on items to select them and
8337 * clicking on the grid's viewport and swiping to pan the whole
8338 * view) or via the keyboard, navigating through item with the
8341 * @section Gengrid_Layouts Gengrid layouts
8343 * Gengrid may layout its items in one of two possible layouts:
8347 * When in "horizontal mode", items will be placed in @b columns,
8348 * from top to bottom and, when the space for a column is filled,
8349 * another one is started on the right, thus expanding the grid
8350 * horizontally, making for horizontal scrolling. When in "vertical
8351 * mode" , though, items will be placed in @b rows, from left to
8352 * right and, when the space for a row is filled, another one is
8353 * started below, thus expanding the grid vertically (and making
8354 * for vertical scrolling).
8356 * @section Gengrid_Items Gengrid items
8358 * An item in a gengrid can have 0 or more texts (they can be
8359 * regular text or textblock Evas objects - that's up to the style
8360 * to determine), 0 or more contents (which are simply objects
8361 * swallowed into the gengrid item's theming Edje object) and 0 or
8362 * more <b>boolean states</b>, which have the behavior left to the
8363 * user to define. The Edje part names for each of these properties
8364 * will be looked up, in the theme file for the gengrid, under the
8365 * Edje (string) data items named @c "texts", @c "contents" and @c
8366 * "states", respectively. For each of those properties, if more
8367 * than one part is provided, they must have names listed separated
8368 * by spaces in the data fields. For the default gengrid item
8369 * theme, we have @b one text part (@c "elm.text"), @b two content
8370 * parts (@c "elm.swalllow.icon" and @c "elm.swallow.end") and @b
8373 * A gengrid item may be at one of several styles. Elementary
8374 * provides one by default - "default", but this can be extended by
8375 * system or application custom themes/overlays/extensions (see
8376 * @ref Theme "themes" for more details).
8378 * @section Gengrid_Item_Class Gengrid item classes
8380 * In order to have the ability to add and delete items on the fly,
8381 * gengrid implements a class (callback) system where the
8382 * application provides a structure with information about that
8383 * type of item (gengrid may contain multiple different items with
8384 * different classes, states and styles). Gengrid will call the
8385 * functions in this struct (methods) when an item is "realized"
8386 * (i.e., created dynamically, while the user is scrolling the
8387 * grid). All objects will simply be deleted when no longer needed
8388 * with evas_object_del(). The #Elm_GenGrid_Item_Class structure
8389 * contains the following members:
8390 * - @c item_style - This is a constant string and simply defines
8391 * the name of the item style. It @b must be specified and the
8392 * default should be @c "default".
8393 * - @c func.text_get - This function is called when an item
8394 * object is actually created. The @c data parameter will point to
8395 * the same data passed to elm_gengrid_item_append() and related
8396 * item creation functions. The @c obj parameter is the gengrid
8397 * object itself, while the @c part one is the name string of one
8398 * of the existing text parts in the Edje group implementing the
8399 * item's theme. This function @b must return a strdup'()ed string,
8400 * as the caller will free() it when done. See
8401 * #Elm_Gengrid_Item_Text_Get_Cb.
8402 * - @c func.content_get - This function is called when an item object
8403 * is actually created. The @c data parameter will point to the
8404 * same data passed to elm_gengrid_item_append() and related item
8405 * creation functions. The @c obj parameter is the gengrid object
8406 * itself, while the @c part one is the name string of one of the
8407 * existing (content) swallow parts in the Edje group implementing the
8408 * item's theme. It must return @c NULL, when no content is desired,
8409 * or a valid object handle, otherwise. The object will be deleted
8410 * by the gengrid on its deletion or when the item is "unrealized".
8411 * See #Elm_Gengrid_Item_Content_Get_Cb.
8412 * - @c func.state_get - This function is called when an item
8413 * object is actually created. The @c data parameter will point to
8414 * the same data passed to elm_gengrid_item_append() and related
8415 * item creation functions. The @c obj parameter is the gengrid
8416 * object itself, while the @c part one is the name string of one
8417 * of the state parts in the Edje group implementing the item's
8418 * theme. Return @c EINA_FALSE for false/off or @c EINA_TRUE for
8419 * true/on. Gengrids will emit a signal to its theming Edje object
8420 * with @c "elm,state,XXX,active" and @c "elm" as "emission" and
8421 * "source" arguments, respectively, when the state is true (the
8422 * default is false), where @c XXX is the name of the (state) part.
8423 * See #Elm_Gengrid_Item_State_Get_Cb.
8424 * - @c func.del - This is called when elm_gengrid_item_del() is
8425 * called on an item or elm_gengrid_clear() is called on the
8426 * gengrid. This is intended for use when gengrid items are
8427 * deleted, so any data attached to the item (e.g. its data
8428 * parameter on creation) can be deleted. See #Elm_Gengrid_Item_Del_Cb.
8430 * @section Gengrid_Usage_Hints Usage hints
8432 * If the user wants to have multiple items selected at the same
8433 * time, elm_gengrid_multi_select_set() will permit it. If the
8434 * gengrid is single-selection only (the default), then
8435 * elm_gengrid_select_item_get() will return the selected item or
8436 * @c NULL, if none is selected. If the gengrid is under
8437 * multi-selection, then elm_gengrid_selected_items_get() will
8438 * return a list (that is only valid as long as no items are
8439 * modified (added, deleted, selected or unselected) of child items
8442 * If an item changes (internal (boolean) state, text or content
8443 * changes), then use elm_gengrid_item_update() to have gengrid
8444 * update the item with the new state. A gengrid will re-"realize"
8445 * the item, thus calling the functions in the
8446 * #Elm_Gengrid_Item_Class set for that item.
8448 * To programmatically (un)select an item, use
8449 * elm_gengrid_item_selected_set(). To get its selected state use
8450 * elm_gengrid_item_selected_get(). To make an item disabled
8451 * (unable to be selected and appear differently) use
8452 * elm_gengrid_item_disabled_set() to set this and
8453 * elm_gengrid_item_disabled_get() to get the disabled state.
8455 * Grid cells will only have their selection smart callbacks called
8456 * when firstly getting selected. Any further clicks will do
8457 * nothing, unless you enable the "always select mode", with
8458 * elm_gengrid_always_select_mode_set(), thus making every click to
8459 * issue selection callbacks. elm_gengrid_no_select_mode_set() will
8460 * turn off the ability to select items entirely in the widget and
8461 * they will neither appear selected nor call the selection smart
8464 * Remember that you can create new styles and add your own theme
8465 * augmentation per application with elm_theme_extension_add(). If
8466 * you absolutely must have a specific style that overrides any
8467 * theme the user or system sets up you can use
8468 * elm_theme_overlay_add() to add such a file.
8470 * @section Gengrid_Smart_Events Gengrid smart events
8472 * Smart events that you can add callbacks for are:
8473 * - @c "activated" - The user has double-clicked or pressed
8474 * (enter|return|spacebar) on an item. The @c event_info parameter
8475 * is the gengrid item that was activated.
8476 * - @c "clicked,double" - The user has double-clicked an item.
8477 * The @c event_info parameter is the gengrid item that was double-clicked.
8478 * - @c "longpressed" - This is called when the item is pressed for a certain
8479 * amount of time. By default it's 1 second.
8480 * - @c "selected" - The user has made an item selected. The
8481 * @c event_info parameter is the gengrid item that was selected.
8482 * - @c "unselected" - The user has made an item unselected. The
8483 * @c event_info parameter is the gengrid item that was unselected.
8484 * - @c "realized" - This is called when the item in the gengrid
8485 * has its implementing Evas object instantiated, de facto. @c
8486 * event_info is the gengrid item that was created. The object
8487 * may be deleted at any time, so it is highly advised to the
8488 * caller @b not to use the object pointer returned from
8489 * elm_gengrid_item_object_get(), because it may point to freed
8491 * - @c "unrealized" - This is called when the implementing Evas
8492 * object for this item is deleted. @c event_info is the gengrid
8493 * item that was deleted.
8494 * - @c "changed" - Called when an item is added, removed, resized
8495 * or moved and when the gengrid is resized or gets "horizontal"
8497 * - @c "scroll,anim,start" - This is called when scrolling animation has
8499 * - @c "scroll,anim,stop" - This is called when scrolling animation has
8501 * - @c "drag,start,up" - Called when the item in the gengrid has
8502 * been dragged (not scrolled) up.
8503 * - @c "drag,start,down" - Called when the item in the gengrid has
8504 * been dragged (not scrolled) down.
8505 * - @c "drag,start,left" - Called when the item in the gengrid has
8506 * been dragged (not scrolled) left.
8507 * - @c "drag,start,right" - Called when the item in the gengrid has
8508 * been dragged (not scrolled) right.
8509 * - @c "drag,stop" - Called when the item in the gengrid has
8510 * stopped being dragged.
8511 * - @c "drag" - Called when the item in the gengrid is being
8513 * - @c "scroll" - called when the content has been scrolled
8515 * - @c "scroll,drag,start" - called when dragging the content has
8517 * - @c "scroll,drag,stop" - called when dragging the content has
8519 * - @c "edge,top" - This is called when the gengrid is scrolled until
8521 * - @c "edge,bottom" - This is called when the gengrid is scrolled
8522 * until the bottom edge.
8523 * - @c "edge,left" - This is called when the gengrid is scrolled
8524 * until the left edge.
8525 * - @c "edge,right" - This is called when the gengrid is scrolled
8526 * until the right edge.
8528 * List of gengrid examples:
8529 * @li @ref gengrid_example
8533 * @addtogroup Gengrid
8537 typedef struct _Elm_Gengrid_Item_Class Elm_Gengrid_Item_Class; /**< Gengrid item class definition structs */
8538 #define Elm_Gengrid_Item_Class Elm_Gen_Item_Class
8539 typedef struct _Elm_Gengrid_Item Elm_Gengrid_Item; /**< Gengrid item handles */
8540 #define Elm_Gengrid_Item Elm_Gen_Item /**< Item of Elm_Genlist. Sub-type of Elm_Widget_Item */
8541 typedef struct _Elm_Gengrid_Item_Class_Func Elm_Gengrid_Item_Class_Func; /**< Class functions for gengrid item classes. */
8543 * Text fetching class function for Elm_Gen_Item_Class.
8544 * @param data The data passed in the item creation function
8545 * @param obj The base widget object
8546 * @param part The part name of the swallow
8547 * @return The allocated (NOT stringshared) string to set as the text
8549 typedef char *(*Elm_Gengrid_Item_Text_Get_Cb) (void *data, Evas_Object *obj, const char *part);
8551 * Content (swallowed object) fetching class function for Elm_Gen_Item_Class.
8552 * @param data The data passed in the item creation function
8553 * @param obj The base widget object
8554 * @param part The part name of the swallow
8555 * @return The content object to swallow
8557 typedef Evas_Object *(*Elm_Gengrid_Item_Content_Get_Cb) (void *data, Evas_Object *obj, const char *part);
8559 * State fetching class function for Elm_Gen_Item_Class.
8560 * @param data The data passed in the item creation function
8561 * @param obj The base widget object
8562 * @param part The part name of the swallow
8563 * @return The hell if I know
8565 typedef Eina_Bool (*Elm_Gengrid_Item_State_Get_Cb) (void *data, Evas_Object *obj, const char *part);
8567 * Deletion class function for Elm_Gen_Item_Class.
8568 * @param data The data passed in the item creation function
8569 * @param obj The base widget object
8571 typedef void (*Elm_Gengrid_Item_Del_Cb) (void *data, Evas_Object *obj);
8574 * @struct _Elm_Gengrid_Item_Class
8576 * Gengrid item class definition. See @ref Gengrid_Item_Class for
8579 struct _Elm_Gengrid_Item_Class
8581 const char *item_style;
8582 struct _Elm_Gengrid_Item_Class_Func
8584 Elm_Gengrid_Item_Text_Get_Cb text_get; /**< Text fetching class function for gengrid item classes.*/
8585 Elm_Gengrid_Item_Content_Get_Cb content_get; /**< Content fetching class function for gengrid item classes. */
8586 Elm_Gengrid_Item_State_Get_Cb state_get; /**< State fetching class function for gengrid item classes. */
8587 Elm_Gengrid_Item_Del_Cb del; /**< Deletion class function for gengrid item classes. */
8589 }; /**< #Elm_Gengrid_Item_Class member definitions */
8590 #define Elm_Gengrid_Item_Class_Func Elm_Gen_Item_Class_Func
8592 * Add a new gengrid widget to the given parent Elementary
8593 * (container) object
8595 * @param parent The parent object
8596 * @return a new gengrid widget handle or @c NULL, on errors
8598 * This function inserts a new gengrid widget on the canvas.
8600 * @see elm_gengrid_item_size_set()
8601 * @see elm_gengrid_group_item_size_set()
8602 * @see elm_gengrid_horizontal_set()
8603 * @see elm_gengrid_item_append()
8604 * @see elm_gengrid_item_del()
8605 * @see elm_gengrid_clear()
8609 EAPI Evas_Object *elm_gengrid_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
8612 * Set the size for the items of a given gengrid widget
8614 * @param obj The gengrid object.
8615 * @param w The items' width.
8616 * @param h The items' height;
8618 * A gengrid, after creation, has still no information on the size
8619 * to give to each of its cells. So, you most probably will end up
8620 * with squares one @ref Fingers "finger" wide, the default
8621 * size. Use this function to force a custom size for you items,
8622 * making them as big as you wish.
8624 * @see elm_gengrid_item_size_get()
8628 EAPI void elm_gengrid_item_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
8631 * Get the size set for the items of a given gengrid widget
8633 * @param obj The gengrid object.
8634 * @param w Pointer to a variable where to store the items' width.
8635 * @param h Pointer to a variable where to store the items' height.
8637 * @note Use @c NULL pointers on the size values you're not
8638 * interested in: they'll be ignored by the function.
8640 * @see elm_gengrid_item_size_get() for more details
8644 EAPI void elm_gengrid_item_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
8647 * Set the size for the group items of a given gengrid widget
8649 * @param obj The gengrid object.
8650 * @param w The group items' width.
8651 * @param h The group items' height;
8653 * A gengrid, after creation, has still no information on the size
8654 * to give to each of its cells. So, you most probably will end up
8655 * with squares one @ref Fingers "finger" wide, the default
8656 * size. Use this function to force a custom size for you group items,
8657 * making them as big as you wish.
8659 * @see elm_gengrid_group_item_size_get()
8663 EAPI void elm_gengrid_group_item_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
8666 * Get the size set for the group items of a given gengrid widget
8668 * @param obj The gengrid object.
8669 * @param w Pointer to a variable where to store the group items' width.
8670 * @param h Pointer to a variable where to store the group items' height.
8672 * @note Use @c NULL pointers on the size values you're not
8673 * interested in: they'll be ignored by the function.
8675 * @see elm_gengrid_group_item_size_get() for more details
8679 EAPI void elm_gengrid_group_item_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
8682 * Set the items grid's alignment within a given gengrid widget
8684 * @param obj The gengrid object.
8685 * @param align_x Alignment in the horizontal axis (0 <= align_x <= 1).
8686 * @param align_y Alignment in the vertical axis (0 <= align_y <= 1).
8688 * This sets the alignment of the whole grid of items of a gengrid
8689 * within its given viewport. By default, those values are both
8690 * 0.5, meaning that the gengrid will have its items grid placed
8691 * exactly in the middle of its viewport.
8693 * @note If given alignment values are out of the cited ranges,
8694 * they'll be changed to the nearest boundary values on the valid
8697 * @see elm_gengrid_align_get()
8701 EAPI void elm_gengrid_align_set(Evas_Object *obj, double align_x, double align_y) EINA_ARG_NONNULL(1);
8704 * Get the items grid's alignment values within a given gengrid
8707 * @param obj The gengrid object.
8708 * @param align_x Pointer to a variable where to store the
8709 * horizontal alignment.
8710 * @param align_y Pointer to a variable where to store the vertical
8713 * @note Use @c NULL pointers on the alignment values you're not
8714 * interested in: they'll be ignored by the function.
8716 * @see elm_gengrid_align_set() for more details
8720 EAPI void elm_gengrid_align_get(const Evas_Object *obj, double *align_x, double *align_y) EINA_ARG_NONNULL(1);
8723 * Set whether a given gengrid widget is or not able have items
8726 * @param obj The gengrid object
8727 * @param reorder_mode Use @c EINA_TRUE to turn reoderding on,
8728 * @c EINA_FALSE to turn it off
8730 * If a gengrid is set to allow reordering, a click held for more
8731 * than 0.5 over a given item will highlight it specially,
8732 * signalling the gengrid has entered the reordering state. From
8733 * that time on, the user will be able to, while still holding the
8734 * mouse button down, move the item freely in the gengrid's
8735 * viewport, replacing to said item to the locations it goes to.
8736 * The replacements will be animated and, whenever the user
8737 * releases the mouse button, the item being replaced gets a new
8738 * definitive place in the grid.
8740 * @see elm_gengrid_reorder_mode_get()
8744 EAPI void elm_gengrid_reorder_mode_set(Evas_Object *obj, Eina_Bool reorder_mode) EINA_ARG_NONNULL(1);
8747 * Get whether a given gengrid widget is or not able have items
8750 * @param obj The gengrid object
8751 * @return @c EINA_TRUE, if reoderding is on, @c EINA_FALSE if it's
8754 * @see elm_gengrid_reorder_mode_set() for more details
8758 EAPI Eina_Bool elm_gengrid_reorder_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8761 * Append a new item in a given gengrid widget.
8763 * @param obj The gengrid object.
8764 * @param gic The item class for the item.
8765 * @param data The item data.
8766 * @param func Convenience function called when the item is
8768 * @param func_data Data to be passed to @p func.
8769 * @return A handle to the item added or @c NULL, on errors.
8771 * This adds an item to the beginning of the gengrid.
8773 * @see elm_gengrid_item_prepend()
8774 * @see elm_gengrid_item_insert_before()
8775 * @see elm_gengrid_item_insert_after()
8776 * @see elm_gengrid_item_del()
8780 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);
8783 * Prepend a new item in a given gengrid widget.
8785 * @param obj The gengrid object.
8786 * @param gic The item class for the item.
8787 * @param data The item data.
8788 * @param func Convenience function called when the item is
8790 * @param func_data Data to be passed to @p func.
8791 * @return A handle to the item added or @c NULL, on errors.
8793 * This adds an item to the end of the gengrid.
8795 * @see elm_gengrid_item_append()
8796 * @see elm_gengrid_item_insert_before()
8797 * @see elm_gengrid_item_insert_after()
8798 * @see elm_gengrid_item_del()
8802 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);
8805 * Insert an item before another in a gengrid widget
8807 * @param obj The gengrid object.
8808 * @param gic The item class for the item.
8809 * @param data The item data.
8810 * @param relative The item to place this new one before.
8811 * @param func Convenience function called when the item is
8813 * @param func_data Data to be passed to @p func.
8814 * @return A handle to the item added or @c NULL, on errors.
8816 * This inserts an item before another in the gengrid.
8818 * @see elm_gengrid_item_append()
8819 * @see elm_gengrid_item_prepend()
8820 * @see elm_gengrid_item_insert_after()
8821 * @see elm_gengrid_item_del()
8825 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);
8828 * Insert an item after another in a gengrid widget
8830 * @param obj The gengrid object.
8831 * @param gic The item class for the item.
8832 * @param data The item data.
8833 * @param relative The item to place this new one after.
8834 * @param func Convenience function called when the item is
8836 * @param func_data Data to be passed to @p func.
8837 * @return A handle to the item added or @c NULL, on errors.
8839 * This inserts an item after another in the gengrid.
8841 * @see elm_gengrid_item_append()
8842 * @see elm_gengrid_item_prepend()
8843 * @see elm_gengrid_item_insert_after()
8844 * @see elm_gengrid_item_del()
8848 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);
8851 * Insert an item in a gengrid widget using a user-defined sort function.
8853 * @param obj The gengrid object.
8854 * @param gic The item class for the item.
8855 * @param data The item data.
8856 * @param comp User defined comparison function that defines the sort order based on
8857 * Elm_Gen_Item and its data param.
8858 * @param func Convenience function called when the item is selected.
8859 * @param func_data Data to be passed to @p func.
8860 * @return A handle to the item added or @c NULL, on errors.
8862 * This inserts an item in the gengrid based on user defined comparison function.
8864 * @see elm_gengrid_item_append()
8865 * @see elm_gengrid_item_prepend()
8866 * @see elm_gengrid_item_insert_after()
8867 * @see elm_gengrid_item_del()
8868 * @see elm_gengrid_item_direct_sorted_insert()
8872 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);
8875 * Insert an item in a gengrid widget using a user-defined sort function.
8877 * @param obj The gengrid object.
8878 * @param gic The item class for the item.
8879 * @param data The item data.
8880 * @param comp User defined comparison function that defines the sort order based on
8882 * @param func Convenience function called when the item is selected.
8883 * @param func_data Data to be passed to @p func.
8884 * @return A handle to the item added or @c NULL, on errors.
8886 * This inserts an item in the gengrid based on user defined comparison function.
8888 * @see elm_gengrid_item_append()
8889 * @see elm_gengrid_item_prepend()
8890 * @see elm_gengrid_item_insert_after()
8891 * @see elm_gengrid_item_del()
8892 * @see elm_gengrid_item_sorted_insert()
8896 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);
8899 * Set whether items on a given gengrid widget are to get their
8900 * selection callbacks issued for @b every subsequent selection
8901 * click on them or just for the first click.
8903 * @param obj The gengrid object
8904 * @param always_select @c EINA_TRUE to make items "always
8905 * selected", @c EINA_FALSE, otherwise
8907 * By default, grid items will only call their selection callback
8908 * function when firstly getting selected, any subsequent further
8909 * clicks will do nothing. With this call, you make those
8910 * subsequent clicks also to issue the selection callbacks.
8912 * @note <b>Double clicks</b> will @b always be reported on items.
8914 * @see elm_gengrid_always_select_mode_get()
8918 EAPI void elm_gengrid_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
8921 * Get whether items on a given gengrid widget have their selection
8922 * callbacks issued for @b every subsequent selection click on them
8923 * or just for the first click.
8925 * @param obj The gengrid object.
8926 * @return @c EINA_TRUE if the gengrid items are "always selected",
8927 * @c EINA_FALSE, otherwise
8929 * @see elm_gengrid_always_select_mode_set() for more details
8933 EAPI Eina_Bool elm_gengrid_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8936 * Set whether items on a given gengrid widget can be selected or not.
8938 * @param obj The gengrid object
8939 * @param no_select @c EINA_TRUE to make items selectable,
8940 * @c EINA_FALSE otherwise
8942 * This will make items in @p obj selectable or not. In the latter
8943 * case, any user interaction on the gengrid items will neither make
8944 * them appear selected nor them call their selection callback
8947 * @see elm_gengrid_no_select_mode_get()
8951 EAPI void elm_gengrid_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
8954 * Get whether items on a given gengrid widget can be selected or
8957 * @param obj The gengrid object
8958 * @return @c EINA_TRUE, if items are selectable, @c EINA_FALSE
8961 * @see elm_gengrid_no_select_mode_set() for more details
8965 EAPI Eina_Bool elm_gengrid_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8968 * Enable or disable multi-selection in a given gengrid widget
8970 * @param obj The gengrid object.
8971 * @param multi @c EINA_TRUE, to enable multi-selection,
8972 * @c EINA_FALSE to disable it.
8974 * Multi-selection is the ability to have @b more than one
8975 * item selected, on a given gengrid, simultaneously. When it is
8976 * enabled, a sequence of clicks on different items will make them
8977 * all selected, progressively. A click on an already selected item
8978 * will unselect it. If interacting via the keyboard,
8979 * multi-selection is enabled while holding the "Shift" key.
8981 * @note By default, multi-selection is @b disabled on gengrids
8983 * @see elm_gengrid_multi_select_get()
8987 EAPI void elm_gengrid_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
8990 * Get whether multi-selection is enabled or disabled for a given
8993 * @param obj The gengrid object.
8994 * @return @c EINA_TRUE, if multi-selection is enabled, @c
8995 * EINA_FALSE otherwise
8997 * @see elm_gengrid_multi_select_set() for more details
9001 EAPI Eina_Bool elm_gengrid_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9004 * Enable or disable bouncing effect for a given gengrid widget
9006 * @param obj The gengrid object
9007 * @param h_bounce @c EINA_TRUE, to enable @b horizontal bouncing,
9008 * @c EINA_FALSE to disable it
9009 * @param v_bounce @c EINA_TRUE, to enable @b vertical bouncing,
9010 * @c EINA_FALSE to disable it
9012 * The bouncing effect occurs whenever one reaches the gengrid's
9013 * edge's while panning it -- it will scroll past its limits a
9014 * little bit and return to the edge again, in a animated for,
9017 * @note By default, gengrids have bouncing enabled on both axis
9019 * @see elm_gengrid_bounce_get()
9023 EAPI void elm_gengrid_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
9026 * Get whether bouncing effects are enabled or disabled, for a
9027 * given gengrid widget, on each axis
9029 * @param obj The gengrid object
9030 * @param h_bounce Pointer to a variable where to store the
9031 * horizontal bouncing flag.
9032 * @param v_bounce Pointer to a variable where to store the
9033 * vertical bouncing flag.
9035 * @see elm_gengrid_bounce_set() for more details
9039 EAPI void elm_gengrid_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
9042 * Set a given gengrid widget's scrolling page size, relative to
9043 * its viewport size.
9045 * @param obj The gengrid object
9046 * @param h_pagerel The horizontal page (relative) size
9047 * @param v_pagerel The vertical page (relative) size
9049 * The gengrid's scroller is capable of binding scrolling by the
9050 * user to "pages". It means that, while scrolling and, specially
9051 * after releasing the mouse button, the grid will @b snap to the
9052 * nearest displaying page's area. When page sizes are set, the
9053 * grid's continuous content area is split into (equal) page sized
9056 * This function sets the size of a page <b>relatively to the
9057 * viewport dimensions</b> of the gengrid, for each axis. A value
9058 * @c 1.0 means "the exact viewport's size", in that axis, while @c
9059 * 0.0 turns paging off in that axis. Likewise, @c 0.5 means "half
9060 * a viewport". Sane usable values are, than, between @c 0.0 and @c
9061 * 1.0. Values beyond those will make it behave behave
9062 * inconsistently. If you only want one axis to snap to pages, use
9063 * the value @c 0.0 for the other one.
9065 * There is a function setting page size values in @b absolute
9066 * values, too -- elm_gengrid_page_size_set(). Naturally, its use
9067 * is mutually exclusive to this one.
9069 * @see elm_gengrid_page_relative_get()
9073 EAPI void elm_gengrid_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel) EINA_ARG_NONNULL(1);
9076 * Get a given gengrid widget's scrolling page size, relative to
9077 * its viewport size.
9079 * @param obj The gengrid object
9080 * @param h_pagerel Pointer to a variable where to store the
9081 * horizontal page (relative) size
9082 * @param v_pagerel Pointer to a variable where to store the
9083 * vertical page (relative) size
9085 * @see elm_gengrid_page_relative_set() for more details
9089 EAPI void elm_gengrid_page_relative_get(const Evas_Object *obj, double *h_pagerel, double *v_pagerel) EINA_ARG_NONNULL(1);
9092 * Set a given gengrid widget's scrolling page size
9094 * @param obj The gengrid object
9095 * @param h_pagerel The horizontal page size, in pixels
9096 * @param v_pagerel The vertical page size, in pixels
9098 * The gengrid's scroller is capable of binding scrolling by the
9099 * user to "pages". It means that, while scrolling and, specially
9100 * after releasing the mouse button, the grid will @b snap to the
9101 * nearest displaying page's area. When page sizes are set, the
9102 * grid's continuous content area is split into (equal) page sized
9105 * This function sets the size of a page of the gengrid, in pixels,
9106 * for each axis. Sane usable values are, between @c 0 and the
9107 * dimensions of @p obj, for each axis. Values beyond those will
9108 * make it behave behave inconsistently. If you only want one axis
9109 * to snap to pages, use the value @c 0 for the other one.
9111 * There is a function setting page size values in @b relative
9112 * values, too -- elm_gengrid_page_relative_set(). Naturally, its
9113 * use is mutually exclusive to this one.
9117 EAPI void elm_gengrid_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize) EINA_ARG_NONNULL(1);
9120 * @brief Get gengrid current page number.
9122 * @param obj The gengrid object
9123 * @param h_pagenumber The horizontal page number
9124 * @param v_pagenumber The vertical page number
9126 * The page number starts from 0. 0 is the first page.
9127 * Current page means the page which meet the top-left of the viewport.
9128 * If there are two or more pages in the viewport, it returns the number of page
9129 * which meet the top-left of the viewport.
9131 * @see elm_gengrid_last_page_get()
9132 * @see elm_gengrid_page_show()
9133 * @see elm_gengrid_page_brint_in()
9135 EAPI void elm_gengrid_current_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber) EINA_ARG_NONNULL(1);
9138 * @brief Get scroll last page number.
9140 * @param obj The gengrid object
9141 * @param h_pagenumber The horizontal page number
9142 * @param v_pagenumber The vertical page number
9144 * The page number starts from 0. 0 is the first page.
9145 * This returns the last page number among the pages.
9147 * @see elm_gengrid_current_page_get()
9148 * @see elm_gengrid_page_show()
9149 * @see elm_gengrid_page_brint_in()
9151 EAPI void elm_gengrid_last_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber) EINA_ARG_NONNULL(1);
9154 * Show a specific virtual region within the gengrid content object by page number.
9156 * @param obj The gengrid object
9157 * @param h_pagenumber The horizontal page number
9158 * @param v_pagenumber The vertical page number
9160 * 0, 0 of the indicated page is located at the top-left of the viewport.
9161 * This will jump to the page directly without animation.
9166 * sc = elm_gengrid_add(win);
9167 * elm_gengrid_content_set(sc, content);
9168 * elm_gengrid_page_relative_set(sc, 1, 0);
9169 * elm_gengrid_current_page_get(sc, &h_page, &v_page);
9170 * elm_gengrid_page_show(sc, h_page + 1, v_page);
9173 * @see elm_gengrid_page_bring_in()
9175 EAPI void elm_gengrid_page_show(const Evas_Object *obj, int h_pagenumber, int v_pagenumber) EINA_ARG_NONNULL(1);
9178 * Show a specific virtual region within the gengrid content object by page number.
9180 * @param obj The gengrid object
9181 * @param h_pagenumber The horizontal page number
9182 * @param v_pagenumber The vertical page number
9184 * 0, 0 of the indicated page is located at the top-left of the viewport.
9185 * This will slide to the page with animation.
9190 * sc = elm_gengrid_add(win);
9191 * elm_gengrid_content_set(sc, content);
9192 * elm_gengrid_page_relative_set(sc, 1, 0);
9193 * elm_gengrid_last_page_get(sc, &h_page, &v_page);
9194 * elm_gengrid_page_bring_in(sc, h_page, v_page);
9197 * @see elm_gengrid_page_show()
9199 EAPI void elm_gengrid_page_bring_in(const Evas_Object *obj, int h_pagenumber, int v_pagenumber) EINA_ARG_NONNULL(1);
9202 * Set the direction in which a given gengrid widget will expand while
9203 * placing its items.
9205 * @param obj The gengrid object.
9206 * @param setting @c EINA_TRUE to make the gengrid expand
9207 * horizontally, @c EINA_FALSE to expand vertically.
9209 * When in "horizontal mode" (@c EINA_TRUE), items will be placed
9210 * in @b columns, from top to bottom and, when the space for a
9211 * column is filled, another one is started on the right, thus
9212 * expanding the grid horizontally. When in "vertical mode"
9213 * (@c EINA_FALSE), though, items will be placed in @b rows, from left
9214 * to right and, when the space for a row is filled, another one is
9215 * started below, thus expanding the grid vertically.
9217 * @see elm_gengrid_horizontal_get()
9221 EAPI void elm_gengrid_horizontal_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
9224 * Get for what direction a given gengrid widget will expand while
9225 * placing its items.
9227 * @param obj The gengrid object.
9228 * @return @c EINA_TRUE, if @p obj is set to expand horizontally,
9229 * @c EINA_FALSE if it's set to expand vertically.
9231 * @see elm_gengrid_horizontal_set() for more detais
9235 EAPI Eina_Bool elm_gengrid_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9238 * Get the first item in a given gengrid widget
9240 * @param obj The gengrid object
9241 * @return The first item's handle or @c NULL, if there are no
9242 * items in @p obj (and on errors)
9244 * This returns the first item in the @p obj's internal list of
9247 * @see elm_gengrid_last_item_get()
9251 EAPI Elm_Gengrid_Item *elm_gengrid_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9254 * Get the last item in a given gengrid widget
9256 * @param obj The gengrid object
9257 * @return The last item's handle or @c NULL, if there are no
9258 * items in @p obj (and on errors)
9260 * This returns the last item in the @p obj's internal list of
9263 * @see elm_gengrid_first_item_get()
9267 EAPI Elm_Gengrid_Item *elm_gengrid_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9270 * Get the @b next item in a gengrid widget's internal list of items,
9271 * given a handle to one of those items.
9273 * @param item The gengrid item to fetch next from
9274 * @return The item after @p item, or @c NULL if there's none (and
9277 * This returns the item placed after the @p item, on the container
9280 * @see elm_gengrid_item_prev_get()
9284 EAPI Elm_Gengrid_Item *elm_gengrid_item_next_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9287 * Get the @b previous item in a gengrid widget's internal list of items,
9288 * given a handle to one of those items.
9290 * @param item The gengrid item to fetch previous from
9291 * @return The item before @p item, or @c NULL if there's none (and
9294 * This returns the item placed before the @p item, on the container
9297 * @see elm_gengrid_item_next_get()
9301 EAPI Elm_Gengrid_Item *elm_gengrid_item_prev_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9304 * Get the gengrid object's handle which contains a given gengrid
9307 * @param item The item to fetch the container from
9308 * @return The gengrid (parent) object
9310 * This returns the gengrid object itself that an item belongs to.
9314 EAPI Evas_Object *elm_gengrid_item_gengrid_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9317 * Remove a gengrid item from its parent, deleting it.
9319 * @param item The item to be removed.
9320 * @return @c EINA_TRUE on success or @c EINA_FALSE, otherwise.
9322 * @see elm_gengrid_clear(), to remove all items in a gengrid at
9327 EAPI void elm_gengrid_item_del(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9330 * Update the contents of a given gengrid item
9332 * @param item The gengrid item
9334 * This updates an item by calling all the item class functions
9335 * again to get the contents, texts and states. Use this when the
9336 * original item data has changed and you want the changes to be
9341 EAPI void elm_gengrid_item_update(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9344 * Get the Gengrid Item class for the given Gengrid Item.
9346 * @param item The gengrid item
9348 * This returns the Gengrid_Item_Class for the given item. It can be used to examine
9349 * the function pointers and item_style.
9353 EAPI const Elm_Gengrid_Item_Class *elm_gengrid_item_item_class_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9356 * Get the Gengrid Item class for the given Gengrid Item.
9358 * This sets the Gengrid_Item_Class for the given item. It can be used to examine
9359 * the function pointers and item_style.
9361 * @param item The gengrid item
9362 * @param gic The gengrid item class describing the function pointers and the item style.
9366 EAPI void elm_gengrid_item_item_class_set(Elm_Gengrid_Item *item, const Elm_Gengrid_Item_Class *gic) EINA_ARG_NONNULL(1, 2);
9369 * Return the data associated to a given gengrid item
9371 * @param item The gengrid item.
9372 * @return the data associated with this item.
9374 * This returns the @c data value passed on the
9375 * elm_gengrid_item_append() and related item addition calls.
9377 * @see elm_gengrid_item_append()
9378 * @see elm_gengrid_item_data_set()
9382 EAPI void *elm_gengrid_item_data_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9385 * Set the data associated with a given gengrid item
9387 * @param item The gengrid item
9388 * @param data The data pointer to set on it
9390 * This @b overrides the @c data value passed on the
9391 * elm_gengrid_item_append() and related item addition calls. This
9392 * function @b won't call elm_gengrid_item_update() automatically,
9393 * so you'd issue it afterwards if you want to have the item
9394 * updated to reflect the new data.
9396 * @see elm_gengrid_item_data_get()
9397 * @see elm_gengrid_item_update()
9401 EAPI void elm_gengrid_item_data_set(Elm_Gengrid_Item *item, const void *data) EINA_ARG_NONNULL(1);
9404 * Get a given gengrid item's position, relative to the whole
9405 * gengrid's grid area.
9407 * @param item The Gengrid item.
9408 * @param x Pointer to variable to store the item's <b>row number</b>.
9409 * @param y Pointer to variable to store the item's <b>column number</b>.
9411 * This returns the "logical" position of the item within the
9412 * gengrid. For example, @c (0, 1) would stand for first row,
9417 EAPI void elm_gengrid_item_pos_get(const Elm_Gengrid_Item *item, unsigned int *x, unsigned int *y) EINA_ARG_NONNULL(1);
9420 * Set whether a given gengrid item is selected or not
9422 * @param item The gengrid item
9423 * @param selected Use @c EINA_TRUE, to make it selected, @c
9424 * EINA_FALSE to make it unselected
9426 * This sets the selected state of an item. If multi-selection is
9427 * not enabled on the containing gengrid and @p selected is @c
9428 * EINA_TRUE, any other previously selected items will get
9429 * unselected in favor of this new one.
9431 * @see elm_gengrid_item_selected_get()
9435 EAPI void elm_gengrid_item_selected_set(Elm_Gengrid_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
9438 * Get whether a given gengrid item is selected or not
9440 * @param item The gengrid item
9441 * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
9443 * This API returns EINA_TRUE for all the items selected in multi-select mode as well.
9445 * @see elm_gengrid_item_selected_set() for more details
9449 EAPI Eina_Bool elm_gengrid_item_selected_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9452 * Get the real Evas object created to implement the view of a
9453 * given gengrid item
9455 * @param item The gengrid item.
9456 * @return the Evas object implementing this item's view.
9458 * This returns the actual Evas object used to implement the
9459 * specified gengrid item's view. This may be @c NULL, as it may
9460 * not have been created or may have been deleted, at any time, by
9461 * the gengrid. <b>Do not modify this object</b> (move, resize,
9462 * show, hide, etc.), as the gengrid is controlling it. This
9463 * function is for querying, emitting custom signals or hooking
9464 * lower level callbacks for events on that object. Do not delete
9465 * this object under any circumstances.
9467 * @see elm_gengrid_item_data_get()
9471 EAPI const Evas_Object *elm_gengrid_item_object_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9474 * Show the portion of a gengrid's internal grid containing a given
9475 * item, @b immediately.
9477 * @param item The item to display
9479 * This causes gengrid to @b redraw its viewport's contents to the
9480 * region contining the given @p item item, if it is not fully
9483 * @see elm_gengrid_item_bring_in()
9487 EAPI void elm_gengrid_item_show(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9490 * Animatedly bring in, to the visible area of a gengrid, a given
9493 * @param item The gengrid item to display
9495 * This causes gengrid to jump to the given @p item and show
9496 * it (by scrolling), if it is not fully visible. This will use
9497 * animation to do so and take a period of time to complete.
9499 * @see elm_gengrid_item_show()
9503 EAPI void elm_gengrid_item_bring_in(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9506 * Set whether a given gengrid item is disabled or not.
9508 * @param item The gengrid item
9509 * @param disabled Use @c EINA_TRUE, true disable it, @c EINA_FALSE
9510 * to enable it back.
9512 * A disabled item cannot be selected or unselected. It will also
9513 * change its appearance, to signal the user it's disabled.
9515 * @see elm_gengrid_item_disabled_get()
9519 EAPI void elm_gengrid_item_disabled_set(Elm_Gengrid_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
9522 * Get whether a given gengrid item is disabled or not.
9524 * @param item The gengrid item
9525 * @return @c EINA_TRUE, if it's disabled, @c EINA_FALSE otherwise
9528 * @see elm_gengrid_item_disabled_set() for more details
9532 EAPI Eina_Bool elm_gengrid_item_disabled_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9535 * Set the text to be shown in a given gengrid item's tooltips.
9537 * @param item The gengrid item
9538 * @param text The text to set in the content
9540 * This call will setup the text to be used as tooltip to that item
9541 * (analogous to elm_object_tooltip_text_set(), but being item
9542 * tooltips with higher precedence than object tooltips). It can
9543 * have only one tooltip at a time, so any previous tooltip data
9548 EAPI void elm_gengrid_item_tooltip_text_set(Elm_Gengrid_Item *item, const char *text) EINA_ARG_NONNULL(1);
9551 * Set the content to be shown in a given gengrid item's tooltip
9553 * @param item The gengrid item.
9554 * @param func The function returning the tooltip contents.
9555 * @param data What to provide to @a func as callback data/context.
9556 * @param del_cb Called when data is not needed anymore, either when
9557 * another callback replaces @p func, the tooltip is unset with
9558 * elm_gengrid_item_tooltip_unset() or the owner @p item
9559 * dies. This callback receives as its first parameter the
9560 * given @p data, being @c event_info the item handle.
9562 * This call will setup the tooltip's contents to @p item
9563 * (analogous to elm_object_tooltip_content_cb_set(), but being
9564 * item tooltips with higher precedence than object tooltips). It
9565 * can have only one tooltip at a time, so any previous tooltip
9566 * content will get removed. @p func (with @p data) will be called
9567 * every time Elementary needs to show the tooltip and it should
9568 * return a valid Evas object, which will be fully managed by the
9569 * tooltip system, getting deleted when the tooltip is gone.
9573 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);
9576 * Unset a tooltip from a given gengrid item
9578 * @param item gengrid item to remove a previously set tooltip from.
9580 * This call removes any tooltip set on @p item. The callback
9581 * provided as @c del_cb to
9582 * elm_gengrid_item_tooltip_content_cb_set() will be called to
9583 * notify it is not used anymore (and have resources cleaned, if
9586 * @see elm_gengrid_item_tooltip_content_cb_set()
9590 EAPI void elm_gengrid_item_tooltip_unset(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9593 * Set a different @b style for a given gengrid item's tooltip.
9595 * @param item gengrid item with tooltip set
9596 * @param style the <b>theme style</b> to use on tooltips (e.g. @c
9597 * "default", @c "transparent", etc)
9599 * Tooltips can have <b>alternate styles</b> to be displayed on,
9600 * which are defined by the theme set on Elementary. This function
9601 * works analogously as elm_object_tooltip_style_set(), but here
9602 * applied only to gengrid item objects. The default style for
9603 * tooltips is @c "default".
9605 * @note before you set a style you should define a tooltip with
9606 * elm_gengrid_item_tooltip_content_cb_set() or
9607 * elm_gengrid_item_tooltip_text_set()
9609 * @see elm_gengrid_item_tooltip_style_get()
9613 EAPI void elm_gengrid_item_tooltip_style_set(Elm_Gengrid_Item *item, const char *style) EINA_ARG_NONNULL(1);
9616 * Get the style set a given gengrid item's tooltip.
9618 * @param item gengrid item with tooltip already set on.
9619 * @return style the theme style in use, which defaults to
9620 * "default". If the object does not have a tooltip set,
9621 * then @c NULL is returned.
9623 * @see elm_gengrid_item_tooltip_style_set() for more details
9627 EAPI const char *elm_gengrid_item_tooltip_style_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9629 * @brief Disable size restrictions on an object's tooltip
9630 * @param item The tooltip's anchor object
9631 * @param disable If EINA_TRUE, size restrictions are disabled
9632 * @return EINA_FALSE on failure, EINA_TRUE on success
9634 * This function allows a tooltip to expand beyond its parant window's canvas.
9635 * It will instead be limited only by the size of the display.
9637 EAPI Eina_Bool elm_gengrid_item_tooltip_size_restrict_disable(Elm_Gengrid_Item *item, Eina_Bool disable);
9639 * @brief Retrieve size restriction state of an object's tooltip
9640 * @param item The tooltip's anchor object
9641 * @return If EINA_TRUE, size restrictions are disabled
9643 * This function returns whether a tooltip is allowed to expand beyond
9644 * its parant window's canvas.
9645 * It will instead be limited only by the size of the display.
9647 EAPI Eina_Bool elm_gengrid_item_tooltip_size_restrict_disabled_get(const Elm_Gengrid_Item *item);
9649 * Set the type of mouse pointer/cursor decoration to be shown,
9650 * when the mouse pointer is over the given gengrid widget item
9652 * @param item gengrid item to customize cursor on
9653 * @param cursor the cursor type's name
9655 * This function works analogously as elm_object_cursor_set(), but
9656 * here the cursor's changing area is restricted to the item's
9657 * area, and not the whole widget's. Note that that item cursors
9658 * have precedence over widget cursors, so that a mouse over @p
9659 * item will always show cursor @p type.
9661 * If this function is called twice for an object, a previously set
9662 * cursor will be unset on the second call.
9664 * @see elm_object_cursor_set()
9665 * @see elm_gengrid_item_cursor_get()
9666 * @see elm_gengrid_item_cursor_unset()
9670 EAPI void elm_gengrid_item_cursor_set(Elm_Gengrid_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
9673 * Get the type of mouse pointer/cursor decoration set to be shown,
9674 * when the mouse pointer is over the given gengrid widget item
9676 * @param item gengrid item with custom cursor set
9677 * @return the cursor type's name or @c NULL, if no custom cursors
9678 * were set to @p item (and on errors)
9680 * @see elm_object_cursor_get()
9681 * @see elm_gengrid_item_cursor_set() for more details
9682 * @see elm_gengrid_item_cursor_unset()
9686 EAPI const char *elm_gengrid_item_cursor_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9689 * Unset any custom mouse pointer/cursor decoration set to be
9690 * shown, when the mouse pointer is over the given gengrid widget
9691 * item, thus making it show the @b default cursor again.
9693 * @param item a gengrid item
9695 * Use this call to undo any custom settings on this item's cursor
9696 * decoration, bringing it back to defaults (no custom style set).
9698 * @see elm_object_cursor_unset()
9699 * @see elm_gengrid_item_cursor_set() for more details
9703 EAPI void elm_gengrid_item_cursor_unset(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9706 * Set a different @b style for a given custom cursor set for a
9709 * @param item gengrid item with custom cursor set
9710 * @param style the <b>theme style</b> to use (e.g. @c "default",
9711 * @c "transparent", etc)
9713 * This function only makes sense when one is using custom mouse
9714 * cursor decorations <b>defined in a theme file</b> , which can
9715 * have, given a cursor name/type, <b>alternate styles</b> on
9716 * it. It works analogously as elm_object_cursor_style_set(), but
9717 * here applied only to gengrid item objects.
9719 * @warning Before you set a cursor style you should have defined a
9720 * custom cursor previously on the item, with
9721 * elm_gengrid_item_cursor_set()
9723 * @see elm_gengrid_item_cursor_engine_only_set()
9724 * @see elm_gengrid_item_cursor_style_get()
9728 EAPI void elm_gengrid_item_cursor_style_set(Elm_Gengrid_Item *item, const char *style) EINA_ARG_NONNULL(1);
9731 * Get the current @b style set for a given gengrid item's custom
9734 * @param item gengrid item with custom cursor set.
9735 * @return style the cursor style in use. If the object does not
9736 * have a cursor set, then @c NULL is returned.
9738 * @see elm_gengrid_item_cursor_style_set() for more details
9742 EAPI const char *elm_gengrid_item_cursor_style_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9745 * Set if the (custom) cursor for a given gengrid item should be
9746 * searched in its theme, also, or should only rely on the
9749 * @param item item with custom (custom) cursor already set on
9750 * @param engine_only Use @c EINA_TRUE to have cursors looked for
9751 * only on those provided by the rendering engine, @c EINA_FALSE to
9752 * have them searched on the widget's theme, as well.
9754 * @note This call is of use only if you've set a custom cursor
9755 * for gengrid items, with elm_gengrid_item_cursor_set().
9757 * @note By default, cursors will only be looked for between those
9758 * provided by the rendering engine.
9762 EAPI void elm_gengrid_item_cursor_engine_only_set(Elm_Gengrid_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
9765 * Get if the (custom) cursor for a given gengrid item is being
9766 * searched in its theme, also, or is only relying on the rendering
9769 * @param item a gengrid item
9770 * @return @c EINA_TRUE, if cursors are being looked for only on
9771 * those provided by the rendering engine, @c EINA_FALSE if they
9772 * are being searched on the widget's theme, as well.
9774 * @see elm_gengrid_item_cursor_engine_only_set(), for more details
9778 EAPI Eina_Bool elm_gengrid_item_cursor_engine_only_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9781 * Remove all items from a given gengrid widget
9783 * @param obj The gengrid object.
9785 * This removes (and deletes) all items in @p obj, leaving it
9788 * @see elm_gengrid_item_del(), to remove just one item.
9792 EAPI void elm_gengrid_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
9795 * Get the selected item in a given gengrid widget
9797 * @param obj The gengrid object.
9798 * @return The selected item's handleor @c NULL, if none is
9799 * selected at the moment (and on errors)
9801 * This returns the selected item in @p obj. If multi selection is
9802 * enabled on @p obj (@see elm_gengrid_multi_select_set()), only
9803 * the first item in the list is selected, which might not be very
9804 * useful. For that case, see elm_gengrid_selected_items_get().
9808 EAPI Elm_Gengrid_Item *elm_gengrid_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9811 * Get <b>a list</b> of selected items in a given gengrid
9813 * @param obj The gengrid object.
9814 * @return The list of selected items or @c NULL, if none is
9815 * selected at the moment (and on errors)
9817 * This returns a list of the selected items, in the order that
9818 * they appear in the grid. This list is only valid as long as no
9819 * more items are selected or unselected (or unselected implictly
9820 * by deletion). The list contains #Elm_Gengrid_Item pointers as
9823 * @see elm_gengrid_selected_item_get()
9827 EAPI const Eina_List *elm_gengrid_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9834 * @defgroup Clock Clock
9836 * @image html img/widget/clock/preview-00.png
9837 * @image latex img/widget/clock/preview-00.eps
9839 * This is a @b digital clock widget. In its default theme, it has a
9840 * vintage "flipping numbers clock" appearance, which will animate
9841 * sheets of individual algarisms individually as time goes by.
9843 * A newly created clock will fetch system's time (already
9844 * considering local time adjustments) to start with, and will tick
9845 * accondingly. It may or may not show seconds.
9847 * Clocks have an @b edition mode. When in it, the sheets will
9848 * display extra arrow indications on the top and bottom and the
9849 * user may click on them to raise or lower the time values. After
9850 * it's told to exit edition mode, it will keep ticking with that
9851 * new time set (it keeps the difference from local time).
9853 * Also, when under edition mode, user clicks on the cited arrows
9854 * which are @b held for some time will make the clock to flip the
9855 * sheet, thus editing the time, continuosly and automatically for
9856 * the user. The interval between sheet flips will keep growing in
9857 * time, so that it helps the user to reach a time which is distant
9860 * The time display is, by default, in military mode (24h), but an
9861 * am/pm indicator may be optionally shown, too, when it will
9864 * Smart callbacks one can register to:
9865 * - "changed" - the clock's user changed the time
9867 * Here is an example on its usage:
9868 * @li @ref clock_example
9877 * Identifiers for which clock digits should be editable, when a
9878 * clock widget is in edition mode. Values may be ORed together to
9879 * make a mask, naturally.
9881 * @see elm_clock_edit_set()
9882 * @see elm_clock_digit_edit_set()
9884 typedef enum _Elm_Clock_Digedit
9886 ELM_CLOCK_NONE = 0, /**< Default value. Means that all digits are editable, when in edition mode. */
9887 ELM_CLOCK_HOUR_DECIMAL = 1 << 0, /**< Decimal algarism of hours value should be editable */
9888 ELM_CLOCK_HOUR_UNIT = 1 << 1, /**< Unit algarism of hours value should be editable */
9889 ELM_CLOCK_MIN_DECIMAL = 1 << 2, /**< Decimal algarism of minutes value should be editable */
9890 ELM_CLOCK_MIN_UNIT = 1 << 3, /**< Unit algarism of minutes value should be editable */
9891 ELM_CLOCK_SEC_DECIMAL = 1 << 4, /**< Decimal algarism of seconds value should be editable */
9892 ELM_CLOCK_SEC_UNIT = 1 << 5, /**< Unit algarism of seconds value should be editable */
9893 ELM_CLOCK_ALL = (1 << 6) - 1 /**< All digits should be editable */
9894 } Elm_Clock_Digedit;
9897 * Add a new clock widget to the given parent Elementary
9898 * (container) object
9900 * @param parent The parent object
9901 * @return a new clock widget handle or @c NULL, on errors
9903 * This function inserts a new clock widget on the canvas.
9907 EAPI Evas_Object *elm_clock_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
9910 * Set a clock widget's time, programmatically
9912 * @param obj The clock widget object
9913 * @param hrs The hours to set
9914 * @param min The minutes to set
9915 * @param sec The secondes to set
9917 * This function updates the time that is showed by the clock
9920 * Values @b must be set within the following ranges:
9921 * - 0 - 23, for hours
9922 * - 0 - 59, for minutes
9923 * - 0 - 59, for seconds,
9925 * even if the clock is not in "military" mode.
9927 * @warning The behavior for values set out of those ranges is @b
9932 EAPI void elm_clock_time_set(Evas_Object *obj, int hrs, int min, int sec) EINA_ARG_NONNULL(1);
9935 * Get a clock widget's time values
9937 * @param obj The clock object
9938 * @param[out] hrs Pointer to the variable to get the hours value
9939 * @param[out] min Pointer to the variable to get the minutes value
9940 * @param[out] sec Pointer to the variable to get the seconds value
9942 * This function gets the time set for @p obj, returning
9943 * it on the variables passed as the arguments to function
9945 * @note Use @c NULL pointers on the time values you're not
9946 * interested in: they'll be ignored by the function.
9950 EAPI void elm_clock_time_get(const Evas_Object *obj, int *hrs, int *min, int *sec) EINA_ARG_NONNULL(1);
9953 * Set whether a given clock widget is under <b>edition mode</b> or
9954 * under (default) displaying-only mode.
9956 * @param obj The clock object
9957 * @param edit @c EINA_TRUE to put it in edition, @c EINA_FALSE to
9958 * put it back to "displaying only" mode
9960 * This function makes a clock's time to be editable or not <b>by
9961 * user interaction</b>. When in edition mode, clocks @b stop
9962 * ticking, until one brings them back to canonical mode. The
9963 * elm_clock_digit_edit_set() function will influence which digits
9964 * of the clock will be editable. By default, all of them will be
9965 * (#ELM_CLOCK_NONE).
9967 * @note am/pm sheets, if being shown, will @b always be editable
9968 * under edition mode.
9970 * @see elm_clock_edit_get()
9974 EAPI void elm_clock_edit_set(Evas_Object *obj, Eina_Bool edit) EINA_ARG_NONNULL(1);
9977 * Retrieve whether a given clock widget is under <b>edition
9978 * mode</b> or under (default) displaying-only mode.
9980 * @param obj The clock object
9981 * @param edit @c EINA_TRUE, if it's in edition mode, @c EINA_FALSE
9984 * This function retrieves whether the clock's time can be edited
9985 * or not by user interaction.
9987 * @see elm_clock_edit_set() for more details
9991 EAPI Eina_Bool elm_clock_edit_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9994 * Set what digits of the given clock widget should be editable
9995 * when in edition mode.
9997 * @param obj The clock object
9998 * @param digedit Bit mask indicating the digits to be editable
9999 * (values in #Elm_Clock_Digedit).
10001 * If the @p digedit param is #ELM_CLOCK_NONE, editing will be
10002 * disabled on @p obj (same effect as elm_clock_edit_set(), with @c
10005 * @see elm_clock_digit_edit_get()
10009 EAPI void elm_clock_digit_edit_set(Evas_Object *obj, Elm_Clock_Digedit digedit) EINA_ARG_NONNULL(1);
10012 * Retrieve what digits of the given clock widget should be
10013 * editable when in edition mode.
10015 * @param obj The clock object
10016 * @return Bit mask indicating the digits to be editable
10017 * (values in #Elm_Clock_Digedit).
10019 * @see elm_clock_digit_edit_set() for more details
10023 EAPI Elm_Clock_Digedit elm_clock_digit_edit_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10026 * Set if the given clock widget must show hours in military or
10029 * @param obj The clock object
10030 * @param am_pm @c EINA_TRUE to put it in am/pm mode, @c EINA_FALSE
10033 * This function sets if the clock must show hours in military or
10034 * am/pm mode. In some countries like Brazil the military mode
10035 * (00-24h-format) is used, in opposition to the USA, where the
10036 * am/pm mode is more commonly used.
10038 * @see elm_clock_show_am_pm_get()
10042 EAPI void elm_clock_show_am_pm_set(Evas_Object *obj, Eina_Bool am_pm) EINA_ARG_NONNULL(1);
10045 * Get if the given clock widget shows hours in military or am/pm
10048 * @param obj The clock object
10049 * @return @c EINA_TRUE, if in am/pm mode, @c EINA_FALSE if in
10052 * This function gets if the clock shows hours in military or am/pm
10055 * @see elm_clock_show_am_pm_set() for more details
10059 EAPI Eina_Bool elm_clock_show_am_pm_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10062 * Set if the given clock widget must show time with seconds or not
10064 * @param obj The clock object
10065 * @param seconds @c EINA_TRUE to show seconds, @c EINA_FALSE otherwise
10067 * This function sets if the given clock must show or not elapsed
10068 * seconds. By default, they are @b not shown.
10070 * @see elm_clock_show_seconds_get()
10074 EAPI void elm_clock_show_seconds_set(Evas_Object *obj, Eina_Bool seconds) EINA_ARG_NONNULL(1);
10077 * Get whether the given clock widget is showing time with seconds
10080 * @param obj The clock object
10081 * @return @c EINA_TRUE if it's showing seconds, @c EINA_FALSE otherwise
10083 * This function gets whether @p obj is showing or not the elapsed
10086 * @see elm_clock_show_seconds_set()
10090 EAPI Eina_Bool elm_clock_show_seconds_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10093 * Set the interval on time updates for an user mouse button hold
10094 * on clock widgets' time edition.
10096 * @param obj The clock object
10097 * @param interval The (first) interval value in seconds
10099 * This interval value is @b decreased while the user holds the
10100 * mouse pointer either incrementing or decrementing a given the
10101 * clock digit's value.
10103 * This helps the user to get to a given time distant from the
10104 * current one easier/faster, as it will start to flip quicker and
10105 * quicker on mouse button holds.
10107 * The calculation for the next flip interval value, starting from
10108 * the one set with this call, is the previous interval divided by
10109 * 1.05, so it decreases a little bit.
10111 * The default starting interval value for automatic flips is
10114 * @see elm_clock_interval_get()
10118 EAPI void elm_clock_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
10121 * Get the interval on time updates for an user mouse button hold
10122 * on clock widgets' time edition.
10124 * @param obj The clock object
10125 * @return The (first) interval value, in seconds, set on it
10127 * @see elm_clock_interval_set() for more details
10131 EAPI double elm_clock_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10138 * @defgroup Layout Layout
10140 * @image html img/widget/layout/preview-00.png
10141 * @image latex img/widget/layout/preview-00.eps width=\textwidth
10143 * @image html img/layout-predefined.png
10144 * @image latex img/layout-predefined.eps width=\textwidth
10146 * This is a container widget that takes a standard Edje design file and
10147 * wraps it very thinly in a widget.
10149 * An Edje design (theme) file has a very wide range of possibilities to
10150 * describe the behavior of elements added to the Layout. Check out the Edje
10151 * documentation and the EDC reference to get more information about what can
10152 * be done with Edje.
10154 * Just like @ref List, @ref Box, and other container widgets, any
10155 * object added to the Layout will become its child, meaning that it will be
10156 * deleted if the Layout is deleted, move if the Layout is moved, and so on.
10158 * The Layout widget can contain as many Contents, Boxes or Tables as
10159 * described in its theme file. For instance, objects can be added to
10160 * different Tables by specifying the respective Table part names. The same
10161 * is valid for Content and Box.
10163 * The objects added as child of the Layout will behave as described in the
10164 * part description where they were added. There are 3 possible types of
10165 * parts where a child can be added:
10167 * @section secContent Content (SWALLOW part)
10169 * Only one object can be added to the @c SWALLOW part (but you still can
10170 * have many @c SWALLOW parts and one object on each of them). Use the @c
10171 * elm_object_content_set/get/unset functions to set, retrieve and unset
10172 * objects as content of the @c SWALLOW. After being set to this part, the
10173 * object size, position, visibility, clipping and other description
10174 * properties will be totally controlled by the description of the given part
10175 * (inside the Edje theme file).
10177 * One can use @c evas_object_size_hint_* functions on the child to have some
10178 * kind of control over its behavior, but the resulting behavior will still
10179 * depend heavily on the @c SWALLOW part description.
10181 * The Edje theme also can change the part description, based on signals or
10182 * scripts running inside the theme. This change can also be animated. All of
10183 * this will affect the child object set as content accordingly. The object
10184 * size will be changed if the part size is changed, it will animate move if
10185 * the part is moving, and so on.
10187 * The following picture demonstrates a Layout widget with a child object
10188 * added to its @c SWALLOW:
10190 * @image html layout_swallow.png
10191 * @image latex layout_swallow.eps width=\textwidth
10193 * @section secBox Box (BOX part)
10195 * An Edje @c BOX part is very similar to the Elementary @ref Box widget. It
10196 * allows one to add objects to the box and have them distributed along its
10197 * area, accordingly to the specified @a layout property (now by @a layout we
10198 * mean the chosen layouting design of the Box, not the Layout widget
10201 * A similar effect for having a box with its position, size and other things
10202 * controlled by the Layout theme would be to create an Elementary @ref Box
10203 * widget and add it as a Content in the @c SWALLOW part.
10205 * The main difference of using the Layout Box is that its behavior, the box
10206 * properties like layouting format, padding, align, etc. will be all
10207 * controlled by the theme. This means, for example, that a signal could be
10208 * sent to the Layout theme (with elm_object_signal_emit()) and the theme
10209 * handled the signal by changing the box padding, or align, or both. Using
10210 * the Elementary @ref Box widget is not necessarily harder or easier, it
10211 * just depends on the circunstances and requirements.
10213 * The Layout Box can be used through the @c elm_layout_box_* set of
10216 * The following picture demonstrates a Layout widget with many child objects
10217 * added to its @c BOX part:
10219 * @image html layout_box.png
10220 * @image latex layout_box.eps width=\textwidth
10222 * @section secTable Table (TABLE part)
10224 * Just like the @ref secBox, the Layout Table is very similar to the
10225 * Elementary @ref Table widget. It allows one to add objects to the Table
10226 * specifying the row and column where the object should be added, and any
10227 * column or row span if necessary.
10229 * Again, we could have this design by adding a @ref Table widget to the @c
10230 * SWALLOW part using elm_object_part_content_set(). The same difference happens
10231 * here when choosing to use the Layout Table (a @c TABLE part) instead of
10232 * the @ref Table plus @c SWALLOW part. It's just a matter of convenience.
10234 * The Layout Table can be used through the @c elm_layout_table_* set of
10237 * The following picture demonstrates a Layout widget with many child objects
10238 * added to its @c TABLE part:
10240 * @image html layout_table.png
10241 * @image latex layout_table.eps width=\textwidth
10243 * @section secPredef Predefined Layouts
10245 * Another interesting thing about the Layout widget is that it offers some
10246 * predefined themes that come with the default Elementary theme. These
10247 * themes can be set by the call elm_layout_theme_set(), and provide some
10248 * basic functionality depending on the theme used.
10250 * Most of them already send some signals, some already provide a toolbar or
10251 * back and next buttons.
10253 * These are available predefined theme layouts. All of them have class = @c
10254 * layout, group = @c application, and style = one of the following options:
10256 * @li @c toolbar-content - application with toolbar and main content area
10257 * @li @c toolbar-content-back - application with toolbar and main content
10258 * area with a back button and title area
10259 * @li @c toolbar-content-back-next - application with toolbar and main
10260 * content area with a back and next buttons and title area
10261 * @li @c content-back - application with a main content area with a back
10262 * button and title area
10263 * @li @c content-back-next - application with a main content area with a
10264 * back and next buttons and title area
10265 * @li @c toolbar-vbox - application with toolbar and main content area as a
10267 * @li @c toolbar-table - application with toolbar and main content area as a
10270 * @section secExamples Examples
10272 * Some examples of the Layout widget can be found here:
10273 * @li @ref layout_example_01
10274 * @li @ref layout_example_02
10275 * @li @ref layout_example_03
10276 * @li @ref layout_example_edc
10281 * Add a new layout to the parent
10283 * @param parent The parent object
10284 * @return The new object or NULL if it cannot be created
10286 * @see elm_layout_file_set()
10287 * @see elm_layout_theme_set()
10291 EAPI Evas_Object *elm_layout_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10293 * Set the file that will be used as layout
10295 * @param obj The layout object
10296 * @param file The path to file (edj) that will be used as layout
10297 * @param group The group that the layout belongs in edje file
10299 * @return (1 = success, 0 = error)
10303 EAPI Eina_Bool elm_layout_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1);
10305 * Set the edje group from the elementary theme that will be used as layout
10307 * @param obj The layout object
10308 * @param clas the clas of the group
10309 * @param group the group
10310 * @param style the style to used
10312 * @return (1 = success, 0 = error)
10316 EAPI Eina_Bool elm_layout_theme_set(Evas_Object *obj, const char *clas, const char *group, const char *style) EINA_ARG_NONNULL(1);
10318 * Set the layout content.
10320 * @param obj The layout object
10321 * @param swallow The swallow part name in the edje file
10322 * @param content The child that will be added in this layout object
10324 * Once the content object is set, a previously set one will be deleted.
10325 * If you want to keep that old content object, use the
10326 * elm_object_part_content_unset() function.
10328 * @note In an Edje theme, the part used as a content container is called @c
10329 * SWALLOW. This is why the parameter name is called @p swallow, but it is
10330 * expected to be a part name just like the second parameter of
10331 * elm_layout_box_append().
10333 * @see elm_layout_box_append()
10334 * @see elm_object_part_content_get()
10335 * @see elm_object_part_content_unset()
10337 * @deprecated use elm_object_part_content_set() instead
10341 EINA_DEPRECATED EAPI void elm_layout_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content) EINA_ARG_NONNULL(1);
10343 * Get the child object in the given content part.
10345 * @param obj The layout object
10346 * @param swallow The SWALLOW part to get its content
10348 * @return The swallowed object or NULL if none or an error occurred
10350 * @deprecated use elm_object_part_content_get() instead
10354 EINA_DEPRECATED EAPI Evas_Object *elm_layout_content_get(const Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
10356 * Unset the layout content.
10358 * @param obj The layout object
10359 * @param swallow The swallow part name in the edje file
10360 * @return The content that was being used
10362 * Unparent and return the content object which was set for this part.
10364 * @deprecated use elm_object_part_content_unset() instead
10368 EINA_DEPRECATED EAPI Evas_Object *elm_layout_content_unset(Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
10370 * Set the text of the given part
10372 * @param obj The layout object
10373 * @param part The TEXT part where to set the text
10374 * @param text The text to set
10377 * @deprecated use elm_object_part_text_set() instead.
10379 EINA_DEPRECATED EAPI void elm_layout_text_set(Evas_Object *obj, const char *part, const char *text) EINA_ARG_NONNULL(1);
10381 * Get the text set in the given part
10383 * @param obj The layout object
10384 * @param part The TEXT part to retrieve the text off
10386 * @return The text set in @p part
10389 * @deprecated use elm_object_part_text_get() instead.
10391 EINA_DEPRECATED EAPI const char *elm_layout_text_get(const Evas_Object *obj, const char *part) EINA_ARG_NONNULL(1);
10393 * Append child to layout box part.
10395 * @param obj the layout object
10396 * @param part the box part to which the object will be appended.
10397 * @param child the child object to append to box.
10399 * Once the object is appended, it will become child of the layout. Its
10400 * lifetime will be bound to the layout, whenever the layout dies the child
10401 * will be deleted automatically. One should use elm_layout_box_remove() to
10402 * make this layout forget about the object.
10404 * @see elm_layout_box_prepend()
10405 * @see elm_layout_box_insert_before()
10406 * @see elm_layout_box_insert_at()
10407 * @see elm_layout_box_remove()
10411 EAPI void elm_layout_box_append(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1);
10413 * Prepend child to layout box part.
10415 * @param obj the layout object
10416 * @param part the box part to prepend.
10417 * @param child the child object to prepend to box.
10419 * Once the object is prepended, it will become child of the layout. Its
10420 * lifetime will be bound to the layout, whenever the layout dies the child
10421 * will be deleted automatically. One should use elm_layout_box_remove() to
10422 * make this layout forget about the object.
10424 * @see elm_layout_box_append()
10425 * @see elm_layout_box_insert_before()
10426 * @see elm_layout_box_insert_at()
10427 * @see elm_layout_box_remove()
10431 EAPI void elm_layout_box_prepend(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1);
10433 * Insert child to layout box part before a reference object.
10435 * @param obj the layout object
10436 * @param part the box part to insert.
10437 * @param child the child object to insert into box.
10438 * @param reference another reference object to insert before in box.
10440 * Once the object is inserted, it will become child of the layout. Its
10441 * lifetime will be bound to the layout, whenever the layout dies the child
10442 * will be deleted automatically. One should use elm_layout_box_remove() to
10443 * make this layout forget about the object.
10445 * @see elm_layout_box_append()
10446 * @see elm_layout_box_prepend()
10447 * @see elm_layout_box_insert_before()
10448 * @see elm_layout_box_remove()
10452 EAPI void elm_layout_box_insert_before(Evas_Object *obj, const char *part, Evas_Object *child, const Evas_Object *reference) EINA_ARG_NONNULL(1);
10454 * Insert child to layout box part at a given position.
10456 * @param obj the layout object
10457 * @param part the box part to insert.
10458 * @param child the child object to insert into box.
10459 * @param pos the numeric position >=0 to insert the child.
10461 * Once the object is inserted, it will become child of the layout. Its
10462 * lifetime will be bound to the layout, whenever the layout dies the child
10463 * will be deleted automatically. One should use elm_layout_box_remove() to
10464 * make this layout forget about the object.
10466 * @see elm_layout_box_append()
10467 * @see elm_layout_box_prepend()
10468 * @see elm_layout_box_insert_before()
10469 * @see elm_layout_box_remove()
10473 EAPI void elm_layout_box_insert_at(Evas_Object *obj, const char *part, Evas_Object *child, unsigned int pos) EINA_ARG_NONNULL(1);
10475 * Remove a child of the given part box.
10477 * @param obj The layout object
10478 * @param part The box part name to remove child.
10479 * @param child The object to remove from box.
10480 * @return The object that was being used, or NULL if not found.
10482 * The object will be removed from the box part and its lifetime will
10483 * not be handled by the layout anymore. This is equivalent to
10484 * elm_object_part_content_unset() for box.
10486 * @see elm_layout_box_append()
10487 * @see elm_layout_box_remove_all()
10491 EAPI Evas_Object *elm_layout_box_remove(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1, 2, 3);
10493 * Remove all children of the given part box.
10495 * @param obj The layout object
10496 * @param part The box part name to remove child.
10497 * @param clear If EINA_TRUE, then all objects will be deleted as
10498 * well, otherwise they will just be removed and will be
10499 * dangling on the canvas.
10501 * The objects will be removed from the box part and their lifetime will
10502 * not be handled by the layout anymore. This is equivalent to
10503 * elm_layout_box_remove() for all box children.
10505 * @see elm_layout_box_append()
10506 * @see elm_layout_box_remove()
10510 EAPI void elm_layout_box_remove_all(Evas_Object *obj, const char *part, Eina_Bool clear) EINA_ARG_NONNULL(1, 2);
10512 * Insert child to layout table part.
10514 * @param obj the layout object
10515 * @param part the box part to pack child.
10516 * @param child_obj the child object to pack into table.
10517 * @param col the column to which the child should be added. (>= 0)
10518 * @param row the row to which the child should be added. (>= 0)
10519 * @param colspan how many columns should be used to store this object. (>=
10521 * @param rowspan how many rows should be used to store this object. (>= 1)
10523 * Once the object is inserted, it will become child of the table. Its
10524 * lifetime will be bound to the layout, and whenever the layout dies the
10525 * child will be deleted automatically. One should use
10526 * elm_layout_table_remove() to make this layout forget about the object.
10528 * If @p colspan or @p rowspan are bigger than 1, that object will occupy
10529 * more space than a single cell. For instance, the following code:
10531 * elm_layout_table_pack(layout, "table_part", child, 0, 1, 3, 1);
10534 * Would result in an object being added like the following picture:
10536 * @image html layout_colspan.png
10537 * @image latex layout_colspan.eps width=\textwidth
10539 * @see elm_layout_table_unpack()
10540 * @see elm_layout_table_clear()
10544 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);
10546 * Unpack (remove) a child of the given part table.
10548 * @param obj The layout object
10549 * @param part The table part name to remove child.
10550 * @param child_obj The object to remove from table.
10551 * @return The object that was being used, or NULL if not found.
10553 * The object will be unpacked from the table part and its lifetime
10554 * will not be handled by the layout anymore. This is equivalent to
10555 * elm_object_part_content_unset() for table.
10557 * @see elm_layout_table_pack()
10558 * @see elm_layout_table_clear()
10562 EAPI Evas_Object *elm_layout_table_unpack(Evas_Object *obj, const char *part, Evas_Object *child_obj) EINA_ARG_NONNULL(1, 2, 3);
10564 * Remove all the child objects of the given part table.
10566 * @param obj The layout object
10567 * @param part The table part name to remove child.
10568 * @param clear If EINA_TRUE, then all objects will be deleted as
10569 * well, otherwise they will just be removed and will be
10570 * dangling on the canvas.
10572 * The objects will be removed from the table part and their lifetime will
10573 * not be handled by the layout anymore. This is equivalent to
10574 * elm_layout_table_unpack() for all table children.
10576 * @see elm_layout_table_pack()
10577 * @see elm_layout_table_unpack()
10581 EAPI void elm_layout_table_clear(Evas_Object *obj, const char *part, Eina_Bool clear) EINA_ARG_NONNULL(1, 2);
10583 * Get the edje layout
10585 * @param obj The layout object
10587 * @return A Evas_Object with the edje layout settings loaded
10588 * with function elm_layout_file_set
10590 * This returns the edje object. It is not expected to be used to then
10591 * swallow objects via edje_object_part_swallow() for example. Use
10592 * elm_object_part_content_set() instead so child object handling and sizing is
10595 * @note This function should only be used if you really need to call some
10596 * low level Edje function on this edje object. All the common stuff (setting
10597 * text, emitting signals, hooking callbacks to signals, etc.) can be done
10598 * with proper elementary functions.
10600 * @see elm_object_signal_callback_add()
10601 * @see elm_object_signal_emit()
10602 * @see elm_object_part_text_set()
10603 * @see elm_object_part_content_set()
10604 * @see elm_layout_box_append()
10605 * @see elm_layout_table_pack()
10606 * @see elm_layout_data_get()
10610 EAPI Evas_Object *elm_layout_edje_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10612 * Get the edje data from the given layout
10614 * @param obj The layout object
10615 * @param key The data key
10617 * @return The edje data string
10619 * This function fetches data specified inside the edje theme of this layout.
10620 * This function return NULL if data is not found.
10622 * In EDC this comes from a data block within the group block that @p
10623 * obj was loaded from. E.g.
10630 * item: "key1" "value1";
10631 * item: "key2" "value2";
10639 EAPI const char *elm_layout_data_get(const Evas_Object *obj, const char *key) EINA_ARG_NONNULL(1, 2);
10643 * @param obj The layout object
10645 * Manually forces a sizing re-evaluation. This is useful when the minimum
10646 * size required by the edje theme of this layout has changed. The change on
10647 * the minimum size required by the edje theme is not immediately reported to
10648 * the elementary layout, so one needs to call this function in order to tell
10649 * the widget (layout) that it needs to reevaluate its own size.
10651 * The minimum size of the theme is calculated based on minimum size of
10652 * parts, the size of elements inside containers like box and table, etc. All
10653 * of this can change due to state changes, and that's when this function
10654 * should be called.
10656 * Also note that a standard signal of "size,eval" "elm" emitted from the
10657 * edje object will cause this to happen too.
10661 EAPI void elm_layout_sizing_eval(Evas_Object *obj) EINA_ARG_NONNULL(1);
10664 * Sets a specific cursor for an edje part.
10666 * @param obj The layout object.
10667 * @param part_name a part from loaded edje group.
10668 * @param cursor cursor name to use, see Elementary_Cursor.h
10670 * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
10671 * part not exists or it has "mouse_events: 0".
10675 EAPI Eina_Bool elm_layout_part_cursor_set(Evas_Object *obj, const char *part_name, const char *cursor) EINA_ARG_NONNULL(1, 2);
10678 * Get the cursor to be shown when mouse is over an edje part
10680 * @param obj The layout object.
10681 * @param part_name a part from loaded edje group.
10682 * @return the cursor name.
10686 EAPI const char *elm_layout_part_cursor_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
10689 * Unsets a cursor previously set with elm_layout_part_cursor_set().
10691 * @param obj The layout object.
10692 * @param part_name a part from loaded edje group, that had a cursor set
10693 * with elm_layout_part_cursor_set().
10697 EAPI void elm_layout_part_cursor_unset(Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
10700 * Sets a specific cursor style for an edje part.
10702 * @param obj The layout object.
10703 * @param part_name a part from loaded edje group.
10704 * @param style the theme style to use (default, transparent, ...)
10706 * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
10707 * part not exists or it did not had a cursor set.
10711 EAPI Eina_Bool elm_layout_part_cursor_style_set(Evas_Object *obj, const char *part_name, const char *style) EINA_ARG_NONNULL(1, 2);
10714 * Gets a specific cursor style for an edje part.
10716 * @param obj The layout object.
10717 * @param part_name a part from loaded edje group.
10719 * @return the theme style in use, defaults to "default". If the
10720 * object does not have a cursor set, then NULL is returned.
10724 EAPI const char *elm_layout_part_cursor_style_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
10727 * Sets if the cursor set should be searched on the theme or should use
10728 * the provided by the engine, only.
10730 * @note before you set if should look on theme you should define a
10731 * cursor with elm_layout_part_cursor_set(). By default it will only
10732 * look for cursors provided by the engine.
10734 * @param obj The layout object.
10735 * @param part_name a part from loaded edje group.
10736 * @param engine_only if cursors should be just provided by the engine (EINA_TRUE)
10737 * or should also search on widget's theme as well (EINA_FALSE)
10739 * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
10740 * part not exists or it did not had a cursor set.
10744 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);
10747 * Gets a specific cursor engine_only for an edje part.
10749 * @param obj The layout object.
10750 * @param part_name a part from loaded edje group.
10752 * @return whenever the cursor is just provided by engine or also from theme.
10756 EAPI Eina_Bool elm_layout_part_cursor_engine_only_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
10759 * @def elm_layout_icon_set
10760 * Convenience macro to set the icon object in a layout that follows the
10761 * Elementary naming convention for its parts.
10765 #define elm_layout_icon_set(_ly, _obj) \
10768 elm_object_part_content_set((_ly), "elm.swallow.icon", (_obj)); \
10769 if ((_obj)) sig = "elm,state,icon,visible"; \
10770 else sig = "elm,state,icon,hidden"; \
10771 elm_object_signal_emit((_ly), sig, "elm"); \
10775 * @def elm_layout_icon_get
10776 * Convienience macro to get the icon object from a layout that follows the
10777 * Elementary naming convention for its parts.
10781 #define elm_layout_icon_get(_ly) \
10782 elm_object_part_content_get((_ly), "elm.swallow.icon")
10785 * @def elm_layout_end_set
10786 * Convienience macro to set the end object in a layout that follows the
10787 * Elementary naming convention for its parts.
10791 #define elm_layout_end_set(_ly, _obj) \
10794 elm_object_part_content_set((_ly), "elm.swallow.end", (_obj)); \
10795 if ((_obj)) sig = "elm,state,end,visible"; \
10796 else sig = "elm,state,end,hidden"; \
10797 elm_object_signal_emit((_ly), sig, "elm"); \
10801 * @def elm_layout_end_get
10802 * Convienience macro to get the end object in a layout that follows the
10803 * Elementary naming convention for its parts.
10807 #define elm_layout_end_get(_ly) \
10808 elm_object_part_content_get((_ly), "elm.swallow.end")
10811 * @def elm_layout_label_set
10812 * Convienience macro to set the label in a layout that follows the
10813 * Elementary naming convention for its parts.
10816 * @deprecated use elm_object_text_set() instead.
10818 #define elm_layout_label_set(_ly, _txt) \
10819 elm_layout_text_set((_ly), "elm.text", (_txt))
10822 * @def elm_layout_label_get
10823 * Convenience macro to get the label in a layout that follows the
10824 * Elementary naming convention for its parts.
10827 * @deprecated use elm_object_text_set() instead.
10829 #define elm_layout_label_get(_ly) \
10830 elm_layout_text_get((_ly), "elm.text")
10832 /* smart callbacks called:
10833 * "theme,changed" - when elm theme is changed.
10837 * @defgroup Notify Notify
10839 * @image html img/widget/notify/preview-00.png
10840 * @image latex img/widget/notify/preview-00.eps
10842 * Display a container in a particular region of the parent(top, bottom,
10843 * etc). A timeout can be set to automatically hide the notify. This is so
10844 * that, after an evas_object_show() on a notify object, if a timeout was set
10845 * on it, it will @b automatically get hidden after that time.
10847 * Signals that you can add callbacks for are:
10848 * @li "timeout" - when timeout happens on notify and it's hidden
10849 * @li "block,clicked" - when a click outside of the notify happens
10851 * Default contents parts of the notify widget that you can use for are:
10852 * @li "default" - A content of the notify
10854 * @ref tutorial_notify show usage of the API.
10859 * @brief Possible orient values for notify.
10861 * This values should be used in conjunction to elm_notify_orient_set() to
10862 * set the position in which the notify should appear(relative to its parent)
10863 * and in conjunction with elm_notify_orient_get() to know where the notify
10866 typedef enum _Elm_Notify_Orient
10868 ELM_NOTIFY_ORIENT_TOP, /**< Notify should appear in the top of parent, default */
10869 ELM_NOTIFY_ORIENT_CENTER, /**< Notify should appear in the center of parent */
10870 ELM_NOTIFY_ORIENT_BOTTOM, /**< Notify should appear in the bottom of parent */
10871 ELM_NOTIFY_ORIENT_LEFT, /**< Notify should appear in the left of parent */
10872 ELM_NOTIFY_ORIENT_RIGHT, /**< Notify should appear in the right of parent */
10873 ELM_NOTIFY_ORIENT_TOP_LEFT, /**< Notify should appear in the top left of parent */
10874 ELM_NOTIFY_ORIENT_TOP_RIGHT, /**< Notify should appear in the top right of parent */
10875 ELM_NOTIFY_ORIENT_BOTTOM_LEFT, /**< Notify should appear in the bottom left of parent */
10876 ELM_NOTIFY_ORIENT_BOTTOM_RIGHT, /**< Notify should appear in the bottom right of parent */
10877 ELM_NOTIFY_ORIENT_LAST /**< Sentinel value, @b don't use */
10878 } Elm_Notify_Orient;
10880 * @brief Add a new notify to the parent
10882 * @param parent The parent object
10883 * @return The new object or NULL if it cannot be created
10885 EAPI Evas_Object *elm_notify_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10887 * @brief Set the content of the notify widget
10889 * @param obj The notify object
10890 * @param content The content will be filled in this notify object
10892 * Once the content object is set, a previously set one will be deleted. If
10893 * you want to keep that old content object, use the
10894 * elm_notify_content_unset() function.
10896 * @deprecated use elm_object_content_set() instead
10899 EINA_DEPRECATED EAPI void elm_notify_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
10901 * @brief Unset the content of the notify widget
10903 * @param obj The notify object
10904 * @return The content that was being used
10906 * Unparent and return the content object which was set for this widget
10908 * @see elm_notify_content_set()
10909 * @deprecated use elm_object_content_unset() instead
10912 EINA_DEPRECATED EAPI Evas_Object *elm_notify_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
10914 * @brief Return the content of the notify widget
10916 * @param obj The notify object
10917 * @return The content that is being used
10919 * @see elm_notify_content_set()
10920 * @deprecated use elm_object_content_get() instead
10923 EINA_DEPRECATED EAPI Evas_Object *elm_notify_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10925 * @brief Set the notify parent
10927 * @param obj The notify object
10928 * @param content The new parent
10930 * Once the parent object is set, a previously set one will be disconnected
10933 EAPI void elm_notify_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
10935 * @brief Get the notify parent
10937 * @param obj The notify object
10938 * @return The parent
10940 * @see elm_notify_parent_set()
10942 EAPI Evas_Object *elm_notify_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10944 * @brief Set the orientation
10946 * @param obj The notify object
10947 * @param orient The new orientation
10949 * Sets the position in which the notify will appear in its parent.
10951 * @see @ref Elm_Notify_Orient for possible values.
10953 EAPI void elm_notify_orient_set(Evas_Object *obj, Elm_Notify_Orient orient) EINA_ARG_NONNULL(1);
10955 * @brief Return the orientation
10956 * @param obj The notify object
10957 * @return The orientation of the notification
10959 * @see elm_notify_orient_set()
10960 * @see Elm_Notify_Orient
10962 EAPI Elm_Notify_Orient elm_notify_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10964 * @brief Set the time interval after which the notify window is going to be
10967 * @param obj The notify object
10968 * @param time The timeout in seconds
10970 * This function sets a timeout and starts the timer controlling when the
10971 * notify is hidden. Since calling evas_object_show() on a notify restarts
10972 * the timer controlling when the notify is hidden, setting this before the
10973 * notify is shown will in effect mean starting the timer when the notify is
10976 * @note Set a value <= 0.0 to disable a running timer.
10978 * @note If the value > 0.0 and the notify is previously visible, the
10979 * timer will be started with this value, canceling any running timer.
10981 EAPI void elm_notify_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
10983 * @brief Return the timeout value (in seconds)
10984 * @param obj the notify object
10986 * @see elm_notify_timeout_set()
10988 EAPI double elm_notify_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10990 * @brief Sets whether events should be passed to by a click outside
10993 * @param obj The notify object
10994 * @param repeats EINA_TRUE Events are repeats, else no
10996 * When true if the user clicks outside the window the events will be caught
10997 * by the others widgets, else the events are blocked.
10999 * @note The default value is EINA_TRUE.
11001 EAPI void elm_notify_repeat_events_set(Evas_Object *obj, Eina_Bool repeat) EINA_ARG_NONNULL(1);
11003 * @brief Return true if events are repeat below the notify object
11004 * @param obj the notify object
11006 * @see elm_notify_repeat_events_set()
11008 EAPI Eina_Bool elm_notify_repeat_events_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11014 * @defgroup Hover Hover
11016 * @image html img/widget/hover/preview-00.png
11017 * @image latex img/widget/hover/preview-00.eps
11019 * A Hover object will hover over its @p parent object at the @p target
11020 * location. Anything in the background will be given a darker coloring to
11021 * indicate that the hover object is on top (at the default theme). When the
11022 * hover is clicked it is dismissed(hidden), if the contents of the hover are
11023 * clicked that @b doesn't cause the hover to be dismissed.
11025 * A Hover object has two parents. One parent that owns it during creation
11026 * and the other parent being the one over which the hover object spans.
11029 * @note The hover object will take up the entire space of @p target
11032 * Elementary has the following styles for the hover widget:
11036 * @li hoversel_vertical
11038 * The following are the available position for content:
11050 * Signals that you can add callbacks for are:
11051 * @li "clicked" - the user clicked the empty space in the hover to dismiss
11052 * @li "smart,changed" - a content object placed under the "smart"
11053 * policy was replaced to a new slot direction.
11055 * See @ref tutorial_hover for more information.
11059 typedef enum _Elm_Hover_Axis
11061 ELM_HOVER_AXIS_NONE, /**< ELM_HOVER_AXIS_NONE -- no prefered orientation */
11062 ELM_HOVER_AXIS_HORIZONTAL, /**< ELM_HOVER_AXIS_HORIZONTAL -- horizontal */
11063 ELM_HOVER_AXIS_VERTICAL, /**< ELM_HOVER_AXIS_VERTICAL -- vertical */
11064 ELM_HOVER_AXIS_BOTH /**< ELM_HOVER_AXIS_BOTH -- both */
11067 * @brief Adds a hover object to @p parent
11069 * @param parent The parent object
11070 * @return The hover object or NULL if one could not be created
11072 EAPI Evas_Object *elm_hover_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
11074 * @brief Sets the target object for the hover.
11076 * @param obj The hover object
11077 * @param target The object to center the hover onto.
11079 * This function will cause the hover to be centered on the target object.
11081 EAPI void elm_hover_target_set(Evas_Object *obj, Evas_Object *target) EINA_ARG_NONNULL(1);
11083 * @brief Gets the target object for the hover.
11085 * @param obj The hover object
11086 * @return The target object for the hover.
11088 * @see elm_hover_target_set()
11090 EAPI Evas_Object *elm_hover_target_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11092 * @brief Sets the parent object for the hover.
11094 * @param obj The hover object
11095 * @param parent The object to locate the hover over.
11097 * This function will cause the hover to take up the entire space that the
11098 * parent object fills.
11100 EAPI void elm_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
11102 * @brief Gets the parent object for the hover.
11104 * @param obj The hover object
11105 * @return The parent object to locate the hover over.
11107 * @see elm_hover_parent_set()
11109 EAPI Evas_Object *elm_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11111 * @brief Sets the content of the hover object and the direction in which it
11114 * @param obj The hover object
11115 * @param swallow The direction that the object will be displayed
11116 * at. Accepted values are "left", "top-left", "top", "top-right",
11117 * "right", "bottom-right", "bottom", "bottom-left", "middle" and
11119 * @param content The content to place at @p swallow
11121 * Once the content object is set for a given direction, a previously
11122 * set one (on the same direction) will be deleted. If you want to
11123 * keep that old content object, use the elm_hover_content_unset()
11126 * All directions may have contents at the same time, except for
11127 * "smart". This is a special placement hint and its use case
11128 * independs of the calculations coming from
11129 * elm_hover_best_content_location_get(). Its use is for cases when
11130 * one desires only one hover content, but with a dynamic special
11131 * placement within the hover area. The content's geometry, whenever
11132 * it changes, will be used to decide on a best location, not
11133 * extrapolating the hover's parent object view to show it in (still
11134 * being the hover's target determinant of its medium part -- move and
11135 * resize it to simulate finger sizes, for example). If one of the
11136 * directions other than "smart" are used, a previously content set
11137 * using it will be deleted, and vice-versa.
11139 EAPI void elm_hover_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content) EINA_ARG_NONNULL(1);
11141 * @brief Get the content of the hover object, in a given direction.
11143 * Return the content object which was set for this widget in the
11144 * @p swallow direction.
11146 * @param obj The hover object
11147 * @param swallow The direction that the object was display at.
11148 * @return The content that was being used
11150 * @see elm_hover_content_set()
11152 EAPI Evas_Object *elm_hover_content_get(const Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
11154 * @brief Unset the content of the hover object, in a given direction.
11156 * Unparent and return the content object set at @p swallow direction.
11158 * @param obj The hover object
11159 * @param swallow The direction that the object was display at.
11160 * @return The content that was being used.
11162 * @see elm_hover_content_set()
11164 EAPI Evas_Object *elm_hover_content_unset(Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
11166 * @brief Returns the best swallow location for content in the hover.
11168 * @param obj The hover object
11169 * @param pref_axis The preferred orientation axis for the hover object to use
11170 * @return The edje location to place content into the hover or @c
11173 * Best is defined here as the location at which there is the most available
11176 * @p pref_axis may be one of
11177 * - @c ELM_HOVER_AXIS_NONE -- no prefered orientation
11178 * - @c ELM_HOVER_AXIS_HORIZONTAL -- horizontal
11179 * - @c ELM_HOVER_AXIS_VERTICAL -- vertical
11180 * - @c ELM_HOVER_AXIS_BOTH -- both
11182 * If ELM_HOVER_AXIS_HORIZONTAL is choosen the returned position will
11183 * nescessarily be along the horizontal axis("left" or "right"). If
11184 * ELM_HOVER_AXIS_VERTICAL is choosen the returned position will nescessarily
11185 * be along the vertical axis("top" or "bottom"). Chossing
11186 * ELM_HOVER_AXIS_BOTH or ELM_HOVER_AXIS_NONE has the same effect and the
11187 * returned position may be in either axis.
11189 * @see elm_hover_content_set()
11191 EAPI const char *elm_hover_best_content_location_get(const Evas_Object *obj, Elm_Hover_Axis pref_axis) EINA_ARG_NONNULL(1);
11198 * @defgroup Entry Entry
11200 * @image html img/widget/entry/preview-00.png
11201 * @image latex img/widget/entry/preview-00.eps width=\textwidth
11202 * @image html img/widget/entry/preview-01.png
11203 * @image latex img/widget/entry/preview-01.eps width=\textwidth
11204 * @image html img/widget/entry/preview-02.png
11205 * @image latex img/widget/entry/preview-02.eps width=\textwidth
11206 * @image html img/widget/entry/preview-03.png
11207 * @image latex img/widget/entry/preview-03.eps width=\textwidth
11209 * An entry is a convenience widget which shows a box that the user can
11210 * enter text into. Entries by default don't scroll, so they grow to
11211 * accomodate the entire text, resizing the parent window as needed. This
11212 * can be changed with the elm_entry_scrollable_set() function.
11214 * They can also be single line or multi line (the default) and when set
11215 * to multi line mode they support text wrapping in any of the modes
11216 * indicated by #Elm_Wrap_Type.
11218 * Other features include password mode, filtering of inserted text with
11219 * elm_entry_text_filter_append() and related functions, inline "items" and
11220 * formatted markup text.
11222 * @section entry-markup Formatted text
11224 * The markup tags supported by the Entry are defined by the theme, but
11225 * even when writing new themes or extensions it's a good idea to stick to
11226 * a sane default, to maintain coherency and avoid application breakages.
11227 * Currently defined by the default theme are the following tags:
11228 * @li \<br\>: Inserts a line break.
11229 * @li \<ps\>: Inserts a paragraph separator. This is preferred over line
11231 * @li \<tab\>: Inserts a tab.
11232 * @li \<em\>...\</em\>: Emphasis. Sets the @em oblique style for the
11234 * @li \<b\>...\</b\>: Sets the @b bold style for the enclosed text.
11235 * @li \<link\>...\</link\>: Underlines the enclosed text.
11236 * @li \<hilight\>...\</hilight\>: Hilights the enclosed text.
11238 * @section entry-special Special markups
11240 * Besides those used to format text, entries support two special markup
11241 * tags used to insert clickable portions of text or items inlined within
11244 * @subsection entry-anchors Anchors
11246 * Anchors are similar to HTML anchors. Text can be surrounded by \<a\> and
11247 * \</a\> tags and an event will be generated when this text is clicked,
11251 * This text is outside <a href=anc-01>but this one is an anchor</a>
11254 * The @c href attribute in the opening tag gives the name that will be
11255 * used to identify the anchor and it can be any valid utf8 string.
11257 * When an anchor is clicked, an @c "anchor,clicked" signal is emitted with
11258 * an #Elm_Entry_Anchor_Info in the @c event_info parameter for the
11259 * callback function. The same applies for "anchor,in" (mouse in), "anchor,out"
11260 * (mouse out), "anchor,down" (mouse down), and "anchor,up" (mouse up) events on
11263 * @subsection entry-items Items
11265 * Inlined in the text, any other @c Evas_Object can be inserted by using
11266 * \<item\> tags this way:
11269 * <item size=16x16 vsize=full href=emoticon/haha></item>
11272 * Just like with anchors, the @c href identifies each item, but these need,
11273 * in addition, to indicate their size, which is done using any one of
11274 * @c size, @c absize or @c relsize attributes. These attributes take their
11275 * value in the WxH format, where W is the width and H the height of the
11278 * @li absize: Absolute pixel size for the item. Whatever value is set will
11279 * be the item's size regardless of any scale value the object may have
11280 * been set to. The final line height will be adjusted to fit larger items.
11281 * @li size: Similar to @c absize, but it's adjusted to the scale value set
11283 * @li relsize: Size is adjusted for the item to fit within the current
11286 * Besides their size, items are specificed a @c vsize value that affects
11287 * how their final size and position are calculated. The possible values
11289 * @li ascent: Item will be placed within the line's baseline and its
11290 * ascent. That is, the height between the line where all characters are
11291 * positioned and the highest point in the line. For @c size and @c absize
11292 * items, the descent value will be added to the total line height to make
11293 * them fit. @c relsize items will be adjusted to fit within this space.
11294 * @li full: Items will be placed between the descent and ascent, or the
11295 * lowest point in the line and its highest.
11297 * The next image shows different configurations of items and how
11298 * the previously mentioned options affect their sizes. In all cases,
11299 * the green line indicates the ascent, blue for the baseline and red for
11302 * @image html entry_item.png
11303 * @image latex entry_item.eps width=\textwidth
11305 * And another one to show how size differs from absize. In the first one,
11306 * the scale value is set to 1.0, while the second one is using one of 2.0.
11308 * @image html entry_item_scale.png
11309 * @image latex entry_item_scale.eps width=\textwidth
11311 * After the size for an item is calculated, the entry will request an
11312 * object to place in its space. For this, the functions set with
11313 * elm_entry_item_provider_append() and related functions will be called
11314 * in order until one of them returns a @c non-NULL value. If no providers
11315 * are available, or all of them return @c NULL, then the entry falls back
11316 * to one of the internal defaults, provided the name matches with one of
11319 * All of the following are currently supported:
11322 * - emoticon/angry-shout
11323 * - emoticon/crazy-laugh
11324 * - emoticon/evil-laugh
11326 * - emoticon/goggle-smile
11327 * - emoticon/grumpy
11328 * - emoticon/grumpy-smile
11329 * - emoticon/guilty
11330 * - emoticon/guilty-smile
11332 * - emoticon/half-smile
11333 * - emoticon/happy-panting
11335 * - emoticon/indifferent
11337 * - emoticon/knowing-grin
11339 * - emoticon/little-bit-sorry
11340 * - emoticon/love-lots
11342 * - emoticon/minimal-smile
11343 * - emoticon/not-happy
11344 * - emoticon/not-impressed
11346 * - emoticon/opensmile
11349 * - emoticon/squint-laugh
11350 * - emoticon/surprised
11351 * - emoticon/suspicious
11352 * - emoticon/tongue-dangling
11353 * - emoticon/tongue-poke
11355 * - emoticon/unhappy
11356 * - emoticon/very-sorry
11359 * - emoticon/worried
11362 * Alternatively, an item may reference an image by its path, using
11363 * the URI form @c file:///path/to/an/image.png and the entry will then
11364 * use that image for the item.
11366 * @section entry-files Loading and saving files
11368 * Entries have convinience functions to load text from a file and save
11369 * changes back to it after a short delay. The automatic saving is enabled
11370 * by default, but can be disabled with elm_entry_autosave_set() and files
11371 * can be loaded directly as plain text or have any markup in them
11372 * recognized. See elm_entry_file_set() for more details.
11374 * @section entry-signals Emitted signals
11376 * This widget emits the following signals:
11378 * @li "changed": The text within the entry was changed.
11379 * @li "changed,user": The text within the entry was changed because of user interaction.
11380 * @li "activated": The enter key was pressed on a single line entry.
11381 * @li "press": A mouse button has been pressed on the entry.
11382 * @li "longpressed": A mouse button has been pressed and held for a couple
11384 * @li "clicked": The entry has been clicked (mouse press and release).
11385 * @li "clicked,double": The entry has been double clicked.
11386 * @li "clicked,triple": The entry has been triple clicked.
11387 * @li "focused": The entry has received focus.
11388 * @li "unfocused": The entry has lost focus.
11389 * @li "selection,paste": A paste of the clipboard contents was requested.
11390 * @li "selection,copy": A copy of the selected text into the clipboard was
11392 * @li "selection,cut": A cut of the selected text into the clipboard was
11394 * @li "selection,start": A selection has begun and no previous selection
11396 * @li "selection,changed": The current selection has changed.
11397 * @li "selection,cleared": The current selection has been cleared.
11398 * @li "cursor,changed": The cursor has changed position.
11399 * @li "anchor,clicked": An anchor has been clicked. The event_info
11400 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
11401 * @li "anchor,in": Mouse cursor has moved into an anchor. The event_info
11402 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
11403 * @li "anchor,out": Mouse cursor has moved out of an anchor. The event_info
11404 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
11405 * @li "anchor,up": Mouse button has been unpressed on an anchor. The event_info
11406 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
11407 * @li "anchor,down": Mouse button has been pressed on an anchor. The event_info
11408 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
11409 * @li "preedit,changed": The preedit string has changed.
11410 * @li "language,changed": Program language changed.
11412 * @section entry-examples
11414 * An overview of the Entry API can be seen in @ref entry_example_01
11419 * @typedef Elm_Entry_Anchor_Info
11421 * The info sent in the callback for the "anchor,clicked" signals emitted
11424 typedef struct _Elm_Entry_Anchor_Info Elm_Entry_Anchor_Info;
11426 * @struct _Elm_Entry_Anchor_Info
11428 * The info sent in the callback for the "anchor,clicked" signals emitted
11431 struct _Elm_Entry_Anchor_Info
11433 const char *name; /**< The name of the anchor, as stated in its href */
11434 int button; /**< The mouse button used to click on it */
11435 Evas_Coord x, /**< Anchor geometry, relative to canvas */
11436 y, /**< Anchor geometry, relative to canvas */
11437 w, /**< Anchor geometry, relative to canvas */
11438 h; /**< Anchor geometry, relative to canvas */
11441 * @typedef Elm_Entry_Filter_Cb
11442 * This callback type is used by entry filters to modify text.
11443 * @param data The data specified as the last param when adding the filter
11444 * @param entry The entry object
11445 * @param text A pointer to the location of the text being filtered. This data can be modified,
11446 * but any additional allocations must be managed by the user.
11447 * @see elm_entry_text_filter_append
11448 * @see elm_entry_text_filter_prepend
11450 typedef void (*Elm_Entry_Filter_Cb)(void *data, Evas_Object *entry, char **text);
11453 * @typedef Elm_Entry_Change_Info
11454 * This corresponds to Edje_Entry_Change_Info. Includes information about
11455 * a change in the entry.
11457 typedef Edje_Entry_Change_Info Elm_Entry_Change_Info;
11461 * This adds an entry to @p parent object.
11463 * By default, entries are:
11467 * @li autosave is enabled
11469 * @param parent The parent object
11470 * @return The new object or NULL if it cannot be created
11472 EAPI Evas_Object *elm_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
11474 * Sets the entry to single line mode.
11476 * In single line mode, entries don't ever wrap when the text reaches the
11477 * edge, and instead they keep growing horizontally. Pressing the @c Enter
11478 * key will generate an @c "activate" event instead of adding a new line.
11480 * When @p single_line is @c EINA_FALSE, line wrapping takes effect again
11481 * and pressing enter will break the text into a different line
11482 * without generating any events.
11484 * @param obj The entry object
11485 * @param single_line If true, the text in the entry
11486 * will be on a single line.
11488 EAPI void elm_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line) EINA_ARG_NONNULL(1);
11490 * Gets whether the entry is set to be single line.
11492 * @param obj The entry object
11493 * @return single_line If true, the text in the entry is set to display
11494 * on a single line.
11496 * @see elm_entry_single_line_set()
11498 EAPI Eina_Bool elm_entry_single_line_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11500 * Sets the entry to password mode.
11502 * In password mode, entries are implicitly single line and the display of
11503 * any text in them is replaced with asterisks (*).
11505 * @param obj The entry object
11506 * @param password If true, password mode is enabled.
11508 EAPI void elm_entry_password_set(Evas_Object *obj, Eina_Bool password) EINA_ARG_NONNULL(1);
11510 * Gets whether the entry is set to password mode.
11512 * @param obj The entry object
11513 * @return If true, the entry is set to display all characters
11514 * as asterisks (*).
11516 * @see elm_entry_password_set()
11518 EAPI Eina_Bool elm_entry_password_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11520 * This sets the text displayed within the entry to @p entry.
11522 * @param obj The entry object
11523 * @param entry The text to be displayed
11525 * @deprecated Use elm_object_text_set() instead.
11526 * @note Using this function bypasses text filters
11528 EAPI void elm_entry_entry_set(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
11530 * This returns the text currently shown in object @p entry.
11531 * See also elm_entry_entry_set().
11533 * @param obj The entry object
11534 * @return The currently displayed text or NULL on failure
11536 * @deprecated Use elm_object_text_get() instead.
11538 EAPI const char *elm_entry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11540 * Appends @p entry to the text of the entry.
11542 * Adds the text in @p entry to the end of any text already present in the
11545 * The appended text is subject to any filters set for the widget.
11547 * @param obj The entry object
11548 * @param entry The text to be displayed
11550 * @see elm_entry_text_filter_append()
11552 EAPI void elm_entry_entry_append(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
11554 * Gets whether the entry is empty.
11556 * Empty means no text at all. If there are any markup tags, like an item
11557 * tag for which no provider finds anything, and no text is displayed, this
11558 * function still returns EINA_FALSE.
11560 * @param obj The entry object
11561 * @return EINA_TRUE if the entry is empty, EINA_FALSE otherwise.
11563 EAPI Eina_Bool elm_entry_is_empty(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11565 * Gets any selected text within the entry.
11567 * If there's any selected text in the entry, this function returns it as
11568 * a string in markup format. NULL is returned if no selection exists or
11569 * if an error occurred.
11571 * The returned value points to an internal string and should not be freed
11572 * or modified in any way. If the @p entry object is deleted or its
11573 * contents are changed, the returned pointer should be considered invalid.
11575 * @param obj The entry object
11576 * @return The selected text within the entry or NULL on failure
11578 EAPI const char *elm_entry_selection_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11580 * Returns the actual textblock object of the entry.
11582 * This function exposes the internal textblock object that actually
11583 * contains and draws the text. This should be used for low-level
11584 * manipulations that are otherwise not possible.
11586 * Changing the textblock directly from here will not notify edje/elm to
11587 * recalculate the textblock size automatically, so any modifications
11588 * done to the textblock returned by this function should be followed by
11589 * a call to elm_entry_calc_force().
11591 * The return value is marked as const as an additional warning.
11592 * One should not use the returned object with any of the generic evas
11593 * functions (geometry_get/resize/move and etc), but only with the textblock
11594 * functions; The former will either not work at all, or break the correct
11597 * IMPORTANT: Many functions may change (i.e delete and create a new one)
11598 * the internal textblock object. Do NOT cache the returned object, and try
11599 * not to mix calls on this object with regular elm_entry calls (which may
11600 * change the internal textblock object). This applies to all cursors
11601 * returned from textblock calls, and all the other derivative values.
11603 * @param obj The entry object
11604 * @return The textblock object.
11606 EAPI const Evas_Object *elm_entry_textblock_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11608 * Forces calculation of the entry size and text layouting.
11610 * This should be used after modifying the textblock object directly. See
11611 * elm_entry_textblock_get() for more information.
11613 * @param obj The entry object
11615 * @see elm_entry_textblock_get()
11617 EAPI void elm_entry_calc_force(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11619 * Inserts the given text into the entry at the current cursor position.
11621 * This inserts text at the cursor position as if it was typed
11622 * by the user (note that this also allows markup which a user
11623 * can't just "type" as it would be converted to escaped text, so this
11624 * call can be used to insert things like emoticon items or bold push/pop
11625 * tags, other font and color change tags etc.)
11627 * If any selection exists, it will be replaced by the inserted text.
11629 * The inserted text is subject to any filters set for the widget.
11631 * @param obj The entry object
11632 * @param entry The text to insert
11634 * @see elm_entry_text_filter_append()
11636 EAPI void elm_entry_entry_insert(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
11638 * Set the line wrap type to use on multi-line entries.
11640 * Sets the wrap type used by the entry to any of the specified in
11641 * #Elm_Wrap_Type. This tells how the text will be implicitly cut into a new
11642 * line (without inserting a line break or paragraph separator) when it
11643 * reaches the far edge of the widget.
11645 * Note that this only makes sense for multi-line entries. A widget set
11646 * to be single line will never wrap.
11648 * @param obj The entry object
11649 * @param wrap The wrap mode to use. See #Elm_Wrap_Type for details on them
11651 EAPI void elm_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
11653 * Gets the wrap mode the entry was set to use.
11655 * @param obj The entry object
11656 * @return Wrap type
11658 * @see also elm_entry_line_wrap_set()
11660 EAPI Elm_Wrap_Type elm_entry_line_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11662 * Sets if the entry is to be editable or not.
11664 * By default, entries are editable and when focused, any text input by the
11665 * user will be inserted at the current cursor position. But calling this
11666 * function with @p editable as EINA_FALSE will prevent the user from
11667 * inputting text into the entry.
11669 * The only way to change the text of a non-editable entry is to use
11670 * elm_object_text_set(), elm_entry_entry_insert() and other related
11673 * @param obj The entry object
11674 * @param editable If EINA_TRUE, user input will be inserted in the entry,
11675 * if not, the entry is read-only and no user input is allowed.
11677 EAPI void elm_entry_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
11679 * Gets whether the entry is editable or not.
11681 * @param obj The entry object
11682 * @return If true, the entry is editable by the user.
11683 * If false, it is not editable by the user
11685 * @see elm_entry_editable_set()
11687 EAPI Eina_Bool elm_entry_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11689 * This drops any existing text selection within the entry.
11691 * @param obj The entry object
11693 EAPI void elm_entry_select_none(Evas_Object *obj) EINA_ARG_NONNULL(1);
11695 * This selects all text within the entry.
11697 * @param obj The entry object
11699 EAPI void elm_entry_select_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
11701 * This moves the cursor one place to the right within the entry.
11703 * @param obj The entry object
11704 * @return EINA_TRUE upon success, EINA_FALSE upon failure
11706 EAPI Eina_Bool elm_entry_cursor_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
11708 * This moves the cursor one place to the left within the entry.
11710 * @param obj The entry object
11711 * @return EINA_TRUE upon success, EINA_FALSE upon failure
11713 EAPI Eina_Bool elm_entry_cursor_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
11715 * This moves the cursor one line up within the entry.
11717 * @param obj The entry object
11718 * @return EINA_TRUE upon success, EINA_FALSE upon failure
11720 EAPI Eina_Bool elm_entry_cursor_up(Evas_Object *obj) EINA_ARG_NONNULL(1);
11722 * This moves the cursor one line down within the entry.
11724 * @param obj The entry object
11725 * @return EINA_TRUE upon success, EINA_FALSE upon failure
11727 EAPI Eina_Bool elm_entry_cursor_down(Evas_Object *obj) EINA_ARG_NONNULL(1);
11729 * This moves the cursor to the beginning of the entry.
11731 * @param obj The entry object
11733 EAPI void elm_entry_cursor_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
11735 * This moves the cursor to the end of the entry.
11737 * @param obj The entry object
11739 EAPI void elm_entry_cursor_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
11741 * This moves the cursor to the beginning of the current line.
11743 * @param obj The entry object
11745 EAPI void elm_entry_cursor_line_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
11747 * This moves the cursor to the end of the current line.
11749 * @param obj The entry object
11751 EAPI void elm_entry_cursor_line_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
11753 * This begins a selection within the entry as though
11754 * the user were holding down the mouse button to make a selection.
11756 * @param obj The entry object
11758 EAPI void elm_entry_cursor_selection_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
11760 * This ends a selection within the entry as though
11761 * the user had just released the mouse button while making a selection.
11763 * @param obj The entry object
11765 EAPI void elm_entry_cursor_selection_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
11767 * Gets whether a format node exists at the current cursor position.
11769 * A format node is anything that defines how the text is rendered. It can
11770 * be a visible format node, such as a line break or a paragraph separator,
11771 * or an invisible one, such as bold begin or end tag.
11772 * This function returns whether any format node exists at the current
11775 * @param obj The entry object
11776 * @return EINA_TRUE if the current cursor position contains a format node,
11777 * EINA_FALSE otherwise.
11779 * @see elm_entry_cursor_is_visible_format_get()
11781 EAPI Eina_Bool elm_entry_cursor_is_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11783 * Gets if the current cursor position holds a visible format node.
11785 * @param obj The entry object
11786 * @return EINA_TRUE if the current cursor is a visible format, EINA_FALSE
11787 * if it's an invisible one or no format exists.
11789 * @see elm_entry_cursor_is_format_get()
11791 EAPI Eina_Bool elm_entry_cursor_is_visible_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11793 * Gets the character pointed by the cursor at its current position.
11795 * This function returns a string with the utf8 character stored at the
11796 * current cursor position.
11797 * Only the text is returned, any format that may exist will not be part
11798 * of the return value.
11800 * @param obj The entry object
11801 * @return The text pointed by the cursors.
11803 EAPI const char *elm_entry_cursor_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11805 * This function returns the geometry of the cursor.
11807 * It's useful if you want to draw something on the cursor (or where it is),
11808 * or for example in the case of scrolled entry where you want to show the
11811 * @param obj The entry object
11812 * @param x returned geometry
11813 * @param y returned geometry
11814 * @param w returned geometry
11815 * @param h returned geometry
11816 * @return EINA_TRUE upon success, EINA_FALSE upon failure
11818 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);
11820 * Sets the cursor position in the entry to the given value
11822 * The value in @p pos is the index of the character position within the
11823 * contents of the string as returned by elm_entry_cursor_pos_get().
11825 * @param obj The entry object
11826 * @param pos The position of the cursor
11828 EAPI void elm_entry_cursor_pos_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
11830 * Retrieves the current position of the cursor in the entry
11832 * @param obj The entry object
11833 * @return The cursor position
11835 EAPI int elm_entry_cursor_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11837 * This executes a "cut" action on the selected text in the entry.
11839 * @param obj The entry object
11841 EAPI void elm_entry_selection_cut(Evas_Object *obj) EINA_ARG_NONNULL(1);
11843 * This executes a "copy" action on the selected text in the entry.
11845 * @param obj The entry object
11847 EAPI void elm_entry_selection_copy(Evas_Object *obj) EINA_ARG_NONNULL(1);
11849 * This executes a "paste" action in the entry.
11851 * @param obj The entry object
11853 EAPI void elm_entry_selection_paste(Evas_Object *obj) EINA_ARG_NONNULL(1);
11855 * This clears and frees the items in a entry's contextual (longpress)
11858 * @param obj The entry object
11860 * @see elm_entry_context_menu_item_add()
11862 EAPI void elm_entry_context_menu_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
11864 * This adds an item to the entry's contextual menu.
11866 * A longpress on an entry will make the contextual menu show up, if this
11867 * hasn't been disabled with elm_entry_context_menu_disabled_set().
11868 * By default, this menu provides a few options like enabling selection mode,
11869 * which is useful on embedded devices that need to be explicit about it,
11870 * and when a selection exists it also shows the copy and cut actions.
11872 * With this function, developers can add other options to this menu to
11873 * perform any action they deem necessary.
11875 * @param obj The entry object
11876 * @param label The item's text label
11877 * @param icon_file The item's icon file
11878 * @param icon_type The item's icon type
11879 * @param func The callback to execute when the item is clicked
11880 * @param data The data to associate with the item for related functions
11882 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);
11884 * This disables the entry's contextual (longpress) menu.
11886 * @param obj The entry object
11887 * @param disabled If true, the menu is disabled
11889 EAPI void elm_entry_context_menu_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
11891 * This returns whether the entry's contextual (longpress) menu is
11894 * @param obj The entry object
11895 * @return If true, the menu is disabled
11897 EAPI Eina_Bool elm_entry_context_menu_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11899 * This appends a custom item provider to the list for that entry
11901 * This appends the given callback. The list is walked from beginning to end
11902 * with each function called given the item href string in the text. If the
11903 * function returns an object handle other than NULL (it should create an
11904 * object to do this), then this object is used to replace that item. If
11905 * not the next provider is called until one provides an item object, or the
11906 * default provider in entry does.
11908 * @param obj The entry object
11909 * @param func The function called to provide the item object
11910 * @param data The data passed to @p func
11912 * @see @ref entry-items
11914 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);
11916 * This prepends a custom item provider to the list for that entry
11918 * This prepends the given callback. See elm_entry_item_provider_append() for
11921 * @param obj The entry object
11922 * @param func The function called to provide the item object
11923 * @param data The data passed to @p func
11925 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);
11927 * This removes a custom item provider to the list for that entry
11929 * This removes the given callback. See elm_entry_item_provider_append() for
11932 * @param obj The entry object
11933 * @param func The function called to provide the item object
11934 * @param data The data passed to @p func
11936 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);
11938 * Append a filter function for text inserted in the entry
11940 * Append the given callback to the list. This functions will be called
11941 * whenever any text is inserted into the entry, with the text to be inserted
11942 * as a parameter. The callback function is free to alter the text in any way
11943 * it wants, but it must remember to free the given pointer and update it.
11944 * If the new text is to be discarded, the function can free it and set its
11945 * text parameter to NULL. This will also prevent any following filters from
11948 * @param obj The entry object
11949 * @param func The function to use as text filter
11950 * @param data User data to pass to @p func
11952 EAPI void elm_entry_text_filter_append(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
11954 * Prepend a filter function for text insdrted in the entry
11956 * Prepend the given callback to the list. See elm_entry_text_filter_append()
11957 * for more information
11959 * @param obj The entry object
11960 * @param func The function to use as text filter
11961 * @param data User data to pass to @p func
11963 EAPI void elm_entry_text_filter_prepend(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
11965 * Remove a filter from the list
11967 * Removes the given callback from the filter list. See
11968 * elm_entry_text_filter_append() for more information.
11970 * @param obj The entry object
11971 * @param func The filter function to remove
11972 * @param data The user data passed when adding the function
11974 EAPI void elm_entry_text_filter_remove(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
11976 * This converts a markup (HTML-like) string into UTF-8.
11978 * The returned string is a malloc'ed buffer and it should be freed when
11979 * not needed anymore.
11981 * @param s The string (in markup) to be converted
11982 * @return The converted string (in UTF-8). It should be freed.
11984 EAPI char *elm_entry_markup_to_utf8(const char *s) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
11986 * This converts a UTF-8 string into markup (HTML-like).
11988 * The returned string is a malloc'ed buffer and it should be freed when
11989 * not needed anymore.
11991 * @param s The string (in UTF-8) to be converted
11992 * @return The converted string (in markup). It should be freed.
11994 EAPI char *elm_entry_utf8_to_markup(const char *s) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
11996 * This sets the file (and implicitly loads it) for the text to display and
11997 * then edit. All changes are written back to the file after a short delay if
11998 * the entry object is set to autosave (which is the default).
12000 * If the entry had any other file set previously, any changes made to it
12001 * will be saved if the autosave feature is enabled, otherwise, the file
12002 * will be silently discarded and any non-saved changes will be lost.
12004 * @param obj The entry object
12005 * @param file The path to the file to load and save
12006 * @param format The file format
12008 EAPI void elm_entry_file_set(Evas_Object *obj, const char *file, Elm_Text_Format format) EINA_ARG_NONNULL(1);
12010 * Gets the file being edited by the entry.
12012 * This function can be used to retrieve any file set on the entry for
12013 * edition, along with the format used to load and save it.
12015 * @param obj The entry object
12016 * @param file The path to the file to load and save
12017 * @param format The file format
12019 EAPI void elm_entry_file_get(const Evas_Object *obj, const char **file, Elm_Text_Format *format) EINA_ARG_NONNULL(1);
12021 * This function writes any changes made to the file set with
12022 * elm_entry_file_set()
12024 * @param obj The entry object
12026 EAPI void elm_entry_file_save(Evas_Object *obj) EINA_ARG_NONNULL(1);
12028 * This sets the entry object to 'autosave' the loaded text file or not.
12030 * @param obj The entry object
12031 * @param autosave Autosave the loaded file or not
12033 * @see elm_entry_file_set()
12035 EAPI void elm_entry_autosave_set(Evas_Object *obj, Eina_Bool autosave) EINA_ARG_NONNULL(1);
12037 * This gets the entry object's 'autosave' status.
12039 * @param obj The entry object
12040 * @return Autosave the loaded file or not
12042 * @see elm_entry_file_set()
12044 EAPI Eina_Bool elm_entry_autosave_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12046 * Control pasting of text and images for the widget.
12048 * Normally the entry allows both text and images to be pasted. By setting
12049 * textonly to be true, this prevents images from being pasted.
12051 * Note this only changes the behaviour of text.
12053 * @param obj The entry object
12054 * @param textonly paste mode - EINA_TRUE is text only, EINA_FALSE is
12055 * text+image+other.
12057 EAPI void elm_entry_cnp_textonly_set(Evas_Object *obj, Eina_Bool textonly) EINA_ARG_NONNULL(1);
12059 * Getting elm_entry text paste/drop mode.
12061 * In textonly mode, only text may be pasted or dropped into the widget.
12063 * @param obj The entry object
12064 * @return If the widget only accepts text from pastes.
12066 EAPI Eina_Bool elm_entry_cnp_textonly_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12068 * Enable or disable scrolling in entry
12070 * Normally the entry is not scrollable unless you enable it with this call.
12072 * @param obj The entry object
12073 * @param scroll EINA_TRUE if it is to be scrollable, EINA_FALSE otherwise
12075 EAPI void elm_entry_scrollable_set(Evas_Object *obj, Eina_Bool scroll);
12077 * Get the scrollable state of the entry
12079 * Normally the entry is not scrollable. This gets the scrollable state
12080 * of the entry. See elm_entry_scrollable_set() for more information.
12082 * @param obj The entry object
12083 * @return The scrollable state
12085 EAPI Eina_Bool elm_entry_scrollable_get(const Evas_Object *obj);
12087 * This sets a widget to be displayed to the left of a scrolled entry.
12089 * @param obj The scrolled entry object
12090 * @param icon The widget to display on the left side of the scrolled
12093 * @note A previously set widget will be destroyed.
12094 * @note If the object being set does not have minimum size hints set,
12095 * it won't get properly displayed.
12097 * @see elm_entry_end_set()
12099 EAPI void elm_entry_icon_set(Evas_Object *obj, Evas_Object *icon);
12101 * Gets the leftmost widget of the scrolled entry. This object is
12102 * owned by the scrolled entry and should not be modified.
12104 * @param obj The scrolled entry object
12105 * @return the left widget inside the scroller
12107 EAPI Evas_Object *elm_entry_icon_get(const Evas_Object *obj);
12109 * Unset the leftmost widget of the scrolled entry, unparenting and
12112 * @param obj The scrolled entry object
12113 * @return the previously set icon sub-object of this entry, on
12116 * @see elm_entry_icon_set()
12118 EAPI Evas_Object *elm_entry_icon_unset(Evas_Object *obj);
12120 * Sets the visibility of the left-side widget of the scrolled entry,
12121 * set by elm_entry_icon_set().
12123 * @param obj The scrolled entry object
12124 * @param setting EINA_TRUE if the object should be displayed,
12125 * EINA_FALSE if not.
12127 EAPI void elm_entry_icon_visible_set(Evas_Object *obj, Eina_Bool setting);
12129 * This sets a widget to be displayed to the end of a scrolled entry.
12131 * @param obj The scrolled entry object
12132 * @param end The widget to display on the right side of the scrolled
12135 * @note A previously set widget will be destroyed.
12136 * @note If the object being set does not have minimum size hints set,
12137 * it won't get properly displayed.
12139 * @see elm_entry_icon_set
12141 EAPI void elm_entry_end_set(Evas_Object *obj, Evas_Object *end);
12143 * Gets the endmost widget of the scrolled entry. This object is owned
12144 * by the scrolled entry and should not be modified.
12146 * @param obj The scrolled entry object
12147 * @return the right widget inside the scroller
12149 EAPI Evas_Object *elm_entry_end_get(const Evas_Object *obj);
12151 * Unset the endmost widget of the scrolled entry, unparenting and
12154 * @param obj The scrolled entry object
12155 * @return the previously set icon sub-object of this entry, on
12158 * @see elm_entry_icon_set()
12160 EAPI Evas_Object *elm_entry_end_unset(Evas_Object *obj);
12162 * Sets the visibility of the end widget of the scrolled entry, set by
12163 * elm_entry_end_set().
12165 * @param obj The scrolled entry object
12166 * @param setting EINA_TRUE if the object should be displayed,
12167 * EINA_FALSE if not.
12169 EAPI void elm_entry_end_visible_set(Evas_Object *obj, Eina_Bool setting);
12171 * This sets the scrolled entry's scrollbar policy (ie. enabling/disabling
12174 * Setting an entry to single-line mode with elm_entry_single_line_set()
12175 * will automatically disable the display of scrollbars when the entry
12176 * moves inside its scroller.
12178 * @param obj The scrolled entry object
12179 * @param h The horizontal scrollbar policy to apply
12180 * @param v The vertical scrollbar policy to apply
12182 EAPI void elm_entry_scrollbar_policy_set(Evas_Object *obj, Elm_Scroller_Policy h, Elm_Scroller_Policy v);
12184 * This enables/disables bouncing within the entry.
12186 * This function sets whether the entry will bounce when scrolling reaches
12187 * the end of the contained entry.
12189 * @param obj The scrolled entry object
12190 * @param h The horizontal bounce state
12191 * @param v The vertical bounce state
12193 EAPI void elm_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce);
12195 * Get the bounce mode
12197 * @param obj The Entry object
12198 * @param h_bounce Allow bounce horizontally
12199 * @param v_bounce Allow bounce vertically
12201 EAPI void elm_entry_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce);
12203 /* pre-made filters for entries */
12205 * @typedef Elm_Entry_Filter_Limit_Size
12207 * Data for the elm_entry_filter_limit_size() entry filter.
12209 typedef struct _Elm_Entry_Filter_Limit_Size Elm_Entry_Filter_Limit_Size;
12211 * @struct _Elm_Entry_Filter_Limit_Size
12213 * Data for the elm_entry_filter_limit_size() entry filter.
12215 struct _Elm_Entry_Filter_Limit_Size
12217 int max_char_count; /**< The maximum number of characters allowed. */
12218 int max_byte_count; /**< The maximum number of bytes allowed*/
12221 * Filter inserted text based on user defined character and byte limits
12223 * Add this filter to an entry to limit the characters that it will accept
12224 * based the the contents of the provided #Elm_Entry_Filter_Limit_Size.
12225 * The funtion works on the UTF-8 representation of the string, converting
12226 * it from the set markup, thus not accounting for any format in it.
12228 * The user must create an #Elm_Entry_Filter_Limit_Size structure and pass
12229 * it as data when setting the filter. In it, it's possible to set limits
12230 * by character count or bytes (any of them is disabled if 0), and both can
12231 * be set at the same time. In that case, it first checks for characters,
12234 * The function will cut the inserted text in order to allow only the first
12235 * number of characters that are still allowed. The cut is made in
12236 * characters, even when limiting by bytes, in order to always contain
12237 * valid ones and avoid half unicode characters making it in.
12239 * This filter, like any others, does not apply when setting the entry text
12240 * directly with elm_object_text_set() (or the deprecated
12241 * elm_entry_entry_set()).
12243 EAPI void elm_entry_filter_limit_size(void *data, Evas_Object *entry, char **text) EINA_ARG_NONNULL(1, 2, 3);
12245 * @typedef Elm_Entry_Filter_Accept_Set
12247 * Data for the elm_entry_filter_accept_set() entry filter.
12249 typedef struct _Elm_Entry_Filter_Accept_Set Elm_Entry_Filter_Accept_Set;
12251 * @struct _Elm_Entry_Filter_Accept_Set
12253 * Data for the elm_entry_filter_accept_set() entry filter.
12255 struct _Elm_Entry_Filter_Accept_Set
12257 const char *accepted; /**< Set of characters accepted in the entry. */
12258 const char *rejected; /**< Set of characters rejected from the entry. */
12261 * Filter inserted text based on accepted or rejected sets of characters
12263 * Add this filter to an entry to restrict the set of accepted characters
12264 * based on the sets in the provided #Elm_Entry_Filter_Accept_Set.
12265 * This structure contains both accepted and rejected sets, but they are
12266 * mutually exclusive.
12268 * The @c accepted set takes preference, so if it is set, the filter will
12269 * only work based on the accepted characters, ignoring anything in the
12270 * @c rejected value. If @c accepted is @c NULL, then @c rejected is used.
12272 * In both cases, the function filters by matching utf8 characters to the
12273 * raw markup text, so it can be used to remove formatting tags.
12275 * This filter, like any others, does not apply when setting the entry text
12276 * directly with elm_object_text_set() (or the deprecated
12277 * elm_entry_entry_set()).
12279 EAPI void elm_entry_filter_accept_set(void *data, Evas_Object *entry, char **text) EINA_ARG_NONNULL(1, 3);
12281 * Set the input panel layout of the entry
12283 * @param obj The entry object
12284 * @param layout layout type
12286 EAPI void elm_entry_input_panel_layout_set(Evas_Object *obj, Elm_Input_Panel_Layout layout) EINA_ARG_NONNULL(1);
12288 * Get the input panel layout of the entry
12290 * @param obj The entry object
12291 * @return layout type
12293 * @see elm_entry_input_panel_layout_set
12295 EAPI Elm_Input_Panel_Layout elm_entry_input_panel_layout_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
12297 * Set the autocapitalization type on the immodule.
12299 * @param obj The entry object
12300 * @param autocapital_type The type of autocapitalization
12302 EAPI void elm_entry_autocapital_type_set(Evas_Object *obj, Elm_Autocapital_Type autocapital_type) EINA_ARG_NONNULL(1);
12304 * Retrieve the autocapitalization type on the immodule.
12306 * @param obj The entry object
12307 * @return autocapitalization type
12309 EAPI Elm_Autocapital_Type elm_entry_autocapital_type_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
12311 * Sets the attribute to show the input panel automatically.
12313 * @param obj The entry object
12314 * @param enabled If true, the input panel is appeared when entry is clicked or has a focus
12316 EAPI void elm_entry_input_panel_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
12318 * Retrieve the attribute to show the input panel automatically.
12320 * @param obj The entry object
12321 * @return EINA_TRUE if input panel will be appeared when the entry is clicked or has a focus, EINA_FALSE otherwise
12323 EAPI Eina_Bool elm_entry_input_panel_enabled_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
12329 /* composite widgets - these basically put together basic widgets above
12330 * in convenient packages that do more than basic stuff */
12334 * @defgroup Anchorview Anchorview
12336 * @image html img/widget/anchorview/preview-00.png
12337 * @image latex img/widget/anchorview/preview-00.eps
12339 * Anchorview is for displaying text that contains markup with anchors
12340 * like <c>\<a href=1234\>something\</\></c> in it.
12342 * Besides being styled differently, the anchorview widget provides the
12343 * necessary functionality so that clicking on these anchors brings up a
12344 * popup with user defined content such as "call", "add to contacts" or
12345 * "open web page". This popup is provided using the @ref Hover widget.
12347 * This widget is very similar to @ref Anchorblock, so refer to that
12348 * widget for an example. The only difference Anchorview has is that the
12349 * widget is already provided with scrolling functionality, so if the
12350 * text set to it is too large to fit in the given space, it will scroll,
12351 * whereas the @ref Anchorblock widget will keep growing to ensure all the
12352 * text can be displayed.
12354 * This widget emits the following signals:
12355 * @li "anchor,clicked": will be called when an anchor is clicked. The
12356 * @p event_info parameter on the callback will be a pointer of type
12357 * ::Elm_Entry_Anchorview_Info.
12359 * See @ref Anchorblock for an example on how to use both of them.
12368 * @typedef Elm_Entry_Anchorview_Info
12370 * The info sent in the callback for "anchor,clicked" signals emitted by
12371 * the Anchorview widget.
12373 typedef struct _Elm_Entry_Anchorview_Info Elm_Entry_Anchorview_Info;
12375 * @struct _Elm_Entry_Anchorview_Info
12377 * The info sent in the callback for "anchor,clicked" signals emitted by
12378 * the Anchorview widget.
12380 struct _Elm_Entry_Anchorview_Info
12382 const char *name; /**< Name of the anchor, as indicated in its href
12384 int button; /**< The mouse button used to click on it */
12385 Evas_Object *hover; /**< The hover object to use for the popup */
12387 Evas_Coord x, y, w, h;
12388 } anchor, /**< Geometry selection of text used as anchor */
12389 hover_parent; /**< Geometry of the object used as parent by the
12391 Eina_Bool hover_left : 1; /**< Hint indicating if there's space
12392 for content on the left side of
12393 the hover. Before calling the
12394 callback, the widget will make the
12395 necessary calculations to check
12396 which sides are fit to be set with
12397 content, based on the position the
12398 hover is activated and its distance
12399 to the edges of its parent object
12401 Eina_Bool hover_right : 1; /**< Hint indicating content fits on
12402 the right side of the hover.
12403 See @ref hover_left */
12404 Eina_Bool hover_top : 1; /**< Hint indicating content fits on top
12405 of the hover. See @ref hover_left */
12406 Eina_Bool hover_bottom : 1; /**< Hint indicating content fits
12407 below the hover. See @ref
12411 * Add a new Anchorview object
12413 * @param parent The parent object
12414 * @return The new object or NULL if it cannot be created
12416 EAPI Evas_Object *elm_anchorview_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12418 * Set the text to show in the anchorview
12420 * Sets the text of the anchorview to @p text. This text can include markup
12421 * format tags, including <c>\<a href=anchorname\></c> to begin a segment of
12422 * text that will be specially styled and react to click events, ended with
12423 * either of \</a\> or \</\>. When clicked, the anchor will emit an
12424 * "anchor,clicked" signal that you can attach a callback to with
12425 * evas_object_smart_callback_add(). The name of the anchor given in the
12426 * event info struct will be the one set in the href attribute, in this
12427 * case, anchorname.
12429 * Other markup can be used to style the text in different ways, but it's
12430 * up to the style defined in the theme which tags do what.
12431 * @deprecated use elm_object_text_set() instead.
12433 EINA_DEPRECATED EAPI void elm_anchorview_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1);
12435 * Get the markup text set for the anchorview
12437 * Retrieves the text set on the anchorview, with markup tags included.
12439 * @param obj The anchorview object
12440 * @return The markup text set or @c NULL if nothing was set or an error
12442 * @deprecated use elm_object_text_set() instead.
12444 EINA_DEPRECATED EAPI const char *elm_anchorview_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12446 * Set the parent of the hover popup
12448 * Sets the parent object to use by the hover created by the anchorview
12449 * when an anchor is clicked. See @ref Hover for more details on this.
12450 * If no parent is set, the same anchorview object will be used.
12452 * @param obj The anchorview object
12453 * @param parent The object to use as parent for the hover
12455 EAPI void elm_anchorview_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
12457 * Get the parent of the hover popup
12459 * Get the object used as parent for the hover created by the anchorview
12460 * widget. See @ref Hover for more details on this.
12462 * @param obj The anchorview object
12463 * @return The object used as parent for the hover, NULL if none is set.
12465 EAPI Evas_Object *elm_anchorview_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12467 * Set the style that the hover should use
12469 * When creating the popup hover, anchorview will request that it's
12470 * themed according to @p style.
12472 * @param obj The anchorview object
12473 * @param style The style to use for the underlying hover
12475 * @see elm_object_style_set()
12477 EAPI void elm_anchorview_hover_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
12479 * Get the style that the hover should use
12481 * Get the style the hover created by anchorview will use.
12483 * @param obj The anchorview object
12484 * @return The style to use by the hover. NULL means the default is used.
12486 * @see elm_object_style_set()
12488 EAPI const char *elm_anchorview_hover_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12490 * Ends the hover popup in the anchorview
12492 * When an anchor is clicked, the anchorview widget will create a hover
12493 * object to use as a popup with user provided content. This function
12494 * terminates this popup, returning the anchorview to its normal state.
12496 * @param obj The anchorview object
12498 EAPI void elm_anchorview_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
12500 * Set bouncing behaviour when the scrolled content reaches an edge
12502 * Tell the internal scroller object whether it should bounce or not
12503 * when it reaches the respective edges for each axis.
12505 * @param obj The anchorview object
12506 * @param h_bounce Whether to bounce or not in the horizontal axis
12507 * @param v_bounce Whether to bounce or not in the vertical axis
12509 * @see elm_scroller_bounce_set()
12511 EAPI void elm_anchorview_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
12513 * Get the set bouncing behaviour of the internal scroller
12515 * Get whether the internal scroller should bounce when the edge of each
12516 * axis is reached scrolling.
12518 * @param obj The anchorview object
12519 * @param h_bounce Pointer where to store the bounce state of the horizontal
12521 * @param v_bounce Pointer where to store the bounce state of the vertical
12524 * @see elm_scroller_bounce_get()
12526 EAPI void elm_anchorview_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
12528 * Appends a custom item provider to the given anchorview
12530 * Appends the given function to the list of items providers. This list is
12531 * called, one function at a time, with the given @p data pointer, the
12532 * anchorview object and, in the @p item parameter, the item name as
12533 * referenced in its href string. Following functions in the list will be
12534 * called in order until one of them returns something different to NULL,
12535 * which should be an Evas_Object which will be used in place of the item
12538 * Items in the markup text take the form \<item relsize=16x16 vsize=full
12539 * href=item/name\>\</item\>
12541 * @param obj The anchorview object
12542 * @param func The function to add to the list of providers
12543 * @param data User data that will be passed to the callback function
12545 * @see elm_entry_item_provider_append()
12547 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);
12549 * Prepend a custom item provider to the given anchorview
12551 * Like elm_anchorview_item_provider_append(), but it adds the function
12552 * @p func to the beginning of the list, instead of the end.
12554 * @param obj The anchorview object
12555 * @param func The function to add to the list of providers
12556 * @param data User data that will be passed to the callback function
12558 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);
12560 * Remove a custom item provider from the list of the given anchorview
12562 * Removes the function and data pairing that matches @p func and @p data.
12563 * That is, unless the same function and same user data are given, the
12564 * function will not be removed from the list. This allows us to add the
12565 * same callback several times, with different @p data pointers and be
12566 * able to remove them later without conflicts.
12568 * @param obj The anchorview object
12569 * @param func The function to remove from the list
12570 * @param data The data matching the function to remove from the list
12572 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);
12579 * @defgroup Anchorblock Anchorblock
12581 * @image html img/widget/anchorblock/preview-00.png
12582 * @image latex img/widget/anchorblock/preview-00.eps
12584 * Anchorblock is for displaying text that contains markup with anchors
12585 * like <c>\<a href=1234\>something\</\></c> in it.
12587 * Besides being styled differently, the anchorblock widget provides the
12588 * necessary functionality so that clicking on these anchors brings up a
12589 * popup with user defined content such as "call", "add to contacts" or
12590 * "open web page". This popup is provided using the @ref Hover widget.
12592 * This widget emits the following signals:
12593 * @li "anchor,clicked": will be called when an anchor is clicked. The
12594 * @p event_info parameter on the callback will be a pointer of type
12595 * ::Elm_Entry_Anchorblock_Info.
12601 * Since examples are usually better than plain words, we might as well
12602 * try @ref tutorial_anchorblock_example "one".
12605 * @addtogroup Anchorblock
12609 * @typedef Elm_Entry_Anchorblock_Info
12611 * The info sent in the callback for "anchor,clicked" signals emitted by
12612 * the Anchorblock widget.
12614 typedef struct _Elm_Entry_Anchorblock_Info Elm_Entry_Anchorblock_Info;
12616 * @struct _Elm_Entry_Anchorblock_Info
12618 * The info sent in the callback for "anchor,clicked" signals emitted by
12619 * the Anchorblock widget.
12621 struct _Elm_Entry_Anchorblock_Info
12623 const char *name; /**< Name of the anchor, as indicated in its href
12625 int button; /**< The mouse button used to click on it */
12626 Evas_Object *hover; /**< The hover object to use for the popup */
12628 Evas_Coord x, y, w, h;
12629 } anchor, /**< Geometry selection of text used as anchor */
12630 hover_parent; /**< Geometry of the object used as parent by the
12632 Eina_Bool hover_left : 1; /**< Hint indicating if there's space
12633 for content on the left side of
12634 the hover. Before calling the
12635 callback, the widget will make the
12636 necessary calculations to check
12637 which sides are fit to be set with
12638 content, based on the position the
12639 hover is activated and its distance
12640 to the edges of its parent object
12642 Eina_Bool hover_right : 1; /**< Hint indicating content fits on
12643 the right side of the hover.
12644 See @ref hover_left */
12645 Eina_Bool hover_top : 1; /**< Hint indicating content fits on top
12646 of the hover. See @ref hover_left */
12647 Eina_Bool hover_bottom : 1; /**< Hint indicating content fits
12648 below the hover. See @ref
12652 * Add a new Anchorblock object
12654 * @param parent The parent object
12655 * @return The new object or NULL if it cannot be created
12657 EAPI Evas_Object *elm_anchorblock_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12659 * Set the text to show in the anchorblock
12661 * Sets the text of the anchorblock to @p text. This text can include markup
12662 * format tags, including <c>\<a href=anchorname\></a></c> to begin a segment
12663 * of text that will be specially styled and react to click events, ended
12664 * with either of \</a\> or \</\>. When clicked, the anchor will emit an
12665 * "anchor,clicked" signal that you can attach a callback to with
12666 * evas_object_smart_callback_add(). The name of the anchor given in the
12667 * event info struct will be the one set in the href attribute, in this
12668 * case, anchorname.
12670 * Other markup can be used to style the text in different ways, but it's
12671 * up to the style defined in the theme which tags do what.
12672 * @deprecated use elm_object_text_set() instead.
12674 EINA_DEPRECATED EAPI void elm_anchorblock_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1);
12676 * Get the markup text set for the anchorblock
12678 * Retrieves the text set on the anchorblock, with markup tags included.
12680 * @param obj The anchorblock object
12681 * @return The markup text set or @c NULL if nothing was set or an error
12683 * @deprecated use elm_object_text_set() instead.
12685 EINA_DEPRECATED EAPI const char *elm_anchorblock_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12687 * Set the parent of the hover popup
12689 * Sets the parent object to use by the hover created by the anchorblock
12690 * when an anchor is clicked. See @ref Hover for more details on this.
12692 * @param obj The anchorblock object
12693 * @param parent The object to use as parent for the hover
12695 EAPI void elm_anchorblock_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
12697 * Get the parent of the hover popup
12699 * Get the object used as parent for the hover created by the anchorblock
12700 * widget. See @ref Hover for more details on this.
12701 * If no parent is set, the same anchorblock object will be used.
12703 * @param obj The anchorblock object
12704 * @return The object used as parent for the hover, NULL if none is set.
12706 EAPI Evas_Object *elm_anchorblock_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12708 * Set the style that the hover should use
12710 * When creating the popup hover, anchorblock will request that it's
12711 * themed according to @p style.
12713 * @param obj The anchorblock object
12714 * @param style The style to use for the underlying hover
12716 * @see elm_object_style_set()
12718 EAPI void elm_anchorblock_hover_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
12720 * Get the style that the hover should use
12722 * Get the style, the hover created by anchorblock will use.
12724 * @param obj The anchorblock object
12725 * @return The style to use by the hover. NULL means the default is used.
12727 * @see elm_object_style_set()
12729 EAPI const char *elm_anchorblock_hover_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12731 * Ends the hover popup in the anchorblock
12733 * When an anchor is clicked, the anchorblock widget will create a hover
12734 * object to use as a popup with user provided content. This function
12735 * terminates this popup, returning the anchorblock to its normal state.
12737 * @param obj The anchorblock object
12739 EAPI void elm_anchorblock_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
12741 * Appends a custom item provider to the given anchorblock
12743 * Appends the given function to the list of items providers. This list is
12744 * called, one function at a time, with the given @p data pointer, the
12745 * anchorblock object and, in the @p item parameter, the item name as
12746 * referenced in its href string. Following functions in the list will be
12747 * called in order until one of them returns something different to NULL,
12748 * which should be an Evas_Object which will be used in place of the item
12751 * Items in the markup text take the form \<item relsize=16x16 vsize=full
12752 * href=item/name\>\</item\>
12754 * @param obj The anchorblock object
12755 * @param func The function to add to the list of providers
12756 * @param data User data that will be passed to the callback function
12758 * @see elm_entry_item_provider_append()
12760 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);
12762 * Prepend a custom item provider to the given anchorblock
12764 * Like elm_anchorblock_item_provider_append(), but it adds the function
12765 * @p func to the beginning of the list, instead of the end.
12767 * @param obj The anchorblock object
12768 * @param func The function to add to the list of providers
12769 * @param data User data that will be passed to the callback function
12771 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);
12773 * Remove a custom item provider from the list of the given anchorblock
12775 * Removes the function and data pairing that matches @p func and @p data.
12776 * That is, unless the same function and same user data are given, the
12777 * function will not be removed from the list. This allows us to add the
12778 * same callback several times, with different @p data pointers and be
12779 * able to remove them later without conflicts.
12781 * @param obj The anchorblock object
12782 * @param func The function to remove from the list
12783 * @param data The data matching the function to remove from the list
12785 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);
12791 * @defgroup Bubble Bubble
12793 * @image html img/widget/bubble/preview-00.png
12794 * @image latex img/widget/bubble/preview-00.eps
12795 * @image html img/widget/bubble/preview-01.png
12796 * @image latex img/widget/bubble/preview-01.eps
12797 * @image html img/widget/bubble/preview-02.png
12798 * @image latex img/widget/bubble/preview-02.eps
12800 * @brief The Bubble is a widget to show text similar to how speech is
12801 * represented in comics.
12803 * The bubble widget contains 5 important visual elements:
12804 * @li The frame is a rectangle with rounded edjes and an "arrow".
12805 * @li The @p icon is an image to which the frame's arrow points to.
12806 * @li The @p label is a text which appears to the right of the icon if the
12807 * corner is "top_left" or "bottom_left" and is right aligned to the frame
12809 * @li The @p info is a text which appears to the right of the label. Info's
12810 * font is of a ligther color than label.
12811 * @li The @p content is an evas object that is shown inside the frame.
12813 * The position of the arrow, icon, label and info depends on which corner is
12814 * selected. The four available corners are:
12815 * @li "top_left" - Default
12817 * @li "bottom_left"
12818 * @li "bottom_right"
12820 * Signals that you can add callbacks for are:
12821 * @li "clicked" - This is called when a user has clicked the bubble.
12823 * Default contents parts of the bubble that you can use for are:
12824 * @li "default" - A content of the bubble
12825 * @li "icon" - An icon of the bubble
12827 * Default text parts of the button widget that you can use for are:
12828 * @li NULL - Label of the bubble
12830 * For an example of using a buble see @ref bubble_01_example_page "this".
12836 * Add a new bubble to the parent
12838 * @param parent The parent object
12839 * @return The new object or NULL if it cannot be created
12841 * This function adds a text bubble to the given parent evas object.
12843 EAPI Evas_Object *elm_bubble_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12845 * Set the label of the bubble
12847 * @param obj The bubble object
12848 * @param label The string to set in the label
12850 * This function sets the title of the bubble. Where this appears depends on
12851 * the selected corner.
12852 * @deprecated use elm_object_text_set() instead.
12854 EINA_DEPRECATED EAPI void elm_bubble_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
12856 * Get the label of the bubble
12858 * @param obj The bubble object
12859 * @return The string of set in the label
12861 * This function gets the title of the bubble.
12862 * @deprecated use elm_object_text_get() instead.
12864 EINA_DEPRECATED EAPI const char *elm_bubble_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12866 * Set the info of the bubble
12868 * @param obj The bubble object
12869 * @param info The given info about the bubble
12871 * This function sets the info of the bubble. Where this appears depends on
12872 * the selected corner.
12873 * @deprecated use elm_object_part_text_set() instead. (with "info" as the parameter).
12875 EINA_DEPRECATED EAPI void elm_bubble_info_set(Evas_Object *obj, const char *info) EINA_ARG_NONNULL(1);
12877 * Get the info of the bubble
12879 * @param obj The bubble object
12881 * @return The "info" string of the bubble
12883 * This function gets the info text.
12884 * @deprecated use elm_object_part_text_get() instead. (with "info" as the parameter).
12886 EINA_DEPRECATED EAPI const char *elm_bubble_info_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12888 * Set the content to be shown in the bubble
12890 * Once the content object is set, a previously set one will be deleted.
12891 * If you want to keep the old content object, use the
12892 * elm_bubble_content_unset() function.
12894 * @param obj The bubble object
12895 * @param content The given content of the bubble
12897 * This function sets the content shown on the middle of the bubble.
12899 * @deprecated use elm_object_content_set() instead
12902 EINA_DEPRECATED EAPI void elm_bubble_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
12904 * Get the content shown in the bubble
12906 * Return the content object which is set for this widget.
12908 * @param obj The bubble object
12909 * @return The content that is being used
12911 * @deprecated use elm_object_content_get() instead
12914 EINA_DEPRECATED EAPI Evas_Object *elm_bubble_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12916 * Unset the content shown in the bubble
12918 * Unparent and return the content object which was set for this widget.
12920 * @param obj The bubble object
12921 * @return The content that was being used
12923 * @deprecated use elm_object_content_unset() instead
12926 EINA_DEPRECATED EAPI Evas_Object *elm_bubble_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
12928 * Set the icon of the bubble
12930 * Once the icon object is set, a previously set one will be deleted.
12931 * If you want to keep the old content object, use the
12932 * elm_icon_content_unset() function.
12934 * @param obj The bubble object
12935 * @param icon The given icon for the bubble
12937 * @deprecated use elm_object_part_content_set() instead
12940 EINA_DEPRECATED EAPI void elm_bubble_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
12942 * Get the icon of the bubble
12944 * @param obj The bubble object
12945 * @return The icon for the bubble
12947 * This function gets the icon shown on the top left of bubble.
12949 * @deprecated use elm_object_part_content_get() instead
12952 EINA_DEPRECATED EAPI Evas_Object *elm_bubble_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12954 * Unset the icon of the bubble
12956 * Unparent and return the icon object which was set for this widget.
12958 * @param obj The bubble object
12959 * @return The icon that was being used
12961 * @deprecated use elm_object_part_content_unset() instead
12964 EINA_DEPRECATED EAPI Evas_Object *elm_bubble_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
12966 * Set the corner of the bubble
12968 * @param obj The bubble object.
12969 * @param corner The given corner for the bubble.
12971 * This function sets the corner of the bubble. The corner will be used to
12972 * determine where the arrow in the frame points to and where label, icon and
12975 * Possible values for corner are:
12976 * @li "top_left" - Default
12978 * @li "bottom_left"
12979 * @li "bottom_right"
12981 EAPI void elm_bubble_corner_set(Evas_Object *obj, const char *corner) EINA_ARG_NONNULL(1, 2);
12983 * Get the corner of the bubble
12985 * @param obj The bubble object.
12986 * @return The given corner for the bubble.
12988 * This function gets the selected corner of the bubble.
12990 EAPI const char *elm_bubble_corner_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12996 * @defgroup Photo Photo
12998 * For displaying the photo of a person (contact). Simple, yet
12999 * with a very specific purpose.
13001 * Signals that you can add callbacks for are:
13003 * "clicked" - This is called when a user has clicked the photo
13004 * "drag,start" - Someone started dragging the image out of the object
13005 * "drag,end" - Dragged item was dropped (somewhere)
13011 * Add a new photo to the parent
13013 * @param parent The parent object
13014 * @return The new object or NULL if it cannot be created
13018 EAPI Evas_Object *elm_photo_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
13021 * Set the file that will be used as photo
13023 * @param obj The photo object
13024 * @param file The path to file that will be used as photo
13026 * @return (1 = success, 0 = error)
13030 EAPI Eina_Bool elm_photo_file_set(Evas_Object *obj, const char *file) EINA_ARG_NONNULL(1);
13033 * Set the file that will be used as thumbnail in the photo.
13035 * @param obj The photo object.
13036 * @param file The path to file that will be used as thumb.
13037 * @param group The key used in case of an EET file.
13041 EAPI void elm_photo_thumb_set(const Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
13044 * Set the size that will be used on the photo
13046 * @param obj The photo object
13047 * @param size The size that the photo will be
13051 EAPI void elm_photo_size_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
13054 * Set if the photo should be completely visible or not.
13056 * @param obj The photo object
13057 * @param fill if true the photo will be completely visible
13061 EAPI void elm_photo_fill_inside_set(Evas_Object *obj, Eina_Bool fill) EINA_ARG_NONNULL(1);
13064 * Set editability of the photo.
13066 * An editable photo can be dragged to or from, and can be cut or
13067 * pasted too. Note that pasting an image or dropping an item on
13068 * the image will delete the existing content.
13070 * @param obj The photo object.
13071 * @param set To set of clear editablity.
13073 EAPI void elm_photo_editable_set(Evas_Object *obj, Eina_Bool set) EINA_ARG_NONNULL(1);
13079 /* gesture layer */
13081 * @defgroup Elm_Gesture_Layer Gesture Layer
13082 * Gesture Layer Usage:
13084 * Use Gesture Layer to detect gestures.
13085 * The advantage is that you don't have to implement
13086 * gesture detection, just set callbacks of gesture state.
13087 * By using gesture layer we make standard interface.
13089 * In order to use Gesture Layer you start with @ref elm_gesture_layer_add
13090 * with a parent object parameter.
13091 * Next 'activate' gesture layer with a @ref elm_gesture_layer_attach
13092 * call. Usually with same object as target (2nd parameter).
13094 * Now you need to tell gesture layer what gestures you follow.
13095 * This is done with @ref elm_gesture_layer_cb_set call.
13096 * By setting the callback you actually saying to gesture layer:
13097 * I would like to know when the gesture @ref Elm_Gesture_Types
13098 * switches to state @ref Elm_Gesture_State.
13100 * Next, you need to implement the actual action that follows the input
13101 * in your callback.
13103 * Note that if you like to stop being reported about a gesture, just set
13104 * all callbacks referring this gesture to NULL.
13105 * (again with @ref elm_gesture_layer_cb_set)
13107 * The information reported by gesture layer to your callback is depending
13108 * on @ref Elm_Gesture_Types:
13109 * @ref Elm_Gesture_Taps_Info is the info reported for tap gestures:
13110 * @ref ELM_GESTURE_N_TAPS, @ref ELM_GESTURE_N_LONG_TAPS,
13111 * @ref ELM_GESTURE_N_DOUBLE_TAPS, @ref ELM_GESTURE_N_TRIPLE_TAPS.
13113 * @ref Elm_Gesture_Momentum_Info is info reported for momentum gestures:
13114 * @ref ELM_GESTURE_MOMENTUM.
13116 * @ref Elm_Gesture_Line_Info is the info reported for line gestures:
13117 * (this also contains @ref Elm_Gesture_Momentum_Info internal structure)
13118 * @ref ELM_GESTURE_N_LINES, @ref ELM_GESTURE_N_FLICKS.
13119 * Note that we consider a flick as a line-gesture that should be completed
13120 * in flick-time-limit as defined in @ref Config.
13122 * @ref Elm_Gesture_Zoom_Info is the info reported for @ref ELM_GESTURE_ZOOM gesture.
13124 * @ref Elm_Gesture_Rotate_Info is the info reported for @ref ELM_GESTURE_ROTATE gesture.
13127 * Gesture Layer Tweaks:
13129 * Note that line, flick, gestures can start without the need to remove fingers from surface.
13130 * When user fingers rests on same-spot gesture is ended and starts again when fingers moved.
13132 * Setting glayer_continues_enable to false in @ref Config will change this behavior
13133 * so gesture starts when user touches (a *DOWN event) touch-surface
13134 * and ends when no fingers touches surface (a *UP event).
13138 * @enum _Elm_Gesture_Types
13139 * Enum of supported gesture types.
13140 * @ingroup Elm_Gesture_Layer
13142 enum _Elm_Gesture_Types
13144 ELM_GESTURE_FIRST = 0,
13146 ELM_GESTURE_N_TAPS, /**< N fingers single taps */
13147 ELM_GESTURE_N_LONG_TAPS, /**< N fingers single long-taps */
13148 ELM_GESTURE_N_DOUBLE_TAPS, /**< N fingers double-single taps */
13149 ELM_GESTURE_N_TRIPLE_TAPS, /**< N fingers triple-single taps */
13151 ELM_GESTURE_MOMENTUM, /**< Reports momentum in the dircetion of move */
13153 ELM_GESTURE_N_LINES, /**< N fingers line gesture */
13154 ELM_GESTURE_N_FLICKS, /**< N fingers flick gesture */
13156 ELM_GESTURE_ZOOM, /**< Zoom */
13157 ELM_GESTURE_ROTATE, /**< Rotate */
13163 * @typedef Elm_Gesture_Types
13164 * gesture types enum
13165 * @ingroup Elm_Gesture_Layer
13167 typedef enum _Elm_Gesture_Types Elm_Gesture_Types;
13170 * @enum _Elm_Gesture_State
13171 * Enum of gesture states.
13172 * @ingroup Elm_Gesture_Layer
13174 enum _Elm_Gesture_State
13176 ELM_GESTURE_STATE_UNDEFINED = -1, /**< Gesture not STARTed */
13177 ELM_GESTURE_STATE_START, /**< Gesture STARTed */
13178 ELM_GESTURE_STATE_MOVE, /**< Gesture is ongoing */
13179 ELM_GESTURE_STATE_END, /**< Gesture completed */
13180 ELM_GESTURE_STATE_ABORT /**< Onging gesture was ABORTed */
13184 * @typedef Elm_Gesture_State
13185 * gesture states enum
13186 * @ingroup Elm_Gesture_Layer
13188 typedef enum _Elm_Gesture_State Elm_Gesture_State;
13191 * @struct _Elm_Gesture_Taps_Info
13192 * Struct holds taps info for user
13193 * @ingroup Elm_Gesture_Layer
13195 struct _Elm_Gesture_Taps_Info
13197 Evas_Coord x, y; /**< Holds center point between fingers */
13198 unsigned int n; /**< Number of fingers tapped */
13199 unsigned int timestamp; /**< event timestamp */
13203 * @typedef Elm_Gesture_Taps_Info
13204 * holds taps info for user
13205 * @ingroup Elm_Gesture_Layer
13207 typedef struct _Elm_Gesture_Taps_Info Elm_Gesture_Taps_Info;
13210 * @struct _Elm_Gesture_Momentum_Info
13211 * Struct holds momentum info for user
13212 * x1 and y1 are not necessarily in sync
13213 * x1 holds x value of x direction starting point
13214 * and same holds for y1.
13215 * This is noticeable when doing V-shape movement
13216 * @ingroup Elm_Gesture_Layer
13218 struct _Elm_Gesture_Momentum_Info
13219 { /* Report line ends, timestamps, and momentum computed */
13220 Evas_Coord x1; /**< Final-swipe direction starting point on X */
13221 Evas_Coord y1; /**< Final-swipe direction starting point on Y */
13222 Evas_Coord x2; /**< Final-swipe direction ending point on X */
13223 Evas_Coord y2; /**< Final-swipe direction ending point on Y */
13225 unsigned int tx; /**< Timestamp of start of final x-swipe */
13226 unsigned int ty; /**< Timestamp of start of final y-swipe */
13228 Evas_Coord mx; /**< Momentum on X */
13229 Evas_Coord my; /**< Momentum on Y */
13231 unsigned int n; /**< Number of fingers */
13235 * @typedef Elm_Gesture_Momentum_Info
13236 * holds momentum info for user
13237 * @ingroup Elm_Gesture_Layer
13239 typedef struct _Elm_Gesture_Momentum_Info Elm_Gesture_Momentum_Info;
13242 * @struct _Elm_Gesture_Line_Info
13243 * Struct holds line info for user
13244 * @ingroup Elm_Gesture_Layer
13246 struct _Elm_Gesture_Line_Info
13247 { /* Report line ends, timestamps, and momentum computed */
13248 Elm_Gesture_Momentum_Info momentum; /**< Line momentum info */
13249 double angle; /**< Angle (direction) of lines */
13253 * @typedef Elm_Gesture_Line_Info
13254 * Holds line info for user
13255 * @ingroup Elm_Gesture_Layer
13257 typedef struct _Elm_Gesture_Line_Info Elm_Gesture_Line_Info;
13260 * @struct _Elm_Gesture_Zoom_Info
13261 * Struct holds zoom info for user
13262 * @ingroup Elm_Gesture_Layer
13264 struct _Elm_Gesture_Zoom_Info
13266 Evas_Coord x, y; /**< Holds zoom center point reported to user */
13267 Evas_Coord radius; /**< Holds radius between fingers reported to user */
13268 double zoom; /**< Zoom value: 1.0 means no zoom */
13269 double momentum; /**< Zoom momentum: zoom growth per second (NOT YET SUPPORTED) */
13273 * @typedef Elm_Gesture_Zoom_Info
13274 * Holds zoom info for user
13275 * @ingroup Elm_Gesture_Layer
13277 typedef struct _Elm_Gesture_Zoom_Info Elm_Gesture_Zoom_Info;
13280 * @struct _Elm_Gesture_Rotate_Info
13281 * Struct holds rotation info for user
13282 * @ingroup Elm_Gesture_Layer
13284 struct _Elm_Gesture_Rotate_Info
13286 Evas_Coord x, y; /**< Holds zoom center point reported to user */
13287 Evas_Coord radius; /**< Holds radius between fingers reported to user */
13288 double base_angle; /**< Holds start-angle */
13289 double angle; /**< Rotation value: 0.0 means no rotation */
13290 double momentum; /**< Rotation momentum: rotation done per second (NOT YET SUPPORTED) */
13294 * @typedef Elm_Gesture_Rotate_Info
13295 * Holds rotation info for user
13296 * @ingroup Elm_Gesture_Layer
13298 typedef struct _Elm_Gesture_Rotate_Info Elm_Gesture_Rotate_Info;
13301 * @typedef Elm_Gesture_Event_Cb
13302 * User callback used to stream gesture info from gesture layer
13303 * @param data user data
13304 * @param event_info gesture report info
13305 * Returns a flag field to be applied on the causing event.
13306 * You should probably return EVAS_EVENT_FLAG_ON_HOLD if your widget acted
13307 * upon the event, in an irreversible way.
13309 * @ingroup Elm_Gesture_Layer
13311 typedef Evas_Event_Flags (*Elm_Gesture_Event_Cb) (void *data, void *event_info);
13314 * Use function to set callbacks to be notified about
13315 * change of state of gesture.
13316 * When a user registers a callback with this function
13317 * this means this gesture has to be tested.
13319 * When ALL callbacks for a gesture are set to NULL
13320 * it means user isn't interested in gesture-state
13321 * and it will not be tested.
13323 * @param obj Pointer to gesture-layer.
13324 * @param idx The gesture you would like to track its state.
13325 * @param cb callback function pointer.
13326 * @param cb_type what event this callback tracks: START, MOVE, END, ABORT.
13327 * @param data user info to be sent to callback (usually, Smart Data)
13329 * @ingroup Elm_Gesture_Layer
13331 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);
13334 * Call this function to get repeat-events settings.
13336 * @param obj Pointer to gesture-layer.
13338 * @return repeat events settings.
13339 * @see elm_gesture_layer_hold_events_set()
13340 * @ingroup Elm_Gesture_Layer
13342 EAPI Eina_Bool elm_gesture_layer_hold_events_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
13345 * This function called in order to make gesture-layer repeat events.
13346 * Set this of you like to get the raw events only if gestures were not detected.
13347 * Clear this if you like gesture layer to fwd events as testing gestures.
13349 * @param obj Pointer to gesture-layer.
13350 * @param r Repeat: TRUE/FALSE
13352 * @ingroup Elm_Gesture_Layer
13354 EAPI void elm_gesture_layer_hold_events_set(Evas_Object *obj, Eina_Bool r) EINA_ARG_NONNULL(1);
13357 * This function sets step-value for zoom action.
13358 * Set step to any positive value.
13359 * Cancel step setting by setting to 0.0
13361 * @param obj Pointer to gesture-layer.
13362 * @param s new zoom step value.
13364 * @ingroup Elm_Gesture_Layer
13366 EAPI void elm_gesture_layer_zoom_step_set(Evas_Object *obj, double s) EINA_ARG_NONNULL(1);
13369 * This function sets step-value for rotate action.
13370 * Set step to any positive value.
13371 * Cancel step setting by setting to 0.0
13373 * @param obj Pointer to gesture-layer.
13374 * @param s new roatate step value.
13376 * @ingroup Elm_Gesture_Layer
13378 EAPI void elm_gesture_layer_rotate_step_set(Evas_Object *obj, double s) EINA_ARG_NONNULL(1);
13381 * This function called to attach gesture-layer to an Evas_Object.
13382 * @param obj Pointer to gesture-layer.
13383 * @param t Pointer to underlying object (AKA Target)
13385 * @return TRUE, FALSE on success, failure.
13387 * @ingroup Elm_Gesture_Layer
13389 EAPI Eina_Bool elm_gesture_layer_attach(Evas_Object *obj, Evas_Object *t) EINA_ARG_NONNULL(1, 2);
13392 * Call this function to construct a new gesture-layer object.
13393 * This does not activate the gesture layer. You have to
13394 * call elm_gesture_layer_attach in order to 'activate' gesture-layer.
13396 * @param parent the parent object.
13398 * @return Pointer to new gesture-layer object.
13400 * @ingroup Elm_Gesture_Layer
13402 EAPI Evas_Object *elm_gesture_layer_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
13405 * @defgroup Thumb Thumb
13407 * @image html img/widget/thumb/preview-00.png
13408 * @image latex img/widget/thumb/preview-00.eps
13410 * A thumb object is used for displaying the thumbnail of an image or video.
13411 * You must have compiled Elementary with Ethumb_Client support and the DBus
13412 * service must be present and auto-activated in order to have thumbnails to
13415 * Once the thumbnail object becomes visible, it will check if there is a
13416 * previously generated thumbnail image for the file set on it. If not, it
13417 * will start generating this thumbnail.
13419 * Different config settings will cause different thumbnails to be generated
13420 * even on the same file.
13422 * Generated thumbnails are stored under @c $HOME/.thumbnails/. Check the
13423 * Ethumb documentation to change this path, and to see other configuration
13426 * Signals that you can add callbacks for are:
13428 * - "clicked" - This is called when a user has clicked the thumb without dragging
13430 * - "clicked,double" - This is called when a user has double-clicked the thumb.
13431 * - "press" - This is called when a user has pressed down the thumb.
13432 * - "generate,start" - The thumbnail generation started.
13433 * - "generate,stop" - The generation process stopped.
13434 * - "generate,error" - The generation failed.
13435 * - "load,error" - The thumbnail image loading failed.
13437 * available styles:
13441 * An example of use of thumbnail:
13443 * - @ref thumb_example_01
13447 * @addtogroup Thumb
13452 * @enum _Elm_Thumb_Animation_Setting
13453 * @typedef Elm_Thumb_Animation_Setting
13455 * Used to set if a video thumbnail is animating or not.
13459 typedef enum _Elm_Thumb_Animation_Setting
13461 ELM_THUMB_ANIMATION_START = 0, /**< Play animation once */
13462 ELM_THUMB_ANIMATION_LOOP, /**< Keep playing animation until stop is requested */
13463 ELM_THUMB_ANIMATION_STOP, /**< Stop playing the animation */
13464 ELM_THUMB_ANIMATION_LAST
13465 } Elm_Thumb_Animation_Setting;
13468 * Add a new thumb object to the parent.
13470 * @param parent The parent object.
13471 * @return The new object or NULL if it cannot be created.
13473 * @see elm_thumb_file_set()
13474 * @see elm_thumb_ethumb_client_get()
13478 EAPI Evas_Object *elm_thumb_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
13480 * Reload thumbnail if it was generated before.
13482 * @param obj The thumb object to reload
13484 * This is useful if the ethumb client configuration changed, like its
13485 * size, aspect or any other property one set in the handle returned
13486 * by elm_thumb_ethumb_client_get().
13488 * If the options didn't change, the thumbnail won't be generated again, but
13489 * the old one will still be used.
13491 * @see elm_thumb_file_set()
13495 EAPI void elm_thumb_reload(Evas_Object *obj) EINA_ARG_NONNULL(1);
13497 * Set the file that will be used as thumbnail.
13499 * @param obj The thumb object.
13500 * @param file The path to file that will be used as thumb.
13501 * @param key The key used in case of an EET file.
13503 * The file can be an image or a video (in that case, acceptable extensions are:
13504 * avi, mp4, ogv, mov, mpg and wmv). To start the video animation, use the
13505 * function elm_thumb_animate().
13507 * @see elm_thumb_file_get()
13508 * @see elm_thumb_reload()
13509 * @see elm_thumb_animate()
13513 EAPI void elm_thumb_file_set(Evas_Object *obj, const char *file, const char *key) EINA_ARG_NONNULL(1);
13515 * Get the image or video path and key used to generate the thumbnail.
13517 * @param obj The thumb object.
13518 * @param file Pointer to filename.
13519 * @param key Pointer to key.
13521 * @see elm_thumb_file_set()
13522 * @see elm_thumb_path_get()
13526 EAPI void elm_thumb_file_get(const Evas_Object *obj, const char **file, const char **key) EINA_ARG_NONNULL(1);
13528 * Get the path and key to the image or video generated by ethumb.
13530 * One just need to make sure that the thumbnail was generated before getting
13531 * its path; otherwise, the path will be NULL. One way to do that is by asking
13532 * for the path when/after the "generate,stop" smart callback is called.
13534 * @param obj The thumb object.
13535 * @param file Pointer to thumb path.
13536 * @param key Pointer to thumb key.
13538 * @see elm_thumb_file_get()
13542 EAPI void elm_thumb_path_get(const Evas_Object *obj, const char **file, const char **key) EINA_ARG_NONNULL(1);
13544 * Set the animation state for the thumb object. If its content is an animated
13545 * video, you may start/stop the animation or tell it to play continuously and
13548 * @param obj The thumb object.
13549 * @param setting The animation setting.
13551 * @see elm_thumb_file_set()
13555 EAPI void elm_thumb_animate_set(Evas_Object *obj, Elm_Thumb_Animation_Setting s) EINA_ARG_NONNULL(1);
13557 * Get the animation state for the thumb object.
13559 * @param obj The thumb object.
13560 * @return getting The animation setting or @c ELM_THUMB_ANIMATION_LAST,
13563 * @see elm_thumb_animate_set()
13567 EAPI Elm_Thumb_Animation_Setting elm_thumb_animate_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13569 * Get the ethumb_client handle so custom configuration can be made.
13571 * @return Ethumb_Client instance or NULL.
13573 * This must be called before the objects are created to be sure no object is
13574 * visible and no generation started.
13576 * Example of usage:
13579 * #include <Elementary.h>
13580 * #ifndef ELM_LIB_QUICKLAUNCH
13582 * elm_main(int argc, char **argv)
13584 * Ethumb_Client *client;
13586 * elm_need_ethumb();
13590 * client = elm_thumb_ethumb_client_get();
13593 * ERR("could not get ethumb_client");
13596 * ethumb_client_size_set(client, 100, 100);
13597 * ethumb_client_crop_align_set(client, 0.5, 0.5);
13600 * // Create elm_thumb objects here
13610 * @note There's only one client handle for Ethumb, so once a configuration
13611 * change is done to it, any other request for thumbnails (for any thumbnail
13612 * object) will use that configuration. Thus, this configuration is global.
13616 EAPI void *elm_thumb_ethumb_client_get(void);
13618 * Get the ethumb_client connection state.
13620 * @return EINA_TRUE if the client is connected to the server or EINA_FALSE
13623 EAPI Eina_Bool elm_thumb_ethumb_client_connected(void);
13625 * Make the thumbnail 'editable'.
13627 * @param obj Thumb object.
13628 * @param set Turn on or off editability. Default is @c EINA_FALSE.
13630 * This means the thumbnail is a valid drag target for drag and drop, and can be
13631 * cut or pasted too.
13633 * @see elm_thumb_editable_get()
13637 EAPI Eina_Bool elm_thumb_editable_set(Evas_Object *obj, Eina_Bool edit) EINA_ARG_NONNULL(1);
13639 * Make the thumbnail 'editable'.
13641 * @param obj Thumb object.
13642 * @return Editability.
13644 * This means the thumbnail is a valid drag target for drag and drop, and can be
13645 * cut or pasted too.
13647 * @see elm_thumb_editable_set()
13651 EAPI Eina_Bool elm_thumb_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13658 * @defgroup Web Web
13660 * @image html img/widget/web/preview-00.png
13661 * @image latex img/widget/web/preview-00.eps
13663 * A web object is used for displaying web pages (HTML/CSS/JS)
13664 * using WebKit-EFL. You must have compiled Elementary with
13667 * Signals that you can add callbacks for are:
13668 * @li "download,request": A file download has been requested. Event info is
13669 * a pointer to a Elm_Web_Download
13670 * @li "editorclient,contents,changed": Editor client's contents changed
13671 * @li "editorclient,selection,changed": Editor client's selection changed
13672 * @li "frame,created": A new frame was created. Event info is an
13673 * Evas_Object which can be handled with WebKit's ewk_frame API
13674 * @li "icon,received": An icon was received by the main frame
13675 * @li "inputmethod,changed": Input method changed. Event info is an
13676 * Eina_Bool indicating whether it's enabled or not
13677 * @li "js,windowobject,clear": JS window object has been cleared
13678 * @li "link,hover,in": Mouse cursor is hovering over a link. Event info
13679 * is a char *link[2], where the first string contains the URL the link
13680 * points to, and the second one the title of the link
13681 * @li "link,hover,out": Mouse cursor left the link
13682 * @li "load,document,finished": Loading of a document finished. Event info
13683 * is the frame that finished loading
13684 * @li "load,error": Load failed. Event info is a pointer to
13685 * Elm_Web_Frame_Load_Error
13686 * @li "load,finished": Load finished. Event info is NULL on success, on
13687 * error it's a pointer to Elm_Web_Frame_Load_Error
13688 * @li "load,newwindow,show": A new window was created and is ready to be
13690 * @li "load,progress": Overall load progress. Event info is a pointer to
13691 * a double containing a value between 0.0 and 1.0
13692 * @li "load,provisional": Started provisional load
13693 * @li "load,started": Loading of a document started
13694 * @li "menubar,visible,get": Queries if the menubar is visible. Event info
13695 * is a pointer to Eina_Bool where the callback should set EINA_TRUE if
13696 * the menubar is visible, or EINA_FALSE in case it's not
13697 * @li "menubar,visible,set": Informs menubar visibility. Event info is
13698 * an Eina_Bool indicating the visibility
13699 * @li "popup,created": A dropdown widget was activated, requesting its
13700 * popup menu to be created. Event info is a pointer to Elm_Web_Menu
13701 * @li "popup,willdelete": The web object is ready to destroy the popup
13702 * object created. Event info is a pointer to Elm_Web_Menu
13703 * @li "ready": Page is fully loaded
13704 * @li "scrollbars,visible,get": Queries visibility of scrollbars. Event
13705 * info is a pointer to Eina_Bool where the visibility state should be set
13706 * @li "scrollbars,visible,set": Informs scrollbars visibility. Event info
13707 * is an Eina_Bool with the visibility state set
13708 * @li "statusbar,text,set": Text of the statusbar changed. Even info is
13709 * a string with the new text
13710 * @li "statusbar,visible,get": Queries visibility of the status bar.
13711 * Event info is a pointer to Eina_Bool where the visibility state should be
13713 * @li "statusbar,visible,set": Informs statusbar visibility. Event info is
13714 * an Eina_Bool with the visibility value
13715 * @li "title,changed": Title of the main frame changed. Event info is a
13716 * string with the new title
13717 * @li "toolbars,visible,get": Queries visibility of toolbars. Event info
13718 * is a pointer to Eina_Bool where the visibility state should be set
13719 * @li "toolbars,visible,set": Informs the visibility of toolbars. Event
13720 * info is an Eina_Bool with the visibility state
13721 * @li "tooltip,text,set": Show and set text of a tooltip. Event info is
13722 * a string with the text to show
13723 * @li "uri,changed": URI of the main frame changed. Event info is a string
13725 * @li "view,resized": The web object internal's view changed sized
13726 * @li "windows,close,request": A JavaScript request to close the current
13727 * window was requested
13728 * @li "zoom,animated,end": Animated zoom finished
13730 * available styles:
13733 * An example of use of web:
13735 * - @ref web_example_01 TBD
13744 * Structure used to report load errors.
13746 * Load errors are reported as signal by elm_web. All the strings are
13747 * temporary references and should @b not be used after the signal
13748 * callback returns. If it's required, make copies with strdup() or
13749 * eina_stringshare_add() (they are not even guaranteed to be
13750 * stringshared, so must use eina_stringshare_add() and not
13751 * eina_stringshare_ref()).
13753 typedef struct _Elm_Web_Frame_Load_Error Elm_Web_Frame_Load_Error;
13755 * Structure used to report load errors.
13757 * Load errors are reported as signal by elm_web. All the strings are
13758 * temporary references and should @b not be used after the signal
13759 * callback returns. If it's required, make copies with strdup() or
13760 * eina_stringshare_add() (they are not even guaranteed to be
13761 * stringshared, so must use eina_stringshare_add() and not
13762 * eina_stringshare_ref()).
13764 struct _Elm_Web_Frame_Load_Error
13766 int code; /**< Numeric error code */
13767 Eina_Bool is_cancellation; /**< Error produced by cancelling a request */
13768 const char *domain; /**< Error domain name */
13769 const char *description; /**< Error description (already localized) */
13770 const char *failing_url; /**< The URL that failed to load */
13771 Evas_Object *frame; /**< Frame object that produced the error */
13775 * The possibles types that the items in a menu can be
13777 typedef enum _Elm_Web_Menu_Item_Type
13779 ELM_WEB_MENU_SEPARATOR,
13780 ELM_WEB_MENU_GROUP,
13781 ELM_WEB_MENU_OPTION
13782 } Elm_Web_Menu_Item_Type;
13785 * Structure describing the items in a menu
13787 typedef struct _Elm_Web_Menu_Item Elm_Web_Menu_Item;
13789 * Structure describing the items in a menu
13791 struct _Elm_Web_Menu_Item
13793 const char *text; /**< The text for the item */
13794 Elm_Web_Menu_Item_Type type; /**< The type of the item */
13798 * Structure describing the menu of a popup
13800 * This structure will be passed as the @c event_info for the "popup,create"
13801 * signal, which is emitted when a dropdown menu is opened. Users wanting
13802 * to handle these popups by themselves should listen to this signal and
13803 * set the @c handled property of the struct to @c EINA_TRUE. Leaving this
13804 * property as @c EINA_FALSE means that the user will not handle the popup
13805 * and the default implementation will be used.
13807 * When the popup is ready to be dismissed, a "popup,willdelete" signal
13808 * will be emitted to notify the user that it can destroy any objects and
13809 * free all data related to it.
13811 * @see elm_web_popup_selected_set()
13812 * @see elm_web_popup_destroy()
13814 typedef struct _Elm_Web_Menu Elm_Web_Menu;
13816 * Structure describing the menu of a popup
13818 * This structure will be passed as the @c event_info for the "popup,create"
13819 * signal, which is emitted when a dropdown menu is opened. Users wanting
13820 * to handle these popups by themselves should listen to this signal and
13821 * set the @c handled property of the struct to @c EINA_TRUE. Leaving this
13822 * property as @c EINA_FALSE means that the user will not handle the popup
13823 * and the default implementation will be used.
13825 * When the popup is ready to be dismissed, a "popup,willdelete" signal
13826 * will be emitted to notify the user that it can destroy any objects and
13827 * free all data related to it.
13829 * @see elm_web_popup_selected_set()
13830 * @see elm_web_popup_destroy()
13832 struct _Elm_Web_Menu
13834 Eina_List *items; /**< List of #Elm_Web_Menu_Item */
13835 int x; /**< The X position of the popup, relative to the elm_web object */
13836 int y; /**< The Y position of the popup, relative to the elm_web object */
13837 int width; /**< Width of the popup menu */
13838 int height; /**< Height of the popup menu */
13840 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. */
13843 typedef struct _Elm_Web_Download Elm_Web_Download;
13844 struct _Elm_Web_Download
13850 * Types of zoom available.
13852 typedef enum _Elm_Web_Zoom_Mode
13854 ELM_WEB_ZOOM_MODE_MANUAL = 0, /**< Zoom controlled normally by elm_web_zoom_set */
13855 ELM_WEB_ZOOM_MODE_AUTO_FIT, /**< Zoom until content fits in web object */
13856 ELM_WEB_ZOOM_MODE_AUTO_FILL, /**< Zoom until content fills web object */
13857 ELM_WEB_ZOOM_MODE_LAST
13858 } Elm_Web_Zoom_Mode;
13860 * Opaque handler containing the features (such as statusbar, menubar, etc)
13861 * that are to be set on a newly requested window.
13863 typedef struct _Elm_Web_Window_Features Elm_Web_Window_Features;
13865 * Callback type for the create_window hook.
13867 * The function parameters are:
13868 * @li @p data User data pointer set when setting the hook function
13869 * @li @p obj The elm_web object requesting the new window
13870 * @li @p js Set to @c EINA_TRUE if the request was originated from
13871 * JavaScript. @c EINA_FALSE otherwise.
13872 * @li @p window_features A pointer of #Elm_Web_Window_Features indicating
13873 * the features requested for the new window.
13875 * The returned value of the function should be the @c elm_web widget where
13876 * the request will be loaded. That is, if a new window or tab is created,
13877 * the elm_web widget in it should be returned, and @b NOT the window
13879 * Returning @c NULL should cancel the request.
13881 * @see elm_web_window_create_hook_set()
13883 typedef Evas_Object *(*Elm_Web_Window_Open)(void *data, Evas_Object *obj, Eina_Bool js, const Elm_Web_Window_Features *window_features);
13885 * Callback type for the JS alert hook.
13887 * The function parameters are:
13888 * @li @p data User data pointer set when setting the hook function
13889 * @li @p obj The elm_web object requesting the new window
13890 * @li @p message The message to show in the alert dialog
13892 * The function should return the object representing the alert dialog.
13893 * Elm_Web will run a second main loop to handle the dialog and normal
13894 * flow of the application will be restored when the object is deleted, so
13895 * the user should handle the popup properly in order to delete the object
13896 * when the action is finished.
13897 * If the function returns @c NULL the popup will be ignored.
13899 * @see elm_web_dialog_alert_hook_set()
13901 typedef Evas_Object *(*Elm_Web_Dialog_Alert)(void *data, Evas_Object *obj, const char *message);
13903 * Callback type for the JS confirm hook.
13905 * The function parameters are:
13906 * @li @p data User data pointer set when setting the hook function
13907 * @li @p obj The elm_web object requesting the new window
13908 * @li @p message The message to show in the confirm dialog
13909 * @li @p ret Pointer where to store the user selection. @c EINA_TRUE if
13910 * the user selected @c Ok, @c EINA_FALSE otherwise.
13912 * The function should return the object representing the confirm dialog.
13913 * Elm_Web will run a second main loop to handle the dialog and normal
13914 * flow of the application will be restored when the object is deleted, so
13915 * the user should handle the popup properly in order to delete the object
13916 * when the action is finished.
13917 * If the function returns @c NULL the popup will be ignored.
13919 * @see elm_web_dialog_confirm_hook_set()
13921 typedef Evas_Object *(*Elm_Web_Dialog_Confirm)(void *data, Evas_Object *obj, const char *message, Eina_Bool *ret);
13923 * Callback type for the JS prompt hook.
13925 * The function parameters are:
13926 * @li @p data User data pointer set when setting the hook function
13927 * @li @p obj The elm_web object requesting the new window
13928 * @li @p message The message to show in the prompt dialog
13929 * @li @p def_value The default value to present the user in the entry
13930 * @li @p value Pointer where to store the value given by the user. Must
13931 * be a malloc'ed string or @c NULL if the user cancelled the popup.
13932 * @li @p ret Pointer where to store the user selection. @c EINA_TRUE if
13933 * the user selected @c Ok, @c EINA_FALSE otherwise.
13935 * The function should return the object representing the prompt dialog.
13936 * Elm_Web will run a second main loop to handle the dialog and normal
13937 * flow of the application will be restored when the object is deleted, so
13938 * the user should handle the popup properly in order to delete the object
13939 * when the action is finished.
13940 * If the function returns @c NULL the popup will be ignored.
13942 * @see elm_web_dialog_prompt_hook_set()
13944 typedef Evas_Object *(*Elm_Web_Dialog_Prompt)(void *data, Evas_Object *obj, const char *message, const char *def_value, char **value, Eina_Bool *ret);
13946 * Callback type for the JS file selector hook.
13948 * The function parameters are:
13949 * @li @p data User data pointer set when setting the hook function
13950 * @li @p obj The elm_web object requesting the new window
13951 * @li @p allows_multiple @c EINA_TRUE if multiple files can be selected.
13952 * @li @p accept_types Mime types accepted
13953 * @li @p selected Pointer where to store the list of malloc'ed strings
13954 * containing the path to each file selected. Must be @c NULL if the file
13955 * dialog is cancelled
13956 * @li @p ret Pointer where to store the user selection. @c EINA_TRUE if
13957 * the user selected @c Ok, @c EINA_FALSE otherwise.
13959 * The function should return the object representing the file selector
13961 * Elm_Web will run a second main loop to handle the dialog and normal
13962 * flow of the application will be restored when the object is deleted, so
13963 * the user should handle the popup properly in order to delete the object
13964 * when the action is finished.
13965 * If the function returns @c NULL the popup will be ignored.
13967 * @see elm_web_dialog_file selector_hook_set()
13969 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);
13971 * Callback type for the JS console message hook.
13973 * When a console message is added from JavaScript, any set function to the
13974 * console message hook will be called for the user to handle. There is no
13975 * default implementation of this hook.
13977 * The function parameters are:
13978 * @li @p data User data pointer set when setting the hook function
13979 * @li @p obj The elm_web object that originated the message
13980 * @li @p message The message sent
13981 * @li @p line_number The line number
13982 * @li @p source_id Source id
13984 * @see elm_web_console_message_hook_set()
13986 typedef void (*Elm_Web_Console_Message)(void *data, Evas_Object *obj, const char *message, unsigned int line_number, const char *source_id);
13988 * Add a new web object to the parent.
13990 * @param parent The parent object.
13991 * @return The new object or NULL if it cannot be created.
13993 * @see elm_web_uri_set()
13994 * @see elm_web_webkit_view_get()
13996 EAPI Evas_Object *elm_web_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
13999 * Get internal ewk_view object from web object.
14001 * Elementary may not provide some low level features of EWebKit,
14002 * instead of cluttering the API with proxy methods we opted to
14003 * return the internal reference. Be careful using it as it may
14004 * interfere with elm_web behavior.
14006 * @param obj The web object.
14007 * @return The internal ewk_view object or NULL if it does not
14008 * exist. (Failure to create or Elementary compiled without
14011 * @see elm_web_add()
14013 EAPI Evas_Object *elm_web_webkit_view_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14016 * Sets the function to call when a new window is requested
14018 * This hook will be called when a request to create a new window is
14019 * issued from the web page loaded.
14020 * There is no default implementation for this feature, so leaving this
14021 * unset or passing @c NULL in @p func will prevent new windows from
14024 * @param obj The web object where to set the hook function
14025 * @param func The hook function to be called when a window is requested
14026 * @param data User data
14028 EAPI void elm_web_window_create_hook_set(Evas_Object *obj, Elm_Web_Window_Open func, void *data);
14030 * Sets the function to call when an alert dialog
14032 * This hook will be called when a JavaScript alert dialog is requested.
14033 * If no function is set or @c NULL is passed in @p func, the default
14034 * implementation will take place.
14036 * @param obj The web object where to set the hook function
14037 * @param func The callback function to be used
14038 * @param data User data
14040 * @see elm_web_inwin_mode_set()
14042 EAPI void elm_web_dialog_alert_hook_set(Evas_Object *obj, Elm_Web_Dialog_Alert func, void *data);
14044 * Sets the function to call when an confirm dialog
14046 * This hook will be called when a JavaScript confirm dialog is requested.
14047 * If no function is set or @c NULL is passed in @p func, the default
14048 * implementation will take place.
14050 * @param obj The web object where to set the hook function
14051 * @param func The callback function to be used
14052 * @param data User data
14054 * @see elm_web_inwin_mode_set()
14056 EAPI void elm_web_dialog_confirm_hook_set(Evas_Object *obj, Elm_Web_Dialog_Confirm func, void *data);
14058 * Sets the function to call when an prompt dialog
14060 * This hook will be called when a JavaScript prompt dialog is requested.
14061 * If no function is set or @c NULL is passed in @p func, the default
14062 * implementation will take place.
14064 * @param obj The web object where to set the hook function
14065 * @param func The callback function to be used
14066 * @param data User data
14068 * @see elm_web_inwin_mode_set()
14070 EAPI void elm_web_dialog_prompt_hook_set(Evas_Object *obj, Elm_Web_Dialog_Prompt func, void *data);
14072 * Sets the function to call when an file selector dialog
14074 * This hook will be called when a JavaScript file selector dialog is
14076 * If no function is set or @c NULL is passed in @p func, the default
14077 * implementation will take place.
14079 * @param obj The web object where to set the hook function
14080 * @param func The callback function to be used
14081 * @param data User data
14083 * @see elm_web_inwin_mode_set()
14085 EAPI void elm_web_dialog_file_selector_hook_set(Evas_Object *obj, Elm_Web_Dialog_File_Selector func, void *data);
14087 * Sets the function to call when a console message is emitted from JS
14089 * This hook will be called when a console message is emitted from
14090 * JavaScript. There is no default implementation for this feature.
14092 * @param obj The web object where to set the hook function
14093 * @param func The callback function to be used
14094 * @param data User data
14096 EAPI void elm_web_console_message_hook_set(Evas_Object *obj, Elm_Web_Console_Message func, void *data);
14098 * Gets the status of the tab propagation
14100 * @param obj The web object to query
14101 * @return EINA_TRUE if tab propagation is enabled, EINA_FALSE otherwise
14103 * @see elm_web_tab_propagate_set()
14105 EAPI Eina_Bool elm_web_tab_propagate_get(const Evas_Object *obj);
14107 * Sets whether to use tab propagation
14109 * If tab propagation is enabled, whenever the user presses the Tab key,
14110 * Elementary will handle it and switch focus to the next widget.
14111 * The default value is disabled, where WebKit will handle the Tab key to
14112 * cycle focus though its internal objects, jumping to the next widget
14113 * only when that cycle ends.
14115 * @param obj The web object
14116 * @param propagate Whether to propagate Tab keys to Elementary or not
14118 EAPI void elm_web_tab_propagate_set(Evas_Object *obj, Eina_Bool propagate);
14120 * Sets the URI for the web object
14122 * It must be a full URI, with resource included, in the form
14123 * http://www.enlightenment.org or file:///tmp/something.html
14125 * @param obj The web object
14126 * @param uri The URI to set
14127 * @return EINA_TRUE if the URI could be, EINA_FALSE if an error occurred
14129 EAPI Eina_Bool elm_web_uri_set(Evas_Object *obj, const char *uri);
14131 * Gets the current URI for the object
14133 * The returned string must not be freed and is guaranteed to be
14136 * @param obj The web object
14137 * @return A stringshared internal string with the current URI, or NULL on
14140 EAPI const char *elm_web_uri_get(const Evas_Object *obj);
14142 * Gets the current title
14144 * The returned string must not be freed and is guaranteed to be
14147 * @param obj The web object
14148 * @return A stringshared internal string with the current title, or NULL on
14151 EAPI const char *elm_web_title_get(const Evas_Object *obj);
14153 * Sets the background color to be used by the web object
14155 * This is the color that will be used by default when the loaded page
14156 * does not set it's own. Color values are pre-multiplied.
14158 * @param obj The web object
14159 * @param r Red component
14160 * @param g Green component
14161 * @param b Blue component
14162 * @param a Alpha component
14164 EAPI void elm_web_bg_color_set(Evas_Object *obj, int r, int g, int b, int a);
14166 * Gets the background color to be used by the web object
14168 * This is the color that will be used by default when the loaded page
14169 * does not set it's own. Color values are pre-multiplied.
14171 * @param obj The web object
14172 * @param r Red component
14173 * @param g Green component
14174 * @param b Blue component
14175 * @param a Alpha component
14177 EAPI void elm_web_bg_color_get(const Evas_Object *obj, int *r, int *g, int *b, int *a);
14179 * Gets a copy of the currently selected text
14181 * The string returned must be freed by the user when it's done with it.
14183 * @param obj The web object
14184 * @return A newly allocated string, or NULL if nothing is selected or an
14187 EAPI char *elm_view_selection_get(const Evas_Object *obj);
14189 * Tells the web object which index in the currently open popup was selected
14191 * When the user handles the popup creation from the "popup,created" signal,
14192 * it needs to tell the web object which item was selected by calling this
14193 * function with the index corresponding to the item.
14195 * @param obj The web object
14196 * @param index The index selected
14198 * @see elm_web_popup_destroy()
14200 EAPI void elm_web_popup_selected_set(Evas_Object *obj, int index);
14202 * Dismisses an open dropdown popup
14204 * When the popup from a dropdown widget is to be dismissed, either after
14205 * selecting an option or to cancel it, this function must be called, which
14206 * will later emit an "popup,willdelete" signal to notify the user that
14207 * any memory and objects related to this popup can be freed.
14209 * @param obj The web object
14210 * @return EINA_TRUE if the menu was successfully destroyed, or EINA_FALSE
14211 * if there was no menu to destroy
14213 EAPI Eina_Bool elm_web_popup_destroy(Evas_Object *obj);
14215 * Searches the given string in a document.
14217 * @param obj The web object where to search the text
14218 * @param string String to search
14219 * @param case_sensitive If search should be case sensitive or not
14220 * @param forward If search is from cursor and on or backwards
14221 * @param wrap If search should wrap at the end
14223 * @return @c EINA_TRUE if the given string was found, @c EINA_FALSE if not
14226 EAPI Eina_Bool elm_web_text_search(const Evas_Object *obj, const char *string, Eina_Bool case_sensitive, Eina_Bool forward, Eina_Bool wrap);
14228 * Marks matches of the given string in a document.
14230 * @param obj The web object where to search text
14231 * @param string String to match
14232 * @param case_sensitive If match should be case sensitive or not
14233 * @param highlight If matches should be highlighted
14234 * @param limit Maximum amount of matches, or zero to unlimited
14236 * @return number of matched @a string
14238 EAPI unsigned int elm_web_text_matches_mark(Evas_Object *obj, const char *string, Eina_Bool case_sensitive, Eina_Bool highlight, unsigned int limit);
14240 * Clears all marked matches in the document
14242 * @param obj The web object
14244 * @return EINA_TRUE on success, EINA_FALSE otherwise
14246 EAPI Eina_Bool elm_web_text_matches_unmark_all(Evas_Object *obj);
14248 * Sets whether to highlight the matched marks
14250 * If enabled, marks set with elm_web_text_matches_mark() will be
14253 * @param obj The web object
14254 * @param highlight Whether to highlight the marks or not
14256 * @return EINA_TRUE on success, EINA_FALSE otherwise
14258 EAPI Eina_Bool elm_web_text_matches_highlight_set(Evas_Object *obj, Eina_Bool highlight);
14260 * Gets whether highlighting marks is enabled
14262 * @param The web object
14264 * @return EINA_TRUE is marks are set to be highlighted, EINA_FALSE
14267 EAPI Eina_Bool elm_web_text_matches_highlight_get(const Evas_Object *obj);
14269 * Gets the overall loading progress of the page
14271 * Returns the estimated loading progress of the page, with a value between
14272 * 0.0 and 1.0. This is an estimated progress accounting for all the frames
14273 * included in the page.
14275 * @param The web object
14277 * @return A value between 0.0 and 1.0 indicating the progress, or -1.0 on
14280 EAPI double elm_web_load_progress_get(const Evas_Object *obj);
14282 * Stops loading the current page
14284 * Cancels the loading of the current page in the web object. This will
14285 * cause a "load,error" signal to be emitted, with the is_cancellation
14286 * flag set to EINA_TRUE.
14288 * @param obj The web object
14290 * @return EINA_TRUE if the cancel was successful, EINA_FALSE otherwise
14292 EAPI Eina_Bool elm_web_stop(Evas_Object *obj);
14294 * Requests a reload of the current document in the object
14296 * @param obj The web object
14298 * @return EINA_TRUE on success, EINA_FALSE otherwise
14300 EAPI Eina_Bool elm_web_reload(Evas_Object *obj);
14302 * Requests a reload of the current document, avoiding any existing caches
14304 * @param obj The web object
14306 * @return EINA_TRUE on success, EINA_FALSE otherwise
14308 EAPI Eina_Bool elm_web_reload_full(Evas_Object *obj);
14310 * Goes back one step in the browsing history
14312 * This is equivalent to calling elm_web_object_navigate(obj, -1);
14314 * @param obj The web object
14316 * @return EINA_TRUE on success, EINA_FALSE otherwise
14318 * @see elm_web_history_enable_set()
14319 * @see elm_web_back_possible()
14320 * @see elm_web_forward()
14321 * @see elm_web_navigate()
14323 EAPI Eina_Bool elm_web_back(Evas_Object *obj);
14325 * Goes forward one step in the browsing history
14327 * This is equivalent to calling elm_web_object_navigate(obj, 1);
14329 * @param obj The web object
14331 * @return EINA_TRUE on success, EINA_FALSE otherwise
14333 * @see elm_web_history_enable_set()
14334 * @see elm_web_forward_possible()
14335 * @see elm_web_back()
14336 * @see elm_web_navigate()
14338 EAPI Eina_Bool elm_web_forward(Evas_Object *obj);
14340 * Jumps the given number of steps in the browsing history
14342 * The @p steps value can be a negative integer to back in history, or a
14343 * positive to move forward.
14345 * @param obj The web object
14346 * @param steps The number of steps to jump
14348 * @return EINA_TRUE on success, EINA_FALSE on error or if not enough
14349 * history exists to jump the given number of steps
14351 * @see elm_web_history_enable_set()
14352 * @see elm_web_navigate_possible()
14353 * @see elm_web_back()
14354 * @see elm_web_forward()
14356 EAPI Eina_Bool elm_web_navigate(Evas_Object *obj, int steps);
14358 * Queries whether it's possible to go back in history
14360 * @param obj The web object
14362 * @return EINA_TRUE if it's possible to back in history, EINA_FALSE
14365 EAPI Eina_Bool elm_web_back_possible(Evas_Object *obj);
14367 * Queries whether it's possible to go forward in history
14369 * @param obj The web object
14371 * @return EINA_TRUE if it's possible to forward in history, EINA_FALSE
14374 EAPI Eina_Bool elm_web_forward_possible(Evas_Object *obj);
14376 * Queries whether it's possible to jump the given number of steps
14378 * The @p steps value can be a negative integer to back in history, or a
14379 * positive to move forward.
14381 * @param obj The web object
14382 * @param steps The number of steps to check for
14384 * @return EINA_TRUE if enough history exists to perform the given jump,
14385 * EINA_FALSE otherwise
14387 EAPI Eina_Bool elm_web_navigate_possible(Evas_Object *obj, int steps);
14389 * Gets whether browsing history is enabled for the given object
14391 * @param obj The web object
14393 * @return EINA_TRUE if history is enabled, EINA_FALSE otherwise
14395 EAPI Eina_Bool elm_web_history_enable_get(const Evas_Object *obj);
14397 * Enables or disables the browsing history
14399 * @param obj The web object
14400 * @param enable Whether to enable or disable the browsing history
14402 EAPI void elm_web_history_enable_set(Evas_Object *obj, Eina_Bool enable);
14404 * Sets the zoom level of the web object
14406 * Zoom level matches the Webkit API, so 1.0 means normal zoom, with higher
14407 * values meaning zoom in and lower meaning zoom out. This function will
14408 * only affect the zoom level if the mode set with elm_web_zoom_mode_set()
14409 * is ::ELM_WEB_ZOOM_MODE_MANUAL.
14411 * @param obj The web object
14412 * @param zoom The zoom level to set
14414 EAPI void elm_web_zoom_set(Evas_Object *obj, double zoom);
14416 * Gets the current zoom level set on the web object
14418 * Note that this is the zoom level set on the web object and not that
14419 * of the underlying Webkit one. In the ::ELM_WEB_ZOOM_MODE_MANUAL mode,
14420 * the two zoom levels should match, but for the other two modes the
14421 * Webkit zoom is calculated internally to match the chosen mode without
14422 * changing the zoom level set for the web object.
14424 * @param obj The web object
14426 * @return The zoom level set on the object
14428 EAPI double elm_web_zoom_get(const Evas_Object *obj);
14430 * Sets the zoom mode to use
14432 * The modes can be any of those defined in ::Elm_Web_Zoom_Mode, except
14433 * ::ELM_WEB_ZOOM_MODE_LAST. The default is ::ELM_WEB_ZOOM_MODE_MANUAL.
14435 * ::ELM_WEB_ZOOM_MODE_MANUAL means the zoom level will be controlled
14436 * with the elm_web_zoom_set() function.
14437 * ::ELM_WEB_ZOOM_MODE_AUTO_FIT will calculate the needed zoom level to
14438 * make sure the entirety of the web object's contents are shown.
14439 * ::ELM_WEB_ZOOM_MODE_AUTO_FILL will calculate the needed zoom level to
14440 * fit the contents in the web object's size, without leaving any space
14443 * @param obj The web object
14444 * @param mode The mode to set
14446 EAPI void elm_web_zoom_mode_set(Evas_Object *obj, Elm_Web_Zoom_Mode mode);
14448 * Gets the currently set zoom mode
14450 * @param obj The web object
14452 * @return The current zoom mode set for the object, or
14453 * ::ELM_WEB_ZOOM_MODE_LAST on error
14455 EAPI Elm_Web_Zoom_Mode elm_web_zoom_mode_get(const Evas_Object *obj);
14457 * Shows the given region in the web object
14459 * @param obj The web object
14460 * @param x The x coordinate of the region to show
14461 * @param y The y coordinate of the region to show
14462 * @param w The width of the region to show
14463 * @param h The height of the region to show
14465 EAPI void elm_web_region_show(Evas_Object *obj, int x, int y, int w, int h);
14467 * Brings in the region to the visible area
14469 * Like elm_web_region_show(), but it animates the scrolling of the object
14472 * @param obj The web object
14473 * @param x The x coordinate of the region to show
14474 * @param y The y coordinate of the region to show
14475 * @param w The width of the region to show
14476 * @param h The height of the region to show
14478 EAPI void elm_web_region_bring_in(Evas_Object *obj, int x, int y, int w, int h);
14480 * Sets the default dialogs to use an Inwin instead of a normal window
14482 * If set, then the default implementation for the JavaScript dialogs and
14483 * file selector will be opened in an Inwin. Otherwise they will use a
14484 * normal separated window.
14486 * @param obj The web object
14487 * @param value EINA_TRUE to use Inwin, EINA_FALSE to use a normal window
14489 EAPI void elm_web_inwin_mode_set(Evas_Object *obj, Eina_Bool value);
14491 * Gets whether Inwin mode is set for the current object
14493 * @param obj The web object
14495 * @return EINA_TRUE if Inwin mode is set, EINA_FALSE otherwise
14497 EAPI Eina_Bool elm_web_inwin_mode_get(const Evas_Object *obj);
14499 EAPI void elm_web_window_features_ref(Elm_Web_Window_Features *wf);
14500 EAPI void elm_web_window_features_unref(Elm_Web_Window_Features *wf);
14501 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);
14502 EAPI void elm_web_window_features_int_property_get(const Elm_Web_Window_Features *wf, int *x, int *y, int *w, int *h);
14509 * @defgroup Hoversel Hoversel
14511 * @image html img/widget/hoversel/preview-00.png
14512 * @image latex img/widget/hoversel/preview-00.eps
14514 * A hoversel is a button that pops up a list of items (automatically
14515 * choosing the direction to display) that have a label and, optionally, an
14516 * icon to select from. It is a convenience widget to avoid the need to do
14517 * all the piecing together yourself. It is intended for a small number of
14518 * items in the hoversel menu (no more than 8), though is capable of many
14521 * Signals that you can add callbacks for are:
14522 * "clicked" - the user clicked the hoversel button and popped up the sel
14523 * "selected" - an item in the hoversel list is selected. event_info is the item
14524 * "dismissed" - the hover is dismissed
14526 * See @ref tutorial_hoversel for an example.
14529 typedef struct _Elm_Hoversel_Item Elm_Hoversel_Item; /**< Item of Elm_Hoversel. Sub-type of Elm_Widget_Item */
14531 * @brief Add a new Hoversel object
14533 * @param parent The parent object
14534 * @return The new object or NULL if it cannot be created
14536 EAPI Evas_Object *elm_hoversel_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
14538 * @brief This sets the hoversel to expand horizontally.
14540 * @param obj The hoversel object
14541 * @param horizontal If true, the hover will expand horizontally to the
14544 * @note The initial button will display horizontally regardless of this
14547 EAPI void elm_hoversel_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
14549 * @brief This returns whether the hoversel is set to expand horizontally.
14551 * @param obj The hoversel object
14552 * @return If true, the hover will expand horizontally to the right.
14554 * @see elm_hoversel_horizontal_set()
14556 EAPI Eina_Bool elm_hoversel_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14558 * @brief Set the Hover parent
14560 * @param obj The hoversel object
14561 * @param parent The parent to use
14563 * Sets the hover parent object, the area that will be darkened when the
14564 * hoversel is clicked. Should probably be the window that the hoversel is
14565 * in. See @ref Hover objects for more information.
14567 EAPI void elm_hoversel_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
14569 * @brief Get the Hover parent
14571 * @param obj The hoversel object
14572 * @return The used parent
14574 * Gets the hover parent object.
14576 * @see elm_hoversel_hover_parent_set()
14578 EAPI Evas_Object *elm_hoversel_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14580 * @brief Set the hoversel button label
14582 * @param obj The hoversel object
14583 * @param label The label text.
14585 * This sets the label of the button that is always visible (before it is
14586 * clicked and expanded).
14588 * @deprecated elm_object_text_set()
14590 EINA_DEPRECATED EAPI void elm_hoversel_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
14592 * @brief Get the hoversel button label
14594 * @param obj The hoversel object
14595 * @return The label text.
14597 * @deprecated elm_object_text_get()
14599 EINA_DEPRECATED EAPI const char *elm_hoversel_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14601 * @brief Set the icon of the hoversel button
14603 * @param obj The hoversel object
14604 * @param icon The icon object
14606 * Sets the icon of the button that is always visible (before it is clicked
14607 * and expanded). Once the icon object is set, a previously set one will be
14608 * deleted, if you want to keep that old content object, use the
14609 * elm_hoversel_icon_unset() function.
14611 * @see elm_object_content_set() for the button widget
14613 EAPI void elm_hoversel_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
14615 * @brief Get the icon of the hoversel button
14617 * @param obj The hoversel object
14618 * @return The icon object
14620 * Get the icon of the button that is always visible (before it is clicked
14621 * and expanded). Also see elm_object_content_get() for the button widget.
14623 * @see elm_hoversel_icon_set()
14625 EAPI Evas_Object *elm_hoversel_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14627 * @brief Get and unparent the icon of the hoversel button
14629 * @param obj The hoversel object
14630 * @return The icon object that was being used
14632 * Unparent and return the icon of the button that is always visible
14633 * (before it is clicked and expanded).
14635 * @see elm_hoversel_icon_set()
14636 * @see elm_object_content_unset() for the button widget
14638 EAPI Evas_Object *elm_hoversel_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
14640 * @brief This triggers the hoversel popup from code, the same as if the user
14641 * had clicked the button.
14643 * @param obj The hoversel object
14645 EAPI void elm_hoversel_hover_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
14647 * @brief This dismisses the hoversel popup as if the user had clicked
14648 * outside the hover.
14650 * @param obj The hoversel object
14652 EAPI void elm_hoversel_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
14654 * @brief Returns whether the hoversel is expanded.
14656 * @param obj The hoversel object
14657 * @return This will return EINA_TRUE if the hoversel is expanded or
14658 * EINA_FALSE if it is not expanded.
14660 EAPI Eina_Bool elm_hoversel_expanded_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14662 * @brief This will remove all the children items from the hoversel.
14664 * @param obj The hoversel object
14666 * @warning Should @b not be called while the hoversel is active; use
14667 * elm_hoversel_expanded_get() to check first.
14669 * @see elm_hoversel_item_del_cb_set()
14670 * @see elm_hoversel_item_del()
14672 EAPI void elm_hoversel_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
14674 * @brief Get the list of items within the given hoversel.
14676 * @param obj The hoversel object
14677 * @return Returns a list of Elm_Hoversel_Item*
14679 * @see elm_hoversel_item_add()
14681 EAPI const Eina_List *elm_hoversel_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14683 * @brief Add an item to the hoversel button
14685 * @param obj The hoversel object
14686 * @param label The text label to use for the item (NULL if not desired)
14687 * @param icon_file An image file path on disk to use for the icon or standard
14688 * icon name (NULL if not desired)
14689 * @param icon_type The icon type if relevant
14690 * @param func Convenience function to call when this item is selected
14691 * @param data Data to pass to item-related functions
14692 * @return A handle to the item added.
14694 * This adds an item to the hoversel to show when it is clicked. Note: if you
14695 * need to use an icon from an edje file then use
14696 * elm_hoversel_item_icon_set() right after the this function, and set
14697 * icon_file to NULL here.
14699 * For more information on what @p icon_file and @p icon_type are see the
14700 * @ref Icon "icon documentation".
14702 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);
14704 * @brief Delete an item from the hoversel
14706 * @param item The item to delete
14708 * This deletes the item from the hoversel (should not be called while the
14709 * hoversel is active; use elm_hoversel_expanded_get() to check first).
14711 * @see elm_hoversel_item_add()
14712 * @see elm_hoversel_item_del_cb_set()
14714 EAPI void elm_hoversel_item_del(Elm_Hoversel_Item *item) EINA_ARG_NONNULL(1);
14716 * @brief Set the function to be called when an item from the hoversel is
14719 * @param item The item to set the callback on
14720 * @param func The function called
14722 * That function will receive these parameters:
14723 * @li void *item_data
14724 * @li Evas_Object *the_item_object
14725 * @li Elm_Hoversel_Item *the_object_struct
14727 * @see elm_hoversel_item_add()
14729 EAPI void elm_hoversel_item_del_cb_set(Elm_Hoversel_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
14731 * @brief This returns the data pointer supplied with elm_hoversel_item_add()
14732 * that will be passed to associated function callbacks.
14734 * @param item The item to get the data from
14735 * @return The data pointer set with elm_hoversel_item_add()
14737 * @see elm_hoversel_item_add()
14739 EAPI void *elm_hoversel_item_data_get(const Elm_Hoversel_Item *it) EINA_ARG_NONNULL(1);
14741 * @brief This returns the label text of the given hoversel item.
14743 * @param item The item to get the label
14744 * @return The label text of the hoversel item
14746 * @see elm_hoversel_item_add()
14748 EAPI const char *elm_hoversel_item_label_get(const Elm_Hoversel_Item *it) EINA_ARG_NONNULL(1);
14750 * @brief This sets the icon for the given hoversel item.
14752 * @param item The item to set the icon
14753 * @param icon_file An image file path on disk to use for the icon or standard
14755 * @param icon_group The edje group to use if @p icon_file is an edje file. Set this
14756 * to NULL if the icon is not an edje file
14757 * @param icon_type The icon type
14759 * The icon can be loaded from the standard set, from an image file, or from
14762 * @see elm_hoversel_item_add()
14764 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);
14766 * @brief Get the icon object of the hoversel item
14768 * @param item The item to get the icon from
14769 * @param icon_file The image file path on disk used for the icon or standard
14771 * @param icon_group The edje group used if @p icon_file is an edje file. NULL
14772 * if the icon is not an edje file
14773 * @param icon_type The icon type
14775 * @see elm_hoversel_item_icon_set()
14776 * @see elm_hoversel_item_add()
14778 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);
14784 * @defgroup Toolbar Toolbar
14785 * @ingroup Elementary
14787 * @image html img/widget/toolbar/preview-00.png
14788 * @image latex img/widget/toolbar/preview-00.eps width=\textwidth
14790 * @image html img/toolbar.png
14791 * @image latex img/toolbar.eps width=\textwidth
14793 * A toolbar is a widget that displays a list of items inside
14794 * a box. It can be scrollable, show a menu with items that don't fit
14795 * to toolbar size or even crop them.
14797 * Only one item can be selected at a time.
14799 * Items can have multiple states, or show menus when selected by the user.
14801 * Smart callbacks one can listen to:
14802 * - "clicked" - when the user clicks on a toolbar item and becomes selected.
14803 * - "language,changed" - when the program language changes
14805 * Available styles for it:
14807 * - @c "transparent" - no background or shadow, just show the content
14809 * List of examples:
14810 * @li @ref toolbar_example_01
14811 * @li @ref toolbar_example_02
14812 * @li @ref toolbar_example_03
14816 * @addtogroup Toolbar
14821 * @enum _Elm_Toolbar_Shrink_Mode
14822 * @typedef Elm_Toolbar_Shrink_Mode
14824 * Set toolbar's items display behavior, it can be scrollabel,
14825 * show a menu with exceeding items, or simply hide them.
14827 * @note Default value is #ELM_TOOLBAR_SHRINK_MENU. It reads value
14830 * Values <b> don't </b> work as bitmask, only one can be choosen.
14832 * @see elm_toolbar_mode_shrink_set()
14833 * @see elm_toolbar_mode_shrink_get()
14837 typedef enum _Elm_Toolbar_Shrink_Mode
14839 ELM_TOOLBAR_SHRINK_NONE, /**< Set toolbar minimun size to fit all the items. */
14840 ELM_TOOLBAR_SHRINK_HIDE, /**< Hide exceeding items. */
14841 ELM_TOOLBAR_SHRINK_SCROLL, /**< Allow accessing exceeding items through a scroller. */
14842 ELM_TOOLBAR_SHRINK_MENU, /**< Inserts a button to pop up a menu with exceeding items. */
14843 ELM_TOOLBAR_SHRINK_LAST /**< Indicates error if returned by elm_toolbar_shrink_mode_get() */
14844 } Elm_Toolbar_Shrink_Mode;
14846 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(). */
14849 * Add a new toolbar widget to the given parent Elementary
14850 * (container) object.
14852 * @param parent The parent object.
14853 * @return a new toolbar widget handle or @c NULL, on errors.
14855 * This function inserts a new toolbar widget on the canvas.
14859 EAPI Evas_Object *elm_toolbar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
14861 * Set the icon size, in pixels, to be used by toolbar items.
14863 * @param obj The toolbar object
14864 * @param icon_size The icon size in pixels
14866 * @note Default value is @c 32. It reads value from elm config.
14868 * @see elm_toolbar_icon_size_get()
14872 EAPI void elm_toolbar_icon_size_set(Evas_Object *obj, int icon_size) EINA_ARG_NONNULL(1);
14874 * Get the icon size, in pixels, to be used by toolbar items.
14876 * @param obj The toolbar object.
14877 * @return The icon size in pixels.
14879 * @see elm_toolbar_icon_size_set() for details.
14883 EAPI int elm_toolbar_icon_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14885 * Sets icon lookup order, for toolbar items' icons.
14887 * @param obj The toolbar object.
14888 * @param order The icon lookup order.
14890 * Icons added before calling this function will not be affected.
14891 * The default lookup order is #ELM_ICON_LOOKUP_THEME_FDO.
14893 * @see elm_toolbar_icon_order_lookup_get()
14897 EAPI void elm_toolbar_icon_order_lookup_set(Evas_Object *obj, Elm_Icon_Lookup_Order order) EINA_ARG_NONNULL(1);
14899 * Gets the icon lookup order.
14901 * @param obj The toolbar object.
14902 * @return The icon lookup order.
14904 * @see elm_toolbar_icon_order_lookup_set() for details.
14908 EAPI Elm_Icon_Lookup_Order elm_toolbar_icon_order_lookup_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14910 * Set whether the toolbar should always have an item selected.
14912 * @param obj The toolbar object.
14913 * @param wrap @c EINA_TRUE to enable always-select mode or @c EINA_FALSE to
14916 * This will cause the toolbar to always have an item selected, and clicking
14917 * the selected item will not cause a selected event to be emitted. Enabling this mode
14918 * will immediately select the first toolbar item.
14920 * Always-selected is disabled by default.
14922 * @see elm_toolbar_always_select_mode_get().
14926 EAPI void elm_toolbar_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
14928 * Get whether the toolbar should always have an item selected.
14930 * @param obj The toolbar object.
14931 * @return @c EINA_TRUE means an item will always be selected, @c EINA_FALSE indicates
14932 * that it is possible to have no items selected. If @p obj is @c NULL, @c EINA_FALSE is returned.
14934 * @see elm_toolbar_always_select_mode_set() for details.
14938 EAPI Eina_Bool elm_toolbar_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14940 * Set whether the toolbar items' should be selected by the user or not.
14942 * @param obj The toolbar object.
14943 * @param wrap @c EINA_TRUE to disable selection or @c EINA_FALSE to
14946 * This will turn off the ability to select items entirely and they will
14947 * neither appear selected nor emit selected signals. The clicked
14948 * callback function will still be called.
14950 * Selection is enabled by default.
14952 * @see elm_toolbar_no_select_mode_get().
14956 EAPI void elm_toolbar_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
14959 * Set whether the toolbar items' should be selected by the user or not.
14961 * @param obj The toolbar object.
14962 * @return @c EINA_TRUE means items can be selected. @c EINA_FALSE indicates
14963 * they can't. If @p obj is @c NULL, @c EINA_FALSE is returned.
14965 * @see elm_toolbar_no_select_mode_set() for details.
14969 EAPI Eina_Bool elm_toolbar_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14971 * Append item to the toolbar.
14973 * @param obj The toolbar object.
14974 * @param icon A string with icon name or the absolute path of an image file.
14975 * @param label The label of the item.
14976 * @param func The function to call when the item is clicked.
14977 * @param data The data to associate with the item for related callbacks.
14978 * @return The created item or @c NULL upon failure.
14980 * A new item will be created and appended to the toolbar, i.e., will
14981 * be set as @b last item.
14983 * Items created with this method can be deleted with
14984 * elm_toolbar_item_del().
14986 * Associated @p data can be properly freed when item is deleted if a
14987 * callback function is set with elm_toolbar_item_del_cb_set().
14989 * If a function is passed as argument, it will be called everytime this item
14990 * is selected, i.e., the user clicks over an unselected item.
14991 * If such function isn't needed, just passing
14992 * @c NULL as @p func is enough. The same should be done for @p data.
14994 * Toolbar will load icon image from fdo or current theme.
14995 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
14996 * If an absolute path is provided it will load it direct from a file.
14998 * @see elm_toolbar_item_icon_set()
14999 * @see elm_toolbar_item_del()
15000 * @see elm_toolbar_item_del_cb_set()
15004 EAPI Elm_Object_Item *elm_toolbar_item_append(Evas_Object *obj, const char *icon, const char *label, Evas_Smart_Cb func, const void *data) EINA_ARG_NONNULL(1);
15006 * Prepend item to the toolbar.
15008 * @param obj The toolbar object.
15009 * @param icon A string with icon name or the absolute path of an image file.
15010 * @param label The label of the item.
15011 * @param func The function to call when the item is clicked.
15012 * @param data The data to associate with the item for related callbacks.
15013 * @return The created item or @c NULL upon failure.
15015 * A new item will be created and prepended to the toolbar, i.e., will
15016 * be set as @b first item.
15018 * Items created with this method can be deleted with
15019 * elm_toolbar_item_del().
15021 * Associated @p data can be properly freed when item is deleted if a
15022 * callback function is set with elm_toolbar_item_del_cb_set().
15024 * If a function is passed as argument, it will be called everytime this item
15025 * is selected, i.e., the user clicks over an unselected item.
15026 * If such function isn't needed, just passing
15027 * @c NULL as @p func is enough. The same should be done for @p data.
15029 * Toolbar will load icon image from fdo or current theme.
15030 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
15031 * If an absolute path is provided it will load it direct from a file.
15033 * @see elm_toolbar_item_icon_set()
15034 * @see elm_toolbar_item_del()
15035 * @see elm_toolbar_item_del_cb_set()
15039 EAPI Elm_Object_Item *elm_toolbar_item_prepend(Evas_Object *obj, const char *icon, const char *label, Evas_Smart_Cb func, const void *data) EINA_ARG_NONNULL(1);
15041 * Insert a new item into the toolbar object before item @p before.
15043 * @param obj The toolbar object.
15044 * @param before The toolbar item to insert before.
15045 * @param icon A string with icon name or the absolute path of an image file.
15046 * @param label The label of the item.
15047 * @param func The function to call when the item is clicked.
15048 * @param data The data to associate with the item for related callbacks.
15049 * @return The created item or @c NULL upon failure.
15051 * A new item will be created and added to the toolbar. Its position in
15052 * this toolbar will be just before item @p before.
15054 * Items created with this method can be deleted with
15055 * elm_toolbar_item_del().
15057 * Associated @p data can be properly freed when item is deleted if a
15058 * callback function is set with elm_toolbar_item_del_cb_set().
15060 * If a function is passed as argument, it will be called everytime this item
15061 * is selected, i.e., the user clicks over an unselected item.
15062 * If such function isn't needed, just passing
15063 * @c NULL as @p func is enough. The same should be done for @p data.
15065 * Toolbar will load icon image from fdo or current theme.
15066 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
15067 * If an absolute path is provided it will load it direct from a file.
15069 * @see elm_toolbar_item_icon_set()
15070 * @see elm_toolbar_item_del()
15071 * @see elm_toolbar_item_del_cb_set()
15075 EAPI Elm_Object_Item *elm_toolbar_item_insert_before(Evas_Object *obj, Elm_Object_Item *before, const char *icon, const char *label, Evas_Smart_Cb func, const void *data) EINA_ARG_NONNULL(1);
15078 * Insert a new item into the toolbar object after item @p after.
15080 * @param obj The toolbar object.
15081 * @param after The toolbar item to insert after.
15082 * @param icon A string with icon name or the absolute path of an image file.
15083 * @param label The label of the item.
15084 * @param func The function to call when the item is clicked.
15085 * @param data The data to associate with the item for related callbacks.
15086 * @return The created item or @c NULL upon failure.
15088 * A new item will be created and added to the toolbar. Its position in
15089 * this toolbar will be just after item @p after.
15091 * Items created with this method can be deleted with
15092 * elm_toolbar_item_del().
15094 * Associated @p data can be properly freed when item is deleted if a
15095 * callback function is set with elm_toolbar_item_del_cb_set().
15097 * If a function is passed as argument, it will be called everytime this item
15098 * is selected, i.e., the user clicks over an unselected item.
15099 * If such function isn't needed, just passing
15100 * @c NULL as @p func is enough. The same should be done for @p data.
15102 * Toolbar will load icon image from fdo or current theme.
15103 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
15104 * If an absolute path is provided it will load it direct from a file.
15106 * @see elm_toolbar_item_icon_set()
15107 * @see elm_toolbar_item_del()
15108 * @see elm_toolbar_item_del_cb_set()
15112 EAPI Elm_Object_Item *elm_toolbar_item_insert_after(Evas_Object *obj, Elm_Object_Item *after, const char *icon, const char *label, Evas_Smart_Cb func, const void *data) EINA_ARG_NONNULL(1);
15114 * Get the first item in the given toolbar widget's list of
15117 * @param obj The toolbar object
15118 * @return The first item or @c NULL, if it has no items (and on
15121 * @see elm_toolbar_item_append()
15122 * @see elm_toolbar_last_item_get()
15126 EAPI Elm_Object_Item *elm_toolbar_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15128 * Get the last item in the given toolbar widget's list of
15131 * @param obj The toolbar object
15132 * @return The last item or @c NULL, if it has no items (and on
15135 * @see elm_toolbar_item_prepend()
15136 * @see elm_toolbar_first_item_get()
15140 EAPI Elm_Object_Item *elm_toolbar_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15142 * Get the item after @p item in toolbar.
15144 * @param it The toolbar item.
15145 * @return The item after @p item, or @c NULL if none or on failure.
15147 * @note If it is the last item, @c NULL will be returned.
15149 * @see elm_toolbar_item_append()
15153 EAPI Elm_Object_Item *elm_toolbar_item_next_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
15155 * Get the item before @p item in toolbar.
15157 * @param item The toolbar item.
15158 * @return The item before @p item, or @c NULL if none or on failure.
15160 * @note If it is the first item, @c NULL will be returned.
15162 * @see elm_toolbar_item_prepend()
15166 EAPI Elm_Object_Item *elm_toolbar_item_prev_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
15168 * Get the toolbar object from an item.
15170 * @param it The item.
15171 * @return The toolbar object.
15173 * This returns the toolbar object itself that an item belongs to.
15177 EAPI Evas_Object *elm_toolbar_item_toolbar_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
15179 * Set the priority of a toolbar item.
15181 * @param it The toolbar item.
15182 * @param priority The item priority. The default is zero.
15184 * This is used only when the toolbar shrink mode is set to
15185 * #ELM_TOOLBAR_SHRINK_MENU or #ELM_TOOLBAR_SHRINK_HIDE.
15186 * When space is less than required, items with low priority
15187 * will be removed from the toolbar and added to a dynamically-created menu,
15188 * while items with higher priority will remain on the toolbar,
15189 * with the same order they were added.
15191 * @see elm_toolbar_item_priority_get()
15195 EAPI void elm_toolbar_item_priority_set(Elm_Object_Item *it, int priority) EINA_ARG_NONNULL(1);
15197 * Get the priority of a toolbar item.
15199 * @param it The toolbar item.
15200 * @return The @p item priority, or @c 0 on failure.
15202 * @see elm_toolbar_item_priority_set() for details.
15206 EAPI int elm_toolbar_item_priority_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
15208 * Get the label of item.
15210 * @param it The item of toolbar.
15211 * @return The label of item.
15213 * The return value is a pointer to the label associated to @p item when
15214 * it was created, with function elm_toolbar_item_append() or similar,
15216 * with function elm_toolbar_item_label_set. If no label
15217 * was passed as argument, it will return @c NULL.
15219 * @see elm_toolbar_item_label_set() for more details.
15220 * @see elm_toolbar_item_append()
15224 EAPI const char *elm_toolbar_item_label_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
15226 * Set the label of item.
15228 * @param it The item of toolbar.
15229 * @param text The label of item.
15231 * The label to be displayed by the item.
15232 * Label will be placed at icons bottom (if set).
15234 * If a label was passed as argument on item creation, with function
15235 * elm_toolbar_item_append() or similar, it will be already
15236 * displayed by the item.
15238 * @see elm_toolbar_item_label_get()
15239 * @see elm_toolbar_item_append()
15243 EAPI void elm_toolbar_item_label_set(Elm_Object_Item *it, const char *label) EINA_ARG_NONNULL(1);
15245 * Return the data associated with a given toolbar widget item.
15247 * @param it The toolbar widget item handle.
15248 * @return The data associated with @p item.
15250 * @see elm_toolbar_item_data_set()
15254 EAPI void *elm_toolbar_item_data_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
15256 * Set the data associated with a given toolbar widget item.
15258 * @param it The toolbar widget item handle
15259 * @param data The new data pointer to set to @p item.
15261 * This sets new item data on @p item.
15263 * @warning The old data pointer won't be touched by this function, so
15264 * the user had better to free that old data himself/herself.
15268 EAPI void elm_toolbar_item_data_set(Elm_Object_Item *it, const void *data) EINA_ARG_NONNULL(1);
15270 * Returns a pointer to a toolbar item by its label.
15272 * @param obj The toolbar object.
15273 * @param label The label of the item to find.
15275 * @return The pointer to the toolbar item matching @p label or @c NULL
15280 EAPI Elm_Object_Item *elm_toolbar_item_find_by_label(const Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
15282 * Get whether the @p item is selected or not.
15284 * @param it The toolbar item.
15285 * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
15286 * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
15288 * @see elm_toolbar_selected_item_set() for details.
15289 * @see elm_toolbar_item_selected_get()
15293 EAPI Eina_Bool elm_toolbar_item_selected_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
15295 * Set the selected state of an item.
15297 * @param it The toolbar item
15298 * @param selected The selected state
15300 * This sets the selected state of the given item @p it.
15301 * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
15303 * If a new item is selected the previosly selected will be unselected.
15304 * Previoulsy selected item can be get with function
15305 * elm_toolbar_selected_item_get().
15307 * Selected items will be highlighted.
15309 * @see elm_toolbar_item_selected_get()
15310 * @see elm_toolbar_selected_item_get()
15314 EAPI void elm_toolbar_item_selected_set(Elm_Object_Item *it, Eina_Bool selected) EINA_ARG_NONNULL(1);
15316 * Get the selected item.
15318 * @param obj The toolbar object.
15319 * @return The selected toolbar item.
15321 * The selected item can be unselected with function
15322 * elm_toolbar_item_selected_set().
15324 * The selected item always will be highlighted on toolbar.
15326 * @see elm_toolbar_selected_items_get()
15330 EAPI Elm_Object_Item *elm_toolbar_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15332 * Set the icon associated with @p item.
15334 * @param obj The parent of this item.
15335 * @param it The toolbar item.
15336 * @param icon A string with icon name or the absolute path of an image file.
15338 * Toolbar will load icon image from fdo or current theme.
15339 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
15340 * If an absolute path is provided it will load it direct from a file.
15342 * @see elm_toolbar_icon_order_lookup_set()
15343 * @see elm_toolbar_icon_order_lookup_get()
15347 EAPI void elm_toolbar_item_icon_set(Elm_Object_Item *it, const char *icon) EINA_ARG_NONNULL(1);
15349 * Get the string used to set the icon of @p item.
15351 * @param it The toolbar item.
15352 * @return The string associated with the icon object.
15354 * @see elm_toolbar_item_icon_set() for details.
15358 EAPI const char *elm_toolbar_item_icon_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
15360 * Get the object of @p item.
15362 * @param it The toolbar item.
15363 * @return The object
15367 EAPI Evas_Object *elm_toolbar_item_object_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
15369 * Get the icon object of @p item.
15371 * @param it The toolbar item.
15372 * @return The icon object
15374 * @see elm_toolbar_item_icon_set(), elm_toolbar_item_icon_file_set(),
15375 * or elm_toolbar_item_icon_memfile_set() for details.
15379 EAPI Evas_Object *elm_toolbar_item_icon_object_get(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
15381 * Set the icon associated with @p item to an image in a binary buffer.
15383 * @param it The toolbar item.
15384 * @param img The binary data that will be used as an image
15385 * @param size The size of binary data @p img
15386 * @param format Optional format of @p img to pass to the image loader
15387 * @param key Optional key of @p img to pass to the image loader (eg. if @p img is an edje file)
15389 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
15391 * @note The icon image set by this function can be changed by
15392 * elm_toolbar_item_icon_set().
15396 EAPI Eina_Bool elm_toolbar_item_icon_memfile_set(Elm_Object_Item *it, const void *img, size_t size, const char *format, const char *key) EINA_ARG_NONNULL(1);
15399 * Set the icon associated with @p item to an image in a binary buffer.
15401 * @param it The toolbar item.
15402 * @param file The file that contains the image
15403 * @param key Optional key of @p img to pass to the image loader (eg. if @p img is an edje file)
15405 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
15407 * @note The icon image set by this function can be changed by
15408 * elm_toolbar_item_icon_set().
15412 EAPI Eina_Bool elm_toolbar_item_icon_file_set(Elm_Object_Item *it, const char *file, const char *key) EINA_ARG_NONNULL(1);
15415 * Delete them item from the toolbar.
15417 * @param it The item of toolbar to be deleted.
15419 * @see elm_toolbar_item_append()
15420 * @see elm_toolbar_item_del_cb_set()
15424 EAPI void elm_toolbar_item_del(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
15427 * Set the function called when a toolbar item is freed.
15429 * @param it The item to set the callback on.
15430 * @param func The function called.
15432 * If there is a @p func, then it will be called prior item's memory release.
15433 * That will be called with the following arguments:
15435 * @li item's Evas object;
15438 * This way, a data associated to a toolbar item could be properly freed.
15442 EAPI void elm_toolbar_item_del_cb_set(Elm_Object_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
15445 * Get a value whether toolbar item is disabled or not.
15447 * @param it The item.
15448 * @return The disabled state.
15450 * @see elm_toolbar_item_disabled_set() for more details.
15454 EAPI Eina_Bool elm_toolbar_item_disabled_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
15457 * Sets the disabled/enabled state of a toolbar item.
15459 * @param it The item.
15460 * @param disabled The disabled state.
15462 * A disabled item cannot be selected or unselected. It will also
15463 * change its appearance (generally greyed out). This sets the
15464 * disabled state (@c EINA_TRUE for disabled, @c EINA_FALSE for
15469 EAPI void elm_toolbar_item_disabled_set(Elm_Object_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1);
15472 * Set or unset item as a separator.
15474 * @param it The toolbar item.
15475 * @param setting @c EINA_TRUE to set item @p item as separator or
15476 * @c EINA_FALSE to unset, i.e., item will be used as a regular item.
15478 * Items aren't set as separator by default.
15480 * If set as separator it will display separator theme, so won't display
15483 * @see elm_toolbar_item_separator_get()
15487 EAPI void elm_toolbar_item_separator_set(Elm_Object_Item *it, Eina_Bool separator) EINA_ARG_NONNULL(1);
15490 * Get a value whether item is a separator or not.
15492 * @param it The toolbar item.
15493 * @return @c EINA_TRUE means item @p it is a separator. @c EINA_FALSE
15494 * indicates it's not. If @p it is @c NULL, @c EINA_FALSE is returned.
15496 * @see elm_toolbar_item_separator_set() for details.
15500 EAPI Eina_Bool elm_toolbar_item_separator_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
15503 * Set the shrink state of toolbar @p obj.
15505 * @param obj The toolbar object.
15506 * @param shrink_mode Toolbar's items display behavior.
15508 * The toolbar won't scroll if #ELM_TOOLBAR_SHRINK_NONE,
15509 * but will enforce a minimun size so all the items will fit, won't scroll
15510 * and won't show the items that don't fit if #ELM_TOOLBAR_SHRINK_HIDE,
15511 * will scroll if #ELM_TOOLBAR_SHRINK_SCROLL, and will create a button to
15512 * pop up excess elements with #ELM_TOOLBAR_SHRINK_MENU.
15516 EAPI void elm_toolbar_mode_shrink_set(Evas_Object *obj, Elm_Toolbar_Shrink_Mode shrink_mode) EINA_ARG_NONNULL(1);
15519 * Get the shrink mode of toolbar @p obj.
15521 * @param obj The toolbar object.
15522 * @return Toolbar's items display behavior.
15524 * @see elm_toolbar_mode_shrink_set() for details.
15528 EAPI Elm_Toolbar_Shrink_Mode elm_toolbar_mode_shrink_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15531 * Enable/disable homogeneous mode.
15533 * @param obj The toolbar object
15534 * @param homogeneous Assume the items within the toolbar are of the
15535 * same size (EINA_TRUE = on, EINA_FALSE = off). Default is @c EINA_FALSE.
15537 * This will enable the homogeneous mode where items are of the same size.
15538 * @see elm_toolbar_homogeneous_get()
15542 EAPI void elm_toolbar_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
15545 * Get whether the homogeneous mode is enabled.
15547 * @param obj The toolbar object.
15548 * @return Assume the items within the toolbar are of the same height
15549 * and width (EINA_TRUE = on, EINA_FALSE = off).
15551 * @see elm_toolbar_homogeneous_set()
15555 EAPI Eina_Bool elm_toolbar_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15557 * Set the parent object of the toolbar items' menus.
15559 * @param obj The toolbar object.
15560 * @param parent The parent of the menu objects.
15562 * Each item can be set as item menu, with elm_toolbar_item_menu_set().
15564 * For more details about setting the parent for toolbar menus, see
15565 * elm_menu_parent_set().
15567 * @see elm_menu_parent_set() for details.
15568 * @see elm_toolbar_item_menu_set() for details.
15572 EAPI void elm_toolbar_menu_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
15574 * Get the parent object of the toolbar items' menus.
15576 * @param obj The toolbar object.
15577 * @return The parent of the menu objects.
15579 * @see elm_toolbar_menu_parent_set() for details.
15583 EAPI Evas_Object *elm_toolbar_menu_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15585 * Set the alignment of the items.
15587 * @param obj The toolbar object.
15588 * @param align The new alignment, a float between <tt> 0.0 </tt>
15589 * and <tt> 1.0 </tt>.
15591 * Alignment of toolbar items, from <tt> 0.0 </tt> to indicates to align
15592 * left, to <tt> 1.0 </tt>, to align to right. <tt> 0.5 </tt> centralize
15595 * Centered items by default.
15597 * @see elm_toolbar_align_get()
15601 EAPI void elm_toolbar_align_set(Evas_Object *obj, double align) EINA_ARG_NONNULL(1);
15603 * Get the alignment of the items.
15605 * @param obj The toolbar object.
15606 * @return toolbar items alignment, a float between <tt> 0.0 </tt> and
15609 * @see elm_toolbar_align_set() for details.
15613 EAPI double elm_toolbar_align_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15615 * Set whether the toolbar item opens a menu.
15617 * @param it The toolbar item.
15618 * @param menu If @c EINA_TRUE, @p item will opens a menu when selected.
15620 * A toolbar item can be set to be a menu, using this function.
15622 * Once it is set to be a menu, it can be manipulated through the
15623 * menu-like function elm_toolbar_menu_parent_set() and the other
15624 * elm_menu functions, using the Evas_Object @c menu returned by
15625 * elm_toolbar_item_menu_get().
15627 * So, items to be displayed in this item's menu should be added with
15628 * elm_menu_item_add().
15630 * The following code exemplifies the most basic usage:
15632 * tb = elm_toolbar_add(win)
15633 * item = elm_toolbar_item_append(tb, "refresh", "Menu", NULL, NULL);
15634 * elm_toolbar_item_menu_set(item, EINA_TRUE);
15635 * elm_toolbar_menu_parent_set(tb, win);
15636 * menu = elm_toolbar_item_menu_get(item);
15637 * elm_menu_item_add(menu, NULL, "edit-cut", "Cut", NULL, NULL);
15638 * menu_item = elm_menu_item_add(menu, NULL, "edit-copy", "Copy", NULL,
15642 * @see elm_toolbar_item_menu_get()
15646 EAPI void elm_toolbar_item_menu_set(Elm_Object_Item *it, Eina_Bool menu) EINA_ARG_NONNULL(1);
15648 * Get toolbar item's menu.
15650 * @param it The toolbar item.
15651 * @return Item's menu object or @c NULL on failure.
15653 * If @p item wasn't set as menu item with elm_toolbar_item_menu_set(),
15654 * this function will set it.
15656 * @see elm_toolbar_item_menu_set() for details.
15660 EAPI Evas_Object *elm_toolbar_item_menu_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
15662 * Add a new state to @p item.
15664 * @param it The toolbar item.
15665 * @param icon A string with icon name or the absolute path of an image file.
15666 * @param label The label of the new state.
15667 * @param func The function to call when the item is clicked when this
15668 * state is selected.
15669 * @param data The data to associate with the state.
15670 * @return The toolbar item state, or @c NULL upon failure.
15672 * Toolbar will load icon image from fdo or current theme.
15673 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
15674 * If an absolute path is provided it will load it direct from a file.
15676 * States created with this function can be removed with
15677 * elm_toolbar_item_state_del().
15679 * @see elm_toolbar_item_state_del()
15680 * @see elm_toolbar_item_state_sel()
15681 * @see elm_toolbar_item_state_get()
15685 EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_add(Elm_Object_Item *it, const char *icon, const char *label, Evas_Smart_Cb func, const void *data) EINA_ARG_NONNULL(1);
15687 * Delete a previoulsy added state to @p item.
15689 * @param it The toolbar item.
15690 * @param state The state to be deleted.
15691 * @return @c EINA_TRUE on success or @c EINA_FALSE on failure.
15693 * @see elm_toolbar_item_state_add()
15695 EAPI Eina_Bool elm_toolbar_item_state_del(Elm_Object_Item *it, Elm_Toolbar_Item_State *state) EINA_ARG_NONNULL(1);
15697 * Set @p state as the current state of @p it.
15699 * @param it The toolbar item.
15700 * @param state The state to use.
15701 * @return @c EINA_TRUE on success or @c EINA_FALSE on failure.
15703 * If @p state is @c NULL, it won't select any state and the default item's
15704 * icon and label will be used. It's the same behaviour than
15705 * elm_toolbar_item_state_unser().
15707 * @see elm_toolbar_item_state_unset()
15711 EAPI Eina_Bool elm_toolbar_item_state_set(Elm_Object_Item *it, Elm_Toolbar_Item_State *state) EINA_ARG_NONNULL(1);
15713 * Unset the state of @p it.
15715 * @param it The toolbar item.
15717 * The default icon and label from this item will be displayed.
15719 * @see elm_toolbar_item_state_set() for more details.
15723 EAPI void elm_toolbar_item_state_unset(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
15725 * Get the current state of @p it.
15727 * @param it The toolbar item.
15728 * @return The selected state or @c NULL if none is selected or on failure.
15730 * @see elm_toolbar_item_state_set() for details.
15731 * @see elm_toolbar_item_state_unset()
15732 * @see elm_toolbar_item_state_add()
15736 EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
15738 * Get the state after selected state in toolbar's @p item.
15740 * @param it The toolbar item to change state.
15741 * @return The state after current state, or @c NULL on failure.
15743 * If last state is selected, this function will return first state.
15745 * @see elm_toolbar_item_state_set()
15746 * @see elm_toolbar_item_state_add()
15750 EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_next(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
15752 * Get the state before selected state in toolbar's @p item.
15754 * @param it The toolbar item to change state.
15755 * @return The state before current state, or @c NULL on failure.
15757 * If first state is selected, this function will return last state.
15759 * @see elm_toolbar_item_state_set()
15760 * @see elm_toolbar_item_state_add()
15764 EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_prev(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
15766 * Set the text to be shown in a given toolbar item's tooltips.
15768 * @param it toolbar item.
15769 * @param text The text to set in the content.
15771 * Setup the text as tooltip to object. The item can have only one tooltip,
15772 * so any previous tooltip data - set with this function or
15773 * elm_toolbar_item_tooltip_content_cb_set() - is removed.
15775 * @see elm_object_tooltip_text_set() for more details.
15779 EAPI void elm_toolbar_item_tooltip_text_set(Elm_Object_Item *it, const char *text) EINA_ARG_NONNULL(1);
15781 * Set the content to be shown in the tooltip item.
15783 * Setup the tooltip to item. The item can have only one tooltip,
15784 * so any previous tooltip data is removed. @p func(with @p data) will
15785 * be called every time that need show the tooltip and it should
15786 * return a valid Evas_Object. This object is then managed fully by
15787 * tooltip system and is deleted when the tooltip is gone.
15789 * @param it the toolbar item being attached a tooltip.
15790 * @param func the function used to create the tooltip contents.
15791 * @param data what to provide to @a func as callback data/context.
15792 * @param del_cb called when data is not needed anymore, either when
15793 * another callback replaces @a func, the tooltip is unset with
15794 * elm_toolbar_item_tooltip_unset() or the owner @a item
15795 * dies. This callback receives as the first parameter the
15796 * given @a data, and @c event_info is the item.
15798 * @see elm_object_tooltip_content_cb_set() for more details.
15802 EAPI void elm_toolbar_item_tooltip_content_cb_set(Elm_Object_Item *it, Elm_Tooltip_Item_Content_Cb func, const void *data, Evas_Smart_Cb del_cb) EINA_ARG_NONNULL(1);
15804 * Unset tooltip from item.
15806 * @param it toolbar item to remove previously set tooltip.
15808 * Remove tooltip from item. The callback provided as del_cb to
15809 * elm_toolbar_item_tooltip_content_cb_set() will be called to notify
15810 * it is not used anymore.
15812 * @see elm_object_tooltip_unset() for more details.
15813 * @see elm_toolbar_item_tooltip_content_cb_set()
15817 EAPI void elm_toolbar_item_tooltip_unset(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
15819 * Sets a different style for this item tooltip.
15821 * @note before you set a style you should define a tooltip with
15822 * elm_toolbar_item_tooltip_content_cb_set() or
15823 * elm_toolbar_item_tooltip_text_set()
15825 * @param it toolbar item with tooltip already set.
15826 * @param style the theme style to use (default, transparent, ...)
15828 * @see elm_object_tooltip_style_set() for more details.
15832 EAPI void elm_toolbar_item_tooltip_style_set(Elm_Object_Item *it, const char *style) EINA_ARG_NONNULL(1);
15834 * Get the style for this item tooltip.
15836 * @param it toolbar item with tooltip already set.
15837 * @return style the theme style in use, defaults to "default". If the
15838 * object does not have a tooltip set, then NULL is returned.
15840 * @see elm_object_tooltip_style_get() for more details.
15841 * @see elm_toolbar_item_tooltip_style_set()
15845 EAPI const char *elm_toolbar_item_tooltip_style_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
15847 * Set the type of mouse pointer/cursor decoration to be shown,
15848 * when the mouse pointer is over the given toolbar widget item
15850 * @param it toolbar item to customize cursor on
15851 * @param cursor the cursor type's name
15853 * This function works analogously as elm_object_cursor_set(), but
15854 * here the cursor's changing area is restricted to the item's
15855 * area, and not the whole widget's. Note that that item cursors
15856 * have precedence over widget cursors, so that a mouse over an
15857 * item with custom cursor set will always show @b that cursor.
15859 * If this function is called twice for an object, a previously set
15860 * cursor will be unset on the second call.
15862 * @see elm_object_cursor_set()
15863 * @see elm_toolbar_item_cursor_get()
15864 * @see elm_toolbar_item_cursor_unset()
15868 EAPI void elm_toolbar_item_cursor_set(Elm_Object_Item *it, const char *cursor) EINA_ARG_NONNULL(1);
15871 * Get the type of mouse pointer/cursor decoration set to be shown,
15872 * when the mouse pointer is over the given toolbar widget item
15874 * @param it toolbar item with custom cursor set
15875 * @return the cursor type's name or @c NULL, if no custom cursors
15876 * were set to @p item (and on errors)
15878 * @see elm_object_cursor_get()
15879 * @see elm_toolbar_item_cursor_set()
15880 * @see elm_toolbar_item_cursor_unset()
15884 EAPI const char *elm_toolbar_item_cursor_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
15887 * Unset any custom mouse pointer/cursor decoration set to be
15888 * shown, when the mouse pointer is over the given toolbar widget
15889 * item, thus making it show the @b default cursor again.
15891 * @param it a toolbar item
15893 * Use this call to undo any custom settings on this item's cursor
15894 * decoration, bringing it back to defaults (no custom style set).
15896 * @see elm_object_cursor_unset()
15897 * @see elm_toolbar_item_cursor_set()
15901 EAPI void elm_toolbar_item_cursor_unset(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
15904 * Set a different @b style for a given custom cursor set for a
15907 * @param it toolbar item with custom cursor set
15908 * @param style the <b>theme style</b> to use (e.g. @c "default",
15909 * @c "transparent", etc)
15911 * This function only makes sense when one is using custom mouse
15912 * cursor decorations <b>defined in a theme file</b>, which can have,
15913 * given a cursor name/type, <b>alternate styles</b> on it. It
15914 * works analogously as elm_object_cursor_style_set(), but here
15915 * applyed only to toolbar item objects.
15917 * @warning Before you set a cursor style you should have definen a
15918 * custom cursor previously on the item, with
15919 * elm_toolbar_item_cursor_set()
15921 * @see elm_toolbar_item_cursor_engine_only_set()
15922 * @see elm_toolbar_item_cursor_style_get()
15926 EAPI void elm_toolbar_item_cursor_style_set(Elm_Object_Item *it, const char *style) EINA_ARG_NONNULL(1);
15929 * Get the current @b style set for a given toolbar item's custom
15932 * @param it toolbar item with custom cursor set.
15933 * @return style the cursor style in use. If the object does not
15934 * have a cursor set, then @c NULL is returned.
15936 * @see elm_toolbar_item_cursor_style_set() for more details
15940 EAPI const char *elm_toolbar_item_cursor_style_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
15943 * Set if the (custom)cursor for a given toolbar item should be
15944 * searched in its theme, also, or should only rely on the
15945 * rendering engine.
15947 * @param it item with custom (custom) cursor already set on
15948 * @param engine_only Use @c EINA_TRUE to have cursors looked for
15949 * only on those provided by the rendering engine, @c EINA_FALSE to
15950 * have them searched on the widget's theme, as well.
15952 * @note This call is of use only if you've set a custom cursor
15953 * for toolbar items, with elm_toolbar_item_cursor_set().
15955 * @note By default, cursors will only be looked for between those
15956 * provided by the rendering engine.
15960 EAPI void elm_toolbar_item_cursor_engine_only_set(Elm_Object_Item *it, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
15963 * Get if the (custom) cursor for a given toolbar item is being
15964 * searched in its theme, also, or is only relying on the rendering
15967 * @param it a toolbar item
15968 * @return @c EINA_TRUE, if cursors are being looked for only on
15969 * those provided by the rendering engine, @c EINA_FALSE if they
15970 * are being searched on the widget's theme, as well.
15972 * @see elm_toolbar_item_cursor_engine_only_set(), for more details
15976 EAPI Eina_Bool elm_toolbar_item_cursor_engine_only_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
15979 * Change a toolbar's orientation
15980 * @param obj The toolbar object
15981 * @param vertical If @c EINA_TRUE, the toolbar is vertical
15982 * By default, a toolbar will be horizontal. Use this function to create a vertical toolbar.
15984 * @deprecated use elm_toolbar_horizontal_set() instead.
15986 EINA_DEPRECATED EAPI void elm_toolbar_orientation_set(Evas_Object *obj, Eina_Bool vertical) EINA_ARG_NONNULL(1);
15989 * Change a toolbar's orientation
15990 * @param obj The toolbar object
15991 * @param horizontal If @c EINA_TRUE, the toolbar is horizontal
15992 * By default, a toolbar will be horizontal. Use this function to create a vertical toolbar.
15995 EAPI void elm_toolbar_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
15998 * Get a toolbar's orientation
15999 * @param obj The toolbar object
16000 * @return If @c EINA_TRUE, the toolbar is vertical
16001 * By default, a toolbar will be horizontal. Use this function to determine whether a toolbar is vertical.
16003 * @deprecated use elm_toolbar_horizontal_get() instead.
16005 EINA_DEPRECATED EAPI Eina_Bool elm_toolbar_orientation_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16008 * Get a toolbar's orientation
16009 * @param obj The toolbar object
16010 * @return If @c EINA_TRUE, the toolbar is horizontal
16011 * By default, a toolbar will be horizontal. Use this function to determine whether a toolbar is vertical.
16014 EAPI Eina_Bool elm_toolbar_horizontal_get(const Evas_Object *obj);
16020 * @defgroup Tooltips Tooltips
16022 * The Tooltip is an (internal, for now) smart object used to show a
16023 * content in a frame on mouse hover of objects(or widgets), with
16024 * tips/information about them.
16029 EAPI double elm_tooltip_delay_get(void);
16030 EAPI Eina_Bool elm_tooltip_delay_set(double delay);
16031 EAPI void elm_object_tooltip_show(Evas_Object *obj) EINA_ARG_NONNULL(1);
16032 EAPI void elm_object_tooltip_hide(Evas_Object *obj) EINA_ARG_NONNULL(1);
16033 EAPI void elm_object_tooltip_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1, 2);
16034 EAPI void elm_object_tooltip_domain_translatable_text_set(Evas_Object *obj, const char *domain, const char *text) EINA_ARG_NONNULL(1, 3);
16035 #define elm_object_tooltip_translatable_text_set(obj, text) elm_object_tooltip_domain_translatable_text_set((obj), NULL, (text))
16036 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);
16037 EAPI void elm_object_tooltip_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
16038 EAPI void elm_object_tooltip_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
16039 EAPI const char *elm_object_tooltip_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16040 EAPI Eina_Bool elm_tooltip_size_restrict_disable(Evas_Object *obj, Eina_Bool disable) EINA_ARG_NONNULL(1);
16041 EAPI Eina_Bool elm_tooltip_size_restrict_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16048 * @defgroup Cursors Cursors
16050 * The Elementary cursor is an internal smart object used to
16051 * customize the mouse cursor displayed over objects (or
16052 * widgets). In the most common scenario, the cursor decoration
16053 * comes from the graphical @b engine Elementary is running
16054 * on. Those engines may provide different decorations for cursors,
16055 * and Elementary provides functions to choose them (think of X11
16056 * cursors, as an example).
16058 * There's also the possibility of, besides using engine provided
16059 * cursors, also use ones coming from Edje theming files. Both
16060 * globally and per widget, Elementary makes it possible for one to
16061 * make the cursors lookup to be held on engines only or on
16062 * Elementary's theme file, too. To set cursor's hot spot,
16063 * two data items should be added to cursor's theme: "hot_x" and
16064 * "hot_y", that are the offset from upper-left corner of the cursor
16065 * (coordinates 0,0).
16071 * Set the cursor to be shown when mouse is over the object
16073 * Set the cursor that will be displayed when mouse is over the
16074 * object. The object can have only one cursor set to it, so if
16075 * this function is called twice for an object, the previous set
16077 * If using X cursors, a definition of all the valid cursor names
16078 * is listed on Elementary_Cursors.h. If an invalid name is set
16079 * the default cursor will be used.
16081 * @param obj the object being set a cursor.
16082 * @param cursor the cursor name to be used.
16086 EAPI void elm_object_cursor_set(Evas_Object *obj, const char *cursor) EINA_ARG_NONNULL(1);
16089 * Get the cursor to be shown when mouse is over the object
16091 * @param obj an object with cursor already set.
16092 * @return the cursor name.
16096 EAPI const char *elm_object_cursor_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16099 * Unset cursor for object
16101 * Unset cursor for object, and set the cursor to default if the mouse
16102 * was over this object.
16104 * @param obj Target object
16105 * @see elm_object_cursor_set()
16109 EAPI void elm_object_cursor_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
16112 * Sets a different style for this object cursor.
16114 * @note before you set a style you should define a cursor with
16115 * elm_object_cursor_set()
16117 * @param obj an object with cursor already set.
16118 * @param style the theme style to use (default, transparent, ...)
16122 EAPI void elm_object_cursor_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
16125 * Get the style for this object cursor.
16127 * @param obj an object with cursor already set.
16128 * @return style the theme style in use, defaults to "default". If the
16129 * object does not have a cursor set, then NULL is returned.
16133 EAPI const char *elm_object_cursor_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16136 * Set if the cursor set should be searched on the theme or should use
16137 * the provided by the engine, only.
16139 * @note before you set if should look on theme you should define a cursor
16140 * with elm_object_cursor_set(). By default it will only look for cursors
16141 * provided by the engine.
16143 * @param obj an object with cursor already set.
16144 * @param engine_only boolean to define it cursors should be looked only
16145 * between the provided by the engine or searched on widget's theme as well.
16149 EAPI void elm_object_cursor_engine_only_set(Evas_Object *obj, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
16152 * Get the cursor engine only usage for this object cursor.
16154 * @param obj an object with cursor already set.
16155 * @return engine_only boolean to define it cursors should be
16156 * looked only between the provided by the engine or searched on
16157 * widget's theme as well. If the object does not have a cursor
16158 * set, then EINA_FALSE is returned.
16162 EAPI Eina_Bool elm_object_cursor_engine_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16165 * Get the configured cursor engine only usage
16167 * This gets the globally configured exclusive usage of engine cursors.
16169 * @return 1 if only engine cursors should be used
16172 EAPI int elm_cursor_engine_only_get(void);
16175 * Set the configured cursor engine only usage
16177 * This sets the globally configured exclusive usage of engine cursors.
16178 * It won't affect cursors set before changing this value.
16180 * @param engine_only If 1 only engine cursors will be enabled, if 0 will
16181 * look for them on theme before.
16182 * @return EINA_TRUE if value is valid and setted (0 or 1)
16185 EAPI Eina_Bool elm_cursor_engine_only_set(int engine_only);
16192 * @defgroup Menu Menu
16194 * @image html img/widget/menu/preview-00.png
16195 * @image latex img/widget/menu/preview-00.eps
16197 * A menu is a list of items displayed above its parent. When the menu is
16198 * showing its parent is darkened. Each item can have a sub-menu. The menu
16199 * object can be used to display a menu on a right click event, in a toolbar,
16202 * Signals that you can add callbacks for are:
16203 * @li "clicked" - the user clicked the empty space in the menu to dismiss.
16205 * Default contents parts of the menu items that you can use for are:
16206 * @li "default" - A main content of the menu item
16208 * Default text parts of the menu items that you can use for are:
16209 * @li "default" - label in the menu item
16211 * @see @ref tutorial_menu
16216 * @brief Add a new menu to the parent
16218 * @param parent The parent object.
16219 * @return The new object or NULL if it cannot be created.
16221 EAPI Evas_Object *elm_menu_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
16223 * @brief Set the parent for the given menu widget
16225 * @param obj The menu object.
16226 * @param parent The new parent.
16228 EAPI void elm_menu_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
16230 * @brief Get the parent for the given menu widget
16232 * @param obj The menu object.
16233 * @return The parent.
16235 * @see elm_menu_parent_set()
16237 EAPI Evas_Object *elm_menu_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16239 * @brief Move the menu to a new position
16241 * @param obj The menu object.
16242 * @param x The new position.
16243 * @param y The new position.
16245 * Sets the top-left position of the menu to (@p x,@p y).
16247 * @note @p x and @p y coordinates are relative to parent.
16249 EAPI void elm_menu_move(Evas_Object *obj, Evas_Coord x, Evas_Coord y) EINA_ARG_NONNULL(1);
16251 * @brief Close a opened menu
16253 * @param obj the menu object
16256 * Hides the menu and all it's sub-menus.
16258 EAPI void elm_menu_close(Evas_Object *obj) EINA_ARG_NONNULL(1);
16260 * @brief Returns a list of @p item's items.
16262 * @param obj The menu object
16263 * @return An Eina_List* of @p item's items
16265 EAPI const Eina_List *elm_menu_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16267 * @brief Get the Evas_Object of an Elm_Object_Item
16269 * @param it The menu item object.
16270 * @return The edje object containing the swallowed content
16272 * @warning Don't manipulate this object!
16275 EAPI Evas_Object *elm_menu_item_object_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
16277 * @brief Add an item at the end of the given menu widget
16279 * @param obj The menu object.
16280 * @param parent The parent menu item (optional)
16281 * @param icon An icon display on the item. The icon will be destryed by the menu.
16282 * @param label The label of the item.
16283 * @param func Function called when the user select the item.
16284 * @param data Data sent by the callback.
16285 * @return Returns the new item.
16287 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);
16289 * @brief Add an object swallowed in an item at the end of the given menu
16292 * @param obj The menu object.
16293 * @param parent The parent menu item (optional)
16294 * @param subobj The object to swallow
16295 * @param func Function called when the user select the item.
16296 * @param data Data sent by the callback.
16297 * @return Returns the new item.
16299 * Add an evas object as an item to the menu.
16301 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);
16303 * @brief Set the label of a menu item
16305 * @param it The menu item object.
16306 * @param label The label to set for @p item
16308 * @warning Don't use this funcion on items created with
16309 * elm_menu_item_add_object() or elm_menu_item_separator_add().
16311 * @deprecated Use elm_object_item_text_set() instead
16313 EINA_DEPRECATED EAPI void elm_menu_item_label_set(Elm_Object_Item *it, const char *label) EINA_ARG_NONNULL(1);
16315 * @brief Get the label of a menu item
16317 * @param it The menu item object.
16318 * @return The label of @p item
16319 * @deprecated Use elm_object_item_text_get() instead
16321 EINA_DEPRECATED EAPI const char *elm_menu_item_label_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
16323 * @brief Set the icon of a menu item to the standard icon with name @p icon
16325 * @param it The menu item object.
16326 * @param icon The icon object to set for the content of @p item
16328 * Once this icon is set, any previously set icon will be deleted.
16330 EAPI void elm_menu_item_object_icon_name_set(Elm_Object_Item *it, const char *icon) EINA_ARG_NONNULL(1, 2);
16332 * @brief Get the string representation from the icon of a menu item
16334 * @param it The menu item object.
16335 * @return The string representation of @p item's icon or NULL
16337 * @see elm_menu_item_object_icon_name_set()
16339 EAPI const char *elm_menu_item_object_icon_name_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
16341 * @brief Set the content object of a menu item
16343 * @param it The menu item object
16344 * @param The content object or NULL
16345 * @return EINA_TRUE on success, else EINA_FALSE
16347 * Use this function to change the object swallowed by a menu item, deleting
16348 * any previously swallowed object.
16350 * @deprecated Use elm_object_item_content_set() instead
16352 EINA_DEPRECATED EAPI Eina_Bool elm_menu_item_object_content_set(Elm_Object_Item *it, Evas_Object *obj) EINA_ARG_NONNULL(1);
16354 * @brief Get the content object of a menu item
16356 * @param it The menu item object
16357 * @return The content object or NULL
16358 * @note If @p item was added with elm_menu_item_add_object, this
16359 * function will return the object passed, else it will return the
16362 * @see elm_menu_item_object_content_set()
16364 * @deprecated Use elm_object_item_content_get() instead
16366 EINA_DEPRECATED EAPI Evas_Object *elm_menu_item_object_content_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
16368 * @brief Set the selected state of @p item.
16370 * @param it The menu item object.
16371 * @param selected The selected/unselected state of the item
16373 EAPI void elm_menu_item_selected_set(Elm_Object_Item *it, Eina_Bool selected) EINA_ARG_NONNULL(1);
16375 * @brief Get the selected state of @p item.
16377 * @param it The menu item object.
16378 * @return The selected/unselected state of the item
16380 * @see elm_menu_item_selected_set()
16382 EAPI Eina_Bool elm_menu_item_selected_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
16384 * @brief Set the disabled state of @p item.
16386 * @param it The menu item object.
16387 * @param disabled The enabled/disabled state of the item
16388 * @deprecated Use elm_object_item_disabled_set() instead
16390 EINA_DEPRECATED EAPI void elm_menu_item_disabled_set(Elm_Object_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1);
16392 * @brief Get the disabled state of @p item.
16394 * @param it The menu item object.
16395 * @return The enabled/disabled state of the item
16397 * @see elm_menu_item_disabled_set()
16398 * @deprecated Use elm_object_item_disabled_get() instead
16400 EINA_DEPRECATED EAPI Eina_Bool elm_menu_item_disabled_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
16402 * @brief Add a separator item to menu @p obj under @p parent.
16404 * @param obj The menu object
16405 * @param parent The item to add the separator under
16406 * @return The created item or NULL on failure
16408 * This is item is a @ref Separator.
16410 EAPI Elm_Object_Item *elm_menu_item_separator_add(Evas_Object *obj, Elm_Object_Item *parent) EINA_ARG_NONNULL(1);
16412 * @brief Returns whether @p item is a separator.
16414 * @param it The item to check
16415 * @return If true, @p item is a separator
16417 * @see elm_menu_item_separator_add()
16419 EAPI Eina_Bool elm_menu_item_is_separator(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
16421 * @brief Deletes an item from the menu.
16423 * @param it The item to delete.
16425 * @see elm_menu_item_add()
16427 EAPI void elm_menu_item_del(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
16429 * @brief Set the function called when a menu item is deleted.
16431 * @param it The item to set the callback on
16432 * @param func The function called
16434 * @see elm_menu_item_add()
16435 * @see elm_menu_item_del()
16437 EAPI void elm_menu_item_del_cb_set(Elm_Object_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
16439 * @brief Returns the data associated with menu item @p item.
16441 * @param it The item
16442 * @return The data associated with @p item or NULL if none was set.
16444 * This is the data set with elm_menu_add() or elm_menu_item_data_set().
16446 * @deprecated Use elm_object_item_data_get() instead
16448 EINA_DEPRECATED EAPI void *elm_menu_item_data_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
16450 * @brief Sets the data to be associated with menu item @p item.
16452 * @param it The item
16453 * @param data The data to be associated with @p item
16455 * @deprecated Use elm_object_item_data_set() instead
16457 EINA_DEPRECATED EAPI void elm_menu_item_data_set(Elm_Object_Item *it, const void *data) EINA_ARG_NONNULL(1);
16460 * @brief Returns a list of @p item's subitems.
16462 * @param it The item
16463 * @return An Eina_List* of @p item's subitems
16465 * @see elm_menu_add()
16467 EAPI const Eina_List *elm_menu_item_subitems_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
16469 * @brief Get the position of a menu item
16471 * @param it The menu item
16472 * @return The item's index
16474 * This function returns the index position of a menu item in a menu.
16475 * For a sub-menu, this number is relative to the first item in the sub-menu.
16477 * @note Index values begin with 0
16479 EAPI unsigned int elm_menu_item_index_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1) EINA_PURE;
16481 * @brief @brief Return a menu item's owner menu
16483 * @param it The menu item
16484 * @return The menu object owning @p item, or NULL on failure
16486 * Use this function to get the menu object owning an item.
16488 EAPI Evas_Object *elm_menu_item_menu_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1) EINA_PURE;
16490 * @brief Get the selected item in the menu
16492 * @param obj The menu object
16493 * @return The selected item, or NULL if none
16495 * @see elm_menu_item_selected_get()
16496 * @see elm_menu_item_selected_set()
16498 EAPI Elm_Object_Item *elm_menu_selected_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
16500 * @brief Get the last item in the menu
16502 * @param obj The menu object
16503 * @return The last item, or NULL if none
16505 EAPI Elm_Object_Item *elm_menu_last_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
16507 * @brief Get the first item in the menu
16509 * @param obj The menu object
16510 * @return The first item, or NULL if none
16512 EAPI Elm_Object_Item *elm_menu_first_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
16514 * @brief Get the next item in the menu.
16516 * @param it The menu item object.
16517 * @return The item after it, or NULL if none
16519 EAPI Elm_Object_Item *elm_menu_item_next_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
16521 * @brief Get the previous item in the menu.
16523 * @param it The menu item object.
16524 * @return The item before it, or NULL if none
16526 EAPI Elm_Object_Item *elm_menu_item_prev_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
16532 * @defgroup List List
16533 * @ingroup Elementary
16535 * @image html img/widget/list/preview-00.png
16536 * @image latex img/widget/list/preview-00.eps width=\textwidth
16538 * @image html img/list.png
16539 * @image latex img/list.eps width=\textwidth
16541 * A list widget is a container whose children are displayed vertically or
16542 * horizontally, in order, and can be selected.
16543 * The list can accept only one or multiple items selection. Also has many
16544 * modes of items displaying.
16546 * A list is a very simple type of list widget. For more robust
16547 * lists, @ref Genlist should probably be used.
16549 * Smart callbacks one can listen to:
16550 * - @c "activated" - The user has double-clicked or pressed
16551 * (enter|return|spacebar) on an item. The @c event_info parameter
16552 * is the item that was activated.
16553 * - @c "clicked,double" - The user has double-clicked an item.
16554 * The @c event_info parameter is the item that was double-clicked.
16555 * - "selected" - when the user selected an item
16556 * - "unselected" - when the user unselected an item
16557 * - "longpressed" - an item in the list is long-pressed
16558 * - "edge,top" - the list is scrolled until the top edge
16559 * - "edge,bottom" - the list is scrolled until the bottom edge
16560 * - "edge,left" - the list is scrolled until the left edge
16561 * - "edge,right" - the list is scrolled until the right edge
16562 * - "language,changed" - the program's language changed
16564 * Available styles for it:
16567 * List of examples:
16568 * @li @ref list_example_01
16569 * @li @ref list_example_02
16570 * @li @ref list_example_03
16579 * @enum _Elm_List_Mode
16580 * @typedef Elm_List_Mode
16582 * Set list's resize behavior, transverse axis scroll and
16583 * items cropping. See each mode's description for more details.
16585 * @note Default value is #ELM_LIST_SCROLL.
16587 * Values <b> don't </b> work as bitmask, only one can be choosen.
16589 * @see elm_list_mode_set()
16590 * @see elm_list_mode_get()
16594 typedef enum _Elm_List_Mode
16596 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. */
16597 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). */
16598 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. */
16599 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. */
16600 ELM_LIST_LAST /**< Indicates error if returned by elm_list_mode_get() */
16603 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(). */
16606 * Add a new list widget to the given parent Elementary
16607 * (container) object.
16609 * @param parent The parent object.
16610 * @return a new list widget handle or @c NULL, on errors.
16612 * This function inserts a new list widget on the canvas.
16616 EAPI Evas_Object *elm_list_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
16621 * @param obj The list object
16623 * @note Call before running show() on the list object.
16624 * @warning If not called, it won't display the list properly.
16627 * li = elm_list_add(win);
16628 * elm_list_item_append(li, "First", NULL, NULL, NULL, NULL);
16629 * elm_list_item_append(li, "Second", NULL, NULL, NULL, NULL);
16631 * evas_object_show(li);
16636 EAPI void elm_list_go(Evas_Object *obj) EINA_ARG_NONNULL(1);
16639 * Enable or disable multiple items selection on the list object.
16641 * @param obj The list object
16642 * @param multi @c EINA_TRUE to enable multi selection or @c EINA_FALSE to
16645 * Disabled by default. If disabled, the user can select a single item of
16646 * the list each time. Selected items are highlighted on list.
16647 * If enabled, many items can be selected.
16649 * If a selected item is selected again, it will be unselected.
16651 * @see elm_list_multi_select_get()
16655 EAPI void elm_list_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
16658 * Get a value whether multiple items selection is enabled or not.
16660 * @see elm_list_multi_select_set() for details.
16662 * @param obj The list object.
16663 * @return @c EINA_TRUE means multiple items selection is enabled.
16664 * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
16665 * @c EINA_FALSE is returned.
16669 EAPI Eina_Bool elm_list_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16672 * Set which mode to use for the list object.
16674 * @param obj The list object
16675 * @param mode One of #Elm_List_Mode: #ELM_LIST_COMPRESS, #ELM_LIST_SCROLL,
16676 * #ELM_LIST_LIMIT or #ELM_LIST_EXPAND.
16678 * Set list's resize behavior, transverse axis scroll and
16679 * items cropping. See each mode's description for more details.
16681 * @note Default value is #ELM_LIST_SCROLL.
16683 * Only one can be set, if a previous one was set, it will be changed
16684 * by the new mode set. Bitmask won't work as well.
16686 * @see elm_list_mode_get()
16690 EAPI void elm_list_mode_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
16693 * Get the mode the list is at.
16695 * @param obj The list object
16696 * @return One of #Elm_List_Mode: #ELM_LIST_COMPRESS, #ELM_LIST_SCROLL,
16697 * #ELM_LIST_LIMIT, #ELM_LIST_EXPAND or #ELM_LIST_LAST on errors.
16699 * @note see elm_list_mode_set() for more information.
16703 EAPI Elm_List_Mode elm_list_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16706 * Enable or disable horizontal mode on the list object.
16708 * @param obj The list object.
16709 * @param horizontal @c EINA_TRUE to enable horizontal or @c EINA_FALSE to
16710 * disable it, i.e., to enable vertical mode.
16712 * @note Vertical mode is set by default.
16714 * On horizontal mode items are displayed on list from left to right,
16715 * instead of from top to bottom. Also, the list will scroll horizontally.
16716 * Each item will presents left icon on top and right icon, or end, at
16719 * @see elm_list_horizontal_get()
16723 EAPI void elm_list_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
16726 * Get a value whether horizontal mode is enabled or not.
16728 * @param obj The list object.
16729 * @return @c EINA_TRUE means horizontal mode selection is enabled.
16730 * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
16731 * @c EINA_FALSE is returned.
16733 * @see elm_list_horizontal_set() for details.
16737 EAPI Eina_Bool elm_list_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16740 * Enable or disable always select mode on the list object.
16742 * @param obj The list object
16743 * @param always_select @c EINA_TRUE to enable always select mode or
16744 * @c EINA_FALSE to disable it.
16746 * @note Always select mode is disabled by default.
16748 * Default behavior of list items is to only call its callback function
16749 * the first time it's pressed, i.e., when it is selected. If a selected
16750 * item is pressed again, and multi-select is disabled, it won't call
16751 * this function (if multi-select is enabled it will unselect the item).
16753 * If always select is enabled, it will call the callback function
16754 * everytime a item is pressed, so it will call when the item is selected,
16755 * and again when a selected item is pressed.
16757 * @see elm_list_always_select_mode_get()
16758 * @see elm_list_multi_select_set()
16762 EAPI void elm_list_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
16765 * Get a value whether always select mode is enabled or not, meaning that
16766 * an item will always call its callback function, even if already selected.
16768 * @param obj The list object
16769 * @return @c EINA_TRUE means horizontal mode selection is enabled.
16770 * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
16771 * @c EINA_FALSE is returned.
16773 * @see elm_list_always_select_mode_set() for details.
16777 EAPI Eina_Bool elm_list_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16780 * Set bouncing behaviour when the scrolled content reaches an edge.
16782 * Tell the internal scroller object whether it should bounce or not
16783 * when it reaches the respective edges for each axis.
16785 * @param obj The list object
16786 * @param h_bounce Whether to bounce or not in the horizontal axis.
16787 * @param v_bounce Whether to bounce or not in the vertical axis.
16789 * @see elm_scroller_bounce_set()
16793 EAPI void elm_list_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
16796 * Get the bouncing behaviour of the internal scroller.
16798 * Get whether the internal scroller should bounce when the edge of each
16799 * axis is reached scrolling.
16801 * @param obj The list object.
16802 * @param h_bounce Pointer where to store the bounce state of the horizontal
16804 * @param v_bounce Pointer where to store the bounce state of the vertical
16807 * @see elm_scroller_bounce_get()
16808 * @see elm_list_bounce_set()
16812 EAPI void elm_list_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
16815 * Set the scrollbar policy.
16817 * @param obj The list object
16818 * @param policy_h Horizontal scrollbar policy.
16819 * @param policy_v Vertical scrollbar policy.
16821 * This sets the scrollbar visibility policy for the given scroller.
16822 * #ELM_SCROLLER_POLICY_AUTO means the scrollbar is made visible if it
16823 * is needed, and otherwise kept hidden. #ELM_SCROLLER_POLICY_ON turns
16824 * it on all the time, and #ELM_SCROLLER_POLICY_OFF always keeps it off.
16825 * This applies respectively for the horizontal and vertical scrollbars.
16827 * The both are disabled by default, i.e., are set to
16828 * #ELM_SCROLLER_POLICY_OFF.
16832 EAPI void elm_list_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
16835 * Get the scrollbar policy.
16837 * @see elm_list_scroller_policy_get() for details.
16839 * @param obj The list object.
16840 * @param policy_h Pointer where to store horizontal scrollbar policy.
16841 * @param policy_v Pointer where to store vertical scrollbar policy.
16845 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);
16848 * Append a new item to the list object.
16850 * @param obj The list object.
16851 * @param label The label of the list item.
16852 * @param icon The icon object to use for the left side of the item. An
16853 * icon can be any Evas object, but usually it is an icon created
16854 * with elm_icon_add().
16855 * @param end The icon object to use for the right side of the item. An
16856 * icon can be any Evas object.
16857 * @param func The function to call when the item is clicked.
16858 * @param data The data to associate with the item for related callbacks.
16860 * @return The created item or @c NULL upon failure.
16862 * A new item will be created and appended to the list, i.e., will
16863 * be set as @b last item.
16865 * Items created with this method can be deleted with
16866 * elm_list_item_del().
16868 * Associated @p data can be properly freed when item is deleted if a
16869 * callback function is set with elm_list_item_del_cb_set().
16871 * If a function is passed as argument, it will be called everytime this item
16872 * is selected, i.e., the user clicks over an unselected item.
16873 * If always select is enabled it will call this function every time
16874 * user clicks over an item (already selected or not).
16875 * If such function isn't needed, just passing
16876 * @c NULL as @p func is enough. The same should be done for @p data.
16878 * Simple example (with no function callback or data associated):
16880 * li = elm_list_add(win);
16881 * ic = elm_icon_add(win);
16882 * elm_icon_file_set(ic, "path/to/image", NULL);
16883 * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
16884 * elm_list_item_append(li, "label", ic, NULL, NULL, NULL);
16886 * evas_object_show(li);
16889 * @see elm_list_always_select_mode_set()
16890 * @see elm_list_item_del()
16891 * @see elm_list_item_del_cb_set()
16892 * @see elm_list_clear()
16893 * @see elm_icon_add()
16897 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);
16900 * Prepend a new item to the list object.
16902 * @param obj The list object.
16903 * @param label The label of the list item.
16904 * @param icon The icon object to use for the left side of the item. An
16905 * icon can be any Evas object, but usually it is an icon created
16906 * with elm_icon_add().
16907 * @param end The icon object to use for the right side of the item. An
16908 * icon can be any Evas object.
16909 * @param func The function to call when the item is clicked.
16910 * @param data The data to associate with the item for related callbacks.
16912 * @return The created item or @c NULL upon failure.
16914 * A new item will be created and prepended to the list, i.e., will
16915 * be set as @b first item.
16917 * Items created with this method can be deleted with
16918 * elm_list_item_del().
16920 * Associated @p data can be properly freed when item is deleted if a
16921 * callback function is set with elm_list_item_del_cb_set().
16923 * If a function is passed as argument, it will be called everytime this item
16924 * is selected, i.e., the user clicks over an unselected item.
16925 * If always select is enabled it will call this function every time
16926 * user clicks over an item (already selected or not).
16927 * If such function isn't needed, just passing
16928 * @c NULL as @p func is enough. The same should be done for @p data.
16930 * @see elm_list_item_append() for a simple code example.
16931 * @see elm_list_always_select_mode_set()
16932 * @see elm_list_item_del()
16933 * @see elm_list_item_del_cb_set()
16934 * @see elm_list_clear()
16935 * @see elm_icon_add()
16939 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);
16942 * Insert a new item into the list object before item @p before.
16944 * @param obj The list object.
16945 * @param before The list item to insert before.
16946 * @param label The label of the list item.
16947 * @param icon The icon object to use for the left side of the item. An
16948 * icon can be any Evas object, but usually it is an icon created
16949 * with elm_icon_add().
16950 * @param end The icon object to use for the right side of the item. An
16951 * icon can be any Evas object.
16952 * @param func The function to call when the item is clicked.
16953 * @param data The data to associate with the item for related callbacks.
16955 * @return The created item or @c NULL upon failure.
16957 * A new item will be created and added to the list. Its position in
16958 * this list will be just before item @p before.
16960 * Items created with this method can be deleted with
16961 * elm_list_item_del().
16963 * Associated @p data can be properly freed when item is deleted if a
16964 * callback function is set with elm_list_item_del_cb_set().
16966 * If a function is passed as argument, it will be called everytime this item
16967 * is selected, i.e., the user clicks over an unselected item.
16968 * If always select is enabled it will call this function every time
16969 * user clicks over an item (already selected or not).
16970 * If such function isn't needed, just passing
16971 * @c NULL as @p func is enough. The same should be done for @p data.
16973 * @see elm_list_item_append() for a simple code example.
16974 * @see elm_list_always_select_mode_set()
16975 * @see elm_list_item_del()
16976 * @see elm_list_item_del_cb_set()
16977 * @see elm_list_clear()
16978 * @see elm_icon_add()
16982 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);
16985 * Insert a new item into the list object after item @p after.
16987 * @param obj The list object.
16988 * @param after The list item to insert after.
16989 * @param label The label of the list item.
16990 * @param icon The icon object to use for the left side of the item. An
16991 * icon can be any Evas object, but usually it is an icon created
16992 * with elm_icon_add().
16993 * @param end The icon object to use for the right side of the item. An
16994 * icon can be any Evas object.
16995 * @param func The function to call when the item is clicked.
16996 * @param data The data to associate with the item for related callbacks.
16998 * @return The created item or @c NULL upon failure.
17000 * A new item will be created and added to the list. Its position in
17001 * this list will be just after item @p after.
17003 * Items created with this method can be deleted with
17004 * elm_list_item_del().
17006 * Associated @p data can be properly freed when item is deleted if a
17007 * callback function is set with elm_list_item_del_cb_set().
17009 * If a function is passed as argument, it will be called everytime this item
17010 * is selected, i.e., the user clicks over an unselected item.
17011 * If always select is enabled it will call this function every time
17012 * user clicks over an item (already selected or not).
17013 * If such function isn't needed, just passing
17014 * @c NULL as @p func is enough. The same should be done for @p data.
17016 * @see elm_list_item_append() for a simple code example.
17017 * @see elm_list_always_select_mode_set()
17018 * @see elm_list_item_del()
17019 * @see elm_list_item_del_cb_set()
17020 * @see elm_list_clear()
17021 * @see elm_icon_add()
17025 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);
17028 * Insert a new item into the sorted list object.
17030 * @param obj The list object.
17031 * @param label The label of the list item.
17032 * @param icon The icon object to use for the left side of the item. An
17033 * icon can be any Evas object, but usually it is an icon created
17034 * with elm_icon_add().
17035 * @param end The icon object to use for the right side of the item. An
17036 * icon can be any Evas object.
17037 * @param func The function to call when the item is clicked.
17038 * @param data The data to associate with the item for related callbacks.
17039 * @param cmp_func The comparing function to be used to sort list
17040 * items <b>by #Elm_List_Item item handles</b>. This function will
17041 * receive two items and compare them, returning a non-negative integer
17042 * if the second item should be place after the first, or negative value
17043 * if should be placed before.
17045 * @return The created item or @c NULL upon failure.
17047 * @note This function inserts values into a list object assuming it was
17048 * sorted and the result will be sorted.
17050 * A new item will be created and added to the list. Its position in
17051 * this list will be found comparing the new item with previously inserted
17052 * items using function @p cmp_func.
17054 * Items created with this method can be deleted with
17055 * elm_list_item_del().
17057 * Associated @p data can be properly freed when item is deleted if a
17058 * callback function is set with elm_list_item_del_cb_set().
17060 * If a function is passed as argument, it will be called everytime this item
17061 * is selected, i.e., the user clicks over an unselected item.
17062 * If always select is enabled it will call this function every time
17063 * user clicks over an item (already selected or not).
17064 * If such function isn't needed, just passing
17065 * @c NULL as @p func is enough. The same should be done for @p data.
17067 * @see elm_list_item_append() for a simple code example.
17068 * @see elm_list_always_select_mode_set()
17069 * @see elm_list_item_del()
17070 * @see elm_list_item_del_cb_set()
17071 * @see elm_list_clear()
17072 * @see elm_icon_add()
17076 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);
17079 * Remove all list's items.
17081 * @param obj The list object
17083 * @see elm_list_item_del()
17084 * @see elm_list_item_append()
17088 EAPI void elm_list_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
17091 * Get a list of all the list items.
17093 * @param obj The list object
17094 * @return An @c Eina_List of list items, #Elm_List_Item,
17095 * or @c NULL on failure.
17097 * @see elm_list_item_append()
17098 * @see elm_list_item_del()
17099 * @see elm_list_clear()
17103 EAPI const Eina_List *elm_list_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17106 * Get the selected item.
17108 * @param obj The list object.
17109 * @return The selected list item.
17111 * The selected item can be unselected with function
17112 * elm_list_item_selected_set().
17114 * The selected item always will be highlighted on list.
17116 * @see elm_list_selected_items_get()
17120 EAPI Elm_List_Item *elm_list_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17123 * Return a list of the currently selected list items.
17125 * @param obj The list object.
17126 * @return An @c Eina_List of list items, #Elm_List_Item,
17127 * or @c NULL on failure.
17129 * Multiple items can be selected if multi select is enabled. It can be
17130 * done with elm_list_multi_select_set().
17132 * @see elm_list_selected_item_get()
17133 * @see elm_list_multi_select_set()
17137 EAPI const Eina_List *elm_list_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17140 * Set the selected state of an item.
17142 * @param item The list item
17143 * @param selected The selected state
17145 * This sets the selected state of the given item @p it.
17146 * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
17148 * If a new item is selected the previosly selected will be unselected,
17149 * unless multiple selection is enabled with elm_list_multi_select_set().
17150 * Previoulsy selected item can be get with function
17151 * elm_list_selected_item_get().
17153 * Selected items will be highlighted.
17155 * @see elm_list_item_selected_get()
17156 * @see elm_list_selected_item_get()
17157 * @see elm_list_multi_select_set()
17161 EAPI void elm_list_item_selected_set(Elm_List_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
17164 * Get whether the @p item is selected or not.
17166 * @param item The list item.
17167 * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
17168 * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
17170 * @see elm_list_selected_item_set() for details.
17171 * @see elm_list_item_selected_get()
17175 EAPI Eina_Bool elm_list_item_selected_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17178 * Set or unset item as a separator.
17180 * @param it The list item.
17181 * @param setting @c EINA_TRUE to set item @p it as separator or
17182 * @c EINA_FALSE to unset, i.e., item will be used as a regular item.
17184 * Items aren't set as separator by default.
17186 * If set as separator it will display separator theme, so won't display
17189 * @see elm_list_item_separator_get()
17193 EAPI void elm_list_item_separator_set(Elm_List_Item *it, Eina_Bool setting) EINA_ARG_NONNULL(1);
17196 * Get a value whether item is a separator or not.
17198 * @see elm_list_item_separator_set() for details.
17200 * @param it The list item.
17201 * @return @c EINA_TRUE means item @p it is a separator. @c EINA_FALSE
17202 * indicates it's not. If @p it is @c NULL, @c EINA_FALSE is returned.
17206 EAPI Eina_Bool elm_list_item_separator_get(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
17209 * Show @p item in the list view.
17211 * @param item The list item to be shown.
17213 * It won't animate list until item is visible. If such behavior is wanted,
17214 * use elm_list_bring_in() intead.
17218 EAPI void elm_list_item_show(Elm_List_Item *item) EINA_ARG_NONNULL(1);
17221 * Bring in the given item to list view.
17223 * @param item The item.
17225 * This causes list to jump to the given item @p item and show it
17226 * (by scrolling), if it is not fully visible.
17228 * This may use animation to do so and take a period of time.
17230 * If animation isn't wanted, elm_list_item_show() can be used.
17234 EAPI void elm_list_item_bring_in(Elm_List_Item *item) EINA_ARG_NONNULL(1);
17237 * Delete them item from the list.
17239 * @param item The item of list to be deleted.
17241 * If deleting all list items is required, elm_list_clear()
17242 * should be used instead of getting items list and deleting each one.
17244 * @see elm_list_clear()
17245 * @see elm_list_item_append()
17246 * @see elm_list_item_del_cb_set()
17250 EAPI void elm_list_item_del(Elm_List_Item *item) EINA_ARG_NONNULL(1);
17253 * Set the function called when a list item is freed.
17255 * @param item The item to set the callback on
17256 * @param func The function called
17258 * If there is a @p func, then it will be called prior item's memory release.
17259 * That will be called with the following arguments:
17261 * @li item's Evas object;
17264 * This way, a data associated to a list item could be properly freed.
17268 EAPI void elm_list_item_del_cb_set(Elm_List_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
17271 * Get the data associated to the item.
17273 * @param item The list item
17274 * @return The data associated to @p item
17276 * The return value is a pointer to data associated to @p item when it was
17277 * created, with function elm_list_item_append() or similar. If no data
17278 * was passed as argument, it will return @c NULL.
17280 * @see elm_list_item_append()
17284 EAPI void *elm_list_item_data_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17287 * Get the left side icon associated to the item.
17289 * @param item The list item
17290 * @return The left side icon associated to @p item
17292 * The return value is a pointer to the icon associated to @p item when
17294 * created, with function elm_list_item_append() or similar, or later
17295 * with function elm_list_item_icon_set(). If no icon
17296 * was passed as argument, it will return @c NULL.
17298 * @see elm_list_item_append()
17299 * @see elm_list_item_icon_set()
17303 EAPI Evas_Object *elm_list_item_icon_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17306 * Set the left side icon associated to the item.
17308 * @param item The list item
17309 * @param icon The left side icon object to associate with @p item
17311 * The icon object to use at left side of the item. An
17312 * icon can be any Evas object, but usually it is an icon created
17313 * with elm_icon_add().
17315 * Once the icon object is set, a previously set one will be deleted.
17316 * @warning Setting the same icon for two items will cause the icon to
17317 * dissapear from the first item.
17319 * If an icon was passed as argument on item creation, with function
17320 * elm_list_item_append() or similar, it will be already
17321 * associated to the item.
17323 * @see elm_list_item_append()
17324 * @see elm_list_item_icon_get()
17328 EAPI void elm_list_item_icon_set(Elm_List_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
17331 * Get the right side icon associated to the item.
17333 * @param item The list item
17334 * @return The right side icon associated to @p item
17336 * The return value is a pointer to the icon associated to @p item when
17338 * created, with function elm_list_item_append() or similar, or later
17339 * with function elm_list_item_icon_set(). If no icon
17340 * was passed as argument, it will return @c NULL.
17342 * @see elm_list_item_append()
17343 * @see elm_list_item_icon_set()
17347 EAPI Evas_Object *elm_list_item_end_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17350 * Set the right side icon associated to the item.
17352 * @param item The list item
17353 * @param end The right side icon object to associate with @p item
17355 * The icon object to use at right side of the item. An
17356 * icon can be any Evas object, but usually it is an icon created
17357 * with elm_icon_add().
17359 * Once the icon object is set, a previously set one will be deleted.
17360 * @warning Setting the same icon for two items will cause the icon to
17361 * dissapear from the first item.
17363 * If an icon was passed as argument on item creation, with function
17364 * elm_list_item_append() or similar, it will be already
17365 * associated to the item.
17367 * @see elm_list_item_append()
17368 * @see elm_list_item_end_get()
17372 EAPI void elm_list_item_end_set(Elm_List_Item *item, Evas_Object *end) EINA_ARG_NONNULL(1);
17375 * Gets the base object of the item.
17377 * @param item The list item
17378 * @return The base object associated with @p item
17380 * Base object is the @c Evas_Object that represents that item.
17384 EAPI Evas_Object *elm_list_item_object_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17385 EINA_DEPRECATED EAPI Evas_Object *elm_list_item_base_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17388 * Get the label of item.
17390 * @param item The item of list.
17391 * @return The label of item.
17393 * The return value is a pointer to the label associated to @p item when
17394 * it was created, with function elm_list_item_append(), or later
17395 * with function elm_list_item_label_set. If no label
17396 * was passed as argument, it will return @c NULL.
17398 * @see elm_list_item_label_set() for more details.
17399 * @see elm_list_item_append()
17403 EAPI const char *elm_list_item_label_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17406 * Set the label of item.
17408 * @param item The item of list.
17409 * @param text The label of item.
17411 * The label to be displayed by the item.
17412 * Label will be placed between left and right side icons (if set).
17414 * If a label was passed as argument on item creation, with function
17415 * elm_list_item_append() or similar, it will be already
17416 * displayed by the item.
17418 * @see elm_list_item_label_get()
17419 * @see elm_list_item_append()
17423 EAPI void elm_list_item_label_set(Elm_List_Item *item, const char *text) EINA_ARG_NONNULL(1);
17427 * Get the item before @p it in list.
17429 * @param it The list item.
17430 * @return The item before @p it, or @c NULL if none or on failure.
17432 * @note If it is the first item, @c NULL will be returned.
17434 * @see elm_list_item_append()
17435 * @see elm_list_items_get()
17439 EAPI Elm_List_Item *elm_list_item_prev(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
17442 * Get the item after @p it in list.
17444 * @param it The list item.
17445 * @return The item after @p it, or @c NULL if none or on failure.
17447 * @note If it is the last item, @c NULL will be returned.
17449 * @see elm_list_item_append()
17450 * @see elm_list_items_get()
17454 EAPI Elm_List_Item *elm_list_item_next(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
17457 * Sets the disabled/enabled state of a list item.
17459 * @param it The item.
17460 * @param disabled The disabled state.
17462 * A disabled item cannot be selected or unselected. It will also
17463 * change its appearance (generally greyed out). This sets the
17464 * disabled state (@c EINA_TRUE for disabled, @c EINA_FALSE for
17469 EAPI void elm_list_item_disabled_set(Elm_List_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1);
17472 * Get a value whether list item is disabled or not.
17474 * @param it The item.
17475 * @return The disabled state.
17477 * @see elm_list_item_disabled_set() for more details.
17481 EAPI Eina_Bool elm_list_item_disabled_get(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
17484 * Set the text to be shown in a given list item's tooltips.
17486 * @param item Target item.
17487 * @param text The text to set in the content.
17489 * Setup the text as tooltip to object. The item can have only one tooltip,
17490 * so any previous tooltip data - set with this function or
17491 * elm_list_item_tooltip_content_cb_set() - is removed.
17493 * @see elm_object_tooltip_text_set() for more details.
17497 EAPI void elm_list_item_tooltip_text_set(Elm_List_Item *item, const char *text) EINA_ARG_NONNULL(1);
17501 * @brief Disable size restrictions on an object's tooltip
17502 * @param item The tooltip's anchor object
17503 * @param disable If EINA_TRUE, size restrictions are disabled
17504 * @return EINA_FALSE on failure, EINA_TRUE on success
17506 * This function allows a tooltip to expand beyond its parant window's canvas.
17507 * It will instead be limited only by the size of the display.
17509 EAPI Eina_Bool elm_list_item_tooltip_size_restrict_disable(Elm_List_Item *item, Eina_Bool disable) EINA_ARG_NONNULL(1);
17511 * @brief Retrieve size restriction state of an object's tooltip
17512 * @param obj The tooltip's anchor object
17513 * @return If EINA_TRUE, size restrictions are disabled
17515 * This function returns whether a tooltip is allowed to expand beyond
17516 * its parant window's canvas.
17517 * It will instead be limited only by the size of the display.
17519 EAPI Eina_Bool elm_list_item_tooltip_size_restrict_disabled_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17522 * Set the content to be shown in the tooltip item.
17524 * Setup the tooltip to item. The item can have only one tooltip,
17525 * so any previous tooltip data is removed. @p func(with @p data) will
17526 * be called every time that need show the tooltip and it should
17527 * return a valid Evas_Object. This object is then managed fully by
17528 * tooltip system and is deleted when the tooltip is gone.
17530 * @param item the list item being attached a tooltip.
17531 * @param func the function used to create the tooltip contents.
17532 * @param data what to provide to @a func as callback data/context.
17533 * @param del_cb called when data is not needed anymore, either when
17534 * another callback replaces @a func, the tooltip is unset with
17535 * elm_list_item_tooltip_unset() or the owner @a item
17536 * dies. This callback receives as the first parameter the
17537 * given @a data, and @c event_info is the item.
17539 * @see elm_object_tooltip_content_cb_set() for more details.
17543 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);
17546 * Unset tooltip from item.
17548 * @param item list item to remove previously set tooltip.
17550 * Remove tooltip from item. The callback provided as del_cb to
17551 * elm_list_item_tooltip_content_cb_set() will be called to notify
17552 * it is not used anymore.
17554 * @see elm_object_tooltip_unset() for more details.
17555 * @see elm_list_item_tooltip_content_cb_set()
17559 EAPI void elm_list_item_tooltip_unset(Elm_List_Item *item) EINA_ARG_NONNULL(1);
17562 * Sets a different style for this item tooltip.
17564 * @note before you set a style you should define a tooltip with
17565 * elm_list_item_tooltip_content_cb_set() or
17566 * elm_list_item_tooltip_text_set()
17568 * @param item list item with tooltip already set.
17569 * @param style the theme style to use (default, transparent, ...)
17571 * @see elm_object_tooltip_style_set() for more details.
17575 EAPI void elm_list_item_tooltip_style_set(Elm_List_Item *item, const char *style) EINA_ARG_NONNULL(1);
17578 * Get the style for this item tooltip.
17580 * @param item list item with tooltip already set.
17581 * @return style the theme style in use, defaults to "default". If the
17582 * object does not have a tooltip set, then NULL is returned.
17584 * @see elm_object_tooltip_style_get() for more details.
17585 * @see elm_list_item_tooltip_style_set()
17589 EAPI const char *elm_list_item_tooltip_style_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17592 * Set the type of mouse pointer/cursor decoration to be shown,
17593 * when the mouse pointer is over the given list widget item
17595 * @param item list item to customize cursor on
17596 * @param cursor the cursor type's name
17598 * This function works analogously as elm_object_cursor_set(), but
17599 * here the cursor's changing area is restricted to the item's
17600 * area, and not the whole widget's. Note that that item cursors
17601 * have precedence over widget cursors, so that a mouse over an
17602 * item with custom cursor set will always show @b that cursor.
17604 * If this function is called twice for an object, a previously set
17605 * cursor will be unset on the second call.
17607 * @see elm_object_cursor_set()
17608 * @see elm_list_item_cursor_get()
17609 * @see elm_list_item_cursor_unset()
17613 EAPI void elm_list_item_cursor_set(Elm_List_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
17616 * Get the type of mouse pointer/cursor decoration set to be shown,
17617 * when the mouse pointer is over the given list widget item
17619 * @param item list item with custom cursor set
17620 * @return the cursor type's name or @c NULL, if no custom cursors
17621 * were set to @p item (and on errors)
17623 * @see elm_object_cursor_get()
17624 * @see elm_list_item_cursor_set()
17625 * @see elm_list_item_cursor_unset()
17629 EAPI const char *elm_list_item_cursor_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17632 * Unset any custom mouse pointer/cursor decoration set to be
17633 * shown, when the mouse pointer is over the given list widget
17634 * item, thus making it show the @b default cursor again.
17636 * @param item a list item
17638 * Use this call to undo any custom settings on this item's cursor
17639 * decoration, bringing it back to defaults (no custom style set).
17641 * @see elm_object_cursor_unset()
17642 * @see elm_list_item_cursor_set()
17646 EAPI void elm_list_item_cursor_unset(Elm_List_Item *item) EINA_ARG_NONNULL(1);
17649 * Set a different @b style for a given custom cursor set for a
17652 * @param item list item with custom cursor set
17653 * @param style the <b>theme style</b> to use (e.g. @c "default",
17654 * @c "transparent", etc)
17656 * This function only makes sense when one is using custom mouse
17657 * cursor decorations <b>defined in a theme file</b>, which can have,
17658 * given a cursor name/type, <b>alternate styles</b> on it. It
17659 * works analogously as elm_object_cursor_style_set(), but here
17660 * applyed only to list item objects.
17662 * @warning Before you set a cursor style you should have definen a
17663 * custom cursor previously on the item, with
17664 * elm_list_item_cursor_set()
17666 * @see elm_list_item_cursor_engine_only_set()
17667 * @see elm_list_item_cursor_style_get()
17671 EAPI void elm_list_item_cursor_style_set(Elm_List_Item *item, const char *style) EINA_ARG_NONNULL(1);
17674 * Get the current @b style set for a given list item's custom
17677 * @param item list item with custom cursor set.
17678 * @return style the cursor style in use. If the object does not
17679 * have a cursor set, then @c NULL is returned.
17681 * @see elm_list_item_cursor_style_set() for more details
17685 EAPI const char *elm_list_item_cursor_style_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17688 * Set if the (custom)cursor for a given list item should be
17689 * searched in its theme, also, or should only rely on the
17690 * rendering engine.
17692 * @param item item with custom (custom) cursor already set on
17693 * @param engine_only Use @c EINA_TRUE to have cursors looked for
17694 * only on those provided by the rendering engine, @c EINA_FALSE to
17695 * have them searched on the widget's theme, as well.
17697 * @note This call is of use only if you've set a custom cursor
17698 * for list items, with elm_list_item_cursor_set().
17700 * @note By default, cursors will only be looked for between those
17701 * provided by the rendering engine.
17705 EAPI void elm_list_item_cursor_engine_only_set(Elm_List_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
17708 * Get if the (custom) cursor for a given list item is being
17709 * searched in its theme, also, or is only relying on the rendering
17712 * @param item a list item
17713 * @return @c EINA_TRUE, if cursors are being looked for only on
17714 * those provided by the rendering engine, @c EINA_FALSE if they
17715 * are being searched on the widget's theme, as well.
17717 * @see elm_list_item_cursor_engine_only_set(), for more details
17721 EAPI Eina_Bool elm_list_item_cursor_engine_only_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17728 * @defgroup Slider Slider
17729 * @ingroup Elementary
17731 * @image html img/widget/slider/preview-00.png
17732 * @image latex img/widget/slider/preview-00.eps width=\textwidth
17734 * The slider adds a dragable āsliderā widget for selecting the value of
17735 * something within a range.
17737 * A slider can be horizontal or vertical. It can contain an Icon and has a
17738 * primary label as well as a units label (that is formatted with floating
17739 * point values and thus accepts a printf-style format string, like
17740 * ā%1.2f unitsā. There is also an indicator string that may be somewhere
17741 * else (like on the slider itself) that also accepts a format string like
17742 * units. Label, Icon Unit and Indicator strings/objects are optional.
17744 * A slider may be inverted which means values invert, with high vales being
17745 * on the left or top and low values on the right or bottom (as opposed to
17746 * normally being low on the left or top and high on the bottom and right).
17748 * The slider should have its minimum and maximum values set by the
17749 * application with elm_slider_min_max_set() and value should also be set by
17750 * the application before use with elm_slider_value_set(). The span of the
17751 * slider is its length (horizontally or vertically). This will be scaled by
17752 * the object or applications scaling factor. At any point code can query the
17753 * slider for its value with elm_slider_value_get().
17755 * Smart callbacks one can listen to:
17756 * - "changed" - Whenever the slider value is changed by the user.
17757 * - "slider,drag,start" - dragging the slider indicator around has started.
17758 * - "slider,drag,stop" - dragging the slider indicator around has stopped.
17759 * - "delay,changed" - A short time after the value is changed by the user.
17760 * This will be called only when the user stops dragging for
17761 * a very short period or when they release their
17762 * finger/mouse, so it avoids possibly expensive reactions to
17763 * the value change.
17765 * Available styles for it:
17768 * Default contents parts of the slider widget that you can use for are:
17769 * @li "icon" - An icon of the slider
17770 * @li "end" - A end part content of the slider
17772 * Default text parts of the silder widget that you can use for are:
17773 * @li "default" - Label of the silder
17774 * Here is an example on its usage:
17775 * @li @ref slider_example
17779 * @addtogroup Slider
17784 * Add a new slider widget to the given parent Elementary
17785 * (container) object.
17787 * @param parent The parent object.
17788 * @return a new slider widget handle or @c NULL, on errors.
17790 * This function inserts a new slider widget on the canvas.
17794 EAPI Evas_Object *elm_slider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
17797 * Set the label of a given slider widget
17799 * @param obj The progress bar object
17800 * @param label The text label string, in UTF-8
17803 * @deprecated use elm_object_text_set() instead.
17805 EINA_DEPRECATED EAPI void elm_slider_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
17808 * Get the label of a given slider widget
17810 * @param obj The progressbar object
17811 * @return The text label string, in UTF-8
17814 * @deprecated use elm_object_text_get() instead.
17816 EINA_DEPRECATED EAPI const char *elm_slider_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17819 * Set the icon object of the slider object.
17821 * @param obj The slider object.
17822 * @param icon The icon object.
17824 * On horizontal mode, icon is placed at left, and on vertical mode,
17827 * @note Once the icon object is set, a previously set one will be deleted.
17828 * If you want to keep that old content object, use the
17829 * elm_slider_icon_unset() function.
17831 * @warning If the object being set does not have minimum size hints set,
17832 * it won't get properly displayed.
17835 * @deprecated use elm_object_part_content_set() instead.
17837 EINA_DEPRECATED EAPI void elm_slider_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
17840 * Unset an icon set on a given slider widget.
17842 * @param obj The slider object.
17843 * @return The icon object that was being used, if any was set, or
17844 * @c NULL, otherwise (and on errors).
17846 * On horizontal mode, icon is placed at left, and on vertical mode,
17849 * This call will unparent and return the icon object which was set
17850 * for this widget, previously, on success.
17852 * @see elm_slider_icon_set() for more details
17853 * @see elm_slider_icon_get()
17854 * @deprecated use elm_object_part_content_unset() instead.
17858 EINA_DEPRECATED EAPI Evas_Object *elm_slider_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
17861 * Retrieve the icon object set for a given slider widget.
17863 * @param obj The slider object.
17864 * @return The icon object's handle, if @p obj had one set, or @c NULL,
17865 * otherwise (and on errors).
17867 * On horizontal mode, icon is placed at left, and on vertical mode,
17870 * @see elm_slider_icon_set() for more details
17871 * @see elm_slider_icon_unset()
17873 * @deprecated use elm_object_part_content_get() instead.
17877 EINA_DEPRECATED EAPI Evas_Object *elm_slider_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17880 * Set the end object of the slider object.
17882 * @param obj The slider object.
17883 * @param end The end object.
17885 * On horizontal mode, end is placed at left, and on vertical mode,
17886 * placed at bottom.
17888 * @note Once the icon object is set, a previously set one will be deleted.
17889 * If you want to keep that old content object, use the
17890 * elm_slider_end_unset() function.
17892 * @warning If the object being set does not have minimum size hints set,
17893 * it won't get properly displayed.
17895 * @deprecated use elm_object_part_content_set() instead.
17899 EINA_DEPRECATED EAPI void elm_slider_end_set(Evas_Object *obj, Evas_Object *end) EINA_ARG_NONNULL(1);
17902 * Unset an end object set on a given slider widget.
17904 * @param obj The slider object.
17905 * @return The end object that was being used, if any was set, or
17906 * @c NULL, otherwise (and on errors).
17908 * On horizontal mode, end is placed at left, and on vertical mode,
17909 * placed at bottom.
17911 * This call will unparent and return the icon object which was set
17912 * for this widget, previously, on success.
17914 * @see elm_slider_end_set() for more details.
17915 * @see elm_slider_end_get()
17917 * @deprecated use elm_object_part_content_unset() instead
17922 EINA_DEPRECATED EAPI Evas_Object *elm_slider_end_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
17925 * Retrieve the end object set for a given slider widget.
17927 * @param obj The slider object.
17928 * @return The end object's handle, if @p obj had one set, or @c NULL,
17929 * otherwise (and on errors).
17931 * On horizontal mode, icon is placed at right, and on vertical mode,
17932 * placed at bottom.
17934 * @see elm_slider_end_set() for more details.
17935 * @see elm_slider_end_unset()
17938 * @deprecated use elm_object_part_content_get() instead
17943 EINA_DEPRECATED EAPI Evas_Object *elm_slider_end_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17946 * Set the (exact) length of the bar region of a given slider widget.
17948 * @param obj The slider object.
17949 * @param size The length of the slider's bar region.
17951 * This sets the minimum width (when in horizontal mode) or height
17952 * (when in vertical mode) of the actual bar area of the slider
17953 * @p obj. This in turn affects the object's minimum size. Use
17954 * this when you're not setting other size hints expanding on the
17955 * given direction (like weight and alignment hints) and you would
17956 * like it to have a specific size.
17958 * @note Icon, end, label, indicator and unit text around @p obj
17959 * will require their
17960 * own space, which will make @p obj to require more the @p size,
17963 * @see elm_slider_span_size_get()
17967 EAPI void elm_slider_span_size_set(Evas_Object *obj, Evas_Coord size) EINA_ARG_NONNULL(1);
17970 * Get the length set for the bar region of a given slider widget
17972 * @param obj The slider object.
17973 * @return The length of the slider's bar region.
17975 * If that size was not set previously, with
17976 * elm_slider_span_size_set(), this call will return @c 0.
17980 EAPI Evas_Coord elm_slider_span_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17983 * Set the format string for the unit label.
17985 * @param obj The slider object.
17986 * @param format The format string for the unit display.
17988 * Unit label is displayed all the time, if set, after slider's bar.
17989 * In horizontal mode, at right and in vertical mode, at bottom.
17991 * If @c NULL, unit label won't be visible. If not it sets the format
17992 * string for the label text. To the label text is provided a floating point
17993 * value, so the label text can display up to 1 floating point value.
17994 * Note that this is optional.
17996 * Use a format string such as "%1.2f meters" for example, and it will
17997 * display values like: "3.14 meters" for a value equal to 3.14159.
17999 * Default is unit label disabled.
18001 * @see elm_slider_indicator_format_get()
18005 EAPI void elm_slider_unit_format_set(Evas_Object *obj, const char *format) EINA_ARG_NONNULL(1);
18008 * Get the unit label format of the slider.
18010 * @param obj The slider object.
18011 * @return The unit label format string in UTF-8.
18013 * Unit label is displayed all the time, if set, after slider's bar.
18014 * In horizontal mode, at right and in vertical mode, at bottom.
18016 * @see elm_slider_unit_format_set() for more
18017 * information on how this works.
18021 EAPI const char *elm_slider_unit_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18024 * Set the format string for the indicator label.
18026 * @param obj The slider object.
18027 * @param indicator The format string for the indicator display.
18029 * The slider may display its value somewhere else then unit label,
18030 * for example, above the slider knob that is dragged around. This function
18031 * sets the format string used for this.
18033 * If @c NULL, indicator label won't be visible. If not it sets the format
18034 * string for the label text. To the label text is provided a floating point
18035 * value, so the label text can display up to 1 floating point value.
18036 * Note that this is optional.
18038 * Use a format string such as "%1.2f meters" for example, and it will
18039 * display values like: "3.14 meters" for a value equal to 3.14159.
18041 * Default is indicator label disabled.
18043 * @see elm_slider_indicator_format_get()
18047 EAPI void elm_slider_indicator_format_set(Evas_Object *obj, const char *indicator) EINA_ARG_NONNULL(1);
18050 * Get the indicator label format of the slider.
18052 * @param obj The slider object.
18053 * @return The indicator label format string in UTF-8.
18055 * The slider may display its value somewhere else then unit label,
18056 * for example, above the slider knob that is dragged around. This function
18057 * gets the format string used for this.
18059 * @see elm_slider_indicator_format_set() for more
18060 * information on how this works.
18064 EAPI const char *elm_slider_indicator_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18067 * Set the format function pointer for the indicator label
18069 * @param obj The slider object.
18070 * @param func The indicator format function.
18071 * @param free_func The freeing function for the format string.
18073 * Set the callback function to format the indicator string.
18075 * @see elm_slider_indicator_format_set() for more info on how this works.
18079 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);
18082 * Set the format function pointer for the units label
18084 * @param obj The slider object.
18085 * @param func The units format function.
18086 * @param free_func The freeing function for the format string.
18088 * Set the callback function to format the indicator string.
18090 * @see elm_slider_units_format_set() for more info on how this works.
18094 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);
18097 * Set the orientation of a given slider widget.
18099 * @param obj The slider object.
18100 * @param horizontal Use @c EINA_TRUE to make @p obj to be
18101 * @b horizontal, @c EINA_FALSE to make it @b vertical.
18103 * Use this function to change how your slider is to be
18104 * disposed: vertically or horizontally.
18106 * By default it's displayed horizontally.
18108 * @see elm_slider_horizontal_get()
18112 EAPI void elm_slider_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
18115 * Retrieve the orientation of a given slider widget
18117 * @param obj The slider object.
18118 * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
18119 * @c EINA_FALSE if it's @b vertical (and on errors).
18121 * @see elm_slider_horizontal_set() for more details.
18125 EAPI Eina_Bool elm_slider_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18128 * Set the minimum and maximum values for the slider.
18130 * @param obj The slider object.
18131 * @param min The minimum value.
18132 * @param max The maximum value.
18134 * Define the allowed range of values to be selected by the user.
18136 * If actual value is less than @p min, it will be updated to @p min. If it
18137 * is bigger then @p max, will be updated to @p max. Actual value can be
18138 * get with elm_slider_value_get().
18140 * By default, min is equal to 0.0, and max is equal to 1.0.
18142 * @warning Maximum must be greater than minimum, otherwise behavior
18145 * @see elm_slider_min_max_get()
18149 EAPI void elm_slider_min_max_set(Evas_Object *obj, double min, double max) EINA_ARG_NONNULL(1);
18152 * Get the minimum and maximum values of the slider.
18154 * @param obj The slider object.
18155 * @param min Pointer where to store the minimum value.
18156 * @param max Pointer where to store the maximum value.
18158 * @note If only one value is needed, the other pointer can be passed
18161 * @see elm_slider_min_max_set() for details.
18165 EAPI void elm_slider_min_max_get(const Evas_Object *obj, double *min, double *max) EINA_ARG_NONNULL(1);
18168 * Set the value the slider displays.
18170 * @param obj The slider object.
18171 * @param val The value to be displayed.
18173 * Value will be presented on the unit label following format specified with
18174 * elm_slider_unit_format_set() and on indicator with
18175 * elm_slider_indicator_format_set().
18177 * @warning The value must to be between min and max values. This values
18178 * are set by elm_slider_min_max_set().
18180 * @see elm_slider_value_get()
18181 * @see elm_slider_unit_format_set()
18182 * @see elm_slider_indicator_format_set()
18183 * @see elm_slider_min_max_set()
18187 EAPI void elm_slider_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
18190 * Get the value displayed by the spinner.
18192 * @param obj The spinner object.
18193 * @return The value displayed.
18195 * @see elm_spinner_value_set() for details.
18199 EAPI double elm_slider_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18202 * Invert a given slider widget's displaying values order
18204 * @param obj The slider object.
18205 * @param inverted Use @c EINA_TRUE to make @p obj inverted,
18206 * @c EINA_FALSE to bring it back to default, non-inverted values.
18208 * A slider may be @b inverted, in which state it gets its
18209 * values inverted, with high vales being on the left or top and
18210 * low values on the right or bottom, as opposed to normally have
18211 * the low values on the former and high values on the latter,
18212 * respectively, for horizontal and vertical modes.
18214 * @see elm_slider_inverted_get()
18218 EAPI void elm_slider_inverted_set(Evas_Object *obj, Eina_Bool inverted) EINA_ARG_NONNULL(1);
18221 * Get whether a given slider widget's displaying values are
18224 * @param obj The slider object.
18225 * @return @c EINA_TRUE, if @p obj has inverted values,
18226 * @c EINA_FALSE otherwise (and on errors).
18228 * @see elm_slider_inverted_set() for more details.
18232 EAPI Eina_Bool elm_slider_inverted_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18235 * Set whether to enlarge slider indicator (augmented knob) or not.
18237 * @param obj The slider object.
18238 * @param show @c EINA_TRUE will make it enlarge, @c EINA_FALSE will
18239 * let the knob always at default size.
18241 * By default, indicator will be bigger while dragged by the user.
18243 * @warning It won't display values set with
18244 * elm_slider_indicator_format_set() if you disable indicator.
18248 EAPI void elm_slider_indicator_show_set(Evas_Object *obj, Eina_Bool show) EINA_ARG_NONNULL(1);
18251 * Get whether a given slider widget's enlarging indicator or not.
18253 * @param obj The slider object.
18254 * @return @c EINA_TRUE, if @p obj is enlarging indicator, or
18255 * @c EINA_FALSE otherwise (and on errors).
18257 * @see elm_slider_indicator_show_set() for details.
18261 EAPI Eina_Bool elm_slider_indicator_show_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18268 * @addtogroup Actionslider Actionslider
18270 * @image html img/widget/actionslider/preview-00.png
18271 * @image latex img/widget/actionslider/preview-00.eps
18273 * An actionslider is a switcher for 2 or 3 labels with customizable magnet
18274 * properties. The user drags and releases the indicator, to choose a label.
18276 * Labels occupy the following positions.
18281 * Positions can be enabled or disabled.
18283 * Magnets can be set on the above positions.
18285 * When the indicator is released, it will move to its nearest "enabled and magnetized" position.
18287 * @note By default all positions are set as enabled.
18289 * Signals that you can add callbacks for are:
18291 * "selected" - when user selects an enabled position (the label is passed
18294 * "pos_changed" - when the indicator reaches any of the positions("left",
18295 * "right" or "center").
18297 * See an example of actionslider usage @ref actionslider_example_page "here"
18300 typedef enum _Elm_Actionslider_Pos
18302 ELM_ACTIONSLIDER_NONE = 0,
18303 ELM_ACTIONSLIDER_LEFT = 1 << 0,
18304 ELM_ACTIONSLIDER_CENTER = 1 << 1,
18305 ELM_ACTIONSLIDER_RIGHT = 1 << 2,
18306 ELM_ACTIONSLIDER_ALL = (1 << 3) -1
18307 } Elm_Actionslider_Pos;
18310 * Add a new actionslider to the parent.
18312 * @param parent The parent object
18313 * @return The new actionslider object or NULL if it cannot be created
18315 EAPI Evas_Object *elm_actionslider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
18317 * Set actionslider labels.
18319 * @param obj The actionslider object
18320 * @param left_label The label to be set on the left.
18321 * @param center_label The label to be set on the center.
18322 * @param right_label The label to be set on the right.
18323 * @deprecated use elm_object_text_set() instead.
18325 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);
18327 * Get actionslider labels.
18329 * @param obj The actionslider object
18330 * @param left_label A char** to place the left_label of @p obj into.
18331 * @param center_label A char** to place the center_label of @p obj into.
18332 * @param right_label A char** to place the right_label of @p obj into.
18333 * @deprecated use elm_object_text_set() instead.
18335 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);
18337 * Get actionslider selected label.
18339 * @param obj The actionslider object
18340 * @return The selected label
18342 EAPI const char *elm_actionslider_selected_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18344 * Set actionslider indicator position.
18346 * @param obj The actionslider object.
18347 * @param pos The position of the indicator.
18349 EAPI void elm_actionslider_indicator_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
18351 * Get actionslider indicator position.
18353 * @param obj The actionslider object.
18354 * @return The position of the indicator.
18356 EAPI Elm_Actionslider_Pos elm_actionslider_indicator_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18358 * Set actionslider magnet position. To make multiple positions magnets @c or
18359 * them together(e.g.: ELM_ACTIONSLIDER_LEFT | ELM_ACTIONSLIDER_RIGHT)
18361 * @param obj The actionslider object.
18362 * @param pos Bit mask indicating the magnet positions.
18364 EAPI void elm_actionslider_magnet_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
18366 * Get actionslider magnet position.
18368 * @param obj The actionslider object.
18369 * @return The positions with magnet property.
18371 EAPI Elm_Actionslider_Pos elm_actionslider_magnet_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18373 * Set actionslider enabled position. To set multiple positions as enabled @c or
18374 * them together(e.g.: ELM_ACTIONSLIDER_LEFT | ELM_ACTIONSLIDER_RIGHT).
18376 * @note All the positions are enabled by default.
18378 * @param obj The actionslider object.
18379 * @param pos Bit mask indicating the enabled positions.
18381 EAPI void elm_actionslider_enabled_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
18383 * Get actionslider enabled position.
18385 * @param obj The actionslider object.
18386 * @return The enabled positions.
18388 EAPI Elm_Actionslider_Pos elm_actionslider_enabled_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18390 * Set the label used on the indicator.
18392 * @param obj The actionslider object
18393 * @param label The label to be set on the indicator.
18394 * @deprecated use elm_object_text_set() instead.
18396 EINA_DEPRECATED EAPI void elm_actionslider_indicator_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
18398 * Get the label used on the indicator object.
18400 * @param obj The actionslider object
18401 * @return The indicator label
18402 * @deprecated use elm_object_text_get() instead.
18404 EINA_DEPRECATED EAPI const char *elm_actionslider_indicator_label_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
18410 * @defgroup Genlist Genlist
18412 * @image html img/widget/genlist/preview-00.png
18413 * @image latex img/widget/genlist/preview-00.eps
18414 * @image html img/genlist.png
18415 * @image latex img/genlist.eps
18417 * This widget aims to have more expansive list than the simple list in
18418 * Elementary that could have more flexible items and allow many more entries
18419 * while still being fast and low on memory usage. At the same time it was
18420 * also made to be able to do tree structures. But the price to pay is more
18421 * complexity when it comes to usage. If all you want is a simple list with
18422 * icons and a single text, use the normal @ref List object.
18424 * Genlist has a fairly large API, mostly because it's relatively complex,
18425 * trying to be both expansive, powerful and efficient. First we will begin
18426 * an overview on the theory behind genlist.
18428 * @section Genlist_Item_Class Genlist item classes - creating items
18430 * In order to have the ability to add and delete items on the fly, genlist
18431 * implements a class (callback) system where the application provides a
18432 * structure with information about that type of item (genlist may contain
18433 * multiple different items with different classes, states and styles).
18434 * Genlist will call the functions in this struct (methods) when an item is
18435 * "realized" (i.e., created dynamically, while the user is scrolling the
18436 * grid). All objects will simply be deleted when no longer needed with
18437 * evas_object_del(). The #Elm_Genlist_Item_Class structure contains the
18438 * following members:
18439 * - @c item_style - This is a constant string and simply defines the name
18440 * of the item style. It @b must be specified and the default should be @c
18443 * - @c func - A struct with pointers to functions that will be called when
18444 * an item is going to be actually created. All of them receive a @c data
18445 * parameter that will point to the same data passed to
18446 * elm_genlist_item_append() and related item creation functions, and a @c
18447 * obj parameter that points to the genlist object itself.
18449 * The function pointers inside @c func are @c text_get, @c content_get, @c
18450 * state_get and @c del. The 3 first functions also receive a @c part
18451 * parameter described below. A brief description of these functions follows:
18453 * - @c text_get - The @c part parameter is the name string of one of the
18454 * existing text parts in the Edje group implementing the item's theme.
18455 * This function @b must return a strdup'()ed string, as the caller will
18456 * free() it when done. See #Elm_Genlist_Item_Text_Get_Cb.
18457 * - @c content_get - The @c part parameter is the name string of one of the
18458 * existing (content) swallow parts in the Edje group implementing the item's
18459 * theme. It must return @c NULL, when no content is desired, or a valid
18460 * object handle, otherwise. The object will be deleted by the genlist on
18461 * its deletion or when the item is "unrealized". See
18462 * #Elm_Genlist_Item_Content_Get_Cb.
18463 * - @c func.state_get - The @c part parameter is the name string of one of
18464 * the state parts in the Edje group implementing the item's theme. Return
18465 * @c EINA_FALSE for false/off or @c EINA_TRUE for true/on. Genlists will
18466 * emit a signal to its theming Edje object with @c "elm,state,XXX,active"
18467 * and @c "elm" as "emission" and "source" arguments, respectively, when
18468 * the state is true (the default is false), where @c XXX is the name of
18469 * the (state) part. See #Elm_Genlist_Item_State_Get_Cb.
18470 * - @c func.del - This is intended for use when genlist items are deleted,
18471 * so any data attached to the item (e.g. its data parameter on creation)
18472 * can be deleted. See #Elm_Genlist_Item_Del_Cb.
18474 * available item styles:
18476 * - default_style - The text part is a textblock
18478 * @image html img/widget/genlist/preview-04.png
18479 * @image latex img/widget/genlist/preview-04.eps
18483 * @image html img/widget/genlist/preview-01.png
18484 * @image latex img/widget/genlist/preview-01.eps
18486 * - icon_top_text_bottom
18488 * @image html img/widget/genlist/preview-02.png
18489 * @image latex img/widget/genlist/preview-02.eps
18493 * @image html img/widget/genlist/preview-03.png
18494 * @image latex img/widget/genlist/preview-03.eps
18496 * @section Genlist_Items Structure of items
18498 * An item in a genlist can have 0 or more texts (they can be regular
18499 * text or textblock Evas objects - that's up to the style to determine), 0
18500 * or more contents (which are simply objects swallowed into the genlist item's
18501 * theming Edje object) and 0 or more <b>boolean states</b>, which have the
18502 * behavior left to the user to define. The Edje part names for each of
18503 * these properties will be looked up, in the theme file for the genlist,
18504 * under the Edje (string) data items named @c "labels", @c "contents" and @c
18505 * "states", respectively. For each of those properties, if more than one
18506 * part is provided, they must have names listed separated by spaces in the
18507 * data fields. For the default genlist item theme, we have @b one text
18508 * part (@c "elm.text"), @b two content parts (@c "elm.swalllow.icon" and @c
18509 * "elm.swallow.end") and @b no state parts.
18511 * A genlist item may be at one of several styles. Elementary provides one
18512 * by default - "default", but this can be extended by system or application
18513 * custom themes/overlays/extensions (see @ref Theme "themes" for more
18516 * @section Genlist_Manipulation Editing and Navigating
18518 * Items can be added by several calls. All of them return a @ref
18519 * Elm_Genlist_Item handle that is an internal member inside the genlist.
18520 * They all take a data parameter that is meant to be used for a handle to
18521 * the applications internal data (eg the struct with the original item
18522 * data). The parent parameter is the parent genlist item this belongs to if
18523 * it is a tree or an indexed group, and NULL if there is no parent. The
18524 * flags can be a bitmask of #ELM_GENLIST_ITEM_NONE,
18525 * #ELM_GENLIST_ITEM_SUBITEMS and #ELM_GENLIST_ITEM_GROUP. If
18526 * #ELM_GENLIST_ITEM_SUBITEMS is set then this item is displayed as an item
18527 * that is able to expand and have child items. If ELM_GENLIST_ITEM_GROUP
18528 * is set then this item is group index item that is displayed at the top
18529 * until the next group comes. The func parameter is a convenience callback
18530 * that is called when the item is selected and the data parameter will be
18531 * the func_data parameter, obj be the genlist object and event_info will be
18532 * the genlist item.
18534 * elm_genlist_item_append() adds an item to the end of the list, or if
18535 * there is a parent, to the end of all the child items of the parent.
18536 * elm_genlist_item_prepend() is the same but adds to the beginning of
18537 * the list or children list. elm_genlist_item_insert_before() inserts at
18538 * item before another item and elm_genlist_item_insert_after() inserts after
18539 * the indicated item.
18541 * The application can clear the list with elm_genlist_clear() which deletes
18542 * all the items in the list and elm_genlist_item_del() will delete a specific
18543 * item. elm_genlist_item_subitems_clear() will clear all items that are
18544 * children of the indicated parent item.
18546 * To help inspect list items you can jump to the item at the top of the list
18547 * with elm_genlist_first_item_get() which will return the item pointer, and
18548 * similarly elm_genlist_last_item_get() gets the item at the end of the list.
18549 * elm_genlist_item_next_get() and elm_genlist_item_prev_get() get the next
18550 * and previous items respectively relative to the indicated item. Using
18551 * these calls you can walk the entire item list/tree. Note that as a tree
18552 * the items are flattened in the list, so elm_genlist_item_parent_get() will
18553 * let you know which item is the parent (and thus know how to skip them if
18556 * @section Genlist_Muti_Selection Multi-selection
18558 * If the application wants multiple items to be able to be selected,
18559 * elm_genlist_multi_select_set() can enable this. If the list is
18560 * single-selection only (the default), then elm_genlist_selected_item_get()
18561 * will return the selected item, if any, or NULL if none is selected. If the
18562 * list is multi-select then elm_genlist_selected_items_get() will return a
18563 * list (that is only valid as long as no items are modified (added, deleted,
18564 * selected or unselected)).
18566 * @section Genlist_Usage_Hints Usage hints
18568 * There are also convenience functions. elm_genlist_item_genlist_get() will
18569 * return the genlist object the item belongs to. elm_genlist_item_show()
18570 * will make the scroller scroll to show that specific item so its visible.
18571 * elm_genlist_item_data_get() returns the data pointer set by the item
18572 * creation functions.
18574 * If an item changes (state of boolean changes, text or contents change),
18575 * then use elm_genlist_item_update() to have genlist update the item with
18576 * the new state. Genlist will re-realize the item thus call the functions
18577 * in the _Elm_Genlist_Item_Class for that item.
18579 * To programmatically (un)select an item use elm_genlist_item_selected_set().
18580 * To get its selected state use elm_genlist_item_selected_get(). Similarly
18581 * to expand/contract an item and get its expanded state, use
18582 * elm_genlist_item_expanded_set() and elm_genlist_item_expanded_get(). And
18583 * again to make an item disabled (unable to be selected and appear
18584 * differently) use elm_genlist_item_disabled_set() to set this and
18585 * elm_genlist_item_disabled_get() to get the disabled state.
18587 * In general to indicate how the genlist should expand items horizontally to
18588 * fill the list area, use elm_genlist_horizontal_set(). Valid modes are
18589 * ELM_LIST_LIMIT and ELM_LIST_SCROLL. The default is ELM_LIST_SCROLL. This
18590 * mode means that if items are too wide to fit, the scroller will scroll
18591 * horizontally. Otherwise items are expanded to fill the width of the
18592 * viewport of the scroller. If it is ELM_LIST_LIMIT, items will be expanded
18593 * to the viewport width and limited to that size. This can be combined with
18594 * a different style that uses edjes' ellipsis feature (cutting text off like
18597 * Items will only call their selection func and callback when first becoming
18598 * selected. Any further clicks will do nothing, unless you enable always
18599 * select with elm_genlist_always_select_mode_set(). This means even if
18600 * selected, every click will make the selected callbacks be called.
18601 * elm_genlist_no_select_mode_set() will turn off the ability to select
18602 * items entirely and they will neither appear selected nor call selected
18603 * callback functions.
18605 * Remember that you can create new styles and add your own theme augmentation
18606 * per application with elm_theme_extension_add(). If you absolutely must
18607 * have a specific style that overrides any theme the user or system sets up
18608 * you can use elm_theme_overlay_add() to add such a file.
18610 * @section Genlist_Implementation Implementation
18612 * Evas tracks every object you create. Every time it processes an event
18613 * (mouse move, down, up etc.) it needs to walk through objects and find out
18614 * what event that affects. Even worse every time it renders display updates,
18615 * in order to just calculate what to re-draw, it needs to walk through many
18616 * many many objects. Thus, the more objects you keep active, the more
18617 * overhead Evas has in just doing its work. It is advisable to keep your
18618 * active objects to the minimum working set you need. Also remember that
18619 * object creation and deletion carries an overhead, so there is a
18620 * middle-ground, which is not easily determined. But don't keep massive lists
18621 * of objects you can't see or use. Genlist does this with list objects. It
18622 * creates and destroys them dynamically as you scroll around. It groups them
18623 * into blocks so it can determine the visibility etc. of a whole block at
18624 * once as opposed to having to walk the whole list. This 2-level list allows
18625 * for very large numbers of items to be in the list (tests have used up to
18626 * 2,000,000 items). Also genlist employs a queue for adding items. As items
18627 * may be different sizes, every item added needs to be calculated as to its
18628 * size and thus this presents a lot of overhead on populating the list, this
18629 * genlist employs a queue. Any item added is queued and spooled off over
18630 * time, actually appearing some time later, so if your list has many members
18631 * you may find it takes a while for them to all appear, with your process
18632 * consuming a lot of CPU while it is busy spooling.
18634 * Genlist also implements a tree structure, but it does so with callbacks to
18635 * the application, with the application filling in tree structures when
18636 * requested (allowing for efficient building of a very deep tree that could
18637 * even be used for file-management). See the above smart signal callbacks for
18640 * @section Genlist_Smart_Events Genlist smart events
18642 * Signals that you can add callbacks for are:
18643 * - @c "activated" - The user has double-clicked or pressed
18644 * (enter|return|spacebar) on an item. The @c event_info parameter is the
18645 * item that was activated.
18646 * - @c "clicked,double" - The user has double-clicked an item. The @c
18647 * event_info parameter is the item that was double-clicked.
18648 * - @c "selected" - This is called when a user has made an item selected.
18649 * The event_info parameter is the genlist item that was selected.
18650 * - @c "unselected" - This is called when a user has made an item
18651 * unselected. The event_info parameter is the genlist item that was
18653 * - @c "expanded" - This is called when elm_genlist_item_expanded_set() is
18654 * called and the item is now meant to be expanded. The event_info
18655 * parameter is the genlist item that was indicated to expand. It is the
18656 * job of this callback to then fill in the child items.
18657 * - @c "contracted" - This is called when elm_genlist_item_expanded_set() is
18658 * called and the item is now meant to be contracted. The event_info
18659 * parameter is the genlist item that was indicated to contract. It is the
18660 * job of this callback to then delete the child items.
18661 * - @c "expand,request" - This is called when a user has indicated they want
18662 * to expand a tree branch item. The callback should decide if the item can
18663 * expand (has any children) and then call elm_genlist_item_expanded_set()
18664 * appropriately to set the state. The event_info parameter is the genlist
18665 * item that was indicated to expand.
18666 * - @c "contract,request" - This is called when a user has indicated they
18667 * want to contract a tree branch item. The callback should decide if the
18668 * item can contract (has any children) and then call
18669 * elm_genlist_item_expanded_set() appropriately to set the state. The
18670 * event_info parameter is the genlist item that was indicated to contract.
18671 * - @c "realized" - This is called when the item in the list is created as a
18672 * real evas object. event_info parameter is the genlist item that was
18673 * created. The object may be deleted at any time, so it is up to the
18674 * caller to not use the object pointer from elm_genlist_item_object_get()
18675 * in a way where it may point to freed objects.
18676 * - @c "unrealized" - This is called just before an item is unrealized.
18677 * After this call content objects provided will be deleted and the item
18678 * object itself delete or be put into a floating cache.
18679 * - @c "drag,start,up" - This is called when the item in the list has been
18680 * dragged (not scrolled) up.
18681 * - @c "drag,start,down" - This is called when the item in the list has been
18682 * dragged (not scrolled) down.
18683 * - @c "drag,start,left" - This is called when the item in the list has been
18684 * dragged (not scrolled) left.
18685 * - @c "drag,start,right" - This is called when the item in the list has
18686 * been dragged (not scrolled) right.
18687 * - @c "drag,stop" - This is called when the item in the list has stopped
18689 * - @c "drag" - This is called when the item in the list is being dragged.
18690 * - @c "longpressed" - This is called when the item is pressed for a certain
18691 * amount of time. By default it's 1 second.
18692 * - @c "scroll,anim,start" - This is called when scrolling animation has
18694 * - @c "scroll,anim,stop" - This is called when scrolling animation has
18696 * - @c "scroll,drag,start" - This is called when dragging the content has
18698 * - @c "scroll,drag,stop" - This is called when dragging the content has
18700 * - @c "edge,top" - This is called when the genlist is scrolled until
18702 * - @c "edge,bottom" - This is called when the genlist is scrolled
18703 * until the bottom edge.
18704 * - @c "edge,left" - This is called when the genlist is scrolled
18705 * until the left edge.
18706 * - @c "edge,right" - This is called when the genlist is scrolled
18707 * until the right edge.
18708 * - @c "multi,swipe,left" - This is called when the genlist is multi-touch
18710 * - @c "multi,swipe,right" - This is called when the genlist is multi-touch
18712 * - @c "multi,swipe,up" - This is called when the genlist is multi-touch
18714 * - @c "multi,swipe,down" - This is called when the genlist is multi-touch
18716 * - @c "multi,pinch,out" - This is called when the genlist is multi-touch
18717 * pinched out. "- @c multi,pinch,in" - This is called when the genlist is
18718 * multi-touch pinched in.
18719 * - @c "swipe" - This is called when the genlist is swiped.
18720 * - @c "moved" - This is called when a genlist item is moved.
18721 * - @c "language,changed" - This is called when the program's language is
18724 * @section Genlist_Examples Examples
18726 * Here is a list of examples that use the genlist, trying to show some of
18727 * its capabilities:
18728 * - @ref genlist_example_01
18729 * - @ref genlist_example_02
18730 * - @ref genlist_example_03
18731 * - @ref genlist_example_04
18732 * - @ref genlist_example_05
18736 * @addtogroup Genlist
18741 * @enum _Elm_Genlist_Item_Flags
18742 * @typedef Elm_Genlist_Item_Flags
18744 * Defines if the item is of any special type (has subitems or it's the
18745 * index of a group), or is just a simple item.
18749 typedef enum _Elm_Genlist_Item_Flags
18751 ELM_GENLIST_ITEM_NONE = 0, /**< simple item */
18752 ELM_GENLIST_ITEM_SUBITEMS = (1 << 0), /**< may expand and have child items */
18753 ELM_GENLIST_ITEM_GROUP = (1 << 1) /**< index of a group of items */
18754 } Elm_Genlist_Item_Flags;
18755 typedef enum _Elm_Genlist_Item_Field_Flags
18757 ELM_GENLIST_ITEM_FIELD_ALL = 0,
18758 ELM_GENLIST_ITEM_FIELD_LABEL = (1 << 0),
18759 ELM_GENLIST_ITEM_FIELD_CONTENT = (1 << 1),
18760 ELM_GENLIST_ITEM_FIELD_STATE = (1 << 2)
18761 } Elm_Genlist_Item_Field_Flags;
18762 typedef struct _Elm_Genlist_Item_Class Elm_Genlist_Item_Class; /**< Genlist item class definition structs */
18763 #define Elm_Genlist_Item_Class Elm_Gen_Item_Class
18764 typedef struct _Elm_Genlist_Item Elm_Genlist_Item; /**< Item of Elm_Genlist. Sub-type of Elm_Widget_Item */
18765 #define Elm_Genlist_Item Elm_Gen_Item /**< Item of Elm_Genlist. Sub-type of Elm_Widget_Item */
18766 typedef struct _Elm_Genlist_Item_Class_Func Elm_Genlist_Item_Class_Func; /**< Class functions for genlist item class */
18768 * Text fetching class function for Elm_Gen_Item_Class.
18769 * @param data The data passed in the item creation function
18770 * @param obj The base widget object
18771 * @param part The part name of the swallow
18772 * @return The allocated (NOT stringshared) string to set as the text
18774 typedef char *(*Elm_Genlist_Item_Text_Get_Cb) (void *data, Evas_Object *obj, const char *part);
18776 * Content (swallowed object) fetching class function for Elm_Gen_Item_Class.
18777 * @param data The data passed in the item creation function
18778 * @param obj The base widget object
18779 * @param part The part name of the swallow
18780 * @return The content object to swallow
18782 typedef Evas_Object *(*Elm_Genlist_Item_Content_Get_Cb) (void *data, Evas_Object *obj, const char *part);
18784 * State fetching class function for Elm_Gen_Item_Class.
18785 * @param data The data passed in the item creation function
18786 * @param obj The base widget object
18787 * @param part The part name of the swallow
18788 * @return The hell if I know
18790 typedef Eina_Bool (*Elm_Genlist_Item_State_Get_Cb) (void *data, Evas_Object *obj, const char *part);
18792 * Deletion class function for Elm_Gen_Item_Class.
18793 * @param data The data passed in the item creation function
18794 * @param obj The base widget object
18796 typedef void (*Elm_Genlist_Item_Del_Cb) (void *data, Evas_Object *obj);
18799 * @struct _Elm_Genlist_Item_Class
18801 * Genlist item class definition structs.
18803 * This struct contains the style and fetching functions that will define the
18804 * contents of each item.
18806 * @see @ref Genlist_Item_Class
18808 struct _Elm_Genlist_Item_Class
18810 const char *item_style; /**< style of this class. */
18811 struct Elm_Genlist_Item_Class_Func
18813 Elm_Genlist_Item_Text_Get_Cb text_get; /**< Text fetching class function for genlist item classes.*/
18814 Elm_Genlist_Item_Content_Get_Cb content_get; /**< Content fetching class function for genlist item classes. */
18815 Elm_Genlist_Item_State_Get_Cb state_get; /**< State fetching class function for genlist item classes. */
18816 Elm_Genlist_Item_Del_Cb del; /**< Deletion class function for genlist item classes. */
18819 #define Elm_Genlist_Item_Class_Func Elm_Gen_Item_Class_Func
18821 * Add a new genlist widget to the given parent Elementary
18822 * (container) object
18824 * @param parent The parent object
18825 * @return a new genlist widget handle or @c NULL, on errors
18827 * This function inserts a new genlist widget on the canvas.
18829 * @see elm_genlist_item_append()
18830 * @see elm_genlist_item_del()
18831 * @see elm_genlist_clear()
18835 EAPI Evas_Object *elm_genlist_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
18837 * Remove all items from a given genlist widget.
18839 * @param obj The genlist object
18841 * This removes (and deletes) all items in @p obj, leaving it empty.
18843 * @see elm_genlist_item_del(), to remove just one item.
18847 EAPI void elm_genlist_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
18849 * Enable or disable multi-selection in the genlist
18851 * @param obj The genlist object
18852 * @param multi Multi-select enable/disable. Default is disabled.
18854 * This enables (@c EINA_TRUE) or disables (@c EINA_FALSE) multi-selection in
18855 * the list. This allows more than 1 item to be selected. To retrieve the list
18856 * of selected items, use elm_genlist_selected_items_get().
18858 * @see elm_genlist_selected_items_get()
18859 * @see elm_genlist_multi_select_get()
18863 EAPI void elm_genlist_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
18865 * Gets if multi-selection in genlist is enabled or disabled.
18867 * @param obj The genlist object
18868 * @return Multi-select enabled/disabled
18869 * (@c EINA_TRUE = enabled/@c EINA_FALSE = disabled). Default is @c EINA_FALSE.
18871 * @see elm_genlist_multi_select_set()
18875 EAPI Eina_Bool elm_genlist_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18877 * This sets the horizontal stretching mode.
18879 * @param obj The genlist object
18880 * @param mode The mode to use (one of #ELM_LIST_SCROLL or #ELM_LIST_LIMIT).
18882 * This sets the mode used for sizing items horizontally. Valid modes
18883 * are #ELM_LIST_LIMIT and #ELM_LIST_SCROLL. The default is
18884 * ELM_LIST_SCROLL. This mode means that if items are too wide to fit,
18885 * the scroller will scroll horizontally. Otherwise items are expanded
18886 * to fill the width of the viewport of the scroller. If it is
18887 * ELM_LIST_LIMIT, items will be expanded to the viewport width and
18888 * limited to that size.
18890 * @see elm_genlist_horizontal_get()
18894 EAPI void elm_genlist_horizontal_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
18895 EINA_DEPRECATED EAPI void elm_genlist_horizontal_mode_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
18897 * Gets the horizontal stretching mode.
18899 * @param obj The genlist object
18900 * @return The mode to use
18901 * (#ELM_LIST_LIMIT, #ELM_LIST_SCROLL)
18903 * @see elm_genlist_horizontal_set()
18907 EAPI Elm_List_Mode elm_genlist_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18908 EINA_DEPRECATED EAPI Elm_List_Mode elm_genlist_horizontal_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18910 * Set the always select mode.
18912 * @param obj The genlist object
18913 * @param always_select The always select mode (@c EINA_TRUE = on, @c
18914 * EINA_FALSE = off). Default is @c EINA_FALSE.
18916 * Items will only call their selection func and callback when first
18917 * becoming selected. Any further clicks will do nothing, unless you
18918 * enable always select with elm_genlist_always_select_mode_set().
18919 * This means that, even if selected, every click will make the selected
18920 * callbacks be called.
18922 * @see elm_genlist_always_select_mode_get()
18926 EAPI void elm_genlist_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
18928 * Get the always select mode.
18930 * @param obj The genlist object
18931 * @return The always select mode
18932 * (@c EINA_TRUE = on, @c EINA_FALSE = off)
18934 * @see elm_genlist_always_select_mode_set()
18938 EAPI Eina_Bool elm_genlist_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18940 * Enable/disable the no select mode.
18942 * @param obj The genlist object
18943 * @param no_select The no select mode
18944 * (EINA_TRUE = on, EINA_FALSE = off)
18946 * This will turn off the ability to select items entirely and they
18947 * will neither appear selected nor call selected callback functions.
18949 * @see elm_genlist_no_select_mode_get()
18953 EAPI void elm_genlist_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
18955 * Gets whether the no select mode is enabled.
18957 * @param obj The genlist object
18958 * @return The no select mode
18959 * (@c EINA_TRUE = on, @c EINA_FALSE = off)
18961 * @see elm_genlist_no_select_mode_set()
18965 EAPI Eina_Bool elm_genlist_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18967 * Enable/disable compress mode.
18969 * @param obj The genlist object
18970 * @param compress The compress mode
18971 * (@c EINA_TRUE = on, @c EINA_FALSE = off). Default is @c EINA_FALSE.
18973 * This will enable the compress mode where items are "compressed"
18974 * horizontally to fit the genlist scrollable viewport width. This is
18975 * special for genlist. Do not rely on
18976 * elm_genlist_horizontal_set() being set to @c ELM_LIST_COMPRESS to
18977 * work as genlist needs to handle it specially.
18979 * @see elm_genlist_compress_mode_get()
18983 EAPI void elm_genlist_compress_mode_set(Evas_Object *obj, Eina_Bool compress) EINA_ARG_NONNULL(1);
18985 * Get whether the compress mode is enabled.
18987 * @param obj The genlist object
18988 * @return The compress mode
18989 * (@c EINA_TRUE = on, @c EINA_FALSE = off)
18991 * @see elm_genlist_compress_mode_set()
18995 EAPI Eina_Bool elm_genlist_compress_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18997 * Enable/disable height-for-width mode.
18999 * @param obj The genlist object
19000 * @param setting The height-for-width mode (@c EINA_TRUE = on,
19001 * @c EINA_FALSE = off). Default is @c EINA_FALSE.
19003 * With height-for-width mode the item width will be fixed (restricted
19004 * to a minimum of) to the list width when calculating its size in
19005 * order to allow the height to be calculated based on it. This allows,
19006 * for instance, text block to wrap lines if the Edje part is
19007 * configured with "text.min: 0 1".
19009 * @note This mode will make list resize slower as it will have to
19010 * recalculate every item height again whenever the list width
19013 * @note When height-for-width mode is enabled, it also enables
19014 * compress mode (see elm_genlist_compress_mode_set()) and
19015 * disables homogeneous (see elm_genlist_homogeneous_set()).
19019 EAPI void elm_genlist_height_for_width_mode_set(Evas_Object *obj, Eina_Bool height_for_width) EINA_ARG_NONNULL(1);
19021 * Get whether the height-for-width mode is enabled.
19023 * @param obj The genlist object
19024 * @return The height-for-width mode (@c EINA_TRUE = on, @c EINA_FALSE =
19029 EAPI Eina_Bool elm_genlist_height_for_width_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19031 * Enable/disable horizontal and vertical bouncing effect.
19033 * @param obj The genlist object
19034 * @param h_bounce Allow bounce horizontally (@c EINA_TRUE = on, @c
19035 * EINA_FALSE = off). Default is @c EINA_FALSE.
19036 * @param v_bounce Allow bounce vertically (@c EINA_TRUE = on, @c
19037 * EINA_FALSE = off). Default is @c EINA_TRUE.
19039 * This will enable or disable the scroller bouncing effect for the
19040 * genlist. See elm_scroller_bounce_set() for details.
19042 * @see elm_scroller_bounce_set()
19043 * @see elm_genlist_bounce_get()
19047 EAPI void elm_genlist_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
19049 * Get whether the horizontal and vertical bouncing effect is enabled.
19051 * @param obj The genlist object
19052 * @param h_bounce Pointer to a bool to receive if the bounce horizontally
19054 * @param v_bounce Pointer to a bool to receive if the bounce vertically
19057 * @see elm_genlist_bounce_set()
19061 EAPI void elm_genlist_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
19063 * Enable/disable homogeneous mode.
19065 * @param obj The genlist object
19066 * @param homogeneous Assume the items within the genlist are of the
19067 * same height and width (EINA_TRUE = on, EINA_FALSE = off). Default is @c
19070 * This will enable the homogeneous mode where items are of the same
19071 * height and width so that genlist may do the lazy-loading at its
19072 * maximum (which increases the performance for scrolling the list). This
19073 * implies 'compressed' mode.
19075 * @see elm_genlist_compress_mode_set()
19076 * @see elm_genlist_homogeneous_get()
19080 EAPI void elm_genlist_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
19082 * Get whether the homogeneous mode is enabled.
19084 * @param obj The genlist object
19085 * @return Assume the items within the genlist are of the same height
19086 * and width (EINA_TRUE = on, EINA_FALSE = off)
19088 * @see elm_genlist_homogeneous_set()
19092 EAPI Eina_Bool elm_genlist_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19094 * Set the maximum number of items within an item block
19096 * @param obj The genlist object
19097 * @param n Maximum number of items within an item block. Default is 32.
19099 * This will configure the block count to tune to the target with
19100 * particular performance matrix.
19102 * A block of objects will be used to reduce the number of operations due to
19103 * many objects in the screen. It can determine the visibility, or if the
19104 * object has changed, it theme needs to be updated, etc. doing this kind of
19105 * calculation to the entire block, instead of per object.
19107 * The default value for the block count is enough for most lists, so unless
19108 * you know you will have a lot of objects visible in the screen at the same
19109 * time, don't try to change this.
19111 * @see elm_genlist_block_count_get()
19112 * @see @ref Genlist_Implementation
19116 EAPI void elm_genlist_block_count_set(Evas_Object *obj, int n) EINA_ARG_NONNULL(1);
19118 * Get the maximum number of items within an item block
19120 * @param obj The genlist object
19121 * @return Maximum number of items within an item block
19123 * @see elm_genlist_block_count_set()
19127 EAPI int elm_genlist_block_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19129 * Set the timeout in seconds for the longpress event.
19131 * @param obj The genlist object
19132 * @param timeout timeout in seconds. Default is 1.
19134 * This option will change how long it takes to send an event "longpressed"
19135 * after the mouse down signal is sent to the list. If this event occurs, no
19136 * "clicked" event will be sent.
19138 * @see elm_genlist_longpress_timeout_set()
19142 EAPI void elm_genlist_longpress_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
19144 * Get the timeout in seconds for the longpress event.
19146 * @param obj The genlist object
19147 * @return timeout in seconds
19149 * @see elm_genlist_longpress_timeout_get()
19153 EAPI double elm_genlist_longpress_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19155 * Append a new item in a given genlist widget.
19157 * @param obj The genlist object
19158 * @param itc The item class for the item
19159 * @param data The item data
19160 * @param parent The parent item, or NULL if none
19161 * @param flags Item flags
19162 * @param func Convenience function called when the item is selected
19163 * @param func_data Data passed to @p func above.
19164 * @return A handle to the item added or @c NULL if not possible
19166 * This adds the given item to the end of the list or the end of
19167 * the children list if the @p parent is given.
19169 * @see elm_genlist_item_prepend()
19170 * @see elm_genlist_item_insert_before()
19171 * @see elm_genlist_item_insert_after()
19172 * @see elm_genlist_item_del()
19176 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);
19178 * Prepend a new item in a given genlist widget.
19180 * @param obj The genlist object
19181 * @param itc The item class for the item
19182 * @param data The item data
19183 * @param parent The parent item, or NULL if none
19184 * @param flags Item flags
19185 * @param func Convenience function called when the item is selected
19186 * @param func_data Data passed to @p func above.
19187 * @return A handle to the item added or NULL if not possible
19189 * This adds an item to the beginning of the list or beginning of the
19190 * children of the parent if given.
19192 * @see elm_genlist_item_append()
19193 * @see elm_genlist_item_insert_before()
19194 * @see elm_genlist_item_insert_after()
19195 * @see elm_genlist_item_del()
19199 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);
19201 * Insert an item before another in a genlist widget
19203 * @param obj The genlist object
19204 * @param itc The item class for the item
19205 * @param data The item data
19206 * @param before The item to place this new one before.
19207 * @param flags Item flags
19208 * @param func Convenience function called when the item is selected
19209 * @param func_data Data passed to @p func above.
19210 * @return A handle to the item added or @c NULL if not possible
19212 * This inserts an item before another in the list. It will be in the
19213 * same tree level or group as the item it is inserted before.
19215 * @see elm_genlist_item_append()
19216 * @see elm_genlist_item_prepend()
19217 * @see elm_genlist_item_insert_after()
19218 * @see elm_genlist_item_del()
19222 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);
19224 * Insert an item after another in a genlist widget
19226 * @param obj The genlist object
19227 * @param itc The item class for the item
19228 * @param data The item data
19229 * @param after The item to place this new one after.
19230 * @param flags Item flags
19231 * @param func Convenience function called when the item is selected
19232 * @param func_data Data passed to @p func above.
19233 * @return A handle to the item added or @c NULL if not possible
19235 * This inserts an item after another in the list. It will be in the
19236 * same tree level or group as the item it is inserted after.
19238 * @see elm_genlist_item_append()
19239 * @see elm_genlist_item_prepend()
19240 * @see elm_genlist_item_insert_before()
19241 * @see elm_genlist_item_del()
19245 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);
19247 * Insert a new item into the sorted genlist object
19249 * @param obj The genlist object
19250 * @param itc The item class for the item
19251 * @param data The item data
19252 * @param parent The parent item, or NULL if none
19253 * @param flags Item flags
19254 * @param comp The function called for the sort
19255 * @param func Convenience function called when item selected
19256 * @param func_data Data passed to @p func above.
19257 * @return A handle to the item added or NULL if not possible
19261 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);
19262 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);
19263 /* operations to retrieve existing items */
19265 * Get the selectd item in the genlist.
19267 * @param obj The genlist object
19268 * @return The selected item, or NULL if none is selected.
19270 * This gets the selected item in the list (if multi-selection is enabled, only
19271 * the item that was first selected in the list is returned - which is not very
19272 * useful, so see elm_genlist_selected_items_get() for when multi-selection is
19275 * If no item is selected, NULL is returned.
19277 * @see elm_genlist_selected_items_get()
19281 EAPI Elm_Genlist_Item *elm_genlist_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19283 * Get a list of selected items in the genlist.
19285 * @param obj The genlist object
19286 * @return The list of selected items, or NULL if none are selected.
19288 * It returns a list of the selected items. This list pointer is only valid so
19289 * long as the selection doesn't change (no items are selected or unselected, or
19290 * unselected implicitly by deletion). The list contains Elm_Genlist_Item
19291 * pointers. The order of the items in this list is the order which they were
19292 * selected, i.e. the first item in this list is the first item that was
19293 * selected, and so on.
19295 * @note If not in multi-select mode, consider using function
19296 * elm_genlist_selected_item_get() instead.
19298 * @see elm_genlist_multi_select_set()
19299 * @see elm_genlist_selected_item_get()
19303 EAPI const Eina_List *elm_genlist_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19305 * Get the mode item style of items in the genlist
19306 * @param obj The genlist object
19307 * @return The mode item style string, or NULL if none is specified
19309 * This is a constant string and simply defines the name of the
19310 * style that will be used for mode animations. It can be
19311 * @c NULL if you don't plan to use Genlist mode. See
19312 * elm_genlist_item_mode_set() for more info.
19316 EAPI const char *elm_genlist_mode_item_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19318 * Set the mode item style of items in the genlist
19319 * @param obj The genlist object
19320 * @param style The mode item style string, or NULL if none is desired
19322 * This is a constant string and simply defines the name of the
19323 * style that will be used for mode animations. It can be
19324 * @c NULL if you don't plan to use Genlist mode. See
19325 * elm_genlist_item_mode_set() for more info.
19329 EAPI void elm_genlist_mode_item_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
19331 * Get a list of realized items in genlist
19333 * @param obj The genlist object
19334 * @return The list of realized items, nor NULL if none are realized.
19336 * This returns a list of the realized items in the genlist. The list
19337 * contains Elm_Genlist_Item pointers. The list must be freed by the
19338 * caller when done with eina_list_free(). The item pointers in the
19339 * list are only valid so long as those items are not deleted or the
19340 * genlist is not deleted.
19342 * @see elm_genlist_realized_items_update()
19346 EAPI Eina_List *elm_genlist_realized_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19348 * Get the item that is at the x, y canvas coords.
19350 * @param obj The gelinst object.
19351 * @param x The input x coordinate
19352 * @param y The input y coordinate
19353 * @param posret The position relative to the item returned here
19354 * @return The item at the coordinates or NULL if none
19356 * This returns the item at the given coordinates (which are canvas
19357 * relative, not object-relative). If an item is at that coordinate,
19358 * that item handle is returned, and if @p posret is not NULL, the
19359 * integer pointed to is set to a value of -1, 0 or 1, depending if
19360 * the coordinate is on the upper portion of that item (-1), on the
19361 * middle section (0) or on the lower part (1). If NULL is returned as
19362 * an item (no item found there), then posret may indicate -1 or 1
19363 * based if the coordinate is above or below all items respectively in
19368 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);
19370 * Get the first item in the genlist
19372 * This returns the first item in the list.
19374 * @param obj The genlist object
19375 * @return The first item, or NULL if none
19379 EAPI Elm_Genlist_Item *elm_genlist_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19381 * Get the last item in the genlist
19383 * This returns the last item in the list.
19385 * @return The last item, or NULL if none
19389 EAPI Elm_Genlist_Item *elm_genlist_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19391 * Set the scrollbar policy
19393 * @param obj The genlist object
19394 * @param policy_h Horizontal scrollbar policy.
19395 * @param policy_v Vertical scrollbar policy.
19397 * This sets the scrollbar visibility policy for the given genlist
19398 * scroller. #ELM_SMART_SCROLLER_POLICY_AUTO means the scrollbar is
19399 * made visible if it is needed, and otherwise kept hidden.
19400 * #ELM_SMART_SCROLLER_POLICY_ON turns it on all the time, and
19401 * #ELM_SMART_SCROLLER_POLICY_OFF always keeps it off. This applies
19402 * respectively for the horizontal and vertical scrollbars. Default is
19403 * #ELM_SMART_SCROLLER_POLICY_AUTO
19405 * @see elm_genlist_scroller_policy_get()
19409 EAPI void elm_genlist_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
19411 * Get the scrollbar policy
19413 * @param obj The genlist object
19414 * @param policy_h Pointer to store the horizontal scrollbar policy.
19415 * @param policy_v Pointer to store the vertical scrollbar policy.
19417 * @see elm_genlist_scroller_policy_set()
19421 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);
19423 * Get the @b next item in a genlist widget's internal list of items,
19424 * given a handle to one of those items.
19426 * @param item The genlist item to fetch next from
19427 * @return The item after @p item, or @c NULL if there's none (and
19430 * This returns the item placed after the @p item, on the container
19433 * @see elm_genlist_item_prev_get()
19437 EAPI Elm_Genlist_Item *elm_genlist_item_next_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19439 * Get the @b previous item in a genlist widget's internal list of items,
19440 * given a handle to one of those items.
19442 * @param item The genlist item to fetch previous from
19443 * @return The item before @p item, or @c NULL if there's none (and
19446 * This returns the item placed before the @p item, on the container
19449 * @see elm_genlist_item_next_get()
19453 EAPI Elm_Genlist_Item *elm_genlist_item_prev_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19455 * Get the genlist object's handle which contains a given genlist
19458 * @param item The item to fetch the container from
19459 * @return The genlist (parent) object
19461 * This returns the genlist object itself that an item belongs to.
19465 EAPI Evas_Object *elm_genlist_item_genlist_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19467 * Get the parent item of the given item
19469 * @param it The item
19470 * @return The parent of the item or @c NULL if it has no parent.
19472 * This returns the item that was specified as parent of the item @p it on
19473 * elm_genlist_item_append() and insertion related functions.
19477 EAPI Elm_Genlist_Item *elm_genlist_item_parent_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19479 * Remove all sub-items (children) of the given item
19481 * @param it The item
19483 * This removes all items that are children (and their descendants) of the
19484 * given item @p it.
19486 * @see elm_genlist_clear()
19487 * @see elm_genlist_item_del()
19491 EAPI void elm_genlist_item_subitems_clear(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19493 * Set whether a given genlist item is selected or not
19495 * @param it The item
19496 * @param selected Use @c EINA_TRUE, to make it selected, @c
19497 * EINA_FALSE to make it unselected
19499 * This sets the selected state of an item. If multi selection is
19500 * not enabled on the containing genlist and @p selected is @c
19501 * EINA_TRUE, any other previously selected items will get
19502 * unselected in favor of this new one.
19504 * @see elm_genlist_item_selected_get()
19508 EAPI void elm_genlist_item_selected_set(Elm_Genlist_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
19510 * Get whether a given genlist item is selected or not
19512 * @param it The item
19513 * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
19515 * @see elm_genlist_item_selected_set() for more details
19519 EAPI Eina_Bool elm_genlist_item_selected_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19521 * Sets the expanded state of an item.
19523 * @param it The item
19524 * @param expanded The expanded state (@c EINA_TRUE expanded, @c EINA_FALSE not expanded).
19526 * This function flags the item of type #ELM_GENLIST_ITEM_SUBITEMS as
19529 * The theme will respond to this change visually, and a signal "expanded" or
19530 * "contracted" will be sent from the genlist with a pointer to the item that
19531 * has been expanded/contracted.
19533 * Calling this function won't show or hide any child of this item (if it is
19534 * a parent). You must manually delete and create them on the callbacks fo
19535 * the "expanded" or "contracted" signals.
19537 * @see elm_genlist_item_expanded_get()
19541 EAPI void elm_genlist_item_expanded_set(Elm_Genlist_Item *item, Eina_Bool expanded) EINA_ARG_NONNULL(1);
19543 * Get the expanded state of an item
19545 * @param it The item
19546 * @return The expanded state
19548 * This gets the expanded state of an item.
19550 * @see elm_genlist_item_expanded_set()
19554 EAPI Eina_Bool elm_genlist_item_expanded_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19556 * Get the depth of expanded item
19558 * @param it The genlist item object
19559 * @return The depth of expanded item
19563 EAPI int elm_genlist_item_expanded_depth_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19565 * Set whether a given genlist item is disabled or not.
19567 * @param it The item
19568 * @param disabled Use @c EINA_TRUE, true disable it, @c EINA_FALSE
19569 * to enable it back.
19571 * A disabled item cannot be selected or unselected. It will also
19572 * change its appearance, to signal the user it's disabled.
19574 * @see elm_genlist_item_disabled_get()
19578 EAPI void elm_genlist_item_disabled_set(Elm_Genlist_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
19580 * Get whether a given genlist item is disabled or not.
19582 * @param it The item
19583 * @return @c EINA_TRUE, if it's disabled, @c EINA_FALSE otherwise
19586 * @see elm_genlist_item_disabled_set() for more details
19590 EAPI Eina_Bool elm_genlist_item_disabled_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19592 * Sets the display only state of an item.
19594 * @param it The item
19595 * @param display_only @c EINA_TRUE if the item is display only, @c
19596 * EINA_FALSE otherwise.
19598 * A display only item cannot be selected or unselected. It is for
19599 * display only and not selecting or otherwise clicking, dragging
19600 * etc. by the user, thus finger size rules will not be applied to
19603 * It's good to set group index items to display only state.
19605 * @see elm_genlist_item_display_only_get()
19609 EAPI void elm_genlist_item_display_only_set(Elm_Genlist_Item *it, Eina_Bool display_only) EINA_ARG_NONNULL(1);
19611 * Get the display only state of an item
19613 * @param it The item
19614 * @return @c EINA_TRUE if the item is display only, @c
19615 * EINA_FALSE otherwise.
19617 * @see elm_genlist_item_display_only_set()
19621 EAPI Eina_Bool elm_genlist_item_display_only_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19623 * Show the portion of a genlist's internal list containing a given
19624 * item, immediately.
19626 * @param it The item to display
19628 * This causes genlist to jump to the given item @p it and show it (by
19629 * immediately scrolling to that position), if it is not fully visible.
19631 * @see elm_genlist_item_bring_in()
19632 * @see elm_genlist_item_top_show()
19633 * @see elm_genlist_item_middle_show()
19637 EAPI void elm_genlist_item_show(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19639 * Animatedly bring in, to the visible are of a genlist, a given
19642 * @param it The item to display
19644 * This causes genlist to jump to the given item @p it and show it (by
19645 * animatedly scrolling), if it is not fully visible. This may use animation
19646 * to do so and take a period of time
19648 * @see elm_genlist_item_show()
19649 * @see elm_genlist_item_top_bring_in()
19650 * @see elm_genlist_item_middle_bring_in()
19654 EAPI void elm_genlist_item_bring_in(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19656 * Show the portion of a genlist's internal list containing a given
19657 * item, immediately.
19659 * @param it The item to display
19661 * This causes genlist to jump to the given item @p it and show it (by
19662 * immediately scrolling to that position), if it is not fully visible.
19664 * The item will be positioned at the top of the genlist viewport.
19666 * @see elm_genlist_item_show()
19667 * @see elm_genlist_item_top_bring_in()
19671 EAPI void elm_genlist_item_top_show(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19673 * Animatedly bring in, to the visible are of a genlist, a given
19676 * @param it The item
19678 * This causes genlist to jump to the given item @p it and show it (by
19679 * animatedly scrolling), if it is not fully visible. This may use animation
19680 * to do so and take a period of time
19682 * The item will be positioned at the top of the genlist viewport.
19684 * @see elm_genlist_item_bring_in()
19685 * @see elm_genlist_item_top_show()
19689 EAPI void elm_genlist_item_top_bring_in(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19691 * Show the portion of a genlist's internal list containing a given
19692 * item, immediately.
19694 * @param it The item to display
19696 * This causes genlist to jump to the given item @p it and show it (by
19697 * immediately scrolling to that position), if it is not fully visible.
19699 * The item will be positioned at the middle of the genlist viewport.
19701 * @see elm_genlist_item_show()
19702 * @see elm_genlist_item_middle_bring_in()
19706 EAPI void elm_genlist_item_middle_show(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19708 * Animatedly bring in, to the visible are of a genlist, a given
19711 * @param it The item
19713 * This causes genlist to jump to the given item @p it and show it (by
19714 * animatedly scrolling), if it is not fully visible. This may use animation
19715 * to do so and take a period of time
19717 * The item will be positioned at the middle of the genlist viewport.
19719 * @see elm_genlist_item_bring_in()
19720 * @see elm_genlist_item_middle_show()
19724 EAPI void elm_genlist_item_middle_bring_in(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19726 * Remove a genlist item from the its parent, deleting it.
19728 * @param item The item to be removed.
19729 * @return @c EINA_TRUE on success or @c EINA_FALSE, otherwise.
19731 * @see elm_genlist_clear(), to remove all items in a genlist at
19736 EAPI void elm_genlist_item_del(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19738 * Return the data associated to a given genlist item
19740 * @param item The genlist item.
19741 * @return the data associated to this item.
19743 * This returns the @c data value passed on the
19744 * elm_genlist_item_append() and related item addition calls.
19746 * @see elm_genlist_item_append()
19747 * @see elm_genlist_item_data_set()
19751 EAPI void *elm_genlist_item_data_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19753 * Set the data associated to a given genlist item
19755 * @param item The genlist item
19756 * @param data The new data pointer to set on it
19758 * This @b overrides the @c data value passed on the
19759 * elm_genlist_item_append() and related item addition calls. This
19760 * function @b won't call elm_genlist_item_update() automatically,
19761 * so you'd issue it afterwards if you want to hove the item
19762 * updated to reflect the that new data.
19764 * @see elm_genlist_item_data_get()
19768 EAPI void elm_genlist_item_data_set(Elm_Genlist_Item *it, const void *data) EINA_ARG_NONNULL(1);
19770 * Tells genlist to "orphan" contents fetchs by the item class
19772 * @param it The item
19774 * This instructs genlist to release references to contents in the item,
19775 * meaning that they will no longer be managed by genlist and are
19776 * floating "orphans" that can be re-used elsewhere if the user wants
19781 EAPI void elm_genlist_item_contents_orphan(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19782 EINA_DEPRECATED EAPI void elm_genlist_item_icons_orphan(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19784 * Get the real Evas object created to implement the view of a
19785 * given genlist item
19787 * @param item The genlist item.
19788 * @return the Evas object implementing this item's view.
19790 * This returns the actual Evas object used to implement the
19791 * specified genlist item's view. This may be @c NULL, as it may
19792 * not have been created or may have been deleted, at any time, by
19793 * the genlist. <b>Do not modify this object</b> (move, resize,
19794 * show, hide, etc.), as the genlist is controlling it. This
19795 * function is for querying, emitting custom signals or hooking
19796 * lower level callbacks for events on that object. Do not delete
19797 * this object under any circumstances.
19799 * @see elm_genlist_item_data_get()
19803 EAPI const Evas_Object *elm_genlist_item_object_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19805 * Update the contents of an item
19807 * @param it The item
19809 * This updates an item by calling all the item class functions again
19810 * to get the contents, texts and states. Use this when the original
19811 * item data has changed and the changes are desired to be reflected.
19813 * Use elm_genlist_realized_items_update() to update all already realized
19816 * @see elm_genlist_realized_items_update()
19820 EAPI void elm_genlist_item_update(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19822 * Promote an item to the top of the list
19824 * @param it The item
19828 EAPI void elm_genlist_item_promote(Elm_Gen_Item *it) EINA_ARG_NONNULL(1);
19830 * Demote an item to the end of the list
19832 * @param it The item
19836 EAPI void elm_genlist_item_demote(Elm_Gen_Item *it) EINA_ARG_NONNULL(1);
19838 * Update the part of an item
19840 * @param it The item
19841 * @param parts The name of item's part
19842 * @param itf The flags of item's part type
19844 * This updates an item's part by calling item's fetching functions again
19845 * to get the contents, texts and states. Use this when the original
19846 * item data has changed and the changes are desired to be reflected.
19847 * Second parts argument is used for globbing to match '*', '?', and '.'
19848 * It can be used at updating multi fields.
19850 * Use elm_genlist_realized_items_update() to update an item's all
19853 * @see elm_genlist_item_update()
19857 EAPI void elm_genlist_item_fields_update(Elm_Genlist_Item *it, const char *parts, Elm_Genlist_Item_Field_Flags itf) EINA_ARG_NONNULL(1);
19859 * Update the item class of an item
19861 * @param it The item
19862 * @param itc The item class for the item
19864 * This sets another class fo the item, changing the way that it is
19865 * displayed. After changing the item class, elm_genlist_item_update() is
19866 * called on the item @p it.
19870 EAPI void elm_genlist_item_item_class_update(Elm_Genlist_Item *it, const Elm_Genlist_Item_Class *itc) EINA_ARG_NONNULL(1, 2);
19871 EAPI const Elm_Genlist_Item_Class *elm_genlist_item_item_class_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19873 * Set the text to be shown in a given genlist item's tooltips.
19875 * @param item The genlist item
19876 * @param text The text to set in the content
19878 * This call will setup the text to be used as tooltip to that item
19879 * (analogous to elm_object_tooltip_text_set(), but being item
19880 * tooltips with higher precedence than object tooltips). It can
19881 * have only one tooltip at a time, so any previous tooltip data
19882 * will get removed.
19884 * In order to set a content or something else as a tooltip, look at
19885 * elm_genlist_item_tooltip_content_cb_set().
19889 EAPI void elm_genlist_item_tooltip_text_set(Elm_Genlist_Item *item, const char *text) EINA_ARG_NONNULL(1);
19891 * Set the content to be shown in a given genlist item's tooltips
19893 * @param item The genlist item.
19894 * @param func The function returning the tooltip contents.
19895 * @param data What to provide to @a func as callback data/context.
19896 * @param del_cb Called when data is not needed anymore, either when
19897 * another callback replaces @p func, the tooltip is unset with
19898 * elm_genlist_item_tooltip_unset() or the owner @p item
19899 * dies. This callback receives as its first parameter the
19900 * given @p data, being @c event_info the item handle.
19902 * This call will setup the tooltip's contents to @p item
19903 * (analogous to elm_object_tooltip_content_cb_set(), but being
19904 * item tooltips with higher precedence than object tooltips). It
19905 * can have only one tooltip at a time, so any previous tooltip
19906 * content will get removed. @p func (with @p data) will be called
19907 * every time Elementary needs to show the tooltip and it should
19908 * return a valid Evas object, which will be fully managed by the
19909 * tooltip system, getting deleted when the tooltip is gone.
19911 * In order to set just a text as a tooltip, look at
19912 * elm_genlist_item_tooltip_text_set().
19916 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);
19918 * Unset a tooltip from a given genlist item
19920 * @param item genlist item to remove a previously set tooltip from.
19922 * This call removes any tooltip set on @p item. The callback
19923 * provided as @c del_cb to
19924 * elm_genlist_item_tooltip_content_cb_set() will be called to
19925 * notify it is not used anymore (and have resources cleaned, if
19928 * @see elm_genlist_item_tooltip_content_cb_set()
19932 EAPI void elm_genlist_item_tooltip_unset(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19934 * Set a different @b style for a given genlist item's tooltip.
19936 * @param item genlist item with tooltip set
19937 * @param style the <b>theme style</b> to use on tooltips (e.g. @c
19938 * "default", @c "transparent", etc)
19940 * Tooltips can have <b>alternate styles</b> to be displayed on,
19941 * which are defined by the theme set on Elementary. This function
19942 * works analogously as elm_object_tooltip_style_set(), but here
19943 * applied only to genlist item objects. The default style for
19944 * tooltips is @c "default".
19946 * @note before you set a style you should define a tooltip with
19947 * elm_genlist_item_tooltip_content_cb_set() or
19948 * elm_genlist_item_tooltip_text_set()
19950 * @see elm_genlist_item_tooltip_style_get()
19954 EAPI void elm_genlist_item_tooltip_style_set(Elm_Genlist_Item *item, const char *style) EINA_ARG_NONNULL(1);
19956 * Get the style set a given genlist item's tooltip.
19958 * @param item genlist item with tooltip already set on.
19959 * @return style the theme style in use, which defaults to
19960 * "default". If the object does not have a tooltip set,
19961 * then @c NULL is returned.
19963 * @see elm_genlist_item_tooltip_style_set() for more details
19967 EAPI const char *elm_genlist_item_tooltip_style_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19969 * @brief Disable size restrictions on an object's tooltip
19970 * @param item The tooltip's anchor object
19971 * @param disable If EINA_TRUE, size restrictions are disabled
19972 * @return EINA_FALSE on failure, EINA_TRUE on success
19974 * This function allows a tooltip to expand beyond its parant window's canvas.
19975 * It will instead be limited only by the size of the display.
19977 EAPI Eina_Bool elm_genlist_item_tooltip_size_restrict_disable(Elm_Genlist_Item *item, Eina_Bool disable);
19979 * @brief Retrieve size restriction state of an object's tooltip
19980 * @param item The tooltip's anchor object
19981 * @return If EINA_TRUE, size restrictions are disabled
19983 * This function returns whether a tooltip is allowed to expand beyond
19984 * its parant window's canvas.
19985 * It will instead be limited only by the size of the display.
19987 EAPI Eina_Bool elm_genlist_item_tooltip_size_restrict_disabled_get(const Elm_Genlist_Item *item);
19989 * Set the type of mouse pointer/cursor decoration to be shown,
19990 * when the mouse pointer is over the given genlist widget item
19992 * @param item genlist item to customize cursor on
19993 * @param cursor the cursor type's name
19995 * This function works analogously as elm_object_cursor_set(), but
19996 * here the cursor's changing area is restricted to the item's
19997 * area, and not the whole widget's. Note that that item cursors
19998 * have precedence over widget cursors, so that a mouse over @p
19999 * item will always show cursor @p type.
20001 * If this function is called twice for an object, a previously set
20002 * cursor will be unset on the second call.
20004 * @see elm_object_cursor_set()
20005 * @see elm_genlist_item_cursor_get()
20006 * @see elm_genlist_item_cursor_unset()
20010 EAPI void elm_genlist_item_cursor_set(Elm_Genlist_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
20012 * Get the type of mouse pointer/cursor decoration set to be shown,
20013 * when the mouse pointer is over the given genlist widget item
20015 * @param item genlist item with custom cursor set
20016 * @return the cursor type's name or @c NULL, if no custom cursors
20017 * were set to @p item (and on errors)
20019 * @see elm_object_cursor_get()
20020 * @see elm_genlist_item_cursor_set() for more details
20021 * @see elm_genlist_item_cursor_unset()
20025 EAPI const char *elm_genlist_item_cursor_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
20027 * Unset any custom mouse pointer/cursor decoration set to be
20028 * shown, when the mouse pointer is over the given genlist widget
20029 * item, thus making it show the @b default cursor again.
20031 * @param item a genlist item
20033 * Use this call to undo any custom settings on this item's cursor
20034 * decoration, bringing it back to defaults (no custom style set).
20036 * @see elm_object_cursor_unset()
20037 * @see elm_genlist_item_cursor_set() for more details
20041 EAPI void elm_genlist_item_cursor_unset(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
20043 * Set a different @b style for a given custom cursor set for a
20046 * @param item genlist item with custom cursor set
20047 * @param style the <b>theme style</b> to use (e.g. @c "default",
20048 * @c "transparent", etc)
20050 * This function only makes sense when one is using custom mouse
20051 * cursor decorations <b>defined in a theme file</b> , which can
20052 * have, given a cursor name/type, <b>alternate styles</b> on
20053 * it. It works analogously as elm_object_cursor_style_set(), but
20054 * here applied only to genlist item objects.
20056 * @warning Before you set a cursor style you should have defined a
20057 * custom cursor previously on the item, with
20058 * elm_genlist_item_cursor_set()
20060 * @see elm_genlist_item_cursor_engine_only_set()
20061 * @see elm_genlist_item_cursor_style_get()
20065 EAPI void elm_genlist_item_cursor_style_set(Elm_Genlist_Item *item, const char *style) EINA_ARG_NONNULL(1);
20067 * Get the current @b style set for a given genlist item's custom
20070 * @param item genlist item with custom cursor set.
20071 * @return style the cursor style in use. If the object does not
20072 * have a cursor set, then @c NULL is returned.
20074 * @see elm_genlist_item_cursor_style_set() for more details
20078 EAPI const char *elm_genlist_item_cursor_style_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
20080 * Set if the (custom) cursor for a given genlist item should be
20081 * searched in its theme, also, or should only rely on the
20082 * rendering engine.
20084 * @param item item with custom (custom) cursor already set on
20085 * @param engine_only Use @c EINA_TRUE to have cursors looked for
20086 * only on those provided by the rendering engine, @c EINA_FALSE to
20087 * have them searched on the widget's theme, as well.
20089 * @note This call is of use only if you've set a custom cursor
20090 * for genlist items, with elm_genlist_item_cursor_set().
20092 * @note By default, cursors will only be looked for between those
20093 * provided by the rendering engine.
20097 EAPI void elm_genlist_item_cursor_engine_only_set(Elm_Genlist_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
20099 * Get if the (custom) cursor for a given genlist item is being
20100 * searched in its theme, also, or is only relying on the rendering
20103 * @param item a genlist item
20104 * @return @c EINA_TRUE, if cursors are being looked for only on
20105 * those provided by the rendering engine, @c EINA_FALSE if they
20106 * are being searched on the widget's theme, as well.
20108 * @see elm_genlist_item_cursor_engine_only_set(), for more details
20112 EAPI Eina_Bool elm_genlist_item_cursor_engine_only_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
20114 * Update the contents of all realized items.
20116 * @param obj The genlist object.
20118 * This updates all realized items by calling all the item class functions again
20119 * to get the contents, texts and states. Use this when the original
20120 * item data has changed and the changes are desired to be reflected.
20122 * To update just one item, use elm_genlist_item_update().
20124 * @see elm_genlist_realized_items_get()
20125 * @see elm_genlist_item_update()
20129 EAPI void elm_genlist_realized_items_update(Evas_Object *obj) EINA_ARG_NONNULL(1);
20131 * Activate a genlist mode on an item
20133 * @param item The genlist item
20134 * @param mode Mode name
20135 * @param mode_set Boolean to define set or unset mode.
20137 * A genlist mode is a different way of selecting an item. Once a mode is
20138 * activated on an item, any other selected item is immediately unselected.
20139 * This feature provides an easy way of implementing a new kind of animation
20140 * for selecting an item, without having to entirely rewrite the item style
20141 * theme. However, the elm_genlist_selected_* API can't be used to get what
20142 * item is activate for a mode.
20144 * The current item style will still be used, but applying a genlist mode to
20145 * an item will select it using a different kind of animation.
20147 * The current active item for a mode can be found by
20148 * elm_genlist_mode_item_get().
20150 * The characteristics of genlist mode are:
20151 * - Only one mode can be active at any time, and for only one item.
20152 * - Genlist handles deactivating other items when one item is activated.
20153 * - A mode is defined in the genlist theme (edc), and more modes can easily
20155 * - A mode style and the genlist item style are different things. They
20156 * can be combined to provide a default style to the item, with some kind
20157 * of animation for that item when the mode is activated.
20159 * When a mode is activated on an item, a new view for that item is created.
20160 * The theme of this mode defines the animation that will be used to transit
20161 * the item from the old view to the new view. This second (new) view will be
20162 * active for that item while the mode is active on the item, and will be
20163 * destroyed after the mode is totally deactivated from that item.
20165 * @see elm_genlist_mode_get()
20166 * @see elm_genlist_mode_item_get()
20170 EAPI void elm_genlist_item_mode_set(Elm_Genlist_Item *it, const char *mode_type, Eina_Bool mode_set) EINA_ARG_NONNULL(1, 2);
20172 * Get the last (or current) genlist mode used.
20174 * @param obj The genlist object
20176 * This function just returns the name of the last used genlist mode. It will
20177 * be the current mode if it's still active.
20179 * @see elm_genlist_item_mode_set()
20180 * @see elm_genlist_mode_item_get()
20184 EAPI const char *elm_genlist_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20186 * Get active genlist mode item
20188 * @param obj The genlist object
20189 * @return The active item for that current mode. Or @c NULL if no item is
20190 * activated with any mode.
20192 * This function returns the item that was activated with a mode, by the
20193 * function elm_genlist_item_mode_set().
20195 * @see elm_genlist_item_mode_set()
20196 * @see elm_genlist_mode_get()
20200 EAPI const Elm_Genlist_Item *elm_genlist_mode_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20205 * @param obj The genlist object
20206 * @param reorder_mode The reorder mode
20207 * (EINA_TRUE = on, EINA_FALSE = off)
20211 EAPI void elm_genlist_reorder_mode_set(Evas_Object *obj, Eina_Bool reorder_mode) EINA_ARG_NONNULL(1);
20214 * Get the reorder mode
20216 * @param obj The genlist object
20217 * @return The reorder mode
20218 * (EINA_TRUE = on, EINA_FALSE = off)
20222 EAPI Eina_Bool elm_genlist_reorder_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20229 * @defgroup Check Check
20231 * @image html img/widget/check/preview-00.png
20232 * @image latex img/widget/check/preview-00.eps
20233 * @image html img/widget/check/preview-01.png
20234 * @image latex img/widget/check/preview-01.eps
20235 * @image html img/widget/check/preview-02.png
20236 * @image latex img/widget/check/preview-02.eps
20238 * @brief The check widget allows for toggling a value between true and
20241 * Check objects are a lot like radio objects in layout and functionality
20242 * except they do not work as a group, but independently and only toggle the
20243 * value of a boolean from false to true (0 or 1). elm_check_state_set() sets
20244 * the boolean state (1 for true, 0 for false), and elm_check_state_get()
20245 * returns the current state. For convenience, like the radio objects, you
20246 * can set a pointer to a boolean directly with elm_check_state_pointer_set()
20247 * for it to modify.
20249 * Signals that you can add callbacks for are:
20250 * "changed" - This is called whenever the user changes the state of one of
20251 * the check object(event_info is NULL).
20253 * Default contents parts of the check widget that you can use for are:
20254 * @li "icon" - An icon of the check
20256 * Default text parts of the check widget that you can use for are:
20257 * @li "elm.text" - Label of the check
20259 * @ref tutorial_check should give you a firm grasp of how to use this widget
20264 * @brief Add a new Check object
20266 * @param parent The parent object
20267 * @return The new object or NULL if it cannot be created
20269 EAPI Evas_Object *elm_check_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20271 * @brief Set the text label of the check object
20273 * @param obj The check object
20274 * @param label The text label string in UTF-8
20276 * @deprecated use elm_object_text_set() instead.
20278 EINA_DEPRECATED EAPI void elm_check_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
20280 * @brief Get the text label of the check object
20282 * @param obj The check object
20283 * @return The text label string in UTF-8
20285 * @deprecated use elm_object_text_get() instead.
20287 EINA_DEPRECATED EAPI const char *elm_check_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20289 * @brief Set the icon object of the check object
20291 * @param obj The check object
20292 * @param icon The icon object
20294 * Once the icon object is set, a previously set one will be deleted.
20295 * If you want to keep that old content object, use the
20296 * elm_object_content_unset() function.
20298 * @deprecated use elm_object_part_content_set() instead.
20301 EINA_DEPRECATED EAPI void elm_check_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
20303 * @brief Get the icon object of the check object
20305 * @param obj The check object
20306 * @return The icon object
20308 * @deprecated use elm_object_part_content_get() instead.
20311 EINA_DEPRECATED EAPI Evas_Object *elm_check_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20313 * @brief Unset the icon used for the check object
20315 * @param obj The check object
20316 * @return The icon object that was being used
20318 * Unparent and return the icon object which was set for this widget.
20320 * @deprecated use elm_object_part_content_unset() instead.
20323 EINA_DEPRECATED EAPI Evas_Object *elm_check_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
20325 * @brief Set the on/off state of the check object
20327 * @param obj The check object
20328 * @param state The state to use (1 == on, 0 == off)
20330 * This sets the state of the check. If set
20331 * with elm_check_state_pointer_set() the state of that variable is also
20332 * changed. Calling this @b doesn't cause the "changed" signal to be emited.
20334 EAPI void elm_check_state_set(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
20336 * @brief Get the state of the check object
20338 * @param obj The check object
20339 * @return The boolean state
20341 EAPI Eina_Bool elm_check_state_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20343 * @brief Set a convenience pointer to a boolean to change
20345 * @param obj The check object
20346 * @param statep Pointer to the boolean to modify
20348 * This sets a pointer to a boolean, that, in addition to the check objects
20349 * state will also be modified directly. To stop setting the object pointed
20350 * to simply use NULL as the @p statep parameter. If @p statep is not NULL,
20351 * then when this is called, the check objects state will also be modified to
20352 * reflect the value of the boolean @p statep points to, just like calling
20353 * elm_check_state_set().
20355 EAPI void elm_check_state_pointer_set(Evas_Object *obj, Eina_Bool *statep) EINA_ARG_NONNULL(1);
20356 EINA_DEPRECATED EAPI void elm_check_states_labels_set(Evas_Object *obj, const char *ontext, const char *offtext) EINA_ARG_NONNULL(1,2,3);
20357 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);
20364 * @defgroup Radio Radio
20366 * @image html img/widget/radio/preview-00.png
20367 * @image latex img/widget/radio/preview-00.eps
20369 * @brief Radio is a widget that allows for 1 or more options to be displayed
20370 * and have the user choose only 1 of them.
20372 * A radio object contains an indicator, an optional Label and an optional
20373 * icon object. While it's possible to have a group of only one radio they,
20374 * are normally used in groups of 2 or more. To add a radio to a group use
20375 * elm_radio_group_add(). The radio object(s) will select from one of a set
20376 * of integer values, so any value they are configuring needs to be mapped to
20377 * a set of integers. To configure what value that radio object represents,
20378 * use elm_radio_state_value_set() to set the integer it represents. To set
20379 * the value the whole group(which one is currently selected) is to indicate
20380 * use elm_radio_value_set() on any group member, and to get the groups value
20381 * use elm_radio_value_get(). For convenience the radio objects are also able
20382 * to directly set an integer(int) to the value that is selected. To specify
20383 * the pointer to this integer to modify, use elm_radio_value_pointer_set().
20384 * The radio objects will modify this directly. That implies the pointer must
20385 * point to valid memory for as long as the radio objects exist.
20387 * Signals that you can add callbacks for are:
20388 * @li changed - This is called whenever the user changes the state of one of
20389 * the radio objects within the group of radio objects that work together.
20391 * Default contents parts of the radio widget that you can use for are:
20392 * @li "icon" - An icon of the radio
20394 * @ref tutorial_radio show most of this API in action.
20398 * @brief Add a new radio to the parent
20400 * @param parent The parent object
20401 * @return The new object or NULL if it cannot be created
20403 EAPI Evas_Object *elm_radio_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20405 * @brief Set the text label of the radio object
20407 * @param obj The radio object
20408 * @param label The text label string in UTF-8
20410 * @deprecated use elm_object_text_set() instead.
20412 EINA_DEPRECATED EAPI void elm_radio_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
20414 * @brief Get the text label of the radio object
20416 * @param obj The radio object
20417 * @return The text label string in UTF-8
20419 * @deprecated use elm_object_text_set() instead.
20421 EINA_DEPRECATED EAPI const char *elm_radio_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20423 * @brief Set the icon object of the radio object
20425 * @param obj The radio object
20426 * @param icon The icon object
20428 * Once the icon object is set, a previously set one will be deleted. If you
20429 * want to keep that old content object, use the elm_radio_icon_unset()
20432 * @deprecated use elm_object_part_content_set() instead.
20435 EINA_DEPRECATED EAPI void elm_radio_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
20437 * @brief Get the icon object of the radio object
20439 * @param obj The radio object
20440 * @return The icon object
20442 * @see elm_radio_icon_set()
20444 * @deprecated use elm_object_part_content_get() instead.
20447 EINA_DEPRECATED EAPI Evas_Object *elm_radio_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20449 * @brief Unset the icon used for the radio object
20451 * @param obj The radio object
20452 * @return The icon object that was being used
20454 * Unparent and return the icon object which was set for this widget.
20456 * @see elm_radio_icon_set()
20457 * @deprecated use elm_object_part_content_unset() instead.
20460 EINA_DEPRECATED EAPI Evas_Object *elm_radio_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
20462 * @brief Add this radio to a group of other radio objects
20464 * @param obj The radio object
20465 * @param group Any object whose group the @p obj is to join.
20467 * Radio objects work in groups. Each member should have a different integer
20468 * value assigned. In order to have them work as a group, they need to know
20469 * about each other. This adds the given radio object to the group of which
20470 * the group object indicated is a member.
20472 EAPI void elm_radio_group_add(Evas_Object *obj, Evas_Object *group) EINA_ARG_NONNULL(1);
20474 * @brief Set the integer value that this radio object represents
20476 * @param obj The radio object
20477 * @param value The value to use if this radio object is selected
20479 * This sets the value of the radio.
20481 EAPI void elm_radio_state_value_set(Evas_Object *obj, int value) EINA_ARG_NONNULL(1);
20483 * @brief Get the integer value that this radio object represents
20485 * @param obj The radio object
20486 * @return The value used if this radio object is selected
20488 * This gets the value of the radio.
20490 * @see elm_radio_value_set()
20492 EAPI int elm_radio_state_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20494 * @brief Set the value of the radio.
20496 * @param obj The radio object
20497 * @param value The value to use for the group
20499 * This sets the value of the radio group and will also set the value if
20500 * pointed to, to the value supplied, but will not call any callbacks.
20502 EAPI void elm_radio_value_set(Evas_Object *obj, int value) EINA_ARG_NONNULL(1);
20504 * @brief Get the state of the radio object
20506 * @param obj The radio object
20507 * @return The integer state
20509 EAPI int elm_radio_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20511 * @brief Set a convenience pointer to a integer to change
20513 * @param obj The radio object
20514 * @param valuep Pointer to the integer to modify
20516 * This sets a pointer to a integer, that, in addition to the radio objects
20517 * state will also be modified directly. To stop setting the object pointed
20518 * to simply use NULL as the @p valuep argument. If valuep is not NULL, then
20519 * when this is called, the radio objects state will also be modified to
20520 * reflect the value of the integer valuep points to, just like calling
20521 * elm_radio_value_set().
20523 EAPI void elm_radio_value_pointer_set(Evas_Object *obj, int *valuep) EINA_ARG_NONNULL(1);
20529 * @defgroup Pager Pager
20531 * @image html img/widget/pager/preview-00.png
20532 * @image latex img/widget/pager/preview-00.eps
20534 * @brief Widget that allows flipping between one or more āpagesā
20537 * The flipping between pages of objects is animated. All content
20538 * in the pager is kept in a stack, being the last content added
20539 * (visible one) on the top of that stack.
20541 * Objects can be pushed or popped from the stack or deleted as
20542 * well. Pushes and pops will animate the widget accordingly to its
20543 * style (a pop will also delete the child object once the
20544 * animation is finished). Any object already in the pager can be
20545 * promoted to the top (from its current stacking position) through
20546 * the use of elm_pager_content_promote(). New objects are pushed
20547 * to the top with elm_pager_content_push(). When the top item is
20548 * no longer wanted, simply pop it with elm_pager_content_pop() and
20549 * it will also be deleted. If an object is no longer needed and is
20550 * not the top item, just delete it as normal. You can query which
20551 * objects are the top and bottom with
20552 * elm_pager_content_bottom_get() and elm_pager_content_top_get().
20554 * Signals that you can add callbacks for are:
20555 * - @c "show,finished" - when a new page is actually shown on the top
20556 * - @c "hide,finished" - when a previous page is hidden
20558 * Only after the first of that signals the child object is
20559 * guaranteed to be visible, as in @c evas_object_visible_get().
20561 * This widget has the following styles available:
20564 * - @c "fade_translucide"
20565 * - @c "fade_invisible"
20567 * @note These styles affect only the flipping animations on the
20568 * default theme; the appearance when not animating is unaffected
20571 * @ref tutorial_pager gives a good overview of the usage of the API.
20576 * Add a new pager to the parent
20578 * @param parent The parent object
20579 * @return The new object or NULL if it cannot be created
20583 EAPI Evas_Object *elm_pager_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20586 * @brief Push an object to the top of the pager stack (and show it).
20588 * @param obj The pager object
20589 * @param content The object to push
20591 * The object pushed becomes a child of the pager, it will be controlled and
20592 * deleted when the pager is deleted.
20594 * @note If the content is already in the stack use
20595 * elm_pager_content_promote().
20596 * @warning Using this function on @p content already in the stack results in
20597 * undefined behavior.
20599 EAPI void elm_pager_content_push(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
20602 * @brief Pop the object that is on top of the stack
20604 * @param obj The pager object
20606 * This pops the object that is on the top(visible) of the pager, makes it
20607 * disappear, then deletes the object. The object that was underneath it on
20608 * the stack will become visible.
20610 EAPI void elm_pager_content_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
20613 * @brief Moves an object already in the pager stack to the top of the stack.
20615 * @param obj The pager object
20616 * @param content The object to promote
20618 * This will take the @p content and move it to the top of the stack as
20619 * if it had been pushed there.
20621 * @note If the content isn't already in the stack use
20622 * elm_pager_content_push().
20623 * @warning Using this function on @p content not already in the stack
20624 * results in undefined behavior.
20626 EAPI void elm_pager_content_promote(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
20629 * @brief Return the object at the bottom of the pager stack
20631 * @param obj The pager object
20632 * @return The bottom object or NULL if none
20634 EAPI Evas_Object *elm_pager_content_bottom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20637 * @brief Return the object at the top of the pager stack
20639 * @param obj The pager object
20640 * @return The top object or NULL if none
20642 EAPI Evas_Object *elm_pager_content_top_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20649 * @defgroup Slideshow Slideshow
20651 * @image html img/widget/slideshow/preview-00.png
20652 * @image latex img/widget/slideshow/preview-00.eps
20654 * This widget, as the name indicates, is a pre-made image
20655 * slideshow panel, with API functions acting on (child) image
20656 * items presentation. Between those actions, are:
20657 * - advance to next/previous image
20658 * - select the style of image transition animation
20659 * - set the exhibition time for each image
20660 * - start/stop the slideshow
20662 * The transition animations are defined in the widget's theme,
20663 * consequently new animations can be added without having to
20664 * update the widget's code.
20666 * @section Slideshow_Items Slideshow items
20668 * For slideshow items, just like for @ref Genlist "genlist" ones,
20669 * the user defines a @b classes, specifying functions that will be
20670 * called on the item's creation and deletion times.
20672 * The #Elm_Slideshow_Item_Class structure contains the following
20675 * - @c func.get - When an item is displayed, this function is
20676 * called, and it's where one should create the item object, de
20677 * facto. For example, the object can be a pure Evas image object
20678 * or an Elementary @ref Photocam "photocam" widget. See
20679 * #SlideshowItemGetFunc.
20680 * - @c func.del - When an item is no more displayed, this function
20681 * is called, where the user must delete any data associated to
20682 * the item. See #SlideshowItemDelFunc.
20684 * @section Slideshow_Caching Slideshow caching
20686 * The slideshow provides facilities to have items adjacent to the
20687 * one being displayed <b>already "realized"</b> (i.e. loaded) for
20688 * you, so that the system does not have to decode image data
20689 * anymore at the time it has to actually switch images on its
20690 * viewport. The user is able to set the numbers of items to be
20691 * cached @b before and @b after the current item, in the widget's
20694 * Smart events one can add callbacks for are:
20696 * - @c "changed" - when the slideshow switches its view to a new
20699 * List of examples for the slideshow widget:
20700 * @li @ref slideshow_example
20704 * @addtogroup Slideshow
20708 typedef struct _Elm_Slideshow_Item_Class Elm_Slideshow_Item_Class; /**< Slideshow item class definition struct */
20709 typedef struct _Elm_Slideshow_Item_Class_Func Elm_Slideshow_Item_Class_Func; /**< Class functions for slideshow item classes. */
20710 typedef struct _Elm_Slideshow_Item Elm_Slideshow_Item; /**< Slideshow item handle */
20711 typedef Evas_Object *(*SlideshowItemGetFunc) (void *data, Evas_Object *obj); /**< Image fetching class function for slideshow item classes. */
20712 typedef void (*SlideshowItemDelFunc) (void *data, Evas_Object *obj); /**< Deletion class function for slideshow item classes. */
20715 * @struct _Elm_Slideshow_Item_Class
20717 * Slideshow item class definition. See @ref Slideshow_Items for
20720 struct _Elm_Slideshow_Item_Class
20722 struct _Elm_Slideshow_Item_Class_Func
20724 SlideshowItemGetFunc get;
20725 SlideshowItemDelFunc del;
20727 }; /**< #Elm_Slideshow_Item_Class member definitions */
20730 * Add a new slideshow widget to the given parent Elementary
20731 * (container) object
20733 * @param parent The parent object
20734 * @return A new slideshow widget handle or @c NULL, on errors
20736 * This function inserts a new slideshow widget on the canvas.
20738 * @ingroup Slideshow
20740 EAPI Evas_Object *elm_slideshow_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20743 * Add (append) a new item in a given slideshow widget.
20745 * @param obj The slideshow object
20746 * @param itc The item class for the item
20747 * @param data The item's data
20748 * @return A handle to the item added or @c NULL, on errors
20750 * Add a new item to @p obj's internal list of items, appending it.
20751 * The item's class must contain the function really fetching the
20752 * image object to show for this item, which could be an Evas image
20753 * object or an Elementary photo, for example. The @p data
20754 * parameter is going to be passed to both class functions of the
20757 * @see #Elm_Slideshow_Item_Class
20758 * @see elm_slideshow_item_sorted_insert()
20760 * @ingroup Slideshow
20762 EAPI Elm_Slideshow_Item *elm_slideshow_item_add(Evas_Object *obj, const Elm_Slideshow_Item_Class *itc, const void *data) EINA_ARG_NONNULL(1);
20765 * Insert a new item into the given slideshow widget, using the @p func
20766 * function to sort items (by item handles).
20768 * @param obj The slideshow object
20769 * @param itc The item class for the item
20770 * @param data The item's data
20771 * @param func The comparing function to be used to sort slideshow
20772 * items <b>by #Elm_Slideshow_Item item handles</b>
20773 * @return Returns The slideshow item handle, on success, or
20774 * @c NULL, on errors
20776 * Add a new item to @p obj's internal list of items, in a position
20777 * determined by the @p func comparing function. The item's class
20778 * must contain the function really fetching the image object to
20779 * show for this item, which could be an Evas image object or an
20780 * Elementary photo, for example. The @p data parameter is going to
20781 * be passed to both class functions of the item.
20783 * @see #Elm_Slideshow_Item_Class
20784 * @see elm_slideshow_item_add()
20786 * @ingroup Slideshow
20788 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);
20791 * Display a given slideshow widget's item, programmatically.
20793 * @param obj The slideshow object
20794 * @param item The item to display on @p obj's viewport
20796 * The change between the current item and @p item will use the
20797 * transition @p obj is set to use (@see
20798 * elm_slideshow_transition_set()).
20800 * @ingroup Slideshow
20802 EAPI void elm_slideshow_show(Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
20805 * Slide to the @b next item, in a given slideshow widget
20807 * @param obj The slideshow object
20809 * The sliding animation @p obj is set to use will be the
20810 * transition effect used, after this call is issued.
20812 * @note If the end of the slideshow's internal list of items is
20813 * reached, it'll wrap around to the list's beginning, again.
20815 * @ingroup Slideshow
20817 EAPI void elm_slideshow_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
20820 * Slide to the @b previous item, in a given slideshow widget
20822 * @param obj The slideshow object
20824 * The sliding animation @p obj is set to use will be the
20825 * transition effect used, after this call is issued.
20827 * @note If the beginning of the slideshow's internal list of items
20828 * is reached, it'll wrap around to the list's end, again.
20830 * @ingroup Slideshow
20832 EAPI void elm_slideshow_previous(Evas_Object *obj) EINA_ARG_NONNULL(1);
20835 * Returns the list of sliding transition/effect names available, for a
20836 * given slideshow widget.
20838 * @param obj The slideshow object
20839 * @return The list of transitions (list of @b stringshared strings
20842 * The transitions, which come from @p obj's theme, must be an EDC
20843 * data item named @c "transitions" on the theme file, with (prefix)
20844 * names of EDC programs actually implementing them.
20846 * The available transitions for slideshows on the default theme are:
20847 * - @c "fade" - the current item fades out, while the new one
20848 * fades in to the slideshow's viewport.
20849 * - @c "black_fade" - the current item fades to black, and just
20850 * then, the new item will fade in.
20851 * - @c "horizontal" - the current item slides horizontally, until
20852 * it gets out of the slideshow's viewport, while the new item
20853 * comes from the left to take its place.
20854 * - @c "vertical" - the current item slides vertically, until it
20855 * gets out of the slideshow's viewport, while the new item comes
20856 * from the bottom to take its place.
20857 * - @c "square" - the new item starts to appear from the middle of
20858 * the current one, but with a tiny size, growing until its
20859 * target (full) size and covering the old one.
20861 * @warning The stringshared strings get no new references
20862 * exclusive to the user grabbing the list, here, so if you'd like
20863 * to use them out of this call's context, you'd better @c
20864 * eina_stringshare_ref() them.
20866 * @see elm_slideshow_transition_set()
20868 * @ingroup Slideshow
20870 EAPI const Eina_List *elm_slideshow_transitions_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20873 * Set the current slide transition/effect in use for a given
20876 * @param obj The slideshow object
20877 * @param transition The new transition's name string
20879 * If @p transition is implemented in @p obj's theme (i.e., is
20880 * contained in the list returned by
20881 * elm_slideshow_transitions_get()), this new sliding effect will
20882 * be used on the widget.
20884 * @see elm_slideshow_transitions_get() for more details
20886 * @ingroup Slideshow
20888 EAPI void elm_slideshow_transition_set(Evas_Object *obj, const char *transition) EINA_ARG_NONNULL(1);
20891 * Get the current slide transition/effect in use for a given
20894 * @param obj The slideshow object
20895 * @return The current transition's name
20897 * @see elm_slideshow_transition_set() for more details
20899 * @ingroup Slideshow
20901 EAPI const char *elm_slideshow_transition_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20904 * Set the interval between each image transition on a given
20905 * slideshow widget, <b>and start the slideshow, itself</b>
20907 * @param obj The slideshow object
20908 * @param timeout The new displaying timeout for images
20910 * After this call, the slideshow widget will start cycling its
20911 * view, sequentially and automatically, with the images of the
20912 * items it has. The time between each new image displayed is going
20913 * to be @p timeout, in @b seconds. If a different timeout was set
20914 * previously and an slideshow was in progress, it will continue
20915 * with the new time between transitions, after this call.
20917 * @note A value less than or equal to 0 on @p timeout will disable
20918 * the widget's internal timer, thus halting any slideshow which
20919 * could be happening on @p obj.
20921 * @see elm_slideshow_timeout_get()
20923 * @ingroup Slideshow
20925 EAPI void elm_slideshow_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
20928 * Get the interval set for image transitions on a given slideshow
20931 * @param obj The slideshow object
20932 * @return Returns the timeout set on it
20934 * @see elm_slideshow_timeout_set() for more details
20936 * @ingroup Slideshow
20938 EAPI double elm_slideshow_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20941 * Set if, after a slideshow is started, for a given slideshow
20942 * widget, its items should be displayed cyclically or not.
20944 * @param obj The slideshow object
20945 * @param loop Use @c EINA_TRUE to make it cycle through items or
20946 * @c EINA_FALSE for it to stop at the end of @p obj's internal
20949 * @note elm_slideshow_next() and elm_slideshow_previous() will @b
20950 * ignore what is set by this functions, i.e., they'll @b always
20951 * cycle through items. This affects only the "automatic"
20952 * slideshow, as set by elm_slideshow_timeout_set().
20954 * @see elm_slideshow_loop_get()
20956 * @ingroup Slideshow
20958 EAPI void elm_slideshow_loop_set(Evas_Object *obj, Eina_Bool loop) EINA_ARG_NONNULL(1);
20961 * Get if, after a slideshow is started, for a given slideshow
20962 * widget, its items are to be displayed cyclically or not.
20964 * @param obj The slideshow object
20965 * @return @c EINA_TRUE, if the items in @p obj will be cycled
20966 * through or @c EINA_FALSE, otherwise
20968 * @see elm_slideshow_loop_set() for more details
20970 * @ingroup Slideshow
20972 EAPI Eina_Bool elm_slideshow_loop_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20975 * Remove all items from a given slideshow widget
20977 * @param obj The slideshow object
20979 * This removes (and deletes) all items in @p obj, leaving it
20982 * @see elm_slideshow_item_del(), to remove just one item.
20984 * @ingroup Slideshow
20986 EAPI void elm_slideshow_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
20989 * Get the internal list of items in a given slideshow widget.
20991 * @param obj The slideshow object
20992 * @return The list of items (#Elm_Slideshow_Item as data) or
20993 * @c NULL on errors.
20995 * This list is @b not to be modified in any way and must not be
20996 * freed. Use the list members with functions like
20997 * elm_slideshow_item_del(), elm_slideshow_item_data_get().
20999 * @warning This list is only valid until @p obj object's internal
21000 * items list is changed. It should be fetched again with another
21001 * call to this function when changes happen.
21003 * @ingroup Slideshow
21005 EAPI const Eina_List *elm_slideshow_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21008 * Delete a given item from a slideshow widget.
21010 * @param item The slideshow item
21012 * @ingroup Slideshow
21014 EAPI void elm_slideshow_item_del(Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
21017 * Return the data associated with a given slideshow item
21019 * @param item The slideshow item
21020 * @return Returns the data associated to this item
21022 * @ingroup Slideshow
21024 EAPI void *elm_slideshow_item_data_get(const Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
21027 * Returns the currently displayed item, in a given slideshow widget
21029 * @param obj The slideshow object
21030 * @return A handle to the item being displayed in @p obj or
21031 * @c NULL, if none is (and on errors)
21033 * @ingroup Slideshow
21035 EAPI Elm_Slideshow_Item *elm_slideshow_item_current_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21038 * Get the real Evas object created to implement the view of a
21039 * given slideshow item
21041 * @param item The slideshow item.
21042 * @return the Evas object implementing this item's view.
21044 * This returns the actual Evas object used to implement the
21045 * specified slideshow item's view. This may be @c NULL, as it may
21046 * not have been created or may have been deleted, at any time, by
21047 * the slideshow. <b>Do not modify this object</b> (move, resize,
21048 * show, hide, etc.), as the slideshow is controlling it. This
21049 * function is for querying, emitting custom signals or hooking
21050 * lower level callbacks for events on that object. Do not delete
21051 * this object under any circumstances.
21053 * @see elm_slideshow_item_data_get()
21055 * @ingroup Slideshow
21057 EAPI Evas_Object* elm_slideshow_item_object_get(const Elm_Slideshow_Item* item) EINA_ARG_NONNULL(1);
21060 * Get the the item, in a given slideshow widget, placed at
21061 * position @p nth, in its internal items list
21063 * @param obj The slideshow object
21064 * @param nth The number of the item to grab a handle to (0 being
21066 * @return The item stored in @p obj at position @p nth or @c NULL,
21067 * if there's no item with that index (and on errors)
21069 * @ingroup Slideshow
21071 EAPI Elm_Slideshow_Item *elm_slideshow_item_nth_get(const Evas_Object *obj, unsigned int nth) EINA_ARG_NONNULL(1);
21074 * Set the current slide layout in use for a given slideshow widget
21076 * @param obj The slideshow object
21077 * @param layout The new layout's name string
21079 * If @p layout is implemented in @p obj's theme (i.e., is contained
21080 * in the list returned by elm_slideshow_layouts_get()), this new
21081 * images layout will be used on the widget.
21083 * @see elm_slideshow_layouts_get() for more details
21085 * @ingroup Slideshow
21087 EAPI void elm_slideshow_layout_set(Evas_Object *obj, const char *layout) EINA_ARG_NONNULL(1);
21090 * Get the current slide layout in use for a given slideshow widget
21092 * @param obj The slideshow object
21093 * @return The current layout's name
21095 * @see elm_slideshow_layout_set() for more details
21097 * @ingroup Slideshow
21099 EAPI const char *elm_slideshow_layout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21102 * Returns the list of @b layout names available, for a given
21103 * slideshow widget.
21105 * @param obj The slideshow object
21106 * @return The list of layouts (list of @b stringshared strings
21109 * Slideshow layouts will change how the widget is to dispose each
21110 * image item in its viewport, with regard to cropping, scaling,
21113 * The layouts, which come from @p obj's theme, must be an EDC
21114 * data item name @c "layouts" on the theme file, with (prefix)
21115 * names of EDC programs actually implementing them.
21117 * The available layouts for slideshows on the default theme are:
21118 * - @c "fullscreen" - item images with original aspect, scaled to
21119 * touch top and down slideshow borders or, if the image's heigh
21120 * is not enough, left and right slideshow borders.
21121 * - @c "not_fullscreen" - the same behavior as the @c "fullscreen"
21122 * one, but always leaving 10% of the slideshow's dimensions of
21123 * distance between the item image's borders and the slideshow
21124 * borders, for each axis.
21126 * @warning The stringshared strings get no new references
21127 * exclusive to the user grabbing the list, here, so if you'd like
21128 * to use them out of this call's context, you'd better @c
21129 * eina_stringshare_ref() them.
21131 * @see elm_slideshow_layout_set()
21133 * @ingroup Slideshow
21135 EAPI const Eina_List *elm_slideshow_layouts_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21138 * Set the number of items to cache, on a given slideshow widget,
21139 * <b>before the current item</b>
21141 * @param obj The slideshow object
21142 * @param count Number of items to cache before the current one
21144 * The default value for this property is @c 2. See
21145 * @ref Slideshow_Caching "slideshow caching" for more details.
21147 * @see elm_slideshow_cache_before_get()
21149 * @ingroup Slideshow
21151 EAPI void elm_slideshow_cache_before_set(Evas_Object *obj, int count) EINA_ARG_NONNULL(1);
21154 * Retrieve the number of items to cache, on a given slideshow widget,
21155 * <b>before the current item</b>
21157 * @param obj The slideshow object
21158 * @return The number of items set to be cached before the current one
21160 * @see elm_slideshow_cache_before_set() for more details
21162 * @ingroup Slideshow
21164 EAPI int elm_slideshow_cache_before_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21167 * Set the number of items to cache, on a given slideshow widget,
21168 * <b>after the current item</b>
21170 * @param obj The slideshow object
21171 * @param count Number of items to cache after the current one
21173 * The default value for this property is @c 2. See
21174 * @ref Slideshow_Caching "slideshow caching" for more details.
21176 * @see elm_slideshow_cache_after_get()
21178 * @ingroup Slideshow
21180 EAPI void elm_slideshow_cache_after_set(Evas_Object *obj, int count) EINA_ARG_NONNULL(1);
21183 * Retrieve the number of items to cache, on a given slideshow widget,
21184 * <b>after the current item</b>
21186 * @param obj The slideshow object
21187 * @return The number of items set to be cached after the current one
21189 * @see elm_slideshow_cache_after_set() for more details
21191 * @ingroup Slideshow
21193 EAPI int elm_slideshow_cache_after_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21196 * Get the number of items stored in a given slideshow widget
21198 * @param obj The slideshow object
21199 * @return The number of items on @p obj, at the moment of this call
21201 * @ingroup Slideshow
21203 EAPI unsigned int elm_slideshow_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21210 * @defgroup Fileselector File Selector
21212 * @image html img/widget/fileselector/preview-00.png
21213 * @image latex img/widget/fileselector/preview-00.eps
21215 * A file selector is a widget that allows a user to navigate
21216 * through a file system, reporting file selections back via its
21219 * It contains shortcut buttons for home directory (@c ~) and to
21220 * jump one directory upwards (..), as well as cancel/ok buttons to
21221 * confirm/cancel a given selection. After either one of those two
21222 * former actions, the file selector will issue its @c "done" smart
21225 * There's a text entry on it, too, showing the name of the current
21226 * selection. There's the possibility of making it editable, so it
21227 * is useful on file saving dialogs on applications, where one
21228 * gives a file name to save contents to, in a given directory in
21229 * the system. This custom file name will be reported on the @c
21230 * "done" smart callback (explained in sequence).
21232 * Finally, it has a view to display file system items into in two
21237 * If Elementary is built with support of the Ethumb thumbnailing
21238 * library, the second form of view will display preview thumbnails
21239 * of files which it supports.
21241 * Smart callbacks one can register to:
21243 * - @c "selected" - the user has clicked on a file (when not in
21244 * folders-only mode) or directory (when in folders-only mode)
21245 * - @c "directory,open" - the list has been populated with new
21246 * content (@c event_info is a pointer to the directory's
21247 * path, a @b stringshared string)
21248 * - @c "done" - the user has clicked on the "ok" or "cancel"
21249 * buttons (@c event_info is a pointer to the selection's
21250 * path, a @b stringshared string)
21252 * Here is an example on its usage:
21253 * @li @ref fileselector_example
21257 * @addtogroup Fileselector
21262 * Defines how a file selector widget is to layout its contents
21263 * (file system entries).
21265 typedef enum _Elm_Fileselector_Mode
21267 ELM_FILESELECTOR_LIST = 0, /**< layout as a list */
21268 ELM_FILESELECTOR_GRID, /**< layout as a grid */
21269 ELM_FILESELECTOR_LAST /**< sentinel (helper) value, not used */
21270 } Elm_Fileselector_Mode;
21273 * Add a new file selector widget to the given parent Elementary
21274 * (container) object
21276 * @param parent The parent object
21277 * @return a new file selector widget handle or @c NULL, on errors
21279 * This function inserts a new file selector widget on the canvas.
21281 * @ingroup Fileselector
21283 EAPI Evas_Object *elm_fileselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21286 * Enable/disable the file name entry box where the user can type
21287 * in a name for a file, in a given file selector widget
21289 * @param obj The file selector object
21290 * @param is_save @c EINA_TRUE to make the file selector a "saving
21291 * dialog", @c EINA_FALSE otherwise
21293 * Having the entry editable is useful on file saving dialogs on
21294 * applications, where one gives a file name to save contents to,
21295 * in a given directory in the system. This custom file name will
21296 * be reported on the @c "done" smart callback.
21298 * @see elm_fileselector_is_save_get()
21300 * @ingroup Fileselector
21302 EAPI void elm_fileselector_is_save_set(Evas_Object *obj, Eina_Bool is_save) EINA_ARG_NONNULL(1);
21305 * Get whether the given file selector is in "saving dialog" mode
21307 * @param obj The file selector object
21308 * @return @c EINA_TRUE, if the file selector is in "saving dialog"
21309 * mode, @c EINA_FALSE otherwise (and on errors)
21311 * @see elm_fileselector_is_save_set() for more details
21313 * @ingroup Fileselector
21315 EAPI Eina_Bool elm_fileselector_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21318 * Enable/disable folder-only view for a given file selector widget
21320 * @param obj The file selector object
21321 * @param only @c EINA_TRUE to make @p obj only display
21322 * directories, @c EINA_FALSE to make files to be displayed in it
21325 * If enabled, the widget's view will only display folder items,
21328 * @see elm_fileselector_folder_only_get()
21330 * @ingroup Fileselector
21332 EAPI void elm_fileselector_folder_only_set(Evas_Object *obj, Eina_Bool only) EINA_ARG_NONNULL(1);
21335 * Get whether folder-only view is set for a given file selector
21338 * @param obj The file selector object
21339 * @return only @c EINA_TRUE if @p obj is only displaying
21340 * directories, @c EINA_FALSE if files are being displayed in it
21341 * too (and on errors)
21343 * @see elm_fileselector_folder_only_get()
21345 * @ingroup Fileselector
21347 EAPI Eina_Bool elm_fileselector_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21350 * Enable/disable the "ok" and "cancel" buttons on a given file
21353 * @param obj The file selector object
21354 * @param only @c EINA_TRUE to show them, @c EINA_FALSE to hide.
21356 * @note A file selector without those buttons will never emit the
21357 * @c "done" smart event, and is only usable if one is just hooking
21358 * to the other two events.
21360 * @see elm_fileselector_buttons_ok_cancel_get()
21362 * @ingroup Fileselector
21364 EAPI void elm_fileselector_buttons_ok_cancel_set(Evas_Object *obj, Eina_Bool buttons) EINA_ARG_NONNULL(1);
21367 * Get whether the "ok" and "cancel" buttons on a given file
21368 * selector widget are being shown.
21370 * @param obj The file selector object
21371 * @return @c EINA_TRUE if they are being shown, @c EINA_FALSE
21372 * otherwise (and on errors)
21374 * @see elm_fileselector_buttons_ok_cancel_set() for more details
21376 * @ingroup Fileselector
21378 EAPI Eina_Bool elm_fileselector_buttons_ok_cancel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21381 * Enable/disable a tree view in the given file selector widget,
21382 * <b>if it's in @c #ELM_FILESELECTOR_LIST mode</b>
21384 * @param obj The file selector object
21385 * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
21388 * In a tree view, arrows are created on the sides of directories,
21389 * allowing them to expand in place.
21391 * @note If it's in other mode, the changes made by this function
21392 * will only be visible when one switches back to "list" mode.
21394 * @see elm_fileselector_expandable_get()
21396 * @ingroup Fileselector
21398 EAPI void elm_fileselector_expandable_set(Evas_Object *obj, Eina_Bool expand) EINA_ARG_NONNULL(1);
21401 * Get whether tree view is enabled for the given file selector
21404 * @param obj The file selector object
21405 * @return @c EINA_TRUE if @p obj is in tree view, @c EINA_FALSE
21406 * otherwise (and or errors)
21408 * @see elm_fileselector_expandable_set() for more details
21410 * @ingroup Fileselector
21412 EAPI Eina_Bool elm_fileselector_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21415 * Set, programmatically, the @b directory that a given file
21416 * selector widget will display contents from
21418 * @param obj The file selector object
21419 * @param path The path to display in @p obj
21421 * This will change the @b directory that @p obj is displaying. It
21422 * will also clear the text entry area on the @p obj object, which
21423 * displays select files' names.
21425 * @see elm_fileselector_path_get()
21427 * @ingroup Fileselector
21429 EAPI void elm_fileselector_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
21432 * Get the parent directory's path that a given file selector
21433 * widget is displaying
21435 * @param obj The file selector object
21436 * @return The (full) path of the directory the file selector is
21437 * displaying, a @b stringshared string
21439 * @see elm_fileselector_path_set()
21441 * @ingroup Fileselector
21443 EAPI const char *elm_fileselector_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21446 * Set, programmatically, the currently selected file/directory in
21447 * the given file selector widget
21449 * @param obj The file selector object
21450 * @param path The (full) path to a file or directory
21451 * @return @c EINA_TRUE on success, @c EINA_FALSE on failure. The
21452 * latter case occurs if the directory or file pointed to do not
21455 * @see elm_fileselector_selected_get()
21457 * @ingroup Fileselector
21459 EAPI Eina_Bool elm_fileselector_selected_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
21462 * Get the currently selected item's (full) path, in the given file
21465 * @param obj The file selector object
21466 * @return The absolute path of the selected item, a @b
21467 * stringshared string
21469 * @note Custom editions on @p obj object's text entry, if made,
21470 * will appear on the return string of this function, naturally.
21472 * @see elm_fileselector_selected_set() for more details
21474 * @ingroup Fileselector
21476 EAPI const char *elm_fileselector_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21479 * Set the mode in which a given file selector widget will display
21480 * (layout) file system entries in its view
21482 * @param obj The file selector object
21483 * @param mode The mode of the fileselector, being it one of
21484 * #ELM_FILESELECTOR_LIST (default) or #ELM_FILESELECTOR_GRID. The
21485 * first one, naturally, will display the files in a list. The
21486 * latter will make the widget to display its entries in a grid
21489 * @note By using elm_fileselector_expandable_set(), the user may
21490 * trigger a tree view for that list.
21492 * @note If Elementary is built with support of the Ethumb
21493 * thumbnailing library, the second form of view will display
21494 * preview thumbnails of files which it supports. You must have
21495 * elm_need_ethumb() called in your Elementary for thumbnailing to
21498 * @see elm_fileselector_expandable_set().
21499 * @see elm_fileselector_mode_get().
21501 * @ingroup Fileselector
21503 EAPI void elm_fileselector_mode_set(Evas_Object *obj, Elm_Fileselector_Mode mode) EINA_ARG_NONNULL(1);
21506 * Get the mode in which a given file selector widget is displaying
21507 * (layouting) file system entries in its view
21509 * @param obj The fileselector object
21510 * @return The mode in which the fileselector is at
21512 * @see elm_fileselector_mode_set() for more details
21514 * @ingroup Fileselector
21516 EAPI Elm_Fileselector_Mode elm_fileselector_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21523 * @defgroup Progressbar Progress bar
21525 * The progress bar is a widget for visually representing the
21526 * progress status of a given job/task.
21528 * A progress bar may be horizontal or vertical. It may display an
21529 * icon besides it, as well as primary and @b units labels. The
21530 * former is meant to label the widget as a whole, while the
21531 * latter, which is formatted with floating point values (and thus
21532 * accepts a <c>printf</c>-style format string, like <c>"%1.2f
21533 * units"</c>), is meant to label the widget's <b>progress
21534 * value</b>. Label, icon and unit strings/objects are @b optional
21535 * for progress bars.
21537 * A progress bar may be @b inverted, in which state it gets its
21538 * values inverted, with high values being on the left or top and
21539 * low values on the right or bottom, as opposed to normally have
21540 * the low values on the former and high values on the latter,
21541 * respectively, for horizontal and vertical modes.
21543 * The @b span of the progress, as set by
21544 * elm_progressbar_span_size_set(), is its length (horizontally or
21545 * vertically), unless one puts size hints on the widget to expand
21546 * on desired directions, by any container. That length will be
21547 * scaled by the object or applications scaling factor. At any
21548 * point code can query the progress bar for its value with
21549 * elm_progressbar_value_get().
21551 * Available widget styles for progress bars:
21553 * - @c "wheel" (simple style, no text, no progression, only
21554 * "pulse" effect is available)
21556 * Default contents parts of the progressbar widget that you can use for are:
21557 * @li "icon" - An icon of the progressbar
21559 * Here is an example on its usage:
21560 * @li @ref progressbar_example
21564 * Add a new progress bar widget to the given parent Elementary
21565 * (container) object
21567 * @param parent The parent object
21568 * @return a new progress bar widget handle or @c NULL, on errors
21570 * This function inserts a new progress bar widget on the canvas.
21572 * @ingroup Progressbar
21574 EAPI Evas_Object *elm_progressbar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21577 * Set whether a given progress bar widget is at "pulsing mode" or
21580 * @param obj The progress bar object
21581 * @param pulse @c EINA_TRUE to put @p obj in pulsing mode,
21582 * @c EINA_FALSE to put it back to its default one
21584 * By default, progress bars will display values from the low to
21585 * high value boundaries. There are, though, contexts in which the
21586 * state of progression of a given task is @b unknown. For those,
21587 * one can set a progress bar widget to a "pulsing state", to give
21588 * the user an idea that some computation is being held, but
21589 * without exact progress values. In the default theme it will
21590 * animate its bar with the contents filling in constantly and back
21591 * to non-filled, in a loop. To start and stop this pulsing
21592 * animation, one has to explicitly call elm_progressbar_pulse().
21594 * @see elm_progressbar_pulse_get()
21595 * @see elm_progressbar_pulse()
21597 * @ingroup Progressbar
21599 EAPI void elm_progressbar_pulse_set(Evas_Object *obj, Eina_Bool pulse) EINA_ARG_NONNULL(1);
21602 * Get whether a given progress bar widget is at "pulsing mode" or
21605 * @param obj The progress bar object
21606 * @return @c EINA_TRUE, if @p obj is in pulsing mode, @c EINA_FALSE
21607 * if it's in the default one (and on errors)
21609 * @ingroup Progressbar
21611 EAPI Eina_Bool elm_progressbar_pulse_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21614 * Start/stop a given progress bar "pulsing" animation, if its
21617 * @param obj The progress bar object
21618 * @param state @c EINA_TRUE, to @b start the pulsing animation,
21619 * @c EINA_FALSE to @b stop it
21621 * @note This call won't do anything if @p obj is not under "pulsing mode".
21623 * @see elm_progressbar_pulse_set() for more details.
21625 * @ingroup Progressbar
21627 EAPI void elm_progressbar_pulse(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
21630 * Set the progress value (in percentage) on a given progress bar
21633 * @param obj The progress bar object
21634 * @param val The progress value (@b must be between @c 0.0 and @c
21637 * Use this call to set progress bar levels.
21639 * @note If you passes a value out of the specified range for @p
21640 * val, it will be interpreted as the @b closest of the @b boundary
21641 * values in the range.
21643 * @ingroup Progressbar
21645 EAPI void elm_progressbar_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
21648 * Get the progress value (in percentage) on a given progress bar
21651 * @param obj The progress bar object
21652 * @return The value of the progressbar
21654 * @see elm_progressbar_value_set() for more details
21656 * @ingroup Progressbar
21658 EAPI double elm_progressbar_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21661 * Set the label of a given progress bar widget
21663 * @param obj The progress bar object
21664 * @param label The text label string, in UTF-8
21666 * @ingroup Progressbar
21667 * @deprecated use elm_object_text_set() instead.
21669 EINA_DEPRECATED EAPI void elm_progressbar_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
21672 * Get the label of a given progress bar widget
21674 * @param obj The progressbar object
21675 * @return The text label string, in UTF-8
21677 * @ingroup Progressbar
21678 * @deprecated use elm_object_text_set() instead.
21680 EINA_DEPRECATED EAPI const char *elm_progressbar_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21683 * Set the icon object of a given progress bar widget
21685 * @param obj The progress bar object
21686 * @param icon The icon object
21688 * Use this call to decorate @p obj with an icon next to it.
21690 * @note Once the icon object is set, a previously set one will be
21691 * deleted. If you want to keep that old content object, use the
21692 * elm_progressbar_icon_unset() function.
21694 * @see elm_progressbar_icon_get()
21695 * @deprecated use elm_object_part_content_set() instead.
21697 * @ingroup Progressbar
21699 EINA_DEPRECATED EAPI void elm_progressbar_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
21702 * Retrieve the icon object set for a given progress bar widget
21704 * @param obj The progress bar object
21705 * @return The icon object's handle, if @p obj had one set, or @c NULL,
21706 * otherwise (and on errors)
21708 * @see elm_progressbar_icon_set() for more details
21709 * @deprecated use elm_object_part_content_get() instead.
21711 * @ingroup Progressbar
21713 EINA_DEPRECATED EAPI Evas_Object *elm_progressbar_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21716 * Unset an icon set on a given progress bar widget
21718 * @param obj The progress bar object
21719 * @return The icon object that was being used, if any was set, or
21720 * @c NULL, otherwise (and on errors)
21722 * This call will unparent and return the icon object which was set
21723 * for this widget, previously, on success.
21725 * @see elm_progressbar_icon_set() for more details
21726 * @deprecated use elm_object_part_content_unset() instead.
21728 * @ingroup Progressbar
21730 EINA_DEPRECATED EAPI Evas_Object *elm_progressbar_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
21733 * Set the (exact) length of the bar region of a given progress bar
21736 * @param obj The progress bar object
21737 * @param size The length of the progress bar's bar region
21739 * This sets the minimum width (when in horizontal mode) or height
21740 * (when in vertical mode) of the actual bar area of the progress
21741 * bar @p obj. This in turn affects the object's minimum size. Use
21742 * this when you're not setting other size hints expanding on the
21743 * given direction (like weight and alignment hints) and you would
21744 * like it to have a specific size.
21746 * @note Icon, label and unit text around @p obj will require their
21747 * own space, which will make @p obj to require more the @p size,
21750 * @see elm_progressbar_span_size_get()
21752 * @ingroup Progressbar
21754 EAPI void elm_progressbar_span_size_set(Evas_Object *obj, Evas_Coord size) EINA_ARG_NONNULL(1);
21757 * Get the length set for the bar region of a given progress bar
21760 * @param obj The progress bar object
21761 * @return The length of the progress bar's bar region
21763 * If that size was not set previously, with
21764 * elm_progressbar_span_size_set(), this call will return @c 0.
21766 * @ingroup Progressbar
21768 EAPI Evas_Coord elm_progressbar_span_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21771 * Set the format string for a given progress bar widget's units
21774 * @param obj The progress bar object
21775 * @param format The format string for @p obj's units label
21777 * If @c NULL is passed on @p format, it will make @p obj's units
21778 * area to be hidden completely. If not, it'll set the <b>format
21779 * string</b> for the units label's @b text. The units label is
21780 * provided a floating point value, so the units text is up display
21781 * at most one floating point falue. Note that the units label is
21782 * optional. Use a format string such as "%1.2f meters" for
21785 * @note The default format string for a progress bar is an integer
21786 * percentage, as in @c "%.0f %%".
21788 * @see elm_progressbar_unit_format_get()
21790 * @ingroup Progressbar
21792 EAPI void elm_progressbar_unit_format_set(Evas_Object *obj, const char *format) EINA_ARG_NONNULL(1);
21795 * Retrieve the format string set for a given progress bar widget's
21798 * @param obj The progress bar object
21799 * @return The format set string for @p obj's units label or
21800 * @c NULL, if none was set (and on errors)
21802 * @see elm_progressbar_unit_format_set() for more details
21804 * @ingroup Progressbar
21806 EAPI const char *elm_progressbar_unit_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21809 * Set the orientation of a given progress bar widget
21811 * @param obj The progress bar object
21812 * @param horizontal Use @c EINA_TRUE to make @p obj to be
21813 * @b horizontal, @c EINA_FALSE to make it @b vertical
21815 * Use this function to change how your progress bar is to be
21816 * disposed: vertically or horizontally.
21818 * @see elm_progressbar_horizontal_get()
21820 * @ingroup Progressbar
21822 EAPI void elm_progressbar_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
21825 * Retrieve the orientation of a given progress bar widget
21827 * @param obj The progress bar object
21828 * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
21829 * @c EINA_FALSE if it's @b vertical (and on errors)
21831 * @see elm_progressbar_horizontal_set() for more details
21833 * @ingroup Progressbar
21835 EAPI Eina_Bool elm_progressbar_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21838 * Invert a given progress bar widget's displaying values order
21840 * @param obj The progress bar object
21841 * @param inverted Use @c EINA_TRUE to make @p obj inverted,
21842 * @c EINA_FALSE to bring it back to default, non-inverted values.
21844 * A progress bar may be @b inverted, in which state it gets its
21845 * values inverted, with high values being on the left or top and
21846 * low values on the right or bottom, as opposed to normally have
21847 * the low values on the former and high values on the latter,
21848 * respectively, for horizontal and vertical modes.
21850 * @see elm_progressbar_inverted_get()
21852 * @ingroup Progressbar
21854 EAPI void elm_progressbar_inverted_set(Evas_Object *obj, Eina_Bool inverted) EINA_ARG_NONNULL(1);
21857 * Get whether a given progress bar widget's displaying values are
21860 * @param obj The progress bar object
21861 * @return @c EINA_TRUE, if @p obj has inverted values,
21862 * @c EINA_FALSE otherwise (and on errors)
21864 * @see elm_progressbar_inverted_set() for more details
21866 * @ingroup Progressbar
21868 EAPI Eina_Bool elm_progressbar_inverted_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21871 * @defgroup Separator Separator
21873 * @brief Separator is a very thin object used to separate other objects.
21875 * A separator can be vertical or horizontal.
21877 * @ref tutorial_separator is a good example of how to use a separator.
21881 * @brief Add a separator object to @p parent
21883 * @param parent The parent object
21885 * @return The separator object, or NULL upon failure
21887 EAPI Evas_Object *elm_separator_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21889 * @brief Set the horizontal mode of a separator object
21891 * @param obj The separator object
21892 * @param horizontal If true, the separator is horizontal
21894 EAPI void elm_separator_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
21896 * @brief Get the horizontal mode of a separator object
21898 * @param obj The separator object
21899 * @return If true, the separator is horizontal
21901 * @see elm_separator_horizontal_set()
21903 EAPI Eina_Bool elm_separator_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21909 * @defgroup Spinner Spinner
21910 * @ingroup Elementary
21912 * @image html img/widget/spinner/preview-00.png
21913 * @image latex img/widget/spinner/preview-00.eps
21915 * A spinner is a widget which allows the user to increase or decrease
21916 * numeric values using arrow buttons, or edit values directly, clicking
21917 * over it and typing the new value.
21919 * By default the spinner will not wrap and has a label
21920 * of "%.0f" (just showing the integer value of the double).
21922 * A spinner has a label that is formatted with floating
21923 * point values and thus accepts a printf-style format string, like
21924 * ā%1.2f unitsā.
21926 * It also allows specific values to be replaced by pre-defined labels.
21928 * Smart callbacks one can register to:
21930 * - "changed" - Whenever the spinner value is changed.
21931 * - "delay,changed" - A short time after the value is changed by the user.
21932 * This will be called only when the user stops dragging for a very short
21933 * period or when they release their finger/mouse, so it avoids possibly
21934 * expensive reactions to the value change.
21936 * Available styles for it:
21938 * - @c "vertical": up/down buttons at the right side and text left aligned.
21940 * Here is an example on its usage:
21941 * @ref spinner_example
21945 * @addtogroup Spinner
21950 * Add a new spinner widget to the given parent Elementary
21951 * (container) object.
21953 * @param parent The parent object.
21954 * @return a new spinner widget handle or @c NULL, on errors.
21956 * This function inserts a new spinner widget on the canvas.
21961 EAPI Evas_Object *elm_spinner_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21964 * Set the format string of the displayed label.
21966 * @param obj The spinner object.
21967 * @param fmt The format string for the label display.
21969 * If @c NULL, this sets the format to "%.0f". If not it sets the format
21970 * string for the label text. The label text is provided a floating point
21971 * value, so the label text can display up to 1 floating point value.
21972 * Note that this is optional.
21974 * Use a format string such as "%1.2f meters" for example, and it will
21975 * display values like: "3.14 meters" for a value equal to 3.14159.
21977 * Default is "%0.f".
21979 * @see elm_spinner_label_format_get()
21983 EAPI void elm_spinner_label_format_set(Evas_Object *obj, const char *fmt) EINA_ARG_NONNULL(1);
21986 * Get the label format of the spinner.
21988 * @param obj The spinner object.
21989 * @return The text label format string in UTF-8.
21991 * @see elm_spinner_label_format_set() for details.
21995 EAPI const char *elm_spinner_label_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21998 * Set the minimum and maximum values for the spinner.
22000 * @param obj The spinner object.
22001 * @param min The minimum value.
22002 * @param max The maximum value.
22004 * Define the allowed range of values to be selected by the user.
22006 * If actual value is less than @p min, it will be updated to @p min. If it
22007 * is bigger then @p max, will be updated to @p max. Actual value can be
22008 * get with elm_spinner_value_get().
22010 * By default, min is equal to 0, and max is equal to 100.
22012 * @warning Maximum must be greater than minimum.
22014 * @see elm_spinner_min_max_get()
22018 EAPI void elm_spinner_min_max_set(Evas_Object *obj, double min, double max) EINA_ARG_NONNULL(1);
22021 * Get the minimum and maximum values of the spinner.
22023 * @param obj The spinner object.
22024 * @param min Pointer where to store the minimum value.
22025 * @param max Pointer where to store the maximum value.
22027 * @note If only one value is needed, the other pointer can be passed
22030 * @see elm_spinner_min_max_set() for details.
22034 EAPI void elm_spinner_min_max_get(const Evas_Object *obj, double *min, double *max) EINA_ARG_NONNULL(1);
22037 * Set the step used to increment or decrement the spinner value.
22039 * @param obj The spinner object.
22040 * @param step The step value.
22042 * This value will be incremented or decremented to the displayed value.
22043 * It will be incremented while the user keep right or top arrow pressed,
22044 * and will be decremented while the user keep left or bottom arrow pressed.
22046 * The interval to increment / decrement can be set with
22047 * elm_spinner_interval_set().
22049 * By default step value is equal to 1.
22051 * @see elm_spinner_step_get()
22055 EAPI void elm_spinner_step_set(Evas_Object *obj, double step) EINA_ARG_NONNULL(1);
22058 * Get the step used to increment or decrement the spinner value.
22060 * @param obj The spinner object.
22061 * @return The step value.
22063 * @see elm_spinner_step_get() for more details.
22067 EAPI double elm_spinner_step_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22070 * Set the value the spinner displays.
22072 * @param obj The spinner object.
22073 * @param val The value to be displayed.
22075 * Value will be presented on the label following format specified with
22076 * elm_spinner_format_set().
22078 * @warning The value must to be between min and max values. This values
22079 * are set by elm_spinner_min_max_set().
22081 * @see elm_spinner_value_get().
22082 * @see elm_spinner_format_set().
22083 * @see elm_spinner_min_max_set().
22087 EAPI void elm_spinner_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
22090 * Get the value displayed by the spinner.
22092 * @param obj The spinner object.
22093 * @return The value displayed.
22095 * @see elm_spinner_value_set() for details.
22099 EAPI double elm_spinner_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22102 * Set whether the spinner should wrap when it reaches its
22103 * minimum or maximum value.
22105 * @param obj The spinner object.
22106 * @param wrap @c EINA_TRUE to enable wrap or @c EINA_FALSE to
22109 * Disabled by default. If disabled, when the user tries to increment the
22111 * but displayed value plus step value is bigger than maximum value,
22113 * won't allow it. The same happens when the user tries to decrement it,
22114 * but the value less step is less than minimum value.
22116 * When wrap is enabled, in such situations it will allow these changes,
22117 * but will get the value that would be less than minimum and subtracts
22118 * from maximum. Or add the value that would be more than maximum to
22122 * @li min value = 10
22123 * @li max value = 50
22124 * @li step value = 20
22125 * @li displayed value = 20
22127 * When the user decrement value (using left or bottom arrow), it will
22128 * displays @c 40, because max - (min - (displayed - step)) is
22129 * @c 50 - (@c 10 - (@c 20 - @c 20)) = @c 40.
22131 * @see elm_spinner_wrap_get().
22135 EAPI void elm_spinner_wrap_set(Evas_Object *obj, Eina_Bool wrap) EINA_ARG_NONNULL(1);
22138 * Get whether the spinner should wrap when it reaches its
22139 * minimum or maximum value.
22141 * @param obj The spinner object
22142 * @return @c EINA_TRUE means wrap is enabled. @c EINA_FALSE indicates
22143 * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
22145 * @see elm_spinner_wrap_set() for details.
22149 EAPI Eina_Bool elm_spinner_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22152 * Set whether the spinner can be directly edited by the user or not.
22154 * @param obj The spinner object.
22155 * @param editable @c EINA_TRUE to allow users to edit it or @c EINA_FALSE to
22156 * don't allow users to edit it directly.
22158 * Spinner objects can have edition @b disabled, in which state they will
22159 * be changed only by arrows.
22160 * Useful for contexts
22161 * where you don't want your users to interact with it writting the value.
22163 * when using special values, the user can see real value instead
22164 * of special label on edition.
22166 * It's enabled by default.
22168 * @see elm_spinner_editable_get()
22172 EAPI void elm_spinner_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
22175 * Get whether the spinner can be directly edited by the user or not.
22177 * @param obj The spinner object.
22178 * @return @c EINA_TRUE means edition is enabled. @c EINA_FALSE indicates
22179 * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
22181 * @see elm_spinner_editable_set() for details.
22185 EAPI Eina_Bool elm_spinner_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22188 * Set a special string to display in the place of the numerical value.
22190 * @param obj The spinner object.
22191 * @param value The value to be replaced.
22192 * @param label The label to be used.
22194 * It's useful for cases when a user should select an item that is
22195 * better indicated by a label than a value. For example, weekdays or months.
22199 * sp = elm_spinner_add(win);
22200 * elm_spinner_min_max_set(sp, 1, 3);
22201 * elm_spinner_special_value_add(sp, 1, "January");
22202 * elm_spinner_special_value_add(sp, 2, "February");
22203 * elm_spinner_special_value_add(sp, 3, "March");
22204 * evas_object_show(sp);
22209 EAPI void elm_spinner_special_value_add(Evas_Object *obj, double value, const char *label) EINA_ARG_NONNULL(1);
22212 * Set the interval on time updates for an user mouse button hold
22213 * on spinner widgets' arrows.
22215 * @param obj The spinner object.
22216 * @param interval The (first) interval value in seconds.
22218 * This interval value is @b decreased while the user holds the
22219 * mouse pointer either incrementing or decrementing spinner's value.
22221 * This helps the user to get to a given value distant from the
22222 * current one easier/faster, as it will start to change quicker and
22223 * quicker on mouse button holds.
22225 * The calculation for the next change interval value, starting from
22226 * the one set with this call, is the previous interval divided by
22227 * @c 1.05, so it decreases a little bit.
22229 * The default starting interval value for automatic changes is
22232 * @see elm_spinner_interval_get()
22236 EAPI void elm_spinner_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
22239 * Get the interval on time updates for an user mouse button hold
22240 * on spinner widgets' arrows.
22242 * @param obj The spinner object.
22243 * @return The (first) interval value, in seconds, set on it.
22245 * @see elm_spinner_interval_set() for more details.
22249 EAPI double elm_spinner_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22256 * @defgroup Index Index
22258 * @image html img/widget/index/preview-00.png
22259 * @image latex img/widget/index/preview-00.eps
22261 * An index widget gives you an index for fast access to whichever
22262 * group of other UI items one might have. It's a list of text
22263 * items (usually letters, for alphabetically ordered access).
22265 * Index widgets are by default hidden and just appear when the
22266 * user clicks over it's reserved area in the canvas. In its
22267 * default theme, it's an area one @ref Fingers "finger" wide on
22268 * the right side of the index widget's container.
22270 * When items on the index are selected, smart callbacks get
22271 * called, so that its user can make other container objects to
22272 * show a given area or child object depending on the index item
22273 * selected. You'd probably be using an index together with @ref
22274 * List "lists", @ref Genlist "generic lists" or @ref Gengrid
22277 * Smart events one can add callbacks for are:
22278 * - @c "changed" - When the selected index item changes. @c
22279 * event_info is the selected item's data pointer.
22280 * - @c "delay,changed" - When the selected index item changes, but
22281 * after a small idling period. @c event_info is the selected
22282 * item's data pointer.
22283 * - @c "selected" - When the user releases a mouse button and
22284 * selects an item. @c event_info is the selected item's data
22286 * - @c "level,up" - when the user moves a finger from the first
22287 * level to the second level
22288 * - @c "level,down" - when the user moves a finger from the second
22289 * level to the first level
22291 * The @c "delay,changed" event is so that it'll wait a small time
22292 * before actually reporting those events and, moreover, just the
22293 * last event happening on those time frames will actually be
22296 * Here are some examples on its usage:
22297 * @li @ref index_example_01
22298 * @li @ref index_example_02
22302 * @addtogroup Index
22306 typedef struct _Elm_Index_Item Elm_Index_Item; /**< Opaque handle for items of Elementary index widgets */
22309 * Add a new index widget to the given parent Elementary
22310 * (container) object
22312 * @param parent The parent object
22313 * @return a new index widget handle or @c NULL, on errors
22315 * This function inserts a new index widget on the canvas.
22319 EAPI Evas_Object *elm_index_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22322 * Set whether a given index widget is or not visible,
22325 * @param obj The index object
22326 * @param active @c EINA_TRUE to show it, @c EINA_FALSE to hide it
22328 * Not to be confused with visible as in @c evas_object_show() --
22329 * visible with regard to the widget's auto hiding feature.
22331 * @see elm_index_active_get()
22335 EAPI void elm_index_active_set(Evas_Object *obj, Eina_Bool active) EINA_ARG_NONNULL(1);
22338 * Get whether a given index widget is currently visible or not.
22340 * @param obj The index object
22341 * @return @c EINA_TRUE, if it's shown, @c EINA_FALSE otherwise
22343 * @see elm_index_active_set() for more details
22347 EAPI Eina_Bool elm_index_active_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22350 * Set the items level for a given index widget.
22352 * @param obj The index object.
22353 * @param level @c 0 or @c 1, the currently implemented levels.
22355 * @see elm_index_item_level_get()
22359 EAPI void elm_index_item_level_set(Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
22362 * Get the items level set for a given index widget.
22364 * @param obj The index object.
22365 * @return @c 0 or @c 1, which are the levels @p obj might be at.
22367 * @see elm_index_item_level_set() for more information
22371 EAPI int elm_index_item_level_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22374 * Returns the last selected item's data, for a given index widget.
22376 * @param obj The index object.
22377 * @return The item @b data associated to the last selected item on
22378 * @p obj (or @c NULL, on errors).
22380 * @warning The returned value is @b not an #Elm_Index_Item item
22381 * handle, but the data associated to it (see the @c item parameter
22382 * in elm_index_item_append(), as an example).
22386 EAPI void *elm_index_item_selected_get(const Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
22389 * Append a new item on a given index widget.
22391 * @param obj The index object.
22392 * @param letter Letter under which the item should be indexed
22393 * @param item The item data to set for the index's item
22395 * Despite the most common usage of the @p letter argument is for
22396 * single char strings, one could use arbitrary strings as index
22399 * @c item will be the pointer returned back on @c "changed", @c
22400 * "delay,changed" and @c "selected" smart events.
22404 EAPI void elm_index_item_append(Evas_Object *obj, const char *letter, const void *item) EINA_ARG_NONNULL(1);
22407 * Prepend a new item on a given index widget.
22409 * @param obj The index object.
22410 * @param letter Letter under which the item should be indexed
22411 * @param item The item data to set for the index's item
22413 * Despite the most common usage of the @p letter argument is for
22414 * single char strings, one could use arbitrary strings as index
22417 * @c item will be the pointer returned back on @c "changed", @c
22418 * "delay,changed" and @c "selected" smart events.
22422 EAPI void elm_index_item_prepend(Evas_Object *obj, const char *letter, const void *item) EINA_ARG_NONNULL(1);
22425 * Append a new item, on a given index widget, <b>after the item
22426 * having @p relative as data</b>.
22428 * @param obj The index object.
22429 * @param letter Letter under which the item should be indexed
22430 * @param item The item data to set for the index's item
22431 * @param relative The item data of the index item to be the
22432 * predecessor of this new one
22434 * Despite the most common usage of the @p letter argument is for
22435 * single char strings, one could use arbitrary strings as index
22438 * @c item will be the pointer returned back on @c "changed", @c
22439 * "delay,changed" and @c "selected" smart events.
22441 * @note If @p relative is @c NULL or if it's not found to be data
22442 * set on any previous item on @p obj, this function will behave as
22443 * elm_index_item_append().
22447 EAPI void elm_index_item_append_relative(Evas_Object *obj, const char *letter, const void *item, const void *relative) EINA_ARG_NONNULL(1);
22450 * Prepend a new item, on a given index widget, <b>after the item
22451 * having @p relative as data</b>.
22453 * @param obj The index object.
22454 * @param letter Letter under which the item should be indexed
22455 * @param item The item data to set for the index's item
22456 * @param relative The item data of the index item to be the
22457 * successor of this new one
22459 * Despite the most common usage of the @p letter argument is for
22460 * single char strings, one could use arbitrary strings as index
22463 * @c item will be the pointer returned back on @c "changed", @c
22464 * "delay,changed" and @c "selected" smart events.
22466 * @note If @p relative is @c NULL or if it's not found to be data
22467 * set on any previous item on @p obj, this function will behave as
22468 * elm_index_item_prepend().
22472 EAPI void elm_index_item_prepend_relative(Evas_Object *obj, const char *letter, const void *item, const void *relative) EINA_ARG_NONNULL(1);
22475 * Insert a new item into the given index widget, using @p cmp_func
22476 * function to sort items (by item handles).
22478 * @param obj The index object.
22479 * @param letter Letter under which the item should be indexed
22480 * @param item The item data to set for the index's item
22481 * @param cmp_func The comparing function to be used to sort index
22482 * items <b>by #Elm_Index_Item item handles</b>
22483 * @param cmp_data_func A @b fallback function to be called for the
22484 * sorting of index items <b>by item data</b>). It will be used
22485 * when @p cmp_func returns @c 0 (equality), which means an index
22486 * item with provided item data already exists. To decide which
22487 * data item should be pointed to by the index item in question, @p
22488 * cmp_data_func will be used. If @p cmp_data_func returns a
22489 * non-negative value, the previous index item data will be
22490 * replaced by the given @p item pointer. If the previous data need
22491 * to be freed, it should be done by the @p cmp_data_func function,
22492 * because all references to it will be lost. If this function is
22493 * not provided (@c NULL is given), index items will be @b
22494 * duplicated, if @p cmp_func returns @c 0.
22496 * Despite the most common usage of the @p letter argument is for
22497 * single char strings, one could use arbitrary strings as index
22500 * @c item will be the pointer returned back on @c "changed", @c
22501 * "delay,changed" and @c "selected" smart events.
22505 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);
22508 * Remove an item from a given index widget, <b>to be referenced by
22509 * it's data value</b>.
22511 * @param obj The index object
22512 * @param item The item's data pointer for the item to be removed
22515 * If a deletion callback is set, via elm_index_item_del_cb_set(),
22516 * that callback function will be called by this one.
22518 * @warning The item to be removed from @p obj will be found via
22519 * its item data pointer, and not by an #Elm_Index_Item handle.
22523 EAPI void elm_index_item_del(Evas_Object *obj, const void *item) EINA_ARG_NONNULL(1);
22526 * Find a given index widget's item, <b>using item data</b>.
22528 * @param obj The index object
22529 * @param item The item data pointed to by the desired index item
22530 * @return The index item handle, if found, or @c NULL otherwise
22534 EAPI Elm_Index_Item *elm_index_item_find(Evas_Object *obj, const void *item) EINA_ARG_NONNULL(1);
22537 * Removes @b all items from a given index widget.
22539 * @param obj The index object.
22541 * If deletion callbacks are set, via elm_index_item_del_cb_set(),
22542 * that callback function will be called for each item in @p obj.
22546 EAPI void elm_index_item_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
22549 * Go to a given items level on a index widget
22551 * @param obj The index object
22552 * @param level The index level (one of @c 0 or @c 1)
22556 EAPI void elm_index_item_go(Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
22559 * Return the data associated with a given index widget item
22561 * @param it The index widget item handle
22562 * @return The data associated with @p it
22564 * @see elm_index_item_data_set()
22568 EAPI void *elm_index_item_data_get(const Elm_Index_Item *item) EINA_ARG_NONNULL(1);
22571 * Set the data associated with a given index widget item
22573 * @param it The index widget item handle
22574 * @param data The new data pointer to set to @p it
22576 * This sets new item data on @p it.
22578 * @warning The old data pointer won't be touched by this function, so
22579 * the user had better to free that old data himself/herself.
22583 EAPI void elm_index_item_data_set(Elm_Index_Item *it, const void *data) EINA_ARG_NONNULL(1);
22586 * Set the function to be called when a given index widget item is freed.
22588 * @param it The item to set the callback on
22589 * @param func The function to call on the item's deletion
22591 * When called, @p func will have both @c data and @c event_info
22592 * arguments with the @p it item's data value and, naturally, the
22593 * @c obj argument with a handle to the parent index widget.
22597 EAPI void elm_index_item_del_cb_set(Elm_Index_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
22600 * Get the letter (string) set on a given index widget item.
22602 * @param it The index item handle
22603 * @return The letter string set on @p it
22607 EAPI const char *elm_index_item_letter_get(const Elm_Index_Item *item) EINA_ARG_NONNULL(1);
22614 * @defgroup Photocam Photocam
22616 * @image html img/widget/photocam/preview-00.png
22617 * @image latex img/widget/photocam/preview-00.eps
22619 * This is a widget specifically for displaying high-resolution digital
22620 * camera photos giving speedy feedback (fast load), low memory footprint
22621 * and zooming and panning as well as fitting logic. It is entirely focused
22622 * on jpeg images, and takes advantage of properties of the jpeg format (via
22623 * evas loader features in the jpeg loader).
22625 * Signals that you can add callbacks for are:
22626 * @li "clicked" - This is called when a user has clicked the photo without
22628 * @li "press" - This is called when a user has pressed down on the photo.
22629 * @li "longpressed" - This is called when a user has pressed down on the
22630 * photo for a long time without dragging around.
22631 * @li "clicked,double" - This is called when a user has double-clicked the
22633 * @li "load" - Photo load begins.
22634 * @li "loaded" - This is called when the image file load is complete for the
22635 * first view (low resolution blurry version).
22636 * @li "load,detail" - Photo detailed data load begins.
22637 * @li "loaded,detail" - This is called when the image file load is complete
22638 * for the detailed image data (full resolution needed).
22639 * @li "zoom,start" - Zoom animation started.
22640 * @li "zoom,stop" - Zoom animation stopped.
22641 * @li "zoom,change" - Zoom changed when using an auto zoom mode.
22642 * @li "scroll" - the content has been scrolled (moved)
22643 * @li "scroll,anim,start" - scrolling animation has started
22644 * @li "scroll,anim,stop" - scrolling animation has stopped
22645 * @li "scroll,drag,start" - dragging the contents around has started
22646 * @li "scroll,drag,stop" - dragging the contents around has stopped
22648 * @ref tutorial_photocam shows the API in action.
22652 * @brief Types of zoom available.
22654 typedef enum _Elm_Photocam_Zoom_Mode
22656 ELM_PHOTOCAM_ZOOM_MODE_MANUAL = 0, /**< Zoom controlled normally by elm_photocam_zoom_set */
22657 ELM_PHOTOCAM_ZOOM_MODE_AUTO_FIT, /**< Zoom until photo fits in photocam */
22658 ELM_PHOTOCAM_ZOOM_MODE_AUTO_FILL, /**< Zoom until photo fills photocam */
22659 ELM_PHOTOCAM_ZOOM_MODE_LAST
22660 } Elm_Photocam_Zoom_Mode;
22662 * @brief Add a new Photocam object
22664 * @param parent The parent object
22665 * @return The new object or NULL if it cannot be created
22667 EAPI Evas_Object *elm_photocam_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22669 * @brief Set the photo file to be shown
22671 * @param obj The photocam object
22672 * @param file The photo file
22673 * @return The return error (see EVAS_LOAD_ERROR_NONE, EVAS_LOAD_ERROR_GENERIC etc.)
22675 * This sets (and shows) the specified file (with a relative or absolute
22676 * path) and will return a load error (same error that
22677 * evas_object_image_load_error_get() will return). The image will change and
22678 * adjust its size at this point and begin a background load process for this
22679 * photo that at some time in the future will be displayed at the full
22682 EAPI Evas_Load_Error elm_photocam_file_set(Evas_Object *obj, const char *file) EINA_ARG_NONNULL(1);
22684 * @brief Returns the path of the current image file
22686 * @param obj The photocam object
22687 * @return Returns the path
22689 * @see elm_photocam_file_set()
22691 EAPI const char *elm_photocam_file_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22693 * @brief Set the zoom level of the photo
22695 * @param obj The photocam object
22696 * @param zoom The zoom level to set
22698 * This sets the zoom level. 1 will be 1:1 pixel for pixel. 2 will be 2:1
22699 * (that is 2x2 photo pixels will display as 1 on-screen pixel). 4:1 will be
22700 * 4x4 photo pixels as 1 screen pixel, and so on. The @p zoom parameter must
22701 * be greater than 0. It is usggested to stick to powers of 2. (1, 2, 4, 8,
22704 EAPI void elm_photocam_zoom_set(Evas_Object *obj, double zoom) EINA_ARG_NONNULL(1);
22706 * @brief Get the zoom level of the photo
22708 * @param obj The photocam object
22709 * @return The current zoom level
22711 * This returns the current zoom level of the photocam object. Note that if
22712 * you set the fill mode to other than ELM_PHOTOCAM_ZOOM_MODE_MANUAL
22713 * (which is the default), the zoom level may be changed at any time by the
22714 * photocam object itself to account for photo size and photocam viewpoer
22717 * @see elm_photocam_zoom_set()
22718 * @see elm_photocam_zoom_mode_set()
22720 EAPI double elm_photocam_zoom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22722 * @brief Set the zoom mode
22724 * @param obj The photocam object
22725 * @param mode The desired mode
22727 * This sets the zoom mode to manual or one of several automatic levels.
22728 * Manual (ELM_PHOTOCAM_ZOOM_MODE_MANUAL) means that zoom is set manually by
22729 * elm_photocam_zoom_set() and will stay at that level until changed by code
22730 * or until zoom mode is changed. This is the default mode. The Automatic
22731 * modes will allow the photocam object to automatically adjust zoom mode
22732 * based on properties. ELM_PHOTOCAM_ZOOM_MODE_AUTO_FIT) will adjust zoom so
22733 * the photo fits EXACTLY inside the scroll frame with no pixels outside this
22734 * area. ELM_PHOTOCAM_ZOOM_MODE_AUTO_FILL will be similar but ensure no
22735 * pixels within the frame are left unfilled.
22737 EAPI void elm_photocam_zoom_mode_set(Evas_Object *obj, Elm_Photocam_Zoom_Mode mode) EINA_ARG_NONNULL(1);
22739 * @brief Get the zoom mode
22741 * @param obj The photocam object
22742 * @return The current zoom mode
22744 * This gets the current zoom mode of the photocam object.
22746 * @see elm_photocam_zoom_mode_set()
22748 EAPI Elm_Photocam_Zoom_Mode elm_photocam_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22750 * @brief Get the current image pixel width and height
22752 * @param obj The photocam object
22753 * @param w A pointer to the width return
22754 * @param h A pointer to the height return
22756 * This gets the current photo pixel width and height (for the original).
22757 * The size will be returned in the integers @p w and @p h that are pointed
22760 EAPI void elm_photocam_image_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
22762 * @brief Get the area of the image that is currently shown
22765 * @param x A pointer to the X-coordinate of region
22766 * @param y A pointer to the Y-coordinate of region
22767 * @param w A pointer to the width
22768 * @param h A pointer to the height
22770 * @see elm_photocam_image_region_show()
22771 * @see elm_photocam_image_region_bring_in()
22773 EAPI void elm_photocam_region_get(const Evas_Object *obj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
22775 * @brief Set the viewed portion of the image
22777 * @param obj The photocam object
22778 * @param x X-coordinate of region in image original pixels
22779 * @param y Y-coordinate of region in image original pixels
22780 * @param w Width of region in image original pixels
22781 * @param h Height of region in image original pixels
22783 * This shows the region of the image without using animation.
22785 EAPI void elm_photocam_image_region_show(Evas_Object *obj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
22787 * @brief Bring in the viewed portion of the image
22789 * @param obj The photocam object
22790 * @param x X-coordinate of region in image original pixels
22791 * @param y Y-coordinate of region in image original pixels
22792 * @param w Width of region in image original pixels
22793 * @param h Height of region in image original pixels
22795 * This shows the region of the image using animation.
22797 EAPI void elm_photocam_image_region_bring_in(Evas_Object *obj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
22799 * @brief Set the paused state for photocam
22801 * @param obj The photocam object
22802 * @param paused The pause state to set
22804 * This sets the paused state to on(EINA_TRUE) or off (EINA_FALSE) for
22805 * photocam. The default is off. This will stop zooming using animation on
22806 * zoom levels changes and change instantly. This will stop any existing
22807 * animations that are running.
22809 EAPI void elm_photocam_paused_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
22811 * @brief Get the paused state for photocam
22813 * @param obj The photocam object
22814 * @return The current paused state
22816 * This gets the current paused state for the photocam object.
22818 * @see elm_photocam_paused_set()
22820 EAPI Eina_Bool elm_photocam_paused_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22822 * @brief Get the internal low-res image used for photocam
22824 * @param obj The photocam object
22825 * @return The internal image object handle, or NULL if none exists
22827 * This gets the internal image object inside photocam. Do not modify it. It
22828 * is for inspection only, and hooking callbacks to. Nothing else. It may be
22829 * deleted at any time as well.
22831 EAPI Evas_Object *elm_photocam_internal_image_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22833 * @brief Set the photocam scrolling bouncing.
22835 * @param obj The photocam object
22836 * @param h_bounce bouncing for horizontal
22837 * @param v_bounce bouncing for vertical
22839 EAPI void elm_photocam_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
22841 * @brief Get the photocam scrolling bouncing.
22843 * @param obj The photocam object
22844 * @param h_bounce bouncing for horizontal
22845 * @param v_bounce bouncing for vertical
22847 * @see elm_photocam_bounce_set()
22849 EAPI void elm_photocam_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
22855 * @defgroup Map Map
22856 * @ingroup Elementary
22858 * @image html img/widget/map/preview-00.png
22859 * @image latex img/widget/map/preview-00.eps
22861 * This is a widget specifically for displaying a map. It uses basically
22862 * OpenStreetMap provider http://www.openstreetmap.org/,
22863 * but custom providers can be added.
22865 * It supports some basic but yet nice features:
22866 * @li zoom and scroll
22867 * @li markers with content to be displayed when user clicks over it
22868 * @li group of markers
22871 * Smart callbacks one can listen to:
22873 * - "clicked" - This is called when a user has clicked the map without
22875 * - "press" - This is called when a user has pressed down on the map.
22876 * - "longpressed" - This is called when a user has pressed down on the map
22877 * for a long time without dragging around.
22878 * - "clicked,double" - This is called when a user has double-clicked
22880 * - "load,detail" - Map detailed data load begins.
22881 * - "loaded,detail" - This is called when all currently visible parts of
22882 * the map are loaded.
22883 * - "zoom,start" - Zoom animation started.
22884 * - "zoom,stop" - Zoom animation stopped.
22885 * - "zoom,change" - Zoom changed when using an auto zoom mode.
22886 * - "scroll" - the content has been scrolled (moved).
22887 * - "scroll,anim,start" - scrolling animation has started.
22888 * - "scroll,anim,stop" - scrolling animation has stopped.
22889 * - "scroll,drag,start" - dragging the contents around has started.
22890 * - "scroll,drag,stop" - dragging the contents around has stopped.
22891 * - "downloaded" - This is called when all currently required map images
22893 * - "route,load" - This is called when route request begins.
22894 * - "route,loaded" - This is called when route request ends.
22895 * - "name,load" - This is called when name request begins.
22896 * - "name,loaded- This is called when name request ends.
22898 * Available style for map widget:
22901 * Available style for markers:
22906 * Available style for marker bubble:
22909 * List of examples:
22910 * @li @ref map_example_01
22911 * @li @ref map_example_02
22912 * @li @ref map_example_03
22921 * @enum _Elm_Map_Zoom_Mode
22922 * @typedef Elm_Map_Zoom_Mode
22924 * Set map's zoom behavior. It can be set to manual or automatic.
22926 * Default value is #ELM_MAP_ZOOM_MODE_MANUAL.
22928 * Values <b> don't </b> work as bitmask, only one can be choosen.
22930 * @note Valid sizes are 2^zoom, consequently the map may be smaller
22931 * than the scroller view.
22933 * @see elm_map_zoom_mode_set()
22934 * @see elm_map_zoom_mode_get()
22938 typedef enum _Elm_Map_Zoom_Mode
22940 ELM_MAP_ZOOM_MODE_MANUAL, /**< Zoom controlled manually by elm_map_zoom_set(). It's set by default. */
22941 ELM_MAP_ZOOM_MODE_AUTO_FIT, /**< Zoom until map fits inside the scroll frame with no pixels outside this area. */
22942 ELM_MAP_ZOOM_MODE_AUTO_FILL, /**< Zoom until map fills scroll, ensuring no pixels are left unfilled. */
22943 ELM_MAP_ZOOM_MODE_LAST
22944 } Elm_Map_Zoom_Mode;
22947 * @enum _Elm_Map_Route_Sources
22948 * @typedef Elm_Map_Route_Sources
22950 * Set route service to be used. By default used source is
22951 * #ELM_MAP_ROUTE_SOURCE_YOURS.
22953 * @see elm_map_route_source_set()
22954 * @see elm_map_route_source_get()
22958 typedef enum _Elm_Map_Route_Sources
22960 ELM_MAP_ROUTE_SOURCE_YOURS, /**< Routing service http://www.yournavigation.org/ . Set by default.*/
22961 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. */
22962 ELM_MAP_ROUTE_SOURCE_ORS, /**< Open Route Service: http://www.openrouteservice.org/ . It's not working with Map yet. */
22963 ELM_MAP_ROUTE_SOURCE_LAST
22964 } Elm_Map_Route_Sources;
22966 typedef enum _Elm_Map_Name_Sources
22968 ELM_MAP_NAME_SOURCE_NOMINATIM,
22969 ELM_MAP_NAME_SOURCE_LAST
22970 } Elm_Map_Name_Sources;
22973 * @enum _Elm_Map_Route_Type
22974 * @typedef Elm_Map_Route_Type
22976 * Set type of transport used on route.
22978 * @see elm_map_route_add()
22982 typedef enum _Elm_Map_Route_Type
22984 ELM_MAP_ROUTE_TYPE_MOTOCAR, /**< Route should consider an automobile will be used. */
22985 ELM_MAP_ROUTE_TYPE_BICYCLE, /**< Route should consider a bicycle will be used by the user. */
22986 ELM_MAP_ROUTE_TYPE_FOOT, /**< Route should consider user will be walking. */
22987 ELM_MAP_ROUTE_TYPE_LAST
22988 } Elm_Map_Route_Type;
22991 * @enum _Elm_Map_Route_Method
22992 * @typedef Elm_Map_Route_Method
22994 * Set the routing method, what should be priorized, time or distance.
22996 * @see elm_map_route_add()
23000 typedef enum _Elm_Map_Route_Method
23002 ELM_MAP_ROUTE_METHOD_FASTEST, /**< Route should priorize time. */
23003 ELM_MAP_ROUTE_METHOD_SHORTEST, /**< Route should priorize distance. */
23004 ELM_MAP_ROUTE_METHOD_LAST
23005 } Elm_Map_Route_Method;
23007 typedef enum _Elm_Map_Name_Method
23009 ELM_MAP_NAME_METHOD_SEARCH,
23010 ELM_MAP_NAME_METHOD_REVERSE,
23011 ELM_MAP_NAME_METHOD_LAST
23012 } Elm_Map_Name_Method;
23014 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(). */
23015 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(). */
23016 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(). */
23017 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(). */
23018 typedef struct _Elm_Map_Name Elm_Map_Name; /**< A handle for specific coordinates. */
23019 typedef struct _Elm_Map_Track Elm_Map_Track;
23021 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. */
23022 typedef void (*ElmMapMarkerDelFunc) (Evas_Object *obj, Elm_Map_Marker *marker, void *data, Evas_Object *o); /**< Function to delete bubble content for marker classes. */
23023 typedef Evas_Object *(*ElmMapMarkerIconGetFunc) (Evas_Object *obj, Elm_Map_Marker *marker, void *data); /**< Icon fetching class function for marker classes. */
23024 typedef Evas_Object *(*ElmMapGroupIconGetFunc) (Evas_Object *obj, void *data); /**< Icon fetching class function for markers group classes. */
23026 typedef char *(*ElmMapModuleSourceFunc) (void);
23027 typedef int (*ElmMapModuleZoomMinFunc) (void);
23028 typedef int (*ElmMapModuleZoomMaxFunc) (void);
23029 typedef char *(*ElmMapModuleUrlFunc) (Evas_Object *obj, int x, int y, int zoom);
23030 typedef int (*ElmMapModuleRouteSourceFunc) (void);
23031 typedef char *(*ElmMapModuleRouteUrlFunc) (Evas_Object *obj, char *type_name, int method, double flon, double flat, double tlon, double tlat);
23032 typedef char *(*ElmMapModuleNameUrlFunc) (Evas_Object *obj, int method, char *name, double lon, double lat);
23033 typedef Eina_Bool (*ElmMapModuleGeoIntoCoordFunc) (const Evas_Object *obj, int zoom, double lon, double lat, int size, int *x, int *y);
23034 typedef Eina_Bool (*ElmMapModuleCoordIntoGeoFunc) (const Evas_Object *obj, int zoom, int x, int y, int size, double *lon, double *lat);
23037 * Add a new map widget to the given parent Elementary (container) object.
23039 * @param parent The parent object.
23040 * @return a new map widget handle or @c NULL, on errors.
23042 * This function inserts a new map widget on the canvas.
23046 EAPI Evas_Object *elm_map_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
23049 * Set the zoom level of the map.
23051 * @param obj The map object.
23052 * @param zoom The zoom level to set.
23054 * This sets the zoom level.
23056 * It will respect limits defined by elm_map_source_zoom_min_set() and
23057 * elm_map_source_zoom_max_set().
23059 * By default these values are 0 (world map) and 18 (maximum zoom).
23061 * This function should be used when zoom mode is set to
23062 * #ELM_MAP_ZOOM_MODE_MANUAL. This is the default mode, and can be set
23063 * with elm_map_zoom_mode_set().
23065 * @see elm_map_zoom_mode_set().
23066 * @see elm_map_zoom_get().
23070 EAPI void elm_map_zoom_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
23073 * Get the zoom level of the map.
23075 * @param obj The map object.
23076 * @return The current zoom level.
23078 * This returns the current zoom level of the map object.
23080 * Note that if you set the fill mode to other than #ELM_MAP_ZOOM_MODE_MANUAL
23081 * (which is the default), the zoom level may be changed at any time by the
23082 * map object itself to account for map size and map viewport size.
23084 * @see elm_map_zoom_set() for details.
23088 EAPI int elm_map_zoom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23091 * Set the zoom mode used by the map object.
23093 * @param obj The map object.
23094 * @param mode The zoom mode of the map, being it one of
23095 * #ELM_MAP_ZOOM_MODE_MANUAL (default), #ELM_MAP_ZOOM_MODE_AUTO_FIT,
23096 * or #ELM_MAP_ZOOM_MODE_AUTO_FILL.
23098 * This sets the zoom mode to manual or one of the automatic levels.
23099 * Manual (#ELM_MAP_ZOOM_MODE_MANUAL) means that zoom is set manually by
23100 * elm_map_zoom_set() and will stay at that level until changed by code
23101 * or until zoom mode is changed. This is the default mode.
23103 * The Automatic modes will allow the map object to automatically
23104 * adjust zoom mode based on properties. #ELM_MAP_ZOOM_MODE_AUTO_FIT will
23105 * adjust zoom so the map fits inside the scroll frame with no pixels
23106 * outside this area. #ELM_MAP_ZOOM_MODE_AUTO_FILL will be similar but
23107 * ensure no pixels within the frame are left unfilled. Do not forget that
23108 * the valid sizes are 2^zoom, consequently the map may be smaller than
23109 * the scroller view.
23111 * @see elm_map_zoom_set()
23115 EAPI void elm_map_zoom_mode_set(Evas_Object *obj, Elm_Map_Zoom_Mode mode) EINA_ARG_NONNULL(1);
23118 * Get the zoom mode used by the map object.
23120 * @param obj The map object.
23121 * @return The zoom mode of the map, being it one of
23122 * #ELM_MAP_ZOOM_MODE_MANUAL (default), #ELM_MAP_ZOOM_MODE_AUTO_FIT,
23123 * or #ELM_MAP_ZOOM_MODE_AUTO_FILL.
23125 * This function returns the current zoom mode used by the map object.
23127 * @see elm_map_zoom_mode_set() for more details.
23131 EAPI Elm_Map_Zoom_Mode elm_map_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23134 * Get the current coordinates of the map.
23136 * @param obj The map object.
23137 * @param lon Pointer where to store longitude.
23138 * @param lat Pointer where to store latitude.
23140 * This gets the current center coordinates of the map object. It can be
23141 * set by elm_map_geo_region_bring_in() and elm_map_geo_region_show().
23143 * @see elm_map_geo_region_bring_in()
23144 * @see elm_map_geo_region_show()
23148 EAPI void elm_map_geo_region_get(const Evas_Object *obj, double *lon, double *lat) EINA_ARG_NONNULL(1);
23151 * Animatedly bring in given coordinates to the center of the map.
23153 * @param obj The map object.
23154 * @param lon Longitude to center at.
23155 * @param lat Latitude to center at.
23157 * This causes map to jump to the given @p lat and @p lon coordinates
23158 * and show it (by scrolling) in the center of the viewport, if it is not
23159 * already centered. This will use animation to do so and take a period
23160 * of time to complete.
23162 * @see elm_map_geo_region_show() for a function to avoid animation.
23163 * @see elm_map_geo_region_get()
23167 EAPI void elm_map_geo_region_bring_in(Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
23170 * Show the given coordinates at the center of the map, @b immediately.
23172 * @param obj The map object.
23173 * @param lon Longitude to center at.
23174 * @param lat Latitude to center at.
23176 * This causes map to @b redraw its viewport's contents to the
23177 * region contining the given @p lat and @p lon, that will be moved to the
23178 * center of the map.
23180 * @see elm_map_geo_region_bring_in() for a function to move with animation.
23181 * @see elm_map_geo_region_get()
23185 EAPI void elm_map_geo_region_show(Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
23188 * Pause or unpause the map.
23190 * @param obj The map object.
23191 * @param paused Use @c EINA_TRUE to pause the map @p obj or @c EINA_FALSE
23194 * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
23197 * The default is off.
23199 * This will stop zooming using animation, changing zoom levels will
23200 * change instantly. This will stop any existing animations that are running.
23202 * @see elm_map_paused_get()
23206 EAPI void elm_map_paused_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
23209 * Get a value whether map is paused or not.
23211 * @param obj The map object.
23212 * @return @c EINA_TRUE means map is pause. @c EINA_FALSE indicates
23213 * it is not. If @p obj is @c NULL, @c EINA_FALSE is returned.
23215 * This gets the current paused state for the map object.
23217 * @see elm_map_paused_set() for details.
23221 EAPI Eina_Bool elm_map_paused_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23224 * Set to show markers during zoom level changes or not.
23226 * @param obj The map object.
23227 * @param paused Use @c EINA_TRUE to @b not show markers or @c EINA_FALSE
23230 * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
23233 * The default is off.
23235 * This will stop zooming using animation, changing zoom levels will
23236 * change instantly. This will stop any existing animations that are running.
23238 * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
23241 * The default is off.
23243 * Enabling it will force the map to stop displaying the markers during
23244 * zoom level changes. Set to on if you have a large number of markers.
23246 * @see elm_map_paused_markers_get()
23250 EAPI void elm_map_paused_markers_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
23253 * Get a value whether markers will be displayed on zoom level changes or not
23255 * @param obj The map object.
23256 * @return @c EINA_TRUE means map @b won't display markers or @c EINA_FALSE
23257 * indicates it will. If @p obj is @c NULL, @c EINA_FALSE is returned.
23259 * This gets the current markers paused state for the map object.
23261 * @see elm_map_paused_markers_set() for details.
23265 EAPI Eina_Bool elm_map_paused_markers_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23268 * Get the information of downloading status.
23270 * @param obj The map object.
23271 * @param try_num Pointer where to store number of tiles being downloaded.
23272 * @param finish_num Pointer where to store number of tiles successfully
23275 * This gets the current downloading status for the map object, the number
23276 * of tiles being downloaded and the number of tiles already downloaded.
23280 EAPI void elm_map_utils_downloading_status_get(const Evas_Object *obj, int *try_num, int *finish_num) EINA_ARG_NONNULL(1, 2, 3);
23283 * Convert a pixel coordinate (x,y) into a geographic coordinate
23284 * (longitude, latitude).
23286 * @param obj The map object.
23287 * @param x the coordinate.
23288 * @param y the coordinate.
23289 * @param size the size in pixels of the map.
23290 * The map is a square and generally his size is : pow(2.0, zoom)*256.
23291 * @param lon Pointer where to store the longitude that correspond to x.
23292 * @param lat Pointer where to store the latitude that correspond to y.
23294 * @note Origin pixel point is the top left corner of the viewport.
23295 * Map zoom and size are taken on account.
23297 * @see elm_map_utils_convert_geo_into_coord() if you need the inverse.
23301 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);
23304 * Convert a geographic coordinate (longitude, latitude) into a pixel
23305 * coordinate (x, y).
23307 * @param obj The map object.
23308 * @param lon the longitude.
23309 * @param lat the latitude.
23310 * @param size the size in pixels of the map. The map is a square
23311 * and generally his size is : pow(2.0, zoom)*256.
23312 * @param x Pointer where to store the horizontal pixel coordinate that
23313 * correspond to the longitude.
23314 * @param y Pointer where to store the vertical pixel coordinate that
23315 * correspond to the latitude.
23317 * @note Origin pixel point is the top left corner of the viewport.
23318 * Map zoom and size are taken on account.
23320 * @see elm_map_utils_convert_coord_into_geo() if you need the inverse.
23324 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);
23327 * Convert a geographic coordinate (longitude, latitude) into a name
23330 * @param obj The map object.
23331 * @param lon the longitude.
23332 * @param lat the latitude.
23333 * @return name A #Elm_Map_Name handle for this coordinate.
23335 * To get the string for this address, elm_map_name_address_get()
23338 * @see elm_map_utils_convert_name_into_coord() if you need the inverse.
23342 EAPI Elm_Map_Name *elm_map_utils_convert_coord_into_name(const Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
23345 * Convert a name (address) into a geographic coordinate
23346 * (longitude, latitude).
23348 * @param obj The map object.
23349 * @param name The address.
23350 * @return name A #Elm_Map_Name handle for this address.
23352 * To get the longitude and latitude, elm_map_name_region_get()
23355 * @see elm_map_utils_convert_coord_into_name() if you need the inverse.
23359 EAPI Elm_Map_Name *elm_map_utils_convert_name_into_coord(const Evas_Object *obj, char *address) EINA_ARG_NONNULL(1, 2);
23362 * Convert a pixel coordinate into a rotated pixel coordinate.
23364 * @param obj The map object.
23365 * @param x horizontal coordinate of the point to rotate.
23366 * @param y vertical coordinate of the point to rotate.
23367 * @param cx rotation's center horizontal position.
23368 * @param cy rotation's center vertical position.
23369 * @param degree amount of degrees from 0.0 to 360.0 to rotate arount Z axis.
23370 * @param xx Pointer where to store rotated x.
23371 * @param yy Pointer where to store rotated y.
23375 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);
23378 * Add a new marker to the map object.
23380 * @param obj The map object.
23381 * @param lon The longitude of the marker.
23382 * @param lat The latitude of the marker.
23383 * @param clas The class, to use when marker @b isn't grouped to others.
23384 * @param clas_group The class group, to use when marker is grouped to others
23385 * @param data The data passed to the callbacks.
23387 * @return The created marker or @c NULL upon failure.
23389 * A marker will be created and shown in a specific point of the map, defined
23390 * by @p lon and @p lat.
23392 * It will be displayed using style defined by @p class when this marker
23393 * is displayed alone (not grouped). A new class can be created with
23394 * elm_map_marker_class_new().
23396 * If the marker is grouped to other markers, it will be displayed with
23397 * style defined by @p class_group. Markers with the same group are grouped
23398 * if they are close. A new group class can be created with
23399 * elm_map_marker_group_class_new().
23401 * Markers created with this method can be deleted with
23402 * elm_map_marker_remove().
23404 * A marker can have associated content to be displayed by a bubble,
23405 * when a user click over it, as well as an icon. These objects will
23406 * be fetch using class' callback functions.
23408 * @see elm_map_marker_class_new()
23409 * @see elm_map_marker_group_class_new()
23410 * @see elm_map_marker_remove()
23414 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);
23417 * Set the maximum numbers of markers' content to be displayed in a group.
23419 * @param obj The map object.
23420 * @param max The maximum numbers of items displayed in a bubble.
23422 * A bubble will be displayed when the user clicks over the group,
23423 * and will place the content of markers that belong to this group
23426 * A group can have a long list of markers, consequently the creation
23427 * of the content of the bubble can be very slow.
23429 * In order to avoid this, a maximum number of items is displayed
23432 * By default this number is 30.
23434 * Marker with the same group class are grouped if they are close.
23436 * @see elm_map_marker_add()
23440 EAPI void elm_map_max_marker_per_group_set(Evas_Object *obj, int max) EINA_ARG_NONNULL(1);
23443 * Remove a marker from the map.
23445 * @param marker The marker to remove.
23447 * @see elm_map_marker_add()
23451 EAPI void elm_map_marker_remove(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
23454 * Get the current coordinates of the marker.
23456 * @param marker marker.
23457 * @param lat Pointer where to store the marker's latitude.
23458 * @param lon Pointer where to store the marker's longitude.
23460 * These values are set when adding markers, with function
23461 * elm_map_marker_add().
23463 * @see elm_map_marker_add()
23467 EAPI void elm_map_marker_region_get(const Elm_Map_Marker *marker, double *lon, double *lat) EINA_ARG_NONNULL(1);
23470 * Animatedly bring in given marker to the center of the map.
23472 * @param marker The marker to center at.
23474 * This causes map to jump to the given @p marker's coordinates
23475 * and show it (by scrolling) in the center of the viewport, if it is not
23476 * already centered. This will use animation to do so and take a period
23477 * of time to complete.
23479 * @see elm_map_marker_show() for a function to avoid animation.
23480 * @see elm_map_marker_region_get()
23484 EAPI void elm_map_marker_bring_in(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
23487 * Show the given marker at the center of the map, @b immediately.
23489 * @param marker The marker to center at.
23491 * This causes map to @b redraw its viewport's contents to the
23492 * region contining the given @p marker's coordinates, that will be
23493 * moved to the center of the map.
23495 * @see elm_map_marker_bring_in() for a function to move with animation.
23496 * @see elm_map_markers_list_show() if more than one marker need to be
23498 * @see elm_map_marker_region_get()
23502 EAPI void elm_map_marker_show(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
23505 * Move and zoom the map to display a list of markers.
23507 * @param markers A list of #Elm_Map_Marker handles.
23509 * The map will be centered on the center point of the markers in the list.
23510 * Then the map will be zoomed in order to fit the markers using the maximum
23511 * zoom which allows display of all the markers.
23513 * @warning All the markers should belong to the same map object.
23515 * @see elm_map_marker_show() to show a single marker.
23516 * @see elm_map_marker_bring_in()
23520 EAPI void elm_map_markers_list_show(Eina_List *markers) EINA_ARG_NONNULL(1);
23523 * Get the Evas object returned by the ElmMapMarkerGetFunc callback
23525 * @param marker The marker wich content should be returned.
23526 * @return Return the evas object if it exists, else @c NULL.
23528 * To set callback function #ElmMapMarkerGetFunc for the marker class,
23529 * elm_map_marker_class_get_cb_set() should be used.
23531 * This content is what will be inside the bubble that will be displayed
23532 * when an user clicks over the marker.
23534 * This returns the actual Evas object used to be placed inside
23535 * the bubble. This may be @c NULL, as it may
23536 * not have been created or may have been deleted, at any time, by
23537 * the map. <b>Do not modify this object</b> (move, resize,
23538 * show, hide, etc.), as the map is controlling it. This
23539 * function is for querying, emitting custom signals or hooking
23540 * lower level callbacks for events on that object. Do not delete
23541 * this object under any circumstances.
23545 EAPI Evas_Object *elm_map_marker_object_get(const Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
23548 * Update the marker
23550 * @param marker The marker to be updated.
23552 * If a content is set to this marker, it will call function to delete it,
23553 * #ElmMapMarkerDelFunc, and then will fetch the content again with
23554 * #ElmMapMarkerGetFunc.
23556 * These functions are set for the marker class with
23557 * elm_map_marker_class_get_cb_set() and elm_map_marker_class_del_cb_set().
23561 EAPI void elm_map_marker_update(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
23564 * Close all the bubbles opened by the user.
23566 * @param obj The map object.
23568 * A bubble is displayed with a content fetched with #ElmMapMarkerGetFunc
23569 * when the user clicks on a marker.
23571 * This functions is set for the marker class with
23572 * elm_map_marker_class_get_cb_set().
23576 EAPI void elm_map_bubbles_close(Evas_Object *obj) EINA_ARG_NONNULL(1);
23579 * Create a new group class.
23581 * @param obj The map object.
23582 * @return Returns the new group class.
23584 * Each marker must be associated to a group class. Markers in the same
23585 * group are grouped if they are close.
23587 * The group class defines the style of the marker when a marker is grouped
23588 * to others markers. When it is alone, another class will be used.
23590 * A group class will need to be provided when creating a marker with
23591 * elm_map_marker_add().
23593 * Some properties and functions can be set by class, as:
23594 * - style, with elm_map_group_class_style_set()
23595 * - data - to be associated to the group class. It can be set using
23596 * elm_map_group_class_data_set().
23597 * - min zoom to display markers, set with
23598 * elm_map_group_class_zoom_displayed_set().
23599 * - max zoom to group markers, set using
23600 * elm_map_group_class_zoom_grouped_set().
23601 * - visibility - set if markers will be visible or not, set with
23602 * elm_map_group_class_hide_set().
23603 * - #ElmMapGroupIconGetFunc - used to fetch icon for markers group classes.
23604 * It can be set using elm_map_group_class_icon_cb_set().
23606 * @see elm_map_marker_add()
23607 * @see elm_map_group_class_style_set()
23608 * @see elm_map_group_class_data_set()
23609 * @see elm_map_group_class_zoom_displayed_set()
23610 * @see elm_map_group_class_zoom_grouped_set()
23611 * @see elm_map_group_class_hide_set()
23612 * @see elm_map_group_class_icon_cb_set()
23616 EAPI Elm_Map_Group_Class *elm_map_group_class_new(Evas_Object *obj) EINA_ARG_NONNULL(1);
23619 * Set the marker's style of a group class.
23621 * @param clas The group class.
23622 * @param style The style to be used by markers.
23624 * Each marker must be associated to a group class, and will use the style
23625 * defined by such class when grouped to other markers.
23627 * The following styles are provided by default theme:
23628 * @li @c radio - blue circle
23629 * @li @c radio2 - green circle
23632 * @see elm_map_group_class_new() for more details.
23633 * @see elm_map_marker_add()
23637 EAPI void elm_map_group_class_style_set(Elm_Map_Group_Class *clas, const char *style) EINA_ARG_NONNULL(1);
23640 * Set the icon callback function of a group class.
23642 * @param clas The group class.
23643 * @param icon_get The callback function that will return the icon.
23645 * Each marker must be associated to a group class, and it can display a
23646 * custom icon. The function @p icon_get must return this icon.
23648 * @see elm_map_group_class_new() for more details.
23649 * @see elm_map_marker_add()
23653 EAPI void elm_map_group_class_icon_cb_set(Elm_Map_Group_Class *clas, ElmMapGroupIconGetFunc icon_get) EINA_ARG_NONNULL(1);
23656 * Set the data associated to the group class.
23658 * @param clas The group class.
23659 * @param data The new user data.
23661 * This data will be passed for callback functions, like icon get callback,
23662 * that can be set with elm_map_group_class_icon_cb_set().
23664 * If a data was previously set, the object will lose the pointer for it,
23665 * so if needs to be freed, you must do it yourself.
23667 * @see elm_map_group_class_new() for more details.
23668 * @see elm_map_group_class_icon_cb_set()
23669 * @see elm_map_marker_add()
23673 EAPI void elm_map_group_class_data_set(Elm_Map_Group_Class *clas, void *data) EINA_ARG_NONNULL(1);
23676 * Set the minimum zoom from where the markers are displayed.
23678 * @param clas The group class.
23679 * @param zoom The minimum zoom.
23681 * Markers only will be displayed when the map is displayed at @p zoom
23684 * @see elm_map_group_class_new() for more details.
23685 * @see elm_map_marker_add()
23689 EAPI void elm_map_group_class_zoom_displayed_set(Elm_Map_Group_Class *clas, int zoom) EINA_ARG_NONNULL(1);
23692 * Set the zoom from where the markers are no more grouped.
23694 * @param clas The group class.
23695 * @param zoom The maximum zoom.
23697 * Markers only will be grouped when the map is displayed at
23698 * less than @p zoom.
23700 * @see elm_map_group_class_new() for more details.
23701 * @see elm_map_marker_add()
23705 EAPI void elm_map_group_class_zoom_grouped_set(Elm_Map_Group_Class *clas, int zoom) EINA_ARG_NONNULL(1);
23708 * Set if the markers associated to the group class @clas are hidden or not.
23710 * @param clas The group class.
23711 * @param hide Use @c EINA_TRUE to hide markers or @c EINA_FALSE
23714 * If @p hide is @c EINA_TRUE the markers will be hidden, but default
23719 EAPI void elm_map_group_class_hide_set(Evas_Object *obj, Elm_Map_Group_Class *clas, Eina_Bool hide) EINA_ARG_NONNULL(1, 2);
23722 * Create a new marker class.
23724 * @param obj The map object.
23725 * @return Returns the new group class.
23727 * Each marker must be associated to a class.
23729 * The marker class defines the style of the marker when a marker is
23730 * displayed alone, i.e., not grouped to to others markers. When grouped
23731 * it will use group class style.
23733 * A marker class will need to be provided when creating a marker with
23734 * elm_map_marker_add().
23736 * Some properties and functions can be set by class, as:
23737 * - style, with elm_map_marker_class_style_set()
23738 * - #ElmMapMarkerIconGetFunc - used to fetch icon for markers classes.
23739 * It can be set using elm_map_marker_class_icon_cb_set().
23740 * - #ElmMapMarkerGetFunc - used to fetch bubble content for marker classes.
23741 * Set using elm_map_marker_class_get_cb_set().
23742 * - #ElmMapMarkerDelFunc - used to delete bubble content for marker classes.
23743 * Set using elm_map_marker_class_del_cb_set().
23745 * @see elm_map_marker_add()
23746 * @see elm_map_marker_class_style_set()
23747 * @see elm_map_marker_class_icon_cb_set()
23748 * @see elm_map_marker_class_get_cb_set()
23749 * @see elm_map_marker_class_del_cb_set()
23753 EAPI Elm_Map_Marker_Class *elm_map_marker_class_new(Evas_Object *obj) EINA_ARG_NONNULL(1);
23756 * Set the marker's style of a marker class.
23758 * @param clas The marker class.
23759 * @param style The style to be used by markers.
23761 * Each marker must be associated to a marker class, and will use the style
23762 * defined by such class when alone, i.e., @b not grouped to other markers.
23764 * The following styles are provided by default theme:
23769 * @see elm_map_marker_class_new() for more details.
23770 * @see elm_map_marker_add()
23774 EAPI void elm_map_marker_class_style_set(Elm_Map_Marker_Class *clas, const char *style) EINA_ARG_NONNULL(1);
23777 * Set the icon callback function of a marker class.
23779 * @param clas The marker class.
23780 * @param icon_get The callback function that will return the icon.
23782 * Each marker must be associated to a marker class, and it can display a
23783 * custom icon. The function @p icon_get must return this icon.
23785 * @see elm_map_marker_class_new() for more details.
23786 * @see elm_map_marker_add()
23790 EAPI void elm_map_marker_class_icon_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerIconGetFunc icon_get) EINA_ARG_NONNULL(1);
23793 * Set the bubble content callback function of a marker class.
23795 * @param clas The marker class.
23796 * @param get The callback function that will return the content.
23798 * Each marker must be associated to a marker class, and it can display a
23799 * a content on a bubble that opens when the user click over the marker.
23800 * The function @p get must return this content object.
23802 * If this content will need to be deleted, elm_map_marker_class_del_cb_set()
23805 * @see elm_map_marker_class_new() for more details.
23806 * @see elm_map_marker_class_del_cb_set()
23807 * @see elm_map_marker_add()
23811 EAPI void elm_map_marker_class_get_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerGetFunc get) EINA_ARG_NONNULL(1);
23814 * Set the callback function used to delete bubble content of a marker class.
23816 * @param clas The marker class.
23817 * @param del The callback function that will delete the content.
23819 * Each marker must be associated to a marker class, and it can display a
23820 * a content on a bubble that opens when the user click over the marker.
23821 * The function to return such content can be set with
23822 * elm_map_marker_class_get_cb_set().
23824 * If this content must be freed, a callback function need to be
23825 * set for that task with this function.
23827 * If this callback is defined it will have to delete (or not) the
23828 * object inside, but if the callback is not defined the object will be
23829 * destroyed with evas_object_del().
23831 * @see elm_map_marker_class_new() for more details.
23832 * @see elm_map_marker_class_get_cb_set()
23833 * @see elm_map_marker_add()
23837 EAPI void elm_map_marker_class_del_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerDelFunc del) EINA_ARG_NONNULL(1);
23840 * Get the list of available sources.
23842 * @param obj The map object.
23843 * @return The source names list.
23845 * It will provide a list with all available sources, that can be set as
23846 * current source with elm_map_source_name_set(), or get with
23847 * elm_map_source_name_get().
23849 * Available sources:
23855 * @see elm_map_source_name_set() for more details.
23856 * @see elm_map_source_name_get()
23860 EAPI const char **elm_map_source_names_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23863 * Set the source of the map.
23865 * @param obj The map object.
23866 * @param source The source to be used.
23868 * Map widget retrieves images that composes the map from a web service.
23869 * This web service can be set with this method.
23871 * A different service can return a different maps with different
23872 * information and it can use different zoom values.
23874 * The @p source_name need to match one of the names provided by
23875 * elm_map_source_names_get().
23877 * The current source can be get using elm_map_source_name_get().
23879 * @see elm_map_source_names_get()
23880 * @see elm_map_source_name_get()
23885 EAPI void elm_map_source_name_set(Evas_Object *obj, const char *source_name) EINA_ARG_NONNULL(1);
23888 * Get the name of currently used source.
23890 * @param obj The map object.
23891 * @return Returns the name of the source in use.
23893 * @see elm_map_source_name_set() for more details.
23897 EAPI const char *elm_map_source_name_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23900 * Set the source of the route service to be used by the map.
23902 * @param obj The map object.
23903 * @param source The route service to be used, being it one of
23904 * #ELM_MAP_ROUTE_SOURCE_YOURS (default), #ELM_MAP_ROUTE_SOURCE_MONAV,
23905 * and #ELM_MAP_ROUTE_SOURCE_ORS.
23907 * Each one has its own algorithm, so the route retrieved may
23908 * differ depending on the source route. Now, only the default is working.
23910 * #ELM_MAP_ROUTE_SOURCE_YOURS is the routing service provided at
23911 * http://www.yournavigation.org/.
23913 * #ELM_MAP_ROUTE_SOURCE_MONAV, offers exact routing without heuristic
23914 * assumptions. Its routing core is based on Contraction Hierarchies.
23916 * #ELM_MAP_ROUTE_SOURCE_ORS, is provided at http://www.openrouteservice.org/
23918 * @see elm_map_route_source_get().
23922 EAPI void elm_map_route_source_set(Evas_Object *obj, Elm_Map_Route_Sources source) EINA_ARG_NONNULL(1);
23925 * Get the current route source.
23927 * @param obj The map object.
23928 * @return The source of the route service used by the map.
23930 * @see elm_map_route_source_set() for details.
23934 EAPI Elm_Map_Route_Sources elm_map_route_source_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23937 * Set the minimum zoom of the source.
23939 * @param obj The map object.
23940 * @param zoom New minimum zoom value to be used.
23942 * By default, it's 0.
23946 EAPI void elm_map_source_zoom_min_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
23949 * Get the minimum zoom of the source.
23951 * @param obj The map object.
23952 * @return Returns the minimum zoom of the source.
23954 * @see elm_map_source_zoom_min_set() for details.
23958 EAPI int elm_map_source_zoom_min_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23961 * Set the maximum zoom of the source.
23963 * @param obj The map object.
23964 * @param zoom New maximum zoom value to be used.
23966 * By default, it's 18.
23970 EAPI void elm_map_source_zoom_max_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
23973 * Get the maximum zoom of the source.
23975 * @param obj The map object.
23976 * @return Returns the maximum zoom of the source.
23978 * @see elm_map_source_zoom_min_set() for details.
23982 EAPI int elm_map_source_zoom_max_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23985 * Set the user agent used by the map object to access routing services.
23987 * @param obj The map object.
23988 * @param user_agent The user agent to be used by the map.
23990 * User agent is a client application implementing a network protocol used
23991 * in communications within a clientāserver distributed computing system
23993 * The @p user_agent identification string will transmitted in a header
23994 * field @c User-Agent.
23996 * @see elm_map_user_agent_get()
24000 EAPI void elm_map_user_agent_set(Evas_Object *obj, const char *user_agent) EINA_ARG_NONNULL(1, 2);
24003 * Get the user agent used by the map object.
24005 * @param obj The map object.
24006 * @return The user agent identification string used by the map.
24008 * @see elm_map_user_agent_set() for details.
24012 EAPI const char *elm_map_user_agent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24015 * Add a new route to the map object.
24017 * @param obj The map object.
24018 * @param type The type of transport to be considered when tracing a route.
24019 * @param method The routing method, what should be priorized.
24020 * @param flon The start longitude.
24021 * @param flat The start latitude.
24022 * @param tlon The destination longitude.
24023 * @param tlat The destination latitude.
24025 * @return The created route or @c NULL upon failure.
24027 * A route will be traced by point on coordinates (@p flat, @p flon)
24028 * to point on coordinates (@p tlat, @p tlon), using the route service
24029 * set with elm_map_route_source_set().
24031 * It will take @p type on consideration to define the route,
24032 * depending if the user will be walking or driving, the route may vary.
24033 * One of #ELM_MAP_ROUTE_TYPE_MOTOCAR, #ELM_MAP_ROUTE_TYPE_BICYCLE, or
24034 * #ELM_MAP_ROUTE_TYPE_FOOT need to be used.
24036 * Another parameter is what the route should priorize, the minor distance
24037 * or the less time to be spend on the route. So @p method should be one
24038 * of #ELM_MAP_ROUTE_METHOD_SHORTEST or #ELM_MAP_ROUTE_METHOD_FASTEST.
24040 * Routes created with this method can be deleted with
24041 * elm_map_route_remove(), colored with elm_map_route_color_set(),
24042 * and distance can be get with elm_map_route_distance_get().
24044 * @see elm_map_route_remove()
24045 * @see elm_map_route_color_set()
24046 * @see elm_map_route_distance_get()
24047 * @see elm_map_route_source_set()
24051 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);
24054 * Remove a route from the map.
24056 * @param route The route to remove.
24058 * @see elm_map_route_add()
24062 EAPI void elm_map_route_remove(Elm_Map_Route *route) EINA_ARG_NONNULL(1);
24065 * Set the route color.
24067 * @param route The route object.
24068 * @param r Red channel value, from 0 to 255.
24069 * @param g Green channel value, from 0 to 255.
24070 * @param b Blue channel value, from 0 to 255.
24071 * @param a Alpha channel value, from 0 to 255.
24073 * It uses an additive color model, so each color channel represents
24074 * how much of each primary colors must to be used. 0 represents
24075 * ausence of this color, so if all of the three are set to 0,
24076 * the color will be black.
24078 * These component values should be integers in the range 0 to 255,
24079 * (single 8-bit byte).
24081 * This sets the color used for the route. By default, it is set to
24082 * solid red (r = 255, g = 0, b = 0, a = 255).
24084 * For alpha channel, 0 represents completely transparent, and 255, opaque.
24086 * @see elm_map_route_color_get()
24090 EAPI void elm_map_route_color_set(Elm_Map_Route *route, int r, int g , int b, int a) EINA_ARG_NONNULL(1);
24093 * Get the route color.
24095 * @param route The route object.
24096 * @param r Pointer where to store the red channel value.
24097 * @param g Pointer where to store the green channel value.
24098 * @param b Pointer where to store the blue channel value.
24099 * @param a Pointer where to store the alpha channel value.
24101 * @see elm_map_route_color_set() for details.
24105 EAPI void elm_map_route_color_get(const Elm_Map_Route *route, int *r, int *g , int *b, int *a) EINA_ARG_NONNULL(1);
24108 * Get the route distance in kilometers.
24110 * @param route The route object.
24111 * @return The distance of route (unit : km).
24115 EAPI double elm_map_route_distance_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
24118 * Get the information of route nodes.
24120 * @param route The route object.
24121 * @return Returns a string with the nodes of route.
24125 EAPI const char *elm_map_route_node_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
24128 * Get the information of route waypoint.
24130 * @param route the route object.
24131 * @return Returns a string with information about waypoint of route.
24135 EAPI const char *elm_map_route_waypoint_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
24138 * Get the address of the name.
24140 * @param name The name handle.
24141 * @return Returns the address string of @p name.
24143 * This gets the coordinates of the @p name, created with one of the
24144 * conversion functions.
24146 * @see elm_map_utils_convert_name_into_coord()
24147 * @see elm_map_utils_convert_coord_into_name()
24151 EAPI const char *elm_map_name_address_get(const Elm_Map_Name *name) EINA_ARG_NONNULL(1);
24154 * Get the current coordinates of the name.
24156 * @param name The name handle.
24157 * @param lat Pointer where to store the latitude.
24158 * @param lon Pointer where to store The longitude.
24160 * This gets the coordinates of the @p name, created with one of the
24161 * conversion functions.
24163 * @see elm_map_utils_convert_name_into_coord()
24164 * @see elm_map_utils_convert_coord_into_name()
24168 EAPI void elm_map_name_region_get(const Elm_Map_Name *name, double *lon, double *lat) EINA_ARG_NONNULL(1);
24171 * Remove a name from the map.
24173 * @param name The name to remove.
24175 * Basically the struct handled by @p name will be freed, so convertions
24176 * between address and coordinates will be lost.
24178 * @see elm_map_utils_convert_name_into_coord()
24179 * @see elm_map_utils_convert_coord_into_name()
24183 EAPI void elm_map_name_remove(Elm_Map_Name *name) EINA_ARG_NONNULL(1);
24188 * @param obj The map object.
24189 * @param degree Angle from 0.0 to 360.0 to rotate arount Z axis.
24190 * @param cx Rotation's center horizontal position.
24191 * @param cy Rotation's center vertical position.
24193 * @see elm_map_rotate_get()
24197 EAPI void elm_map_rotate_set(Evas_Object *obj, double degree, Evas_Coord cx, Evas_Coord cy) EINA_ARG_NONNULL(1);
24200 * Get the rotate degree of the map
24202 * @param obj The map object
24203 * @param degree Pointer where to store degrees from 0.0 to 360.0
24204 * to rotate arount Z axis.
24205 * @param cx Pointer where to store rotation's center horizontal position.
24206 * @param cy Pointer where to store rotation's center vertical position.
24208 * @see elm_map_rotate_set() to set map rotation.
24212 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);
24215 * Enable or disable mouse wheel to be used to zoom in / out the map.
24217 * @param obj The map object.
24218 * @param disabled Use @c EINA_TRUE to disable mouse wheel or @c EINA_FALSE
24221 * Mouse wheel can be used for the user to zoom in or zoom out the map.
24223 * It's disabled by default.
24225 * @see elm_map_wheel_disabled_get()
24229 EAPI void elm_map_wheel_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
24232 * Get a value whether mouse wheel is enabled or not.
24234 * @param obj The map object.
24235 * @return @c EINA_TRUE means map is disabled. @c EINA_FALSE indicates
24236 * it is enabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
24238 * Mouse wheel can be used for the user to zoom in or zoom out the map.
24240 * @see elm_map_wheel_disabled_set() for details.
24244 EAPI Eina_Bool elm_map_wheel_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24248 * Add a track on the map
24250 * @param obj The map object.
24251 * @param emap The emap route object.
24252 * @return The route object. This is an elm object of type Route.
24254 * @see elm_route_add() for details.
24258 EAPI Evas_Object *elm_map_track_add(Evas_Object *obj, EMap_Route *emap) EINA_ARG_NONNULL(1);
24262 * Remove a track from the map
24264 * @param obj The map object.
24265 * @param route The track to remove.
24269 EAPI void elm_map_track_remove(Evas_Object *obj, Evas_Object *route) EINA_ARG_NONNULL(1);
24276 EAPI Evas_Object *elm_route_add(Evas_Object *parent);
24278 EAPI void elm_route_emap_set(Evas_Object *obj, EMap_Route *emap);
24280 EAPI double elm_route_lon_min_get(Evas_Object *obj);
24281 EAPI double elm_route_lat_min_get(Evas_Object *obj);
24282 EAPI double elm_route_lon_max_get(Evas_Object *obj);
24283 EAPI double elm_route_lat_max_get(Evas_Object *obj);
24287 * @defgroup Panel Panel
24289 * @image html img/widget/panel/preview-00.png
24290 * @image latex img/widget/panel/preview-00.eps
24292 * @brief A panel is a type of animated container that contains subobjects.
24293 * It can be expanded or contracted by clicking the button on it's edge.
24295 * Orientations are as follows:
24296 * @li ELM_PANEL_ORIENT_TOP
24297 * @li ELM_PANEL_ORIENT_LEFT
24298 * @li ELM_PANEL_ORIENT_RIGHT
24300 * Default contents parts of the panel widget that you can use for are:
24301 * @li "default" - A content of the panel
24303 * @ref tutorial_panel shows one way to use this widget.
24306 typedef enum _Elm_Panel_Orient
24308 ELM_PANEL_ORIENT_TOP, /**< Panel (dis)appears from the top */
24309 ELM_PANEL_ORIENT_BOTTOM, /**< Not implemented */
24310 ELM_PANEL_ORIENT_LEFT, /**< Panel (dis)appears from the left */
24311 ELM_PANEL_ORIENT_RIGHT, /**< Panel (dis)appears from the right */
24312 } Elm_Panel_Orient;
24314 * @brief Adds a panel object
24316 * @param parent The parent object
24318 * @return The panel object, or NULL on failure
24320 EAPI Evas_Object *elm_panel_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24322 * @brief Sets the orientation of the panel
24324 * @param parent The parent object
24325 * @param orient The panel orientation. Can be one of the following:
24326 * @li ELM_PANEL_ORIENT_TOP
24327 * @li ELM_PANEL_ORIENT_LEFT
24328 * @li ELM_PANEL_ORIENT_RIGHT
24330 * Sets from where the panel will (dis)appear.
24332 EAPI void elm_panel_orient_set(Evas_Object *obj, Elm_Panel_Orient orient) EINA_ARG_NONNULL(1);
24334 * @brief Get the orientation of the panel.
24336 * @param obj The panel object
24337 * @return The Elm_Panel_Orient, or ELM_PANEL_ORIENT_LEFT on failure.
24339 EAPI Elm_Panel_Orient elm_panel_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24341 * @brief Set the content of the panel.
24343 * @param obj The panel object
24344 * @param content The panel content
24346 * Once the content object is set, a previously set one will be deleted.
24347 * If you want to keep that old content object, use the
24348 * elm_panel_content_unset() function.
24350 * @deprecated use elm_object_content_set() instead
24353 EINA_DEPRECATED EAPI void elm_panel_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
24355 * @brief Get the content of the panel.
24357 * @param obj The panel object
24358 * @return The content that is being used
24360 * Return the content object which is set for this widget.
24362 * @see elm_panel_content_set()
24364 * @deprecated use elm_object_content_get() instead
24367 EINA_DEPRECATED EAPI Evas_Object *elm_panel_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24369 * @brief Unset the content of the panel.
24371 * @param obj The panel object
24372 * @return The content that was being used
24374 * Unparent and return the content object which was set for this widget.
24376 * @see elm_panel_content_set()
24378 * @deprecated use elm_object_content_unset() instead
24381 EINA_DEPRECATED EAPI Evas_Object *elm_panel_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24383 * @brief Set the state of the panel.
24385 * @param obj The panel object
24386 * @param hidden If true, the panel will run the animation to contract
24388 EAPI void elm_panel_hidden_set(Evas_Object *obj, Eina_Bool hidden) EINA_ARG_NONNULL(1);
24390 * @brief Get the state of the panel.
24392 * @param obj The panel object
24393 * @param hidden If true, the panel is in the "hide" state
24395 EAPI Eina_Bool elm_panel_hidden_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24397 * @brief Toggle the hidden state of the panel from code
24399 * @param obj The panel object
24401 EAPI void elm_panel_toggle(Evas_Object *obj) EINA_ARG_NONNULL(1);
24407 * @defgroup Panes Panes
24408 * @ingroup Elementary
24410 * @image html img/widget/panes/preview-00.png
24411 * @image latex img/widget/panes/preview-00.eps width=\textwidth
24413 * @image html img/panes.png
24414 * @image latex img/panes.eps width=\textwidth
24416 * The panes adds a dragable bar between two contents. When dragged
24417 * this bar will resize contents size.
24419 * Panes can be displayed vertically or horizontally, and contents
24420 * size proportion can be customized (homogeneous by default).
24422 * Smart callbacks one can listen to:
24423 * - "press" - The panes has been pressed (button wasn't released yet).
24424 * - "unpressed" - The panes was released after being pressed.
24425 * - "clicked" - The panes has been clicked>
24426 * - "clicked,double" - The panes has been double clicked
24428 * Available styles for it:
24431 * Default contents parts of the panes widget that you can use for are:
24432 * @li "left" - A leftside content of the panes
24433 * @li "right" - A rightside content of the panes
24435 * If panes is displayed vertically, left content will be displayed at
24438 * Here is an example on its usage:
24439 * @li @ref panes_example
24443 * @addtogroup Panes
24448 * Add a new panes widget to the given parent Elementary
24449 * (container) object.
24451 * @param parent The parent object.
24452 * @return a new panes widget handle or @c NULL, on errors.
24454 * This function inserts a new panes widget on the canvas.
24458 EAPI Evas_Object *elm_panes_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24461 * Set the left content of the panes widget.
24463 * @param obj The panes object.
24464 * @param content The new left content object.
24466 * Once the content object is set, a previously set one will be deleted.
24467 * If you want to keep that old content object, use the
24468 * elm_panes_content_left_unset() function.
24470 * If panes is displayed vertically, left content will be displayed at
24473 * @see elm_panes_content_left_get()
24474 * @see elm_panes_content_right_set() to set content on the other side.
24476 * @deprecated use elm_object_part_content_set() instead
24480 EINA_DEPRECATED EAPI void elm_panes_content_left_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
24483 * Set the right content of the panes widget.
24485 * @param obj The panes object.
24486 * @param content The new right content object.
24488 * Once the content object is set, a previously set one will be deleted.
24489 * If you want to keep that old content object, use the
24490 * elm_panes_content_right_unset() function.
24492 * If panes is displayed vertically, left content will be displayed at
24495 * @see elm_panes_content_right_get()
24496 * @see elm_panes_content_left_set() to set content on the other side.
24498 * @deprecated use elm_object_part_content_set() instead
24502 EINA_DEPRECATED EAPI void elm_panes_content_right_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
24505 * Get the left content of the panes.
24507 * @param obj The panes object.
24508 * @return The left content object that is being used.
24510 * Return the left content object which is set for this widget.
24512 * @see elm_panes_content_left_set() for details.
24514 * @deprecated use elm_object_part_content_get() instead
24518 EINA_DEPRECATED EAPI Evas_Object *elm_panes_content_left_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24521 * Get the right content of the panes.
24523 * @param obj The panes object
24524 * @return The right content object that is being used
24526 * Return the right content object which is set for this widget.
24528 * @see elm_panes_content_right_set() for details.
24530 * @deprecated use elm_object_part_content_get() instead
24534 EINA_DEPRECATED EAPI Evas_Object *elm_panes_content_right_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24537 * Unset the left content used for the panes.
24539 * @param obj The panes object.
24540 * @return The left content object that was being used.
24542 * Unparent and return the left content object which was set for this widget.
24544 * @see elm_panes_content_left_set() for details.
24545 * @see elm_panes_content_left_get().
24547 * @deprecated use elm_object_part_content_unset() instead
24551 EINA_DEPRECATED EAPI Evas_Object *elm_panes_content_left_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24554 * Unset the right content used for the panes.
24556 * @param obj The panes object.
24557 * @return The right content object that was being used.
24559 * Unparent and return the right content object which was set for this
24562 * @see elm_panes_content_right_set() for details.
24563 * @see elm_panes_content_right_get().
24565 * @deprecated use elm_object_part_content_unset() instead
24569 EINA_DEPRECATED EAPI Evas_Object *elm_panes_content_right_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24572 * Get the size proportion of panes widget's left side.
24574 * @param obj The panes object.
24575 * @return float value between 0.0 and 1.0 representing size proportion
24578 * @see elm_panes_content_left_size_set() for more details.
24582 EAPI double elm_panes_content_left_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24585 * Set the size proportion of panes widget's left side.
24587 * @param obj The panes object.
24588 * @param size Value between 0.0 and 1.0 representing size proportion
24591 * By default it's homogeneous, i.e., both sides have the same size.
24593 * If something different is required, it can be set with this function.
24594 * For example, if the left content should be displayed over
24595 * 75% of the panes size, @p size should be passed as @c 0.75.
24596 * This way, right content will be resized to 25% of panes size.
24598 * If displayed vertically, left content is displayed at top, and
24599 * right content at bottom.
24601 * @note This proportion will change when user drags the panes bar.
24603 * @see elm_panes_content_left_size_get()
24607 EAPI void elm_panes_content_left_size_set(Evas_Object *obj, double size) EINA_ARG_NONNULL(1);
24610 * Set the orientation of a given panes widget.
24612 * @param obj The panes object.
24613 * @param horizontal Use @c EINA_TRUE to make @p obj to be
24614 * @b horizontal, @c EINA_FALSE to make it @b vertical.
24616 * Use this function to change how your panes is to be
24617 * disposed: vertically or horizontally.
24619 * By default it's displayed horizontally.
24621 * @see elm_panes_horizontal_get()
24625 EAPI void elm_panes_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
24628 * Retrieve the orientation of a given panes widget.
24630 * @param obj The panes object.
24631 * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
24632 * @c EINA_FALSE if it's @b vertical (and on errors).
24634 * @see elm_panes_horizontal_set() for more details.
24638 EAPI Eina_Bool elm_panes_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24639 EAPI void elm_panes_fixed_set(Evas_Object *obj, Eina_Bool fixed) EINA_ARG_NONNULL(1);
24640 EAPI Eina_Bool elm_panes_fixed_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24647 * @defgroup Flip Flip
24649 * @image html img/widget/flip/preview-00.png
24650 * @image latex img/widget/flip/preview-00.eps
24652 * This widget holds 2 content objects(Evas_Object): one on the front and one
24653 * on the back. It allows you to flip from front to back and vice-versa using
24654 * various animations.
24656 * If either the front or back contents are not set the flip will treat that
24657 * as transparent. So if you wore to set the front content but not the back,
24658 * and then call elm_flip_go() you would see whatever is below the flip.
24660 * For a list of supported animations see elm_flip_go().
24662 * Signals that you can add callbacks for are:
24663 * "animate,begin" - when a flip animation was started
24664 * "animate,done" - when a flip animation is finished
24666 * @ref tutorial_flip show how to use most of the API.
24670 typedef enum _Elm_Flip_Mode
24672 ELM_FLIP_ROTATE_Y_CENTER_AXIS,
24673 ELM_FLIP_ROTATE_X_CENTER_AXIS,
24674 ELM_FLIP_ROTATE_XZ_CENTER_AXIS,
24675 ELM_FLIP_ROTATE_YZ_CENTER_AXIS,
24676 ELM_FLIP_CUBE_LEFT,
24677 ELM_FLIP_CUBE_RIGHT,
24679 ELM_FLIP_CUBE_DOWN,
24680 ELM_FLIP_PAGE_LEFT,
24681 ELM_FLIP_PAGE_RIGHT,
24685 typedef enum _Elm_Flip_Interaction
24687 ELM_FLIP_INTERACTION_NONE,
24688 ELM_FLIP_INTERACTION_ROTATE,
24689 ELM_FLIP_INTERACTION_CUBE,
24690 ELM_FLIP_INTERACTION_PAGE
24691 } Elm_Flip_Interaction;
24692 typedef enum _Elm_Flip_Direction
24694 ELM_FLIP_DIRECTION_UP, /**< Allows interaction with the top of the widget */
24695 ELM_FLIP_DIRECTION_DOWN, /**< Allows interaction with the bottom of the widget */
24696 ELM_FLIP_DIRECTION_LEFT, /**< Allows interaction with the left portion of the widget */
24697 ELM_FLIP_DIRECTION_RIGHT /**< Allows interaction with the right portion of the widget */
24698 } Elm_Flip_Direction;
24700 * @brief Add a new flip to the parent
24702 * @param parent The parent object
24703 * @return The new object or NULL if it cannot be created
24705 EAPI Evas_Object *elm_flip_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24707 * @brief Set the front content of the flip widget.
24709 * @param obj The flip object
24710 * @param content The new front content object
24712 * Once the content object is set, a previously set one will be deleted.
24713 * If you want to keep that old content object, use the
24714 * elm_flip_content_front_unset() function.
24716 EAPI void elm_flip_content_front_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
24718 * @brief Set the back content of the flip widget.
24720 * @param obj The flip object
24721 * @param content The new back content object
24723 * Once the content object is set, a previously set one will be deleted.
24724 * If you want to keep that old content object, use the
24725 * elm_flip_content_back_unset() function.
24727 EAPI void elm_flip_content_back_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
24729 * @brief Get the front content used for the flip
24731 * @param obj The flip object
24732 * @return The front content object that is being used
24734 * Return the front content object which is set for this widget.
24736 EAPI Evas_Object *elm_flip_content_front_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24738 * @brief Get the back content used for the flip
24740 * @param obj The flip object
24741 * @return The back content object that is being used
24743 * Return the back content object which is set for this widget.
24745 EAPI Evas_Object *elm_flip_content_back_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24747 * @brief Unset the front content used for the flip
24749 * @param obj The flip object
24750 * @return The front content object that was being used
24752 * Unparent and return the front content object which was set for this widget.
24754 EAPI Evas_Object *elm_flip_content_front_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24756 * @brief Unset the back content used for the flip
24758 * @param obj The flip object
24759 * @return The back content object that was being used
24761 * Unparent and return the back content object which was set for this widget.
24763 EAPI Evas_Object *elm_flip_content_back_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24765 * @brief Get flip front visibility state
24767 * @param obj The flip objct
24768 * @return EINA_TRUE if front front is showing, EINA_FALSE if the back is
24771 EAPI Eina_Bool elm_flip_front_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24773 * @brief Set flip perspective
24775 * @param obj The flip object
24776 * @param foc The coordinate to set the focus on
24777 * @param x The X coordinate
24778 * @param y The Y coordinate
24780 * @warning This function currently does nothing.
24782 EAPI void elm_flip_perspective_set(Evas_Object *obj, Evas_Coord foc, Evas_Coord x, Evas_Coord y) EINA_ARG_NONNULL(1);
24784 * @brief Runs the flip animation
24786 * @param obj The flip object
24787 * @param mode The mode type
24789 * Flips the front and back contents using the @p mode animation. This
24790 * efectively hides the currently visible content and shows the hidden one.
24792 * There a number of possible animations to use for the flipping:
24793 * @li ELM_FLIP_ROTATE_X_CENTER_AXIS - Rotate the currently visible content
24794 * around a horizontal axis in the middle of its height, the other content
24795 * is shown as the other side of the flip.
24796 * @li ELM_FLIP_ROTATE_Y_CENTER_AXIS - Rotate the currently visible content
24797 * around a vertical axis in the middle of its width, the other content is
24798 * shown as the other side of the flip.
24799 * @li ELM_FLIP_ROTATE_XZ_CENTER_AXIS - Rotate the currently visible content
24800 * around a diagonal axis in the middle of its width, the other content is
24801 * shown as the other side of the flip.
24802 * @li ELM_FLIP_ROTATE_YZ_CENTER_AXIS - Rotate the currently visible content
24803 * around a diagonal axis in the middle of its height, the other content is
24804 * shown as the other side of the flip.
24805 * @li ELM_FLIP_CUBE_LEFT - Rotate the currently visible content to the left
24806 * as if the flip was a cube, the other content is show as the right face of
24808 * @li ELM_FLIP_CUBE_RIGHT - Rotate the currently visible content to the
24809 * right as if the flip was a cube, the other content is show as the left
24810 * face of the cube.
24811 * @li ELM_FLIP_CUBE_UP - Rotate the currently visible content up as if the
24812 * flip was a cube, the other content is show as the bottom face of the cube.
24813 * @li ELM_FLIP_CUBE_DOWN - Rotate the currently visible content down as if
24814 * the flip was a cube, the other content is show as the upper face of the
24816 * @li ELM_FLIP_PAGE_LEFT - Move the currently visible content to the left as
24817 * if the flip was a book, the other content is shown as the page below that.
24818 * @li ELM_FLIP_PAGE_RIGHT - Move the currently visible content to the right
24819 * as if the flip was a book, the other content is shown as the page below
24821 * @li ELM_FLIP_PAGE_UP - Move the currently visible content up as if the
24822 * flip was a book, the other content is shown as the page below that.
24823 * @li ELM_FLIP_PAGE_DOWN - Move the currently visible content down as if the
24824 * flip was a book, the other content is shown as the page below that.
24826 * @image html elm_flip.png
24827 * @image latex elm_flip.eps width=\textwidth
24829 EAPI void elm_flip_go(Evas_Object *obj, Elm_Flip_Mode mode) EINA_ARG_NONNULL(1);
24831 * @brief Set the interactive flip mode
24833 * @param obj The flip object
24834 * @param mode The interactive flip mode to use
24836 * This sets if the flip should be interactive (allow user to click and
24837 * drag a side of the flip to reveal the back page and cause it to flip).
24838 * By default a flip is not interactive. You may also need to set which
24839 * sides of the flip are "active" for flipping and how much space they use
24840 * (a minimum of a finger size) with elm_flip_interacton_direction_enabled_set()
24841 * and elm_flip_interacton_direction_hitsize_set()
24843 * The four avilable mode of interaction are:
24844 * @li ELM_FLIP_INTERACTION_NONE - No interaction is allowed
24845 * @li ELM_FLIP_INTERACTION_ROTATE - Interaction will cause rotate animation
24846 * @li ELM_FLIP_INTERACTION_CUBE - Interaction will cause cube animation
24847 * @li ELM_FLIP_INTERACTION_PAGE - Interaction will cause page animation
24849 * @note ELM_FLIP_INTERACTION_ROTATE won't cause
24850 * ELM_FLIP_ROTATE_XZ_CENTER_AXIS or ELM_FLIP_ROTATE_YZ_CENTER_AXIS to
24851 * happen, those can only be acheived with elm_flip_go();
24853 EAPI void elm_flip_interaction_set(Evas_Object *obj, Elm_Flip_Interaction mode);
24855 * @brief Get the interactive flip mode
24857 * @param obj The flip object
24858 * @return The interactive flip mode
24860 * Returns the interactive flip mode set by elm_flip_interaction_set()
24862 EAPI Elm_Flip_Interaction elm_flip_interaction_get(const Evas_Object *obj);
24864 * @brief Set which directions of the flip respond to interactive flip
24866 * @param obj The flip object
24867 * @param dir The direction to change
24868 * @param enabled If that direction is enabled or not
24870 * By default all directions are disabled, so you may want to enable the
24871 * desired directions for flipping if you need interactive flipping. You must
24872 * call this function once for each direction that should be enabled.
24874 * @see elm_flip_interaction_set()
24876 EAPI void elm_flip_interacton_direction_enabled_set(Evas_Object *obj, Elm_Flip_Direction dir, Eina_Bool enabled);
24878 * @brief Get the enabled state of that flip direction
24880 * @param obj The flip object
24881 * @param dir The direction to check
24882 * @return If that direction is enabled or not
24884 * Gets the enabled state set by elm_flip_interacton_direction_enabled_set()
24886 * @see elm_flip_interaction_set()
24888 EAPI Eina_Bool elm_flip_interacton_direction_enabled_get(Evas_Object *obj, Elm_Flip_Direction dir);
24890 * @brief Set the amount of the flip that is sensitive to interactive flip
24892 * @param obj The flip object
24893 * @param dir The direction to modify
24894 * @param hitsize The amount of that dimension (0.0 to 1.0) to use
24896 * Set the amount of the flip that is sensitive to interactive flip, with 0
24897 * representing no area in the flip and 1 representing the entire flip. There
24898 * is however a consideration to be made in that the area will never be
24899 * smaller than the finger size set(as set in your Elementary configuration).
24901 * @see elm_flip_interaction_set()
24903 EAPI void elm_flip_interacton_direction_hitsize_set(Evas_Object *obj, Elm_Flip_Direction dir, double hitsize);
24905 * @brief Get the amount of the flip that is sensitive to interactive flip
24907 * @param obj The flip object
24908 * @param dir The direction to check
24909 * @return The size set for that direction
24911 * Returns the amount os sensitive area set by
24912 * elm_flip_interacton_direction_hitsize_set().
24914 EAPI double elm_flip_interacton_direction_hitsize_get(Evas_Object *obj, Elm_Flip_Direction dir);
24919 /* scrolledentry */
24920 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24921 EINA_DEPRECATED EAPI void elm_scrolled_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line) EINA_ARG_NONNULL(1);
24922 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_single_line_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24923 EINA_DEPRECATED EAPI void elm_scrolled_entry_password_set(Evas_Object *obj, Eina_Bool password) EINA_ARG_NONNULL(1);
24924 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_password_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24925 EINA_DEPRECATED EAPI void elm_scrolled_entry_entry_set(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
24926 EINA_DEPRECATED EAPI const char *elm_scrolled_entry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24927 EINA_DEPRECATED EAPI void elm_scrolled_entry_entry_append(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
24928 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_is_empty(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24929 EINA_DEPRECATED EAPI const char *elm_scrolled_entry_selection_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24930 EINA_DEPRECATED EAPI void elm_scrolled_entry_entry_insert(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
24931 EINA_DEPRECATED EAPI void elm_scrolled_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
24932 EINA_DEPRECATED EAPI void elm_scrolled_entry_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
24933 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24934 EINA_DEPRECATED EAPI void elm_scrolled_entry_select_none(Evas_Object *obj) EINA_ARG_NONNULL(1);
24935 EINA_DEPRECATED EAPI void elm_scrolled_entry_select_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
24936 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
24937 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
24938 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_up(Evas_Object *obj) EINA_ARG_NONNULL(1);
24939 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_down(Evas_Object *obj) EINA_ARG_NONNULL(1);
24940 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
24941 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
24942 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_line_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
24943 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_line_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
24944 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_selection_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
24945 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_selection_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
24946 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_is_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24947 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_is_visible_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24948 EINA_DEPRECATED EAPI const char *elm_scrolled_entry_cursor_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24949 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_pos_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
24950 EINA_DEPRECATED EAPI int elm_scrolled_entry_cursor_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24951 EINA_DEPRECATED EAPI void elm_scrolled_entry_selection_cut(Evas_Object *obj) EINA_ARG_NONNULL(1);
24952 EINA_DEPRECATED EAPI void elm_scrolled_entry_selection_copy(Evas_Object *obj) EINA_ARG_NONNULL(1);
24953 EINA_DEPRECATED EAPI void elm_scrolled_entry_selection_paste(Evas_Object *obj) EINA_ARG_NONNULL(1);
24954 EINA_DEPRECATED EAPI void elm_scrolled_entry_context_menu_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
24955 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);
24956 EINA_DEPRECATED EAPI void elm_scrolled_entry_context_menu_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
24957 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_context_menu_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24958 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);
24959 EINA_DEPRECATED EAPI void elm_scrolled_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
24960 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);
24961 EINA_DEPRECATED EAPI void elm_scrolled_entry_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1, 2);
24962 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24963 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24964 EINA_DEPRECATED EAPI void elm_scrolled_entry_icon_visible_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
24965 EINA_DEPRECATED EAPI void elm_scrolled_entry_end_set(Evas_Object *obj, Evas_Object *end) EINA_ARG_NONNULL(1, 2);
24966 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_end_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24967 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_end_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24968 EINA_DEPRECATED EAPI void elm_scrolled_entry_end_visible_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
24969 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);
24970 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);
24971 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);
24972 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);
24973 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);
24974 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);
24975 EINA_DEPRECATED EAPI void elm_scrolled_entry_file_set(Evas_Object *obj, const char *file, Elm_Text_Format format) EINA_ARG_NONNULL(1);
24976 EINA_DEPRECATED EAPI void elm_scrolled_entry_file_get(const Evas_Object *obj, const char **file, Elm_Text_Format *format) EINA_ARG_NONNULL(1);
24977 EINA_DEPRECATED EAPI void elm_scrolled_entry_file_save(Evas_Object *obj) EINA_ARG_NONNULL(1);
24978 EINA_DEPRECATED EAPI void elm_scrolled_entry_autosave_set(Evas_Object *obj, Eina_Bool autosave) EINA_ARG_NONNULL(1);
24979 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_autosave_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24980 EINA_DEPRECATED EAPI void elm_scrolled_entry_cnp_textonly_set(Evas_Object *obj, Eina_Bool textonly) EINA_ARG_NONNULL(1);
24981 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cnp_textonly_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
24984 * @defgroup Conformant Conformant
24985 * @ingroup Elementary
24987 * @image html img/widget/conformant/preview-00.png
24988 * @image latex img/widget/conformant/preview-00.eps width=\textwidth
24990 * @image html img/conformant.png
24991 * @image latex img/conformant.eps width=\textwidth
24993 * The aim is to provide a widget that can be used in elementary apps to
24994 * account for space taken up by the indicator, virtual keypad & softkey
24995 * windows when running the illume2 module of E17.
24997 * So conformant content will be sized and positioned considering the
24998 * space required for such stuff, and when they popup, as a keyboard
24999 * shows when an entry is selected, conformant content won't change.
25001 * Available styles for it:
25004 * Default contents parts of the conformant widget that you can use for are:
25005 * @li "default" - A content of the conformant
25007 * See how to use this widget in this example:
25008 * @ref conformant_example
25012 * @addtogroup Conformant
25017 * Add a new conformant widget to the given parent Elementary
25018 * (container) object.
25020 * @param parent The parent object.
25021 * @return A new conformant widget handle or @c NULL, on errors.
25023 * This function inserts a new conformant widget on the canvas.
25025 * @ingroup Conformant
25027 EAPI Evas_Object *elm_conformant_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
25030 * Set the content of the conformant widget.
25032 * @param obj The conformant object.
25033 * @param content The content to be displayed by the conformant.
25035 * Content will be sized and positioned considering the space required
25036 * to display a virtual keyboard. So it won't fill all the conformant
25037 * size. This way is possible to be sure that content won't resize
25038 * or be re-positioned after the keyboard is displayed.
25040 * Once the content object is set, a previously set one will be deleted.
25041 * If you want to keep that old content object, use the
25042 * elm_object_content_unset() function.
25044 * @see elm_object_content_unset()
25045 * @see elm_object_content_get()
25047 * @deprecated use elm_object_content_set() instead
25049 * @ingroup Conformant
25051 EINA_DEPRECATED EAPI void elm_conformant_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
25054 * Get the content of the conformant widget.
25056 * @param obj The conformant object.
25057 * @return The content that is being used.
25059 * Return the content object which is set for this widget.
25060 * It won't be unparent from conformant. For that, use
25061 * elm_object_content_unset().
25063 * @see elm_object_content_set().
25064 * @see elm_object_content_unset()
25066 * @deprecated use elm_object_content_get() instead
25068 * @ingroup Conformant
25070 EINA_DEPRECATED EAPI Evas_Object *elm_conformant_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25073 * Unset the content of the conformant widget.
25075 * @param obj The conformant object.
25076 * @return The content that was being used.
25078 * Unparent and return the content object which was set for this widget.
25080 * @see elm_object_content_set().
25082 * @deprecated use elm_object_content_unset() instead
25084 * @ingroup Conformant
25086 EINA_DEPRECATED EAPI Evas_Object *elm_conformant_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
25089 * Returns the Evas_Object that represents the content area.
25091 * @param obj The conformant object.
25092 * @return The content area of the widget.
25094 * @ingroup Conformant
25096 EAPI Evas_Object *elm_conformant_content_area_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25103 * @defgroup Mapbuf Mapbuf
25104 * @ingroup Elementary
25106 * @image html img/widget/mapbuf/preview-00.png
25107 * @image latex img/widget/mapbuf/preview-00.eps width=\textwidth
25109 * This holds one content object and uses an Evas Map of transformation
25110 * points to be later used with this content. So the content will be
25111 * moved, resized, etc as a single image. So it will improve performance
25112 * when you have a complex interafce, with a lot of elements, and will
25113 * need to resize or move it frequently (the content object and its
25116 * Default contents parts of the mapbuf widget that you can use for are:
25117 * @li "default" - A content of the mapbuf
25119 * To enable map, elm_mapbuf_enabled_set() should be used.
25121 * See how to use this widget in this example:
25122 * @ref mapbuf_example
25126 * @addtogroup Mapbuf
25131 * Add a new mapbuf widget to the given parent Elementary
25132 * (container) object.
25134 * @param parent The parent object.
25135 * @return A new mapbuf widget handle or @c NULL, on errors.
25137 * This function inserts a new mapbuf widget on the canvas.
25141 EAPI Evas_Object *elm_mapbuf_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
25144 * Set the content of the mapbuf.
25146 * @param obj The mapbuf object.
25147 * @param content The content that will be filled in this mapbuf object.
25149 * Once the content object is set, a previously set one will be deleted.
25150 * If you want to keep that old content object, use the
25151 * elm_mapbuf_content_unset() function.
25153 * To enable map, elm_mapbuf_enabled_set() should be used.
25155 * @deprecated use elm_object_content_set() instead
25159 EINA_DEPRECATED EAPI void elm_mapbuf_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
25162 * Get the content of the mapbuf.
25164 * @param obj The mapbuf object.
25165 * @return The content that is being used.
25167 * Return the content object which is set for this widget.
25169 * @see elm_mapbuf_content_set() for details.
25171 * @deprecated use elm_object_content_get() instead
25175 EINA_DEPRECATED EAPI Evas_Object *elm_mapbuf_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25178 * Unset the content of the mapbuf.
25180 * @param obj The mapbuf object.
25181 * @return The content that was being used.
25183 * Unparent and return the content object which was set for this widget.
25185 * @see elm_mapbuf_content_set() for details.
25187 * @deprecated use elm_object_content_unset() instead
25191 EINA_DEPRECATED EAPI Evas_Object *elm_mapbuf_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
25194 * Enable or disable the map.
25196 * @param obj The mapbuf object.
25197 * @param enabled @c EINA_TRUE to enable map or @c EINA_FALSE to disable it.
25199 * This enables the map that is set or disables it. On enable, the object
25200 * geometry will be saved, and the new geometry will change (position and
25201 * size) to reflect the map geometry set.
25203 * Also, when enabled, alpha and smooth states will be used, so if the
25204 * content isn't solid, alpha should be enabled, for example, otherwise
25205 * a black retangle will fill the content.
25207 * When disabled, the stored map will be freed and geometry prior to
25208 * enabling the map will be restored.
25210 * It's disabled by default.
25212 * @see elm_mapbuf_alpha_set()
25213 * @see elm_mapbuf_smooth_set()
25217 EAPI void elm_mapbuf_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
25220 * Get a value whether map is enabled or not.
25222 * @param obj The mapbuf object.
25223 * @return @c EINA_TRUE means map is enabled. @c EINA_FALSE indicates
25224 * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
25226 * @see elm_mapbuf_enabled_set() for details.
25230 EAPI Eina_Bool elm_mapbuf_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25233 * Enable or disable smooth map rendering.
25235 * @param obj The mapbuf object.
25236 * @param smooth @c EINA_TRUE to enable smooth map rendering or @c EINA_FALSE
25239 * This sets smoothing for map rendering. If the object is a type that has
25240 * its own smoothing settings, then both the smooth settings for this object
25241 * and the map must be turned off.
25243 * By default smooth maps are enabled.
25247 EAPI void elm_mapbuf_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
25250 * Get a value whether smooth map rendering is enabled or not.
25252 * @param obj The mapbuf object.
25253 * @return @c EINA_TRUE means smooth map rendering is enabled. @c EINA_FALSE
25254 * indicates it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
25256 * @see elm_mapbuf_smooth_set() for details.
25260 EAPI Eina_Bool elm_mapbuf_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25263 * Set or unset alpha flag for map rendering.
25265 * @param obj The mapbuf object.
25266 * @param alpha @c EINA_TRUE to enable alpha blending or @c EINA_FALSE
25269 * This sets alpha flag for map rendering. If the object is a type that has
25270 * its own alpha settings, then this will take precedence. Only image objects
25271 * have this currently. It stops alpha blending of the map area, and is
25272 * useful if you know the object and/or all sub-objects is 100% solid.
25274 * Alpha is enabled by default.
25278 EAPI void elm_mapbuf_alpha_set(Evas_Object *obj, Eina_Bool alpha) EINA_ARG_NONNULL(1);
25281 * Get a value whether alpha blending is enabled or not.
25283 * @param obj The mapbuf object.
25284 * @return @c EINA_TRUE means alpha blending is enabled. @c EINA_FALSE
25285 * indicates it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
25287 * @see elm_mapbuf_alpha_set() for details.
25291 EAPI Eina_Bool elm_mapbuf_alpha_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25298 * @defgroup Flipselector Flip Selector
25300 * @image html img/widget/flipselector/preview-00.png
25301 * @image latex img/widget/flipselector/preview-00.eps
25303 * A flip selector is a widget to show a set of @b text items, one
25304 * at a time, with the same sheet switching style as the @ref Clock
25305 * "clock" widget, when one changes the current displaying sheet
25306 * (thus, the "flip" in the name).
25308 * User clicks to flip sheets which are @b held for some time will
25309 * make the flip selector to flip continuosly and automatically for
25310 * the user. The interval between flips will keep growing in time,
25311 * so that it helps the user to reach an item which is distant from
25312 * the current selection.
25314 * Smart callbacks one can register to:
25315 * - @c "selected" - when the widget's selected text item is changed
25316 * - @c "overflowed" - when the widget's current selection is changed
25317 * from the first item in its list to the last
25318 * - @c "underflowed" - when the widget's current selection is changed
25319 * from the last item in its list to the first
25321 * Available styles for it:
25324 * To set/get the label of the flipselector item, you can use
25325 * elm_object_item_text_set/get APIs.
25326 * Once the text is set, a previously set one will be deleted.
25328 * Here is an example on its usage:
25329 * @li @ref flipselector_example
25333 * @addtogroup Flipselector
25338 * Add a new flip selector widget to the given parent Elementary
25339 * (container) widget
25341 * @param parent The parent object
25342 * @return a new flip selector widget handle or @c NULL, on errors
25344 * This function inserts a new flip selector widget on the canvas.
25346 * @ingroup Flipselector
25348 EAPI Evas_Object *elm_flipselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
25351 * Programmatically select the next item of a flip selector widget
25353 * @param obj The flipselector object
25355 * @note The selection will be animated. Also, if it reaches the
25356 * end of its list of member items, it will continue with the first
25359 * @ingroup Flipselector
25361 EAPI void elm_flipselector_flip_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
25364 * Programmatically select the previous item of a flip selector
25367 * @param obj The flipselector object
25369 * @note The selection will be animated. Also, if it reaches the
25370 * beginning of its list of member items, it will continue with the
25371 * last one backwards.
25373 * @ingroup Flipselector
25375 EAPI void elm_flipselector_flip_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
25378 * Append a (text) item to a flip selector widget
25380 * @param obj The flipselector object
25381 * @param label The (text) label of the new item
25382 * @param func Convenience callback function to take place when
25384 * @param data Data passed to @p func, above
25385 * @return A handle to the item added or @c NULL, on errors
25387 * The widget's list of labels to show will be appended with the
25388 * given value. If the user wishes so, a callback function pointer
25389 * can be passed, which will get called when this same item is
25392 * @note The current selection @b won't be modified by appending an
25393 * element to the list.
25395 * @note The maximum length of the text label is going to be
25396 * determined <b>by the widget's theme</b>. Strings larger than
25397 * that value are going to be @b truncated.
25399 * @ingroup Flipselector
25401 EAPI Elm_Object_Item *elm_flipselector_item_append(Evas_Object *obj, const char *label, Evas_Smart_Cb func, void *data) EINA_ARG_NONNULL(1);
25404 * Prepend a (text) item to a flip selector widget
25406 * @param obj The flipselector object
25407 * @param label The (text) label of the new item
25408 * @param func Convenience callback function to take place when
25410 * @param data Data passed to @p func, above
25411 * @return A handle to the item added or @c NULL, on errors
25413 * The widget's list of labels to show will be prepended with the
25414 * given value. If the user wishes so, a callback function pointer
25415 * can be passed, which will get called when this same item is
25418 * @note The current selection @b won't be modified by prepending
25419 * an element to the list.
25421 * @note The maximum length of the text label is going to be
25422 * determined <b>by the widget's theme</b>. Strings larger than
25423 * that value are going to be @b truncated.
25425 * @ingroup Flipselector
25427 EAPI Elm_Object_Item *elm_flipselector_item_prepend(Evas_Object *obj, const char *label, Evas_Smart_Cb func, void *data) EINA_ARG_NONNULL(1);
25430 * Get the internal list of items in a given flip selector widget.
25432 * @param obj The flipselector object
25433 * @return The list of items (#Elm_Object_Item as data) or
25434 * @c NULL on errors.
25436 * This list is @b not to be modified in any way and must not be
25437 * freed. Use the list members with functions like
25438 * elm_object_item_text_set(),
25439 * elm_object_item_text_get(),
25440 * elm_flipselector_item_del(),
25441 * elm_flipselector_item_selected_get(),
25442 * elm_flipselector_item_selected_set().
25444 * @warning This list is only valid until @p obj object's internal
25445 * items list is changed. It should be fetched again with another
25446 * call to this function when changes happen.
25448 * @ingroup Flipselector
25450 EAPI const Eina_List *elm_flipselector_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25453 * Get the first item in the given flip selector widget's list of
25456 * @param obj The flipselector object
25457 * @return The first item or @c NULL, if it has no items (and on
25460 * @see elm_flipselector_item_append()
25461 * @see elm_flipselector_last_item_get()
25463 * @ingroup Flipselector
25465 EAPI Elm_Object_Item *elm_flipselector_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25468 * Get the last item in the given flip selector widget's list of
25471 * @param obj The flipselector object
25472 * @return The last item or @c NULL, if it has no items (and on
25475 * @see elm_flipselector_item_prepend()
25476 * @see elm_flipselector_first_item_get()
25478 * @ingroup Flipselector
25480 EAPI Elm_Object_Item *elm_flipselector_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25483 * Get the currently selected item in a flip selector widget.
25485 * @param obj The flipselector object
25486 * @return The selected item or @c NULL, if the widget has no items
25489 * @ingroup Flipselector
25491 EAPI Elm_Object_Item *elm_flipselector_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25494 * Set whether a given flip selector widget's item should be the
25495 * currently selected one.
25497 * @param it The flip selector item
25498 * @param selected @c EINA_TRUE to select it, @c EINA_FALSE to unselect.
25500 * This sets whether @p item is or not the selected (thus, under
25501 * display) one. If @p item is different than one under display,
25502 * the latter will be unselected. If the @p item is set to be
25503 * unselected, on the other hand, the @b first item in the widget's
25504 * internal members list will be the new selected one.
25506 * @see elm_flipselector_item_selected_get()
25508 * @ingroup Flipselector
25510 EAPI void elm_flipselector_item_selected_set(Elm_Object_Item *it, Eina_Bool selected) EINA_ARG_NONNULL(1);
25513 * Get whether a given flip selector widget's item is the currently
25516 * @param it The flip selector item
25517 * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
25520 * @see elm_flipselector_item_selected_set()
25522 * @ingroup Flipselector
25524 EAPI Eina_Bool elm_flipselector_item_selected_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
25527 * Delete a given item from a flip selector widget.
25529 * @param it The item to delete
25531 * @ingroup Flipselector
25533 EAPI void elm_flipselector_item_del(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
25536 * Get the label of a given flip selector widget's item.
25538 * @param it The item to get label from
25539 * @return The text label of @p item or @c NULL, on errors
25541 * @see elm_object_item_text_set()
25543 * @deprecated see elm_object_item_text_get() instead
25544 * @ingroup Flipselector
25546 EINA_DEPRECATED EAPI const char *elm_flipselector_item_label_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
25549 * Set the label of a given flip selector widget's item.
25551 * @param it The item to set label on
25552 * @param label The text label string, in UTF-8 encoding
25554 * @see elm_object_item_text_get()
25556 * @deprecated see elm_object_item_text_set() instead
25557 * @ingroup Flipselector
25559 EINA_DEPRECATED EAPI void elm_flipselector_item_label_set(Elm_Object_Item *it, const char *label) EINA_ARG_NONNULL(1);
25562 * Gets the item before @p item in a flip selector widget's
25563 * internal list of items.
25565 * @param it The item to fetch previous from
25566 * @return The item before the @p item, in its parent's list. If
25567 * there is no previous item for @p item or there's an
25568 * error, @c NULL is returned.
25570 * @see elm_flipselector_item_next_get()
25572 * @ingroup Flipselector
25574 EAPI Elm_Object_Item *elm_flipselector_item_prev_get(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
25577 * Gets the item after @p item in a flip selector widget's
25578 * internal list of items.
25580 * @param it The item to fetch next from
25581 * @return The item after the @p item, in its parent's list. If
25582 * there is no next item for @p item or there's an
25583 * error, @c NULL is returned.
25585 * @see elm_flipselector_item_next_get()
25587 * @ingroup Flipselector
25589 EAPI Elm_Object_Item *elm_flipselector_item_next_get(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
25592 * Set the interval on time updates for an user mouse button hold
25593 * on a flip selector widget.
25595 * @param obj The flip selector object
25596 * @param interval The (first) interval value in seconds
25598 * This interval value is @b decreased while the user holds the
25599 * mouse pointer either flipping up or flipping doww a given flip
25602 * This helps the user to get to a given item distant from the
25603 * current one easier/faster, as it will start to flip quicker and
25604 * quicker on mouse button holds.
25606 * The calculation for the next flip interval value, starting from
25607 * the one set with this call, is the previous interval divided by
25608 * 1.05, so it decreases a little bit.
25610 * The default starting interval value for automatic flips is
25613 * @see elm_flipselector_interval_get()
25615 * @ingroup Flipselector
25617 EAPI void elm_flipselector_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
25620 * Get the interval on time updates for an user mouse button hold
25621 * on a flip selector widget.
25623 * @param obj The flip selector object
25624 * @return The (first) interval value, in seconds, set on it
25626 * @see elm_flipselector_interval_set() for more details
25628 * @ingroup Flipselector
25630 EAPI double elm_flipselector_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25636 * @addtogroup Calendar
25641 * @enum _Elm_Calendar_Mark_Repeat
25642 * @typedef Elm_Calendar_Mark_Repeat
25644 * Event periodicity, used to define if a mark should be repeated
25645 * @b beyond event's day. It's set when a mark is added.
25647 * So, for a mark added to 13th May with periodicity set to WEEKLY,
25648 * there will be marks every week after this date. Marks will be displayed
25649 * at 13th, 20th, 27th, 3rd June ...
25651 * Values don't work as bitmask, only one can be choosen.
25653 * @see elm_calendar_mark_add()
25655 * @ingroup Calendar
25657 typedef enum _Elm_Calendar_Mark_Repeat
25659 ELM_CALENDAR_UNIQUE, /**< Default value. Marks will be displayed only on event day. */
25660 ELM_CALENDAR_DAILY, /**< Marks will be displayed everyday after event day (inclusive). */
25661 ELM_CALENDAR_WEEKLY, /**< Marks will be displayed every week after event day (inclusive) - i.e. each seven days. */
25662 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*/
25663 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. */
25664 } Elm_Calendar_Mark_Repeat;
25666 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(). */
25669 * Add a new calendar widget to the given parent Elementary
25670 * (container) object.
25672 * @param parent The parent object.
25673 * @return a new calendar widget handle or @c NULL, on errors.
25675 * This function inserts a new calendar widget on the canvas.
25677 * @ref calendar_example_01
25679 * @ingroup Calendar
25681 EAPI Evas_Object *elm_calendar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
25684 * Get weekdays names displayed by the calendar.
25686 * @param obj The calendar object.
25687 * @return Array of seven strings to be used as weekday names.
25689 * By default, weekdays abbreviations get from system are displayed:
25690 * E.g. for an en_US locale: "Sun, Mon, Tue, Wed, Thu, Fri, Sat"
25691 * The first string is related to Sunday, the second to Monday...
25693 * @see elm_calendar_weekdays_name_set()
25695 * @ref calendar_example_05
25697 * @ingroup Calendar
25699 EAPI const char **elm_calendar_weekdays_names_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25702 * Set weekdays names to be displayed by the calendar.
25704 * @param obj The calendar object.
25705 * @param weekdays Array of seven strings to be used as weekday names.
25706 * @warning It must have 7 elements, or it will access invalid memory.
25707 * @warning The strings must be NULL terminated ('@\0').
25709 * By default, weekdays abbreviations get from system are displayed:
25710 * E.g. for an en_US locale: "Sun, Mon, Tue, Wed, Thu, Fri, Sat"
25712 * The first string should be related to Sunday, the second to Monday...
25714 * The usage should be like this:
25716 * const char *weekdays[] =
25718 * "Sunday", "Monday", "Tuesday", "Wednesday",
25719 * "Thursday", "Friday", "Saturday"
25721 * elm_calendar_weekdays_names_set(calendar, weekdays);
25724 * @see elm_calendar_weekdays_name_get()
25726 * @ref calendar_example_02
25728 * @ingroup Calendar
25730 EAPI void elm_calendar_weekdays_names_set(Evas_Object *obj, const char *weekdays[]) EINA_ARG_NONNULL(1, 2);
25733 * Set the minimum and maximum values for the year
25735 * @param obj The calendar object
25736 * @param min The minimum year, greater than 1901;
25737 * @param max The maximum year;
25739 * Maximum must be greater than minimum, except if you don't wan't to set
25741 * Default values are 1902 and -1.
25743 * If the maximum year is a negative value, it will be limited depending
25744 * on the platform architecture (year 2037 for 32 bits);
25746 * @see elm_calendar_min_max_year_get()
25748 * @ref calendar_example_03
25750 * @ingroup Calendar
25752 EAPI void elm_calendar_min_max_year_set(Evas_Object *obj, int min, int max) EINA_ARG_NONNULL(1);
25755 * Get the minimum and maximum values for the year
25757 * @param obj The calendar object.
25758 * @param min The minimum year.
25759 * @param max The maximum year.
25761 * Default values are 1902 and -1.
25763 * @see elm_calendar_min_max_year_get() for more details.
25765 * @ref calendar_example_05
25767 * @ingroup Calendar
25769 EAPI void elm_calendar_min_max_year_get(const Evas_Object *obj, int *min, int *max) EINA_ARG_NONNULL(1);
25772 * Enable or disable day selection
25774 * @param obj The calendar object.
25775 * @param enabled @c EINA_TRUE to enable selection or @c EINA_FALSE to
25778 * Enabled by default. If disabled, the user still can select months,
25779 * but not days. Selected days are highlighted on calendar.
25780 * It should be used if you won't need such selection for the widget usage.
25782 * When a day is selected, or month is changed, smart callbacks for
25783 * signal "changed" will be called.
25785 * @see elm_calendar_day_selection_enable_get()
25787 * @ref calendar_example_04
25789 * @ingroup Calendar
25791 EAPI void elm_calendar_day_selection_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
25794 * Get a value whether day selection is enabled or not.
25796 * @see elm_calendar_day_selection_enable_set() for details.
25798 * @param obj The calendar object.
25799 * @return EINA_TRUE means day selection is enabled. EINA_FALSE indicates
25800 * it's disabled. If @p obj is NULL, EINA_FALSE is returned.
25802 * @ref calendar_example_05
25804 * @ingroup Calendar
25806 EAPI Eina_Bool elm_calendar_day_selection_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25810 * Set selected date to be highlighted on calendar.
25812 * @param obj The calendar object.
25813 * @param selected_time A @b tm struct to represent the selected date.
25815 * Set the selected date, changing the displayed month if needed.
25816 * Selected date changes when the user goes to next/previous month or
25817 * select a day pressing over it on calendar.
25819 * @see elm_calendar_selected_time_get()
25821 * @ref calendar_example_04
25823 * @ingroup Calendar
25825 EAPI void elm_calendar_selected_time_set(Evas_Object *obj, struct tm *selected_time) EINA_ARG_NONNULL(1);
25828 * Get selected date.
25830 * @param obj The calendar object
25831 * @param selected_time A @b tm struct to point to selected date
25832 * @return EINA_FALSE means an error ocurred and returned time shouldn't
25835 * Get date selected by the user or set by function
25836 * elm_calendar_selected_time_set().
25837 * Selected date changes when the user goes to next/previous month or
25838 * select a day pressing over it on calendar.
25840 * @see elm_calendar_selected_time_get()
25842 * @ref calendar_example_05
25844 * @ingroup Calendar
25846 EAPI Eina_Bool elm_calendar_selected_time_get(const Evas_Object *obj, struct tm *selected_time) EINA_ARG_NONNULL(1, 2);
25849 * Set a function to format the string that will be used to display
25852 * @param obj The calendar object
25853 * @param format_function Function to set the month-year string given
25854 * the selected date
25856 * By default it uses strftime with "%B %Y" format string.
25857 * It should allocate the memory that will be used by the string,
25858 * that will be freed by the widget after usage.
25859 * A pointer to the string and a pointer to the time struct will be provided.
25864 * _format_month_year(struct tm *selected_time)
25867 * if (!strftime(buf, sizeof(buf), "%B %Y", selected_time)) return NULL;
25868 * return strdup(buf);
25871 * elm_calendar_format_function_set(calendar, _format_month_year);
25874 * @ref calendar_example_02
25876 * @ingroup Calendar
25878 EAPI void elm_calendar_format_function_set(Evas_Object *obj, char * (*format_function) (struct tm *stime)) EINA_ARG_NONNULL(1);
25881 * Add a new mark to the calendar
25883 * @param obj The calendar object
25884 * @param mark_type A string used to define the type of mark. It will be
25885 * emitted to the theme, that should display a related modification on these
25886 * days representation.
25887 * @param mark_time A time struct to represent the date of inclusion of the
25888 * mark. For marks that repeats it will just be displayed after the inclusion
25889 * date in the calendar.
25890 * @param repeat Repeat the event following this periodicity. Can be a unique
25891 * mark (that don't repeat), daily, weekly, monthly or annually.
25892 * @return The created mark or @p NULL upon failure.
25894 * Add a mark that will be drawn in the calendar respecting the insertion
25895 * time and periodicity. It will emit the type as signal to the widget theme.
25896 * Default theme supports "holiday" and "checked", but it can be extended.
25898 * It won't immediately update the calendar, drawing the marks.
25899 * For this, call elm_calendar_marks_draw(). However, when user selects
25900 * next or previous month calendar forces marks drawn.
25902 * Marks created with this method can be deleted with
25903 * elm_calendar_mark_del().
25907 * struct tm selected_time;
25908 * time_t current_time;
25910 * current_time = time(NULL) + 5 * 84600;
25911 * localtime_r(¤t_time, &selected_time);
25912 * elm_calendar_mark_add(cal, "holiday", selected_time,
25913 * ELM_CALENDAR_ANNUALLY);
25915 * current_time = time(NULL) + 1 * 84600;
25916 * localtime_r(¤t_time, &selected_time);
25917 * elm_calendar_mark_add(cal, "checked", selected_time, ELM_CALENDAR_UNIQUE);
25919 * elm_calendar_marks_draw(cal);
25922 * @see elm_calendar_marks_draw()
25923 * @see elm_calendar_mark_del()
25925 * @ref calendar_example_06
25927 * @ingroup Calendar
25929 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);
25932 * Delete mark from the calendar.
25934 * @param mark The mark to be deleted.
25936 * If deleting all calendar marks is required, elm_calendar_marks_clear()
25937 * should be used instead of getting marks list and deleting each one.
25939 * @see elm_calendar_mark_add()
25941 * @ref calendar_example_06
25943 * @ingroup Calendar
25945 EAPI void elm_calendar_mark_del(Elm_Calendar_Mark *mark) EINA_ARG_NONNULL(1);
25948 * Remove all calendar's marks
25950 * @param obj The calendar object.
25952 * @see elm_calendar_mark_add()
25953 * @see elm_calendar_mark_del()
25955 * @ingroup Calendar
25957 EAPI void elm_calendar_marks_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
25961 * Get a list of all the calendar marks.
25963 * @param obj The calendar object.
25964 * @return An @c Eina_List of calendar marks objects, or @c NULL on failure.
25966 * @see elm_calendar_mark_add()
25967 * @see elm_calendar_mark_del()
25968 * @see elm_calendar_marks_clear()
25970 * @ingroup Calendar
25972 EAPI const Eina_List *elm_calendar_marks_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25975 * Draw calendar marks.
25977 * @param obj The calendar object.
25979 * Should be used after adding, removing or clearing marks.
25980 * It will go through the entire marks list updating the calendar.
25981 * If lots of marks will be added, add all the marks and then call
25984 * When the month is changed, i.e. user selects next or previous month,
25985 * marks will be drawed.
25987 * @see elm_calendar_mark_add()
25988 * @see elm_calendar_mark_del()
25989 * @see elm_calendar_marks_clear()
25991 * @ref calendar_example_06
25993 * @ingroup Calendar
25995 EAPI void elm_calendar_marks_draw(Evas_Object *obj) EINA_ARG_NONNULL(1);
25998 * Set a day text color to the same that represents Saturdays.
26000 * @param obj The calendar object.
26001 * @param pos The text position. Position is the cell counter, from left
26002 * to right, up to down. It starts on 0 and ends on 41.
26004 * @deprecated use elm_calendar_mark_add() instead like:
26007 * struct tm t = { 0, 0, 12, 6, 0, 0, 6, 6, -1 };
26008 * elm_calendar_mark_add(obj, "sat", &t, ELM_CALENDAR_WEEKLY);
26011 * @see elm_calendar_mark_add()
26013 * @ingroup Calendar
26015 EINA_DEPRECATED EAPI void elm_calendar_text_saturday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
26018 * Set a day text color to the same that represents Sundays.
26020 * @param obj The calendar object.
26021 * @param pos The text position. Position is the cell counter, from left
26022 * to right, up to down. It starts on 0 and ends on 41.
26024 * @deprecated use elm_calendar_mark_add() instead like:
26027 * struct tm t = { 0, 0, 12, 7, 0, 0, 0, 0, -1 };
26028 * elm_calendar_mark_add(obj, "sat", &t, ELM_CALENDAR_WEEKLY);
26031 * @see elm_calendar_mark_add()
26033 * @ingroup Calendar
26035 EINA_DEPRECATED EAPI void elm_calendar_text_sunday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
26038 * Set a day text color to the same that represents Weekdays.
26040 * @param obj The calendar object
26041 * @param pos The text position. Position is the cell counter, from left
26042 * to right, up to down. It starts on 0 and ends on 41.
26044 * @deprecated use elm_calendar_mark_add() instead like:
26047 * struct tm t = { 0, 0, 12, 1, 0, 0, 0, 0, -1 };
26049 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // monday
26050 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
26051 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // tuesday
26052 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
26053 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // wednesday
26054 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
26055 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // thursday
26056 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
26057 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // friday
26060 * @see elm_calendar_mark_add()
26062 * @ingroup Calendar
26064 EINA_DEPRECATED EAPI void elm_calendar_text_weekday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
26067 * Set the interval on time updates for an user mouse button hold
26068 * on calendar widgets' month selection.
26070 * @param obj The calendar object
26071 * @param interval The (first) interval value in seconds
26073 * This interval value is @b decreased while the user holds the
26074 * mouse pointer either selecting next or previous month.
26076 * This helps the user to get to a given month distant from the
26077 * current one easier/faster, as it will start to change quicker and
26078 * quicker on mouse button holds.
26080 * The calculation for the next change interval value, starting from
26081 * the one set with this call, is the previous interval divided by
26082 * 1.05, so it decreases a little bit.
26084 * The default starting interval value for automatic changes is
26087 * @see elm_calendar_interval_get()
26089 * @ingroup Calendar
26091 EAPI void elm_calendar_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
26094 * Get the interval on time updates for an user mouse button hold
26095 * on calendar widgets' month selection.
26097 * @param obj The calendar object
26098 * @return The (first) interval value, in seconds, set on it
26100 * @see elm_calendar_interval_set() for more details
26102 * @ingroup Calendar
26104 EAPI double elm_calendar_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26111 * @defgroup Diskselector Diskselector
26112 * @ingroup Elementary
26114 * @image html img/widget/diskselector/preview-00.png
26115 * @image latex img/widget/diskselector/preview-00.eps
26117 * A diskselector is a kind of list widget. It scrolls horizontally,
26118 * and can contain label and icon objects. Three items are displayed
26119 * with the selected one in the middle.
26121 * It can act like a circular list with round mode and labels can be
26122 * reduced for a defined length for side items.
26124 * Smart callbacks one can listen to:
26125 * - "selected" - when item is selected, i.e. scroller stops.
26127 * Available styles for it:
26130 * List of examples:
26131 * @li @ref diskselector_example_01
26132 * @li @ref diskselector_example_02
26136 * @addtogroup Diskselector
26140 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(). */
26143 * Add a new diskselector widget to the given parent Elementary
26144 * (container) object.
26146 * @param parent The parent object.
26147 * @return a new diskselector widget handle or @c NULL, on errors.
26149 * This function inserts a new diskselector widget on the canvas.
26151 * @ingroup Diskselector
26153 EAPI Evas_Object *elm_diskselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
26156 * Enable or disable round mode.
26158 * @param obj The diskselector object.
26159 * @param round @c EINA_TRUE to enable round mode or @c EINA_FALSE to
26162 * Disabled by default. If round mode is enabled the items list will
26163 * work like a circle list, so when the user reaches the last item,
26164 * the first one will popup.
26166 * @see elm_diskselector_round_get()
26168 * @ingroup Diskselector
26170 EAPI void elm_diskselector_round_set(Evas_Object *obj, Eina_Bool round) EINA_ARG_NONNULL(1);
26173 * Get a value whether round mode is enabled or not.
26175 * @see elm_diskselector_round_set() for details.
26177 * @param obj The diskselector object.
26178 * @return @c EINA_TRUE means round mode is enabled. @c EINA_FALSE indicates
26179 * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
26181 * @ingroup Diskselector
26183 EAPI Eina_Bool elm_diskselector_round_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26186 * Get the side labels max length.
26188 * @deprecated use elm_diskselector_side_label_length_get() instead:
26190 * @param obj The diskselector object.
26191 * @return The max length defined for side labels, or 0 if not a valid
26194 * @ingroup Diskselector
26196 EINA_DEPRECATED EAPI int elm_diskselector_side_label_lenght_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26199 * Set the side labels max length.
26201 * @deprecated use elm_diskselector_side_label_length_set() instead:
26203 * @param obj The diskselector object.
26204 * @param len The max length defined for side labels.
26206 * @ingroup Diskselector
26208 EINA_DEPRECATED EAPI void elm_diskselector_side_label_lenght_set(Evas_Object *obj, int len) EINA_ARG_NONNULL(1);
26211 * Get the side labels max length.
26213 * @see elm_diskselector_side_label_length_set() for details.
26215 * @param obj The diskselector object.
26216 * @return The max length defined for side labels, or 0 if not a valid
26219 * @ingroup Diskselector
26221 EAPI int elm_diskselector_side_label_length_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26224 * Set the side labels max length.
26226 * @param obj The diskselector object.
26227 * @param len The max length defined for side labels.
26229 * Length is the number of characters of items' label that will be
26230 * visible when it's set on side positions. It will just crop
26231 * the string after defined size. E.g.:
26233 * An item with label "January" would be displayed on side position as
26234 * "Jan" if max length is set to 3, or "Janu", if this property
26237 * When it's selected, the entire label will be displayed, except for
26238 * width restrictions. In this case label will be cropped and "..."
26239 * will be concatenated.
26241 * Default side label max length is 3.
26243 * This property will be applyed over all items, included before or
26244 * later this function call.
26246 * @ingroup Diskselector
26248 EAPI void elm_diskselector_side_label_length_set(Evas_Object *obj, int len) EINA_ARG_NONNULL(1);
26251 * Set the number of items to be displayed.
26253 * @param obj The diskselector object.
26254 * @param num The number of items the diskselector will display.
26256 * Default value is 3, and also it's the minimun. If @p num is less
26257 * than 3, it will be set to 3.
26259 * Also, it can be set on theme, using data item @c display_item_num
26260 * on group "elm/diskselector/item/X", where X is style set.
26263 * group { name: "elm/diskselector/item/X";
26265 * item: "display_item_num" "5";
26268 * @ingroup Diskselector
26270 EAPI void elm_diskselector_display_item_num_set(Evas_Object *obj, int num) EINA_ARG_NONNULL(1);
26273 * Get the number of items in the diskselector object.
26275 * @param obj The diskselector object.
26277 * @ingroup Diskselector
26279 EAPI int elm_diskselector_display_item_num_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26282 * Set bouncing behaviour when the scrolled content reaches an edge.
26284 * Tell the internal scroller object whether it should bounce or not
26285 * when it reaches the respective edges for each axis.
26287 * @param obj The diskselector object.
26288 * @param h_bounce Whether to bounce or not in the horizontal axis.
26289 * @param v_bounce Whether to bounce or not in the vertical axis.
26291 * @see elm_scroller_bounce_set()
26293 * @ingroup Diskselector
26295 EAPI void elm_diskselector_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
26298 * Get the bouncing behaviour of the internal scroller.
26300 * Get whether the internal scroller should bounce when the edge of each
26301 * axis is reached scrolling.
26303 * @param obj The diskselector object.
26304 * @param h_bounce Pointer where to store the bounce state of the horizontal
26306 * @param v_bounce Pointer where to store the bounce state of the vertical
26309 * @see elm_scroller_bounce_get()
26310 * @see elm_diskselector_bounce_set()
26312 * @ingroup Diskselector
26314 EAPI void elm_diskselector_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
26317 * Get the scrollbar policy.
26319 * @see elm_diskselector_scroller_policy_get() for details.
26321 * @param obj The diskselector object.
26322 * @param policy_h Pointer where to store horizontal scrollbar policy.
26323 * @param policy_v Pointer where to store vertical scrollbar policy.
26325 * @ingroup Diskselector
26327 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);
26330 * Set the scrollbar policy.
26332 * @param obj The diskselector object.
26333 * @param policy_h Horizontal scrollbar policy.
26334 * @param policy_v Vertical scrollbar policy.
26336 * This sets the scrollbar visibility policy for the given scroller.
26337 * #ELM_SCROLLER_POLICY_AUTO means the scrollbar is made visible if it
26338 * is needed, and otherwise kept hidden. #ELM_SCROLLER_POLICY_ON turns
26339 * it on all the time, and #ELM_SCROLLER_POLICY_OFF always keeps it off.
26340 * This applies respectively for the horizontal and vertical scrollbars.
26342 * The both are disabled by default, i.e., are set to
26343 * #ELM_SCROLLER_POLICY_OFF.
26345 * @ingroup Diskselector
26347 EAPI void elm_diskselector_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
26350 * Remove all diskselector's items.
26352 * @param obj The diskselector object.
26354 * @see elm_diskselector_item_del()
26355 * @see elm_diskselector_item_append()
26357 * @ingroup Diskselector
26359 EAPI void elm_diskselector_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
26362 * Get a list of all the diskselector items.
26364 * @param obj The diskselector object.
26365 * @return An @c Eina_List of diskselector items, #Elm_Diskselector_Item,
26366 * or @c NULL on failure.
26368 * @see elm_diskselector_item_append()
26369 * @see elm_diskselector_item_del()
26370 * @see elm_diskselector_clear()
26372 * @ingroup Diskselector
26374 EAPI const Eina_List *elm_diskselector_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26377 * Appends a new item to the diskselector object.
26379 * @param obj The diskselector object.
26380 * @param label The label of the diskselector item.
26381 * @param icon The icon object to use at left side of the item. An
26382 * icon can be any Evas object, but usually it is an icon created
26383 * with elm_icon_add().
26384 * @param func The function to call when the item is selected.
26385 * @param data The data to associate with the item for related callbacks.
26387 * @return The created item or @c NULL upon failure.
26389 * A new item will be created and appended to the diskselector, i.e., will
26390 * be set as last item. Also, if there is no selected item, it will
26391 * be selected. This will always happens for the first appended item.
26393 * If no icon is set, label will be centered on item position, otherwise
26394 * the icon will be placed at left of the label, that will be shifted
26397 * Items created with this method can be deleted with
26398 * elm_diskselector_item_del().
26400 * Associated @p data can be properly freed when item is deleted if a
26401 * callback function is set with elm_diskselector_item_del_cb_set().
26403 * If a function is passed as argument, it will be called everytime this item
26404 * is selected, i.e., the user stops the diskselector with this
26405 * item on center position. If such function isn't needed, just passing
26406 * @c NULL as @p func is enough. The same should be done for @p data.
26408 * Simple example (with no function callback or data associated):
26410 * disk = elm_diskselector_add(win);
26411 * ic = elm_icon_add(win);
26412 * elm_icon_file_set(ic, "path/to/image", NULL);
26413 * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
26414 * elm_diskselector_item_append(disk, "label", ic, NULL, NULL);
26417 * @see elm_diskselector_item_del()
26418 * @see elm_diskselector_item_del_cb_set()
26419 * @see elm_diskselector_clear()
26420 * @see elm_icon_add()
26422 * @ingroup Diskselector
26424 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);
26428 * Delete them item from the diskselector.
26430 * @param it The item of diskselector to be deleted.
26432 * If deleting all diskselector items is required, elm_diskselector_clear()
26433 * should be used instead of getting items list and deleting each one.
26435 * @see elm_diskselector_clear()
26436 * @see elm_diskselector_item_append()
26437 * @see elm_diskselector_item_del_cb_set()
26439 * @ingroup Diskselector
26441 EAPI void elm_diskselector_item_del(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26444 * Set the function called when a diskselector item is freed.
26446 * @param it The item to set the callback on
26447 * @param func The function called
26449 * If there is a @p func, then it will be called prior item's memory release.
26450 * That will be called with the following arguments:
26452 * @li item's Evas object;
26455 * This way, a data associated to a diskselector item could be properly
26458 * @ingroup Diskselector
26460 EAPI void elm_diskselector_item_del_cb_set(Elm_Diskselector_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
26463 * Get the data associated to the item.
26465 * @param it The diskselector item
26466 * @return The data associated to @p it
26468 * The return value is a pointer to data associated to @p item when it was
26469 * created, with function elm_diskselector_item_append(). If no data
26470 * was passed as argument, it will return @c NULL.
26472 * @see elm_diskselector_item_append()
26474 * @ingroup Diskselector
26476 EAPI void *elm_diskselector_item_data_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26479 * Set the icon associated to the item.
26481 * @param it The diskselector item
26482 * @param icon The icon object to associate with @p it
26484 * The icon object to use at left side of the item. An
26485 * icon can be any Evas object, but usually it is an icon created
26486 * with elm_icon_add().
26488 * Once the icon object is set, a previously set one will be deleted.
26489 * @warning Setting the same icon for two items will cause the icon to
26490 * dissapear from the first item.
26492 * If an icon was passed as argument on item creation, with function
26493 * elm_diskselector_item_append(), it will be already
26494 * associated to the item.
26496 * @see elm_diskselector_item_append()
26497 * @see elm_diskselector_item_icon_get()
26499 * @ingroup Diskselector
26501 EAPI void elm_diskselector_item_icon_set(Elm_Diskselector_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
26504 * Get the icon associated to the item.
26506 * @param it The diskselector item
26507 * @return The icon associated to @p it
26509 * The return value is a pointer to the icon associated to @p item when it was
26510 * created, with function elm_diskselector_item_append(), or later
26511 * with function elm_diskselector_item_icon_set. If no icon
26512 * was passed as argument, it will return @c NULL.
26514 * @see elm_diskselector_item_append()
26515 * @see elm_diskselector_item_icon_set()
26517 * @ingroup Diskselector
26519 EAPI Evas_Object *elm_diskselector_item_icon_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26522 * Set the label of item.
26524 * @param it The item of diskselector.
26525 * @param label The label of item.
26527 * The label to be displayed by the item.
26529 * If no icon is set, label will be centered on item position, otherwise
26530 * the icon will be placed at left of the label, that will be shifted
26533 * An item with label "January" would be displayed on side position as
26534 * "Jan" if max length is set to 3 with function
26535 * elm_diskselector_side_label_lenght_set(), or "Janu", if this property
26538 * When this @p item is selected, the entire label will be displayed,
26539 * except for width restrictions.
26540 * In this case label will be cropped and "..." will be concatenated,
26541 * but only for display purposes. It will keep the entire string, so
26542 * if diskselector is resized the remaining characters will be displayed.
26544 * If a label was passed as argument on item creation, with function
26545 * elm_diskselector_item_append(), it will be already
26546 * displayed by the item.
26548 * @see elm_diskselector_side_label_lenght_set()
26549 * @see elm_diskselector_item_label_get()
26550 * @see elm_diskselector_item_append()
26552 * @ingroup Diskselector
26554 EAPI void elm_diskselector_item_label_set(Elm_Diskselector_Item *item, const char *label) EINA_ARG_NONNULL(1);
26557 * Get the label of item.
26559 * @param it The item of diskselector.
26560 * @return The label of item.
26562 * The return value is a pointer to the label associated to @p item when it was
26563 * created, with function elm_diskselector_item_append(), or later
26564 * with function elm_diskselector_item_label_set. If no label
26565 * was passed as argument, it will return @c NULL.
26567 * @see elm_diskselector_item_label_set() for more details.
26568 * @see elm_diskselector_item_append()
26570 * @ingroup Diskselector
26572 EAPI const char *elm_diskselector_item_label_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26575 * Get the selected item.
26577 * @param obj The diskselector object.
26578 * @return The selected diskselector item.
26580 * The selected item can be unselected with function
26581 * elm_diskselector_item_selected_set(), and the first item of
26582 * diskselector will be selected.
26584 * The selected item always will be centered on diskselector, with
26585 * full label displayed, i.e., max lenght set to side labels won't
26586 * apply on the selected item. More details on
26587 * elm_diskselector_side_label_length_set().
26589 * @ingroup Diskselector
26591 EAPI Elm_Diskselector_Item *elm_diskselector_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26594 * Set the selected state of an item.
26596 * @param it The diskselector item
26597 * @param selected The selected state
26599 * This sets the selected state of the given item @p it.
26600 * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
26602 * If a new item is selected the previosly selected will be unselected.
26603 * Previoulsy selected item can be get with function
26604 * elm_diskselector_selected_item_get().
26606 * If the item @p it is unselected, the first item of diskselector will
26609 * Selected items will be visible on center position of diskselector.
26610 * So if it was on another position before selected, or was invisible,
26611 * diskselector will animate items until the selected item reaches center
26614 * @see elm_diskselector_item_selected_get()
26615 * @see elm_diskselector_selected_item_get()
26617 * @ingroup Diskselector
26619 EAPI void elm_diskselector_item_selected_set(Elm_Diskselector_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
26622 * Get whether the @p item is selected or not.
26624 * @param it The diskselector item.
26625 * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
26626 * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
26628 * @see elm_diskselector_selected_item_set() for details.
26629 * @see elm_diskselector_item_selected_get()
26631 * @ingroup Diskselector
26633 EAPI Eina_Bool elm_diskselector_item_selected_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26636 * Get the first item of the diskselector.
26638 * @param obj The diskselector object.
26639 * @return The first item, or @c NULL if none.
26641 * The list of items follows append order. So it will return the first
26642 * item appended to the widget that wasn't deleted.
26644 * @see elm_diskselector_item_append()
26645 * @see elm_diskselector_items_get()
26647 * @ingroup Diskselector
26649 EAPI Elm_Diskselector_Item *elm_diskselector_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26652 * Get the last item of the diskselector.
26654 * @param obj The diskselector object.
26655 * @return The last item, or @c NULL if none.
26657 * The list of items follows append order. So it will return last first
26658 * item appended to the widget that wasn't deleted.
26660 * @see elm_diskselector_item_append()
26661 * @see elm_diskselector_items_get()
26663 * @ingroup Diskselector
26665 EAPI Elm_Diskselector_Item *elm_diskselector_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26668 * Get the item before @p item in diskselector.
26670 * @param it The diskselector item.
26671 * @return The item before @p item, or @c NULL if none or on failure.
26673 * The list of items follows append order. So it will return item appended
26674 * just before @p item and that wasn't deleted.
26676 * If it is the first item, @c NULL will be returned.
26677 * First item can be get by elm_diskselector_first_item_get().
26679 * @see elm_diskselector_item_append()
26680 * @see elm_diskselector_items_get()
26682 * @ingroup Diskselector
26684 EAPI Elm_Diskselector_Item *elm_diskselector_item_prev_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26687 * Get the item after @p item in diskselector.
26689 * @param it The diskselector item.
26690 * @return The item after @p item, or @c NULL if none or on failure.
26692 * The list of items follows append order. So it will return item appended
26693 * just after @p item and that wasn't deleted.
26695 * If it is the last item, @c NULL will be returned.
26696 * Last item can be get by elm_diskselector_last_item_get().
26698 * @see elm_diskselector_item_append()
26699 * @see elm_diskselector_items_get()
26701 * @ingroup Diskselector
26703 EAPI Elm_Diskselector_Item *elm_diskselector_item_next_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26706 * Set the text to be shown in the diskselector item.
26708 * @param item Target item
26709 * @param text The text to set in the content
26711 * Setup the text as tooltip to object. The item can have only one tooltip,
26712 * so any previous tooltip data is removed.
26714 * @see elm_object_tooltip_text_set() for more details.
26716 * @ingroup Diskselector
26718 EAPI void elm_diskselector_item_tooltip_text_set(Elm_Diskselector_Item *item, const char *text) EINA_ARG_NONNULL(1);
26721 * Set the content to be shown in the tooltip item.
26723 * Setup the tooltip to item. The item can have only one tooltip,
26724 * so any previous tooltip data is removed. @p func(with @p data) will
26725 * be called every time that need show the tooltip and it should
26726 * return a valid Evas_Object. This object is then managed fully by
26727 * tooltip system and is deleted when the tooltip is gone.
26729 * @param item the diskselector item being attached a tooltip.
26730 * @param func the function used to create the tooltip contents.
26731 * @param data what to provide to @a func as callback data/context.
26732 * @param del_cb called when data is not needed anymore, either when
26733 * another callback replaces @p func, the tooltip is unset with
26734 * elm_diskselector_item_tooltip_unset() or the owner @a item
26735 * dies. This callback receives as the first parameter the
26736 * given @a data, and @c event_info is the item.
26738 * @see elm_object_tooltip_content_cb_set() for more details.
26740 * @ingroup Diskselector
26742 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);
26745 * Unset tooltip from item.
26747 * @param item diskselector item to remove previously set tooltip.
26749 * Remove tooltip from item. The callback provided as del_cb to
26750 * elm_diskselector_item_tooltip_content_cb_set() will be called to notify
26751 * it is not used anymore.
26753 * @see elm_object_tooltip_unset() for more details.
26754 * @see elm_diskselector_item_tooltip_content_cb_set()
26756 * @ingroup Diskselector
26758 EAPI void elm_diskselector_item_tooltip_unset(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26762 * Sets a different style for this item tooltip.
26764 * @note before you set a style you should define a tooltip with
26765 * elm_diskselector_item_tooltip_content_cb_set() or
26766 * elm_diskselector_item_tooltip_text_set()
26768 * @param item diskselector item with tooltip already set.
26769 * @param style the theme style to use (default, transparent, ...)
26771 * @see elm_object_tooltip_style_set() for more details.
26773 * @ingroup Diskselector
26775 EAPI void elm_diskselector_item_tooltip_style_set(Elm_Diskselector_Item *item, const char *style) EINA_ARG_NONNULL(1);
26778 * Get the style for this item tooltip.
26780 * @param item diskselector item with tooltip already set.
26781 * @return style the theme style in use, defaults to "default". If the
26782 * object does not have a tooltip set, then NULL is returned.
26784 * @see elm_object_tooltip_style_get() for more details.
26785 * @see elm_diskselector_item_tooltip_style_set()
26787 * @ingroup Diskselector
26789 EAPI const char *elm_diskselector_item_tooltip_style_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26792 * Set the cursor to be shown when mouse is over the diskselector item
26794 * @param item Target item
26795 * @param cursor the cursor name to be used.
26797 * @see elm_object_cursor_set() for more details.
26799 * @ingroup Diskselector
26801 EAPI void elm_diskselector_item_cursor_set(Elm_Diskselector_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
26804 * Get the cursor to be shown when mouse is over the diskselector item
26806 * @param item diskselector item with cursor already set.
26807 * @return the cursor name.
26809 * @see elm_object_cursor_get() for more details.
26810 * @see elm_diskselector_cursor_set()
26812 * @ingroup Diskselector
26814 EAPI const char *elm_diskselector_item_cursor_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26818 * Unset the cursor to be shown when mouse is over the diskselector item
26820 * @param item Target item
26822 * @see elm_object_cursor_unset() for more details.
26823 * @see elm_diskselector_cursor_set()
26825 * @ingroup Diskselector
26827 EAPI void elm_diskselector_item_cursor_unset(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26830 * Sets a different style for this item cursor.
26832 * @note before you set a style you should define a cursor with
26833 * elm_diskselector_item_cursor_set()
26835 * @param item diskselector item with cursor already set.
26836 * @param style the theme style to use (default, transparent, ...)
26838 * @see elm_object_cursor_style_set() for more details.
26840 * @ingroup Diskselector
26842 EAPI void elm_diskselector_item_cursor_style_set(Elm_Diskselector_Item *item, const char *style) EINA_ARG_NONNULL(1);
26846 * Get the style for this item cursor.
26848 * @param item diskselector item with cursor already set.
26849 * @return style the theme style in use, defaults to "default". If the
26850 * object does not have a cursor set, then @c NULL is returned.
26852 * @see elm_object_cursor_style_get() for more details.
26853 * @see elm_diskselector_item_cursor_style_set()
26855 * @ingroup Diskselector
26857 EAPI const char *elm_diskselector_item_cursor_style_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26861 * Set if the cursor set should be searched on the theme or should use
26862 * the provided by the engine, only.
26864 * @note before you set if should look on theme you should define a cursor
26865 * with elm_diskselector_item_cursor_set().
26866 * By default it will only look for cursors provided by the engine.
26868 * @param item widget item with cursor already set.
26869 * @param engine_only boolean to define if cursors set with
26870 * elm_diskselector_item_cursor_set() should be searched only
26871 * between cursors provided by the engine or searched on widget's
26874 * @see elm_object_cursor_engine_only_set() for more details.
26876 * @ingroup Diskselector
26878 EAPI void elm_diskselector_item_cursor_engine_only_set(Elm_Diskselector_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
26881 * Get the cursor engine only usage for this item cursor.
26883 * @param item widget item with cursor already set.
26884 * @return engine_only boolean to define it cursors should be looked only
26885 * between the provided by the engine or searched on widget's theme as well.
26886 * If the item does not have a cursor set, then @c EINA_FALSE is returned.
26888 * @see elm_object_cursor_engine_only_get() for more details.
26889 * @see elm_diskselector_item_cursor_engine_only_set()
26891 * @ingroup Diskselector
26893 EAPI Eina_Bool elm_diskselector_item_cursor_engine_only_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26900 * @defgroup Colorselector Colorselector
26904 * @image html img/widget/colorselector/preview-00.png
26905 * @image latex img/widget/colorselector/preview-00.eps
26907 * @brief Widget for user to select a color.
26909 * Signals that you can add callbacks for are:
26910 * "changed" - When the color value changes(event_info is NULL).
26912 * See @ref tutorial_colorselector.
26915 * @brief Add a new colorselector to the parent
26917 * @param parent The parent object
26918 * @return The new object or NULL if it cannot be created
26920 * @ingroup Colorselector
26922 EAPI Evas_Object *elm_colorselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
26924 * Set a color for the colorselector
26926 * @param obj Colorselector object
26927 * @param r r-value of color
26928 * @param g g-value of color
26929 * @param b b-value of color
26930 * @param a a-value of color
26932 * @ingroup Colorselector
26934 EAPI void elm_colorselector_color_set(Evas_Object *obj, int r, int g , int b, int a) EINA_ARG_NONNULL(1);
26936 * Get a color from the colorselector
26938 * @param obj Colorselector object
26939 * @param r integer pointer for r-value of color
26940 * @param g integer pointer for g-value of color
26941 * @param b integer pointer for b-value of color
26942 * @param a integer pointer for a-value of color
26944 * @ingroup Colorselector
26946 EAPI void elm_colorselector_color_get(const Evas_Object *obj, int *r, int *g , int *b, int *a) EINA_ARG_NONNULL(1);
26952 * @defgroup Ctxpopup Ctxpopup
26954 * @image html img/widget/ctxpopup/preview-00.png
26955 * @image latex img/widget/ctxpopup/preview-00.eps
26957 * @brief Context popup widet.
26959 * A ctxpopup is a widget that, when shown, pops up a list of items.
26960 * It automatically chooses an area inside its parent object's view
26961 * (set via elm_ctxpopup_add() and elm_ctxpopup_hover_parent_set()) to
26962 * optimally fit into it. In the default theme, it will also point an
26963 * arrow to it's top left position at the time one shows it. Ctxpopup
26964 * items have a label and/or an icon. It is intended for a small
26965 * number of items (hence the use of list, not genlist).
26967 * @note Ctxpopup is a especialization of @ref Hover.
26969 * Signals that you can add callbacks for are:
26970 * "dismissed" - the ctxpopup was dismissed
26972 * Default contents parts of the ctxpopup widget that you can use for are:
26973 * @li "default" - A content of the ctxpopup
26975 * Default contents parts of the naviframe items that you can use for are:
26976 * @li "icon" - An icon in the title area
26978 * Default text parts of the naviframe items that you can use for are:
26979 * @li "default" - Title label in the title area
26981 * @ref tutorial_ctxpopup shows the usage of a good deal of the API.
26984 typedef enum _Elm_Ctxpopup_Direction
26986 ELM_CTXPOPUP_DIRECTION_DOWN, /**< ctxpopup show appear below clicked
26988 ELM_CTXPOPUP_DIRECTION_RIGHT, /**< ctxpopup show appear to the right of
26989 the clicked area */
26990 ELM_CTXPOPUP_DIRECTION_LEFT, /**< ctxpopup show appear to the left of
26991 the clicked area */
26992 ELM_CTXPOPUP_DIRECTION_UP, /**< ctxpopup show appear above the clicked
26994 ELM_CTXPOPUP_DIRECTION_UNKNOWN, /**< ctxpopup does not determine it's direction yet*/
26995 } Elm_Ctxpopup_Direction;
26998 * @brief Add a new Ctxpopup object to the parent.
27000 * @param parent Parent object
27001 * @return New object or @c NULL, if it cannot be created
27003 EAPI Evas_Object *elm_ctxpopup_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
27005 * @brief Set the Ctxpopup's parent
27007 * @param obj The ctxpopup object
27008 * @param area The parent to use
27010 * Set the parent object.
27012 * @note elm_ctxpopup_add() will automatically call this function
27013 * with its @c parent argument.
27015 * @see elm_ctxpopup_add()
27016 * @see elm_hover_parent_set()
27018 EAPI void elm_ctxpopup_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1, 2);
27020 * @brief Get the Ctxpopup's parent
27022 * @param obj The ctxpopup object
27024 * @see elm_ctxpopup_hover_parent_set() for more information
27026 EAPI Evas_Object *elm_ctxpopup_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
27028 * @brief Clear all items in the given ctxpopup object.
27030 * @param obj Ctxpopup object
27032 EAPI void elm_ctxpopup_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
27034 * @brief Change the ctxpopup's orientation to horizontal or vertical.
27036 * @param obj Ctxpopup object
27037 * @param horizontal @c EINA_TRUE for horizontal mode, @c EINA_FALSE for vertical
27039 EAPI void elm_ctxpopup_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
27041 * @brief Get the value of current ctxpopup object's orientation.
27043 * @param obj Ctxpopup object
27044 * @return @c EINA_TRUE for horizontal mode, @c EINA_FALSE for vertical mode (or errors)
27046 * @see elm_ctxpopup_horizontal_set()
27048 EAPI Eina_Bool elm_ctxpopup_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
27050 * @brief Add a new item to a ctxpopup object.
27052 * @param obj Ctxpopup object
27053 * @param icon Icon to be set on new item
27054 * @param label The Label of the new item
27055 * @param func Convenience function called when item selected
27056 * @param data Data passed to @p func
27057 * @return A handle to the item added or @c NULL, on errors
27059 * @warning Ctxpopup can't hold both an item list and a content at the same
27060 * time. When an item is added, any previous content will be removed.
27062 * @see elm_ctxpopup_content_set()
27064 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);
27066 * @brief Delete the given item in a ctxpopup object.
27068 * @param it Ctxpopup item to be deleted
27070 * @see elm_ctxpopup_item_append()
27072 EAPI void elm_ctxpopup_item_del(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
27074 * @brief Set the ctxpopup item's state as disabled or enabled.
27076 * @param it Ctxpopup item to be enabled/disabled
27077 * @param disabled @c EINA_TRUE to disable it, @c EINA_FALSE to enable it
27079 * When disabled the item is greyed out to indicate it's state.
27080 * @deprecated use elm_object_item_disabled_set() instead
27082 EINA_DEPRECATED EAPI void elm_ctxpopup_item_disabled_set(Elm_Object_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1);
27084 * @brief Get the ctxpopup item's disabled/enabled state.
27086 * @param it Ctxpopup item to be enabled/disabled
27087 * @return disabled @c EINA_TRUE, if disabled, @c EINA_FALSE otherwise
27089 * @see elm_ctxpopup_item_disabled_set()
27090 * @deprecated use elm_object_item_disabled_get() instead
27092 EAPI Eina_Bool elm_ctxpopup_item_disabled_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
27094 * @brief Get the icon object for the given ctxpopup item.
27096 * @param it Ctxpopup item
27097 * @return icon object or @c NULL, if the item does not have icon or an error
27100 * @see elm_ctxpopup_item_append()
27101 * @see elm_ctxpopup_item_icon_set()
27103 * @deprecated use elm_object_item_part_content_get() instead
27105 EINA_DEPRECATED EAPI Evas_Object *elm_ctxpopup_item_icon_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
27107 * @brief Sets the side icon associated with the ctxpopup item
27109 * @param it Ctxpopup item
27110 * @param icon Icon object to be set
27112 * Once the icon object is set, a previously set one will be deleted.
27113 * @warning Setting the same icon for two items will cause the icon to
27114 * dissapear from the first item.
27116 * @see elm_ctxpopup_item_append()
27118 * @deprecated use elm_object_item_part_content_set() instead
27121 EINA_DEPRECATED EAPI void elm_ctxpopup_item_icon_set(Elm_Object_Item *it, Evas_Object *icon) EINA_ARG_NONNULL(1);
27123 * @brief Get the label for the given ctxpopup item.
27125 * @param it Ctxpopup item
27126 * @return label string or @c NULL, if the item does not have label or an
27129 * @see elm_ctxpopup_item_append()
27130 * @see elm_ctxpopup_item_label_set()
27132 * @deprecated use elm_object_item_text_get() instead
27134 EINA_DEPRECATED EAPI const char *elm_ctxpopup_item_label_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
27136 * @brief (Re)set the label on the given ctxpopup item.
27138 * @param it Ctxpopup item
27139 * @param label String to set as label
27141 * @deprecated use elm_object_item_text_set() instead
27143 EINA_DEPRECATED EAPI void elm_ctxpopup_item_label_set(Elm_Object_Item *it, const char *label) EINA_ARG_NONNULL(1);
27145 * @brief Set an elm widget as the content of the ctxpopup.
27147 * @param obj Ctxpopup object
27148 * @param content Content to be swallowed
27150 * If the content object is already set, a previous one will bedeleted. If
27151 * you want to keep that old content object, use the
27152 * elm_ctxpopup_content_unset() function.
27154 * @warning Ctxpopup can't hold both a item list and a content at the same
27155 * time. When a content is set, any previous items will be removed.
27157 * @deprecated use elm_object_content_set() instead
27160 EINA_DEPRECATED EAPI void elm_ctxpopup_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1, 2);
27162 * @brief Unset the ctxpopup content
27164 * @param obj Ctxpopup object
27165 * @return The content that was being used
27167 * Unparent and return the content object which was set for this widget.
27169 * @deprecated use elm_object_content_unset()
27171 * @see elm_ctxpopup_content_set()
27173 * @deprecated use elm_object_content_unset() instead
27176 EINA_DEPRECATED EAPI Evas_Object *elm_ctxpopup_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
27178 * @brief Set the direction priority of a ctxpopup.
27180 * @param obj Ctxpopup object
27181 * @param first 1st priority of direction
27182 * @param second 2nd priority of direction
27183 * @param third 3th priority of direction
27184 * @param fourth 4th priority of direction
27186 * This functions gives a chance to user to set the priority of ctxpopup
27187 * showing direction. This doesn't guarantee the ctxpopup will appear in the
27188 * requested direction.
27190 * @see Elm_Ctxpopup_Direction
27192 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);
27194 * @brief Get the direction priority of a ctxpopup.
27196 * @param obj Ctxpopup object
27197 * @param first 1st priority of direction to be returned
27198 * @param second 2nd priority of direction to be returned
27199 * @param third 3th priority of direction to be returned
27200 * @param fourth 4th priority of direction to be returned
27202 * @see elm_ctxpopup_direction_priority_set() for more information.
27204 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);
27207 * @brief Get the current direction of a ctxpopup.
27209 * @param obj Ctxpopup object
27210 * @return current direction of a ctxpopup
27212 * @warning Once the ctxpopup showed up, the direction would be determined
27214 EAPI Elm_Ctxpopup_Direction elm_ctxpopup_direction_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
27223 * @defgroup Transit Transit
27224 * @ingroup Elementary
27226 * Transit is designed to apply various animated transition effects to @c
27227 * Evas_Object, such like translation, rotation, etc. For using these
27228 * effects, create an @ref Elm_Transit and add the desired transition effects.
27230 * Once the effects are added into transit, they will be automatically
27231 * managed (their callback will be called until the duration is ended, and
27232 * they will be deleted on completion).
27236 * Elm_Transit *trans = elm_transit_add();
27237 * elm_transit_object_add(trans, obj);
27238 * elm_transit_effect_translation_add(trans, 0, 0, 280, 280
27239 * elm_transit_duration_set(transit, 1);
27240 * elm_transit_auto_reverse_set(transit, EINA_TRUE);
27241 * elm_transit_tween_mode_set(transit, ELM_TRANSIT_TWEEN_MODE_DECELERATE);
27242 * elm_transit_repeat_times_set(transit, 3);
27245 * Some transition effects are used to change the properties of objects. They
27247 * @li @ref elm_transit_effect_translation_add
27248 * @li @ref elm_transit_effect_color_add
27249 * @li @ref elm_transit_effect_rotation_add
27250 * @li @ref elm_transit_effect_wipe_add
27251 * @li @ref elm_transit_effect_zoom_add
27252 * @li @ref elm_transit_effect_resizing_add
27254 * Other transition effects are used to make one object disappear and another
27255 * object appear on its old place. These effects are:
27257 * @li @ref elm_transit_effect_flip_add
27258 * @li @ref elm_transit_effect_resizable_flip_add
27259 * @li @ref elm_transit_effect_fade_add
27260 * @li @ref elm_transit_effect_blend_add
27262 * It's also possible to make a transition chain with @ref
27263 * elm_transit_chain_transit_add.
27265 * @warning We strongly recommend to use elm_transit just when edje can not do
27266 * the trick. Edje has more advantage than Elm_Transit, it has more flexibility and
27267 * animations can be manipulated inside the theme.
27269 * List of examples:
27270 * @li @ref transit_example_01_explained
27271 * @li @ref transit_example_02_explained
27272 * @li @ref transit_example_03_c
27273 * @li @ref transit_example_04_c
27279 * @enum Elm_Transit_Tween_Mode
27281 * The type of acceleration used in the transition.
27285 ELM_TRANSIT_TWEEN_MODE_LINEAR, /**< Constant speed */
27286 ELM_TRANSIT_TWEEN_MODE_SINUSOIDAL, /**< Starts slow, increase speed
27287 over time, then decrease again
27289 ELM_TRANSIT_TWEEN_MODE_DECELERATE, /**< Starts fast and decrease
27291 ELM_TRANSIT_TWEEN_MODE_ACCELERATE /**< Starts slow and increase speed
27293 } Elm_Transit_Tween_Mode;
27296 * @enum Elm_Transit_Effect_Flip_Axis
27298 * The axis where flip effect should be applied.
27302 ELM_TRANSIT_EFFECT_FLIP_AXIS_X, /**< Flip on X axis */
27303 ELM_TRANSIT_EFFECT_FLIP_AXIS_Y /**< Flip on Y axis */
27304 } Elm_Transit_Effect_Flip_Axis;
27306 * @enum Elm_Transit_Effect_Wipe_Dir
27308 * The direction where the wipe effect should occur.
27312 ELM_TRANSIT_EFFECT_WIPE_DIR_LEFT, /**< Wipe to the left */
27313 ELM_TRANSIT_EFFECT_WIPE_DIR_RIGHT, /**< Wipe to the right */
27314 ELM_TRANSIT_EFFECT_WIPE_DIR_UP, /**< Wipe up */
27315 ELM_TRANSIT_EFFECT_WIPE_DIR_DOWN /**< Wipe down */
27316 } Elm_Transit_Effect_Wipe_Dir;
27317 /** @enum Elm_Transit_Effect_Wipe_Type
27319 * Whether the wipe effect should show or hide the object.
27323 ELM_TRANSIT_EFFECT_WIPE_TYPE_HIDE, /**< Hide the object during the
27325 ELM_TRANSIT_EFFECT_WIPE_TYPE_SHOW /**< Show the object during the
27327 } Elm_Transit_Effect_Wipe_Type;
27330 * @typedef Elm_Transit
27332 * The Transit created with elm_transit_add(). This type has the information
27333 * about the objects which the transition will be applied, and the
27334 * transition effects that will be used. It also contains info about
27335 * duration, number of repetitions, auto-reverse, etc.
27337 typedef struct _Elm_Transit Elm_Transit;
27338 typedef void Elm_Transit_Effect;
27340 * @typedef Elm_Transit_Effect_Transition_Cb
27342 * Transition callback called for this effect on each transition iteration.
27344 typedef void (*Elm_Transit_Effect_Transition_Cb) (Elm_Transit_Effect *effect, Elm_Transit *transit, double progress);
27346 * Elm_Transit_Effect_End_Cb
27348 * Transition callback called for this effect when the transition is over.
27350 typedef void (*Elm_Transit_Effect_End_Cb) (Elm_Transit_Effect *effect, Elm_Transit *transit);
27353 * Elm_Transit_Del_Cb
27355 * A callback called when the transit is deleted.
27357 typedef void (*Elm_Transit_Del_Cb) (void *data, Elm_Transit *transit);
27362 * @note Is not necessary to delete the transit object, it will be deleted at
27363 * the end of its operation.
27364 * @note The transit will start playing when the program enter in the main loop, is not
27365 * necessary to give a start to the transit.
27367 * @return The transit object.
27371 EAPI Elm_Transit *elm_transit_add(void);
27374 * Stops the animation and delete the @p transit object.
27376 * Call this function if you wants to stop the animation before the duration
27377 * time. Make sure the @p transit object is still alive with
27378 * elm_transit_del_cb_set() function.
27379 * All added effects will be deleted, calling its repective data_free_cb
27380 * functions. The function setted by elm_transit_del_cb_set() will be called.
27382 * @see elm_transit_del_cb_set()
27384 * @param transit The transit object to be deleted.
27387 * @warning Just call this function if you are sure the transit is alive.
27389 EAPI void elm_transit_del(Elm_Transit *transit) EINA_ARG_NONNULL(1);
27392 * Add a new effect to the transit.
27394 * @note The cb function and the data are the key to the effect. If you try to
27395 * add an already added effect, nothing is done.
27396 * @note After the first addition of an effect in @p transit, if its
27397 * effect list become empty again, the @p transit will be killed by
27398 * elm_transit_del(transit) function.
27402 * Elm_Transit *transit = elm_transit_add();
27403 * elm_transit_effect_add(transit,
27404 * elm_transit_effect_blend_op,
27405 * elm_transit_effect_blend_context_new(),
27406 * elm_transit_effect_blend_context_free);
27409 * @param transit The transit object.
27410 * @param transition_cb The operation function. It is called when the
27411 * animation begins, it is the function that actually performs the animation.
27412 * It is called with the @p data, @p transit and the time progression of the
27413 * animation (a double value between 0.0 and 1.0).
27414 * @param effect The context data of the effect.
27415 * @param end_cb The function to free the context data, it will be called
27416 * at the end of the effect, it must finalize the animation and free the
27420 * @warning The transit free the context data at the and of the transition with
27421 * the data_free_cb function, do not use the context data in another transit.
27423 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);
27426 * Delete an added effect.
27428 * This function will remove the effect from the @p transit, calling the
27429 * data_free_cb to free the @p data.
27431 * @see elm_transit_effect_add()
27433 * @note If the effect is not found, nothing is done.
27434 * @note If the effect list become empty, this function will call
27435 * elm_transit_del(transit), that is, it will kill the @p transit.
27437 * @param transit The transit object.
27438 * @param transition_cb The operation function.
27439 * @param effect The context data of the effect.
27443 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);
27446 * Add new object to apply the effects.
27448 * @note After the first addition of an object in @p transit, if its
27449 * object list become empty again, the @p transit will be killed by
27450 * elm_transit_del(transit) function.
27451 * @note If the @p obj belongs to another transit, the @p obj will be
27452 * removed from it and it will only belong to the @p transit. If the old
27453 * transit stays without objects, it will die.
27454 * @note When you add an object into the @p transit, its state from
27455 * evas_object_pass_events_get(obj) is saved, and it is applied when the
27456 * transit ends, if you change this state whith evas_object_pass_events_set()
27457 * after add the object, this state will change again when @p transit stops to
27460 * @param transit The transit object.
27461 * @param obj Object to be animated.
27464 * @warning It is not allowed to add a new object after transit begins to go.
27466 EAPI void elm_transit_object_add(Elm_Transit *transit, Evas_Object *obj) EINA_ARG_NONNULL(1, 2);
27469 * Removes an added object from the transit.
27471 * @note If the @p obj is not in the @p transit, nothing is done.
27472 * @note If the list become empty, this function will call
27473 * elm_transit_del(transit), that is, it will kill the @p transit.
27475 * @param transit The transit object.
27476 * @param obj Object to be removed from @p transit.
27479 * @warning It is not allowed to remove objects after transit begins to go.
27481 EAPI void elm_transit_object_remove(Elm_Transit *transit, Evas_Object *obj) EINA_ARG_NONNULL(1, 2);
27484 * Get the objects of the transit.
27486 * @param transit The transit object.
27487 * @return a Eina_List with the objects from the transit.
27491 EAPI const Eina_List *elm_transit_objects_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27494 * Enable/disable keeping up the objects states.
27495 * If it is not kept, the objects states will be reset when transition ends.
27497 * @note @p transit can not be NULL.
27498 * @note One state includes geometry, color, map data.
27500 * @param transit The transit object.
27501 * @param state_keep Keeping or Non Keeping.
27505 EAPI void elm_transit_objects_final_state_keep_set(Elm_Transit *transit, Eina_Bool state_keep) EINA_ARG_NONNULL(1);
27508 * Get a value whether the objects states will be reset or not.
27510 * @note @p transit can not be NULL
27512 * @see elm_transit_objects_final_state_keep_set()
27514 * @param transit The transit object.
27515 * @return EINA_TRUE means the states of the objects will be reset.
27516 * If @p transit is NULL, EINA_FALSE is returned
27520 EAPI Eina_Bool elm_transit_objects_final_state_keep_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27523 * Set the event enabled when transit is operating.
27525 * If @p enabled is EINA_TRUE, the objects of the transit will receives
27526 * events from mouse and keyboard during the animation.
27527 * @note When you add an object with elm_transit_object_add(), its state from
27528 * evas_object_pass_events_get(obj) is saved, and it is applied when the
27529 * transit ends, if you change this state with evas_object_pass_events_set()
27530 * after adding the object, this state will change again when @p transit stops
27533 * @param transit The transit object.
27534 * @param enabled Events are received when enabled is @c EINA_TRUE, and
27535 * ignored otherwise.
27539 EAPI void elm_transit_event_enabled_set(Elm_Transit *transit, Eina_Bool enabled) EINA_ARG_NONNULL(1);
27542 * Get the value of event enabled status.
27544 * @see elm_transit_event_enabled_set()
27546 * @param transit The Transit object
27547 * @return EINA_TRUE, when event is enabled. If @p transit is NULL
27548 * EINA_FALSE is returned
27552 EAPI Eina_Bool elm_transit_event_enabled_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27555 * Set the user-callback function when the transit is deleted.
27557 * @note Using this function twice will overwrite the first function setted.
27558 * @note the @p transit object will be deleted after call @p cb function.
27560 * @param transit The transit object.
27561 * @param cb Callback function pointer. This function will be called before
27562 * the deletion of the transit.
27563 * @param data Callback funtion user data. It is the @p op parameter.
27567 EAPI void elm_transit_del_cb_set(Elm_Transit *transit, Elm_Transit_Del_Cb cb, void *data) EINA_ARG_NONNULL(1);
27570 * Set reverse effect automatically.
27572 * If auto reverse is setted, after running the effects with the progress
27573 * parameter from 0 to 1, it will call the effecs again with the progress
27574 * from 1 to 0. The transit will last for a time iqual to (2 * duration * repeat),
27575 * where the duration was setted with the function elm_transit_add and
27576 * the repeat with the function elm_transit_repeat_times_set().
27578 * @param transit The transit object.
27579 * @param reverse EINA_TRUE means the auto_reverse is on.
27583 EAPI void elm_transit_auto_reverse_set(Elm_Transit *transit, Eina_Bool reverse) EINA_ARG_NONNULL(1);
27586 * Get if the auto reverse is on.
27588 * @see elm_transit_auto_reverse_set()
27590 * @param transit The transit object.
27591 * @return EINA_TRUE means auto reverse is on. If @p transit is NULL
27592 * EINA_FALSE is returned
27596 EAPI Eina_Bool elm_transit_auto_reverse_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27599 * Set the transit repeat count. Effect will be repeated by repeat count.
27601 * This function sets the number of repetition the transit will run after
27602 * the first one, that is, if @p repeat is 1, the transit will run 2 times.
27603 * If the @p repeat is a negative number, it will repeat infinite times.
27605 * @note If this function is called during the transit execution, the transit
27606 * will run @p repeat times, ignoring the times it already performed.
27608 * @param transit The transit object
27609 * @param repeat Repeat count
27613 EAPI void elm_transit_repeat_times_set(Elm_Transit *transit, int repeat) EINA_ARG_NONNULL(1);
27616 * Get the transit repeat count.
27618 * @see elm_transit_repeat_times_set()
27620 * @param transit The Transit object.
27621 * @return The repeat count. If @p transit is NULL
27626 EAPI int elm_transit_repeat_times_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27629 * Set the transit animation acceleration type.
27631 * This function sets the tween mode of the transit that can be:
27632 * ELM_TRANSIT_TWEEN_MODE_LINEAR - The default mode.
27633 * ELM_TRANSIT_TWEEN_MODE_SINUSOIDAL - Starts in accelerate mode and ends decelerating.
27634 * ELM_TRANSIT_TWEEN_MODE_DECELERATE - The animation will be slowed over time.
27635 * ELM_TRANSIT_TWEEN_MODE_ACCELERATE - The animation will accelerate over time.
27637 * @param transit The transit object.
27638 * @param tween_mode The tween type.
27642 EAPI void elm_transit_tween_mode_set(Elm_Transit *transit, Elm_Transit_Tween_Mode tween_mode) EINA_ARG_NONNULL(1);
27645 * Get the transit animation acceleration type.
27647 * @note @p transit can not be NULL
27649 * @param transit The transit object.
27650 * @return The tween type. If @p transit is NULL
27651 * ELM_TRANSIT_TWEEN_MODE_LINEAR is returned.
27655 EAPI Elm_Transit_Tween_Mode elm_transit_tween_mode_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27658 * Set the transit animation time
27660 * @note @p transit can not be NULL
27662 * @param transit The transit object.
27663 * @param duration The animation time.
27667 EAPI void elm_transit_duration_set(Elm_Transit *transit, double duration) EINA_ARG_NONNULL(1);
27670 * Get the transit animation time
27672 * @note @p transit can not be NULL
27674 * @param transit The transit object.
27676 * @return The transit animation time.
27680 EAPI double elm_transit_duration_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27683 * Starts the transition.
27684 * Once this API is called, the transit begins to measure the time.
27686 * @note @p transit can not be NULL
27688 * @param transit The transit object.
27692 EAPI void elm_transit_go(Elm_Transit *transit) EINA_ARG_NONNULL(1);
27695 * Pause/Resume the transition.
27697 * If you call elm_transit_go again, the transit will be started from the
27698 * beginning, and will be unpaused.
27700 * @note @p transit can not be NULL
27702 * @param transit The transit object.
27703 * @param paused Whether the transition should be paused or not.
27707 EAPI void elm_transit_paused_set(Elm_Transit *transit, Eina_Bool paused) EINA_ARG_NONNULL(1);
27710 * Get the value of paused status.
27712 * @see elm_transit_paused_set()
27714 * @note @p transit can not be NULL
27716 * @param transit The transit object.
27717 * @return EINA_TRUE means transition is paused. If @p transit is NULL
27718 * EINA_FALSE is returned
27722 EAPI Eina_Bool elm_transit_paused_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27725 * Get the time progression of the animation (a double value between 0.0 and 1.0).
27727 * The value returned is a fraction (current time / total time). It
27728 * represents the progression position relative to the total.
27730 * @note @p transit can not be NULL
27732 * @param transit The transit object.
27734 * @return The time progression value. If @p transit is NULL
27739 EAPI double elm_transit_progress_value_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27742 * Makes the chain relationship between two transits.
27744 * @note @p transit can not be NULL. Transit would have multiple chain transits.
27745 * @note @p chain_transit can not be NULL. Chain transits could be chained to the only one transit.
27747 * @param transit The transit object.
27748 * @param chain_transit The chain transit object. This transit will be operated
27749 * after transit is done.
27751 * This function adds @p chain_transit transition to a chain after the @p
27752 * transit, and will be started as soon as @p transit ends. See @ref
27753 * transit_example_02_explained for a full example.
27757 EAPI void elm_transit_chain_transit_add(Elm_Transit *transit, Elm_Transit *chain_transit) EINA_ARG_NONNULL(1, 2);
27760 * Cut off the chain relationship between two transits.
27762 * @note @p transit can not be NULL. Transit would have the chain relationship with @p chain transit.
27763 * @note @p chain_transit can not be NULL. Chain transits should be chained to the @p transit.
27765 * @param transit The transit object.
27766 * @param chain_transit The chain transit object.
27768 * This function remove the @p chain_transit transition from the @p transit.
27772 EAPI void elm_transit_chain_transit_del(Elm_Transit *transit, Elm_Transit *chain_transit) EINA_ARG_NONNULL(1,2);
27775 * Get the current chain transit list.
27777 * @note @p transit can not be NULL.
27779 * @param transit The transit object.
27780 * @return chain transit list.
27784 EAPI Eina_List *elm_transit_chain_transits_get(const Elm_Transit *transit);
27787 * Add the Resizing Effect to Elm_Transit.
27789 * @note This API is one of the facades. It creates resizing effect context
27790 * and add it's required APIs to elm_transit_effect_add.
27792 * @see elm_transit_effect_add()
27794 * @param transit Transit object.
27795 * @param from_w Object width size when effect begins.
27796 * @param from_h Object height size when effect begins.
27797 * @param to_w Object width size when effect ends.
27798 * @param to_h Object height size when effect ends.
27799 * @return Resizing effect context data.
27803 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);
27806 * Add the Translation Effect to Elm_Transit.
27808 * @note This API is one of the facades. It creates translation effect context
27809 * and add it's required APIs to elm_transit_effect_add.
27811 * @see elm_transit_effect_add()
27813 * @param transit Transit object.
27814 * @param from_dx X Position variation when effect begins.
27815 * @param from_dy Y Position variation when effect begins.
27816 * @param to_dx X Position variation when effect ends.
27817 * @param to_dy Y Position variation when effect ends.
27818 * @return Translation effect context data.
27821 * @warning It is highly recommended just create a transit with this effect when
27822 * the window that the objects of the transit belongs has already been created.
27823 * This is because this effect needs the geometry information about the objects,
27824 * and if the window was not created yet, it can get a wrong information.
27826 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);
27829 * Add the Zoom Effect to Elm_Transit.
27831 * @note This API is one of the facades. It creates zoom effect context
27832 * and add it's required APIs to elm_transit_effect_add.
27834 * @see elm_transit_effect_add()
27836 * @param transit Transit object.
27837 * @param from_rate Scale rate when effect begins (1 is current rate).
27838 * @param to_rate Scale rate when effect ends.
27839 * @return Zoom effect context data.
27842 * @warning It is highly recommended just create a transit with this effect when
27843 * the window that the objects of the transit belongs has already been created.
27844 * This is because this effect needs the geometry information about the objects,
27845 * and if the window was not created yet, it can get a wrong information.
27847 EAPI Elm_Transit_Effect *elm_transit_effect_zoom_add(Elm_Transit *transit, float from_rate, float to_rate);
27850 * Add the Flip Effect to Elm_Transit.
27852 * @note This API is one of the facades. It creates flip effect context
27853 * and add it's required APIs to elm_transit_effect_add.
27854 * @note This effect is applied to each pair of objects in the order they are listed
27855 * in the transit list of objects. The first object in the pair will be the
27856 * "front" object and the second will be the "back" object.
27858 * @see elm_transit_effect_add()
27860 * @param transit Transit object.
27861 * @param axis Flipping Axis(X or Y).
27862 * @param cw Flipping Direction. EINA_TRUE is clock-wise.
27863 * @return Flip effect context data.
27866 * @warning It is highly recommended just create a transit with this effect when
27867 * the window that the objects of the transit belongs has already been created.
27868 * This is because this effect needs the geometry information about the objects,
27869 * and if the window was not created yet, it can get a wrong information.
27871 EAPI Elm_Transit_Effect *elm_transit_effect_flip_add(Elm_Transit *transit, Elm_Transit_Effect_Flip_Axis axis, Eina_Bool cw);
27874 * Add the Resizable Flip Effect to Elm_Transit.
27876 * @note This API is one of the facades. It creates resizable flip effect context
27877 * and add it's required APIs to elm_transit_effect_add.
27878 * @note This effect is applied to each pair of objects in the order they are listed
27879 * in the transit list of objects. The first object in the pair will be the
27880 * "front" object and the second will be the "back" object.
27882 * @see elm_transit_effect_add()
27884 * @param transit Transit object.
27885 * @param axis Flipping Axis(X or Y).
27886 * @param cw Flipping Direction. EINA_TRUE is clock-wise.
27887 * @return Resizable flip effect context data.
27890 * @warning It is highly recommended just create a transit with this effect when
27891 * the window that the objects of the transit belongs has already been created.
27892 * This is because this effect needs the geometry information about the objects,
27893 * and if the window was not created yet, it can get a wrong information.
27895 EAPI Elm_Transit_Effect *elm_transit_effect_resizable_flip_add(Elm_Transit *transit, Elm_Transit_Effect_Flip_Axis axis, Eina_Bool cw);
27898 * Add the Wipe Effect to Elm_Transit.
27900 * @note This API is one of the facades. It creates wipe effect context
27901 * and add it's required APIs to elm_transit_effect_add.
27903 * @see elm_transit_effect_add()
27905 * @param transit Transit object.
27906 * @param type Wipe type. Hide or show.
27907 * @param dir Wipe Direction.
27908 * @return Wipe effect context data.
27911 * @warning It is highly recommended just create a transit with this effect when
27912 * the window that the objects of the transit belongs has already been created.
27913 * This is because this effect needs the geometry information about the objects,
27914 * and if the window was not created yet, it can get a wrong information.
27916 EAPI Elm_Transit_Effect *elm_transit_effect_wipe_add(Elm_Transit *transit, Elm_Transit_Effect_Wipe_Type type, Elm_Transit_Effect_Wipe_Dir dir);
27919 * Add the Color Effect to Elm_Transit.
27921 * @note This API is one of the facades. It creates color effect context
27922 * and add it's required APIs to elm_transit_effect_add.
27924 * @see elm_transit_effect_add()
27926 * @param transit Transit object.
27927 * @param from_r RGB R when effect begins.
27928 * @param from_g RGB G when effect begins.
27929 * @param from_b RGB B when effect begins.
27930 * @param from_a RGB A when effect begins.
27931 * @param to_r RGB R when effect ends.
27932 * @param to_g RGB G when effect ends.
27933 * @param to_b RGB B when effect ends.
27934 * @param to_a RGB A when effect ends.
27935 * @return Color effect context data.
27939 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);
27942 * Add the Fade Effect to Elm_Transit.
27944 * @note This API is one of the facades. It creates fade effect context
27945 * and add it's required APIs to elm_transit_effect_add.
27946 * @note This effect is applied to each pair of objects in the order they are listed
27947 * in the transit list of objects. The first object in the pair will be the
27948 * "before" object and the second will be the "after" object.
27950 * @see elm_transit_effect_add()
27952 * @param transit Transit object.
27953 * @return Fade effect context data.
27956 * @warning It is highly recommended just create a transit with this effect when
27957 * the window that the objects of the transit belongs has already been created.
27958 * This is because this effect needs the color information about the objects,
27959 * and if the window was not created yet, it can get a wrong information.
27961 EAPI Elm_Transit_Effect *elm_transit_effect_fade_add(Elm_Transit *transit);
27964 * Add the Blend Effect to Elm_Transit.
27966 * @note This API is one of the facades. It creates blend effect context
27967 * and add it's required APIs to elm_transit_effect_add.
27968 * @note This effect is applied to each pair of objects in the order they are listed
27969 * in the transit list of objects. The first object in the pair will be the
27970 * "before" object and the second will be the "after" object.
27972 * @see elm_transit_effect_add()
27974 * @param transit Transit object.
27975 * @return Blend effect context data.
27978 * @warning It is highly recommended just create a transit with this effect when
27979 * the window that the objects of the transit belongs has already been created.
27980 * This is because this effect needs the color information about the objects,
27981 * and if the window was not created yet, it can get a wrong information.
27983 EAPI Elm_Transit_Effect *elm_transit_effect_blend_add(Elm_Transit *transit);
27986 * Add the Rotation Effect to Elm_Transit.
27988 * @note This API is one of the facades. It creates rotation effect context
27989 * and add it's required APIs to elm_transit_effect_add.
27991 * @see elm_transit_effect_add()
27993 * @param transit Transit object.
27994 * @param from_degree Degree when effect begins.
27995 * @param to_degree Degree when effect is ends.
27996 * @return Rotation effect context data.
27999 * @warning It is highly recommended just create a transit with this effect when
28000 * the window that the objects of the transit belongs has already been created.
28001 * This is because this effect needs the geometry information about the objects,
28002 * and if the window was not created yet, it can get a wrong information.
28004 EAPI Elm_Transit_Effect *elm_transit_effect_rotation_add(Elm_Transit *transit, float from_degree, float to_degree);
28007 * Add the ImageAnimation Effect to Elm_Transit.
28009 * @note This API is one of the facades. It creates image animation effect context
28010 * and add it's required APIs to elm_transit_effect_add.
28011 * The @p images parameter is a list images paths. This list and
28012 * its contents will be deleted at the end of the effect by
28013 * elm_transit_effect_image_animation_context_free() function.
28017 * char buf[PATH_MAX];
28018 * Eina_List *images = NULL;
28019 * Elm_Transit *transi = elm_transit_add();
28021 * snprintf(buf, sizeof(buf), "%s/images/icon_11.png", PACKAGE_DATA_DIR);
28022 * images = eina_list_append(images, eina_stringshare_add(buf));
28024 * snprintf(buf, sizeof(buf), "%s/images/logo_small.png", PACKAGE_DATA_DIR);
28025 * images = eina_list_append(images, eina_stringshare_add(buf));
28026 * elm_transit_effect_image_animation_add(transi, images);
28030 * @see elm_transit_effect_add()
28032 * @param transit Transit object.
28033 * @param images Eina_List of images file paths. This list and
28034 * its contents will be deleted at the end of the effect by
28035 * elm_transit_effect_image_animation_context_free() function.
28036 * @return Image Animation effect context data.
28040 EAPI Elm_Transit_Effect *elm_transit_effect_image_animation_add(Elm_Transit *transit, Eina_List *images);
28045 typedef struct _Elm_Store Elm_Store;
28046 typedef struct _Elm_Store_Filesystem Elm_Store_Filesystem;
28047 typedef struct _Elm_Store_Item Elm_Store_Item;
28048 typedef struct _Elm_Store_Item_Filesystem Elm_Store_Item_Filesystem;
28049 typedef struct _Elm_Store_Item_Info Elm_Store_Item_Info;
28050 typedef struct _Elm_Store_Item_Info_Filesystem Elm_Store_Item_Info_Filesystem;
28051 typedef struct _Elm_Store_Item_Mapping Elm_Store_Item_Mapping;
28052 typedef struct _Elm_Store_Item_Mapping_Empty Elm_Store_Item_Mapping_Empty;
28053 typedef struct _Elm_Store_Item_Mapping_Icon Elm_Store_Item_Mapping_Icon;
28054 typedef struct _Elm_Store_Item_Mapping_Photo Elm_Store_Item_Mapping_Photo;
28055 typedef struct _Elm_Store_Item_Mapping_Custom Elm_Store_Item_Mapping_Custom;
28057 typedef Eina_Bool (*Elm_Store_Item_List_Cb) (void *data, Elm_Store_Item_Info *info);
28058 typedef void (*Elm_Store_Item_Fetch_Cb) (void *data, Elm_Store_Item *sti);
28059 typedef void (*Elm_Store_Item_Unfetch_Cb) (void *data, Elm_Store_Item *sti);
28060 typedef void *(*Elm_Store_Item_Mapping_Cb) (void *data, Elm_Store_Item *sti, const char *part);
28064 ELM_STORE_ITEM_MAPPING_NONE = 0,
28065 ELM_STORE_ITEM_MAPPING_LABEL, // const char * -> label
28066 ELM_STORE_ITEM_MAPPING_STATE, // Eina_Bool -> state
28067 ELM_STORE_ITEM_MAPPING_ICON, // char * -> icon path
28068 ELM_STORE_ITEM_MAPPING_PHOTO, // char * -> photo path
28069 ELM_STORE_ITEM_MAPPING_CUSTOM, // item->custom(it->data, it, part) -> void * (-> any)
28070 // can add more here as needed by common apps
28071 ELM_STORE_ITEM_MAPPING_LAST
28072 } Elm_Store_Item_Mapping_Type;
28074 struct _Elm_Store_Item_Mapping_Icon
28076 // FIXME: allow edje file icons
28078 Elm_Icon_Lookup_Order lookup_order;
28079 Eina_Bool standard_name : 1;
28080 Eina_Bool no_scale : 1;
28081 Eina_Bool smooth : 1;
28082 Eina_Bool scale_up : 1;
28083 Eina_Bool scale_down : 1;
28086 struct _Elm_Store_Item_Mapping_Empty
28091 struct _Elm_Store_Item_Mapping_Photo
28096 struct _Elm_Store_Item_Mapping_Custom
28098 Elm_Store_Item_Mapping_Cb func;
28101 struct _Elm_Store_Item_Mapping
28103 Elm_Store_Item_Mapping_Type type;
28108 Elm_Store_Item_Mapping_Empty empty;
28109 Elm_Store_Item_Mapping_Icon icon;
28110 Elm_Store_Item_Mapping_Photo photo;
28111 Elm_Store_Item_Mapping_Custom custom;
28112 // add more types here
28116 struct _Elm_Store_Item_Info
28118 Elm_Genlist_Item_Class *item_class;
28119 const Elm_Store_Item_Mapping *mapping;
28124 struct _Elm_Store_Item_Info_Filesystem
28126 Elm_Store_Item_Info base;
28130 #define ELM_STORE_ITEM_MAPPING_END { ELM_STORE_ITEM_MAPPING_NONE, NULL, 0, { .empty = { EINA_TRUE } } }
28131 #define ELM_STORE_ITEM_MAPPING_OFFSET(st, it) offsetof(st, it)
28133 EAPI void elm_store_free(Elm_Store *st);
28135 EAPI Elm_Store *elm_store_filesystem_new(void);
28136 EAPI void elm_store_filesystem_directory_set(Elm_Store *st, const char *dir) EINA_ARG_NONNULL(1);
28137 EAPI const char *elm_store_filesystem_directory_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
28138 EAPI const char *elm_store_item_filesystem_path_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
28140 EAPI void elm_store_target_genlist_set(Elm_Store *st, Evas_Object *obj) EINA_ARG_NONNULL(1);
28142 EAPI void elm_store_cache_set(Elm_Store *st, int max) EINA_ARG_NONNULL(1);
28143 EAPI int elm_store_cache_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
28144 EAPI void elm_store_list_func_set(Elm_Store *st, Elm_Store_Item_List_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
28145 EAPI void elm_store_fetch_func_set(Elm_Store *st, Elm_Store_Item_Fetch_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
28146 EAPI void elm_store_fetch_thread_set(Elm_Store *st, Eina_Bool use_thread) EINA_ARG_NONNULL(1);
28147 EAPI Eina_Bool elm_store_fetch_thread_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
28149 EAPI void elm_store_unfetch_func_set(Elm_Store *st, Elm_Store_Item_Unfetch_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
28150 EAPI void elm_store_sorted_set(Elm_Store *st, Eina_Bool sorted) EINA_ARG_NONNULL(1);
28151 EAPI Eina_Bool elm_store_sorted_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
28152 EAPI void elm_store_item_data_set(Elm_Store_Item *sti, void *data) EINA_ARG_NONNULL(1);
28153 EAPI void *elm_store_item_data_get(Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
28154 EAPI const Elm_Store *elm_store_item_store_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
28155 EAPI const Elm_Genlist_Item *elm_store_item_genlist_item_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
28158 * @defgroup SegmentControl SegmentControl
28159 * @ingroup Elementary
28161 * @image html img/widget/segment_control/preview-00.png
28162 * @image latex img/widget/segment_control/preview-00.eps width=\textwidth
28164 * @image html img/segment_control.png
28165 * @image latex img/segment_control.eps width=\textwidth
28167 * Segment control widget is a horizontal control made of multiple segment
28168 * items, each segment item functioning similar to discrete two state button.
28169 * A segment control groups the items together and provides compact
28170 * single button with multiple equal size segments.
28172 * Segment item size is determined by base widget
28173 * size and the number of items added.
28174 * Only one segment item can be at selected state. A segment item can display
28175 * combination of Text and any Evas_Object like Images or other widget.
28177 * Smart callbacks one can listen to:
28178 * - "changed" - When the user clicks on a segment item which is not
28179 * previously selected and get selected. The event_info parameter is the
28180 * segment item pointer.
28182 * Available styles for it:
28185 * Here is an example on its usage:
28186 * @li @ref segment_control_example
28190 * @addtogroup SegmentControl
28194 typedef struct _Elm_Segment_Item Elm_Segment_Item; /**< Item handle for a segment control widget. */
28197 * Add a new segment control widget to the given parent Elementary
28198 * (container) object.
28200 * @param parent The parent object.
28201 * @return a new segment control widget handle or @c NULL, on errors.
28203 * This function inserts a new segment control widget on the canvas.
28205 * @ingroup SegmentControl
28207 EAPI Evas_Object *elm_segment_control_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
28210 * Append a new item to the segment control object.
28212 * @param obj The segment control object.
28213 * @param icon The icon object to use for the left side of the item. An
28214 * icon can be any Evas object, but usually it is an icon created
28215 * with elm_icon_add().
28216 * @param label The label of the item.
28217 * Note that, NULL is different from empty string "".
28218 * @return The created item or @c NULL upon failure.
28220 * A new item will be created and appended to the segment control, i.e., will
28221 * be set as @b last item.
28223 * If it should be inserted at another position,
28224 * elm_segment_control_item_insert_at() should be used instead.
28226 * Items created with this function can be deleted with function
28227 * elm_segment_control_item_del() or elm_segment_control_item_del_at().
28229 * @note @p label set to @c NULL is different from empty string "".
28231 * only has icon, it will be displayed bigger and centered. If it has
28232 * icon and label, even that an empty string, icon will be smaller and
28233 * positioned at left.
28237 * sc = elm_segment_control_add(win);
28238 * ic = elm_icon_add(win);
28239 * elm_icon_file_set(ic, "path/to/image", NULL);
28240 * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
28241 * elm_segment_control_item_add(sc, ic, "label");
28242 * evas_object_show(sc);
28245 * @see elm_segment_control_item_insert_at()
28246 * @see elm_segment_control_item_del()
28248 * @ingroup SegmentControl
28250 EAPI Elm_Segment_Item *elm_segment_control_item_add(Evas_Object *obj, Evas_Object *icon, const char *label) EINA_ARG_NONNULL(1);
28253 * Insert a new item to the segment control object at specified position.
28255 * @param obj The segment control object.
28256 * @param icon The icon object to use for the left side of the item. An
28257 * icon can be any Evas object, but usually it is an icon created
28258 * with elm_icon_add().
28259 * @param label The label of the item.
28260 * @param index Item position. Value should be between 0 and items count.
28261 * @return The created item or @c NULL upon failure.
28263 * Index values must be between @c 0, when item will be prepended to
28264 * segment control, and items count, that can be get with
28265 * elm_segment_control_item_count_get(), case when item will be appended
28266 * to segment control, just like elm_segment_control_item_add().
28268 * Items created with this function can be deleted with function
28269 * elm_segment_control_item_del() or elm_segment_control_item_del_at().
28271 * @note @p label set to @c NULL is different from empty string "".
28273 * only has icon, it will be displayed bigger and centered. If it has
28274 * icon and label, even that an empty string, icon will be smaller and
28275 * positioned at left.
28277 * @see elm_segment_control_item_add()
28278 * @see elm_segment_control_item_count_get()
28279 * @see elm_segment_control_item_del()
28281 * @ingroup SegmentControl
28283 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);
28286 * Remove a segment control item from its parent, deleting it.
28288 * @param it The item to be removed.
28290 * Items can be added with elm_segment_control_item_add() or
28291 * elm_segment_control_item_insert_at().
28293 * @ingroup SegmentControl
28295 EAPI void elm_segment_control_item_del(Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
28298 * Remove a segment control item at given index from its parent,
28301 * @param obj The segment control object.
28302 * @param index The position of the segment control item to be deleted.
28304 * Items can be added with elm_segment_control_item_add() or
28305 * elm_segment_control_item_insert_at().
28307 * @ingroup SegmentControl
28309 EAPI void elm_segment_control_item_del_at(Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
28312 * Get the Segment items count from segment control.
28314 * @param obj The segment control object.
28315 * @return Segment items count.
28317 * It will just return the number of items added to segment control @p obj.
28319 * @ingroup SegmentControl
28321 EAPI int elm_segment_control_item_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
28324 * Get the item placed at specified index.
28326 * @param obj The segment control object.
28327 * @param index The index of the segment item.
28328 * @return The segment control item or @c NULL on failure.
28330 * Index is the position of an item in segment control widget. Its
28331 * range is from @c 0 to <tt> count - 1 </tt>.
28332 * Count is the number of items, that can be get with
28333 * elm_segment_control_item_count_get().
28335 * @ingroup SegmentControl
28337 EAPI Elm_Segment_Item *elm_segment_control_item_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
28340 * Get the label of item.
28342 * @param obj The segment control object.
28343 * @param index The index of the segment item.
28344 * @return The label of the item at @p index.
28346 * The return value is a pointer to the label associated to the item when
28347 * it was created, with function elm_segment_control_item_add(), or later
28348 * with function elm_segment_control_item_label_set. If no label
28349 * was passed as argument, it will return @c NULL.
28351 * @see elm_segment_control_item_label_set() for more details.
28352 * @see elm_segment_control_item_add()
28354 * @ingroup SegmentControl
28356 EAPI const char *elm_segment_control_item_label_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
28359 * Set the label of item.
28361 * @param it The item of segment control.
28362 * @param text The label of item.
28364 * The label to be displayed by the item.
28365 * Label will be at right of the icon (if set).
28367 * If a label was passed as argument on item creation, with function
28368 * elm_control_segment_item_add(), it will be already
28369 * displayed by the item.
28371 * @see elm_segment_control_item_label_get()
28372 * @see elm_segment_control_item_add()
28374 * @ingroup SegmentControl
28376 EAPI void elm_segment_control_item_label_set(Elm_Segment_Item* it, const char* label) EINA_ARG_NONNULL(1);
28379 * Get the icon associated to the item.
28381 * @param obj The segment control object.
28382 * @param index The index of the segment item.
28383 * @return The left side icon associated to the item at @p index.
28385 * The return value is a pointer to the icon associated to the item when
28386 * it was created, with function elm_segment_control_item_add(), or later
28387 * with function elm_segment_control_item_icon_set(). If no icon
28388 * was passed as argument, it will return @c NULL.
28390 * @see elm_segment_control_item_add()
28391 * @see elm_segment_control_item_icon_set()
28393 * @ingroup SegmentControl
28395 EAPI Evas_Object *elm_segment_control_item_icon_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
28398 * Set the icon associated to the item.
28400 * @param it The segment control item.
28401 * @param icon The icon object to associate with @p it.
28403 * The icon object to use at left side of the item. An
28404 * icon can be any Evas object, but usually it is an icon created
28405 * with elm_icon_add().
28407 * Once the icon object is set, a previously set one will be deleted.
28408 * @warning Setting the same icon for two items will cause the icon to
28409 * dissapear from the first item.
28411 * If an icon was passed as argument on item creation, with function
28412 * elm_segment_control_item_add(), it will be already
28413 * associated to the item.
28415 * @see elm_segment_control_item_add()
28416 * @see elm_segment_control_item_icon_get()
28418 * @ingroup SegmentControl
28420 EAPI void elm_segment_control_item_icon_set(Elm_Segment_Item *it, Evas_Object *icon) EINA_ARG_NONNULL(1);
28423 * Get the index of an item.
28425 * @param it The segment control item.
28426 * @return The position of item in segment control widget.
28428 * Index is the position of an item in segment control widget. Its
28429 * range is from @c 0 to <tt> count - 1 </tt>.
28430 * Count is the number of items, that can be get with
28431 * elm_segment_control_item_count_get().
28433 * @ingroup SegmentControl
28435 EAPI int elm_segment_control_item_index_get(const Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
28438 * Get the base object of the item.
28440 * @param it The segment control item.
28441 * @return The base object associated with @p it.
28443 * Base object is the @c Evas_Object that represents that item.
28445 * @ingroup SegmentControl
28447 EAPI Evas_Object *elm_segment_control_item_object_get(const Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
28450 * Get the selected item.
28452 * @param obj The segment control object.
28453 * @return The selected item or @c NULL if none of segment items is
28456 * The selected item can be unselected with function
28457 * elm_segment_control_item_selected_set().
28459 * The selected item always will be highlighted on segment control.
28461 * @ingroup SegmentControl
28463 EAPI Elm_Segment_Item *elm_segment_control_item_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
28466 * Set the selected state of an item.
28468 * @param it The segment control item
28469 * @param select The selected state
28471 * This sets the selected state of the given item @p it.
28472 * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
28474 * If a new item is selected the previosly selected will be unselected.
28475 * Previoulsy selected item can be get with function
28476 * elm_segment_control_item_selected_get().
28478 * The selected item always will be highlighted on segment control.
28480 * @see elm_segment_control_item_selected_get()
28482 * @ingroup SegmentControl
28484 EAPI void elm_segment_control_item_selected_set(Elm_Segment_Item *it, Eina_Bool select) EINA_ARG_NONNULL(1);
28491 * @defgroup Grid Grid
28493 * The grid is a grid layout widget that lays out a series of children as a
28494 * fixed "grid" of widgets using a given percentage of the grid width and
28495 * height each using the child object.
28497 * The Grid uses a "Virtual resolution" that is stretched to fill the grid
28498 * widgets size itself. The default is 100 x 100, so that means the
28499 * position and sizes of children will effectively be percentages (0 to 100)
28500 * of the width or height of the grid widget
28506 * Add a new grid to the parent
28508 * @param parent The parent object
28509 * @return The new object or NULL if it cannot be created
28513 EAPI Evas_Object *elm_grid_add(Evas_Object *parent);
28516 * Set the virtual size of the grid
28518 * @param obj The grid object
28519 * @param w The virtual width of the grid
28520 * @param h The virtual height of the grid
28524 EAPI void elm_grid_size_set(Evas_Object *obj, int w, int h);
28527 * Get the virtual size of the grid
28529 * @param obj The grid object
28530 * @param w Pointer to integer to store the virtual width of the grid
28531 * @param h Pointer to integer to store the virtual height of the grid
28535 EAPI void elm_grid_size_get(Evas_Object *obj, int *w, int *h);
28538 * Pack child at given position and size
28540 * @param obj The grid object
28541 * @param subobj The child to pack
28542 * @param x The virtual x coord at which to pack it
28543 * @param y The virtual y coord at which to pack it
28544 * @param w The virtual width at which to pack it
28545 * @param h The virtual height at which to pack it
28549 EAPI void elm_grid_pack(Evas_Object *obj, Evas_Object *subobj, int x, int y, int w, int h);
28552 * Unpack a child from a grid object
28554 * @param obj The grid object
28555 * @param subobj The child to unpack
28559 EAPI void elm_grid_unpack(Evas_Object *obj, Evas_Object *subobj);
28562 * Faster way to remove all child objects from a grid object.
28564 * @param obj The grid object
28565 * @param clear If true, it will delete just removed children
28569 EAPI void elm_grid_clear(Evas_Object *obj, Eina_Bool clear);
28572 * Set packing of an existing child at to position and size
28574 * @param subobj The child to set packing of
28575 * @param x The virtual x coord at which to pack it
28576 * @param y The virtual y coord at which to pack it
28577 * @param w The virtual width at which to pack it
28578 * @param h The virtual height at which to pack it
28582 EAPI void elm_grid_pack_set(Evas_Object *subobj, int x, int y, int w, int h);
28585 * get packing of a child
28587 * @param subobj The child to query
28588 * @param x Pointer to integer to store the virtual x coord
28589 * @param y Pointer to integer to store the virtual y coord
28590 * @param w Pointer to integer to store the virtual width
28591 * @param h Pointer to integer to store the virtual height
28595 EAPI void elm_grid_pack_get(Evas_Object *subobj, int *x, int *y, int *w, int *h);
28601 EAPI Evas_Object *elm_factory_add(Evas_Object *parent);
28602 EINA_DEPRECATED EAPI void elm_factory_content_set(Evas_Object *obj, Evas_Object *content);
28603 EINA_DEPRECATED EAPI Evas_Object *elm_factory_content_get(const Evas_Object *obj);
28604 EAPI void elm_factory_maxmin_mode_set(Evas_Object *obj, Eina_Bool enabled);
28605 EAPI Eina_Bool elm_factory_maxmin_mode_get(const Evas_Object *obj);
28606 EAPI void elm_factory_maxmin_reset_set(Evas_Object *obj);
28609 * @defgroup Video Video
28611 * @addtogroup Video
28614 * Elementary comes with two object that help design application that need
28615 * to display video. The main one, Elm_Video, display a video by using Emotion.
28616 * It does embedded the video inside an Edje object, so you can do some
28617 * animation depending on the video state change. It does also implement a
28618 * ressource management policy to remove this burden from the application writer.
28620 * The second one, Elm_Player is a video player that need to be linked with and Elm_Video.
28621 * It take care of updating its content according to Emotion event and provide a
28622 * way to theme itself. It also does automatically raise the priority of the
28623 * linked Elm_Video so it will use the video decoder if available. It also does
28624 * activate the remember function on the linked Elm_Video object.
28626 * Signals that you can add callback for are :
28628 * "forward,clicked" - the user clicked the forward button.
28629 * "info,clicked" - the user clicked the info button.
28630 * "next,clicked" - the user clicked the next button.
28631 * "pause,clicked" - the user clicked the pause button.
28632 * "play,clicked" - the user clicked the play button.
28633 * "prev,clicked" - the user clicked the prev button.
28634 * "rewind,clicked" - the user clicked the rewind button.
28635 * "stop,clicked" - the user clicked the stop button.
28637 * Default contents parts of the player widget that you can use for are:
28638 * @li "video" - A video of the player
28643 * @brief Add a new Elm_Player object to the given parent Elementary (container) object.
28645 * @param parent The parent object
28646 * @return a new player widget handle or @c NULL, on errors.
28648 * This function inserts a new player widget on the canvas.
28650 * @see elm_object_part_content_set()
28654 EAPI Evas_Object *elm_player_add(Evas_Object *parent);
28657 * @brief Link a Elm_Payer with an Elm_Video object.
28659 * @param player the Elm_Player object.
28660 * @param video The Elm_Video object.
28662 * This mean that action on the player widget will affect the
28663 * video object and the state of the video will be reflected in
28664 * the player itself.
28666 * @see elm_player_add()
28667 * @see elm_video_add()
28668 * @deprecated use elm_object_part_content_set() instead
28672 EINA_DEPRECATED EAPI void elm_player_video_set(Evas_Object *player, Evas_Object *video);
28675 * @brief Add a new Elm_Video object to the given parent Elementary (container) object.
28677 * @param parent The parent object
28678 * @return a new video widget handle or @c NULL, on errors.
28680 * This function inserts a new video widget on the canvas.
28682 * @seeelm_video_file_set()
28683 * @see elm_video_uri_set()
28687 EAPI Evas_Object *elm_video_add(Evas_Object *parent);
28690 * @brief Define the file that will be the video source.
28692 * @param video The video object to define the file for.
28693 * @param filename The file to target.
28695 * This function will explicitly define a filename as a source
28696 * for the video of the Elm_Video object.
28698 * @see elm_video_uri_set()
28699 * @see elm_video_add()
28700 * @see elm_player_add()
28704 EAPI void elm_video_file_set(Evas_Object *video, const char *filename);
28707 * @brief Define the uri that will be the video source.
28709 * @param video The video object to define the file for.
28710 * @param uri The uri to target.
28712 * This function will define an uri as a source for the video of the
28713 * Elm_Video object. URI could be remote source of video, like http:// or local source
28714 * like for example WebCam who are most of the time v4l2:// (but that depend and
28715 * you should use Emotion API to request and list the available Webcam on your system).
28717 * @see elm_video_file_set()
28718 * @see elm_video_add()
28719 * @see elm_player_add()
28723 EAPI void elm_video_uri_set(Evas_Object *video, const char *uri);
28726 * @brief Get the underlying Emotion object.
28728 * @param video The video object to proceed the request on.
28729 * @return the underlying Emotion object.
28733 EAPI Evas_Object *elm_video_emotion_get(const Evas_Object *video);
28736 * @brief Start to play the video
28738 * @param video The video object to proceed the request on.
28740 * Start to play the video and cancel all suspend state.
28744 EAPI void elm_video_play(Evas_Object *video);
28747 * @brief Pause the video
28749 * @param video The video object to proceed the request on.
28751 * Pause the video and start a timer to trigger suspend mode.
28755 EAPI void elm_video_pause(Evas_Object *video);
28758 * @brief Stop the video
28760 * @param video The video object to proceed the request on.
28762 * Stop the video and put the emotion in deep sleep mode.
28766 EAPI void elm_video_stop(Evas_Object *video);
28769 * @brief Is the video actually playing.
28771 * @param video The video object to proceed the request on.
28772 * @return EINA_TRUE if the video is actually playing.
28774 * You should consider watching event on the object instead of polling
28775 * the object state.
28779 EAPI Eina_Bool elm_video_is_playing(const Evas_Object *video);
28782 * @brief Is it possible to seek inside the video.
28784 * @param video The video object to proceed the request on.
28785 * @return EINA_TRUE if is possible to seek inside the video.
28789 EAPI Eina_Bool elm_video_is_seekable(const Evas_Object *video);
28792 * @brief Is the audio muted.
28794 * @param video The video object to proceed the request on.
28795 * @return EINA_TRUE if the audio is muted.
28799 EAPI Eina_Bool elm_video_audio_mute_get(const Evas_Object *video);
28802 * @brief Change the mute state of the Elm_Video object.
28804 * @param video The video object to proceed the request on.
28805 * @param mute The new mute state.
28809 EAPI void elm_video_audio_mute_set(Evas_Object *video, Eina_Bool mute);
28812 * @brief Get the audio level of the current video.
28814 * @param video The video object to proceed the request on.
28815 * @return the current audio level.
28819 EAPI double elm_video_audio_level_get(const Evas_Object *video);
28822 * @brief Set the audio level of anElm_Video object.
28824 * @param video The video object to proceed the request on.
28825 * @param volume The new audio volume.
28829 EAPI void elm_video_audio_level_set(Evas_Object *video, double volume);
28831 EAPI double elm_video_play_position_get(const Evas_Object *video);
28832 EAPI void elm_video_play_position_set(Evas_Object *video, double position);
28833 EAPI double elm_video_play_length_get(const Evas_Object *video);
28834 EAPI void elm_video_remember_position_set(Evas_Object *video, Eina_Bool remember);
28835 EAPI Eina_Bool elm_video_remember_position_get(const Evas_Object *video);
28836 EAPI const char *elm_video_title_get(const Evas_Object *video);
28842 * @defgroup Naviframe Naviframe
28843 * @ingroup Elementary
28845 * @brief Naviframe is a kind of view manager for the applications.
28847 * Naviframe provides functions to switch different pages with stack
28848 * mechanism. It means if one page(item) needs to be changed to the new one,
28849 * then naviframe would push the new page to it's internal stack. Of course,
28850 * it can be back to the previous page by popping the top page. Naviframe
28851 * provides some transition effect while the pages are switching (same as
28854 * Since each item could keep the different styles, users could keep the
28855 * same look & feel for the pages or different styles for the items in it's
28858 * Signals that you can add callback for are:
28859 * @li "transition,finished" - When the transition is finished in changing
28861 * @li "title,clicked" - User clicked title area
28863 * Default contents parts of the naviframe items that you can use for are:
28864 * @li "default" - A main content of the page
28865 * @li "icon" - An icon in the title area
28866 * @li "prev_btn" - A button to go to the previous page
28867 * @li "next_btn" - A button to go to the next page
28869 * Default text parts of the naviframe items that you can use for are:
28870 * @li "default" - Title label in the title area
28871 * @li "subtitle" - Sub-title label in the title area
28873 * @ref tutorial_naviframe gives a good overview of the usage of the API.
28877 * @addtogroup Naviframe
28882 * @brief Add a new Naviframe object to the parent.
28884 * @param parent Parent object
28885 * @return New object or @c NULL, if it cannot be created
28887 * @ingroup Naviframe
28889 EAPI Evas_Object *elm_naviframe_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
28891 * @brief Push a new item to the top of the naviframe stack (and show it).
28893 * @param obj The naviframe object
28894 * @param title_label The label in the title area. The name of the title
28895 * label part is "elm.text.title"
28896 * @param prev_btn The button to go to the previous item. If it is NULL,
28897 * then naviframe will create a back button automatically. The name of
28898 * the prev_btn part is "elm.swallow.prev_btn"
28899 * @param next_btn The button to go to the next item. Or It could be just an
28900 * extra function button. The name of the next_btn part is
28901 * "elm.swallow.next_btn"
28902 * @param content The main content object. The name of content part is
28903 * "elm.swallow.content"
28904 * @param item_style The current item style name. @c NULL would be default.
28905 * @return The created item or @c NULL upon failure.
28907 * The item pushed becomes one page of the naviframe, this item will be
28908 * deleted when it is popped.
28910 * @see also elm_naviframe_item_style_set()
28911 * @see also elm_naviframe_item_insert_before()
28912 * @see also elm_naviframe_item_insert_after()
28914 * The following styles are available for this item:
28917 * @ingroup Naviframe
28919 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);
28921 * @brief Insert a new item into the naviframe before item @p before.
28923 * @param before The naviframe item to insert before.
28924 * @param title_label The label in the title area. The name of the title
28925 * label part is "elm.text.title"
28926 * @param prev_btn The button to go to the previous item. If it is NULL,
28927 * then naviframe will create a back button automatically. The name of
28928 * the prev_btn part is "elm.swallow.prev_btn"
28929 * @param next_btn The button to go to the next item. Or It could be just an
28930 * extra function button. The name of the next_btn part is
28931 * "elm.swallow.next_btn"
28932 * @param content The main content object. The name of content part is
28933 * "elm.swallow.content"
28934 * @param item_style The current item style name. @c NULL would be default.
28935 * @return The created item or @c NULL upon failure.
28937 * The item is inserted into the naviframe straight away without any
28938 * transition operations. This item will be deleted when it is popped.
28940 * @see also elm_naviframe_item_style_set()
28941 * @see also elm_naviframe_item_push()
28942 * @see also elm_naviframe_item_insert_after()
28944 * The following styles are available for this item:
28947 * @ingroup Naviframe
28949 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);
28951 * @brief Insert a new item into the naviframe after item @p after.
28953 * @param after The naviframe item to insert after.
28954 * @param title_label The label in the title area. The name of the title
28955 * label part is "elm.text.title"
28956 * @param prev_btn The button to go to the previous item. If it is NULL,
28957 * then naviframe will create a back button automatically. The name of
28958 * the prev_btn part is "elm.swallow.prev_btn"
28959 * @param next_btn The button to go to the next item. Or It could be just an
28960 * extra function button. The name of the next_btn part is
28961 * "elm.swallow.next_btn"
28962 * @param content The main content object. The name of content part is
28963 * "elm.swallow.content"
28964 * @param item_style The current item style name. @c NULL would be default.
28965 * @return The created item or @c NULL upon failure.
28967 * The item is inserted into the naviframe straight away without any
28968 * transition operations. This item will be deleted when it is popped.
28970 * @see also elm_naviframe_item_style_set()
28971 * @see also elm_naviframe_item_push()
28972 * @see also elm_naviframe_item_insert_before()
28974 * The following styles are available for this item:
28977 * @ingroup Naviframe
28979 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);
28981 * @brief Pop an item that is on top of the stack
28983 * @param obj The naviframe object
28984 * @return @c NULL or the content object(if the
28985 * elm_naviframe_content_preserve_on_pop_get is true).
28987 * This pops an item that is on the top(visible) of the naviframe, makes it
28988 * disappear, then deletes the item. The item that was underneath it on the
28989 * stack will become visible.
28991 * @see also elm_naviframe_content_preserve_on_pop_get()
28993 * @ingroup Naviframe
28995 EAPI Evas_Object *elm_naviframe_item_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
28997 * @brief Pop the items between the top and the above one on the given item.
28999 * @param it The naviframe item
29001 * @ingroup Naviframe
29003 EAPI void elm_naviframe_item_pop_to(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
29005 * Promote an item already in the naviframe stack to the top of the stack
29007 * @param it The naviframe item
29009 * This will take the indicated item and promote it to the top of the stack
29010 * as if it had been pushed there. The item must already be inside the
29011 * naviframe stack to work.
29014 EAPI void elm_naviframe_item_promote(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
29016 * @brief Delete the given item instantly.
29018 * @param it The naviframe item
29020 * This just deletes the given item from the naviframe item list instantly.
29021 * So this would not emit any signals for view transitions but just change
29022 * the current view if the given item is a top one.
29024 * @ingroup Naviframe
29026 EAPI void elm_naviframe_item_del(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
29028 * @brief preserve the content objects when items are popped.
29030 * @param obj The naviframe object
29031 * @param preserve Enable the preserve mode if EINA_TRUE, disable otherwise
29033 * @see also elm_naviframe_content_preserve_on_pop_get()
29035 * @ingroup Naviframe
29037 EAPI void elm_naviframe_content_preserve_on_pop_set(Evas_Object *obj, Eina_Bool preserve) EINA_ARG_NONNULL(1);
29039 * @brief Get a value whether preserve mode is enabled or not.
29041 * @param obj The naviframe object
29042 * @return If @c EINA_TRUE, preserve mode is enabled
29044 * @see also elm_naviframe_content_preserve_on_pop_set()
29046 * @ingroup Naviframe
29048 EAPI Eina_Bool elm_naviframe_content_preserve_on_pop_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
29050 * @brief Get a top item on the naviframe stack
29052 * @param obj The naviframe object
29053 * @return The top item on the naviframe stack or @c NULL, if the stack is
29056 * @ingroup Naviframe
29058 EAPI Elm_Object_Item *elm_naviframe_top_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
29060 * @brief Get a bottom item on the naviframe stack
29062 * @param obj The naviframe object
29063 * @return The bottom item on the naviframe stack or @c NULL, if the stack is
29066 * @ingroup Naviframe
29068 EAPI Elm_Object_Item *elm_naviframe_bottom_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
29070 * @brief Set an item style
29072 * @param obj The naviframe item
29073 * @param item_style The current item style name. @c NULL would be default
29075 * The following styles are available for this item:
29078 * @see also elm_naviframe_item_style_get()
29080 * @ingroup Naviframe
29082 EAPI void elm_naviframe_item_style_set(Elm_Object_Item *it, const char *item_style) EINA_ARG_NONNULL(1);
29084 * @brief Get an item style
29086 * @param obj The naviframe item
29087 * @return The current item style name
29089 * @see also elm_naviframe_item_style_set()
29091 * @ingroup Naviframe
29093 EAPI const char *elm_naviframe_item_style_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
29095 * @brief Show/Hide the title area
29097 * @param it The naviframe item
29098 * @param visible If @c EINA_TRUE, title area will be visible, hidden
29101 * When the title area is invisible, then the controls would be hidden so as * to expand the content area to full-size.
29103 * @see also elm_naviframe_item_title_visible_get()
29105 * @ingroup Naviframe
29107 EAPI void elm_naviframe_item_title_visible_set(Elm_Object_Item *it, Eina_Bool visible) EINA_ARG_NONNULL(1);
29109 * @brief Get a value whether title area is visible or not.
29111 * @param it The naviframe item
29112 * @return If @c EINA_TRUE, title area is visible
29114 * @see also elm_naviframe_item_title_visible_set()
29116 * @ingroup Naviframe
29118 EAPI Eina_Bool elm_naviframe_item_title_visible_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
29121 * @brief Set creating prev button automatically or not
29123 * @param obj The naviframe object
29124 * @param auto_pushed If @c EINA_TRUE, the previous button(back button) will
29125 * be created internally when you pass the @c NULL to the prev_btn
29126 * parameter in elm_naviframe_item_push
29128 * @see also elm_naviframe_item_push()
29130 EAPI void elm_naviframe_prev_btn_auto_pushed_set(Evas_Object *obj, Eina_Bool auto_pushed) EINA_ARG_NONNULL(1);
29132 * @brief Get a value whether prev button(back button) will be auto pushed or
29135 * @param obj The naviframe object
29136 * @return If @c EINA_TRUE, prev button will be auto pushed.
29138 * @see also elm_naviframe_item_push()
29139 * elm_naviframe_prev_btn_auto_pushed_set()
29141 EAPI Eina_Bool elm_naviframe_prev_btn_auto_pushed_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
29143 * @brief Get a list of all the naviframe items.
29145 * @param obj The naviframe object
29146 * @return An Eina_Inlist* of naviframe items, #Elm_Object_Item,
29147 * or @c NULL on failure.
29149 EAPI Eina_Inlist *elm_naviframe_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
29156 * @defgroup Multibuttonentry Multibuttonentry
29158 * A Multibuttonentry is a widget to allow a user enter text and manage it as a number of buttons
29159 * Each text button is inserted by pressing the "return" key. If there is no space in the current row,
29160 * a new button is added to the next row. When a text button is pressed, it will become focused.
29161 * Backspace removes the focus.
29162 * When the Multibuttonentry loses focus items longer than 1 lines are shrunk to one line.
29164 * Smart callbacks one can register:
29165 * - @c "item,selected" - when item is selected. May be called on backspace key.
29166 * - @c "item,added" - when a new multibuttonentry item is added.
29167 * - @c "item,deleted" - when a multibuttonentry item is deleted.
29168 * - @c "item,clicked" - selected item of multibuttonentry is clicked.
29169 * - @c "clicked" - when multibuttonentry is clicked.
29170 * - @c "focused" - when multibuttonentry is focused.
29171 * - @c "unfocused" - when multibuttonentry is unfocused.
29172 * - @c "expanded" - when multibuttonentry is expanded.
29173 * - @c "shrank" - when multibuttonentry is shrank.
29174 * - @c "shrank,state,changed" - when shrink mode state of multibuttonentry is changed.
29176 * Here is an example on its usage:
29177 * @li @ref multibuttonentry_example
29180 * @addtogroup Multibuttonentry
29184 typedef struct _Multibuttonentry_Item Elm_Multibuttonentry_Item;
29185 typedef Eina_Bool (*Elm_Multibuttonentry_Item_Filter_callback) (Evas_Object *obj, const char *item_label, void *item_data, void *data);
29188 * @brief Add a new multibuttonentry to the parent
29190 * @param parent The parent object
29191 * @return The new object or NULL if it cannot be created
29194 EAPI Evas_Object *elm_multibuttonentry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
29198 * @param obj The multibuttonentry object
29199 * @return The label, or NULL if none
29202 EAPI const char *elm_multibuttonentry_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
29206 * @param obj The multibuttonentry object
29207 * @param label The text label string
29210 EAPI void elm_multibuttonentry_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
29212 * Get the entry of the multibuttonentry object
29214 * @param obj The multibuttonentry object
29215 * @return The entry object, or NULL if none
29218 EAPI Evas_Object *elm_multibuttonentry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
29220 * Get the guide text
29222 * @param obj The multibuttonentry object
29223 * @return The guide text, or NULL if none
29226 EAPI const char * elm_multibuttonentry_guide_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
29228 * Set the guide text
29230 * @param obj The multibuttonentry object
29231 * @param label The guide text string
29234 EAPI void elm_multibuttonentry_guide_text_set(Evas_Object *obj, const char *guidetext) EINA_ARG_NONNULL(1);
29236 * Get the value of shrink_mode state.
29238 * @param obj The multibuttonentry object
29239 * @param the value of shrink mode state.
29242 EAPI int elm_multibuttonentry_shrink_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
29244 * Set/Unset the multibuttonentry to shrink mode state of single line
29246 * @param obj The multibuttonentry object
29247 * @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.
29250 EAPI void elm_multibuttonentry_shrink_mode_set(Evas_Object *obj, int shrink) EINA_ARG_NONNULL(1);
29252 * Prepend a new item to the multibuttonentry
29254 * @param obj The multibuttonentry object
29255 * @param label The label of new item
29256 * @param data The ponter to the data to be attached
29257 * @return A handle to the item added or NULL if not possible
29260 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_prepend(Evas_Object *obj, const char *label, void *data) EINA_ARG_NONNULL(1);
29262 * Append a new item to the multibuttonentry
29264 * @param obj The multibuttonentry object
29265 * @param label The label of new item
29266 * @param data The ponter to the data to be attached
29267 * @return A handle to the item added or NULL if not possible
29270 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_append(Evas_Object *obj, const char *label, void *data) EINA_ARG_NONNULL(1);
29272 * Add a new item to the multibuttonentry before the indicated object
29275 * @param obj The multibuttonentry object
29276 * @param before The item before which to add it
29277 * @param label The label of new item
29278 * @param data The ponter to the data to be attached
29279 * @return A handle to the item added or NULL if not possible
29282 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);
29284 * Add a new item to the multibuttonentry after the indicated object
29286 * @param obj The multibuttonentry object
29287 * @param after The item after which to add it
29288 * @param label The label of new item
29289 * @param data The ponter to the data to be attached
29290 * @return A handle to the item added or NULL if not possible
29293 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);
29295 * Get a list of items in the multibuttonentry
29297 * @param obj The multibuttonentry object
29298 * @return The list of items, or NULL if none
29301 EAPI const Eina_List *elm_multibuttonentry_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
29303 * Get the first item in the multibuttonentry
29305 * @param obj The multibuttonentry object
29306 * @return The first item, or NULL if none
29309 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
29311 * Get the last item in the multibuttonentry
29313 * @param obj The multibuttonentry object
29314 * @return The last item, or NULL if none
29317 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
29319 * Get the selected item in the multibuttonentry
29321 * @param obj The multibuttonentry object
29322 * @return The selected item, or NULL if none
29325 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
29327 * Set the selected state of an item
29329 * @param item The item
29330 * @param selected if it's EINA_TRUE, select the item otherwise, unselect the item
29333 EAPI void elm_multibuttonentry_item_select(Elm_Multibuttonentry_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
29335 * unselect all items.
29337 * @param obj The multibuttonentry object
29340 EAPI void elm_multibuttonentry_item_unselect_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
29342 * Delete a given item
29344 * @param item The item
29347 EAPI void elm_multibuttonentry_item_del(Elm_Multibuttonentry_Item *item) EINA_ARG_NONNULL(1);
29349 * Remove all items in the multibuttonentry.
29351 * @param obj The multibuttonentry object
29354 EAPI void elm_multibuttonentry_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
29356 * Get the label of a given item
29358 * @param item The item
29359 * @return The label of a given item, or NULL if none
29362 EAPI const char *elm_multibuttonentry_item_label_get(const Elm_Multibuttonentry_Item *item) EINA_ARG_NONNULL(1);
29364 * Set the label of a given item
29366 * @param item The item
29367 * @param label The text label string
29370 EAPI void elm_multibuttonentry_item_label_set(Elm_Multibuttonentry_Item *item, const char *str) EINA_ARG_NONNULL(1);
29372 * Get the previous item in the multibuttonentry
29374 * @param item The item
29375 * @return The item before the item @p item
29378 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_prev_get(const Elm_Multibuttonentry_Item *item) EINA_ARG_NONNULL(1);
29380 * Get the next item in the multibuttonentry
29382 * @param item The item
29383 * @return The item after the item @p item
29386 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_next_get(const Elm_Multibuttonentry_Item *item) EINA_ARG_NONNULL(1);
29388 * Append a item filter function for text inserted in the Multibuttonentry
29390 * Append the given callback to the list. This functions will be called
29391 * whenever any text is inserted into the Multibuttonentry, with the text to be inserted
29392 * as a parameter. The callback function is free to alter the text in any way
29393 * it wants, but it must remember to free the given pointer and update it.
29394 * If the new text is to be discarded, the function can free it and set it text
29395 * parameter to NULL. This will also prevent any following filters from being
29398 * @param obj The multibuttonentryentry object
29399 * @param func The function to use as item filter
29400 * @param data User data to pass to @p func
29403 EAPI void elm_multibuttonentry_item_filter_append(Evas_Object *obj, Elm_Multibuttonentry_Item_Filter_callback func, void *data) EINA_ARG_NONNULL(1);
29405 * Prepend a filter function for text inserted in the Multibuttentry
29407 * Prepend the given callback to the list. See elm_multibuttonentry_item_filter_append()
29408 * for more information
29410 * @param obj The multibuttonentry object
29411 * @param func The function to use as text filter
29412 * @param data User data to pass to @p func
29415 EAPI void elm_multibuttonentry_item_filter_prepend(Evas_Object *obj, Elm_Multibuttonentry_Item_Filter_callback func, void *data) EINA_ARG_NONNULL(1);
29417 * Remove a filter from the list
29419 * Removes the given callback from the filter list. See elm_multibuttonentry_item_filter_append()
29420 * for more information.
29422 * @param obj The multibuttonentry object
29423 * @param func The filter function to remove
29424 * @param data The user data passed when adding the function
29427 EAPI void elm_multibuttonentry_item_filter_remove(Evas_Object *obj, Elm_Multibuttonentry_Item_Filter_callback func, void *data) EINA_ARG_NONNULL(1);