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 in which the widgets will be
35 @section license License
37 LGPL v2 (see COPYING in the base of Elementary's source). This applies to
38 all files in the source tree.
40 @section ack Acknowledgements
41 There is a lot that goes into making a widget set, and they don't happen out of
42 nothing. It's like trying to make everyone everywhere happy, regardless of age,
43 gender, race or nationality - and that is really tough. So thanks to people and
44 organisations behind this, as listed in the @ref authors page.
49 * @defgroup Start Getting Started
51 * To write an Elementary app, you can get started with the following:
54 #include <Elementary.h>
56 elm_main(int argc, char **argv)
58 // create window(s) here and do any application init
59 elm_run(); // run main loop
60 elm_shutdown(); // after mainloop finishes running, shutdown
61 return 0; // exit 0 for exit code
66 * To use autotools (which helps in many ways in the long run, like being able
67 * to immediately create releases of your software directly from your tree
68 * and ensure everything needed to build it is there) you will need a
69 * configure.ac, Makefile.am and autogen.sh file.
74 AC_INIT(myapp, 0.0.0, myname@mydomain.com)
76 AC_CONFIG_SRCDIR(configure.ac)
77 AM_CONFIG_HEADER(config.h)
79 AM_INIT_AUTOMAKE(1.6 dist-bzip2)
80 PKG_CHECK_MODULES([ELEMENTARY], elementary)
87 AUTOMAKE_OPTIONS = 1.4 foreign
88 MAINTAINERCLEANFILES = Makefile.in aclocal.m4 config.h.in configure depcomp install-sh missing
90 INCLUDES = -I$(top_srcdir)
94 myapp_SOURCES = main.c
95 myapp_LDADD = @ELEMENTARY_LIBS@
96 myapp_CFLAGS = @ELEMENTARY_CFLAGS@
103 echo "Running aclocal..." ; aclocal $ACLOCAL_FLAGS || exit 1
104 echo "Running autoheader..." ; autoheader || exit 1
105 echo "Running autoconf..." ; autoconf || exit 1
106 echo "Running automake..." ; automake --add-missing --copy --gnu || exit 1
110 * To generate all the things needed to bootstrap just run:
116 * This will generate Makefile.in's, the confgure script and everything else.
117 * After this it works like all normal autotools projects:
124 * Note sudo was assumed to get root permissions, as this would install in
125 * /usr/local which is system-owned. Use any way you like to gain root, or
126 * specify a different prefix with configure:
129 ./confiugre --prefix=$HOME/mysoftware
132 * Also remember that autotools buys you some useful commands like:
137 * This uninstalls the software after it was installed with "make install".
138 * It is very useful to clear up what you built if you wish to clean the
145 * This firstly checks if your build tree is "clean" and ready for
146 * distribution. It also builds a tarball (myapp-0.0.0.tar.gz) that is
147 * ready to upload and distribute to the world, that contains the generated
148 * Makefile.in's and configure script. The users do not need to run
149 * autogen.sh - just configure and on. They don't need autotools installed.
150 * This tarball also builds cleanly, has all the sources it needs to build
151 * included (that is sources for your application, not libraries it depends
152 * on like Elementary). It builds cleanly in a buildroot and does not
153 * contain any files that are temporarily generated like binaries and other
154 * build-generated files, so the tarball is clean, and no need to worry
155 * about cleaning up your tree before packaging.
161 * This cleans up all build files (binaries, objects etc.) from the tree.
167 * This cleans out all files from the build and from configure's output too.
170 make maintainer-clean
173 * This deletes all the files autogen.sh will produce so the tree is clean
174 * to be put into a revision-control system (like CVS, SVN or GIT for example).
176 * There is a more advanced way of making use of the quicklaunch infrastructure
177 * in Elementary (which will not be covered here due to its more advanced
180 * Now let's actually create an interactive "Hello World" gui that you can
181 * click the ok button to exit. It's more code because this now does something
182 * much more significant, but it's still very simple:
185 #include <Elementary.h>
188 on_done(void *data, Evas_Object *obj, void *event_info)
190 // quit the mainloop (elm_run function will return)
195 elm_main(int argc, char **argv)
197 Evas_Object *win, *bg, *box, *lab, *btn;
199 // new window - do the usual and give it a name, title and delete handler
200 win = elm_win_add(NULL, "hello", ELM_WIN_BASIC);
201 elm_win_title_set(win, "Hello");
202 // when the user clicks "close" on a window there is a request to delete
203 evas_object_smart_callback_add(win, "delete,request", on_done, NULL);
206 bg = elm_bg_add(win);
207 // add object as a resize object for the window (controls window minimum
208 // size as well as gets resized if window is resized)
209 elm_win_resize_object_add(win, bg);
210 evas_object_show(bg);
212 // add a box object - default is vertical. a box holds children in a row,
213 // either horizontally or vertically. nothing more.
214 box = elm_box_add(win);
215 // make the box hotizontal
216 elm_box_horizontal_set(box, EINA_TRUE);
217 // add object as a resize object for the window (controls window minimum
218 // size as well as gets resized if window is resized)
219 elm_win_resize_object_add(win, box);
220 evas_object_show(box);
222 // add a label widget, set the text and put it in the pad frame
223 lab = elm_label_add(win);
224 // set default text of the label
225 elm_object_text_set(lab, "Hello out there world!");
226 // pack the label at the end of the box
227 elm_box_pack_end(box, lab);
228 evas_object_show(lab);
231 btn = elm_button_add(win);
232 // set default text of button to "OK"
233 elm_object_text_set(btn, "OK");
234 // pack the button at the end of the box
235 elm_box_pack_end(box, btn);
236 evas_object_show(btn);
237 // call on_done when button is clicked
238 evas_object_smart_callback_add(btn, "clicked", on_done, NULL);
240 // now we are done, show the window
241 evas_object_show(win);
243 // run the mainloop and process events and callbacks
253 @page authors Authors
254 @author Carsten Haitzler <raster@@rasterman.com>
255 @author Gustavo Sverzut Barbieri <barbieri@@profusion.mobi>
256 @author Cedric Bail <cedric.bail@@free.fr>
257 @author Vincent Torri <vtorri@@univ-evry.fr>
258 @author Daniel Kolesa <quaker66@@gmail.com>
259 @author Jaime Thomas <avi.thomas@@gmail.com>
260 @author Swisscom - http://www.swisscom.ch/
261 @author Christopher Michael <devilhorns@@comcast.net>
262 @author Marco Trevisan (Treviño) <mail@@3v1n0.net>
263 @author Michael Bouchaud <michael.bouchaud@@gmail.com>
264 @author Jonathan Atton (Watchwolf) <jonathan.atton@@gmail.com>
265 @author Brian Wang <brian.wang.0721@@gmail.com>
266 @author Mike Blumenkrantz (zmike) <mike@@zentific.com>
267 @author Samsung Electronics <tbd>
268 @author Samsung SAIT <tbd>
269 @author Brett Nash <nash@@nash.id.au>
270 @author Bruno Dilly <bdilly@@profusion.mobi>
271 @author Rafael Fonseca <rfonseca@@profusion.mobi>
272 @author Chuneon Park <hermet@@hermet.pe.kr>
273 @author Woohyun Jung <wh0705.jung@@samsung.com>
274 @author Jaehwan Kim <jae.hwan.kim@@samsung.com>
275 @author Wonguk Jeong <wonguk.jeong@@samsung.com>
276 @author Leandro A. F. Pereira <leandro@@profusion.mobi>
277 @author Helen Fornazier <helen.fornazier@@profusion.mobi>
278 @author Gustavo Lima Chaves <glima@@profusion.mobi>
279 @author Fabiano Fidêncio <fidencio@@profusion.mobi>
280 @author Tiago Falcão <tiago@@profusion.mobi>
281 @author Otavio Pontes <otavio@@profusion.mobi>
282 @author Viktor Kojouharov <vkojouharov@@gmail.com>
283 @author Daniel Juyung Seo (SeoZ) <juyung.seo@@samsung.com> <seojuyung2@@gmail.com>
284 @author Sangho Park <sangho.g.park@@samsung.com> <gouache95@@gmail.com>
285 @author Rajeev Ranjan (Rajeev) <rajeev.r@@samsung.com> <rajeev.jnnce@@gmail.com>
286 @author Seunggyun Kim <sgyun.kim@@samsung.com> <tmdrbs@@gmail.com>
287 @author Sohyun Kim <anna1014.kim@@samsung.com> <sohyun.anna@@gmail.com>
288 @author Jihoon Kim <jihoon48.kim@@samsung.com>
289 @author Jeonghyun Yun (arosis) <jh0506.yun@@samsung.com>
290 @author Tom Hacohen <tom@@stosb.com>
291 @author Aharon Hillel <a.hillel@@partner.samsung.com>
292 @author Jonathan Atton (Watchwolf) <jonathan.atton@@gmail.com>
293 @author Shinwoo Kim <kimcinoo@@gmail.com>
294 @author Govindaraju SM <govi.sm@@samsung.com> <govism@@gmail.com>
295 @author Prince Kumar Dubey <prince.dubey@@samsung.com> <prince.dubey@@gmail.com>
296 @author Sung W. Park <sungwoo@gmail.com>
297 @author Thierry el Borgi <thierry@substantiel.fr>
298 @author Shilpa Singh <shilpa.singh@samsung.com> <shilpasingh.o@gmail.com>
299 @author Chanwook Jung <joey.jung@samsung.com>
301 Please contact <enlightenment-devel@lists.sourceforge.net> to get in
302 contact with the developers and maintainers.
310 * @brief Elementary's API
315 @ELM_UNIX_DEF@ ELM_UNIX
316 @ELM_WIN32_DEF@ ELM_WIN32
317 @ELM_WINCE_DEF@ ELM_WINCE
318 @ELM_EDBUS_DEF@ ELM_EDBUS
319 @ELM_EFREET_DEF@ ELM_EFREET
320 @ELM_ETHUMB_DEF@ ELM_ETHUMB
321 @ELM_EMAP_DEF@ ELM_EMAP
322 @ELM_DEBUG_DEF@ ELM_DEBUG
323 @ELM_ALLOCA_H_DEF@ ELM_ALLOCA_H
324 @ELM_LIBINTL_H_DEF@ ELM_LIBINTL_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>
347 # ifdef ELM_LIBINTL_H
348 # include <libintl.h>
359 #if defined (ELM_WIN32) || defined (ELM_WINCE)
362 # define alloca _alloca
373 #include <Ecore_Evas.h>
374 #include <Ecore_File.h>
375 #include <Ecore_IMF.h>
376 #include <Ecore_Con.h>
385 # include <Efreet_Mime.h>
386 # include <Efreet_Trash.h>
390 # include <Ethumb_Client.h>
402 # ifdef ELEMENTARY_BUILD
404 # define EAPI __declspec(dllexport)
407 # endif /* ! DLL_EXPORT */
409 # define EAPI __declspec(dllimport)
410 # endif /* ! EFL_EVAS_BUILD */
414 # define EAPI __attribute__ ((visibility("default")))
421 #endif /* ! _WIN32 */
424 /* allow usage from c++ */
429 #define ELM_VERSION_MAJOR @VMAJ@
430 #define ELM_VERSION_MINOR @VMIN@
432 typedef struct _Elm_Version
440 EAPI extern Elm_Version *elm_version;
443 #define ELM_RECTS_INTERSECT(x, y, w, h, xx, yy, ww, hh) (((x) < ((xx) + (ww))) && ((y) < ((yy) + (hh))) && (((x) + (w)) > (xx)) && (((y) + (h)) > (yy)))
444 #define ELM_PI 3.14159265358979323846
447 * @defgroup General General
449 * @brief General Elementary API. Functions that don't relate to
450 * Elementary objects specifically.
452 * Here are documented functions which init/shutdown the library,
453 * that apply to generic Elementary objects, that deal with
454 * configuration, et cetera.
456 * @ref general_functions_example_page "This" example contemplates
457 * some of these functions.
461 * @addtogroup General
466 * Defines couple of standard Evas_Object layers to be used
467 * with evas_object_layer_set().
469 * @note whenever extending with new values, try to keep some padding
470 * to siblings so there is room for further extensions.
472 typedef enum _Elm_Object_Layer
474 ELM_OBJECT_LAYER_BACKGROUND = EVAS_LAYER_MIN + 64, /**< where to place backgrounds */
475 ELM_OBJECT_LAYER_DEFAULT = 0, /**< Evas_Object default layer (and thus for Elementary) */
476 ELM_OBJECT_LAYER_FOCUS = EVAS_LAYER_MAX - 128, /**< where focus object visualization is */
477 ELM_OBJECT_LAYER_TOOLTIP = EVAS_LAYER_MAX - 64, /**< where to show tooltips */
478 ELM_OBJECT_LAYER_CURSOR = EVAS_LAYER_MAX - 32, /**< where to show cursors */
479 ELM_OBJECT_LAYER_LAST /**< last layer known by Elementary */
482 /**************************************************************************/
483 EAPI extern int ELM_ECORE_EVENT_ETHUMB_CONNECT;
486 * Emitted when any Elementary's policy value is changed.
488 EAPI extern int ELM_EVENT_POLICY_CHANGED;
491 * @typedef Elm_Event_Policy_Changed
493 * Data on the event when an Elementary policy has changed
495 typedef struct _Elm_Event_Policy_Changed Elm_Event_Policy_Changed;
498 * @struct _Elm_Event_Policy_Changed
500 * Data on the event when an Elementary policy has changed
502 struct _Elm_Event_Policy_Changed
504 unsigned int policy; /**< the policy identifier */
505 int new_value; /**< value the policy had before the change */
506 int old_value; /**< new value the policy got */
510 * Policy identifiers.
512 typedef enum _Elm_Policy
514 ELM_POLICY_QUIT, /**< under which circumstances the application
515 * should quit automatically. @see
519 } Elm_Policy; /**< Elementary policy identifiers/groups enumeration. @see elm_policy_set()
522 typedef enum _Elm_Policy_Quit
524 ELM_POLICY_QUIT_NONE = 0, /**< never quit the application
526 ELM_POLICY_QUIT_LAST_WINDOW_CLOSED /**< quit when the
528 * window is closed */
529 } Elm_Policy_Quit; /**< Possible values for the #ELM_POLICY_QUIT policy */
531 typedef enum _Elm_Focus_Direction
535 } Elm_Focus_Direction;
537 typedef enum _Elm_Text_Format
539 ELM_TEXT_FORMAT_PLAIN_UTF8,
540 ELM_TEXT_FORMAT_MARKUP_UTF8
544 * Line wrapping types.
546 typedef enum _Elm_Wrap_Type
548 ELM_WRAP_NONE = 0, /**< No wrap - value is zero */
549 ELM_WRAP_CHAR, /**< Char wrap - wrap between characters */
550 ELM_WRAP_WORD, /**< Word wrap - wrap in allowed wrapping points (as defined in the unicode standard) */
551 ELM_WRAP_MIXED, /**< Mixed wrap - Word wrap, and if that fails, char wrap. */
556 * @typedef Elm_Object_Item
557 * An Elementary Object item handle.
560 typedef struct _Elm_Object_Item Elm_Object_Item;
564 * Called back when a widget's tooltip is activated and needs content.
565 * @param data user-data given to elm_object_tooltip_content_cb_set()
566 * @param obj owner widget.
567 * @param tooltip The tooltip object (affix content to this!)
569 typedef Evas_Object *(*Elm_Tooltip_Content_Cb) (void *data, Evas_Object *obj, Evas_Object *tooltip);
572 * Called back when a widget's item tooltip is activated and needs content.
573 * @param data user-data given to elm_object_tooltip_content_cb_set()
574 * @param obj owner widget.
575 * @param tooltip The tooltip object (affix content to this!)
576 * @param item context dependent item. As an example, if tooltip was
577 * set on Elm_List_Item, then it is of this type.
579 typedef Evas_Object *(*Elm_Tooltip_Item_Content_Cb) (void *data, Evas_Object *obj, Evas_Object *tooltip, void *item);
581 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. */
583 #ifndef ELM_LIB_QUICKLAUNCH
584 #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 */
586 #define ELM_MAIN() int main(int argc, char **argv) {return elm_quicklaunch_fallback(argc, argv);} /**< macro to be used after the elm_main() function */
589 /**************************************************************************/
593 * Initialize Elementary
595 * @param[in] argc System's argument count value
596 * @param[in] argv System's pointer to array of argument strings
597 * @return The init counter value.
599 * This function initializes Elementary and increments a counter of
600 * the number of calls to it. It returns the new counter's value.
602 * @warning This call is exported only for use by the @c ELM_MAIN()
603 * macro. There is no need to use this if you use this macro (which
604 * is highly advisable). An elm_main() should contain the entry
605 * point code for your application, having the same prototype as
606 * elm_init(), and @b not being static (putting the @c EAPI symbol
607 * in front of its type declaration is advisable). The @c
608 * ELM_MAIN() call should be placed just after it.
611 * @dontinclude bg_example_01.c
615 * See the full @ref bg_example_01_c "example".
617 * @see elm_shutdown().
620 EAPI int elm_init(int argc, char **argv);
623 * Shut down Elementary
625 * @return The init counter value.
627 * This should be called at the end of your application, just
628 * before it ceases to do any more processing. This will clean up
629 * any permanent resources your application may have allocated via
630 * Elementary that would otherwise persist.
632 * @see elm_init() for an example
636 EAPI int elm_shutdown(void);
639 * Run Elementary's main loop
641 * This call should be issued just after all initialization is
642 * completed. This function will not return until elm_exit() is
643 * called. It will keep looping, running the main
644 * (event/processing) loop for Elementary.
646 * @see elm_init() for an example
650 EAPI void elm_run(void);
653 * Exit Elementary's main loop
655 * If this call is issued, it will flag the main loop to cease
656 * processing and return back to its parent function (usually your
657 * elm_main() function).
659 * @see elm_init() for an example. There, just after a request to
660 * close the window comes, the main loop will be left.
662 * @note By using the #ELM_POLICY_QUIT on your Elementary
663 * applications, you'll this function called automatically for you.
667 EAPI void elm_exit(void);
670 * Provide information in order to make Elementary determine the @b
671 * run time location of the software in question, so other data files
672 * such as images, sound files, executable utilities, libraries,
673 * modules and locale files can be found.
675 * @param mainfunc This is your application's main function name,
676 * whose binary's location is to be found. Providing @c NULL
677 * will make Elementary not to use it
678 * @param dom This will be used as the application's "domain", in the
679 * form of a prefix to any environment variables that may
680 * override prefix detection and the directory name, inside the
681 * standard share or data directories, where the software's
682 * data files will be looked for.
683 * @param checkfile This is an (optional) magic file's path to check
684 * for existence (and it must be located in the data directory,
685 * under the share directory provided above). Its presence will
686 * help determine the prefix found was correct. Pass @c NULL if
687 * the check is not to be done.
689 * This function allows one to re-locate the application somewhere
690 * else after compilation, if the developer wishes for easier
691 * distribution of pre-compiled binaries.
693 * The prefix system is designed to locate where the given software is
694 * installed (under a common path prefix) at run time and then report
695 * specific locations of this prefix and common directories inside
696 * this prefix like the binary, library, data and locale directories,
697 * through the @c elm_app_*_get() family of functions.
699 * Call elm_app_info_set() early on before you change working
700 * directory or anything about @c argv[0], so it gets accurate
703 * It will then try and trace back which file @p mainfunc comes from,
704 * if provided, to determine the application's prefix directory.
706 * The @p dom parameter provides a string prefix to prepend before
707 * environment variables, allowing a fallback to @b specific
708 * environment variables to locate the software. You would most
709 * probably provide a lowercase string there, because it will also
710 * serve as directory domain, explained next. For environment
711 * variables purposes, this string is made uppercase. For example if
712 * @c "myapp" is provided as the prefix, then the program would expect
713 * @c "MYAPP_PREFIX" as a master environment variable to specify the
714 * exact install prefix for the software, or more specific environment
715 * variables like @c "MYAPP_BIN_DIR", @c "MYAPP_LIB_DIR", @c
716 * "MYAPP_DATA_DIR" and @c "MYAPP_LOCALE_DIR", which could be set by
717 * the user or scripts before launching. If not provided (@c NULL),
718 * environment variables will not be used to override compiled-in
719 * defaults or auto detections.
721 * The @p dom string also provides a subdirectory inside the system
722 * shared data directory for data files. For example, if the system
723 * directory is @c /usr/local/share, then this directory name is
724 * appended, creating @c /usr/local/share/myapp, if it @p was @c
725 * "myapp". It is expected the application installs data files in
728 * The @p checkfile is a file name or path of something inside the
729 * share or data directory to be used to test that the prefix
730 * detection worked. For example, your app will install a wallpaper
731 * image as @c /usr/local/share/myapp/images/wallpaper.jpg and so to
732 * check that this worked, provide @c "images/wallpaper.jpg" as the @p
735 * @see elm_app_compile_bin_dir_set()
736 * @see elm_app_compile_lib_dir_set()
737 * @see elm_app_compile_data_dir_set()
738 * @see elm_app_compile_locale_set()
739 * @see elm_app_prefix_dir_get()
740 * @see elm_app_bin_dir_get()
741 * @see elm_app_lib_dir_get()
742 * @see elm_app_data_dir_get()
743 * @see elm_app_locale_dir_get()
745 EAPI void elm_app_info_set(void *mainfunc, const char *dom, const char *checkfile);
748 * Provide information on the @b fallback application's binaries
749 * directory, on scenarios where they get overriden by
750 * elm_app_info_set().
752 * @param dir The path to the default binaries directory (compile time
755 * @note Elementary will as well use this path to determine actual
756 * names of binaries' directory paths, maybe changing it to be @c
757 * something/local/bin instead of @c something/bin, only, for
760 * @warning You should call this function @b before
761 * elm_app_info_set().
763 EAPI void elm_app_compile_bin_dir_set(const char *dir);
766 * Provide information on the @b fallback application's libraries
767 * directory, on scenarios where they get overriden by
768 * elm_app_info_set().
770 * @param dir The path to the default libraries directory (compile
773 * @note Elementary will as well use this path to determine actual
774 * names of libraries' directory paths, maybe changing it to be @c
775 * something/lib32 or @c something/lib64 instead of @c something/lib,
778 * @warning You should call this function @b before
779 * elm_app_info_set().
781 EAPI void elm_app_compile_lib_dir_set(const char *dir);
784 * Provide information on the @b fallback application's data
785 * directory, on scenarios where they get overriden by
786 * elm_app_info_set().
788 * @param dir The path to the default data directory (compile time
791 * @note Elementary will as well use this path to determine actual
792 * names of data directory paths, maybe changing it to be @c
793 * something/local/share instead of @c something/share, only, for
796 * @warning You should call this function @b before
797 * elm_app_info_set().
799 EAPI void elm_app_compile_data_dir_set(const char *dir);
802 * Provide information on the @b fallback application's locale
803 * directory, on scenarios where they get overriden by
804 * elm_app_info_set().
806 * @param dir The path to the default locale directory (compile time
809 * @warning You should call this function @b before
810 * elm_app_info_set().
812 EAPI void elm_app_compile_locale_set(const char *dir);
815 * Retrieve the application's run time prefix directory, as set by
816 * elm_app_info_set() and the way (environment) the application was
819 * @return The directory prefix the application is actually using
821 EAPI const char *elm_app_prefix_dir_get(void);
824 * Retrieve the application's run time binaries prefix directory, as
825 * set by elm_app_info_set() and the way (environment) the application
828 * @return The binaries directory prefix the application is actually
831 EAPI const char *elm_app_bin_dir_get(void);
834 * Retrieve the application's run time libraries prefix directory, as
835 * set by elm_app_info_set() and the way (environment) the application
838 * @return The libraries directory prefix the application is actually
841 EAPI const char *elm_app_lib_dir_get(void);
844 * Retrieve the application's run time data prefix directory, as
845 * set by elm_app_info_set() and the way (environment) the application
848 * @return The data directory prefix the application is actually
851 EAPI const char *elm_app_data_dir_get(void);
854 * Retrieve the application's run time locale prefix directory, as
855 * set by elm_app_info_set() and the way (environment) the application
858 * @return The locale directory prefix the application is actually
861 EAPI const char *elm_app_locale_dir_get(void);
863 EAPI void elm_quicklaunch_mode_set(Eina_Bool ql_on);
864 EAPI Eina_Bool elm_quicklaunch_mode_get(void);
865 EAPI int elm_quicklaunch_init(int argc, char **argv);
866 EAPI int elm_quicklaunch_sub_init(int argc, char **argv);
867 EAPI int elm_quicklaunch_sub_shutdown(void);
868 EAPI int elm_quicklaunch_shutdown(void);
869 EAPI void elm_quicklaunch_seed(void);
870 EAPI Eina_Bool elm_quicklaunch_prepare(int argc, char **argv);
871 EAPI Eina_Bool elm_quicklaunch_fork(int argc, char **argv, char *cwd, void (postfork_func) (void *data), void *postfork_data);
872 EAPI void elm_quicklaunch_cleanup(void);
873 EAPI int elm_quicklaunch_fallback(int argc, char **argv);
874 EAPI char *elm_quicklaunch_exe_path_get(const char *exe);
876 EAPI Eina_Bool elm_need_efreet(void);
877 EAPI Eina_Bool elm_need_e_dbus(void);
880 * This must be called before any other function that handle with
881 * elm_thumb objects or ethumb_client instances.
885 EAPI Eina_Bool elm_need_ethumb(void);
888 * Set a new policy's value (for a given policy group/identifier).
890 * @param policy policy identifier, as in @ref Elm_Policy.
891 * @param value policy value, which depends on the identifier
893 * @return @c EINA_TRUE on success or @c EINA_FALSE, on error.
895 * Elementary policies define applications' behavior,
896 * somehow. These behaviors are divided in policy groups (see
897 * #Elm_Policy enumeration). This call will emit the Ecore event
898 * #ELM_EVENT_POLICY_CHANGED, which can be hooked at with
899 * handlers. An #Elm_Event_Policy_Changed struct will be passed,
902 * @note Currently, we have only one policy identifier/group
903 * (#ELM_POLICY_QUIT), which has two possible values.
907 EAPI Eina_Bool elm_policy_set(unsigned int policy, int value);
910 * Gets the policy value set for given policy identifier.
912 * @param policy policy identifier, as in #Elm_Policy.
913 * @return The currently set policy value, for that
914 * identifier. Will be @c 0 if @p policy passed is invalid.
918 EAPI int elm_policy_get(unsigned int policy);
921 * Set a label of an object
923 * @param obj The Elementary object
924 * @param part The text part name to set (NULL for the default label)
925 * @param label The new text of the label
927 * @note Elementary objects may have many labels (e.g. Action Slider)
931 EAPI void elm_object_text_part_set(Evas_Object *obj, const char *part, const char *label);
933 #define elm_object_text_set(obj, label) elm_object_text_part_set((obj), NULL, (label))
936 * Get a label of an object
938 * @param obj The Elementary object
939 * @param part The text part name to get (NULL for the default label)
940 * @return text of the label or NULL for any error
942 * @note Elementary objects may have many labels (e.g. Action Slider)
946 EAPI const char *elm_object_text_part_get(const Evas_Object *obj, const char *part);
948 #define elm_object_text_get(obj) elm_object_text_part_get((obj), NULL)
951 * Set a content of an object
953 * @param obj The Elementary object
954 * @param part The content part name to set (NULL for the default content)
955 * @param content The new content of the object
957 * @note Elementary objects may have many contents
961 EAPI void elm_object_content_part_set(Evas_Object *obj, const char *part, Evas_Object *content);
963 #define elm_object_content_set(obj, content) elm_object_content_part_set((obj), NULL, (content))
966 * Get a content of an object
968 * @param obj The Elementary object
969 * @param item The content part name to get (NULL for the default content)
970 * @return content of the object or NULL for any error
972 * @note Elementary objects may have many contents
976 EAPI Evas_Object *elm_object_content_part_get(const Evas_Object *obj, const char *part);
978 #define elm_object_content_get(obj) elm_object_content_part_get((obj), NULL)
981 * Unset a content of an object
983 * @param obj The Elementary object
984 * @param item The content part name to unset (NULL for the default content)
986 * @note Elementary objects may have many contents
990 EAPI Evas_Object *elm_object_content_part_unset(Evas_Object *obj, const char *part);
992 #define elm_object_content_unset(obj) elm_object_content_part_unset((obj), NULL)
995 * Set a content of an object item
997 * @param it The Elementary object item
998 * @param part The content part name to unset (NULL for the default content)
999 * @param content The new content of the object item
1001 * @note Elementary object items may have many contents
1005 EAPI void elm_object_item_content_part_set(Elm_Object_Item *it, const char *part, Evas_Object *content);
1007 #define elm_object_item_content_set(it, content) elm_object_item_content_part_set((it), NULL, (content))
1010 * Get a content of an object item
1012 * @param it The Elementary object item
1013 * @param part The content part name to unset (NULL for the default content)
1014 * @return content of the object item or NULL for any error
1016 * @note Elementary object items may have many contents
1020 EAPI Evas_Object *elm_object_item_content_part_get(const Elm_Object_Item *it, const char *item);
1022 #define elm_object_item_content_get(it, content) elm_object_item_content_part_get((it), NULL, (content))
1025 * Unset a content of an object item
1027 * @param it The Elementary object item
1028 * @param part The content part name to unset (NULL for the default content)
1030 * @note Elementary object items may have many contents
1034 EAPI Evas_Object *elm_object_item_content_part_unset(Elm_Object_Item *it, const char *part);
1036 #define elm_object_item_content_unset(it, content) elm_object_item_content_part_unset((it), (content))
1039 * Set a label of an objec itemt
1041 * @param it The Elementary object item
1042 * @param part The text part name to set (NULL for the default label)
1043 * @param label The new text of the label
1045 * @note Elementary object items may have many labels
1049 EAPI void elm_object_item_text_part_set(Elm_Object_Item *it, const char *part, const char *label);
1051 #define elm_object_item_text_set(it, label) elm_object_item_text_part_set((it), NULL, (label))
1054 * Get a label of an object
1056 * @param it The Elementary object item
1057 * @param part The text part name to get (NULL for the default label)
1058 * @return text of the label or NULL for any error
1060 * @note Elementary object items may have many labels
1064 EAPI const char *elm_object_item_text_part_get(const Elm_Object_Item *it, const char *part);
1067 * Set the text to read out when in accessibility mode
1069 * @param obj The object which is to be described
1070 * @param txt The text that describes the widget to people with poor or no vision
1074 EAPI void elm_object_access_info_set(Evas_Object *obj, const char *txt);
1077 * Set the text to read out when in accessibility mode
1079 * @param it The object item which is to be described
1080 * @param txt The text that describes the widget to people with poor or no vision
1084 EAPI void elm_object_item_access_info_set(Elm_Object_Item *it, const char *txt);
1087 #define elm_object_item_text_get(it) elm_object_item_text_part_get((it), NULL)
1094 * @defgroup Caches Caches
1096 * These are functions which let one fine-tune some cache values for
1097 * Elementary applications, thus allowing for performance adjustments.
1103 * @brief Flush all caches.
1105 * Frees all data that was in cache and is not currently being used to reduce
1106 * memory usage. This frees Edje's, Evas' and Eet's cache. This is equivalent
1107 * to calling all of the following functions:
1108 * @li edje_file_cache_flush()
1109 * @li edje_collection_cache_flush()
1110 * @li eet_clearcache()
1111 * @li evas_image_cache_flush()
1112 * @li evas_font_cache_flush()
1113 * @li evas_render_dump()
1114 * @note Evas caches are flushed for every canvas associated with a window.
1118 EAPI void elm_all_flush(void);
1121 * Get the configured cache flush interval time
1123 * This gets the globally configured cache flush interval time, in
1126 * @return The cache flush interval time
1129 * @see elm_all_flush()
1131 EAPI int elm_cache_flush_interval_get(void);
1134 * Set the configured cache flush interval time
1136 * This sets the globally configured cache flush interval time, in ticks
1138 * @param size The cache flush interval time
1141 * @see elm_all_flush()
1143 EAPI void elm_cache_flush_interval_set(int size);
1146 * Set the configured cache flush interval time for all applications on the
1149 * This sets the globally configured cache flush interval time -- in ticks
1150 * -- for all applications on the display.
1152 * @param size The cache flush interval time
1155 EAPI void elm_cache_flush_interval_all_set(int size);
1158 * Get the configured cache flush enabled state
1160 * This gets the globally configured cache flush state - if it is enabled
1161 * or not. When cache flushing is enabled, elementary will regularly
1162 * (see elm_cache_flush_interval_get() ) flush caches and dump data out of
1163 * memory and allow usage to re-seed caches and data in memory where it
1164 * can do so. An idle application will thus minimise its memory usage as
1165 * data will be freed from memory and not be re-loaded as it is idle and
1166 * not rendering or doing anything graphically right now.
1168 * @return The cache flush state
1171 * @see elm_all_flush()
1173 EAPI Eina_Bool elm_cache_flush_enabled_get(void);
1176 * Set the configured cache flush enabled state
1178 * This sets the globally configured cache flush enabled state
1180 * @param size The cache flush enabled state
1183 * @see elm_all_flush()
1185 EAPI void elm_cache_flush_enabled_set(Eina_Bool enabled);
1188 * Set the configured cache flush enabled state for all applications on the
1191 * This sets the globally configured cache flush enabled state for all
1192 * applications on the display.
1194 * @param size The cache flush enabled state
1197 EAPI void elm_cache_flush_enabled_all_set(Eina_Bool enabled);
1200 * Get the configured font cache size
1202 * This gets the globally configured font cache size, in bytes
1204 * @return The font cache size
1207 EAPI int elm_font_cache_get(void);
1210 * Set the configured font cache size
1212 * This sets the globally configured font cache size, in bytes
1214 * @param size The font cache size
1217 EAPI void elm_font_cache_set(int size);
1220 * Set the configured font cache size for all applications on the
1223 * This sets the globally configured font cache size -- in bytes
1224 * -- for all applications on the display.
1226 * @param size The font cache size
1229 EAPI void elm_font_cache_all_set(int size);
1232 * Get the configured image cache size
1234 * This gets the globally configured image cache size, in bytes
1236 * @return The image cache size
1239 EAPI int elm_image_cache_get(void);
1242 * Set the configured image cache size
1244 * This sets the globally configured image cache size, in bytes
1246 * @param size The image cache size
1249 EAPI void elm_image_cache_set(int size);
1252 * Set the configured image cache size for all applications on the
1255 * This sets the globally configured image cache size -- in bytes
1256 * -- for all applications on the display.
1258 * @param size The image cache size
1261 EAPI void elm_image_cache_all_set(int size);
1264 * Get the configured edje file cache size.
1266 * This gets the globally configured edje file cache size, in number
1269 * @return The edje file cache size
1272 EAPI int elm_edje_file_cache_get(void);
1275 * Set the configured edje file cache size
1277 * This sets the globally configured edje file cache size, in number
1280 * @param size The edje file cache size
1283 EAPI void elm_edje_file_cache_set(int size);
1286 * Set the configured edje file cache size for all applications on the
1289 * This sets the globally configured edje file cache size -- in number
1290 * of files -- for all applications on the display.
1292 * @param size The edje file cache size
1295 EAPI void elm_edje_file_cache_all_set(int size);
1298 * Get the configured edje collections (groups) cache size.
1300 * This gets the globally configured edje collections cache size, in
1301 * number of collections.
1303 * @return The edje collections cache size
1306 EAPI int elm_edje_collection_cache_get(void);
1309 * Set the configured edje collections (groups) cache size
1311 * This sets the globally configured edje collections cache size, in
1312 * number of collections.
1314 * @param size The edje collections cache size
1317 EAPI void elm_edje_collection_cache_set(int size);
1320 * Set the configured edje collections (groups) cache size for all
1321 * applications on the display
1323 * This sets the globally configured edje collections cache size -- in
1324 * number of collections -- for all applications on the display.
1326 * @param size The edje collections cache size
1329 EAPI void elm_edje_collection_cache_all_set(int size);
1336 * @defgroup Scaling Widget Scaling
1338 * Different widgets can be scaled independently. These functions
1339 * allow you to manipulate this scaling on a per-widget basis. The
1340 * object and all its children get their scaling factors multiplied
1341 * by the scale factor set. This is multiplicative, in that if a
1342 * child also has a scale size set it is in turn multiplied by its
1343 * parent's scale size. @c 1.0 means “don't scale”, @c 2.0 is
1344 * double size, @c 0.5 is half, etc.
1346 * @ref general_functions_example_page "This" example contemplates
1347 * some of these functions.
1351 * Get the global scaling factor
1353 * This gets the globally configured scaling factor that is applied to all
1356 * @return The scaling factor
1359 EAPI double elm_scale_get(void);
1362 * Set the global scaling factor
1364 * This sets the globally configured scaling factor that is applied to all
1367 * @param scale The scaling factor to set
1370 EAPI void elm_scale_set(double scale);
1373 * Set the global scaling factor for all applications on the display
1375 * This sets the globally configured scaling factor that is applied to all
1376 * objects for all applications.
1377 * @param scale The scaling factor to set
1380 EAPI void elm_scale_all_set(double scale);
1383 * Set the scaling factor for a given Elementary object
1385 * @param obj The Elementary to operate on
1386 * @param scale Scale factor (from @c 0.0 up, with @c 1.0 meaning
1391 EAPI void elm_object_scale_set(Evas_Object *obj, double scale) EINA_ARG_NONNULL(1);
1394 * Get the scaling factor for a given Elementary object
1396 * @param obj The object
1397 * @return The scaling factor set by elm_object_scale_set()
1401 EAPI double elm_object_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1404 * @defgroup UI-Mirroring Selective Widget mirroring
1406 * These functions allow you to set ui-mirroring on specific
1407 * widgets or the whole interface. Widgets can be in one of two
1408 * modes, automatic and manual. Automatic means they'll be changed
1409 * according to the system mirroring mode and manual means only
1410 * explicit changes will matter. You are not supposed to change
1411 * mirroring state of a widget set to automatic, will mostly work,
1412 * but the behavior is not really defined.
1417 EAPI Eina_Bool elm_mirrored_get(void);
1418 EAPI void elm_mirrored_set(Eina_Bool mirrored);
1421 * Get the system mirrored mode. This determines the default mirrored mode
1424 * @return EINA_TRUE if mirrored is set, EINA_FALSE otherwise
1426 EAPI Eina_Bool elm_object_mirrored_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1429 * Set the system mirrored mode. This determines the default mirrored mode
1432 * @param mirrored EINA_TRUE to set mirrored mode, EINA_FALSE to unset it.
1434 EAPI void elm_object_mirrored_set(Evas_Object *obj, Eina_Bool mirrored) EINA_ARG_NONNULL(1);
1437 * Returns the widget's mirrored mode setting.
1439 * @param obj The widget.
1440 * @return mirrored mode setting of the object.
1443 EAPI Eina_Bool elm_object_mirrored_automatic_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1446 * Sets the widget's mirrored mode setting.
1447 * When widget in automatic mode, it follows the system mirrored mode set by
1448 * elm_mirrored_set().
1449 * @param obj The widget.
1450 * @param automatic EINA_TRUE for auto mirrored mode. EINA_FALSE for manual.
1452 EAPI void elm_object_mirrored_automatic_set(Evas_Object *obj, Eina_Bool automatic) EINA_ARG_NONNULL(1);
1459 * Set the style to use by a widget
1461 * Sets the style name that will define the appearance of a widget. Styles
1462 * vary from widget to widget and may also be defined by other themes
1463 * by means of extensions and overlays.
1465 * @param obj The Elementary widget to style
1466 * @param style The style name to use
1468 * @see elm_theme_extension_add()
1469 * @see elm_theme_extension_del()
1470 * @see elm_theme_overlay_add()
1471 * @see elm_theme_overlay_del()
1475 EAPI void elm_object_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
1477 * Get the style used by the widget
1479 * This gets the style being used for that widget. Note that the string
1480 * pointer is only valid as longas the object is valid and the style doesn't
1483 * @param obj The Elementary widget to query for its style
1484 * @return The style name used
1486 * @see elm_object_style_set()
1490 EAPI const char *elm_object_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1493 * @defgroup Styles Styles
1495 * Widgets can have different styles of look. These generic API's
1496 * set styles of widgets, if they support them (and if the theme(s)
1499 * @ref general_functions_example_page "This" example contemplates
1500 * some of these functions.
1504 * Set the disabled state of an Elementary object.
1506 * @param obj The Elementary object to operate on
1507 * @param disabled The state to put in in: @c EINA_TRUE for
1508 * disabled, @c EINA_FALSE for enabled
1510 * Elementary objects can be @b disabled, in which state they won't
1511 * receive input and, in general, will be themed differently from
1512 * their normal state, usually greyed out. Useful for contexts
1513 * where you don't want your users to interact with some of the
1514 * parts of you interface.
1516 * This sets the state for the widget, either disabling it or
1521 EAPI void elm_object_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
1524 * Get the disabled state of an Elementary object.
1526 * @param obj The Elementary object to operate on
1527 * @return @c EINA_TRUE, if the widget is disabled, @c EINA_FALSE
1528 * if it's enabled (or on errors)
1530 * This gets the state of the widget, which might be enabled or disabled.
1534 EAPI Eina_Bool elm_object_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1537 * @defgroup WidgetNavigation Widget Tree Navigation.
1539 * How to check if an Evas Object is an Elementary widget? How to
1540 * get the first elementary widget that is parent of the given
1541 * object? These are all covered in widget tree navigation.
1543 * @ref general_functions_example_page "This" example contemplates
1544 * some of these functions.
1548 * Check if the given Evas Object is an Elementary widget.
1550 * @param obj the object to query.
1551 * @return @c EINA_TRUE if it is an elementary widget variant,
1552 * @c EINA_FALSE otherwise
1553 * @ingroup WidgetNavigation
1555 EAPI Eina_Bool elm_object_widget_check(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1558 * Get the first parent of the given object that is an Elementary
1561 * @param obj the Elementary object to query parent from.
1562 * @return the parent object that is an Elementary widget, or @c
1563 * NULL, if it was not found.
1565 * Use this to query for an object's parent widget.
1567 * @note Most of Elementary users wouldn't be mixing non-Elementary
1568 * smart objects in the objects tree of an application, as this is
1569 * an advanced usage of Elementary with Evas. So, except for the
1570 * application's window, which is the root of that tree, all other
1571 * objects would have valid Elementary widget parents.
1573 * @ingroup WidgetNavigation
1575 EAPI Evas_Object *elm_object_parent_widget_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1578 * Get the top level parent of an Elementary widget.
1580 * @param obj The object to query.
1581 * @return The top level Elementary widget, or @c NULL if parent cannot be
1583 * @ingroup WidgetNavigation
1585 EAPI Evas_Object *elm_object_top_widget_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1588 * Get the string that represents this Elementary widget.
1590 * @note Elementary is weird and exposes itself as a single
1591 * Evas_Object_Smart_Class of type "elm_widget", so
1592 * evas_object_type_get() always return that, making debug and
1593 * language bindings hard. This function tries to mitigate this
1594 * problem, but the solution is to change Elementary to use
1595 * proper inheritance.
1597 * @param obj the object to query.
1598 * @return Elementary widget name, or @c NULL if not a valid widget.
1599 * @ingroup WidgetNavigation
1601 EAPI const char *elm_object_widget_type_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1604 * @defgroup Config Elementary Config
1606 * Elementary configuration is formed by a set options bounded to a
1607 * given @ref Profile profile, like @ref Theme theme, @ref Fingers
1608 * "finger size", etc. These are functions with which one syncronizes
1609 * changes made to those values to the configuration storing files, de
1610 * facto. You most probably don't want to use the functions in this
1611 * group unlees you're writing an elementary configuration manager.
1617 * Save back Elementary's configuration, so that it will persist on
1620 * @return @c EINA_TRUE, when sucessful. @c EINA_FALSE, otherwise.
1623 * This function will take effect -- thus, do I/O -- immediately. Use
1624 * it when you want to apply all configuration changes at once. The
1625 * current configuration set will get saved onto the current profile
1626 * configuration file.
1629 EAPI Eina_Bool elm_config_save(void);
1632 * Reload Elementary's configuration, bounded to current selected
1635 * @return @c EINA_TRUE, when sucessful. @c EINA_FALSE, otherwise.
1638 * Useful when you want to force reloading of configuration values for
1639 * a profile. If one removes user custom configuration directories,
1640 * for example, it will force a reload with system values insted.
1643 EAPI void elm_config_reload(void);
1650 * @defgroup Profile Elementary Profile
1652 * Profiles are pre-set options that affect the whole look-and-feel of
1653 * Elementary-based applications. There are, for example, profiles
1654 * aimed at desktop computer applications and others aimed at mobile,
1655 * touchscreen-based ones. You most probably don't want to use the
1656 * functions in this group unlees you're writing an elementary
1657 * configuration manager.
1663 * Get Elementary's profile in use.
1665 * This gets the global profile that is applied to all Elementary
1668 * @return The profile's name
1671 EAPI const char *elm_profile_current_get(void);
1674 * Get an Elementary's profile directory path in the filesystem. One
1675 * may want to fetch a system profile's dir or an user one (fetched
1678 * @param profile The profile's name
1679 * @param is_user Whether to lookup for an user profile (@c EINA_TRUE)
1680 * or a system one (@c EINA_FALSE)
1681 * @return The profile's directory path.
1684 * @note You must free it with elm_profile_dir_free().
1686 EAPI const char *elm_profile_dir_get(const char *profile, Eina_Bool is_user);
1689 * Free an Elementary's profile directory path, as returned by
1690 * elm_profile_dir_get().
1692 * @param p_dir The profile's path
1696 EAPI void elm_profile_dir_free(const char *p_dir);
1699 * Get Elementary's list of available profiles.
1701 * @return The profiles list. List node data are the profile name
1705 * @note One must free this list, after usage, with the function
1706 * elm_profile_list_free().
1708 EAPI Eina_List *elm_profile_list_get(void);
1711 * Free Elementary's list of available profiles.
1713 * @param l The profiles list, as returned by elm_profile_list_get().
1717 EAPI void elm_profile_list_free(Eina_List *l);
1720 * Set Elementary's profile.
1722 * This sets the global profile that is applied to Elementary
1723 * applications. Just the process the call comes from will be
1726 * @param profile The profile's name
1730 EAPI void elm_profile_set(const char *profile);
1733 * Set Elementary's profile.
1735 * This sets the global profile that is applied to all Elementary
1736 * applications. All running Elementary windows will be affected.
1738 * @param profile The profile's name
1742 EAPI void elm_profile_all_set(const char *profile);
1749 * @defgroup Engine Elementary Engine
1751 * These are functions setting and querying which rendering engine
1752 * Elementary will use for drawing its windows' pixels.
1754 * The following are the available engines:
1755 * @li "software_x11"
1758 * @li "software_16_x11"
1759 * @li "software_8_x11"
1762 * @li "software_gdi"
1763 * @li "software_16_wince_gdi"
1765 * @li "software_16_sdl"
1773 * @brief Get Elementary's rendering engine in use.
1775 * @return The rendering engine's name
1776 * @note there's no need to free the returned string, here.
1778 * This gets the global rendering engine that is applied to all Elementary
1781 * @see elm_engine_set()
1783 EAPI const char *elm_engine_current_get(void);
1786 * @brief Set Elementary's rendering engine for use.
1788 * @param engine The rendering engine's name
1790 * This sets global rendering engine that is applied to all Elementary
1791 * applications. Note that it will take effect only to Elementary windows
1792 * created after this is called.
1794 * @see elm_win_add()
1796 EAPI void elm_engine_set(const char *engine);
1803 * @defgroup Fonts Elementary Fonts
1805 * These are functions dealing with font rendering, selection and the
1806 * like for Elementary applications. One might fetch which system
1807 * fonts are there to use and set custom fonts for individual classes
1808 * of UI items containing text (text classes).
1813 typedef struct _Elm_Text_Class
1819 typedef struct _Elm_Font_Overlay
1821 const char *text_class;
1823 Evas_Font_Size size;
1826 typedef struct _Elm_Font_Properties
1830 } Elm_Font_Properties;
1833 * Get Elementary's list of supported text classes.
1835 * @return The text classes list, with @c Elm_Text_Class blobs as data.
1838 * Release the list with elm_text_classes_list_free().
1840 EAPI const Eina_List *elm_text_classes_list_get(void);
1843 * Free Elementary's list of supported text classes.
1847 * @see elm_text_classes_list_get().
1849 EAPI void elm_text_classes_list_free(const Eina_List *list);
1852 * Get Elementary's list of font overlays, set with
1853 * elm_font_overlay_set().
1855 * @return The font overlays list, with @c Elm_Font_Overlay blobs as
1860 * For each text class, one can set a <b>font overlay</b> for it,
1861 * overriding the default font properties for that class coming from
1862 * the theme in use. There is no need to free this list.
1864 * @see elm_font_overlay_set() and elm_font_overlay_unset().
1866 EAPI const Eina_List *elm_font_overlay_list_get(void);
1869 * Set a font overlay for a given Elementary text class.
1871 * @param text_class Text class name
1872 * @param font Font name and style string
1873 * @param size Font size
1877 * @p font has to be in the format returned by
1878 * elm_font_fontconfig_name_get(). @see elm_font_overlay_list_get()
1879 * and elm_font_overlay_unset().
1881 EAPI void elm_font_overlay_set(const char *text_class, const char *font, Evas_Font_Size size);
1884 * Unset a font overlay for a given Elementary text class.
1886 * @param text_class Text class name
1890 * This will bring back text elements belonging to text class
1891 * @p text_class back to their default font settings.
1893 EAPI void elm_font_overlay_unset(const char *text_class);
1896 * Apply the changes made with elm_font_overlay_set() and
1897 * elm_font_overlay_unset() on the current Elementary window.
1901 * This applies all font overlays set to all objects in the UI.
1903 EAPI void elm_font_overlay_apply(void);
1906 * Apply the changes made with elm_font_overlay_set() and
1907 * elm_font_overlay_unset() on all Elementary application windows.
1911 * This applies all font overlays set to all objects in the UI.
1913 EAPI void elm_font_overlay_all_apply(void);
1916 * Translate a font (family) name string in fontconfig's font names
1917 * syntax into an @c Elm_Font_Properties struct.
1919 * @param font The font name and styles string
1920 * @return the font properties struct
1924 * @note The reverse translation can be achived with
1925 * elm_font_fontconfig_name_get(), for one style only (single font
1926 * instance, not family).
1928 EAPI Elm_Font_Properties *elm_font_properties_get(const char *font) EINA_ARG_NONNULL(1);
1931 * Free font properties return by elm_font_properties_get().
1933 * @param efp the font properties struct
1937 EAPI void elm_font_properties_free(Elm_Font_Properties *efp) EINA_ARG_NONNULL(1);
1940 * Translate a font name, bound to a style, into fontconfig's font names
1943 * @param name The font (family) name
1944 * @param style The given style (may be @c NULL)
1946 * @return the font name and style string
1950 * @note The reverse translation can be achived with
1951 * elm_font_properties_get(), for one style only (single font
1952 * instance, not family).
1954 EAPI const char *elm_font_fontconfig_name_get(const char *name, const char *style) EINA_ARG_NONNULL(1);
1957 * Free the font string return by elm_font_fontconfig_name_get().
1959 * @param efp the font properties struct
1963 EAPI void elm_font_fontconfig_name_free(const char *name) EINA_ARG_NONNULL(1);
1966 * Create a font hash table of available system fonts.
1968 * One must call it with @p list being the return value of
1969 * evas_font_available_list(). The hash will be indexed by font
1970 * (family) names, being its values @c Elm_Font_Properties blobs.
1972 * @param list The list of available system fonts, as returned by
1973 * evas_font_available_list().
1974 * @return the font hash.
1978 * @note The user is supposed to get it populated at least with 3
1979 * default font families (Sans, Serif, Monospace), which should be
1980 * present on most systems.
1982 EAPI Eina_Hash *elm_font_available_hash_add(Eina_List *list);
1985 * Free the hash return by elm_font_available_hash_add().
1987 * @param hash the hash to be freed.
1991 EAPI void elm_font_available_hash_del(Eina_Hash *hash);
1998 * @defgroup Fingers Fingers
2000 * Elementary is designed to be finger-friendly for touchscreens,
2001 * and so in addition to scaling for display resolution, it can
2002 * also scale based on finger "resolution" (or size). You can then
2003 * customize the granularity of the areas meant to receive clicks
2006 * Different profiles may have pre-set values for finger sizes.
2008 * @ref general_functions_example_page "This" example contemplates
2009 * some of these functions.
2015 * Get the configured "finger size"
2017 * @return The finger size
2019 * This gets the globally configured finger size, <b>in pixels</b>
2023 EAPI Evas_Coord elm_finger_size_get(void);
2026 * Set the configured finger size
2028 * This sets the globally configured finger size in pixels
2030 * @param size The finger size
2033 EAPI void elm_finger_size_set(Evas_Coord size);
2036 * Set the configured finger size for all applications on the display
2038 * This sets the globally configured finger size in pixels for all
2039 * applications on the display
2041 * @param size The finger size
2044 EAPI void elm_finger_size_all_set(Evas_Coord size);
2051 * @defgroup Focus Focus
2053 * An Elementary application has, at all times, one (and only one)
2054 * @b focused object. This is what determines where the input
2055 * events go to within the application's window. Also, focused
2056 * objects can be decorated differently, in order to signal to the
2057 * user where the input is, at a given moment.
2059 * Elementary applications also have the concept of <b>focus
2060 * chain</b>: one can cycle through all the windows' focusable
2061 * objects by input (tab key) or programmatically. The default
2062 * focus chain for an application is the one define by the order in
2063 * which the widgets where added in code. One will cycle through
2064 * top level widgets, and, for each one containg sub-objects, cycle
2065 * through them all, before returning to the level
2066 * above. Elementary also allows one to set @b custom focus chains
2067 * for their applications.
2069 * Besides the focused decoration a widget may exhibit, when it
2070 * gets focus, Elementary has a @b global focus highlight object
2071 * that can be enabled for a window. If one chooses to do so, this
2072 * extra highlight effect will surround the current focused object,
2075 * @note Some Elementary widgets are @b unfocusable, after
2076 * creation, by their very nature: they are not meant to be
2077 * interacted with input events, but are there just for visual
2080 * @ref general_functions_example_page "This" example contemplates
2081 * some of these functions.
2085 * Get the enable status of the focus highlight
2087 * This gets whether the highlight on focused objects is enabled or not
2090 EAPI Eina_Bool elm_focus_highlight_enabled_get(void);
2093 * Set the enable status of the focus highlight
2095 * Set whether to show or not the highlight on focused objects
2096 * @param enable Enable highlight if EINA_TRUE, disable otherwise
2099 EAPI void elm_focus_highlight_enabled_set(Eina_Bool enable);
2102 * Get the enable status of the highlight animation
2104 * Get whether the focus highlight, if enabled, will animate its switch from
2105 * one object to the next
2108 EAPI Eina_Bool elm_focus_highlight_animate_get(void);
2111 * Set the enable status of the highlight animation
2113 * Set whether the focus highlight, if enabled, will animate its switch from
2114 * one object to the next
2115 * @param animate Enable animation if EINA_TRUE, disable otherwise
2118 EAPI void elm_focus_highlight_animate_set(Eina_Bool animate);
2121 * Get the whether an Elementary object has the focus or not.
2123 * @param obj The Elementary object to get the information from
2124 * @return @c EINA_TRUE, if the object is focused, @c EINA_FALSE if
2125 * not (and on errors).
2127 * @see elm_object_focus_set()
2131 EAPI Eina_Bool elm_object_focus_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2134 * Set/unset focus to a given Elementary object.
2136 * @param obj The Elementary object to operate on.
2137 * @param enable @c EINA_TRUE Set focus to a given object,
2138 * @c EINA_FALSE Unset focus to a given object.
2140 * @note When you set focus to this object, if it can handle focus, will
2141 * take the focus away from the one who had it previously and will, for
2142 * now on, be the one receiving input events. Unsetting focus will remove
2143 * the focus from @p obj, passing it back to the previous element in the
2146 * @see elm_object_focus_get(), elm_object_focus_custom_chain_get()
2150 EAPI void elm_object_focus_set(Evas_Object *obj, Eina_Bool focus) EINA_ARG_NONNULL(1);
2153 * Make a given Elementary object the focused one.
2155 * @param obj The Elementary object to make focused.
2157 * @note This object, if it can handle focus, will take the focus
2158 * away from the one who had it previously and will, for now on, be
2159 * the one receiving input events.
2161 * @see elm_object_focus_get()
2162 * @deprecated use elm_object_focus_set() instead.
2166 EINA_DEPRECATED EAPI void elm_object_focus(Evas_Object *obj) EINA_ARG_NONNULL(1);
2169 * Remove the focus from an Elementary object
2171 * @param obj The Elementary to take focus from
2173 * This removes the focus from @p obj, passing it back to the
2174 * previous element in the focus chain list.
2176 * @see elm_object_focus() and elm_object_focus_custom_chain_get()
2177 * @deprecated use elm_object_focus_set() instead.
2181 EINA_DEPRECATED EAPI void elm_object_unfocus(Evas_Object *obj) EINA_ARG_NONNULL(1);
2184 * Set the ability for an Element object to be focused
2186 * @param obj The Elementary object to operate on
2187 * @param enable @c EINA_TRUE if the object can be focused, @c
2188 * EINA_FALSE if not (and on errors)
2190 * This sets whether the object @p obj is able to take focus or
2191 * not. Unfocusable objects do nothing when programmatically
2192 * focused, being the nearest focusable parent object the one
2193 * really getting focus. Also, when they receive mouse input, they
2194 * will get the event, but not take away the focus from where it
2199 EAPI void elm_object_focus_allow_set(Evas_Object *obj, Eina_Bool enable) EINA_ARG_NONNULL(1);
2202 * Get whether an Elementary object is focusable or not
2204 * @param obj The Elementary object to operate on
2205 * @return @c EINA_TRUE if the object is allowed to be focused, @c
2206 * EINA_FALSE if not (and on errors)
2208 * @note Objects which are meant to be interacted with by input
2209 * events are created able to be focused, by default. All the
2214 EAPI Eina_Bool elm_object_focus_allow_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2217 * Set custom focus chain.
2219 * This function overwrites any previous custom focus chain within
2220 * the list of objects. The previous list will be deleted and this list
2221 * will be managed by elementary. After it is set, don't modify it.
2223 * @note On focus cycle, only will be evaluated children of this container.
2225 * @param obj The container object
2226 * @param objs Chain of objects to pass focus
2229 EAPI void elm_object_focus_custom_chain_set(Evas_Object *obj, Eina_List *objs) EINA_ARG_NONNULL(1);
2232 * Unset a custom focus chain on a given Elementary widget
2234 * @param obj The container object to remove focus chain from
2236 * Any focus chain previously set on @p obj (for its child objects)
2237 * is removed entirely after this call.
2241 EAPI void elm_object_focus_custom_chain_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
2244 * Get custom focus chain
2246 * @param obj The container object
2249 EAPI const Eina_List *elm_object_focus_custom_chain_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2252 * Append object to custom focus chain.
2254 * @note If relative_child equal to NULL or not in custom chain, the object
2255 * will be added in end.
2257 * @note On focus cycle, only will be evaluated children of this container.
2259 * @param obj The container object
2260 * @param child The child to be added in custom chain
2261 * @param relative_child The relative object to position the child
2264 EAPI void elm_object_focus_custom_chain_append(Evas_Object *obj, Evas_Object *child, Evas_Object *relative_child) EINA_ARG_NONNULL(1, 2);
2267 * Prepend object to custom focus chain.
2269 * @note If relative_child equal to NULL or not in custom chain, the object
2270 * will be added in begin.
2272 * @note On focus cycle, only will be evaluated children of this container.
2274 * @param obj The container object
2275 * @param child The child to be added in custom chain
2276 * @param relative_child The relative object to position the child
2279 EAPI void elm_object_focus_custom_chain_prepend(Evas_Object *obj, Evas_Object *child, Evas_Object *relative_child) EINA_ARG_NONNULL(1, 2);
2282 * Give focus to next object in object tree.
2284 * Give focus to next object in focus chain of one object sub-tree.
2285 * If the last object of chain already have focus, the focus will go to the
2286 * first object of chain.
2288 * @param obj The object root of sub-tree
2289 * @param dir Direction to cycle the focus
2293 EAPI void elm_object_focus_cycle(Evas_Object *obj, Elm_Focus_Direction dir) EINA_ARG_NONNULL(1);
2296 * Give focus to near object in one direction.
2298 * Give focus to near object in direction of one object.
2299 * If none focusable object in given direction, the focus will not change.
2301 * @param obj The reference object
2302 * @param x Horizontal component of direction to focus
2303 * @param y Vertical component of direction to focus
2307 EAPI void elm_object_focus_direction_go(Evas_Object *obj, int x, int y) EINA_ARG_NONNULL(1);
2310 * Make the elementary object and its children to be unfocusable
2313 * @param obj The Elementary object to operate on
2314 * @param tree_unfocusable @c EINA_TRUE for unfocusable,
2315 * @c EINA_FALSE for focusable.
2317 * This sets whether the object @p obj and its children objects
2318 * are able to take focus or not. If the tree is set as unfocusable,
2319 * newest focused object which is not in this tree will get focus.
2320 * This API can be helpful for an object to be deleted.
2321 * When an object will be deleted soon, it and its children may not
2322 * want to get focus (by focus reverting or by other focus controls).
2323 * Then, just use this API before deleting.
2325 * @see elm_object_tree_unfocusable_get()
2329 EAPI void elm_object_tree_unfocusable_set(Evas_Object *obj, Eina_Bool tree_unfocusable); EINA_ARG_NONNULL(1);
2332 * Get whether an Elementary object and its children are unfocusable or not.
2334 * @param obj The Elementary object to get the information from
2335 * @return @c EINA_TRUE, if the tree is unfocussable,
2336 * @c EINA_FALSE if not (and on errors).
2338 * @see elm_object_tree_unfocusable_set()
2342 EAPI Eina_Bool elm_object_tree_unfocusable_get(const Evas_Object *obj); EINA_ARG_NONNULL(1);
2345 * @defgroup Scrolling Scrolling
2347 * These are functions setting how scrollable views in Elementary
2348 * widgets should behave on user interaction.
2354 * Get whether scrollers should bounce when they reach their
2355 * viewport's edge during a scroll.
2357 * @return the thumb scroll bouncing state
2359 * This is the default behavior for touch screens, in general.
2360 * @ingroup Scrolling
2362 EAPI Eina_Bool elm_scroll_bounce_enabled_get(void);
2365 * Set whether scrollers should bounce when they reach their
2366 * viewport's edge during a scroll.
2368 * @param enabled the thumb scroll bouncing state
2370 * @see elm_thumbscroll_bounce_enabled_get()
2371 * @ingroup Scrolling
2373 EAPI void elm_scroll_bounce_enabled_set(Eina_Bool enabled);
2376 * Set whether scrollers should bounce when they reach their
2377 * viewport's edge during a scroll, for all Elementary application
2380 * @param enabled the thumb scroll bouncing state
2382 * @see elm_thumbscroll_bounce_enabled_get()
2383 * @ingroup Scrolling
2385 EAPI void elm_scroll_bounce_enabled_all_set(Eina_Bool enabled);
2388 * Get the amount of inertia a scroller will impose at bounce
2391 * @return the thumb scroll bounce friction
2393 * @ingroup Scrolling
2395 EAPI double elm_scroll_bounce_friction_get(void);
2398 * Set the amount of inertia a scroller will impose at bounce
2401 * @param friction the thumb scroll bounce friction
2403 * @see elm_thumbscroll_bounce_friction_get()
2404 * @ingroup Scrolling
2406 EAPI void elm_scroll_bounce_friction_set(double friction);
2409 * Set the amount of inertia a scroller will impose at bounce
2410 * animations, for all Elementary application windows.
2412 * @param friction the thumb scroll bounce friction
2414 * @see elm_thumbscroll_bounce_friction_get()
2415 * @ingroup Scrolling
2417 EAPI void elm_scroll_bounce_friction_all_set(double friction);
2420 * Get the amount of inertia a <b>paged</b> scroller will impose at
2421 * page fitting animations.
2423 * @return the page scroll friction
2425 * @ingroup Scrolling
2427 EAPI double elm_scroll_page_scroll_friction_get(void);
2430 * Set the amount of inertia a <b>paged</b> scroller will impose at
2431 * page fitting animations.
2433 * @param friction the page scroll friction
2435 * @see elm_thumbscroll_page_scroll_friction_get()
2436 * @ingroup Scrolling
2438 EAPI void elm_scroll_page_scroll_friction_set(double friction);
2441 * Set the amount of inertia a <b>paged</b> scroller will impose at
2442 * page fitting animations, for all Elementary application windows.
2444 * @param friction the page scroll friction
2446 * @see elm_thumbscroll_page_scroll_friction_get()
2447 * @ingroup Scrolling
2449 EAPI void elm_scroll_page_scroll_friction_all_set(double friction);
2452 * Get the amount of inertia a scroller will impose at region bring
2455 * @return the bring in scroll friction
2457 * @ingroup Scrolling
2459 EAPI double elm_scroll_bring_in_scroll_friction_get(void);
2462 * Set the amount of inertia a scroller will impose at region bring
2465 * @param friction the bring in scroll friction
2467 * @see elm_thumbscroll_bring_in_scroll_friction_get()
2468 * @ingroup Scrolling
2470 EAPI void elm_scroll_bring_in_scroll_friction_set(double friction);
2473 * Set the amount of inertia a scroller will impose at region bring
2474 * animations, for all Elementary application windows.
2476 * @param friction the bring in scroll friction
2478 * @see elm_thumbscroll_bring_in_scroll_friction_get()
2479 * @ingroup Scrolling
2481 EAPI void elm_scroll_bring_in_scroll_friction_all_set(double friction);
2484 * Get the amount of inertia scrollers will impose at animations
2485 * triggered by Elementary widgets' zooming API.
2487 * @return the zoom friction
2489 * @ingroup Scrolling
2491 EAPI double elm_scroll_zoom_friction_get(void);
2494 * Set the amount of inertia scrollers will impose at animations
2495 * triggered by Elementary widgets' zooming API.
2497 * @param friction the zoom friction
2499 * @see elm_thumbscroll_zoom_friction_get()
2500 * @ingroup Scrolling
2502 EAPI void elm_scroll_zoom_friction_set(double friction);
2505 * Set the amount of inertia scrollers will impose at animations
2506 * triggered by Elementary widgets' zooming API, for all Elementary
2507 * application windows.
2509 * @param friction the zoom friction
2511 * @see elm_thumbscroll_zoom_friction_get()
2512 * @ingroup Scrolling
2514 EAPI void elm_scroll_zoom_friction_all_set(double friction);
2517 * Get whether scrollers should be draggable from any point in their
2520 * @return the thumb scroll state
2522 * @note This is the default behavior for touch screens, in general.
2523 * @note All other functions namespaced with "thumbscroll" will only
2524 * have effect if this mode is enabled.
2526 * @ingroup Scrolling
2528 EAPI Eina_Bool elm_scroll_thumbscroll_enabled_get(void);
2531 * Set whether scrollers should be draggable from any point in their
2534 * @param enabled the thumb scroll state
2536 * @see elm_thumbscroll_enabled_get()
2537 * @ingroup Scrolling
2539 EAPI void elm_scroll_thumbscroll_enabled_set(Eina_Bool enabled);
2542 * Set whether scrollers should be draggable from any point in their
2543 * views, for all Elementary application windows.
2545 * @param enabled the thumb scroll state
2547 * @see elm_thumbscroll_enabled_get()
2548 * @ingroup Scrolling
2550 EAPI void elm_scroll_thumbscroll_enabled_all_set(Eina_Bool enabled);
2553 * Get the number of pixels one should travel while dragging a
2554 * scroller's view to actually trigger scrolling.
2556 * @return the thumb scroll threshould
2558 * One would use higher values for touch screens, in general, because
2559 * of their inherent imprecision.
2560 * @ingroup Scrolling
2562 EAPI unsigned int elm_scroll_thumbscroll_threshold_get(void);
2565 * Set the number of pixels one should travel while dragging a
2566 * scroller's view to actually trigger scrolling.
2568 * @param threshold the thumb scroll threshould
2570 * @see elm_thumbscroll_threshould_get()
2571 * @ingroup Scrolling
2573 EAPI void elm_scroll_thumbscroll_threshold_set(unsigned int threshold);
2576 * Set the number of pixels one should travel while dragging a
2577 * scroller's view to actually trigger scrolling, for all Elementary
2578 * application windows.
2580 * @param threshold the thumb scroll threshould
2582 * @see elm_thumbscroll_threshould_get()
2583 * @ingroup Scrolling
2585 EAPI void elm_scroll_thumbscroll_threshold_all_set(unsigned int threshold);
2588 * Get the minimum speed of mouse cursor movement which will trigger
2589 * list self scrolling animation after a mouse up event
2592 * @return the thumb scroll momentum threshould
2594 * @ingroup Scrolling
2596 EAPI double elm_scroll_thumbscroll_momentum_threshold_get(void);
2599 * Set the minimum speed of mouse cursor movement which will trigger
2600 * list self scrolling animation after a mouse up event
2603 * @param threshold the thumb scroll momentum threshould
2605 * @see elm_thumbscroll_momentum_threshould_get()
2606 * @ingroup Scrolling
2608 EAPI void elm_scroll_thumbscroll_momentum_threshold_set(double threshold);
2611 * Set the minimum speed of mouse cursor movement which will trigger
2612 * list self scrolling animation after a mouse up event
2613 * (pixels/second), for all Elementary application windows.
2615 * @param threshold the thumb scroll momentum threshould
2617 * @see elm_thumbscroll_momentum_threshould_get()
2618 * @ingroup Scrolling
2620 EAPI void elm_scroll_thumbscroll_momentum_threshold_all_set(double threshold);
2623 * Get the amount of inertia a scroller will impose at self scrolling
2626 * @return the thumb scroll friction
2628 * @ingroup Scrolling
2630 EAPI double elm_scroll_thumbscroll_friction_get(void);
2633 * Set the amount of inertia a scroller will impose at self scrolling
2636 * @param friction the thumb scroll friction
2638 * @see elm_thumbscroll_friction_get()
2639 * @ingroup Scrolling
2641 EAPI void elm_scroll_thumbscroll_friction_set(double friction);
2644 * Set the amount of inertia a scroller will impose at self scrolling
2645 * animations, for all Elementary application windows.
2647 * @param friction the thumb scroll friction
2649 * @see elm_thumbscroll_friction_get()
2650 * @ingroup Scrolling
2652 EAPI void elm_scroll_thumbscroll_friction_all_set(double friction);
2655 * Get the amount of lag between your actual mouse cursor dragging
2656 * movement and a scroller's view movement itself, while pushing it
2657 * into bounce state manually.
2659 * @return the thumb scroll border friction
2661 * @ingroup Scrolling
2663 EAPI double elm_scroll_thumbscroll_border_friction_get(void);
2666 * Set the amount of lag between your actual mouse cursor dragging
2667 * movement and a scroller's view movement itself, while pushing it
2668 * into bounce state manually.
2670 * @param friction the thumb scroll border friction. @c 0.0 for
2671 * perfect synchrony between two movements, @c 1.0 for maximum
2674 * @see elm_thumbscroll_border_friction_get()
2675 * @note parameter value will get bound to 0.0 - 1.0 interval, always
2677 * @ingroup Scrolling
2679 EAPI void elm_scroll_thumbscroll_border_friction_set(double friction);
2682 * Set the amount of lag between your actual mouse cursor dragging
2683 * movement and a scroller's view movement itself, while pushing it
2684 * into bounce state manually, for all Elementary application windows.
2686 * @param friction the thumb scroll border friction. @c 0.0 for
2687 * perfect synchrony between two movements, @c 1.0 for maximum
2690 * @see elm_thumbscroll_border_friction_get()
2691 * @note parameter value will get bound to 0.0 - 1.0 interval, always
2693 * @ingroup Scrolling
2695 EAPI void elm_scroll_thumbscroll_border_friction_all_set(double friction);
2702 * @defgroup Scrollhints Scrollhints
2704 * Objects when inside a scroller can scroll, but this may not always be
2705 * desirable in certain situations. This allows an object to hint to itself
2706 * and parents to "not scroll" in one of 2 ways. If any child object of a
2707 * scroller has pushed a scroll freeze or hold then it affects all parent
2708 * scrollers until all children have released them.
2710 * 1. To hold on scrolling. This means just flicking and dragging may no
2711 * longer scroll, but pressing/dragging near an edge of the scroller will
2712 * still scroll. This is automatically used by the entry object when
2715 * 2. To totally freeze scrolling. This means it stops. until
2722 * Push the scroll hold by 1
2724 * This increments the scroll hold count by one. If it is more than 0 it will
2725 * take effect on the parents of the indicated object.
2727 * @param obj The object
2728 * @ingroup Scrollhints
2730 EAPI void elm_object_scroll_hold_push(Evas_Object *obj) EINA_ARG_NONNULL(1);
2733 * Pop the scroll hold by 1
2735 * This decrements the scroll hold count by one. If it is more than 0 it will
2736 * take effect on the parents of the indicated object.
2738 * @param obj The object
2739 * @ingroup Scrollhints
2741 EAPI void elm_object_scroll_hold_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
2744 * Push the scroll freeze by 1
2746 * This increments the scroll freeze count by one. If it is more
2747 * than 0 it will take effect on the parents of the indicated
2750 * @param obj The object
2751 * @ingroup Scrollhints
2753 EAPI void elm_object_scroll_freeze_push(Evas_Object *obj) EINA_ARG_NONNULL(1);
2756 * Pop the scroll freeze by 1
2758 * This decrements the scroll freeze count by one. If it is more
2759 * than 0 it will take effect on the parents of the indicated
2762 * @param obj The object
2763 * @ingroup Scrollhints
2765 EAPI void elm_object_scroll_freeze_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
2768 * Lock the scrolling of the given widget (and thus all parents)
2770 * This locks the given object from scrolling in the X axis (and implicitly
2771 * also locks all parent scrollers too from doing the same).
2773 * @param obj The object
2774 * @param lock The lock state (1 == locked, 0 == unlocked)
2775 * @ingroup Scrollhints
2777 EAPI void elm_object_scroll_lock_x_set(Evas_Object *obj, Eina_Bool lock) EINA_ARG_NONNULL(1);
2780 * Lock the scrolling of the given widget (and thus all parents)
2782 * This locks the given object from scrolling in the Y axis (and implicitly
2783 * also locks all parent scrollers too from doing the same).
2785 * @param obj The object
2786 * @param lock The lock state (1 == locked, 0 == unlocked)
2787 * @ingroup Scrollhints
2789 EAPI void elm_object_scroll_lock_y_set(Evas_Object *obj, Eina_Bool lock) EINA_ARG_NONNULL(1);
2792 * Get the scrolling lock of the given widget
2794 * This gets the lock for X axis scrolling.
2796 * @param obj The object
2797 * @ingroup Scrollhints
2799 EAPI Eina_Bool elm_object_scroll_lock_x_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2802 * Get the scrolling lock of the given widget
2804 * This gets the lock for X axis scrolling.
2806 * @param obj The object
2807 * @ingroup Scrollhints
2809 EAPI Eina_Bool elm_object_scroll_lock_y_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2816 * Send a signal to the widget edje object.
2818 * This function sends a signal to the edje object of the obj. An
2819 * edje program can respond to a signal by specifying matching
2820 * 'signal' and 'source' fields.
2822 * @param obj The object
2823 * @param emission The signal's name.
2824 * @param source The signal's source.
2827 EAPI void elm_object_signal_emit(Evas_Object *obj, const char *emission, const char *source) EINA_ARG_NONNULL(1);
2830 * Add a callback for a signal emitted by widget edje object.
2832 * This function connects a callback function to a signal emitted by the
2833 * edje object of the obj.
2834 * Globs can occur in either the emission or source name.
2836 * @param obj The object
2837 * @param emission The signal's name.
2838 * @param source The signal's source.
2839 * @param func The callback function to be executed when the signal is
2841 * @param data A pointer to data to pass in to the callback function.
2844 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);
2847 * Remove a signal-triggered callback from a widget edje object.
2849 * This function removes a callback, previoulsy attached to a
2850 * signal emitted by the edje object of the obj. The parameters
2851 * emission, source and func must match exactly those passed to a
2852 * previous call to elm_object_signal_callback_add(). The data
2853 * pointer that was passed to this call will be returned.
2855 * @param obj The object
2856 * @param emission The signal's name.
2857 * @param source The signal's source.
2858 * @param func The callback function to be executed when the signal is
2860 * @return The data pointer
2863 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);
2866 * Add a callback for input events (key up, key down, mouse wheel)
2867 * on a given Elementary widget
2869 * @param obj The widget to add an event callback on
2870 * @param func The callback function to be executed when the event
2872 * @param data Data to pass in to @p func
2874 * Every widget in an Elementary interface set to receive focus,
2875 * with elm_object_focus_allow_set(), will propagate @b all of its
2876 * key up, key down and mouse wheel input events up to its parent
2877 * object, and so on. All of the focusable ones in this chain which
2878 * had an event callback set, with this call, will be able to treat
2879 * those events. There are two ways of making the propagation of
2880 * these event upwards in the tree of widgets to @b cease:
2881 * - Just return @c EINA_TRUE on @p func. @c EINA_FALSE will mean
2882 * the event was @b not processed, so the propagation will go on.
2883 * - The @c event_info pointer passed to @p func will contain the
2884 * event's structure and, if you OR its @c event_flags inner
2885 * value to @c EVAS_EVENT_FLAG_ON_HOLD, you're telling Elementary
2886 * one has already handled it, thus killing the event's
2889 * @note Your event callback will be issued on those events taking
2890 * place only if no other child widget of @obj has consumed the
2893 * @note Not to be confused with @c
2894 * evas_object_event_callback_add(), which will add event callbacks
2895 * per type on general Evas objects (no event propagation
2896 * infrastructure taken in account).
2898 * @note Not to be confused with @c
2899 * elm_object_signal_callback_add(), which will add callbacks to @b
2900 * signals coming from a widget's theme, not input events.
2902 * @note Not to be confused with @c
2903 * edje_object_signal_callback_add(), which does the same as
2904 * elm_object_signal_callback_add(), but directly on an Edje
2907 * @note Not to be confused with @c
2908 * evas_object_smart_callback_add(), which adds callbacks to smart
2909 * objects' <b>smart events</b>, and not input events.
2911 * @see elm_object_event_callback_del()
2915 EAPI void elm_object_event_callback_add(Evas_Object *obj, Elm_Event_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
2918 * Remove an event callback from a widget.
2920 * This function removes a callback, previoulsy attached to event emission
2922 * The parameters func and data must match exactly those passed to
2923 * a previous call to elm_object_event_callback_add(). The data pointer that
2924 * was passed to this call will be returned.
2926 * @param obj The object
2927 * @param func The callback function to be executed when the event is
2929 * @param data Data to pass in to the callback function.
2930 * @return The data pointer
2933 EAPI void *elm_object_event_callback_del(Evas_Object *obj, Elm_Event_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
2936 * Adjust size of an element for finger usage.
2938 * @param times_w How many fingers should fit horizontally
2939 * @param w Pointer to the width size to adjust
2940 * @param times_h How many fingers should fit vertically
2941 * @param h Pointer to the height size to adjust
2943 * This takes width and height sizes (in pixels) as input and a
2944 * size multiple (which is how many fingers you want to place
2945 * within the area, being "finger" the size set by
2946 * elm_finger_size_set()), and adjusts the size to be large enough
2947 * to accommodate the resulting size -- if it doesn't already
2948 * accommodate it. On return the @p w and @p h sizes pointed to by
2949 * these parameters will be modified, on those conditions.
2951 * @note This is kind of a low level Elementary call, most useful
2952 * on size evaluation times for widgets. An external user wouldn't
2953 * be calling, most of the time.
2957 EAPI void elm_coords_finger_size_adjust(int times_w, Evas_Coord *w, int times_h, Evas_Coord *h);
2960 * Get the duration for occuring long press event.
2962 * @return Timeout for long press event
2963 * @ingroup Longpress
2965 EAPI double elm_longpress_timeout_get(void);
2968 * Set the duration for occuring long press event.
2970 * @param lonpress_timeout Timeout for long press event
2971 * @ingroup Longpress
2973 EAPI void elm_longpress_timeout_set(double longpress_timeout);
2976 * @defgroup Debug Debug
2977 * don't use it unless you are sure
2983 * Print Tree object hierarchy in stdout
2985 * @param obj The root object
2988 EAPI void elm_object_tree_dump(const Evas_Object *top);
2991 * Print Elm Objects tree hierarchy in file as dot(graphviz) syntax.
2993 * @param obj The root object
2994 * @param file The path of output file
2997 EAPI void elm_object_tree_dot_dump(const Evas_Object *top, const char *file);
3004 * @defgroup Theme Theme
3006 * Elementary uses Edje to theme its widgets, naturally. But for the most
3007 * part this is hidden behind a simpler interface that lets the user set
3008 * extensions and choose the style of widgets in a much easier way.
3010 * Instead of thinking in terms of paths to Edje files and their groups
3011 * each time you want to change the appearance of a widget, Elementary
3012 * works so you can add any theme file with extensions or replace the
3013 * main theme at one point in the application, and then just set the style
3014 * of widgets with elm_object_style_set() and related functions. Elementary
3015 * will then look in its list of themes for a matching group and apply it,
3016 * and when the theme changes midway through the application, all widgets
3017 * will be updated accordingly.
3019 * There are three concepts you need to know to understand how Elementary
3020 * theming works: default theme, extensions and overlays.
3022 * Default theme, obviously enough, is the one that provides the default
3023 * look of all widgets. End users can change the theme used by Elementary
3024 * by setting the @c ELM_THEME environment variable before running an
3025 * application, or globally for all programs using the @c elementary_config
3026 * utility. Applications can change the default theme using elm_theme_set(),
3027 * but this can go against the user wishes, so it's not an adviced practice.
3029 * Ideally, applications should find everything they need in the already
3030 * provided theme, but there may be occasions when that's not enough and
3031 * custom styles are required to correctly express the idea. For this
3032 * cases, Elementary has extensions.
3034 * Extensions allow the application developer to write styles of its own
3035 * to apply to some widgets. This requires knowledge of how each widget
3036 * is themed, as extensions will always replace the entire group used by
3037 * the widget, so important signals and parts need to be there for the
3038 * object to behave properly (see documentation of Edje for details).
3039 * Once the theme for the extension is done, the application needs to add
3040 * it to the list of themes Elementary will look into, using
3041 * elm_theme_extension_add(), and set the style of the desired widgets as
3042 * he would normally with elm_object_style_set().
3044 * Overlays, on the other hand, can replace the look of all widgets by
3045 * overriding the default style. Like extensions, it's up to the application
3046 * developer to write the theme for the widgets it wants, the difference
3047 * being that when looking for the theme, Elementary will check first the
3048 * list of overlays, then the set theme and lastly the list of extensions,
3049 * so with overlays it's possible to replace the default view and every
3050 * widget will be affected. This is very much alike to setting the whole
3051 * theme for the application and will probably clash with the end user
3052 * options, not to mention the risk of ending up with not matching styles
3053 * across the program. Unless there's a very special reason to use them,
3054 * overlays should be avoided for the resons exposed before.
3056 * All these theme lists are handled by ::Elm_Theme instances. Elementary
3057 * keeps one default internally and every function that receives one of
3058 * these can be called with NULL to refer to this default (except for
3059 * elm_theme_free()). It's possible to create a new instance of a
3060 * ::Elm_Theme to set other theme for a specific widget (and all of its
3061 * children), but this is as discouraged, if not even more so, than using
3062 * overlays. Don't use this unless you really know what you are doing.
3064 * But to be less negative about things, you can look at the following
3066 * @li @ref theme_example_01 "Using extensions"
3067 * @li @ref theme_example_02 "Using overlays"
3072 * @typedef Elm_Theme
3074 * Opaque handler for the list of themes Elementary looks for when
3075 * rendering widgets.
3077 * Stay out of this unless you really know what you are doing. For most
3078 * cases, sticking to the default is all a developer needs.
3080 typedef struct _Elm_Theme Elm_Theme;
3083 * Create a new specific theme
3085 * This creates an empty specific theme that only uses the default theme. A
3086 * specific theme has its own private set of extensions and overlays too
3087 * (which are empty by default). Specific themes do not fall back to themes
3088 * of parent objects. They are not intended for this use. Use styles, overlays
3089 * and extensions when needed, but avoid specific themes unless there is no
3090 * other way (example: you want to have a preview of a new theme you are
3091 * selecting in a "theme selector" window. The preview is inside a scroller
3092 * and should display what the theme you selected will look like, but not
3093 * actually apply it yet. The child of the scroller will have a specific
3094 * theme set to show this preview before the user decides to apply it to all
3097 EAPI Elm_Theme *elm_theme_new(void);
3099 * Free a specific theme
3101 * @param th The theme to free
3103 * This frees a theme created with elm_theme_new().
3105 EAPI void elm_theme_free(Elm_Theme *th);
3107 * Copy the theme fom the source to the destination theme
3109 * @param th The source theme to copy from
3110 * @param thdst The destination theme to copy data to
3112 * This makes a one-time static copy of all the theme config, extensions
3113 * and overlays from @p th to @p thdst. If @p th references a theme, then
3114 * @p thdst is also set to reference it, with all the theme settings,
3115 * overlays and extensions that @p th had.
3117 EAPI void elm_theme_copy(Elm_Theme *th, Elm_Theme *thdst);
3119 * Tell the source theme to reference the ref theme
3121 * @param th The theme that will do the referencing
3122 * @param thref The theme that is the reference source
3124 * This clears @p th to be empty and then sets it to refer to @p thref
3125 * so @p th acts as an override to @p thref, but where its overrides
3126 * don't apply, it will fall through to @p thref for configuration.
3128 EAPI void elm_theme_ref_set(Elm_Theme *th, Elm_Theme *thref);
3130 * Return the theme referred to
3132 * @param th The theme to get the reference from
3133 * @return The referenced theme handle
3135 * This gets the theme set as the reference theme by elm_theme_ref_set().
3136 * If no theme is set as a reference, NULL is returned.
3138 EAPI Elm_Theme *elm_theme_ref_get(Elm_Theme *th);
3140 * Return the default theme
3142 * @return The default theme handle
3144 * This returns the internal default theme setup handle that all widgets
3145 * use implicitly unless a specific theme is set. This is also often use
3146 * as a shorthand of NULL.
3148 EAPI Elm_Theme *elm_theme_default_get(void);
3150 * Prepends a theme overlay to the list of overlays
3152 * @param th The theme to add to, or if NULL, the default theme
3153 * @param item The Edje file path to be used
3155 * Use this if your application needs to provide some custom overlay theme
3156 * (An Edje file that replaces some default styles of widgets) where adding
3157 * new styles, or changing system theme configuration is not possible. Do
3158 * NOT use this instead of a proper system theme configuration. Use proper
3159 * configuration files, profiles, environment variables etc. to set a theme
3160 * so that the theme can be altered by simple confiugration by a user. Using
3161 * this call to achieve that effect is abusing the API and will create lots
3164 * @see elm_theme_extension_add()
3166 EAPI void elm_theme_overlay_add(Elm_Theme *th, const char *item);
3168 * Delete a theme overlay from the list of overlays
3170 * @param th The theme to delete from, or if NULL, the default theme
3171 * @param item The name of the theme overlay
3173 * @see elm_theme_overlay_add()
3175 EAPI void elm_theme_overlay_del(Elm_Theme *th, const char *item);
3177 * Appends a theme extension to the list of extensions.
3179 * @param th The theme to add to, or if NULL, the default theme
3180 * @param item The Edje file path to be used
3182 * This is intended when an application needs more styles of widgets or new
3183 * widget themes that the default does not provide (or may not provide). The
3184 * application has "extended" usage by coming up with new custom style names
3185 * for widgets for specific uses, but as these are not "standard", they are
3186 * not guaranteed to be provided by a default theme. This means the
3187 * application is required to provide these extra elements itself in specific
3188 * Edje files. This call adds one of those Edje files to the theme search
3189 * path to be search after the default theme. The use of this call is
3190 * encouraged when default styles do not meet the needs of the application.
3191 * Use this call instead of elm_theme_overlay_add() for almost all cases.
3193 * @see elm_object_style_set()
3195 EAPI void elm_theme_extension_add(Elm_Theme *th, const char *item);
3197 * Deletes a theme extension from the list of extensions.
3199 * @param th The theme to delete from, or if NULL, the default theme
3200 * @param item The name of the theme extension
3202 * @see elm_theme_extension_add()
3204 EAPI void elm_theme_extension_del(Elm_Theme *th, const char *item);
3206 * Set the theme search order for the given theme
3208 * @param th The theme to set the search order, or if NULL, the default theme
3209 * @param theme Theme search string
3211 * This sets the search string for the theme in path-notation from first
3212 * theme to search, to last, delimited by the : character. Example:
3214 * "shiny:/path/to/file.edj:default"
3216 * See the ELM_THEME environment variable for more information.
3218 * @see elm_theme_get()
3219 * @see elm_theme_list_get()
3221 EAPI void elm_theme_set(Elm_Theme *th, const char *theme);
3223 * Return the theme search order
3225 * @param th The theme to get the search order, or if NULL, the default theme
3226 * @return The internal search order path
3228 * This function returns a colon separated string of theme elements as
3229 * returned by elm_theme_list_get().
3231 * @see elm_theme_set()
3232 * @see elm_theme_list_get()
3234 EAPI const char *elm_theme_get(Elm_Theme *th);
3236 * Return a list of theme elements to be used in a theme.
3238 * @param th Theme to get the list of theme elements from.
3239 * @return The internal list of theme elements
3241 * This returns the internal list of theme elements (will only be valid as
3242 * long as the theme is not modified by elm_theme_set() or theme is not
3243 * freed by elm_theme_free(). This is a list of strings which must not be
3244 * altered as they are also internal. If @p th is NULL, then the default
3245 * theme element list is returned.
3247 * A theme element can consist of a full or relative path to a .edj file,
3248 * or a name, without extension, for a theme to be searched in the known
3249 * theme paths for Elemementary.
3251 * @see elm_theme_set()
3252 * @see elm_theme_get()
3254 EAPI const Eina_List *elm_theme_list_get(const Elm_Theme *th);
3256 * Return the full patrh for a theme element
3258 * @param f The theme element name
3259 * @param in_search_path Pointer to a boolean to indicate if item is in the search path or not
3260 * @return The full path to the file found.
3262 * This returns a string you should free with free() on success, NULL on
3263 * failure. This will search for the given theme element, and if it is a
3264 * full or relative path element or a simple searchable name. The returned
3265 * path is the full path to the file, if searched, and the file exists, or it
3266 * is simply the full path given in the element or a resolved path if
3267 * relative to home. The @p in_search_path boolean pointed to is set to
3268 * EINA_TRUE if the file was a searchable file andis in the search path,
3269 * and EINA_FALSE otherwise.
3271 EAPI char *elm_theme_list_item_path_get(const char *f, Eina_Bool *in_search_path);
3273 * Flush the current theme.
3275 * @param th Theme to flush
3277 * This flushes caches that let elementary know where to find theme elements
3278 * in the given theme. If @p th is NULL, then the default theme is flushed.
3279 * Call this function if source theme data has changed in such a way as to
3280 * make any caches Elementary kept invalid.
3282 EAPI void elm_theme_flush(Elm_Theme *th);
3284 * This flushes all themes (default and specific ones).
3286 * This will flush all themes in the current application context, by calling
3287 * elm_theme_flush() on each of them.
3289 EAPI void elm_theme_full_flush(void);
3291 * Set the theme for all elementary using applications on the current display
3293 * @param theme The name of the theme to use. Format same as the ELM_THEME
3294 * environment variable.
3296 EAPI void elm_theme_all_set(const char *theme);
3298 * Return a list of theme elements in the theme search path
3300 * @return A list of strings that are the theme element names.
3302 * This lists all available theme files in the standard Elementary search path
3303 * for theme elements, and returns them in alphabetical order as theme
3304 * element names in a list of strings. Free this with
3305 * elm_theme_name_available_list_free() when you are done with the list.
3307 EAPI Eina_List *elm_theme_name_available_list_new(void);
3309 * Free the list returned by elm_theme_name_available_list_new()
3311 * This frees the list of themes returned by
3312 * elm_theme_name_available_list_new(). Once freed the list should no longer
3313 * be used. a new list mys be created.
3315 EAPI void elm_theme_name_available_list_free(Eina_List *list);
3317 * Set a specific theme to be used for this object and its children
3319 * @param obj The object to set the theme on
3320 * @param th The theme to set
3322 * This sets a specific theme that will be used for the given object and any
3323 * child objects it has. If @p th is NULL then the theme to be used is
3324 * cleared and the object will inherit its theme from its parent (which
3325 * ultimately will use the default theme if no specific themes are set).
3327 * Use special themes with great care as this will annoy users and make
3328 * configuration difficult. Avoid any custom themes at all if it can be
3331 EAPI void elm_object_theme_set(Evas_Object *obj, Elm_Theme *th) EINA_ARG_NONNULL(1);
3333 * Get the specific theme to be used
3335 * @param obj The object to get the specific theme from
3336 * @return The specifc theme set.
3338 * This will return a specific theme set, or NULL if no specific theme is
3339 * set on that object. It will not return inherited themes from parents, only
3340 * the specific theme set for that specific object. See elm_object_theme_set()
3341 * for more information.
3343 EAPI Elm_Theme *elm_object_theme_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3349 /** @defgroup Win Win
3351 * @image html img/widget/win/preview-00.png
3352 * @image latex img/widget/win/preview-00.eps
3354 * The window class of Elementary. Contains functions to manipulate
3355 * windows. The Evas engine used to render the window contents is specified
3356 * in the system or user elementary config files (whichever is found last),
3357 * and can be overridden with the ELM_ENGINE environment variable for
3358 * testing. Engines that may be supported (depending on Evas and Ecore-Evas
3359 * compilation setup and modules actually installed at runtime) are (listed
3360 * in order of best supported and most likely to be complete and work to
3363 * @li "x11", "x", "software-x11", "software_x11" (Software rendering in X11)
3364 * @li "gl", "opengl", "opengl-x11", "opengl_x11" (OpenGL or OpenGL-ES2
3366 * @li "shot:..." (Virtual screenshot renderer - renders to output file and
3368 * @li "fb", "software-fb", "software_fb" (Linux framebuffer direct software
3370 * @li "sdl", "software-sdl", "software_sdl" (SDL software rendering to SDL
3372 * @li "gl-sdl", "gl_sdl", "opengl-sdl", "opengl_sdl" (OpenGL or OpenGL-ES2
3373 * rendering using SDL as the buffer)
3374 * @li "gdi", "software-gdi", "software_gdi" (Windows WIN32 rendering via
3375 * GDI with software)
3376 * @li "dfb", "directfb" (Rendering to a DirectFB window)
3377 * @li "x11-8", "x8", "software-8-x11", "software_8_x11" (Rendering in
3378 * grayscale using dedicated 8bit software engine in X11)
3379 * @li "x11-16", "x16", "software-16-x11", "software_16_x11" (Rendering in
3380 * X11 using 16bit software engine)
3381 * @li "wince-gdi", "software-16-wince-gdi", "software_16_wince_gdi"
3382 * (Windows CE rendering via GDI with 16bit software renderer)
3383 * @li "sdl-16", "software-16-sdl", "software_16_sdl" (Rendering to SDL
3384 * buffer with 16bit software renderer)
3386 * All engines use a simple string to select the engine to render, EXCEPT
3387 * the "shot" engine. This actually encodes the output of the virtual
3388 * screenshot and how long to delay in the engine string. The engine string
3389 * is encoded in the following way:
3391 * "shot:[delay=XX][:][repeat=DDD][:][file=XX]"
3393 * Where options are separated by a ":" char if more than one option is
3394 * given, with delay, if provided being the first option and file the last
3395 * (order is important). The delay specifies how long to wait after the
3396 * window is shown before doing the virtual "in memory" rendering and then
3397 * save the output to the file specified by the file option (and then exit).
3398 * If no delay is given, the default is 0.5 seconds. If no file is given the
3399 * default output file is "out.png". Repeat option is for continous
3400 * capturing screenshots. Repeat range is from 1 to 999 and filename is
3401 * fixed to "out001.png" Some examples of using the shot engine:
3403 * ELM_ENGINE="shot:delay=1.0:repeat=5:file=elm_test.png" elementary_test
3404 * ELM_ENGINE="shot:delay=1.0:file=elm_test.png" elementary_test
3405 * ELM_ENGINE="shot:file=elm_test2.png" elementary_test
3406 * ELM_ENGINE="shot:delay=2.0" elementary_test
3407 * ELM_ENGINE="shot:" elementary_test
3409 * Signals that you can add callbacks for are:
3411 * @li "delete,request": the user requested to close the window. See
3412 * elm_win_autodel_set().
3413 * @li "focus,in": window got focus
3414 * @li "focus,out": window lost focus
3415 * @li "moved": window that holds the canvas was moved
3418 * @li @ref win_example_01
3423 * Defines the types of window that can be created
3425 * These are hints set on the window so that a running Window Manager knows
3426 * how the window should be handled and/or what kind of decorations it
3429 * Currently, only the X11 backed engines use them.
3431 typedef enum _Elm_Win_Type
3433 ELM_WIN_BASIC, /**< A normal window. Indicates a normal, top-level
3434 window. Almost every window will be created with this
3436 ELM_WIN_DIALOG_BASIC, /**< Used for simple dialog windows/ */
3437 ELM_WIN_DESKTOP, /**< For special desktop windows, like a background
3438 window holding desktop icons. */
3439 ELM_WIN_DOCK, /**< The window is used as a dock or panel. Usually would
3440 be kept on top of any other window by the Window
3442 ELM_WIN_TOOLBAR, /**< The window is used to hold a floating toolbar, or
3444 ELM_WIN_MENU, /**< Similar to #ELM_WIN_TOOLBAR. */
3445 ELM_WIN_UTILITY, /**< A persistent utility window, like a toolbox or
3447 ELM_WIN_SPLASH, /**< Splash window for a starting up application. */
3448 ELM_WIN_DROPDOWN_MENU, /**< The window is a dropdown menu, as when an
3449 entry in a menubar is clicked. Typically used
3450 with elm_win_override_set(). This hint exists
3451 for completion only, as the EFL way of
3452 implementing a menu would not normally use a
3453 separate window for its contents. */
3454 ELM_WIN_POPUP_MENU, /**< Like #ELM_WIN_DROPDOWN_MENU, but for the menu
3455 triggered by right-clicking an object. */
3456 ELM_WIN_TOOLTIP, /**< The window is a tooltip. A short piece of
3457 explanatory text that typically appear after the
3458 mouse cursor hovers over an object for a while.
3459 Typically used with elm_win_override_set() and also
3460 not very commonly used in the EFL. */
3461 ELM_WIN_NOTIFICATION, /**< A notification window, like a warning about
3462 battery life or a new E-Mail received. */
3463 ELM_WIN_COMBO, /**< A window holding the contents of a combo box. Not
3464 usually used in the EFL. */
3465 ELM_WIN_DND, /**< Used to indicate the window is a representation of an
3466 object being dragged across different windows, or even
3467 applications. Typically used with
3468 elm_win_override_set(). */
3469 ELM_WIN_INLINED_IMAGE, /**< The window is rendered onto an image
3470 buffer. No actual window is created for this
3471 type, instead the window and all of its
3472 contents will be rendered to an image buffer.
3473 This allows to have children window inside a
3474 parent one just like any other object would
3475 be, and do other things like applying @c
3476 Evas_Map effects to it. This is the only type
3477 of window that requires the @c parent
3478 parameter of elm_win_add() to be a valid @c
3483 * The differents layouts that can be requested for the virtual keyboard.
3485 * When the application window is being managed by Illume, it may request
3486 * any of the following layouts for the virtual keyboard.
3488 typedef enum _Elm_Win_Keyboard_Mode
3490 ELM_WIN_KEYBOARD_UNKNOWN, /**< Unknown keyboard state */
3491 ELM_WIN_KEYBOARD_OFF, /**< Request to deactivate the keyboard */
3492 ELM_WIN_KEYBOARD_ON, /**< Enable keyboard with default layout */
3493 ELM_WIN_KEYBOARD_ALPHA, /**< Alpha (a-z) keyboard layout */
3494 ELM_WIN_KEYBOARD_NUMERIC, /**< Numeric keyboard layout */
3495 ELM_WIN_KEYBOARD_PIN, /**< PIN keyboard layout */
3496 ELM_WIN_KEYBOARD_PHONE_NUMBER, /**< Phone keyboard layout */
3497 ELM_WIN_KEYBOARD_HEX, /**< Hexadecimal numeric keyboard layout */
3498 ELM_WIN_KEYBOARD_TERMINAL, /**< Full (QUERTY) keyboard layout */
3499 ELM_WIN_KEYBOARD_PASSWORD, /**< Password keyboard layout */
3500 ELM_WIN_KEYBOARD_IP, /**< IP keyboard layout */
3501 ELM_WIN_KEYBOARD_HOST, /**< Host keyboard layout */
3502 ELM_WIN_KEYBOARD_FILE, /**< File keyboard layout */
3503 ELM_WIN_KEYBOARD_URL, /**< URL keyboard layout */
3504 ELM_WIN_KEYBOARD_KEYPAD, /**< Keypad layout */
3505 ELM_WIN_KEYBOARD_J2ME /**< J2ME keyboard layout */
3506 } Elm_Win_Keyboard_Mode;
3509 * Available commands that can be sent to the Illume manager.
3511 * When running under an Illume session, a window may send commands to the
3512 * Illume manager to perform different actions.
3514 typedef enum _Elm_Illume_Command
3516 ELM_ILLUME_COMMAND_FOCUS_BACK, /**< Reverts focus to the previous
3518 ELM_ILLUME_COMMAND_FOCUS_FORWARD, /**< Sends focus to the next window\
3520 ELM_ILLUME_COMMAND_FOCUS_HOME, /**< Hides all windows to show the Home
3522 ELM_ILLUME_COMMAND_CLOSE /**< Closes the currently active window */
3523 } Elm_Illume_Command;
3526 * Adds a window object. If this is the first window created, pass NULL as
3529 * @param parent Parent object to add the window to, or NULL
3530 * @param name The name of the window
3531 * @param type The window type, one of #Elm_Win_Type.
3533 * The @p parent paramter can be @c NULL for every window @p type except
3534 * #ELM_WIN_INLINED_IMAGE, which needs a parent to retrieve the canvas on
3535 * which the image object will be created.
3537 * @return The created object, or NULL on failure
3539 EAPI Evas_Object *elm_win_add(Evas_Object *parent, const char *name, Elm_Win_Type type);
3541 * Add @p subobj as a resize object of window @p obj.
3544 * Setting an object as a resize object of the window means that the
3545 * @p subobj child's size and position will be controlled by the window
3546 * directly. That is, the object will be resized to match the window size
3547 * and should never be moved or resized manually by the developer.
3549 * In addition, resize objects of the window control what the minimum size
3550 * of it will be, as well as whether it can or not be resized by the user.
3552 * For the end user to be able to resize a window by dragging the handles
3553 * or borders provided by the Window Manager, or using any other similar
3554 * mechanism, all of the resize objects in the window should have their
3555 * evas_object_size_hint_weight_set() set to EVAS_HINT_EXPAND.
3557 * @param obj The window object
3558 * @param subobj The resize object to add
3560 EAPI void elm_win_resize_object_add(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
3562 * Delete @p subobj as a resize object of window @p obj.
3564 * This function removes the object @p subobj from the resize objects of
3565 * the window @p obj. It will not delete the object itself, which will be
3566 * left unmanaged and should be deleted by the developer, manually handled
3567 * or set as child of some other container.
3569 * @param obj The window object
3570 * @param subobj The resize object to add
3572 EAPI void elm_win_resize_object_del(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
3574 * Set the title of the window
3576 * @param obj The window object
3577 * @param title The title to set
3579 EAPI void elm_win_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
3581 * Get the title of the window
3583 * The returned string is an internal one and should not be freed or
3584 * modified. It will also be rendered invalid if a new title is set or if
3585 * the window is destroyed.
3587 * @param obj The window object
3590 EAPI const char *elm_win_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3592 * Set the window's autodel state.
3594 * When closing the window in any way outside of the program control, like
3595 * pressing the X button in the titlebar or using a command from the
3596 * Window Manager, a "delete,request" signal is emitted to indicate that
3597 * this event occurred and the developer can take any action, which may
3598 * include, or not, destroying the window object.
3600 * When the @p autodel parameter is set, the window will be automatically
3601 * destroyed when this event occurs, after the signal is emitted.
3602 * If @p autodel is @c EINA_FALSE, then the window will not be destroyed
3603 * and is up to the program to do so when it's required.
3605 * @param obj The window object
3606 * @param autodel If true, the window will automatically delete itself when
3609 EAPI void elm_win_autodel_set(Evas_Object *obj, Eina_Bool autodel) EINA_ARG_NONNULL(1);
3611 * Get the window's autodel state.
3613 * @param obj The window object
3614 * @return If the window will automatically delete itself when closed
3616 * @see elm_win_autodel_set()
3618 EAPI Eina_Bool elm_win_autodel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3620 * Activate a window object.
3622 * This function sends a request to the Window Manager to activate the
3623 * window pointed by @p obj. If honored by the WM, the window will receive
3624 * the keyboard focus.
3626 * @note This is just a request that a Window Manager may ignore, so calling
3627 * this function does not ensure in any way that the window will be the
3628 * active one after it.
3630 * @param obj The window object
3632 EAPI void elm_win_activate(Evas_Object *obj) EINA_ARG_NONNULL(1);
3634 * Lower a window object.
3636 * Places the window pointed by @p obj at the bottom of the stack, so that
3637 * no other window is covered by it.
3639 * If elm_win_override_set() is not set, the Window Manager may ignore this
3642 * @param obj The window object
3644 EAPI void elm_win_lower(Evas_Object *obj) EINA_ARG_NONNULL(1);
3646 * Raise a window object.
3648 * Places the window pointed by @p obj at the top of the stack, so that it's
3649 * not covered by any other window.
3651 * If elm_win_override_set() is not set, the Window Manager may ignore this
3654 * @param obj The window object
3656 EAPI void elm_win_raise(Evas_Object *obj) EINA_ARG_NONNULL(1);
3658 * Set the borderless state of a window.
3660 * This function requests the Window Manager to not draw any decoration
3661 * around the window.
3663 * @param obj The window object
3664 * @param borderless If true, the window is borderless
3666 EAPI void elm_win_borderless_set(Evas_Object *obj, Eina_Bool borderless) EINA_ARG_NONNULL(1);
3668 * Get the borderless state of a window.
3670 * @param obj The window object
3671 * @return If true, the window is borderless
3673 EAPI Eina_Bool elm_win_borderless_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3675 * Set the shaped state of a window.
3677 * Shaped windows, when supported, will render the parts of the window that
3678 * has no content, transparent.
3680 * If @p shaped is EINA_FALSE, then it is strongly adviced to have some
3681 * background object or cover the entire window in any other way, or the
3682 * parts of the canvas that have no data will show framebuffer artifacts.
3684 * @param obj The window object
3685 * @param shaped If true, the window is shaped
3687 * @see elm_win_alpha_set()
3689 EAPI void elm_win_shaped_set(Evas_Object *obj, Eina_Bool shaped) EINA_ARG_NONNULL(1);
3691 * Get the shaped state of a window.
3693 * @param obj The window object
3694 * @return If true, the window is shaped
3696 * @see elm_win_shaped_set()
3698 EAPI Eina_Bool elm_win_shaped_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3700 * Set the alpha channel state of a window.
3702 * If @p alpha is EINA_TRUE, the alpha channel of the canvas will be enabled
3703 * possibly making parts of the window completely or partially transparent.
3704 * This is also subject to the underlying system supporting it, like for
3705 * example, running under a compositing manager. If no compositing is
3706 * available, enabling this option will instead fallback to using shaped
3707 * windows, with elm_win_shaped_set().
3709 * @param obj The window object
3710 * @param alpha If true, the window has an alpha channel
3712 * @see elm_win_alpha_set()
3714 EAPI void elm_win_alpha_set(Evas_Object *obj, Eina_Bool alpha) EINA_ARG_NONNULL(1);
3716 * Get the transparency state of a window.
3718 * @param obj The window object
3719 * @return If true, the window is transparent
3721 * @see elm_win_transparent_set()
3723 EAPI Eina_Bool elm_win_transparent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3725 * Set the transparency state of a window.
3727 * Use elm_win_alpha_set() instead.
3729 * @param obj The window object
3730 * @param transparent If true, the window is transparent
3732 * @see elm_win_alpha_set()
3734 EAPI void elm_win_transparent_set(Evas_Object *obj, Eina_Bool transparent) EINA_ARG_NONNULL(1);
3736 * Get the alpha channel state of a window.
3738 * @param obj The window object
3739 * @return If true, the window has an alpha channel
3741 EAPI Eina_Bool elm_win_alpha_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3743 * Set the override state of a window.
3745 * A window with @p override set to EINA_TRUE will not be managed by the
3746 * Window Manager. This means that no decorations of any kind will be shown
3747 * for it, moving and resizing must be handled by the application, as well
3748 * as the window visibility.
3750 * This should not be used for normal windows, and even for not so normal
3751 * ones, it should only be used when there's a good reason and with a lot
3752 * of care. Mishandling override windows may result situations that
3753 * disrupt the normal workflow of the end user.
3755 * @param obj The window object
3756 * @param override If true, the window is overridden
3758 EAPI void elm_win_override_set(Evas_Object *obj, Eina_Bool override) EINA_ARG_NONNULL(1);
3760 * Get the override state of a window.
3762 * @param obj The window object
3763 * @return If true, the window is overridden
3765 * @see elm_win_override_set()
3767 EAPI Eina_Bool elm_win_override_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3769 * Set the fullscreen state of a window.
3771 * @param obj The window object
3772 * @param fullscreen If true, the window is fullscreen
3774 EAPI void elm_win_fullscreen_set(Evas_Object *obj, Eina_Bool fullscreen) EINA_ARG_NONNULL(1);
3776 * Get the fullscreen state of a window.
3778 * @param obj The window object
3779 * @return If true, the window is fullscreen
3781 EAPI Eina_Bool elm_win_fullscreen_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3783 * Set the maximized state of a window.
3785 * @param obj The window object
3786 * @param maximized If true, the window is maximized
3788 EAPI void elm_win_maximized_set(Evas_Object *obj, Eina_Bool maximized) EINA_ARG_NONNULL(1);
3790 * Get the maximized state of a window.
3792 * @param obj The window object
3793 * @return If true, the window is maximized
3795 EAPI Eina_Bool elm_win_maximized_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3797 * Set the iconified state of a window.
3799 * @param obj The window object
3800 * @param iconified If true, the window is iconified
3802 EAPI void elm_win_iconified_set(Evas_Object *obj, Eina_Bool iconified) EINA_ARG_NONNULL(1);
3804 * Get the iconified state of a window.
3806 * @param obj The window object
3807 * @return If true, the window is iconified
3809 EAPI Eina_Bool elm_win_iconified_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3811 * Set the layer of the window.
3813 * What this means exactly will depend on the underlying engine used.
3815 * In the case of X11 backed engines, the value in @p layer has the
3816 * following meanings:
3817 * @li < 3: The window will be placed below all others.
3818 * @li > 5: The window will be placed above all others.
3819 * @li other: The window will be placed in the default layer.
3821 * @param obj The window object
3822 * @param layer The layer of the window
3824 EAPI void elm_win_layer_set(Evas_Object *obj, int layer) EINA_ARG_NONNULL(1);
3826 * Get the layer of the window.
3828 * @param obj The window object
3829 * @return The layer of the window
3831 * @see elm_win_layer_set()
3833 EAPI int elm_win_layer_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3835 * Set the rotation of the window.
3837 * Most engines only work with multiples of 90.
3839 * This function is used to set the orientation of the window @p obj to
3840 * match that of the screen. The window itself will be resized to adjust
3841 * to the new geometry of its contents. If you want to keep the window size,
3842 * see elm_win_rotation_with_resize_set().
3844 * @param obj The window object
3845 * @param rotation The rotation of the window, in degrees (0-360),
3846 * counter-clockwise.
3848 EAPI void elm_win_rotation_set(Evas_Object *obj, int rotation) EINA_ARG_NONNULL(1);
3850 * Rotates the window and resizes it.
3852 * Like elm_win_rotation_set(), but it also resizes the window's contents so
3853 * that they fit inside the current window geometry.
3855 * @param obj The window object
3856 * @param layer The rotation of the window in degrees (0-360),
3857 * counter-clockwise.
3859 EAPI void elm_win_rotation_with_resize_set(Evas_Object *obj, int rotation) EINA_ARG_NONNULL(1);
3861 * Get the rotation of the window.
3863 * @param obj The window object
3864 * @return The rotation of the window in degrees (0-360)
3866 * @see elm_win_rotation_set()
3867 * @see elm_win_rotation_with_resize_set()
3869 EAPI int elm_win_rotation_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3871 * Set the sticky state of the window.
3873 * Hints the Window Manager that the window in @p obj should be left fixed
3874 * at its position even when the virtual desktop it's on moves or changes.
3876 * @param obj The window object
3877 * @param sticky If true, the window's sticky state is enabled
3879 EAPI void elm_win_sticky_set(Evas_Object *obj, Eina_Bool sticky) EINA_ARG_NONNULL(1);
3881 * Get the sticky state of the window.
3883 * @param obj The window object
3884 * @return If true, the window's sticky state is enabled
3886 * @see elm_win_sticky_set()
3888 EAPI Eina_Bool elm_win_sticky_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3890 * Set if this window is an illume conformant window
3892 * @param obj The window object
3893 * @param conformant The conformant flag (1 = conformant, 0 = non-conformant)
3895 EAPI void elm_win_conformant_set(Evas_Object *obj, Eina_Bool conformant) EINA_ARG_NONNULL(1);
3897 * Get if this window is an illume conformant window
3899 * @param obj The window object
3900 * @return A boolean if this window is illume conformant or not
3902 EAPI Eina_Bool elm_win_conformant_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3904 * Set a window to be an illume quickpanel window
3906 * By default window objects are not quickpanel windows.
3908 * @param obj The window object
3909 * @param quickpanel The quickpanel flag (1 = quickpanel, 0 = normal window)
3911 EAPI void elm_win_quickpanel_set(Evas_Object *obj, Eina_Bool quickpanel) EINA_ARG_NONNULL(1);
3913 * Get if this window is a quickpanel or not
3915 * @param obj The window object
3916 * @return A boolean if this window is a quickpanel or not
3918 EAPI Eina_Bool elm_win_quickpanel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3920 * Set the major priority of a quickpanel window
3922 * @param obj The window object
3923 * @param priority The major priority for this quickpanel
3925 EAPI void elm_win_quickpanel_priority_major_set(Evas_Object *obj, int priority) EINA_ARG_NONNULL(1);
3927 * Get the major priority of a quickpanel window
3929 * @param obj The window object
3930 * @return The major priority of this quickpanel
3932 EAPI int elm_win_quickpanel_priority_major_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3934 * Set the minor priority of a quickpanel window
3936 * @param obj The window object
3937 * @param priority The minor priority for this quickpanel
3939 EAPI void elm_win_quickpanel_priority_minor_set(Evas_Object *obj, int priority) EINA_ARG_NONNULL(1);
3941 * Get the minor priority of a quickpanel window
3943 * @param obj The window object
3944 * @return The minor priority of this quickpanel
3946 EAPI int elm_win_quickpanel_priority_minor_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3948 * Set which zone this quickpanel should appear in
3950 * @param obj The window object
3951 * @param zone The requested zone for this quickpanel
3953 EAPI void elm_win_quickpanel_zone_set(Evas_Object *obj, int zone) EINA_ARG_NONNULL(1);
3955 * Get which zone this quickpanel should appear in
3957 * @param obj The window object
3958 * @return The requested zone for this quickpanel
3960 EAPI int elm_win_quickpanel_zone_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3962 * Set the window to be skipped by keyboard focus
3964 * This sets the window to be skipped by normal keyboard input. This means
3965 * a window manager will be asked to not focus this window as well as omit
3966 * it from things like the taskbar, pager, "alt-tab" list etc. etc.
3968 * Call this and enable it on a window BEFORE you show it for the first time,
3969 * otherwise it may have no effect.
3971 * Use this for windows that have only output information or might only be
3972 * interacted with by the mouse or fingers, and never for typing input.
3973 * Be careful that this may have side-effects like making the window
3974 * non-accessible in some cases unless the window is specially handled. Use
3977 * @param obj The window object
3978 * @param skip The skip flag state (EINA_TRUE if it is to be skipped)
3980 EAPI void elm_win_prop_focus_skip_set(Evas_Object *obj, Eina_Bool skip) EINA_ARG_NONNULL(1);
3982 * Send a command to the windowing environment
3984 * This is intended to work in touchscreen or small screen device
3985 * environments where there is a more simplistic window management policy in
3986 * place. This uses the window object indicated to select which part of the
3987 * environment to control (the part that this window lives in), and provides
3988 * a command and an optional parameter structure (use NULL for this if not
3991 * @param obj The window object that lives in the environment to control
3992 * @param command The command to send
3993 * @param params Optional parameters for the command
3995 EAPI void elm_win_illume_command_send(Evas_Object *obj, Elm_Illume_Command command, void *params) EINA_ARG_NONNULL(1);
3997 * Get the inlined image object handle
3999 * When you create a window with elm_win_add() of type ELM_WIN_INLINED_IMAGE,
4000 * then the window is in fact an evas image object inlined in the parent
4001 * canvas. You can get this object (be careful to not manipulate it as it
4002 * is under control of elementary), and use it to do things like get pixel
4003 * data, save the image to a file, etc.
4005 * @param obj The window object to get the inlined image from
4006 * @return The inlined image object, or NULL if none exists
4008 EAPI Evas_Object *elm_win_inlined_image_object_get(Evas_Object *obj);
4010 * Set the enabled status for the focus highlight in a window
4012 * This function will enable or disable the focus highlight only for the
4013 * given window, regardless of the global setting for it
4015 * @param obj The window where to enable the highlight
4016 * @param enabled The enabled value for the highlight
4018 EAPI void elm_win_focus_highlight_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
4020 * Get the enabled value of the focus highlight for this window
4022 * @param obj The window in which to check if the focus highlight is enabled
4024 * @return EINA_TRUE if enabled, EINA_FALSE otherwise
4026 EAPI Eina_Bool elm_win_focus_highlight_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4028 * Set the style for the focus highlight on this window
4030 * Sets the style to use for theming the highlight of focused objects on
4031 * the given window. If @p style is NULL, the default will be used.
4033 * @param obj The window where to set the style
4034 * @param style The style to set
4036 EAPI void elm_win_focus_highlight_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
4038 * Get the style set for the focus highlight object
4040 * Gets the style set for this windows highilght object, or NULL if none
4043 * @param obj The window to retrieve the highlights style from
4045 * @return The style set or NULL if none was. Default is used in that case.
4047 EAPI const char *elm_win_focus_highlight_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4049 * ecore_x_icccm_hints_set -> accepts_focus (add to ecore_evas)
4050 * ecore_x_icccm_hints_set -> window_group (add to ecore_evas)
4051 * ecore_x_icccm_size_pos_hints_set -> request_pos (add to ecore_evas)
4052 * ecore_x_icccm_client_leader_set -> l (add to ecore_evas)
4053 * ecore_x_icccm_window_role_set -> role (add to ecore_evas)
4054 * ecore_x_icccm_transient_for_set -> forwin (add to ecore_evas)
4055 * ecore_x_netwm_window_type_set -> type (add to ecore_evas)
4057 * (add to ecore_x) set netwm argb icon! (add to ecore_evas)
4058 * (blank mouse, private mouse obj, defaultmouse)
4062 * Sets the keyboard mode of the window.
4064 * @param obj The window object
4065 * @param mode The mode to set, one of #Elm_Win_Keyboard_Mode
4067 EAPI void elm_win_keyboard_mode_set(Evas_Object *obj, Elm_Win_Keyboard_Mode mode) EINA_ARG_NONNULL(1);
4069 * Gets the keyboard mode of the window.
4071 * @param obj The window object
4072 * @return The mode, one of #Elm_Win_Keyboard_Mode
4074 EAPI Elm_Win_Keyboard_Mode elm_win_keyboard_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4076 * Sets whether the window is a keyboard.
4078 * @param obj The window object
4079 * @param is_keyboard If true, the window is a virtual keyboard
4081 EAPI void elm_win_keyboard_win_set(Evas_Object *obj, Eina_Bool is_keyboard) EINA_ARG_NONNULL(1);
4083 * Gets whether the window is a keyboard.
4085 * @param obj The window object
4086 * @return If the window is a virtual keyboard
4088 EAPI Eina_Bool elm_win_keyboard_win_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4091 * Get the screen position of a window.
4093 * @param obj The window object
4094 * @param x The int to store the x coordinate to
4095 * @param y The int to store the y coordinate to
4097 EAPI void elm_win_screen_position_get(const Evas_Object *obj, int *x, int *y) EINA_ARG_NONNULL(1);
4103 * @defgroup Inwin Inwin
4105 * @image html img/widget/inwin/preview-00.png
4106 * @image latex img/widget/inwin/preview-00.eps
4107 * @image html img/widget/inwin/preview-01.png
4108 * @image latex img/widget/inwin/preview-01.eps
4109 * @image html img/widget/inwin/preview-02.png
4110 * @image latex img/widget/inwin/preview-02.eps
4112 * An inwin is a window inside a window that is useful for a quick popup.
4113 * It does not hover.
4115 * It works by creating an object that will occupy the entire window, so it
4116 * must be created using an @ref Win "elm_win" as parent only. The inwin
4117 * object can be hidden or restacked below every other object if it's
4118 * needed to show what's behind it without destroying it. If this is done,
4119 * the elm_win_inwin_activate() function can be used to bring it back to
4120 * full visibility again.
4122 * There are three styles available in the default theme. These are:
4123 * @li default: The inwin is sized to take over most of the window it's
4125 * @li minimal: The size of the inwin will be the minimum necessary to show
4127 * @li minimal_vertical: Horizontally, the inwin takes as much space as
4128 * possible, but it's sized vertically the most it needs to fit its\
4131 * Some examples of Inwin can be found in the following:
4132 * @li @ref inwin_example_01
4137 * Adds an inwin to the current window
4139 * The @p obj used as parent @b MUST be an @ref Win "Elementary Window".
4140 * Never call this function with anything other than the top-most window
4141 * as its parameter, unless you are fond of undefined behavior.
4143 * After creating the object, the widget will set itself as resize object
4144 * for the window with elm_win_resize_object_add(), so when shown it will
4145 * appear to cover almost the entire window (how much of it depends on its
4146 * content and the style used). It must not be added into other container
4147 * objects and it needs not be moved or resized manually.
4149 * @param parent The parent object
4150 * @return The new object or NULL if it cannot be created
4152 EAPI Evas_Object *elm_win_inwin_add(Evas_Object *obj) EINA_ARG_NONNULL(1);
4154 * Activates an inwin object, ensuring its visibility
4156 * This function will make sure that the inwin @p obj is completely visible
4157 * by calling evas_object_show() and evas_object_raise() on it, to bring it
4158 * to the front. It also sets the keyboard focus to it, which will be passed
4161 * The object's theme will also receive the signal "elm,action,show" with
4164 * @param obj The inwin to activate
4166 EAPI void elm_win_inwin_activate(Evas_Object *obj) EINA_ARG_NONNULL(1);
4168 * Set the content of an inwin object.
4170 * Once the content object is set, a previously set one will be deleted.
4171 * If you want to keep that old content object, use the
4172 * elm_win_inwin_content_unset() function.
4174 * @param obj The inwin object
4175 * @param content The object to set as content
4177 EAPI void elm_win_inwin_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
4179 * Get the content of an inwin object.
4181 * Return the content object which is set for this widget.
4183 * The returned object is valid as long as the inwin is still alive and no
4184 * other content is set on it. Deleting the object will notify the inwin
4185 * about it and this one will be left empty.
4187 * If you need to remove an inwin's content to be reused somewhere else,
4188 * see elm_win_inwin_content_unset().
4190 * @param obj The inwin object
4191 * @return The content that is being used
4193 EAPI Evas_Object *elm_win_inwin_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4195 * Unset the content of an inwin object.
4197 * Unparent and return the content object which was set for this widget.
4199 * @param obj The inwin object
4200 * @return The content that was being used
4202 EAPI Evas_Object *elm_win_inwin_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4206 /* X specific calls - won't work on non-x engines (return 0) */
4209 * Get the Ecore_X_Window of an Evas_Object
4211 * @param obj The object
4213 * @return The Ecore_X_Window of @p obj
4217 EAPI Ecore_X_Window elm_win_xwindow_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4219 /* smart callbacks called:
4220 * "delete,request" - the user requested to delete the window
4221 * "focus,in" - window got focus
4222 * "focus,out" - window lost focus
4223 * "moved" - window that holds the canvas was moved
4229 * @image html img/widget/bg/preview-00.png
4230 * @image latex img/widget/bg/preview-00.eps
4232 * @brief Background object, used for setting a solid color, image or Edje
4233 * group as background to a window or any container object.
4235 * The bg object is used for setting a solid background to a window or
4236 * packing into any container object. It works just like an image, but has
4237 * some properties useful to a background, like setting it to tiled,
4238 * centered, scaled or stretched.
4240 * Here is some sample code using it:
4241 * @li @ref bg_01_example_page
4242 * @li @ref bg_02_example_page
4243 * @li @ref bg_03_example_page
4247 typedef enum _Elm_Bg_Option
4249 ELM_BG_OPTION_CENTER, /**< center the background */
4250 ELM_BG_OPTION_SCALE, /**< scale the background retaining aspect ratio */
4251 ELM_BG_OPTION_STRETCH, /**< stretch the background to fill */
4252 ELM_BG_OPTION_TILE /**< tile background at its original size */
4256 * Add a new background to the parent
4258 * @param parent The parent object
4259 * @return The new object or NULL if it cannot be created
4263 EAPI Evas_Object *elm_bg_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4266 * Set the file (image or edje) used for the background
4268 * @param obj The bg object
4269 * @param file The file path
4270 * @param group Optional key (group in Edje) within the file
4272 * This sets the image file used in the background object. The image (or edje)
4273 * will be stretched (retaining aspect if its an image file) to completely fill
4274 * the bg object. This may mean some parts are not visible.
4276 * @note Once the image of @p obj is set, a previously set one will be deleted,
4277 * even if @p file is NULL.
4281 EAPI void elm_bg_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1);
4284 * Get the file (image or edje) used for the background
4286 * @param obj The bg object
4287 * @param file The file path
4288 * @param group Optional key (group in Edje) within the file
4292 EAPI void elm_bg_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
4295 * Set the option used for the background image
4297 * @param obj The bg object
4298 * @param option The desired background option (TILE, SCALE)
4300 * This sets the option used for manipulating the display of the background
4301 * image. The image can be tiled or scaled.
4305 EAPI void elm_bg_option_set(Evas_Object *obj, Elm_Bg_Option option) EINA_ARG_NONNULL(1);
4308 * Get the option used for the background image
4310 * @param obj The bg object
4311 * @return The desired background option (CENTER, SCALE, STRETCH or TILE)
4315 EAPI Elm_Bg_Option elm_bg_option_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4317 * Set the option used for the background color
4319 * @param obj The bg object
4324 * This sets the color used for the background rectangle. Its range goes
4329 EAPI void elm_bg_color_set(Evas_Object *obj, int r, int g, int b) EINA_ARG_NONNULL(1);
4331 * Get the option used for the background color
4333 * @param obj The bg object
4340 EAPI void elm_bg_color_get(const Evas_Object *obj, int *r, int *g, int *b) EINA_ARG_NONNULL(1);
4343 * Set the overlay object used for the background object.
4345 * @param obj The bg object
4346 * @param overlay The overlay object
4348 * This provides a way for elm_bg to have an 'overlay' that will be on top
4349 * of the bg. Once the over object is set, a previously set one will be
4350 * deleted, even if you set the new one to NULL. If you want to keep that
4351 * old content object, use the elm_bg_overlay_unset() function.
4356 EAPI void elm_bg_overlay_set(Evas_Object *obj, Evas_Object *overlay) EINA_ARG_NONNULL(1);
4359 * Get the overlay object used for the background object.
4361 * @param obj The bg object
4362 * @return The content that is being used
4364 * Return the content object which is set for this widget
4368 EAPI Evas_Object *elm_bg_overlay_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4371 * Get the overlay object used for the background object.
4373 * @param obj The bg object
4374 * @return The content that was being used
4376 * Unparent and return the overlay object which was set for this widget
4380 EAPI Evas_Object *elm_bg_overlay_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4383 * Set the size of the pixmap representation of the image.
4385 * This option just makes sense if an image is going to be set in the bg.
4387 * @param obj The bg object
4388 * @param w The new width of the image pixmap representation.
4389 * @param h The new height of the image pixmap representation.
4391 * This function sets a new size for pixmap representation of the given bg
4392 * image. It allows the image to be loaded already in the specified size,
4393 * reducing the memory usage and load time when loading a big image with load
4394 * size set to a smaller size.
4396 * NOTE: this is just a hint, the real size of the pixmap may differ
4397 * depending on the type of image being loaded, being bigger than requested.
4401 EAPI void elm_bg_load_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
4402 /* smart callbacks called:
4406 * @defgroup Icon Icon
4408 * @image html img/widget/icon/preview-00.png
4409 * @image latex img/widget/icon/preview-00.eps
4411 * An object that provides standard icon images (delete, edit, arrows, etc.)
4412 * or a custom file (PNG, JPG, EDJE, etc.) used for an icon.
4414 * The icon image requested can be in the elementary theme, or in the
4415 * freedesktop.org paths. It's possible to set the order of preference from
4416 * where the image will be used.
4418 * This API is very similar to @ref Image, but with ready to use images.
4420 * Default images provided by the theme are described below.
4422 * The first list contains icons that were first intended to be used in
4423 * toolbars, but can be used in many other places too:
4439 * Now some icons that were designed to be used in menus (but again, you can
4440 * use them anywhere else):
4445 * @li menu/arrow_down
4446 * @li menu/arrow_left
4447 * @li menu/arrow_right
4456 * And here we have some media player specific icons:
4457 * @li media_player/forward
4458 * @li media_player/info
4459 * @li media_player/next
4460 * @li media_player/pause
4461 * @li media_player/play
4462 * @li media_player/prev
4463 * @li media_player/rewind
4464 * @li media_player/stop
4466 * Signals that you can add callbacks for are:
4468 * "clicked" - This is called when a user has clicked the icon
4470 * An example of usage for this API follows:
4471 * @li @ref tutorial_icon
4479 typedef enum _Elm_Icon_Type
4486 * @enum _Elm_Icon_Lookup_Order
4487 * @typedef Elm_Icon_Lookup_Order
4489 * Lookup order used by elm_icon_standard_set(). Should look for icons in the
4490 * theme, FDO paths, or both?
4494 typedef enum _Elm_Icon_Lookup_Order
4496 ELM_ICON_LOOKUP_FDO_THEME, /**< icon look up order: freedesktop, theme */
4497 ELM_ICON_LOOKUP_THEME_FDO, /**< icon look up order: theme, freedesktop */
4498 ELM_ICON_LOOKUP_FDO, /**< icon look up order: freedesktop */
4499 ELM_ICON_LOOKUP_THEME /**< icon look up order: theme */
4500 } Elm_Icon_Lookup_Order;
4503 * Add a new icon object to the parent.
4505 * @param parent The parent object
4506 * @return The new object or NULL if it cannot be created
4508 * @see elm_icon_file_set()
4512 EAPI Evas_Object *elm_icon_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4514 * Set the file that will be used as icon.
4516 * @param obj The icon object
4517 * @param file The path to file that will be used as icon image
4518 * @param group The group that the icon belongs to in edje file
4520 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
4522 * @note The icon image set by this function can be changed by
4523 * elm_icon_standard_set().
4525 * @see elm_icon_file_get()
4529 EAPI Eina_Bool elm_icon_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
4531 * Set a location in memory to be used as an icon
4533 * @param obj The icon object
4534 * @param img The binary data that will be used as an image
4535 * @param size The size of binary data @p img
4536 * @param format Optional format of @p img to pass to the image loader
4537 * @param key Optional key of @p img to pass to the image loader (eg. if @p img is an edje file)
4539 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
4541 * @note The icon image set by this function can be changed by
4542 * elm_icon_standard_set().
4546 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);
4548 * Get the file that will be used as icon.
4550 * @param obj The icon object
4551 * @param file The path to file that will be used as icon icon image
4552 * @param group The group that the icon belongs to in edje file
4554 * @see elm_icon_file_set()
4558 EAPI void elm_icon_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
4559 EAPI void elm_icon_thumb_set(const Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
4561 * Set the icon by icon standards names.
4563 * @param obj The icon object
4564 * @param name The icon name
4566 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
4568 * For example, freedesktop.org defines standard icon names such as "home",
4569 * "network", etc. There can be different icon sets to match those icon
4570 * keys. The @p name given as parameter is one of these "keys", and will be
4571 * used to look in the freedesktop.org paths and elementary theme. One can
4572 * change the lookup order with elm_icon_order_lookup_set().
4574 * If name is not found in any of the expected locations and it is the
4575 * absolute path of an image file, this image will be used.
4577 * @note The icon image set by this function can be changed by
4578 * elm_icon_file_set().
4580 * @see elm_icon_standard_get()
4581 * @see elm_icon_file_set()
4585 EAPI Eina_Bool elm_icon_standard_set(Evas_Object *obj, const char *name) EINA_ARG_NONNULL(1);
4587 * Get the icon name set by icon standard names.
4589 * @param obj The icon object
4590 * @return The icon name
4592 * If the icon image was set using elm_icon_file_set() instead of
4593 * elm_icon_standard_set(), then this function will return @c NULL.
4595 * @see elm_icon_standard_set()
4599 EAPI const char *elm_icon_standard_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4601 * Set the smooth effect for an icon object.
4603 * @param obj The icon object
4604 * @param smooth @c EINA_TRUE if smooth scaling should be used, @c EINA_FALSE
4605 * otherwise. Default is @c EINA_TRUE.
4607 * Set the scaling algorithm to be used when scaling the icon image. Smooth
4608 * scaling provides a better resulting image, but is slower.
4610 * The smooth scaling should be disabled when making animations that change
4611 * the icon size, since they will be faster. Animations that don't require
4612 * resizing of the icon can keep the smooth scaling enabled (even if the icon
4613 * is already scaled, since the scaled icon image will be cached).
4615 * @see elm_icon_smooth_get()
4619 EAPI void elm_icon_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
4621 * Get the smooth effect for an icon object.
4623 * @param obj The icon object
4624 * @return @c EINA_TRUE if smooth scaling is enabled, @c EINA_FALSE otherwise.
4626 * @see elm_icon_smooth_set()
4630 EAPI Eina_Bool elm_icon_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4632 * Disable scaling of this object.
4634 * @param obj The icon object.
4635 * @param no_scale @c EINA_TRUE if the object is not scalable, @c EINA_FALSE
4636 * otherwise. Default is @c EINA_FALSE.
4638 * This function disables scaling of the icon object through the function
4639 * elm_object_scale_set(). However, this does not affect the object
4640 * size/resize in any way. For that effect, take a look at
4641 * elm_icon_scale_set().
4643 * @see elm_icon_no_scale_get()
4644 * @see elm_icon_scale_set()
4645 * @see elm_object_scale_set()
4649 EAPI void elm_icon_no_scale_set(Evas_Object *obj, Eina_Bool no_scale) EINA_ARG_NONNULL(1);
4651 * Get whether scaling is disabled on the object.
4653 * @param obj The icon object
4654 * @return @c EINA_TRUE if scaling is disabled, @c EINA_FALSE otherwise
4656 * @see elm_icon_no_scale_set()
4660 EAPI Eina_Bool elm_icon_no_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4662 * Set if the object is (up/down) resizable.
4664 * @param obj The icon object
4665 * @param scale_up A bool to set if the object is resizable up. Default is
4667 * @param scale_down A bool to set if the object is resizable down. Default
4670 * This function limits the icon object resize ability. If @p scale_up is set to
4671 * @c EINA_FALSE, the object can't have its height or width resized to a value
4672 * higher than the original icon size. Same is valid for @p scale_down.
4674 * @see elm_icon_scale_get()
4678 EAPI void elm_icon_scale_set(Evas_Object *obj, Eina_Bool scale_up, Eina_Bool scale_down) EINA_ARG_NONNULL(1);
4680 * Get if the object is (up/down) resizable.
4682 * @param obj The icon object
4683 * @param scale_up A bool to set if the object is resizable up
4684 * @param scale_down A bool to set if the object is resizable down
4686 * @see elm_icon_scale_set()
4690 EAPI void elm_icon_scale_get(const Evas_Object *obj, Eina_Bool *scale_up, Eina_Bool *scale_down) EINA_ARG_NONNULL(1);
4692 * Get the object's image size
4694 * @param obj The icon object
4695 * @param w A pointer to store the width in
4696 * @param h A pointer to store the height in
4700 EAPI void elm_icon_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
4702 * Set if the icon fill the entire object area.
4704 * @param obj The icon object
4705 * @param fill_outside @c EINA_TRUE if the object is filled outside,
4706 * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
4708 * When the icon object is resized to a different aspect ratio from the
4709 * original icon image, the icon image will still keep its aspect. This flag
4710 * tells how the image should fill the object's area. They are: keep the
4711 * entire icon inside the limits of height and width of the object (@p
4712 * fill_outside is @c EINA_FALSE) or let the extra width or height go outside
4713 * of the object, and the icon will fill the entire object (@p fill_outside
4716 * @note Unlike @ref Image, there's no option in icon to set the aspect ratio
4717 * retain property to false. Thus, the icon image will always keep its
4718 * original aspect ratio.
4720 * @see elm_icon_fill_outside_get()
4721 * @see elm_image_fill_outside_set()
4725 EAPI void elm_icon_fill_outside_set(Evas_Object *obj, Eina_Bool fill_outside) EINA_ARG_NONNULL(1);
4727 * Get if the object is filled outside.
4729 * @param obj The icon object
4730 * @return @c EINA_TRUE if the object is filled outside, @c EINA_FALSE otherwise.
4732 * @see elm_icon_fill_outside_set()
4736 EAPI Eina_Bool elm_icon_fill_outside_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4738 * Set the prescale size for the icon.
4740 * @param obj The icon object
4741 * @param size The prescale size. This value is used for both width and
4744 * This function sets a new size for pixmap representation of the given
4745 * icon. It allows the icon to be loaded already in the specified size,
4746 * reducing the memory usage and load time when loading a big icon with load
4747 * size set to a smaller size.
4749 * It's equivalent to the elm_bg_load_size_set() function for bg.
4751 * @note this is just a hint, the real size of the pixmap may differ
4752 * depending on the type of icon being loaded, being bigger than requested.
4754 * @see elm_icon_prescale_get()
4755 * @see elm_bg_load_size_set()
4759 EAPI void elm_icon_prescale_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
4761 * Get the prescale size for the icon.
4763 * @param obj The icon object
4764 * @return The prescale size
4766 * @see elm_icon_prescale_set()
4770 EAPI int elm_icon_prescale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4772 * Sets the icon lookup order used by elm_icon_standard_set().
4774 * @param obj The icon object
4775 * @param order The icon lookup order (can be one of
4776 * ELM_ICON_LOOKUP_FDO_THEME, ELM_ICON_LOOKUP_THEME_FDO, ELM_ICON_LOOKUP_FDO
4777 * or ELM_ICON_LOOKUP_THEME)
4779 * @see elm_icon_order_lookup_get()
4780 * @see Elm_Icon_Lookup_Order
4784 EAPI void elm_icon_order_lookup_set(Evas_Object *obj, Elm_Icon_Lookup_Order order) EINA_ARG_NONNULL(1);
4786 * Gets the icon lookup order.
4788 * @param obj The icon object
4789 * @return The icon lookup order
4791 * @see elm_icon_order_lookup_set()
4792 * @see Elm_Icon_Lookup_Order
4796 EAPI Elm_Icon_Lookup_Order elm_icon_order_lookup_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4798 * Get if the icon supports animation or not.
4800 * @param obj The icon object
4801 * @return @c EINA_TRUE if the icon supports animation,
4802 * @c EINA_FALSE otherwise.
4804 * Return if this elm icon's image can be animated. Currently Evas only
4805 * supports gif animation. If the return value is EINA_FALSE, other
4806 * elm_icon_animated_XXX APIs won't work.
4809 EAPI Eina_Bool elm_icon_animated_available_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4811 * Set animation mode of the icon.
4813 * @param obj The icon object
4814 * @param anim @c EINA_TRUE if the object do animation job,
4815 * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
4817 * Even though elm icon's file can be animated,
4818 * sometimes appication developer want to just first page of image.
4819 * In that time, don't call this function, because default value is EINA_FALSE
4820 * Only when you want icon support anition,
4821 * use this function and set animated to EINA_TURE
4824 EAPI void elm_icon_animated_set(Evas_Object *obj, Eina_Bool animated) EINA_ARG_NONNULL(1);
4826 * Get animation mode of the icon.
4828 * @param obj The icon object
4829 * @return The animation mode of the icon object
4830 * @see elm_icon_animated_set
4833 EAPI Eina_Bool elm_icon_animated_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4835 * Set animation play mode of the icon.
4837 * @param obj The icon object
4838 * @param play @c EINA_TRUE the object play animation images,
4839 * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
4841 * If you want to play elm icon's animation, you set play to EINA_TURE.
4842 * For example, you make gif player using this set/get API and click event.
4844 * 1. Click event occurs
4845 * 2. Check play flag using elm_icon_animaged_play_get
4846 * 3. If elm icon was playing, set play to EINA_FALSE.
4847 * Then animation will be stopped and vice versa
4850 EAPI void elm_icon_animated_play_set(Evas_Object *obj, Eina_Bool play) EINA_ARG_NONNULL(1);
4852 * Get animation play mode of the icon.
4854 * @param obj The icon object
4855 * @return The play mode of the icon object
4857 * @see elm_icon_animated_lay_get
4860 EAPI Eina_Bool elm_icon_animated_play_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4867 * @defgroup Image Image
4869 * @image html img/widget/image/preview-00.png
4870 * @image latex img/widget/image/preview-00.eps
4873 * An object that allows one to load an image file to it. It can be used
4874 * anywhere like any other elementary widget.
4876 * This widget provides most of the functionality provided from @ref Bg or @ref
4877 * Icon, but with a slightly different API (use the one that fits better your
4880 * The features not provided by those two other image widgets are:
4881 * @li allowing to get the basic @c Evas_Object with elm_image_object_get();
4882 * @li change the object orientation with elm_image_orient_set();
4883 * @li and turning the image editable with elm_image_editable_set().
4885 * Signals that you can add callbacks for are:
4887 * @li @c "clicked" - This is called when a user has clicked the image
4889 * An example of usage for this API follows:
4890 * @li @ref tutorial_image
4899 * @enum _Elm_Image_Orient
4900 * @typedef Elm_Image_Orient
4902 * Possible orientation options for elm_image_orient_set().
4904 * @image html elm_image_orient_set.png
4905 * @image latex elm_image_orient_set.eps width=\textwidth
4909 typedef enum _Elm_Image_Orient
4911 ELM_IMAGE_ORIENT_NONE, /**< no orientation change */
4912 ELM_IMAGE_ROTATE_90_CW, /**< rotate 90 degrees clockwise */
4913 ELM_IMAGE_ROTATE_180_CW, /**< rotate 180 degrees clockwise */
4914 ELM_IMAGE_ROTATE_90_CCW, /**< rotate 90 degrees counter-clockwise (i.e. 270 degrees clockwise) */
4915 ELM_IMAGE_FLIP_HORIZONTAL, /**< flip image horizontally */
4916 ELM_IMAGE_FLIP_VERTICAL, /**< flip image vertically */
4917 ELM_IMAGE_FLIP_TRANSPOSE, /**< flip the image along the y = (side - x) line*/
4918 ELM_IMAGE_FLIP_TRANSVERSE /**< flip the image along the y = x line */
4922 * Add a new image to the parent.
4924 * @param parent The parent object
4925 * @return The new object or NULL if it cannot be created
4927 * @see elm_image_file_set()
4931 EAPI Evas_Object *elm_image_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4933 * Set the file that will be used as image.
4935 * @param obj The image object
4936 * @param file The path to file that will be used as image
4937 * @param group The group that the image belongs in edje file (if it's an
4940 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
4942 * @see elm_image_file_get()
4946 EAPI Eina_Bool elm_image_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
4948 * Get the file that will be used as image.
4950 * @param obj The image object
4951 * @param file The path to file
4952 * @param group The group that the image belongs in edje file
4954 * @see elm_image_file_set()
4958 EAPI void elm_image_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
4960 * Set the smooth effect for an image.
4962 * @param obj The image object
4963 * @param smooth @c EINA_TRUE if smooth scaling should be used, @c EINA_FALSE
4964 * otherwise. Default is @c EINA_TRUE.
4966 * Set the scaling algorithm to be used when scaling the image. Smooth
4967 * scaling provides a better resulting image, but is slower.
4969 * The smooth scaling should be disabled when making animations that change
4970 * the image size, since it will be faster. Animations that don't require
4971 * resizing of the image can keep the smooth scaling enabled (even if the
4972 * image is already scaled, since the scaled image will be cached).
4974 * @see elm_image_smooth_get()
4978 EAPI void elm_image_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
4980 * Get the smooth effect for an image.
4982 * @param obj The image object
4983 * @return @c EINA_TRUE if smooth scaling is enabled, @c EINA_FALSE otherwise.
4985 * @see elm_image_smooth_get()
4989 EAPI Eina_Bool elm_image_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4991 * Gets the current size of the image.
4993 * @param obj The image object.
4994 * @param w Pointer to store width, or NULL.
4995 * @param h Pointer to store height, or NULL.
4997 * This is the real size of the image, not the size of the object.
4999 * On error, neither w or h will be written.
5003 EAPI void elm_image_object_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
5005 * Disable scaling of this object.
5007 * @param obj The image object.
5008 * @param no_scale @c EINA_TRUE if the object is not scalable, @c EINA_FALSE
5009 * otherwise. Default is @c EINA_FALSE.
5011 * This function disables scaling of the elm_image widget through the
5012 * function elm_object_scale_set(). However, this does not affect the widget
5013 * size/resize in any way. For that effect, take a look at
5014 * elm_image_scale_set().
5016 * @see elm_image_no_scale_get()
5017 * @see elm_image_scale_set()
5018 * @see elm_object_scale_set()
5022 EAPI void elm_image_no_scale_set(Evas_Object *obj, Eina_Bool no_scale) EINA_ARG_NONNULL(1);
5024 * Get whether scaling is disabled on the object.
5026 * @param obj The image object
5027 * @return @c EINA_TRUE if scaling is disabled, @c EINA_FALSE otherwise
5029 * @see elm_image_no_scale_set()
5033 EAPI Eina_Bool elm_image_no_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5035 * Set if the object is (up/down) resizable.
5037 * @param obj The image object
5038 * @param scale_up A bool to set if the object is resizable up. Default is
5040 * @param scale_down A bool to set if the object is resizable down. Default
5043 * This function limits the image resize ability. If @p scale_up is set to
5044 * @c EINA_FALSE, the object can't have its height or width resized to a value
5045 * higher than the original image size. Same is valid for @p scale_down.
5047 * @see elm_image_scale_get()
5051 EAPI void elm_image_scale_set(Evas_Object *obj, Eina_Bool scale_up, Eina_Bool scale_down) EINA_ARG_NONNULL(1);
5053 * Get if the object is (up/down) resizable.
5055 * @param obj The image object
5056 * @param scale_up A bool to set if the object is resizable up
5057 * @param scale_down A bool to set if the object is resizable down
5059 * @see elm_image_scale_set()
5063 EAPI void elm_image_scale_get(const Evas_Object *obj, Eina_Bool *scale_up, Eina_Bool *scale_down) EINA_ARG_NONNULL(1);
5065 * Set if the image fill the entire object area when keeping the aspect ratio.
5067 * @param obj The image object
5068 * @param fill_outside @c EINA_TRUE if the object is filled outside,
5069 * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
5071 * When the image should keep its aspect ratio even if resized to another
5072 * aspect ratio, there are two possibilities to resize it: keep the entire
5073 * image inside the limits of height and width of the object (@p fill_outside
5074 * is @c EINA_FALSE) or let the extra width or height go outside of the object,
5075 * and the image will fill the entire object (@p fill_outside is @c EINA_TRUE).
5077 * @note This option will have no effect if
5078 * elm_image_aspect_ratio_retained_set() is set to @c EINA_FALSE.
5080 * @see elm_image_fill_outside_get()
5081 * @see elm_image_aspect_ratio_retained_set()
5085 EAPI void elm_image_fill_outside_set(Evas_Object *obj, Eina_Bool fill_outside) EINA_ARG_NONNULL(1);
5087 * Get if the object is filled outside
5089 * @param obj The image object
5090 * @return @c EINA_TRUE if the object is filled outside, @c EINA_FALSE otherwise.
5092 * @see elm_image_fill_outside_set()
5096 EAPI Eina_Bool elm_image_fill_outside_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5098 * Set the prescale size for the image
5100 * @param obj The image object
5101 * @param size The prescale size. This value is used for both width and
5104 * This function sets a new size for pixmap representation of the given
5105 * image. It allows the image to be loaded already in the specified size,
5106 * reducing the memory usage and load time when loading a big image with load
5107 * size set to a smaller size.
5109 * It's equivalent to the elm_bg_load_size_set() function for bg.
5111 * @note this is just a hint, the real size of the pixmap may differ
5112 * depending on the type of image being loaded, being bigger than requested.
5114 * @see elm_image_prescale_get()
5115 * @see elm_bg_load_size_set()
5119 EAPI void elm_image_prescale_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
5121 * Get the prescale size for the image
5123 * @param obj The image object
5124 * @return The prescale size
5126 * @see elm_image_prescale_set()
5130 EAPI int elm_image_prescale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5132 * Set the image orientation.
5134 * @param obj The image object
5135 * @param orient The image orientation
5136 * (one of #ELM_IMAGE_ORIENT_NONE, #ELM_IMAGE_ROTATE_90_CW,
5137 * #ELM_IMAGE_ROTATE_180_CW, #ELM_IMAGE_ROTATE_90_CCW,
5138 * #ELM_IMAGE_FLIP_HORIZONTAL, #ELM_IMAGE_FLIP_VERTICAL,
5139 * #ELM_IMAGE_FLIP_TRANSPOSE, #ELM_IMAGE_FLIP_TRANSVERSE).
5140 * Default is #ELM_IMAGE_ORIENT_NONE.
5142 * This function allows to rotate or flip the given image.
5144 * @see elm_image_orient_get()
5145 * @see @ref Elm_Image_Orient
5149 EAPI void elm_image_orient_set(Evas_Object *obj, Elm_Image_Orient orient) EINA_ARG_NONNULL(1);
5151 * Get the image orientation.
5153 * @param obj The image object
5154 * @return The image orientation
5155 * (one of #ELM_IMAGE_ORIENT_NONE, #ELM_IMAGE_ROTATE_90_CW,
5156 * #ELM_IMAGE_ROTATE_180_CW, #ELM_IMAGE_ROTATE_90_CCW,
5157 * #ELM_IMAGE_FLIP_HORIZONTAL, #ELM_IMAGE_FLIP_VERTICAL,
5158 * #ELM_IMAGE_FLIP_TRANSPOSE, #ELM_IMAGE_FLIP_TRANSVERSE)
5160 * @see elm_image_orient_set()
5161 * @see @ref Elm_Image_Orient
5165 EAPI Elm_Image_Orient elm_image_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5167 * Make the image 'editable'.
5169 * @param obj Image object.
5170 * @param set Turn on or off editability. Default is @c EINA_FALSE.
5172 * This means the image is a valid drag target for drag and drop, and can be
5173 * cut or pasted too.
5177 EAPI void elm_image_editable_set(Evas_Object *obj, Eina_Bool set) EINA_ARG_NONNULL(1);
5179 * Make the image 'editable'.
5181 * @param obj Image object.
5182 * @return Editability.
5184 * This means the image is a valid drag target for drag and drop, and can be
5185 * cut or pasted too.
5189 EAPI Eina_Bool elm_image_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5191 * Get the basic Evas_Image object from this object (widget).
5193 * @param obj The image object to get the inlined image from
5194 * @return The inlined image object, or NULL if none exists
5196 * This function allows one to get the underlying @c Evas_Object of type
5197 * Image from this elementary widget. It can be useful to do things like get
5198 * the pixel data, save the image to a file, etc.
5200 * @note Be careful to not manipulate it, as it is under control of
5205 EAPI Evas_Object *elm_image_object_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5207 * Set whether the original aspect ratio of the image should be kept on resize.
5209 * @param obj The image object.
5210 * @param retained @c EINA_TRUE if the image should retain the aspect,
5211 * @c EINA_FALSE otherwise.
5213 * The original aspect ratio (width / height) of the image is usually
5214 * distorted to match the object's size. Enabling this option will retain
5215 * this original aspect, and the way that the image is fit into the object's
5216 * area depends on the option set by elm_image_fill_outside_set().
5218 * @see elm_image_aspect_ratio_retained_get()
5219 * @see elm_image_fill_outside_set()
5223 EAPI void elm_image_aspect_ratio_retained_set(Evas_Object *obj, Eina_Bool retained) EINA_ARG_NONNULL(1);
5225 * Get if the object retains the original aspect ratio.
5227 * @param obj The image object.
5228 * @return @c EINA_TRUE if the object keeps the original aspect, @c EINA_FALSE
5233 EAPI Eina_Bool elm_image_aspect_ratio_retained_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5235 /* smart callbacks called:
5236 * "clicked" - the user clicked the image
5244 typedef void (*Elm_GLView_Func_Cb)(Evas_Object *obj);
5246 typedef enum _Elm_GLView_Mode
5248 ELM_GLVIEW_ALPHA = 1,
5249 ELM_GLVIEW_DEPTH = 2,
5250 ELM_GLVIEW_STENCIL = 4
5254 * Defines a policy for the glview resizing.
5256 * @note Default is ELM_GLVIEW_RESIZE_POLICY_RECREATE
5258 typedef enum _Elm_GLView_Resize_Policy
5260 ELM_GLVIEW_RESIZE_POLICY_RECREATE = 1, /**< Resize the internal surface along with the image */
5261 ELM_GLVIEW_RESIZE_POLICY_SCALE = 2 /**< Only reize the internal image and not the surface */
5262 } Elm_GLView_Resize_Policy;
5264 typedef enum _Elm_GLView_Render_Policy
5266 ELM_GLVIEW_RENDER_POLICY_ON_DEMAND = 1, /**< Render only when there is a need for redrawing */
5267 ELM_GLVIEW_RENDER_POLICY_ALWAYS = 2 /**< Render always even when it is not visible */
5268 } Elm_GLView_Render_Policy;
5273 * A simple GLView widget that allows GL rendering.
5275 * Signals that you can add callbacks for are:
5281 * Add a new glview to the parent
5283 * @param parent The parent object
5284 * @return The new object or NULL if it cannot be created
5288 EAPI Evas_Object *elm_glview_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5291 * Sets the size of the glview
5293 * @param obj The glview object
5294 * @param width width of the glview object
5295 * @param height height of the glview object
5299 EAPI void elm_glview_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
5302 * Gets the size of the glview.
5304 * @param obj The glview object
5305 * @param width width of the glview object
5306 * @param height height of the glview object
5308 * Note that this function returns the actual image size of the
5309 * glview. This means that when the scale policy is set to
5310 * ELM_GLVIEW_RESIZE_POLICY_SCALE, it'll return the non-scaled
5315 EAPI void elm_glview_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
5318 * Gets the gl api struct for gl rendering
5320 * @param obj The glview object
5321 * @return The api object or NULL if it cannot be created
5325 EAPI Evas_GL_API *elm_glview_gl_api_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5328 * Set the mode of the GLView. Supports Three simple modes.
5330 * @param obj The glview object
5331 * @param mode The mode Options OR'ed enabling Alpha, Depth, Stencil.
5332 * @return True if set properly.
5336 EAPI Eina_Bool elm_glview_mode_set(Evas_Object *obj, Elm_GLView_Mode mode) EINA_ARG_NONNULL(1);
5339 * Set the resize policy for the glview object.
5341 * @param obj The glview object.
5342 * @param policy The scaling policy.
5344 * By default, the resize policy is set to
5345 * ELM_GLVIEW_RESIZE_POLICY_RECREATE. When resize is called it
5346 * destroys the previous surface and recreates the newly specified
5347 * size. If the policy is set to ELM_GLVIEW_RESIZE_POLICY_SCALE,
5348 * however, glview only scales the image object and not the underlying
5353 EAPI Eina_Bool elm_glview_resize_policy_set(Evas_Object *obj, Elm_GLView_Resize_Policy policy) EINA_ARG_NONNULL(1);
5356 * Set the render policy for the glview object.
5358 * @param obj The glview object.
5359 * @param policy The render policy.
5361 * By default, the render policy is set to
5362 * ELM_GLVIEW_RENDER_POLICY_ON_DEMAND. This policy is set such
5363 * that during the render loop, glview is only redrawn if it needs
5364 * to be redrawn. (i.e. When it is visible) If the policy is set to
5365 * ELM_GLVIEWW_RENDER_POLICY_ALWAYS, it redraws regardless of
5366 * whether it is visible/need redrawing or not.
5370 EAPI Eina_Bool elm_glview_render_policy_set(Evas_Object *obj, Elm_GLView_Render_Policy policy) EINA_ARG_NONNULL(1);
5373 * Set the init function that runs once in the main loop.
5375 * @param obj The glview object.
5376 * @param func The init function to be registered.
5378 * The registered init function gets called once during the render loop.
5382 EAPI void elm_glview_init_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
5385 * Set the render function that runs in the main loop.
5387 * @param obj The glview object.
5388 * @param func The delete function to be registered.
5390 * The registered del function gets called when GLView object is deleted.
5394 EAPI void elm_glview_del_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
5397 * Set the resize function that gets called when resize happens.
5399 * @param obj The glview object.
5400 * @param func The resize function to be registered.
5404 EAPI void elm_glview_resize_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
5407 * Set the render function that runs in the main loop.
5409 * @param obj The glview object.
5410 * @param func The render function to be registered.
5414 EAPI void elm_glview_render_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
5417 * Notifies that there has been changes in the GLView.
5419 * @param obj The glview object.
5423 EAPI void elm_glview_changed_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
5433 * @image html img/widget/box/preview-00.png
5434 * @image latex img/widget/box/preview-00.eps width=\textwidth
5436 * @image html img/box.png
5437 * @image latex img/box.eps width=\textwidth
5439 * A box arranges objects in a linear fashion, governed by a layout function
5440 * that defines the details of this arrangement.
5442 * By default, the box will use an internal function to set the layout to
5443 * a single row, either vertical or horizontal. This layout is affected
5444 * by a number of parameters, such as the homogeneous flag set by
5445 * elm_box_homogeneous_set(), the values given by elm_box_padding_set() and
5446 * elm_box_align_set() and the hints set to each object in the box.
5448 * For this default layout, it's possible to change the orientation with
5449 * elm_box_horizontal_set(). The box will start in the vertical orientation,
5450 * placing its elements ordered from top to bottom. When horizontal is set,
5451 * the order will go from left to right. If the box is set to be
5452 * homogeneous, every object in it will be assigned the same space, that
5453 * of the largest object. Padding can be used to set some spacing between
5454 * the cell given to each object. The alignment of the box, set with
5455 * elm_box_align_set(), determines how the bounding box of all the elements
5456 * will be placed within the space given to the box widget itself.
5458 * The size hints of each object also affect how they are placed and sized
5459 * within the box. evas_object_size_hint_min_set() will give the minimum
5460 * size the object can have, and the box will use it as the basis for all
5461 * latter calculations. Elementary widgets set their own minimum size as
5462 * needed, so there's rarely any need to use it manually.
5464 * evas_object_size_hint_weight_set(), when not in homogeneous mode, is
5465 * used to tell whether the object will be allocated the minimum size it
5466 * needs or if the space given to it should be expanded. It's important
5467 * to realize that expanding the size given to the object is not the same
5468 * thing as resizing the object. It could very well end being a small
5469 * widget floating in a much larger empty space. If not set, the weight
5470 * for objects will normally be 0.0 for both axis, meaning the widget will
5471 * not be expanded. To take as much space possible, set the weight to
5472 * EVAS_HINT_EXPAND (defined to 1.0) for the desired axis to expand.
5474 * Besides how much space each object is allocated, it's possible to control
5475 * how the widget will be placed within that space using
5476 * evas_object_size_hint_align_set(). By default, this value will be 0.5
5477 * for both axis, meaning the object will be centered, but any value from
5478 * 0.0 (left or top, for the @c x and @c y axis, respectively) to 1.0
5479 * (right or bottom) can be used. The special value EVAS_HINT_FILL, which
5480 * is -1.0, means the object will be resized to fill the entire space it
5483 * In addition, customized functions to define the layout can be set, which
5484 * allow the application developer to organize the objects within the box
5485 * in any number of ways.
5487 * The special elm_box_layout_transition() function can be used
5488 * to switch from one layout to another, animating the motion of the
5489 * children of the box.
5491 * @note Objects should not be added to box objects using _add() calls.
5493 * Some examples on how to use boxes follow:
5494 * @li @ref box_example_01
5495 * @li @ref box_example_02
5500 * @typedef Elm_Box_Transition
5502 * Opaque handler containing the parameters to perform an animated
5503 * transition of the layout the box uses.
5505 * @see elm_box_transition_new()
5506 * @see elm_box_layout_set()
5507 * @see elm_box_layout_transition()
5509 typedef struct _Elm_Box_Transition Elm_Box_Transition;
5512 * Add a new box to the parent
5514 * By default, the box will be in vertical mode and non-homogeneous.
5516 * @param parent The parent object
5517 * @return The new object or NULL if it cannot be created
5519 EAPI Evas_Object *elm_box_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5521 * Set the horizontal orientation
5523 * By default, box object arranges their contents vertically from top to
5525 * By calling this function with @p horizontal as EINA_TRUE, the box will
5526 * become horizontal, arranging contents from left to right.
5528 * @note This flag is ignored if a custom layout function is set.
5530 * @param obj The box object
5531 * @param horizontal The horizontal flag (EINA_TRUE = horizontal,
5532 * EINA_FALSE = vertical)
5534 EAPI void elm_box_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
5536 * Get the horizontal orientation
5538 * @param obj The box object
5539 * @return EINA_TRUE if the box is set to horizontal mode, EINA_FALSE otherwise
5541 EAPI Eina_Bool elm_box_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5543 * Set the box to arrange its children homogeneously
5545 * If enabled, homogeneous layout makes all items the same size, according
5546 * to the size of the largest of its children.
5548 * @note This flag is ignored if a custom layout function is set.
5550 * @param obj The box object
5551 * @param homogeneous The homogeneous flag
5553 EAPI void elm_box_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
5555 * Get whether the box is using homogeneous mode or not
5557 * @param obj The box object
5558 * @return EINA_TRUE if it's homogeneous, EINA_FALSE otherwise
5560 EAPI Eina_Bool elm_box_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5561 EINA_DEPRECATED EAPI void elm_box_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
5562 EINA_DEPRECATED EAPI Eina_Bool elm_box_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5564 * Add an object to the beginning of the pack list
5566 * Pack @p subobj into the box @p obj, placing it first in the list of
5567 * children objects. The actual position the object will get on screen
5568 * depends on the layout used. If no custom layout is set, it will be at
5569 * the top or left, depending if the box is vertical or horizontal,
5572 * @param obj The box object
5573 * @param subobj The object to add to the box
5575 * @see elm_box_pack_end()
5576 * @see elm_box_pack_before()
5577 * @see elm_box_pack_after()
5578 * @see elm_box_unpack()
5579 * @see elm_box_unpack_all()
5580 * @see elm_box_clear()
5582 EAPI void elm_box_pack_start(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
5584 * Add an object at the end of the pack list
5586 * Pack @p subobj into the box @p obj, placing it last in the list of
5587 * children objects. The actual position the object will get on screen
5588 * depends on the layout used. If no custom layout is set, it will be at
5589 * the bottom or right, depending if the box is vertical or horizontal,
5592 * @param obj The box object
5593 * @param subobj The object to add to the box
5595 * @see elm_box_pack_start()
5596 * @see elm_box_pack_before()
5597 * @see elm_box_pack_after()
5598 * @see elm_box_unpack()
5599 * @see elm_box_unpack_all()
5600 * @see elm_box_clear()
5602 EAPI void elm_box_pack_end(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
5604 * Adds an object to the box before the indicated object
5606 * This will add the @p subobj to the box indicated before the object
5607 * indicated with @p before. If @p before is not already in the box, results
5608 * are undefined. Before means either to the left of the indicated object or
5609 * above it depending on orientation.
5611 * @param obj The box object
5612 * @param subobj The object to add to the box
5613 * @param before The object before which to add it
5615 * @see elm_box_pack_start()
5616 * @see elm_box_pack_end()
5617 * @see elm_box_pack_after()
5618 * @see elm_box_unpack()
5619 * @see elm_box_unpack_all()
5620 * @see elm_box_clear()
5622 EAPI void elm_box_pack_before(Evas_Object *obj, Evas_Object *subobj, Evas_Object *before) EINA_ARG_NONNULL(1);
5624 * Adds an object to the box after the indicated object
5626 * This will add the @p subobj to the box indicated after the object
5627 * indicated with @p after. If @p after is not already in the box, results
5628 * are undefined. After means either to the right of the indicated object or
5629 * below it depending on orientation.
5631 * @param obj The box object
5632 * @param subobj The object to add to the box
5633 * @param after The object after which to add it
5635 * @see elm_box_pack_start()
5636 * @see elm_box_pack_end()
5637 * @see elm_box_pack_before()
5638 * @see elm_box_unpack()
5639 * @see elm_box_unpack_all()
5640 * @see elm_box_clear()
5642 EAPI void elm_box_pack_after(Evas_Object *obj, Evas_Object *subobj, Evas_Object *after) EINA_ARG_NONNULL(1);
5644 * Clear the box of all children
5646 * Remove all the elements contained by the box, deleting the respective
5649 * @param obj The box object
5651 * @see elm_box_unpack()
5652 * @see elm_box_unpack_all()
5654 EAPI void elm_box_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
5658 * Remove the object given by @p subobj from the box @p obj without
5661 * @param obj The box object
5663 * @see elm_box_unpack_all()
5664 * @see elm_box_clear()
5666 EAPI void elm_box_unpack(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
5668 * Remove all items from the box, without deleting them
5670 * Clear the box from all children, but don't delete the respective objects.
5671 * If no other references of the box children exist, the objects will never
5672 * be deleted, and thus the application will leak the memory. Make sure
5673 * when using this function that you hold a reference to all the objects
5674 * in the box @p obj.
5676 * @param obj The box object
5678 * @see elm_box_clear()
5679 * @see elm_box_unpack()
5681 EAPI void elm_box_unpack_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
5683 * Retrieve a list of the objects packed into the box
5685 * Returns a new @c Eina_List with a pointer to @c Evas_Object in its nodes.
5686 * The order of the list corresponds to the packing order the box uses.
5688 * You must free this list with eina_list_free() once you are done with it.
5690 * @param obj The box object
5692 EAPI const Eina_List *elm_box_children_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5694 * Set the space (padding) between the box's elements.
5696 * Extra space in pixels that will be added between a box child and its
5697 * neighbors after its containing cell has been calculated. This padding
5698 * is set for all elements in the box, besides any possible padding that
5699 * individual elements may have through their size hints.
5701 * @param obj The box object
5702 * @param horizontal The horizontal space between elements
5703 * @param vertical The vertical space between elements
5705 EAPI void elm_box_padding_set(Evas_Object *obj, Evas_Coord horizontal, Evas_Coord vertical) EINA_ARG_NONNULL(1);
5707 * Get the space (padding) between the box's elements.
5709 * @param obj The box object
5710 * @param horizontal The horizontal space between elements
5711 * @param vertical The vertical space between elements
5713 * @see elm_box_padding_set()
5715 EAPI void elm_box_padding_get(const Evas_Object *obj, Evas_Coord *horizontal, Evas_Coord *vertical) EINA_ARG_NONNULL(1);
5717 * Set the alignment of the whole bouding box of contents.
5719 * Sets how the bounding box containing all the elements of the box, after
5720 * their sizes and position has been calculated, will be aligned within
5721 * the space given for the whole box widget.
5723 * @param obj The box object
5724 * @param horizontal The horizontal alignment of elements
5725 * @param vertical The vertical alignment of elements
5727 EAPI void elm_box_align_set(Evas_Object *obj, double horizontal, double vertical) EINA_ARG_NONNULL(1);
5729 * Get the alignment of the whole bouding box of contents.
5731 * @param obj The box object
5732 * @param horizontal The horizontal alignment of elements
5733 * @param vertical The vertical alignment of elements
5735 * @see elm_box_align_set()
5737 EAPI void elm_box_align_get(const Evas_Object *obj, double *horizontal, double *vertical) EINA_ARG_NONNULL(1);
5740 * Set the layout defining function to be used by the box
5742 * Whenever anything changes that requires the box in @p obj to recalculate
5743 * the size and position of its elements, the function @p cb will be called
5744 * to determine what the layout of the children will be.
5746 * Once a custom function is set, everything about the children layout
5747 * is defined by it. The flags set by elm_box_horizontal_set() and
5748 * elm_box_homogeneous_set() no longer have any meaning, and the values
5749 * given by elm_box_padding_set() and elm_box_align_set() are up to this
5750 * layout function to decide if they are used and how. These last two
5751 * will be found in the @c priv parameter, of type @c Evas_Object_Box_Data,
5752 * passed to @p cb. The @c Evas_Object the function receives is not the
5753 * Elementary widget, but the internal Evas Box it uses, so none of the
5754 * functions described here can be used on it.
5756 * Any of the layout functions in @c Evas can be used here, as well as the
5757 * special elm_box_layout_transition().
5759 * The final @p data argument received by @p cb is the same @p data passed
5760 * here, and the @p free_data function will be called to free it
5761 * whenever the box is destroyed or another layout function is set.
5763 * Setting @p cb to NULL will revert back to the default layout function.
5765 * @param obj The box object
5766 * @param cb The callback function used for layout
5767 * @param data Data that will be passed to layout function
5768 * @param free_data Function called to free @p data
5770 * @see elm_box_layout_transition()
5772 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);
5774 * Special layout function that animates the transition from one layout to another
5776 * Normally, when switching the layout function for a box, this will be
5777 * reflected immediately on screen on the next render, but it's also
5778 * possible to do this through an animated transition.
5780 * This is done by creating an ::Elm_Box_Transition and setting the box
5781 * layout to this function.
5785 * Elm_Box_Transition *t = elm_box_transition_new(1.0,
5786 * evas_object_box_layout_vertical, // start
5787 * NULL, // data for initial layout
5788 * NULL, // free function for initial data
5789 * evas_object_box_layout_horizontal, // end
5790 * NULL, // data for final layout
5791 * NULL, // free function for final data
5792 * anim_end, // will be called when animation ends
5793 * NULL); // data for anim_end function\
5794 * elm_box_layout_set(box, elm_box_layout_transition, t,
5795 * elm_box_transition_free);
5798 * @note This function can only be used with elm_box_layout_set(). Calling
5799 * it directly will not have the expected results.
5801 * @see elm_box_transition_new
5802 * @see elm_box_transition_free
5803 * @see elm_box_layout_set
5805 EAPI void elm_box_layout_transition(Evas_Object *obj, Evas_Object_Box_Data *priv, void *data);
5807 * Create a new ::Elm_Box_Transition to animate the switch of layouts
5809 * If you want to animate the change from one layout to another, you need
5810 * to set the layout function of the box to elm_box_layout_transition(),
5811 * passing as user data to it an instance of ::Elm_Box_Transition with the
5812 * necessary information to perform this animation. The free function to
5813 * set for the layout is elm_box_transition_free().
5815 * The parameters to create an ::Elm_Box_Transition sum up to how long
5816 * will it be, in seconds, a layout function to describe the initial point,
5817 * another for the final position of the children and one function to be
5818 * called when the whole animation ends. This last function is useful to
5819 * set the definitive layout for the box, usually the same as the end
5820 * layout for the animation, but could be used to start another transition.
5822 * @param start_layout The layout function that will be used to start the animation
5823 * @param start_layout_data The data to be passed the @p start_layout function
5824 * @param start_layout_free_data Function to free @p start_layout_data
5825 * @param end_layout The layout function that will be used to end the animation
5826 * @param end_layout_free_data The data to be passed the @p end_layout function
5827 * @param end_layout_free_data Function to free @p end_layout_data
5828 * @param transition_end_cb Callback function called when animation ends
5829 * @param transition_end_data Data to be passed to @p transition_end_cb
5830 * @return An instance of ::Elm_Box_Transition
5832 * @see elm_box_transition_new
5833 * @see elm_box_layout_transition
5835 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);
5837 * Free a Elm_Box_Transition instance created with elm_box_transition_new().
5839 * This function is mostly useful as the @c free_data parameter in
5840 * elm_box_layout_set() when elm_box_layout_transition().
5842 * @param data The Elm_Box_Transition instance to be freed.
5844 * @see elm_box_transition_new
5845 * @see elm_box_layout_transition
5847 EAPI void elm_box_transition_free(void *data);
5854 * @defgroup Button Button
5856 * @image html img/widget/button/preview-00.png
5857 * @image latex img/widget/button/preview-00.eps
5858 * @image html img/widget/button/preview-01.png
5859 * @image latex img/widget/button/preview-01.eps
5860 * @image html img/widget/button/preview-02.png
5861 * @image latex img/widget/button/preview-02.eps
5863 * This is a push-button. Press it and run some function. It can contain
5864 * a simple label and icon object and it also has an autorepeat feature.
5866 * This widgets emits the following signals:
5867 * @li "clicked": the user clicked the button (press/release).
5868 * @li "repeated": the user pressed the button without releasing it.
5869 * @li "pressed": button was pressed.
5870 * @li "unpressed": button was released after being pressed.
5871 * In all three cases, the @c event parameter of the callback will be
5874 * Also, defined in the default theme, the button has the following styles
5876 * @li default: a normal button.
5877 * @li anchor: Like default, but the button fades away when the mouse is not
5878 * over it, leaving only the text or icon.
5879 * @li hoversel_vertical: Internally used by @ref Hoversel to give a
5880 * continuous look across its options.
5881 * @li hoversel_vertical_entry: Another internal for @ref Hoversel.
5883 * Follow through a complete example @ref button_example_01 "here".
5887 * Add a new button to the parent's canvas
5889 * @param parent The parent object
5890 * @return The new object or NULL if it cannot be created
5892 EAPI Evas_Object *elm_button_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5894 * Set the label used in the button
5896 * The passed @p label can be NULL to clean any existing text in it and
5897 * leave the button as an icon only object.
5899 * @param obj The button object
5900 * @param label The text will be written on the button
5901 * @deprecated use elm_object_text_set() instead.
5903 EINA_DEPRECATED EAPI void elm_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
5905 * Get the label set for the button
5907 * The string returned is an internal pointer and should not be freed or
5908 * altered. It will also become invalid when the button is destroyed.
5909 * The string returned, if not NULL, is a stringshare, so if you need to
5910 * keep it around even after the button is destroyed, you can use
5911 * eina_stringshare_ref().
5913 * @param obj The button object
5914 * @return The text set to the label, or NULL if nothing is set
5915 * @deprecated use elm_object_text_set() instead.
5917 EINA_DEPRECATED EAPI const char *elm_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5919 * Set the icon used for the button
5921 * Setting a new icon will delete any other that was previously set, making
5922 * any reference to them invalid. If you need to maintain the previous
5923 * object alive, unset it first with elm_button_icon_unset().
5925 * @param obj The button object
5926 * @param icon The icon object for the button
5928 EAPI void elm_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
5930 * Get the icon used for the button
5932 * Return the icon object which is set for this widget. If the button is
5933 * destroyed or another icon is set, the returned object will be deleted
5934 * and any reference to it will be invalid.
5936 * @param obj The button object
5937 * @return The icon object that is being used
5939 * @see elm_button_icon_unset()
5941 EAPI Evas_Object *elm_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5943 * Remove the icon set without deleting it and return the object
5945 * This function drops the reference the button holds of the icon object
5946 * and returns this last object. It is used in case you want to remove any
5947 * icon, or set another one, without deleting the actual object. The button
5948 * will be left without an icon set.
5950 * @param obj The button object
5951 * @return The icon object that was being used
5953 EAPI Evas_Object *elm_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
5955 * Turn on/off the autorepeat event generated when the button is kept pressed
5957 * When off, no autorepeat is performed and buttons emit a normal @c clicked
5958 * signal when they are clicked.
5960 * When on, keeping a button pressed will continuously emit a @c repeated
5961 * signal until the button is released. The time it takes until it starts
5962 * emitting the signal is given by
5963 * elm_button_autorepeat_initial_timeout_set(), and the time between each
5964 * new emission by elm_button_autorepeat_gap_timeout_set().
5966 * @param obj The button object
5967 * @param on A bool to turn on/off the event
5969 EAPI void elm_button_autorepeat_set(Evas_Object *obj, Eina_Bool on) EINA_ARG_NONNULL(1);
5971 * Get whether the autorepeat feature is enabled
5973 * @param obj The button object
5974 * @return EINA_TRUE if autorepeat is on, EINA_FALSE otherwise
5976 * @see elm_button_autorepeat_set()
5978 EAPI Eina_Bool elm_button_autorepeat_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5980 * Set the initial timeout before the autorepeat event is generated
5982 * Sets the timeout, in seconds, since the button is pressed until the
5983 * first @c repeated signal is emitted. If @p t is 0.0 or less, there
5984 * won't be any delay and the even will be fired the moment the button is
5987 * @param obj The button object
5988 * @param t Timeout in seconds
5990 * @see elm_button_autorepeat_set()
5991 * @see elm_button_autorepeat_gap_timeout_set()
5993 EAPI void elm_button_autorepeat_initial_timeout_set(Evas_Object *obj, double t) EINA_ARG_NONNULL(1);
5995 * Get the initial timeout before the autorepeat event is generated
5997 * @param obj The button object
5998 * @return Timeout in seconds
6000 * @see elm_button_autorepeat_initial_timeout_set()
6002 EAPI double elm_button_autorepeat_initial_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6004 * Set the interval between each generated autorepeat event
6006 * After the first @c repeated event is fired, all subsequent ones will
6007 * follow after a delay of @p t seconds for each.
6009 * @param obj The button object
6010 * @param t Interval in seconds
6012 * @see elm_button_autorepeat_initial_timeout_set()
6014 EAPI void elm_button_autorepeat_gap_timeout_set(Evas_Object *obj, double t) EINA_ARG_NONNULL(1);
6016 * Get the interval between each generated autorepeat event
6018 * @param obj The button object
6019 * @return Interval in seconds
6021 EAPI double elm_button_autorepeat_gap_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6027 * @defgroup File_Selector_Button File Selector Button
6029 * @image html img/widget/fileselector_button/preview-00.png
6030 * @image latex img/widget/fileselector_button/preview-00.eps
6031 * @image html img/widget/fileselector_button/preview-01.png
6032 * @image latex img/widget/fileselector_button/preview-01.eps
6033 * @image html img/widget/fileselector_button/preview-02.png
6034 * @image latex img/widget/fileselector_button/preview-02.eps
6036 * This is a button that, when clicked, creates an Elementary
6037 * window (or inner window) <b> with a @ref Fileselector "file
6038 * selector widget" within</b>. When a file is chosen, the (inner)
6039 * window is closed and the button emits a signal having the
6040 * selected file as it's @c event_info.
6042 * This widget encapsulates operations on its internal file
6043 * selector on its own API. There is less control over its file
6044 * selector than that one would have instatiating one directly.
6046 * The following styles are available for this button:
6049 * @li @c "hoversel_vertical"
6050 * @li @c "hoversel_vertical_entry"
6052 * Smart callbacks one can register to:
6053 * - @c "file,chosen" - the user has selected a path, whose string
6054 * pointer comes as the @c event_info data (a stringshared
6057 * Here is an example on its usage:
6058 * @li @ref fileselector_button_example
6060 * @see @ref File_Selector_Entry for a similar widget.
6065 * Add a new file selector button widget to the given parent
6066 * Elementary (container) object
6068 * @param parent The parent object
6069 * @return a new file selector button widget handle or @c NULL, on
6072 EAPI Evas_Object *elm_fileselector_button_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6075 * Set the label for a given file selector button widget
6077 * @param obj The file selector button widget
6078 * @param label The text label to be displayed on @p obj
6080 * @deprecated use elm_object_text_set() instead.
6082 EINA_DEPRECATED EAPI void elm_fileselector_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
6085 * Get the label set for a given file selector button widget
6087 * @param obj The file selector button widget
6088 * @return The button label
6090 * @deprecated use elm_object_text_set() instead.
6092 EINA_DEPRECATED EAPI const char *elm_fileselector_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6095 * Set the icon on a given file selector button widget
6097 * @param obj The file selector button widget
6098 * @param icon The icon object for the button
6100 * Once the icon object is set, a previously set one will be
6101 * deleted. If you want to keep the latter, use the
6102 * elm_fileselector_button_icon_unset() function.
6104 * @see elm_fileselector_button_icon_get()
6106 EAPI void elm_fileselector_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
6109 * Get the icon set for a given file selector button widget
6111 * @param obj The file selector button widget
6112 * @return The icon object currently set on @p obj or @c NULL, if
6115 * @see elm_fileselector_button_icon_set()
6117 EAPI Evas_Object *elm_fileselector_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6120 * Unset the icon used in a given file selector button widget
6122 * @param obj The file selector button widget
6123 * @return The icon object that was being used on @p obj or @c
6126 * Unparent and return the icon object which was set for this
6129 * @see elm_fileselector_button_icon_set()
6131 EAPI Evas_Object *elm_fileselector_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6134 * Set the title for a given file selector button widget's window
6136 * @param obj The file selector button widget
6137 * @param title The title string
6139 * This will change the window's title, when the file selector pops
6140 * out after a click on the button. Those windows have the default
6141 * (unlocalized) value of @c "Select a file" as titles.
6143 * @note It will only take any effect if the file selector
6144 * button widget is @b not under "inwin mode".
6146 * @see elm_fileselector_button_window_title_get()
6148 EAPI void elm_fileselector_button_window_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
6151 * Get the title set for a given file selector button widget's
6154 * @param obj The file selector button widget
6155 * @return Title of the file selector button's window
6157 * @see elm_fileselector_button_window_title_get() for more details
6159 EAPI const char *elm_fileselector_button_window_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6162 * Set the size of a given file selector button widget's window,
6163 * holding the file selector itself.
6165 * @param obj The file selector button widget
6166 * @param width The window's width
6167 * @param height The window's height
6169 * @note it will only take any effect if the file selector button
6170 * widget is @b not under "inwin mode". The default size for the
6171 * window (when applicable) is 400x400 pixels.
6173 * @see elm_fileselector_button_window_size_get()
6175 EAPI void elm_fileselector_button_window_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
6178 * Get the size of a given file selector button widget's window,
6179 * holding the file selector itself.
6181 * @param obj The file selector button widget
6182 * @param width Pointer into which to store the width value
6183 * @param height Pointer into which to store the height value
6185 * @note Use @c NULL pointers on the size values you're not
6186 * interested in: they'll be ignored by the function.
6188 * @see elm_fileselector_button_window_size_set(), for more details
6190 EAPI void elm_fileselector_button_window_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
6193 * Set the initial file system path for a given file selector
6196 * @param obj The file selector button widget
6197 * @param path The path string
6199 * It must be a <b>directory</b> path, which will have the contents
6200 * displayed initially in the file selector's view, when invoked
6201 * from @p obj. The default initial path is the @c "HOME"
6202 * environment variable's value.
6204 * @see elm_fileselector_button_path_get()
6206 EAPI void elm_fileselector_button_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
6209 * Get the initial file system path set for a given file selector
6212 * @param obj The file selector button widget
6213 * @return path The path string
6215 * @see elm_fileselector_button_path_set() for more details
6217 EAPI const char *elm_fileselector_button_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6220 * Enable/disable a tree view in the given file selector button
6221 * widget's internal file selector
6223 * @param obj The file selector button widget
6224 * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
6227 * This has the same effect as elm_fileselector_expandable_set(),
6228 * but now applied to a file selector button's internal file
6231 * @note There's no way to put a file selector button's internal
6232 * file selector in "grid mode", as one may do with "pure" file
6235 * @see elm_fileselector_expandable_get()
6237 EAPI void elm_fileselector_button_expandable_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6240 * Get whether tree view is enabled for the given file selector
6241 * button widget's internal file selector
6243 * @param obj The file selector button widget
6244 * @return @c EINA_TRUE if @p obj widget's internal file selector
6245 * is in tree view, @c EINA_FALSE otherwise (and or errors)
6247 * @see elm_fileselector_expandable_set() for more details
6249 EAPI Eina_Bool elm_fileselector_button_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6252 * Set whether a given file selector button widget's internal file
6253 * selector is to display folders only or the directory contents,
6256 * @param obj The file selector button widget
6257 * @param only @c EINA_TRUE to make @p obj widget's internal file
6258 * selector only display directories, @c EINA_FALSE to make files
6259 * to be displayed in it too
6261 * This has the same effect as elm_fileselector_folder_only_set(),
6262 * but now applied to a file selector button's internal file
6265 * @see elm_fileselector_folder_only_get()
6267 EAPI void elm_fileselector_button_folder_only_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6270 * Get whether a given file selector button widget's internal file
6271 * selector is displaying folders only or the directory contents,
6274 * @param obj The file selector button widget
6275 * @return @c EINA_TRUE if @p obj widget's internal file
6276 * selector is only displaying directories, @c EINA_FALSE if files
6277 * are being displayed in it too (and on errors)
6279 * @see elm_fileselector_button_folder_only_set() for more details
6281 EAPI Eina_Bool elm_fileselector_button_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6284 * Enable/disable the file name entry box where the user can type
6285 * in a name for a file, in a given file selector button widget's
6286 * internal file selector.
6288 * @param obj The file selector button widget
6289 * @param is_save @c EINA_TRUE to make @p obj widget's internal
6290 * file selector a "saving dialog", @c EINA_FALSE otherwise
6292 * This has the same effect as elm_fileselector_is_save_set(),
6293 * but now applied to a file selector button's internal file
6296 * @see elm_fileselector_is_save_get()
6298 EAPI void elm_fileselector_button_is_save_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6301 * Get whether the given file selector button widget's internal
6302 * file selector is in "saving dialog" mode
6304 * @param obj The file selector button widget
6305 * @return @c EINA_TRUE, if @p obj widget's internal file selector
6306 * is in "saving dialog" mode, @c EINA_FALSE otherwise (and on
6309 * @see elm_fileselector_button_is_save_set() for more details
6311 EAPI Eina_Bool elm_fileselector_button_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6314 * Set whether a given file selector button widget's internal file
6315 * selector will raise an Elementary "inner window", instead of a
6316 * dedicated Elementary window. By default, it won't.
6318 * @param obj The file selector button widget
6319 * @param value @c EINA_TRUE to make it use an inner window, @c
6320 * EINA_TRUE to make it use a dedicated window
6322 * @see elm_win_inwin_add() for more information on inner windows
6323 * @see elm_fileselector_button_inwin_mode_get()
6325 EAPI void elm_fileselector_button_inwin_mode_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6328 * Get whether a given file selector button widget's internal file
6329 * selector will raise an Elementary "inner window", instead of a
6330 * dedicated Elementary window.
6332 * @param obj The file selector button widget
6333 * @return @c EINA_TRUE if will use an inner window, @c EINA_TRUE
6334 * if it will use a dedicated window
6336 * @see elm_fileselector_button_inwin_mode_set() for more details
6338 EAPI Eina_Bool elm_fileselector_button_inwin_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6345 * @defgroup File_Selector_Entry File Selector Entry
6347 * @image html img/widget/fileselector_entry/preview-00.png
6348 * @image latex img/widget/fileselector_entry/preview-00.eps
6350 * This is an entry made to be filled with or display a <b>file
6351 * system path string</b>. Besides the entry itself, the widget has
6352 * a @ref File_Selector_Button "file selector button" on its side,
6353 * which will raise an internal @ref Fileselector "file selector widget",
6354 * when clicked, for path selection aided by file system
6357 * This file selector may appear in an Elementary window or in an
6358 * inner window. When a file is chosen from it, the (inner) window
6359 * is closed and the selected file's path string is exposed both as
6360 * an smart event and as the new text on the entry.
6362 * This widget encapsulates operations on its internal file
6363 * selector on its own API. There is less control over its file
6364 * selector than that one would have instatiating one directly.
6366 * Smart callbacks one can register to:
6367 * - @c "changed" - The text within the entry was changed
6368 * - @c "activated" - The entry has had editing finished and
6369 * changes are to be "committed"
6370 * - @c "press" - The entry has been clicked
6371 * - @c "longpressed" - The entry has been clicked (and held) for a
6373 * - @c "clicked" - The entry has been clicked
6374 * - @c "clicked,double" - The entry has been double clicked
6375 * - @c "focused" - The entry has received focus
6376 * - @c "unfocused" - The entry has lost focus
6377 * - @c "selection,paste" - A paste action has occurred on the
6379 * - @c "selection,copy" - A copy action has occurred on the entry
6380 * - @c "selection,cut" - A cut action has occurred on the entry
6381 * - @c "unpressed" - The file selector entry's button was released
6382 * after being pressed.
6383 * - @c "file,chosen" - The user has selected a path via the file
6384 * selector entry's internal file selector, whose string pointer
6385 * comes as the @c event_info data (a stringshared string)
6387 * Here is an example on its usage:
6388 * @li @ref fileselector_entry_example
6390 * @see @ref File_Selector_Button for a similar widget.
6395 * Add a new file selector entry widget to the given parent
6396 * Elementary (container) object
6398 * @param parent The parent object
6399 * @return a new file selector entry widget handle or @c NULL, on
6402 EAPI Evas_Object *elm_fileselector_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6405 * Set the label for a given file selector entry widget's button
6407 * @param obj The file selector entry widget
6408 * @param label The text label to be displayed on @p obj widget's
6411 * @deprecated use elm_object_text_set() instead.
6413 EINA_DEPRECATED EAPI void elm_fileselector_entry_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
6416 * Get the label set for a given file selector entry widget's button
6418 * @param obj The file selector entry widget
6419 * @return The widget button's label
6421 * @deprecated use elm_object_text_set() instead.
6423 EINA_DEPRECATED EAPI const char *elm_fileselector_entry_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6426 * Set the icon on a given file selector entry widget's button
6428 * @param obj The file selector entry widget
6429 * @param icon The icon object for the entry's button
6431 * Once the icon object is set, a previously set one will be
6432 * deleted. If you want to keep the latter, use the
6433 * elm_fileselector_entry_button_icon_unset() function.
6435 * @see elm_fileselector_entry_button_icon_get()
6437 EAPI void elm_fileselector_entry_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
6440 * Get the icon set for a given file selector entry widget's button
6442 * @param obj The file selector entry widget
6443 * @return The icon object currently set on @p obj widget's button
6444 * or @c NULL, if none is
6446 * @see elm_fileselector_entry_button_icon_set()
6448 EAPI Evas_Object *elm_fileselector_entry_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6451 * Unset the icon used in a given file selector entry widget's
6454 * @param obj The file selector entry widget
6455 * @return The icon object that was being used on @p obj widget's
6456 * button or @c NULL, on errors
6458 * Unparent and return the icon object which was set for this
6461 * @see elm_fileselector_entry_button_icon_set()
6463 EAPI Evas_Object *elm_fileselector_entry_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6466 * Set the title for a given file selector entry widget's window
6468 * @param obj The file selector entry widget
6469 * @param title The title string
6471 * This will change the window's title, when the file selector pops
6472 * out after a click on the entry's button. Those windows have the
6473 * default (unlocalized) value of @c "Select a file" as titles.
6475 * @note It will only take any effect if the file selector
6476 * entry widget is @b not under "inwin mode".
6478 * @see elm_fileselector_entry_window_title_get()
6480 EAPI void elm_fileselector_entry_window_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
6483 * Get the title set for a given file selector entry widget's
6486 * @param obj The file selector entry widget
6487 * @return Title of the file selector entry's window
6489 * @see elm_fileselector_entry_window_title_get() for more details
6491 EAPI const char *elm_fileselector_entry_window_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6494 * Set the size of a given file selector entry widget's window,
6495 * holding the file selector itself.
6497 * @param obj The file selector entry widget
6498 * @param width The window's width
6499 * @param height The window's height
6501 * @note it will only take any effect if the file selector entry
6502 * widget is @b not under "inwin mode". The default size for the
6503 * window (when applicable) is 400x400 pixels.
6505 * @see elm_fileselector_entry_window_size_get()
6507 EAPI void elm_fileselector_entry_window_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
6510 * Get the size of a given file selector entry widget's window,
6511 * holding the file selector itself.
6513 * @param obj The file selector entry widget
6514 * @param width Pointer into which to store the width value
6515 * @param height Pointer into which to store the height value
6517 * @note Use @c NULL pointers on the size values you're not
6518 * interested in: they'll be ignored by the function.
6520 * @see elm_fileselector_entry_window_size_set(), for more details
6522 EAPI void elm_fileselector_entry_window_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
6525 * Set the initial file system path and the entry's path string for
6526 * a given file selector entry widget
6528 * @param obj The file selector entry widget
6529 * @param path The path string
6531 * It must be a <b>directory</b> path, which will have the contents
6532 * displayed initially in the file selector's view, when invoked
6533 * from @p obj. The default initial path is the @c "HOME"
6534 * environment variable's value.
6536 * @see elm_fileselector_entry_path_get()
6538 EAPI void elm_fileselector_entry_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
6541 * Get the entry's path string for a given file selector entry
6544 * @param obj The file selector entry widget
6545 * @return path The path string
6547 * @see elm_fileselector_entry_path_set() for more details
6549 EAPI const char *elm_fileselector_entry_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6552 * Enable/disable a tree view in the given file selector entry
6553 * widget's internal file selector
6555 * @param obj The file selector entry widget
6556 * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
6559 * This has the same effect as elm_fileselector_expandable_set(),
6560 * but now applied to a file selector entry's internal file
6563 * @note There's no way to put a file selector entry's internal
6564 * file selector in "grid mode", as one may do with "pure" file
6567 * @see elm_fileselector_expandable_get()
6569 EAPI void elm_fileselector_entry_expandable_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6572 * Get whether tree view is enabled for the given file selector
6573 * entry widget's internal file selector
6575 * @param obj The file selector entry widget
6576 * @return @c EINA_TRUE if @p obj widget's internal file selector
6577 * is in tree view, @c EINA_FALSE otherwise (and or errors)
6579 * @see elm_fileselector_expandable_set() for more details
6581 EAPI Eina_Bool elm_fileselector_entry_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6584 * Set whether a given file selector entry widget's internal file
6585 * selector is to display folders only or the directory contents,
6588 * @param obj The file selector entry widget
6589 * @param only @c EINA_TRUE to make @p obj widget's internal file
6590 * selector only display directories, @c EINA_FALSE to make files
6591 * to be displayed in it too
6593 * This has the same effect as elm_fileselector_folder_only_set(),
6594 * but now applied to a file selector entry's internal file
6597 * @see elm_fileselector_folder_only_get()
6599 EAPI void elm_fileselector_entry_folder_only_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6602 * Get whether a given file selector entry widget's internal file
6603 * selector is displaying folders only or the directory contents,
6606 * @param obj The file selector entry widget
6607 * @return @c EINA_TRUE if @p obj widget's internal file
6608 * selector is only displaying directories, @c EINA_FALSE if files
6609 * are being displayed in it too (and on errors)
6611 * @see elm_fileselector_entry_folder_only_set() for more details
6613 EAPI Eina_Bool elm_fileselector_entry_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6616 * Enable/disable the file name entry box where the user can type
6617 * in a name for a file, in a given file selector entry widget's
6618 * internal file selector.
6620 * @param obj The file selector entry widget
6621 * @param is_save @c EINA_TRUE to make @p obj widget's internal
6622 * file selector a "saving dialog", @c EINA_FALSE otherwise
6624 * This has the same effect as elm_fileselector_is_save_set(),
6625 * but now applied to a file selector entry's internal file
6628 * @see elm_fileselector_is_save_get()
6630 EAPI void elm_fileselector_entry_is_save_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6633 * Get whether the given file selector entry widget's internal
6634 * file selector is in "saving dialog" mode
6636 * @param obj The file selector entry widget
6637 * @return @c EINA_TRUE, if @p obj widget's internal file selector
6638 * is in "saving dialog" mode, @c EINA_FALSE otherwise (and on
6641 * @see elm_fileselector_entry_is_save_set() for more details
6643 EAPI Eina_Bool elm_fileselector_entry_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6646 * Set whether a given file selector entry widget's internal file
6647 * selector will raise an Elementary "inner window", instead of a
6648 * dedicated Elementary window. By default, it won't.
6650 * @param obj The file selector entry widget
6651 * @param value @c EINA_TRUE to make it use an inner window, @c
6652 * EINA_TRUE to make it use a dedicated window
6654 * @see elm_win_inwin_add() for more information on inner windows
6655 * @see elm_fileselector_entry_inwin_mode_get()
6657 EAPI void elm_fileselector_entry_inwin_mode_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6660 * Get whether a given file selector entry widget's internal file
6661 * selector will raise an Elementary "inner window", instead of a
6662 * dedicated Elementary window.
6664 * @param obj The file selector entry widget
6665 * @return @c EINA_TRUE if will use an inner window, @c EINA_TRUE
6666 * if it will use a dedicated window
6668 * @see elm_fileselector_entry_inwin_mode_set() for more details
6670 EAPI Eina_Bool elm_fileselector_entry_inwin_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6673 * Set the initial file system path for a given file selector entry
6676 * @param obj The file selector entry widget
6677 * @param path The path string
6679 * It must be a <b>directory</b> path, which will have the contents
6680 * displayed initially in the file selector's view, when invoked
6681 * from @p obj. The default initial path is the @c "HOME"
6682 * environment variable's value.
6684 * @see elm_fileselector_entry_path_get()
6686 EAPI void elm_fileselector_entry_selected_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
6689 * Get the parent directory's path to the latest file selection on
6690 * a given filer selector entry widget
6692 * @param obj The file selector object
6693 * @return The (full) path of the directory of the last selection
6694 * on @p obj widget, a @b stringshared string
6696 * @see elm_fileselector_entry_path_set()
6698 EAPI const char *elm_fileselector_entry_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6705 * @defgroup Scroller Scroller
6707 * A scroller holds a single object and "scrolls it around". This means that
6708 * it allows the user to use a scrollbar (or a finger) to drag the viewable
6709 * region around, allowing to move through a much larger object that is
6710 * contained in the scroller. The scroiller will always have a small minimum
6711 * size by default as it won't be limited by the contents of the scroller.
6713 * Signals that you can add callbacks for are:
6714 * @li "edge,left" - the left edge of the content has been reached
6715 * @li "edge,right" - the right edge of the content has been reached
6716 * @li "edge,top" - the top edge of the content has been reached
6717 * @li "edge,bottom" - the bottom edge of the content has been reached
6718 * @li "scroll" - the content has been scrolled (moved)
6719 * @li "scroll,anim,start" - scrolling animation has started
6720 * @li "scroll,anim,stop" - scrolling animation has stopped
6721 * @li "scroll,drag,start" - dragging the contents around has started
6722 * @li "scroll,drag,stop" - dragging the contents around has stopped
6723 * @note The "scroll,anim,*" and "scroll,drag,*" signals are only emitted by
6726 * @note When Elemementary is in embedded mode the scrollbars will not be
6727 * dragable, they appear merely as indicators of how much has been scrolled.
6728 * @note When Elementary is in desktop mode the thumbscroll(a.k.a.
6729 * fingerscroll) won't work.
6731 * In @ref tutorial_scroller you'll find an example of how to use most of
6736 * @brief Type that controls when scrollbars should appear.
6738 * @see elm_scroller_policy_set()
6740 typedef enum _Elm_Scroller_Policy
6742 ELM_SCROLLER_POLICY_AUTO = 0, /**< Show scrollbars as needed */
6743 ELM_SCROLLER_POLICY_ON, /**< Always show scrollbars */
6744 ELM_SCROLLER_POLICY_OFF, /**< Never show scrollbars */
6745 ELM_SCROLLER_POLICY_LAST
6746 } Elm_Scroller_Policy;
6748 * @brief Add a new scroller to the parent
6750 * @param parent The parent object
6751 * @return The new object or NULL if it cannot be created
6753 EAPI Evas_Object *elm_scroller_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6755 * @brief Set the content of the scroller widget (the object to be scrolled around).
6757 * @param obj The scroller object
6758 * @param content The new content object
6760 * Once the content object is set, a previously set one will be deleted.
6761 * If you want to keep that old content object, use the
6762 * elm_scroller_content_unset() function.
6764 EAPI void elm_scroller_content_set(Evas_Object *obj, Evas_Object *child) EINA_ARG_NONNULL(1);
6766 * @brief Get the content of the scroller widget
6768 * @param obj The slider object
6769 * @return The content that is being used
6771 * Return the content object which is set for this widget
6773 * @see elm_scroller_content_set()
6775 EAPI Evas_Object *elm_scroller_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6777 * @brief Unset the content of the scroller widget
6779 * @param obj The slider object
6780 * @return The content that was being used
6782 * Unparent and return the content object which was set for this widget
6784 * @see elm_scroller_content_set()
6786 EAPI Evas_Object *elm_scroller_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6788 * @brief Set custom theme elements for the scroller
6790 * @param obj The scroller object
6791 * @param widget The widget name to use (default is "scroller")
6792 * @param base The base name to use (default is "base")
6794 EAPI void elm_scroller_custom_widget_base_theme_set(Evas_Object *obj, const char *widget, const char *base) EINA_ARG_NONNULL(1, 2, 3);
6796 * @brief Make the scroller minimum size limited to the minimum size of the content
6798 * @param obj The scroller object
6799 * @param w Enable limiting minimum size horizontally
6800 * @param h Enable limiting minimum size vertically
6802 * By default the scroller will be as small as its design allows,
6803 * irrespective of its content. This will make the scroller minimum size the
6804 * right size horizontally and/or vertically to perfectly fit its content in
6807 EAPI void elm_scroller_content_min_limit(Evas_Object *obj, Eina_Bool w, Eina_Bool h) EINA_ARG_NONNULL(1);
6809 * @brief Show a specific virtual region within the scroller content object
6811 * @param obj The scroller object
6812 * @param x X coordinate of the region
6813 * @param y Y coordinate of the region
6814 * @param w Width of the region
6815 * @param h Height of the region
6817 * This will ensure all (or part if it does not fit) of the designated
6818 * region in the virtual content object (0, 0 starting at the top-left of the
6819 * virtual content object) is shown within the scroller.
6821 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);
6823 * @brief Set the scrollbar visibility policy
6825 * @param obj The scroller object
6826 * @param policy_h Horizontal scrollbar policy
6827 * @param policy_v Vertical scrollbar policy
6829 * This sets the scrollbar visibility policy for the given scroller.
6830 * ELM_SCROLLER_POLICY_AUTO means the scrollber is made visible if it is
6831 * needed, and otherwise kept hidden. ELM_SCROLLER_POLICY_ON turns it on all
6832 * the time, and ELM_SCROLLER_POLICY_OFF always keeps it off. This applies
6833 * respectively for the horizontal and vertical scrollbars.
6835 EAPI void elm_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
6837 * @brief Gets scrollbar visibility policy
6839 * @param obj The scroller object
6840 * @param policy_h Horizontal scrollbar policy
6841 * @param policy_v Vertical scrollbar policy
6843 * @see elm_scroller_policy_set()
6845 EAPI void elm_scroller_policy_get(const Evas_Object *obj, Elm_Scroller_Policy *policy_h, Elm_Scroller_Policy *policy_v) EINA_ARG_NONNULL(1);
6847 * @brief Get the currently visible content region
6849 * @param obj The scroller object
6850 * @param x X coordinate of the region
6851 * @param y Y coordinate of the region
6852 * @param w Width of the region
6853 * @param h Height of the region
6855 * This gets the current region in the content object that is visible through
6856 * the scroller. The region co-ordinates are returned in the @p x, @p y, @p
6857 * w, @p h values pointed to.
6859 * @note All coordinates are relative to the content.
6861 * @see elm_scroller_region_show()
6863 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);
6865 * @brief Get the size of the content object
6867 * @param obj The scroller object
6868 * @param w Width return
6869 * @param h Height return
6871 * This gets the size of the content object of the scroller.
6873 EAPI void elm_scroller_child_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
6875 * @brief Set bouncing behavior
6877 * @param obj The scroller object
6878 * @param h_bounce Will the scroller bounce horizontally or not
6879 * @param v_bounce Will the scroller bounce vertically or not
6881 * When scrolling, the scroller may "bounce" when reaching an edge of the
6882 * content object. This is a visual way to indicate the end has been reached.
6883 * This is enabled by default for both axis. This will set if it is enabled
6884 * for that axis with the boolean parameters for each axis.
6886 EAPI void elm_scroller_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
6888 * @brief Get the bounce mode
6890 * @param obj The Scroller object
6891 * @param h_bounce Allow bounce horizontally
6892 * @param v_bounce Allow bounce vertically
6894 * @see elm_scroller_bounce_set()
6896 EAPI void elm_scroller_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
6898 * @brief Set scroll page size relative to viewport size.
6900 * @param obj The scroller object
6901 * @param h_pagerel The horizontal page relative size
6902 * @param v_pagerel The vertical page relative size
6904 * The scroller is capable of limiting scrolling by the user to "pages". That
6905 * is to jump by and only show a "whole page" at a time as if the continuous
6906 * area of the scroller content is split into page sized pieces. This sets
6907 * the size of a page relative to the viewport of the scroller. 1.0 is "1
6908 * viewport" is size (horizontally or vertically). 0.0 turns it off in that
6909 * axis. This is mutually exclusive with page size
6910 * (see elm_scroller_page_size_set() for more information). Likewise 0.5
6911 * is "half a viewport". Sane usable valus are normally between 0.0 and 1.0
6912 * including 1.0. If you only want 1 axis to be page "limited", use 0.0 for
6915 EAPI void elm_scroller_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel) EINA_ARG_NONNULL(1);
6917 * @brief Set scroll page size.
6919 * @param obj The scroller object
6920 * @param h_pagesize The horizontal page size
6921 * @param v_pagesize The vertical page size
6923 * This sets the page size to an absolute fixed value, with 0 turning it off
6926 * @see elm_scroller_page_relative_set()
6928 EAPI void elm_scroller_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize) EINA_ARG_NONNULL(1);
6930 * @brief Get scroll current page number.
6932 * @param obj The scroller object
6933 * @param h_pagenumber The horizoptal page number
6934 * @param v_pagenumber The vertical page number
6936 * The page number starts from 0. 0 is the first page.
6937 * Current page means the page which meet the top-left of the viewport.
6938 * If there are two or more pages in the viewport, it returns the number of page
6939 * which meet the top-left of the viewport.
6941 * @see elm_scroller_last_page_get()
6942 * @see elm_scroller_page_show()
6943 * @see elm_scroller_page_brint_in()
6945 EAPI void elm_scroller_current_page_get(Evas_Object *obj, int *h_pagenumber, int *v_pagenumber) EINA_ARG_NONNULL(1);
6947 * @brief Get scroll last page number.
6949 * @param obj The scroller object
6950 * @param h_pagenumber The horizoptal page number
6951 * @param v_pagenumber The vertical page number
6953 * The page number starts from 0. 0 is the first page.
6954 * This returns the last page number among the pages.
6956 * @see elm_scroller_current_page_get()
6957 * @see elm_scroller_page_show()
6958 * @see elm_scroller_page_brint_in()
6960 EAPI void elm_scroller_last_page_get(Evas_Object *obj, int *h_pagenumber, int *v_pagenumber) EINA_ARG_NONNULL(1);
6962 * Show a specific virtual region within the scroller content object by page number.
6964 * @param obj The scroller object
6965 * @param h_pagenumber The horizoptal page number
6966 * @param v_pagenumber The vertical page number
6968 * 0, 0 of the indicated page is located at the top-left of the viewport.
6969 * This will jump to the page directly without animation.
6974 * sc = elm_scroller_add(win);
6975 * elm_scroller_content_set(sc, content);
6976 * elm_scroller_page_relative_set(sc, 1, 0);
6977 * elm_scroller_current_page_get(sc, &h_page, &v_page);
6978 * elm_scroller_page_show(sc, h_page + 1, v_page);
6981 * @see elm_scroller_page_bring_in()
6983 EAPI void elm_scroller_page_show(Evas_Object *obj, int h_pagenumber, int v_pagenumber) EINA_ARG_NONNULL(1);
6985 * Show a specific virtual region within the scroller content object by page number.
6987 * @param obj The scroller object
6988 * @param h_pagenumber The horizoptal page number
6989 * @param v_pagenumber The vertical page number
6991 * 0, 0 of the indicated page is located at the top-left of the viewport.
6992 * This will slide to the page with animation.
6997 * sc = elm_scroller_add(win);
6998 * elm_scroller_content_set(sc, content);
6999 * elm_scroller_page_relative_set(sc, 1, 0);
7000 * elm_scroller_last_page_get(sc, &h_page, &v_page);
7001 * elm_scroller_page_bring_in(sc, h_page, v_page);
7004 * @see elm_scroller_page_show()
7006 EAPI void elm_scroller_page_bring_in(Evas_Object *obj, int h_pagenumber, int v_pagenumber) EINA_ARG_NONNULL(1);
7008 * @brief Show a specific virtual region within the scroller content object.
7010 * @param obj The scroller object
7011 * @param x X coordinate of the region
7012 * @param y Y coordinate of the region
7013 * @param w Width of the region
7014 * @param h Height of the region
7016 * This will ensure all (or part if it does not fit) of the designated
7017 * region in the virtual content object (0, 0 starting at the top-left of the
7018 * virtual content object) is shown within the scroller. Unlike
7019 * elm_scroller_region_show(), this allow the scroller to "smoothly slide"
7020 * to this location (if configuration in general calls for transitions). It
7021 * may not jump immediately to the new location and make take a while and
7022 * show other content along the way.
7024 * @see elm_scroller_region_show()
7026 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);
7028 * @brief Set event propagation on a scroller
7030 * @param obj The scroller object
7031 * @param propagation If propagation is enabled or not
7033 * This enables or disabled event propagation from the scroller content to
7034 * the scroller and its parent. By default event propagation is disabled.
7036 EAPI void elm_scroller_propagate_events_set(Evas_Object *obj, Eina_Bool propagation);
7038 * @brief Get event propagation for a scroller
7040 * @param obj The scroller object
7041 * @return The propagation state
7043 * This gets the event propagation for a scroller.
7045 * @see elm_scroller_propagate_events_set()
7047 EAPI Eina_Bool elm_scroller_propagate_events_get(const Evas_Object *obj);
7053 * @defgroup Label Label
7055 * @image html img/widget/label/preview-00.png
7056 * @image latex img/widget/label/preview-00.eps
7058 * @brief Widget to display text, with simple html-like markup.
7060 * The Label widget @b doesn't allow text to overflow its boundaries, if the
7061 * text doesn't fit the geometry of the label it will be ellipsized or be
7062 * cut. Elementary provides several themes for this widget:
7063 * @li default - No animation
7064 * @li marker - Centers the text in the label and make it bold by default
7065 * @li slide_long - The entire text appears from the right of the screen and
7066 * slides until it disappears in the left of the screen(reappering on the
7068 * @li slide_short - The text appears in the left of the label and slides to
7069 * the right to show the overflow. When all of the text has been shown the
7070 * position is reset.
7071 * @li slide_bounce - The text appears in the left of the label and slides to
7072 * the right to show the overflow. When all of the text has been shown the
7073 * animation reverses, moving the text to the left.
7075 * Custom themes can of course invent new markup tags and style them any way
7078 * See @ref tutorial_label for a demonstration of how to use a label widget.
7082 * @brief Add a new label to the parent
7084 * @param parent The parent object
7085 * @return The new object or NULL if it cannot be created
7087 EAPI Evas_Object *elm_label_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7089 * @brief Set the label on the label object
7091 * @param obj The label object
7092 * @param label The label will be used on the label object
7093 * @deprecated See elm_object_text_set()
7095 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 */
7097 * @brief Get the label used on the label object
7099 * @param obj The label object
7100 * @return The string inside the label
7101 * @deprecated See elm_object_text_get()
7103 EINA_DEPRECATED EAPI const char *elm_label_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1); /* deprecated, use elm_object_text_get instead */
7105 * @brief Set the wrapping behavior of the label
7107 * @param obj The label object
7108 * @param wrap To wrap text or not
7110 * By default no wrapping is done. Possible values for @p wrap are:
7111 * @li ELM_WRAP_NONE - No wrapping
7112 * @li ELM_WRAP_CHAR - wrap between characters
7113 * @li ELM_WRAP_WORD - wrap between words
7114 * @li ELM_WRAP_MIXED - Word wrap, and if that fails, char wrap
7116 EAPI void elm_label_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
7118 * @brief Get the wrapping behavior of the label
7120 * @param obj The label object
7123 * @see elm_label_line_wrap_set()
7125 EAPI Elm_Wrap_Type elm_label_line_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7127 * @brief Set wrap width of the label
7129 * @param obj The label object
7130 * @param w The wrap width in pixels at a minimum where words need to wrap
7132 * This function sets the maximum width size hint of the label.
7134 * @warning This is only relevant if the label is inside a container.
7136 EAPI void elm_label_wrap_width_set(Evas_Object *obj, Evas_Coord w) EINA_ARG_NONNULL(1);
7138 * @brief Get wrap width of the label
7140 * @param obj The label object
7141 * @return The wrap width in pixels at a minimum where words need to wrap
7143 * @see elm_label_wrap_width_set()
7145 EAPI Evas_Coord elm_label_wrap_width_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7147 * @brief Set wrap height of the label
7149 * @param obj The label object
7150 * @param h The wrap height in pixels at a minimum where words need to wrap
7152 * This function sets the maximum height size hint of the label.
7154 * @warning This is only relevant if the label is inside a container.
7156 EAPI void elm_label_wrap_height_set(Evas_Object *obj, Evas_Coord h) EINA_ARG_NONNULL(1);
7158 * @brief get wrap width of the label
7160 * @param obj The label object
7161 * @return The wrap height in pixels at a minimum where words need to wrap
7163 EAPI Evas_Coord elm_label_wrap_height_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7165 * @brief Set the font size on the label object.
7167 * @param obj The label object
7168 * @param size font size
7170 * @warning NEVER use this. It is for hyper-special cases only. use styles
7171 * instead. e.g. "big", "medium", "small" - or better name them by use:
7172 * "title", "footnote", "quote" etc.
7174 EAPI void elm_label_fontsize_set(Evas_Object *obj, int fontsize) EINA_ARG_NONNULL(1);
7176 * @brief Set the text color on the label object
7178 * @param obj The label object
7179 * @param r Red property background color of The label object
7180 * @param g Green property background color of The label object
7181 * @param b Blue property background color of The label object
7182 * @param a Alpha property background color of The label object
7184 * @warning NEVER use this. It is for hyper-special cases only. use styles
7185 * instead. e.g. "big", "medium", "small" - or better name them by use:
7186 * "title", "footnote", "quote" etc.
7188 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);
7190 * @brief Set the text align on the label object
7192 * @param obj The label object
7193 * @param align align mode ("left", "center", "right")
7195 * @warning NEVER use this. It is for hyper-special cases only. use styles
7196 * instead. e.g. "big", "medium", "small" - or better name them by use:
7197 * "title", "footnote", "quote" etc.
7199 EAPI void elm_label_text_align_set(Evas_Object *obj, const char *alignmode) EINA_ARG_NONNULL(1);
7201 * @brief Set background color of the label
7203 * @param obj The label object
7204 * @param r Red property background color of The label object
7205 * @param g Green property background color of The label object
7206 * @param b Blue property background color of The label object
7207 * @param a Alpha property background alpha of The label object
7209 * @warning NEVER use this. It is for hyper-special cases only. use styles
7210 * instead. e.g. "big", "medium", "small" - or better name them by use:
7211 * "title", "footnote", "quote" etc.
7213 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);
7215 * @brief Set the ellipsis behavior of the label
7217 * @param obj The label object
7218 * @param ellipsis To ellipsis text or not
7220 * If set to true and the text doesn't fit in the label an ellipsis("...")
7221 * will be shown at the end of the widget.
7223 * @warning This doesn't work with slide(elm_label_slide_set()) or if the
7224 * choosen wrap method was ELM_WRAP_WORD.
7226 EAPI void elm_label_ellipsis_set(Evas_Object *obj, Eina_Bool ellipsis) EINA_ARG_NONNULL(1);
7228 * @brief Set the text slide of the label
7230 * @param obj The label object
7231 * @param slide To start slide or stop
7233 * If set to true the text of the label will slide throught the length of
7236 * @warning This only work with the themes "slide_short", "slide_long" and
7239 EAPI void elm_label_slide_set(Evas_Object *obj, Eina_Bool slide) EINA_ARG_NONNULL(1);
7241 * @brief Get the text slide mode of the label
7243 * @param obj The label object
7244 * @return slide slide mode value
7246 * @see elm_label_slide_set()
7248 EAPI Eina_Bool elm_label_slide_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
7250 * @brief Set the slide duration(speed) of the label
7252 * @param obj The label object
7253 * @return The duration in seconds in moving text from slide begin position
7254 * to slide end position
7256 EAPI void elm_label_slide_duration_set(Evas_Object *obj, double duration) EINA_ARG_NONNULL(1);
7258 * @brief Get the slide duration(speed) of the label
7260 * @param obj The label object
7261 * @return The duration time in moving text from slide begin position to slide end position
7263 * @see elm_label_slide_duration_set()
7265 EAPI double elm_label_slide_duration_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
7271 * @defgroup Toggle Toggle
7273 * @image html img/widget/toggle/preview-00.png
7274 * @image latex img/widget/toggle/preview-00.eps
7276 * @brief A toggle is a slider which can be used to toggle between
7277 * two values. It has two states: on and off.
7279 * Signals that you can add callbacks for are:
7280 * @li "changed" - Whenever the toggle value has been changed. Is not called
7281 * until the toggle is released by the cursor (assuming it
7282 * has been triggered by the cursor in the first place).
7284 * @ref tutorial_toggle show how to use a toggle.
7288 * @brief Add a toggle to @p parent.
7290 * @param parent The parent object
7292 * @return The toggle object
7294 EAPI Evas_Object *elm_toggle_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7296 * @brief Sets the label to be displayed with the toggle.
7298 * @param obj The toggle object
7299 * @param label The label to be displayed
7301 * @deprecated use elm_object_text_set() instead.
7303 EINA_DEPRECATED EAPI void elm_toggle_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
7305 * @brief Gets the label of the toggle
7307 * @param obj toggle object
7308 * @return The label of the toggle
7310 * @deprecated use elm_object_text_get() instead.
7312 EINA_DEPRECATED EAPI const char *elm_toggle_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7314 * @brief Set the icon used for the toggle
7316 * @param obj The toggle object
7317 * @param icon The icon object for the button
7319 * Once the icon object is set, a previously set one will be deleted
7320 * If you want to keep that old content object, use the
7321 * elm_toggle_icon_unset() function.
7323 EAPI void elm_toggle_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
7325 * @brief Get the icon used for the toggle
7327 * @param obj The toggle object
7328 * @return The icon object that is being used
7330 * Return the icon object which is set for this widget.
7332 * @see elm_toggle_icon_set()
7334 EAPI Evas_Object *elm_toggle_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7336 * @brief Unset the icon used for the toggle
7338 * @param obj The toggle object
7339 * @return The icon object that was being used
7341 * Unparent and return the icon object which was set for this widget.
7343 * @see elm_toggle_icon_set()
7345 EAPI Evas_Object *elm_toggle_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
7347 * @brief Sets the labels to be associated with the on and off states of the toggle.
7349 * @param obj The toggle object
7350 * @param onlabel The label displayed when the toggle is in the "on" state
7351 * @param offlabel The label displayed when the toggle is in the "off" state
7353 EAPI void elm_toggle_states_labels_set(Evas_Object *obj, const char *onlabel, const char *offlabel) EINA_ARG_NONNULL(1);
7355 * @brief Gets the labels associated with the on and off states of the toggle.
7357 * @param obj The toggle object
7358 * @param onlabel A char** to place the onlabel of @p obj into
7359 * @param offlabel A char** to place the offlabel of @p obj into
7361 EAPI void elm_toggle_states_labels_get(const Evas_Object *obj, const char **onlabel, const char **offlabel) EINA_ARG_NONNULL(1);
7363 * @brief Sets the state of the toggle to @p state.
7365 * @param obj The toggle object
7366 * @param state The state of @p obj
7368 EAPI void elm_toggle_state_set(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
7370 * @brief Gets the state of the toggle to @p state.
7372 * @param obj The toggle object
7373 * @return The state of @p obj
7375 EAPI Eina_Bool elm_toggle_state_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7377 * @brief Sets the state pointer of the toggle to @p statep.
7379 * @param obj The toggle object
7380 * @param statep The state pointer of @p obj
7382 EAPI void elm_toggle_state_pointer_set(Evas_Object *obj, Eina_Bool *statep) EINA_ARG_NONNULL(1);
7388 * @defgroup Frame Frame
7390 * @image html img/widget/frame/preview-00.png
7391 * @image latex img/widget/frame/preview-00.eps
7393 * @brief Frame is a widget that holds some content and has a title.
7395 * The default look is a frame with a title, but Frame supports multple
7403 * @li outdent_bottom
7405 * Of all this styles only default shows the title. Frame emits no signals.
7407 * For a detailed example see the @ref tutorial_frame.
7412 * @brief Add a new frame to the parent
7414 * @param parent The parent object
7415 * @return The new object or NULL if it cannot be created
7417 EAPI Evas_Object *elm_frame_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7419 * @brief Set the frame label
7421 * @param obj The frame object
7422 * @param label The label of this frame object
7424 * @deprecated use elm_object_text_set() instead.
7426 EINA_DEPRECATED EAPI void elm_frame_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
7428 * @brief Get the frame label
7430 * @param obj The frame object
7432 * @return The label of this frame objet or NULL if unable to get frame
7434 * @deprecated use elm_object_text_get() instead.
7436 EINA_DEPRECATED EAPI const char *elm_frame_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7438 * @brief Set the content of the frame widget
7440 * Once the content object is set, a previously set one will be deleted.
7441 * If you want to keep that old content object, use the
7442 * elm_frame_content_unset() function.
7444 * @param obj The frame object
7445 * @param content The content will be filled in this frame object
7447 EAPI void elm_frame_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
7449 * @brief Get the content of the frame widget
7451 * Return the content object which is set for this widget
7453 * @param obj The frame object
7454 * @return The content that is being used
7456 EAPI Evas_Object *elm_frame_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7458 * @brief Unset the content of the frame widget
7460 * Unparent and return the content object which was set for this widget
7462 * @param obj The frame object
7463 * @return The content that was being used
7465 EAPI Evas_Object *elm_frame_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
7471 * @defgroup Table Table
7473 * A container widget to arrange other widgets in a table where items can
7474 * also span multiple columns or rows - even overlap (and then be raised or
7475 * lowered accordingly to adjust stacking if they do overlap).
7477 * The followin are examples of how to use a table:
7478 * @li @ref tutorial_table_01
7479 * @li @ref tutorial_table_02
7484 * @brief Add a new table to the parent
7486 * @param parent The parent object
7487 * @return The new object or NULL if it cannot be created
7489 EAPI Evas_Object *elm_table_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7491 * @brief Set the homogeneous layout in the table
7493 * @param obj The layout object
7494 * @param homogeneous A boolean to set if the layout is homogeneous in the
7495 * table (EINA_TRUE = homogeneous, EINA_FALSE = no homogeneous)
7497 EAPI void elm_table_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
7499 * @brief Get the current table homogeneous mode.
7501 * @param obj The table object
7502 * @return A boolean to indicating if the layout is homogeneous in the table
7503 * (EINA_TRUE = homogeneous, EINA_FALSE = no homogeneous)
7505 EAPI Eina_Bool elm_table_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7507 * @warning <b>Use elm_table_homogeneous_set() instead</b>
7509 EINA_DEPRECATED EAPI void elm_table_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
7511 * @warning <b>Use elm_table_homogeneous_get() instead</b>
7513 EINA_DEPRECATED EAPI Eina_Bool elm_table_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7515 * @brief Set padding between cells.
7517 * @param obj The layout object.
7518 * @param horizontal set the horizontal padding.
7519 * @param vertical set the vertical padding.
7521 * Default value is 0.
7523 EAPI void elm_table_padding_set(Evas_Object *obj, Evas_Coord horizontal, Evas_Coord vertical) EINA_ARG_NONNULL(1);
7525 * @brief Get padding between cells.
7527 * @param obj The layout object.
7528 * @param horizontal set the horizontal padding.
7529 * @param vertical set the vertical padding.
7531 EAPI void elm_table_padding_get(const Evas_Object *obj, Evas_Coord *horizontal, Evas_Coord *vertical) EINA_ARG_NONNULL(1);
7533 * @brief Add a subobject on the table with the coordinates passed
7535 * @param obj The table object
7536 * @param subobj The subobject to be added to the table
7537 * @param x Row number
7538 * @param y Column number
7542 * @note All positioning inside the table is relative to rows and columns, so
7543 * a value of 0 for x and y, means the top left cell of the table, and a
7544 * value of 1 for w and h means @p subobj only takes that 1 cell.
7546 EAPI void elm_table_pack(Evas_Object *obj, Evas_Object *subobj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
7548 * @brief Remove child from table.
7550 * @param obj The table object
7551 * @param subobj The subobject
7553 EAPI void elm_table_unpack(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
7555 * @brief Faster way to remove all child objects from a table object.
7557 * @param obj The table object
7558 * @param clear If true, will delete children, else just remove from table.
7560 EAPI void elm_table_clear(Evas_Object *obj, Eina_Bool clear) EINA_ARG_NONNULL(1);
7562 * @brief Set the packing location of an existing child of the table
7564 * @param subobj The subobject to be modified in the table
7565 * @param x Row number
7566 * @param y Column number
7570 * Modifies the position of an object already in the table.
7572 * @note All positioning inside the table is relative to rows and columns, so
7573 * a value of 0 for x and y, means the top left cell of the table, and a
7574 * value of 1 for w and h means @p subobj only takes that 1 cell.
7576 EAPI void elm_table_pack_set(Evas_Object *subobj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
7578 * @brief Get the packing location of an existing child of the table
7580 * @param subobj The subobject to be modified in the table
7581 * @param x Row number
7582 * @param y Column number
7586 * @see elm_table_pack_set()
7588 EAPI void elm_table_pack_get(Evas_Object *subobj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
7594 * @defgroup Gengrid Gengrid (Generic grid)
7596 * This widget aims to position objects in a grid layout while
7597 * actually creating and rendering only the visible ones, using the
7598 * same idea as the @ref Genlist "genlist": the user defines a @b
7599 * class for each item, specifying functions that will be called at
7600 * object creation, deletion, etc. When those items are selected by
7601 * the user, a callback function is issued. Users may interact with
7602 * a gengrid via the mouse (by clicking on items to select them and
7603 * clicking on the grid's viewport and swiping to pan the whole
7604 * view) or via the keyboard, navigating through item with the
7607 * @section Gengrid_Layouts Gengrid layouts
7609 * Gengrids may layout its items in one of two possible layouts:
7613 * When in "horizontal mode", items will be placed in @b columns,
7614 * from top to bottom and, when the space for a column is filled,
7615 * another one is started on the right, thus expanding the grid
7616 * horizontally, making for horizontal scrolling. When in "vertical
7617 * mode" , though, items will be placed in @b rows, from left to
7618 * right and, when the space for a row is filled, another one is
7619 * started below, thus expanding the grid vertically (and making
7620 * for vertical scrolling).
7622 * @section Gengrid_Items Gengrid items
7624 * An item in a gengrid can have 0 or more text labels (they can be
7625 * regular text or textblock Evas objects - that's up to the style
7626 * to determine), 0 or more icons (which are simply objects
7627 * swallowed into the gengrid item's theming Edje object) and 0 or
7628 * more <b>boolean states</b>, which have the behavior left to the
7629 * user to define. The Edje part names for each of these properties
7630 * will be looked up, in the theme file for the gengrid, under the
7631 * Edje (string) data items named @c "labels", @c "icons" and @c
7632 * "states", respectively. For each of those properties, if more
7633 * than one part is provided, they must have names listed separated
7634 * by spaces in the data fields. For the default gengrid item
7635 * theme, we have @b one label part (@c "elm.text"), @b two icon
7636 * parts (@c "elm.swalllow.icon" and @c "elm.swallow.end") and @b
7639 * A gengrid item may be at one of several styles. Elementary
7640 * provides one by default - "default", but this can be extended by
7641 * system or application custom themes/overlays/extensions (see
7642 * @ref Theme "themes" for more details).
7644 * @section Gengrid_Item_Class Gengrid item classes
7646 * In order to have the ability to add and delete items on the fly,
7647 * gengrid implements a class (callback) system where the
7648 * application provides a structure with information about that
7649 * type of item (gengrid may contain multiple different items with
7650 * different classes, states and styles). Gengrid will call the
7651 * functions in this struct (methods) when an item is "realized"
7652 * (i.e., created dynamically, while the user is scrolling the
7653 * grid). All objects will simply be deleted when no longer needed
7654 * with evas_object_del(). The #Elm_GenGrid_Item_Class structure
7655 * contains the following members:
7656 * - @c item_style - This is a constant string and simply defines
7657 * the name of the item style. It @b must be specified and the
7658 * default should be @c "default".
7659 * - @c func.label_get - This function is called when an item
7660 * object is actually created. The @c data parameter will point to
7661 * the same data passed to elm_gengrid_item_append() and related
7662 * item creation functions. The @c obj parameter is the gengrid
7663 * object itself, while the @c part one is the name string of one
7664 * of the existing text parts in the Edje group implementing the
7665 * item's theme. This function @b must return a strdup'()ed string,
7666 * as the caller will free() it when done. See
7667 * #Elm_Gengrid_Item_Label_Get_Cb.
7668 * - @c func.icon_get - This function is called when an item object
7669 * is actually created. The @c data parameter will point to the
7670 * same data passed to elm_gengrid_item_append() and related item
7671 * creation functions. The @c obj parameter is the gengrid object
7672 * itself, while the @c part one is the name string of one of the
7673 * existing (icon) swallow parts in the Edje group implementing the
7674 * item's theme. It must return @c NULL, when no icon is desired,
7675 * or a valid object handle, otherwise. The object will be deleted
7676 * by the gengrid on its deletion or when the item is "unrealized".
7677 * See #Elm_Gengrid_Item_Icon_Get_Cb.
7678 * - @c func.state_get - This function is called when an item
7679 * object is actually created. The @c data parameter will point to
7680 * the same data passed to elm_gengrid_item_append() and related
7681 * item creation functions. The @c obj parameter is the gengrid
7682 * object itself, while the @c part one is the name string of one
7683 * of the state parts in the Edje group implementing the item's
7684 * theme. Return @c EINA_FALSE for false/off or @c EINA_TRUE for
7685 * true/on. Gengrids will emit a signal to its theming Edje object
7686 * with @c "elm,state,XXX,active" and @c "elm" as "emission" and
7687 * "source" arguments, respectively, when the state is true (the
7688 * default is false), where @c XXX is the name of the (state) part.
7689 * See #Elm_Gengrid_Item_State_Get_Cb.
7690 * - @c func.del - This is called when elm_gengrid_item_del() is
7691 * called on an item or elm_gengrid_clear() is called on the
7692 * gengrid. This is intended for use when gengrid items are
7693 * deleted, so any data attached to the item (e.g. its data
7694 * parameter on creation) can be deleted. See #Elm_Gengrid_Item_Del_Cb.
7696 * @section Gengrid_Usage_Hints Usage hints
7698 * If the user wants to have multiple items selected at the same
7699 * time, elm_gengrid_multi_select_set() will permit it. If the
7700 * gengrid is single-selection only (the default), then
7701 * elm_gengrid_select_item_get() will return the selected item or
7702 * @c NULL, if none is selected. If the gengrid is under
7703 * multi-selection, then elm_gengrid_selected_items_get() will
7704 * return a list (that is only valid as long as no items are
7705 * modified (added, deleted, selected or unselected) of child items
7708 * If an item changes (internal (boolean) state, label or icon
7709 * changes), then use elm_gengrid_item_update() to have gengrid
7710 * update the item with the new state. A gengrid will re-"realize"
7711 * the item, thus calling the functions in the
7712 * #Elm_Gengrid_Item_Class set for that item.
7714 * To programmatically (un)select an item, use
7715 * elm_gengrid_item_selected_set(). To get its selected state use
7716 * elm_gengrid_item_selected_get(). To make an item disabled
7717 * (unable to be selected and appear differently) use
7718 * elm_gengrid_item_disabled_set() to set this and
7719 * elm_gengrid_item_disabled_get() to get the disabled state.
7721 * Grid cells will only have their selection smart callbacks called
7722 * when firstly getting selected. Any further clicks will do
7723 * nothing, unless you enable the "always select mode", with
7724 * elm_gengrid_always_select_mode_set(), thus making every click to
7725 * issue selection callbacks. elm_gengrid_no_select_mode_set() will
7726 * turn off the ability to select items entirely in the widget and
7727 * they will neither appear selected nor call the selection smart
7730 * Remember that you can create new styles and add your own theme
7731 * augmentation per application with elm_theme_extension_add(). If
7732 * you absolutely must have a specific style that overrides any
7733 * theme the user or system sets up you can use
7734 * elm_theme_overlay_add() to add such a file.
7736 * @section Gengrid_Smart_Events Gengrid smart events
7738 * Smart events that you can add callbacks for are:
7739 * - @c "activated" - The user has double-clicked or pressed
7740 * (enter|return|spacebar) on an item. The @c event_info parameter
7741 * is the gengrid item that was activated.
7742 * - @c "clicked,double" - The user has double-clicked an item.
7743 * The @c event_info parameter is the gengrid item that was double-clicked.
7744 * - @c "selected" - The user has made an item selected. The
7745 * @c event_info parameter is the gengrid item that was selected.
7746 * - @c "unselected" - The user has made an item unselected. The
7747 * @c event_info parameter is the gengrid item that was unselected.
7748 * - @c "realized" - This is called when the item in the gengrid
7749 * has its implementing Evas object instantiated, de facto. @c
7750 * event_info is the gengrid item that was created. The object
7751 * may be deleted at any time, so it is highly advised to the
7752 * caller @b not to use the object pointer returned from
7753 * elm_gengrid_item_object_get(), because it may point to freed
7755 * - @c "unrealized" - This is called when the implementing Evas
7756 * object for this item is deleted. @c event_info is the gengrid
7757 * item that was deleted.
7758 * - @c "changed" - Called when an item is added, removed, resized
7759 * or moved and when the gengrid is resized or gets "horizontal"
7761 * - @c "scroll,anim,start" - This is called when scrolling animation has
7763 * - @c "scroll,anim,stop" - This is called when scrolling animation has
7765 * - @c "drag,start,up" - Called when the item in the gengrid has
7766 * been dragged (not scrolled) up.
7767 * - @c "drag,start,down" - Called when the item in the gengrid has
7768 * been dragged (not scrolled) down.
7769 * - @c "drag,start,left" - Called when the item in the gengrid has
7770 * been dragged (not scrolled) left.
7771 * - @c "drag,start,right" - Called when the item in the gengrid has
7772 * been dragged (not scrolled) right.
7773 * - @c "drag,stop" - Called when the item in the gengrid has
7774 * stopped being dragged.
7775 * - @c "drag" - Called when the item in the gengrid is being
7777 * - @c "scroll" - called when the content has been scrolled
7779 * - @c "scroll,drag,start" - called when dragging the content has
7781 * - @c "scroll,drag,stop" - called when dragging the content has
7784 * List of gendrid examples:
7785 * @li @ref gengrid_example
7789 * @addtogroup Gengrid
7793 typedef struct _Elm_Gengrid_Item_Class Elm_Gengrid_Item_Class; /**< Gengrid item class definition structs */
7794 typedef struct _Elm_Gengrid_Item_Class_Func Elm_Gengrid_Item_Class_Func; /**< Class functions for gengrid item classes. */
7795 typedef struct _Elm_Gengrid_Item Elm_Gengrid_Item; /**< Gengrid item handles */
7796 typedef char *(*Elm_Gengrid_Item_Label_Get_Cb) (void *data, Evas_Object *obj, const char *part); /**< Label fetching class function for gengrid item classes. */
7797 typedef Evas_Object *(*Elm_Gengrid_Item_Icon_Get_Cb) (void *data, Evas_Object *obj, const char *part); /**< Icon fetching class function for gengrid item classes. */
7798 typedef Eina_Bool (*Elm_Gengrid_Item_State_Get_Cb) (void *data, Evas_Object *obj, const char *part); /**< State fetching class function for gengrid item classes. */
7799 typedef void (*Elm_Gengrid_Item_Del_Cb) (void *data, Evas_Object *obj); /**< Deletion class function for gengrid item classes. */
7801 typedef char *(*GridItemLabelGetFunc) (void *data, Evas_Object *obj, const char *part) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Gengrid_Item_Label_Get_Cb. */
7802 typedef Evas_Object *(*GridItemIconGetFunc) (void *data, Evas_Object *obj, const char *part) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Gengrid_Item_Icon_Get_Cb. */
7803 typedef Eina_Bool (*GridItemStateGetFunc) (void *data, Evas_Object *obj, const char *part) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Gengrid_Item_State_Get_Cb. */
7804 typedef void (*GridItemDelFunc) (void *data, Evas_Object *obj) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Gengrid_Item_Del_Cb. */
7807 * @struct _Elm_Gengrid_Item_Class
7809 * Gengrid item class definition. See @ref Gengrid_Item_Class for
7812 struct _Elm_Gengrid_Item_Class
7814 const char *item_style;
7815 struct _Elm_Gengrid_Item_Class_Func
7817 Elm_Gengrid_Item_Label_Get_Cb label_get;
7818 Elm_Gengrid_Item_Icon_Get_Cb icon_get;
7819 Elm_Gengrid_Item_State_Get_Cb state_get;
7820 Elm_Gengrid_Item_Del_Cb del;
7822 }; /**< #Elm_Gengrid_Item_Class member definitions */
7825 * Add a new gengrid widget to the given parent Elementary
7826 * (container) object
7828 * @param parent The parent object
7829 * @return a new gengrid widget handle or @c NULL, on errors
7831 * This function inserts a new gengrid widget on the canvas.
7833 * @see elm_gengrid_item_size_set()
7834 * @see elm_gengrid_horizontal_set()
7835 * @see elm_gengrid_item_append()
7836 * @see elm_gengrid_item_del()
7837 * @see elm_gengrid_clear()
7841 EAPI Evas_Object *elm_gengrid_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7844 * Set the size for the items of a given gengrid widget
7846 * @param obj The gengrid object.
7847 * @param w The items' width.
7848 * @param h The items' height;
7850 * A gengrid, after creation, has still no information on the size
7851 * to give to each of its cells. So, you most probably will end up
7852 * with squares one @ref Fingers "finger" wide, the default
7853 * size. Use this function to force a custom size for you items,
7854 * making them as big as you wish.
7856 * @see elm_gengrid_item_size_get()
7860 EAPI void elm_gengrid_item_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
7863 * Get the size set for the items of a given gengrid widget
7865 * @param obj The gengrid object.
7866 * @param w Pointer to a variable where to store the items' width.
7867 * @param h Pointer to a variable where to store the items' height.
7869 * @note Use @c NULL pointers on the size values you're not
7870 * interested in: they'll be ignored by the function.
7872 * @see elm_gengrid_item_size_get() for more details
7876 EAPI void elm_gengrid_item_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
7879 * Set the items grid's alignment within a given gengrid widget
7881 * @param obj The gengrid object.
7882 * @param align_x Alignment in the horizontal axis (0 <= align_x <= 1).
7883 * @param align_y Alignment in the vertical axis (0 <= align_y <= 1).
7885 * This sets the alignment of the whole grid of items of a gengrid
7886 * within its given viewport. By default, those values are both
7887 * 0.5, meaning that the gengrid will have its items grid placed
7888 * exactly in the middle of its viewport.
7890 * @note If given alignment values are out of the cited ranges,
7891 * they'll be changed to the nearest boundary values on the valid
7894 * @see elm_gengrid_align_get()
7898 EAPI void elm_gengrid_align_set(Evas_Object *obj, double align_x, double align_y) EINA_ARG_NONNULL(1);
7901 * Get the items grid's alignment values within a given gengrid
7904 * @param obj The gengrid object.
7905 * @param align_x Pointer to a variable where to store the
7906 * horizontal alignment.
7907 * @param align_y Pointer to a variable where to store the vertical
7910 * @note Use @c NULL pointers on the alignment values you're not
7911 * interested in: they'll be ignored by the function.
7913 * @see elm_gengrid_align_set() for more details
7917 EAPI void elm_gengrid_align_get(const Evas_Object *obj, double *align_x, double *align_y) EINA_ARG_NONNULL(1);
7920 * Set whether a given gengrid widget is or not able have items
7923 * @param obj The gengrid object
7924 * @param reorder_mode Use @c EINA_TRUE to turn reoderding on,
7925 * @c EINA_FALSE to turn it off
7927 * If a gengrid is set to allow reordering, a click held for more
7928 * than 0.5 over a given item will highlight it specially,
7929 * signalling the gengrid has entered the reordering state. From
7930 * that time on, the user will be able to, while still holding the
7931 * mouse button down, move the item freely in the gengrid's
7932 * viewport, replacing to said item to the locations it goes to.
7933 * The replacements will be animated and, whenever the user
7934 * releases the mouse button, the item being replaced gets a new
7935 * definitive place in the grid.
7937 * @see elm_gengrid_reorder_mode_get()
7941 EAPI void elm_gengrid_reorder_mode_set(Evas_Object *obj, Eina_Bool reorder_mode) EINA_ARG_NONNULL(1);
7944 * Get whether a given gengrid widget is or not able have items
7947 * @param obj The gengrid object
7948 * @return @c EINA_TRUE, if reoderding is on, @c EINA_FALSE if it's
7951 * @see elm_gengrid_reorder_mode_set() for more details
7955 EAPI Eina_Bool elm_gengrid_reorder_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7958 * Append a new item in a given gengrid widget.
7960 * @param obj The gengrid object.
7961 * @param gic The item class for the item.
7962 * @param data The item data.
7963 * @param func Convenience function called when the item is
7965 * @param func_data Data to be passed to @p func.
7966 * @return A handle to the item added or @c NULL, on errors.
7968 * This adds an item to the beginning of the gengrid.
7970 * @see elm_gengrid_item_prepend()
7971 * @see elm_gengrid_item_insert_before()
7972 * @see elm_gengrid_item_insert_after()
7973 * @see elm_gengrid_item_del()
7977 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);
7980 * Prepend a new item in a given gengrid widget.
7982 * @param obj The gengrid object.
7983 * @param gic The item class for the item.
7984 * @param data The item data.
7985 * @param func Convenience function called when the item is
7987 * @param func_data Data to be passed to @p func.
7988 * @return A handle to the item added or @c NULL, on errors.
7990 * This adds an item to the end of the gengrid.
7992 * @see elm_gengrid_item_append()
7993 * @see elm_gengrid_item_insert_before()
7994 * @see elm_gengrid_item_insert_after()
7995 * @see elm_gengrid_item_del()
7999 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);
8002 * Insert an item before another in a gengrid widget
8004 * @param obj The gengrid object.
8005 * @param gic The item class for the item.
8006 * @param data The item data.
8007 * @param relative The item to place this new one before.
8008 * @param func Convenience function called when the item is
8010 * @param func_data Data to be passed to @p func.
8011 * @return A handle to the item added or @c NULL, on errors.
8013 * This inserts an item before another in the gengrid.
8015 * @see elm_gengrid_item_append()
8016 * @see elm_gengrid_item_prepend()
8017 * @see elm_gengrid_item_insert_after()
8018 * @see elm_gengrid_item_del()
8022 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);
8025 * Insert an item after another in a gengrid widget
8027 * @param obj The gengrid object.
8028 * @param gic The item class for the item.
8029 * @param data The item data.
8030 * @param relative The item to place this new one after.
8031 * @param func Convenience function called when the item is
8033 * @param func_data Data to be passed to @p func.
8034 * @return A handle to the item added or @c NULL, on errors.
8036 * This inserts an item after another in the gengrid.
8038 * @see elm_gengrid_item_append()
8039 * @see elm_gengrid_item_prepend()
8040 * @see elm_gengrid_item_insert_after()
8041 * @see elm_gengrid_item_del()
8045 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);
8047 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);
8049 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);
8052 * Set whether items on a given gengrid widget are to get their
8053 * selection callbacks issued for @b every subsequent selection
8054 * click on them or just for the first click.
8056 * @param obj The gengrid object
8057 * @param always_select @c EINA_TRUE to make items "always
8058 * selected", @c EINA_FALSE, otherwise
8060 * By default, grid items will only call their selection callback
8061 * function when firstly getting selected, any subsequent further
8062 * clicks will do nothing. With this call, you make those
8063 * subsequent clicks also to issue the selection callbacks.
8065 * @note <b>Double clicks</b> will @b always be reported on items.
8067 * @see elm_gengrid_always_select_mode_get()
8071 EAPI void elm_gengrid_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
8074 * Get whether items on a given gengrid widget have their selection
8075 * callbacks issued for @b every subsequent selection click on them
8076 * or just for the first click.
8078 * @param obj The gengrid object.
8079 * @return @c EINA_TRUE if the gengrid items are "always selected",
8080 * @c EINA_FALSE, otherwise
8082 * @see elm_gengrid_always_select_mode_set() for more details
8086 EAPI Eina_Bool elm_gengrid_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8089 * Set whether items on a given gengrid widget can be selected or not.
8091 * @param obj The gengrid object
8092 * @param no_select @c EINA_TRUE to make items selectable,
8093 * @c EINA_FALSE otherwise
8095 * This will make items in @p obj selectable or not. In the latter
8096 * case, any user interacion on the gendrid items will neither make
8097 * them appear selected nor them call their selection callback
8100 * @see elm_gengrid_no_select_mode_get()
8104 EAPI void elm_gengrid_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
8107 * Get whether items on a given gengrid widget can be selected or
8110 * @param obj The gengrid object
8111 * @return @c EINA_TRUE, if items are selectable, @c EINA_FALSE
8114 * @see elm_gengrid_no_select_mode_set() for more details
8118 EAPI Eina_Bool elm_gengrid_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8121 * Enable or disable multi-selection in a given gengrid widget
8123 * @param obj The gengrid object.
8124 * @param multi @c EINA_TRUE, to enable multi-selection,
8125 * @c EINA_FALSE to disable it.
8127 * Multi-selection is the ability for one to have @b more than one
8128 * item selected, on a given gengrid, simultaneously. When it is
8129 * enabled, a sequence of clicks on different items will make them
8130 * all selected, progressively. A click on an already selected item
8131 * will unselect it. If interecting via the keyboard,
8132 * multi-selection is enabled while holding the "Shift" key.
8134 * @note By default, multi-selection is @b disabled on gengrids
8136 * @see elm_gengrid_multi_select_get()
8140 EAPI void elm_gengrid_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
8143 * Get whether multi-selection is enabled or disabled for a given
8146 * @param obj The gengrid object.
8147 * @return @c EINA_TRUE, if multi-selection is enabled, @c
8148 * EINA_FALSE otherwise
8150 * @see elm_gengrid_multi_select_set() for more details
8154 EAPI Eina_Bool elm_gengrid_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8157 * Enable or disable bouncing effect for a given gengrid widget
8159 * @param obj The gengrid object
8160 * @param h_bounce @c EINA_TRUE, to enable @b horizontal bouncing,
8161 * @c EINA_FALSE to disable it
8162 * @param v_bounce @c EINA_TRUE, to enable @b vertical bouncing,
8163 * @c EINA_FALSE to disable it
8165 * The bouncing effect occurs whenever one reaches the gengrid's
8166 * edge's while panning it -- it will scroll past its limits a
8167 * little bit and return to the edge again, in a animated for,
8170 * @note By default, gengrids have bouncing enabled on both axis
8172 * @see elm_gengrid_bounce_get()
8176 EAPI void elm_gengrid_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
8179 * Get whether bouncing effects are enabled or disabled, for a
8180 * given gengrid widget, on each axis
8182 * @param obj The gengrid object
8183 * @param h_bounce Pointer to a variable where to store the
8184 * horizontal bouncing flag.
8185 * @param v_bounce Pointer to a variable where to store the
8186 * vertical bouncing flag.
8188 * @see elm_gengrid_bounce_set() for more details
8192 EAPI void elm_gengrid_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
8195 * Set a given gengrid widget's scrolling page size, relative to
8196 * its viewport size.
8198 * @param obj The gengrid object
8199 * @param h_pagerel The horizontal page (relative) size
8200 * @param v_pagerel The vertical page (relative) size
8202 * The gengrid's scroller is capable of binding scrolling by the
8203 * user to "pages". It means that, while scrolling and, specially
8204 * after releasing the mouse button, the grid will @b snap to the
8205 * nearest displaying page's area. When page sizes are set, the
8206 * grid's continuous content area is split into (equal) page sized
8209 * This function sets the size of a page <b>relatively to the
8210 * viewport dimensions</b> of the gengrid, for each axis. A value
8211 * @c 1.0 means "the exact viewport's size", in that axis, while @c
8212 * 0.0 turns paging off in that axis. Likewise, @c 0.5 means "half
8213 * a viewport". Sane usable values are, than, between @c 0.0 and @c
8214 * 1.0. Values beyond those will make it behave behave
8215 * inconsistently. If you only want one axis to snap to pages, use
8216 * the value @c 0.0 for the other one.
8218 * There is a function setting page size values in @b absolute
8219 * values, too -- elm_gengrid_page_size_set(). Naturally, its use
8220 * is mutually exclusive to this one.
8222 * @see elm_gengrid_page_relative_get()
8226 EAPI void elm_gengrid_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel) EINA_ARG_NONNULL(1);
8229 * Get a given gengrid widget's scrolling page size, relative to
8230 * its viewport size.
8232 * @param obj The gengrid object
8233 * @param h_pagerel Pointer to a variable where to store the
8234 * horizontal page (relative) size
8235 * @param v_pagerel Pointer to a variable where to store the
8236 * vertical page (relative) size
8238 * @see elm_gengrid_page_relative_set() for more details
8242 EAPI void elm_gengrid_page_relative_get(const Evas_Object *obj, double *h_pagerel, double *v_pagerel) EINA_ARG_NONNULL(1);
8245 * Set a given gengrid widget's scrolling page size
8247 * @param obj The gengrid object
8248 * @param h_pagerel The horizontal page size, in pixels
8249 * @param v_pagerel The vertical page size, in pixels
8251 * The gengrid's scroller is capable of binding scrolling by the
8252 * user to "pages". It means that, while scrolling and, specially
8253 * after releasing the mouse button, the grid will @b snap to the
8254 * nearest displaying page's area. When page sizes are set, the
8255 * grid's continuous content area is split into (equal) page sized
8258 * This function sets the size of a page of the gengrid, in pixels,
8259 * for each axis. Sane usable values are, between @c 0 and the
8260 * dimensions of @p obj, for each axis. Values beyond those will
8261 * make it behave behave inconsistently. If you only want one axis
8262 * to snap to pages, use the value @c 0 for the other one.
8264 * There is a function setting page size values in @b relative
8265 * values, too -- elm_gengrid_page_relative_set(). Naturally, its
8266 * use is mutually exclusive to this one.
8270 EAPI void elm_gengrid_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize) EINA_ARG_NONNULL(1);
8273 * Set for what direction a given gengrid widget will expand while
8274 * placing its items.
8276 * @param obj The gengrid object.
8277 * @param setting @c EINA_TRUE to make the gengrid expand
8278 * horizontally, @c EINA_FALSE to expand vertically.
8280 * When in "horizontal mode" (@c EINA_TRUE), items will be placed
8281 * in @b columns, from top to bottom and, when the space for a
8282 * column is filled, another one is started on the right, thus
8283 * expanding the grid horizontally. When in "vertical mode"
8284 * (@c EINA_FALSE), though, items will be placed in @b rows, from left
8285 * to right and, when the space for a row is filled, another one is
8286 * started below, thus expanding the grid vertically.
8288 * @see elm_gengrid_horizontal_get()
8292 EAPI void elm_gengrid_horizontal_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
8295 * Get for what direction a given gengrid widget will expand while
8296 * placing its items.
8298 * @param obj The gengrid object.
8299 * @return @c EINA_TRUE, if @p obj is set to expand horizontally,
8300 * @c EINA_FALSE if it's set to expand vertically.
8302 * @see elm_gengrid_horizontal_set() for more detais
8306 EAPI Eina_Bool elm_gengrid_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8309 * Get the first item in a given gengrid widget
8311 * @param obj The gengrid object
8312 * @return The first item's handle or @c NULL, if there are no
8313 * items in @p obj (and on errors)
8315 * This returns the first item in the @p obj's internal list of
8318 * @see elm_gengrid_last_item_get()
8322 EAPI Elm_Gengrid_Item *elm_gengrid_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8325 * Get the last item in a given gengrid widget
8327 * @param obj The gengrid object
8328 * @return The last item's handle or @c NULL, if there are no
8329 * items in @p obj (and on errors)
8331 * This returns the last item in the @p obj's internal list of
8334 * @see elm_gengrid_first_item_get()
8338 EAPI Elm_Gengrid_Item *elm_gengrid_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8341 * Get the @b next item in a gengrid widget's internal list of items,
8342 * given a handle to one of those items.
8344 * @param item The gengrid item to fetch next from
8345 * @return The item after @p item, or @c NULL if there's none (and
8348 * This returns the item placed after the @p item, on the container
8351 * @see elm_gengrid_item_prev_get()
8355 EAPI Elm_Gengrid_Item *elm_gengrid_item_next_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8358 * Get the @b previous item in a gengrid widget's internal list of items,
8359 * given a handle to one of those items.
8361 * @param item The gengrid item to fetch previous from
8362 * @return The item before @p item, or @c NULL if there's none (and
8365 * This returns the item placed before the @p item, on the container
8368 * @see elm_gengrid_item_next_get()
8372 EAPI Elm_Gengrid_Item *elm_gengrid_item_prev_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8375 * Get the gengrid object's handle which contains a given gengrid
8378 * @param item The item to fetch the container from
8379 * @return The gengrid (parent) object
8381 * This returns the gengrid object itself that an item belongs to.
8385 EAPI Evas_Object *elm_gengrid_item_gengrid_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8388 * Remove a gengrid item from the its parent, deleting it.
8390 * @param item The item to be removed.
8391 * @return @c EINA_TRUE on success or @c EINA_FALSE, otherwise.
8393 * @see elm_gengrid_clear(), to remove all items in a gengrid at
8398 EAPI void elm_gengrid_item_del(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8401 * Update the contents of a given gengrid item
8403 * @param item The gengrid item
8405 * This updates an item by calling all the item class functions
8406 * again to get the icons, labels and states. Use this when the
8407 * original item data has changed and you want thta changes to be
8412 EAPI void elm_gengrid_item_update(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8413 EAPI const Elm_Gengrid_Item_Class *elm_gengrid_item_item_class_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8414 EAPI void elm_gengrid_item_item_class_set(Elm_Gengrid_Item *item, const Elm_Gengrid_Item_Class *gic) EINA_ARG_NONNULL(1, 2);
8417 * Return the data associated to a given gengrid item
8419 * @param item The gengrid item.
8420 * @return the data associated to this item.
8422 * This returns the @c data value passed on the
8423 * elm_gengrid_item_append() and related item addition calls.
8425 * @see elm_gengrid_item_append()
8426 * @see elm_gengrid_item_data_set()
8430 EAPI void *elm_gengrid_item_data_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8433 * Set the data associated to a given gengrid item
8435 * @param item The gengrid item
8436 * @param data The new data pointer to set on it
8438 * This @b overrides the @c data value passed on the
8439 * elm_gengrid_item_append() and related item addition calls. This
8440 * function @b won't call elm_gengrid_item_update() automatically,
8441 * so you'd issue it afterwards if you want to hove the item
8442 * updated to reflect the that new data.
8444 * @see elm_gengrid_item_data_get()
8448 EAPI void elm_gengrid_item_data_set(Elm_Gengrid_Item *item, const void *data) EINA_ARG_NONNULL(1);
8451 * Get a given gengrid item's position, relative to the whole
8452 * gengrid's grid area.
8454 * @param item The Gengrid item.
8455 * @param x Pointer to variable where to store the item's <b>row
8457 * @param y Pointer to variable where to store the item's <b>column
8460 * This returns the "logical" position of the item whithin the
8461 * gengrid. For example, @c (0, 1) would stand for first row,
8466 EAPI void elm_gengrid_item_pos_get(const Elm_Gengrid_Item *item, unsigned int *x, unsigned int *y) EINA_ARG_NONNULL(1);
8469 * Set whether a given gengrid item is selected or not
8471 * @param item The gengrid item
8472 * @param selected Use @c EINA_TRUE, to make it selected, @c
8473 * EINA_FALSE to make it unselected
8475 * This sets the selected state of an item. If multi selection is
8476 * not enabled on the containing gengrid and @p selected is @c
8477 * EINA_TRUE, any other previously selected items will get
8478 * unselected in favor of this new one.
8480 * @see elm_gengrid_item_selected_get()
8484 EAPI void elm_gengrid_item_selected_set(Elm_Gengrid_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
8487 * Get whether a given gengrid item is selected or not
8489 * @param item The gengrid item
8490 * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
8492 * @see elm_gengrid_item_selected_set() for more details
8496 EAPI Eina_Bool elm_gengrid_item_selected_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8499 * Get the real Evas object created to implement the view of a
8500 * given gengrid item
8502 * @param item The gengrid item.
8503 * @return the Evas object implementing this item's view.
8505 * This returns the actual Evas object used to implement the
8506 * specified gengrid item's view. This may be @c NULL, as it may
8507 * not have been created or may have been deleted, at any time, by
8508 * the gengrid. <b>Do not modify this object</b> (move, resize,
8509 * show, hide, etc.), as the gengrid is controlling it. This
8510 * function is for querying, emitting custom signals or hooking
8511 * lower level callbacks for events on that object. Do not delete
8512 * this object under any circumstances.
8514 * @see elm_gengrid_item_data_get()
8518 EAPI const Evas_Object *elm_gengrid_item_object_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8521 * Show the portion of a gengrid's internal grid containing a given
8522 * item, @b immediately.
8524 * @param item The item to display
8526 * This causes gengrid to @b redraw its viewport's contents to the
8527 * region contining the given @p item item, if it is not fully
8530 * @see elm_gengrid_item_bring_in()
8534 EAPI void elm_gengrid_item_show(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8537 * Animatedly bring in, to the visible are of a gengrid, a given
8540 * @param item The gengrid item to display
8542 * This causes gengrig to jump to the given @p item item and show
8543 * it (by scrolling), if it is not fully visible. This will use
8544 * animation to do so and take a period of time to complete.
8546 * @see elm_gengrid_item_show()
8550 EAPI void elm_gengrid_item_bring_in(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8553 * Set whether a given gengrid item is disabled or not.
8555 * @param item The gengrid item
8556 * @param disabled Use @c EINA_TRUE, true disable it, @c EINA_FALSE
8557 * to enable it back.
8559 * A disabled item cannot be selected or unselected. It will also
8560 * change its appearance, to signal the user it's disabled.
8562 * @see elm_gengrid_item_disabled_get()
8566 EAPI void elm_gengrid_item_disabled_set(Elm_Gengrid_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
8569 * Get whether a given gengrid item is disabled or not.
8571 * @param item The gengrid item
8572 * @return @c EINA_TRUE, if it's disabled, @c EINA_FALSE otherwise
8575 * @see elm_gengrid_item_disabled_set() for more details
8579 EAPI Eina_Bool elm_gengrid_item_disabled_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8582 * Set the text to be shown in a given gengrid item's tooltips.
8584 * @param item The gengrid item
8585 * @param text The text to set in the content
8587 * This call will setup the text to be used as tooltip to that item
8588 * (analogous to elm_object_tooltip_text_set(), but being item
8589 * tooltips with higher precedence than object tooltips). It can
8590 * have only one tooltip at a time, so any previous tooltip data
8595 EAPI void elm_gengrid_item_tooltip_text_set(Elm_Gengrid_Item *item, const char *text) EINA_ARG_NONNULL(1);
8598 * Set the content to be shown in a given gengrid item's tooltips
8600 * @param item The gengrid item.
8601 * @param func The function returning the tooltip contents.
8602 * @param data What to provide to @a func as callback data/context.
8603 * @param del_cb Called when data is not needed anymore, either when
8604 * another callback replaces @p func, the tooltip is unset with
8605 * elm_gengrid_item_tooltip_unset() or the owner @p item
8606 * dies. This callback receives as its first parameter the
8607 * given @p data, being @c event_info the item handle.
8609 * This call will setup the tooltip's contents to @p item
8610 * (analogous to elm_object_tooltip_content_cb_set(), but being
8611 * item tooltips with higher precedence than object tooltips). It
8612 * can have only one tooltip at a time, so any previous tooltip
8613 * content will get removed. @p func (with @p data) will be called
8614 * every time Elementary needs to show the tooltip and it should
8615 * return a valid Evas object, which will be fully managed by the
8616 * tooltip system, getting deleted when the tooltip is gone.
8620 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);
8623 * Unset a tooltip from a given gengrid item
8625 * @param item gengrid item to remove a previously set tooltip from.
8627 * This call removes any tooltip set on @p item. The callback
8628 * provided as @c del_cb to
8629 * elm_gengrid_item_tooltip_content_cb_set() will be called to
8630 * notify it is not used anymore (and have resources cleaned, if
8633 * @see elm_gengrid_item_tooltip_content_cb_set()
8637 EAPI void elm_gengrid_item_tooltip_unset(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8640 * Set a different @b style for a given gengrid item's tooltip.
8642 * @param item gengrid item with tooltip set
8643 * @param style the <b>theme style</b> to use on tooltips (e.g. @c
8644 * "default", @c "transparent", etc)
8646 * Tooltips can have <b>alternate styles</b> to be displayed on,
8647 * which are defined by the theme set on Elementary. This function
8648 * works analogously as elm_object_tooltip_style_set(), but here
8649 * applied only to gengrid item objects. The default style for
8650 * tooltips is @c "default".
8652 * @note before you set a style you should define a tooltip with
8653 * elm_gengrid_item_tooltip_content_cb_set() or
8654 * elm_gengrid_item_tooltip_text_set()
8656 * @see elm_gengrid_item_tooltip_style_get()
8660 EAPI void elm_gengrid_item_tooltip_style_set(Elm_Gengrid_Item *item, const char *style) EINA_ARG_NONNULL(1);
8663 * Get the style set a given gengrid item's tooltip.
8665 * @param item gengrid item with tooltip already set on.
8666 * @return style the theme style in use, which defaults to
8667 * "default". If the object does not have a tooltip set,
8668 * then @c NULL is returned.
8670 * @see elm_gengrid_item_tooltip_style_set() for more details
8674 EAPI const char *elm_gengrid_item_tooltip_style_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8676 * @brief Disable size restrictions on an object's tooltip
8677 * @param item The tooltip's anchor object
8678 * @param disable If EINA_TRUE, size restrictions are disabled
8679 * @return EINA_FALSE on failure, EINA_TRUE on success
8681 * This function allows a tooltip to expand beyond its parant window's canvas.
8682 * It will instead be limited only by the size of the display.
8684 EAPI Eina_Bool elm_gengrid_item_tooltip_size_restrict_disable(Elm_Gengrid_Item *item, Eina_Bool disable);
8686 * @brief Retrieve size restriction state of an object's tooltip
8687 * @param item The tooltip's anchor object
8688 * @return If EINA_TRUE, size restrictions are disabled
8690 * This function returns whether a tooltip is allowed to expand beyond
8691 * its parant window's canvas.
8692 * It will instead be limited only by the size of the display.
8694 EAPI Eina_Bool elm_gengrid_item_tooltip_size_restrict_disabled_get(const Elm_Gengrid_Item *item);
8696 * Set the type of mouse pointer/cursor decoration to be shown,
8697 * when the mouse pointer is over the given gengrid widget item
8699 * @param item gengrid item to customize cursor on
8700 * @param cursor the cursor type's name
8702 * This function works analogously as elm_object_cursor_set(), but
8703 * here the cursor's changing area is restricted to the item's
8704 * area, and not the whole widget's. Note that that item cursors
8705 * have precedence over widget cursors, so that a mouse over @p
8706 * item will always show cursor @p type.
8708 * If this function is called twice for an object, a previously set
8709 * cursor will be unset on the second call.
8711 * @see elm_object_cursor_set()
8712 * @see elm_gengrid_item_cursor_get()
8713 * @see elm_gengrid_item_cursor_unset()
8717 EAPI void elm_gengrid_item_cursor_set(Elm_Gengrid_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
8720 * Get the type of mouse pointer/cursor decoration set to be shown,
8721 * when the mouse pointer is over the given gengrid widget item
8723 * @param item gengrid item with custom cursor set
8724 * @return the cursor type's name or @c NULL, if no custom cursors
8725 * were set to @p item (and on errors)
8727 * @see elm_object_cursor_get()
8728 * @see elm_gengrid_item_cursor_set() for more details
8729 * @see elm_gengrid_item_cursor_unset()
8733 EAPI const char *elm_gengrid_item_cursor_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8736 * Unset any custom mouse pointer/cursor decoration set to be
8737 * shown, when the mouse pointer is over the given gengrid widget
8738 * item, thus making it show the @b default cursor again.
8740 * @param item a gengrid item
8742 * Use this call to undo any custom settings on this item's cursor
8743 * decoration, bringing it back to defaults (no custom style set).
8745 * @see elm_object_cursor_unset()
8746 * @see elm_gengrid_item_cursor_set() for more details
8750 EAPI void elm_gengrid_item_cursor_unset(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8753 * Set a different @b style for a given custom cursor set for a
8756 * @param item gengrid item with custom cursor set
8757 * @param style the <b>theme style</b> to use (e.g. @c "default",
8758 * @c "transparent", etc)
8760 * This function only makes sense when one is using custom mouse
8761 * cursor decorations <b>defined in a theme file</b> , which can
8762 * have, given a cursor name/type, <b>alternate styles</b> on
8763 * it. It works analogously as elm_object_cursor_style_set(), but
8764 * here applied only to gengrid item objects.
8766 * @warning Before you set a cursor style you should have defined a
8767 * custom cursor previously on the item, with
8768 * elm_gengrid_item_cursor_set()
8770 * @see elm_gengrid_item_cursor_engine_only_set()
8771 * @see elm_gengrid_item_cursor_style_get()
8775 EAPI void elm_gengrid_item_cursor_style_set(Elm_Gengrid_Item *item, const char *style) EINA_ARG_NONNULL(1);
8778 * Get the current @b style set for a given gengrid item's custom
8781 * @param item gengrid item with custom cursor set.
8782 * @return style the cursor style in use. If the object does not
8783 * have a cursor set, then @c NULL is returned.
8785 * @see elm_gengrid_item_cursor_style_set() for more details
8789 EAPI const char *elm_gengrid_item_cursor_style_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8792 * Set if the (custom) cursor for a given gengrid item should be
8793 * searched in its theme, also, or should only rely on the
8796 * @param item item with custom (custom) cursor already set on
8797 * @param engine_only Use @c EINA_TRUE to have cursors looked for
8798 * only on those provided by the rendering engine, @c EINA_FALSE to
8799 * have them searched on the widget's theme, as well.
8801 * @note This call is of use only if you've set a custom cursor
8802 * for gengrid items, with elm_gengrid_item_cursor_set().
8804 * @note By default, cursors will only be looked for between those
8805 * provided by the rendering engine.
8809 EAPI void elm_gengrid_item_cursor_engine_only_set(Elm_Gengrid_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
8812 * Get if the (custom) cursor for a given gengrid item is being
8813 * searched in its theme, also, or is only relying on the rendering
8816 * @param item a gengrid item
8817 * @return @c EINA_TRUE, if cursors are being looked for only on
8818 * those provided by the rendering engine, @c EINA_FALSE if they
8819 * are being searched on the widget's theme, as well.
8821 * @see elm_gengrid_item_cursor_engine_only_set(), for more details
8825 EAPI Eina_Bool elm_gengrid_item_cursor_engine_only_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8828 * Remove all items from a given gengrid widget
8830 * @param obj The gengrid object.
8832 * This removes (and deletes) all items in @p obj, leaving it
8835 * @see elm_gengrid_item_del(), to remove just one item.
8839 EAPI void elm_gengrid_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
8842 * Get the selected item in a given gengrid widget
8844 * @param obj The gengrid object.
8845 * @return The selected item's handleor @c NULL, if none is
8846 * selected at the moment (and on errors)
8848 * This returns the selected item in @p obj. If multi selection is
8849 * enabled on @p obj (@see elm_gengrid_multi_select_set()), only
8850 * the first item in the list is selected, which might not be very
8851 * useful. For that case, see elm_gengrid_selected_items_get().
8855 EAPI Elm_Gengrid_Item *elm_gengrid_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8858 * Get <b>a list</b> of selected items in a given gengrid
8860 * @param obj The gengrid object.
8861 * @return The list of selected items or @c NULL, if none is
8862 * selected at the moment (and on errors)
8864 * This returns a list of the selected items, in the order that
8865 * they appear in the grid. This list is only valid as long as no
8866 * more items are selected or unselected (or unselected implictly
8867 * by deletion). The list contains #Elm_Gengrid_Item pointers as
8870 * @see elm_gengrid_selected_item_get()
8874 EAPI const Eina_List *elm_gengrid_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8881 * @defgroup Clock Clock
8883 * @image html img/widget/clock/preview-00.png
8884 * @image latex img/widget/clock/preview-00.eps
8886 * This is a @b digital clock widget. In its default theme, it has a
8887 * vintage "flipping numbers clock" appearance, which will animate
8888 * sheets of individual algarisms individually as time goes by.
8890 * A newly created clock will fetch system's time (already
8891 * considering local time adjustments) to start with, and will tick
8892 * accondingly. It may or may not show seconds.
8894 * Clocks have an @b edition mode. When in it, the sheets will
8895 * display extra arrow indications on the top and bottom and the
8896 * user may click on them to raise or lower the time values. After
8897 * it's told to exit edition mode, it will keep ticking with that
8898 * new time set (it keeps the difference from local time).
8900 * Also, when under edition mode, user clicks on the cited arrows
8901 * which are @b held for some time will make the clock to flip the
8902 * sheet, thus editing the time, continuosly and automatically for
8903 * the user. The interval between sheet flips will keep growing in
8904 * time, so that it helps the user to reach a time which is distant
8907 * The time display is, by default, in military mode (24h), but an
8908 * am/pm indicator may be optionally shown, too, when it will
8911 * Smart callbacks one can register to:
8912 * - "changed" - the clock's user changed the time
8914 * Here is an example on its usage:
8915 * @li @ref clock_example
8924 * Identifiers for which clock digits should be editable, when a
8925 * clock widget is in edition mode. Values may be ORed together to
8926 * make a mask, naturally.
8928 * @see elm_clock_edit_set()
8929 * @see elm_clock_digit_edit_set()
8931 typedef enum _Elm_Clock_Digedit
8933 ELM_CLOCK_NONE = 0, /**< Default value. Means that all digits are editable, when in edition mode. */
8934 ELM_CLOCK_HOUR_DECIMAL = 1 << 0, /**< Decimal algarism of hours value should be editable */
8935 ELM_CLOCK_HOUR_UNIT = 1 << 1, /**< Unit algarism of hours value should be editable */
8936 ELM_CLOCK_MIN_DECIMAL = 1 << 2, /**< Decimal algarism of minutes value should be editable */
8937 ELM_CLOCK_MIN_UNIT = 1 << 3, /**< Unit algarism of minutes value should be editable */
8938 ELM_CLOCK_SEC_DECIMAL = 1 << 4, /**< Decimal algarism of seconds value should be editable */
8939 ELM_CLOCK_SEC_UNIT = 1 << 5, /**< Unit algarism of seconds value should be editable */
8940 ELM_CLOCK_ALL = (1 << 6) - 1 /**< All digits should be editable */
8941 } Elm_Clock_Digedit;
8944 * Add a new clock widget to the given parent Elementary
8945 * (container) object
8947 * @param parent The parent object
8948 * @return a new clock widget handle or @c NULL, on errors
8950 * This function inserts a new clock widget on the canvas.
8954 EAPI Evas_Object *elm_clock_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
8957 * Set a clock widget's time, programmatically
8959 * @param obj The clock widget object
8960 * @param hrs The hours to set
8961 * @param min The minutes to set
8962 * @param sec The secondes to set
8964 * This function updates the time that is showed by the clock
8967 * Values @b must be set within the following ranges:
8968 * - 0 - 23, for hours
8969 * - 0 - 59, for minutes
8970 * - 0 - 59, for seconds,
8972 * even if the clock is not in "military" mode.
8974 * @warning The behavior for values set out of those ranges is @b
8979 EAPI void elm_clock_time_set(Evas_Object *obj, int hrs, int min, int sec) EINA_ARG_NONNULL(1);
8982 * Get a clock widget's time values
8984 * @param obj The clock object
8985 * @param[out] hrs Pointer to the variable to get the hours value
8986 * @param[out] min Pointer to the variable to get the minutes value
8987 * @param[out] sec Pointer to the variable to get the seconds value
8989 * This function gets the time set for @p obj, returning
8990 * it on the variables passed as the arguments to function
8992 * @note Use @c NULL pointers on the time values you're not
8993 * interested in: they'll be ignored by the function.
8997 EAPI void elm_clock_time_get(const Evas_Object *obj, int *hrs, int *min, int *sec) EINA_ARG_NONNULL(1);
9000 * Set whether a given clock widget is under <b>edition mode</b> or
9001 * under (default) displaying-only mode.
9003 * @param obj The clock object
9004 * @param edit @c EINA_TRUE to put it in edition, @c EINA_FALSE to
9005 * put it back to "displaying only" mode
9007 * This function makes a clock's time to be editable or not <b>by
9008 * user interaction</b>. When in edition mode, clocks @b stop
9009 * ticking, until one brings them back to canonical mode. The
9010 * elm_clock_digit_edit_set() function will influence which digits
9011 * of the clock will be editable. By default, all of them will be
9012 * (#ELM_CLOCK_NONE).
9014 * @note am/pm sheets, if being shown, will @b always be editable
9015 * under edition mode.
9017 * @see elm_clock_edit_get()
9021 EAPI void elm_clock_edit_set(Evas_Object *obj, Eina_Bool edit) EINA_ARG_NONNULL(1);
9024 * Retrieve whether a given clock widget is under <b>edition
9025 * mode</b> or under (default) displaying-only mode.
9027 * @param obj The clock object
9028 * @param edit @c EINA_TRUE, if it's in edition mode, @c EINA_FALSE
9031 * This function retrieves whether the clock's time can be edited
9032 * or not by user interaction.
9034 * @see elm_clock_edit_set() for more details
9038 EAPI Eina_Bool elm_clock_edit_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9041 * Set what digits of the given clock widget should be editable
9042 * when in edition mode.
9044 * @param obj The clock object
9045 * @param digedit Bit mask indicating the digits to be editable
9046 * (values in #Elm_Clock_Digedit).
9048 * If the @p digedit param is #ELM_CLOCK_NONE, editing will be
9049 * disabled on @p obj (same effect as elm_clock_edit_set(), with @c
9052 * @see elm_clock_digit_edit_get()
9056 EAPI void elm_clock_digit_edit_set(Evas_Object *obj, Elm_Clock_Digedit digedit) EINA_ARG_NONNULL(1);
9059 * Retrieve what digits of the given clock widget should be
9060 * editable when in edition mode.
9062 * @param obj The clock object
9063 * @return Bit mask indicating the digits to be editable
9064 * (values in #Elm_Clock_Digedit).
9066 * @see elm_clock_digit_edit_set() for more details
9070 EAPI Elm_Clock_Digedit elm_clock_digit_edit_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9073 * Set if the given clock widget must show hours in military or
9076 * @param obj The clock object
9077 * @param am_pm @c EINA_TRUE to put it in am/pm mode, @c EINA_FALSE
9080 * This function sets if the clock must show hours in military or
9081 * am/pm mode. In some countries like Brazil the military mode
9082 * (00-24h-format) is used, in opposition to the USA, where the
9083 * am/pm mode is more commonly used.
9085 * @see elm_clock_show_am_pm_get()
9089 EAPI void elm_clock_show_am_pm_set(Evas_Object *obj, Eina_Bool am_pm) EINA_ARG_NONNULL(1);
9092 * Get if the given clock widget shows hours in military or am/pm
9095 * @param obj The clock object
9096 * @return @c EINA_TRUE, if in am/pm mode, @c EINA_FALSE if in
9099 * This function gets if the clock shows hours in military or am/pm
9102 * @see elm_clock_show_am_pm_set() for more details
9106 EAPI Eina_Bool elm_clock_show_am_pm_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9109 * Set if the given clock widget must show time with seconds or not
9111 * @param obj The clock object
9112 * @param seconds @c EINA_TRUE to show seconds, @c EINA_FALSE otherwise
9114 * This function sets if the given clock must show or not elapsed
9115 * seconds. By default, they are @b not shown.
9117 * @see elm_clock_show_seconds_get()
9121 EAPI void elm_clock_show_seconds_set(Evas_Object *obj, Eina_Bool seconds) EINA_ARG_NONNULL(1);
9124 * Get whether the given clock widget is showing time with seconds
9127 * @param obj The clock object
9128 * @return @c EINA_TRUE if it's showing seconds, @c EINA_FALSE otherwise
9130 * This function gets whether @p obj is showing or not the elapsed
9133 * @see elm_clock_show_seconds_set()
9137 EAPI Eina_Bool elm_clock_show_seconds_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9140 * Set the interval on time updates for an user mouse button hold
9141 * on clock widgets' time edition.
9143 * @param obj The clock object
9144 * @param interval The (first) interval value in seconds
9146 * This interval value is @b decreased while the user holds the
9147 * mouse pointer either incrementing or decrementing a given the
9148 * clock digit's value.
9150 * This helps the user to get to a given time distant from the
9151 * current one easier/faster, as it will start to flip quicker and
9152 * quicker on mouse button holds.
9154 * The calculation for the next flip interval value, starting from
9155 * the one set with this call, is the previous interval divided by
9156 * 1.05, so it decreases a little bit.
9158 * The default starting interval value for automatic flips is
9161 * @see elm_clock_interval_get()
9165 EAPI void elm_clock_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
9168 * Get the interval on time updates for an user mouse button hold
9169 * on clock widgets' time edition.
9171 * @param obj The clock object
9172 * @return The (first) interval value, in seconds, set on it
9174 * @see elm_clock_interval_set() for more details
9178 EAPI double elm_clock_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9185 * @defgroup Layout Layout
9187 * @image html img/widget/layout/preview-00.png
9188 * @image latex img/widget/layout/preview-00.eps width=\textwidth
9190 * @image html img/layout-predefined.png
9191 * @image latex img/layout-predefined.eps width=\textwidth
9193 * This is a container widget that takes a standard Edje design file and
9194 * wraps it very thinly in a widget.
9196 * An Edje design (theme) file has a very wide range of possibilities to
9197 * describe the behavior of elements added to the Layout. Check out the Edje
9198 * documentation and the EDC reference to get more information about what can
9199 * be done with Edje.
9201 * Just like @ref List, @ref Box, and other container widgets, any
9202 * object added to the Layout will become its child, meaning that it will be
9203 * deleted if the Layout is deleted, move if the Layout is moved, and so on.
9205 * The Layout widget can contain as many Contents, Boxes or Tables as
9206 * described in its theme file. For instance, objects can be added to
9207 * different Tables by specifying the respective Table part names. The same
9208 * is valid for Content and Box.
9210 * The objects added as child of the Layout will behave as described in the
9211 * part description where they were added. There are 3 possible types of
9212 * parts where a child can be added:
9214 * @section secContent Content (SWALLOW part)
9216 * Only one object can be added to the @c SWALLOW part (but you still can
9217 * have many @c SWALLOW parts and one object on each of them). Use the @c
9218 * elm_layout_content_* set of functions to set, retrieve and unset objects
9219 * as content of the @c SWALLOW. After being set to this part, the object
9220 * size, position, visibility, clipping and other description properties
9221 * will be totally controled by the description of the given part (inside
9222 * the Edje theme file).
9224 * One can use @c evas_object_size_hint_* functions on the child to have some
9225 * kind of control over its behavior, but the resulting behavior will still
9226 * depend heavily on the @c SWALLOW part description.
9228 * The Edje theme also can change the part description, based on signals or
9229 * scripts running inside the theme. This change can also be animated. All of
9230 * this will affect the child object set as content accordingly. The object
9231 * size will be changed if the part size is changed, it will animate move if
9232 * the part is moving, and so on.
9234 * The following picture demonstrates a Layout widget with a child object
9235 * added to its @c SWALLOW:
9237 * @image html layout_swallow.png
9238 * @image latex layout_swallow.eps width=\textwidth
9240 * @section secBox Box (BOX part)
9242 * An Edje @c BOX part is very similar to the Elementary @ref Box widget. It
9243 * allows one to add objects to the box and have them distributed along its
9244 * area, accordingly to the specified @a layout property (now by @a layout we
9245 * mean the chosen layouting design of the Box, not the Layout widget
9248 * A similar effect for having a box with its position, size and other things
9249 * controled by the Layout theme would be to create an Elementary @ref Box
9250 * widget and add it as a Content in the @c SWALLOW part.
9252 * The main difference of using the Layout Box is that its behavior, the box
9253 * properties like layouting format, padding, align, etc. will be all
9254 * controled by the theme. This means, for example, that a signal could be
9255 * sent to the Layout theme (with elm_object_signal_emit()) and the theme
9256 * handled the signal by changing the box padding, or align, or both. Using
9257 * the Elementary @ref Box widget is not necessarily harder or easier, it
9258 * just depends on the circunstances and requirements.
9260 * The Layout Box can be used through the @c elm_layout_box_* set of
9263 * The following picture demonstrates a Layout widget with many child objects
9264 * added to its @c BOX part:
9266 * @image html layout_box.png
9267 * @image latex layout_box.eps width=\textwidth
9269 * @section secTable Table (TABLE part)
9271 * Just like the @ref secBox, the Layout Table is very similar to the
9272 * Elementary @ref Table widget. It allows one to add objects to the Table
9273 * specifying the row and column where the object should be added, and any
9274 * column or row span if necessary.
9276 * Again, we could have this design by adding a @ref Table widget to the @c
9277 * SWALLOW part using elm_layout_content_set(). The same difference happens
9278 * here when choosing to use the Layout Table (a @c TABLE part) instead of
9279 * the @ref Table plus @c SWALLOW part. It's just a matter of convenience.
9281 * The Layout Table can be used through the @c elm_layout_table_* set of
9284 * The following picture demonstrates a Layout widget with many child objects
9285 * added to its @c TABLE part:
9287 * @image html layout_table.png
9288 * @image latex layout_table.eps width=\textwidth
9290 * @section secPredef Predefined Layouts
9292 * Another interesting thing about the Layout widget is that it offers some
9293 * predefined themes that come with the default Elementary theme. These
9294 * themes can be set by the call elm_layout_theme_set(), and provide some
9295 * basic functionality depending on the theme used.
9297 * Most of them already send some signals, some already provide a toolbar or
9298 * back and next buttons.
9300 * These are available predefined theme layouts. All of them have class = @c
9301 * layout, group = @c application, and style = one of the following options:
9303 * @li @c toolbar-content - application with toolbar and main content area
9304 * @li @c toolbar-content-back - application with toolbar and main content
9305 * area with a back button and title area
9306 * @li @c toolbar-content-back-next - application with toolbar and main
9307 * content area with a back and next buttons and title area
9308 * @li @c content-back - application with a main content area with a back
9309 * button and title area
9310 * @li @c content-back-next - application with a main content area with a
9311 * back and next buttons and title area
9312 * @li @c toolbar-vbox - application with toolbar and main content area as a
9314 * @li @c toolbar-table - application with toolbar and main content area as a
9317 * @section secExamples Examples
9319 * Some examples of the Layout widget can be found here:
9320 * @li @ref layout_example_01
9321 * @li @ref layout_example_02
9322 * @li @ref layout_example_03
9323 * @li @ref layout_example_edc
9328 * Add a new layout to the parent
9330 * @param parent The parent object
9331 * @return The new object or NULL if it cannot be created
9333 * @see elm_layout_file_set()
9334 * @see elm_layout_theme_set()
9338 EAPI Evas_Object *elm_layout_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
9340 * Set the file that will be used as layout
9342 * @param obj The layout object
9343 * @param file The path to file (edj) that will be used as layout
9344 * @param group The group that the layout belongs in edje file
9346 * @return (1 = success, 0 = error)
9350 EAPI Eina_Bool elm_layout_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1);
9352 * Set the edje group from the elementary theme that will be used as layout
9354 * @param obj The layout object
9355 * @param clas the clas of the group
9356 * @param group the group
9357 * @param style the style to used
9359 * @return (1 = success, 0 = error)
9363 EAPI Eina_Bool elm_layout_theme_set(Evas_Object *obj, const char *clas, const char *group, const char *style) EINA_ARG_NONNULL(1);
9365 * Set the layout content.
9367 * @param obj The layout object
9368 * @param swallow The swallow part name in the edje file
9369 * @param content The child that will be added in this layout object
9371 * Once the content object is set, a previously set one will be deleted.
9372 * If you want to keep that old content object, use the
9373 * elm_layout_content_unset() function.
9375 * @note In an Edje theme, the part used as a content container is called @c
9376 * SWALLOW. This is why the parameter name is called @p swallow, but it is
9377 * expected to be a part name just like the second parameter of
9378 * elm_layout_box_append().
9380 * @see elm_layout_box_append()
9381 * @see elm_layout_content_get()
9382 * @see elm_layout_content_unset()
9387 EAPI void elm_layout_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content) EINA_ARG_NONNULL(1);
9389 * Get the child object in the given content part.
9391 * @param obj The layout object
9392 * @param swallow The SWALLOW part to get its content
9394 * @return The swallowed object or NULL if none or an error occurred
9396 * @see elm_layout_content_set()
9400 EAPI Evas_Object *elm_layout_content_get(const Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
9402 * Unset the layout content.
9404 * @param obj The layout object
9405 * @param swallow The swallow part name in the edje file
9406 * @return The content that was being used
9408 * Unparent and return the content object which was set for this part.
9410 * @see elm_layout_content_set()
9414 EAPI Evas_Object *elm_layout_content_unset(Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
9416 * Set the text of the given part
9418 * @param obj The layout object
9419 * @param part The TEXT part where to set the text
9420 * @param text The text to set
9423 * @deprecated use elm_object_text_* instead.
9425 EINA_DEPRECATED EAPI void elm_layout_text_set(Evas_Object *obj, const char *part, const char *text) EINA_ARG_NONNULL(1);
9427 * Get the text set in the given part
9429 * @param obj The layout object
9430 * @param part The TEXT part to retrieve the text off
9432 * @return The text set in @p part
9435 * @deprecated use elm_object_text_* instead.
9437 EINA_DEPRECATED EAPI const char *elm_layout_text_get(const Evas_Object *obj, const char *part) EINA_ARG_NONNULL(1);
9439 * Append child to layout box part.
9441 * @param obj the layout object
9442 * @param part the box part to which the object will be appended.
9443 * @param child the child object to append to box.
9445 * Once the object is appended, it will become child of the layout. Its
9446 * lifetime will be bound to the layout, whenever the layout dies the child
9447 * will be deleted automatically. One should use elm_layout_box_remove() to
9448 * make this layout forget about the object.
9450 * @see elm_layout_box_prepend()
9451 * @see elm_layout_box_insert_before()
9452 * @see elm_layout_box_insert_at()
9453 * @see elm_layout_box_remove()
9457 EAPI void elm_layout_box_append(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1);
9459 * Prepend child to layout box part.
9461 * @param obj the layout object
9462 * @param part the box part to prepend.
9463 * @param child the child object to prepend to box.
9465 * Once the object is prepended, it will become child of the layout. Its
9466 * lifetime will be bound to the layout, whenever the layout dies the child
9467 * will be deleted automatically. One should use elm_layout_box_remove() to
9468 * make this layout forget about the object.
9470 * @see elm_layout_box_append()
9471 * @see elm_layout_box_insert_before()
9472 * @see elm_layout_box_insert_at()
9473 * @see elm_layout_box_remove()
9477 EAPI void elm_layout_box_prepend(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1);
9479 * Insert child to layout box part before a reference object.
9481 * @param obj the layout object
9482 * @param part the box part to insert.
9483 * @param child the child object to insert into box.
9484 * @param reference another reference object to insert before in box.
9486 * Once the object is inserted, it will become child of the layout. Its
9487 * lifetime will be bound to the layout, whenever the layout dies the child
9488 * will be deleted automatically. One should use elm_layout_box_remove() to
9489 * make this layout forget about the object.
9491 * @see elm_layout_box_append()
9492 * @see elm_layout_box_prepend()
9493 * @see elm_layout_box_insert_before()
9494 * @see elm_layout_box_remove()
9498 EAPI void elm_layout_box_insert_before(Evas_Object *obj, const char *part, Evas_Object *child, const Evas_Object *reference) EINA_ARG_NONNULL(1);
9500 * Insert child to layout box part at a given position.
9502 * @param obj the layout object
9503 * @param part the box part to insert.
9504 * @param child the child object to insert into box.
9505 * @param pos the numeric position >=0 to insert the child.
9507 * Once the object is inserted, it will become child of the layout. Its
9508 * lifetime will be bound to the layout, whenever the layout dies the child
9509 * will be deleted automatically. One should use elm_layout_box_remove() to
9510 * make this layout forget about the object.
9512 * @see elm_layout_box_append()
9513 * @see elm_layout_box_prepend()
9514 * @see elm_layout_box_insert_before()
9515 * @see elm_layout_box_remove()
9519 EAPI void elm_layout_box_insert_at(Evas_Object *obj, const char *part, Evas_Object *child, unsigned int pos) EINA_ARG_NONNULL(1);
9521 * Remove a child of the given part box.
9523 * @param obj The layout object
9524 * @param part The box part name to remove child.
9525 * @param child The object to remove from box.
9526 * @return The object that was being used, or NULL if not found.
9528 * The object will be removed from the box part and its lifetime will
9529 * not be handled by the layout anymore. This is equivalent to
9530 * elm_layout_content_unset() for box.
9532 * @see elm_layout_box_append()
9533 * @see elm_layout_box_remove_all()
9537 EAPI Evas_Object *elm_layout_box_remove(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1, 2, 3);
9539 * Remove all child of the given part box.
9541 * @param obj The layout object
9542 * @param part The box part name to remove child.
9543 * @param clear If EINA_TRUE, then all objects will be deleted as
9544 * well, otherwise they will just be removed and will be
9545 * dangling on the canvas.
9547 * The objects will be removed from the box part and their lifetime will
9548 * not be handled by the layout anymore. This is equivalent to
9549 * elm_layout_box_remove() for all box children.
9551 * @see elm_layout_box_append()
9552 * @see elm_layout_box_remove()
9556 EAPI void elm_layout_box_remove_all(Evas_Object *obj, const char *part, Eina_Bool clear) EINA_ARG_NONNULL(1, 2);
9558 * Insert child to layout table part.
9560 * @param obj the layout object
9561 * @param part the box part to pack child.
9562 * @param child_obj the child object to pack into table.
9563 * @param col the column to which the child should be added. (>= 0)
9564 * @param row the row to which the child should be added. (>= 0)
9565 * @param colspan how many columns should be used to store this object. (>=
9567 * @param rowspan how many rows should be used to store this object. (>= 1)
9569 * Once the object is inserted, it will become child of the table. Its
9570 * lifetime will be bound to the layout, and whenever the layout dies the
9571 * child will be deleted automatically. One should use
9572 * elm_layout_table_remove() to make this layout forget about the object.
9574 * If @p colspan or @p rowspan are bigger than 1, that object will occupy
9575 * more space than a single cell. For instance, the following code:
9577 * elm_layout_table_pack(layout, "table_part", child, 0, 1, 3, 1);
9580 * Would result in an object being added like the following picture:
9582 * @image html layout_colspan.png
9583 * @image latex layout_colspan.eps width=\textwidth
9585 * @see elm_layout_table_unpack()
9586 * @see elm_layout_table_clear()
9590 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);
9592 * Unpack (remove) a child of the given part table.
9594 * @param obj The layout object
9595 * @param part The table part name to remove child.
9596 * @param child_obj The object to remove from table.
9597 * @return The object that was being used, or NULL if not found.
9599 * The object will be unpacked from the table part and its lifetime
9600 * will not be handled by the layout anymore. This is equivalent to
9601 * elm_layout_content_unset() for table.
9603 * @see elm_layout_table_pack()
9604 * @see elm_layout_table_clear()
9608 EAPI Evas_Object *elm_layout_table_unpack(Evas_Object *obj, const char *part, Evas_Object *child_obj) EINA_ARG_NONNULL(1, 2, 3);
9610 * Remove all child of the given part table.
9612 * @param obj The layout object
9613 * @param part The table part name to remove child.
9614 * @param clear If EINA_TRUE, then all objects will be deleted as
9615 * well, otherwise they will just be removed and will be
9616 * dangling on the canvas.
9618 * The objects will be removed from the table part and their lifetime will
9619 * not be handled by the layout anymore. This is equivalent to
9620 * elm_layout_table_unpack() for all table children.
9622 * @see elm_layout_table_pack()
9623 * @see elm_layout_table_unpack()
9627 EAPI void elm_layout_table_clear(Evas_Object *obj, const char *part, Eina_Bool clear) EINA_ARG_NONNULL(1, 2);
9629 * Get the edje layout
9631 * @param obj The layout object
9633 * @return A Evas_Object with the edje layout settings loaded
9634 * with function elm_layout_file_set
9636 * This returns the edje object. It is not expected to be used to then
9637 * swallow objects via edje_object_part_swallow() for example. Use
9638 * elm_layout_content_set() instead so child object handling and sizing is
9641 * @note This function should only be used if you really need to call some
9642 * low level Edje function on this edje object. All the common stuff (setting
9643 * text, emitting signals, hooking callbacks to signals, etc.) can be done
9644 * with proper elementary functions.
9646 * @see elm_object_signal_callback_add()
9647 * @see elm_object_signal_emit()
9648 * @see elm_object_text_part_set()
9649 * @see elm_layout_content_set()
9650 * @see elm_layout_box_append()
9651 * @see elm_layout_table_pack()
9652 * @see elm_layout_data_get()
9656 EAPI Evas_Object *elm_layout_edje_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9658 * Get the edje data from the given layout
9660 * @param obj The layout object
9661 * @param key The data key
9663 * @return The edje data string
9665 * This function fetches data specified inside the edje theme of this layout.
9666 * This function return NULL if data is not found.
9668 * In EDC this comes from a data block within the group block that @p
9669 * obj was loaded from. E.g.
9676 * item: "key1" "value1";
9677 * item: "key2" "value2";
9685 EAPI const char *elm_layout_data_get(const Evas_Object *obj, const char *key) EINA_ARG_NONNULL(1, 2);
9689 * @param obj The layout object
9691 * Manually forces a sizing re-evaluation. This is useful when the minimum
9692 * size required by the edje theme of this layout has changed. The change on
9693 * the minimum size required by the edje theme is not immediately reported to
9694 * the elementary layout, so one needs to call this function in order to tell
9695 * the widget (layout) that it needs to reevaluate its own size.
9697 * The minimum size of the theme is calculated based on minimum size of
9698 * parts, the size of elements inside containers like box and table, etc. All
9699 * of this can change due to state changes, and that's when this function
9702 * Also note that a standard signal of "size,eval" "elm" emitted from the
9703 * edje object will cause this to happen too.
9707 EAPI void elm_layout_sizing_eval(Evas_Object *obj) EINA_ARG_NONNULL(1);
9710 * Sets a specific cursor for an edje part.
9712 * @param obj The layout object.
9713 * @param part_name a part from loaded edje group.
9714 * @param cursor cursor name to use, see Elementary_Cursor.h
9716 * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
9717 * part not exists or it has "mouse_events: 0".
9721 EAPI Eina_Bool elm_layout_part_cursor_set(Evas_Object *obj, const char *part_name, const char *cursor) EINA_ARG_NONNULL(1, 2);
9724 * Get the cursor to be shown when mouse is over an edje part
9726 * @param obj The layout object.
9727 * @param part_name a part from loaded edje group.
9728 * @return the cursor name.
9732 EAPI const char *elm_layout_part_cursor_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
9735 * Unsets a cursor previously set with elm_layout_part_cursor_set().
9737 * @param obj The layout object.
9738 * @param part_name a part from loaded edje group, that had a cursor set
9739 * with elm_layout_part_cursor_set().
9743 EAPI void elm_layout_part_cursor_unset(Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
9746 * Sets a specific cursor style for an edje part.
9748 * @param obj The layout object.
9749 * @param part_name a part from loaded edje group.
9750 * @param style the theme style to use (default, transparent, ...)
9752 * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
9753 * part not exists or it did not had a cursor set.
9757 EAPI Eina_Bool elm_layout_part_cursor_style_set(Evas_Object *obj, const char *part_name, const char *style) EINA_ARG_NONNULL(1, 2);
9760 * Gets a specific cursor style for an edje part.
9762 * @param obj The layout object.
9763 * @param part_name a part from loaded edje group.
9765 * @return the theme style in use, defaults to "default". If the
9766 * object does not have a cursor set, then NULL is returned.
9770 EAPI const char *elm_layout_part_cursor_style_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
9773 * Sets if the cursor set should be searched on the theme or should use
9774 * the provided by the engine, only.
9776 * @note before you set if should look on theme you should define a
9777 * cursor with elm_layout_part_cursor_set(). By default it will only
9778 * look for cursors provided by the engine.
9780 * @param obj The layout object.
9781 * @param part_name a part from loaded edje group.
9782 * @param engine_only if cursors should be just provided by the engine
9783 * or should also search on widget's theme as well
9785 * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
9786 * part not exists or it did not had a cursor set.
9790 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);
9793 * Gets a specific cursor engine_only for an edje part.
9795 * @param obj The layout object.
9796 * @param part_name a part from loaded edje group.
9798 * @return whenever the cursor is just provided by engine or also from theme.
9802 EAPI Eina_Bool elm_layout_part_cursor_engine_only_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
9805 * @def elm_layout_icon_set
9806 * Convienience macro to set the icon object in a layout that follows the
9807 * Elementary naming convention for its parts.
9811 #define elm_layout_icon_set(_ly, _obj) \
9814 elm_layout_content_set((_ly), "elm.swallow.icon", (_obj)); \
9815 if ((_obj)) sig = "elm,state,icon,visible"; \
9816 else sig = "elm,state,icon,hidden"; \
9817 elm_object_signal_emit((_ly), sig, "elm"); \
9821 * @def elm_layout_icon_get
9822 * Convienience macro to get the icon object from a layout that follows the
9823 * Elementary naming convention for its parts.
9827 #define elm_layout_icon_get(_ly) \
9828 elm_layout_content_get((_ly), "elm.swallow.icon")
9831 * @def elm_layout_end_set
9832 * Convienience macro to set the end object in a layout that follows the
9833 * Elementary naming convention for its parts.
9837 #define elm_layout_end_set(_ly, _obj) \
9840 elm_layout_content_set((_ly), "elm.swallow.end", (_obj)); \
9841 if ((_obj)) sig = "elm,state,end,visible"; \
9842 else sig = "elm,state,end,hidden"; \
9843 elm_object_signal_emit((_ly), sig, "elm"); \
9847 * @def elm_layout_end_get
9848 * Convienience macro to get the end object in a layout that follows the
9849 * Elementary naming convention for its parts.
9853 #define elm_layout_end_get(_ly) \
9854 elm_layout_content_get((_ly), "elm.swallow.end")
9857 * @def elm_layout_label_set
9858 * Convienience macro to set the label in a layout that follows the
9859 * Elementary naming convention for its parts.
9862 * @deprecated use elm_object_text_* instead.
9864 #define elm_layout_label_set(_ly, _txt) \
9865 elm_layout_text_set((_ly), "elm.text", (_txt))
9868 * @def elm_layout_label_get
9869 * Convienience macro to get the label in a layout that follows the
9870 * Elementary naming convention for its parts.
9873 * @deprecated use elm_object_text_* instead.
9875 #define elm_layout_label_get(_ly) \
9876 elm_layout_text_get((_ly), "elm.text")
9878 /* smart callbacks called:
9879 * "theme,changed" - when elm theme is changed.
9883 * @defgroup Notify Notify
9885 * @image html img/widget/notify/preview-00.png
9886 * @image latex img/widget/notify/preview-00.eps
9888 * Display a container in a particular region of the parent(top, bottom,
9889 * etc. A timeout can be set to automatically hide the notify. This is so
9890 * that, after an evas_object_show() on a notify object, if a timeout was set
9891 * on it, it will @b automatically get hidden after that time.
9893 * Signals that you can add callbacks for are:
9894 * @li "timeout" - when timeout happens on notify and it's hidden
9895 * @li "block,clicked" - when a click outside of the notify happens
9897 * @ref tutorial_notify show usage of the API.
9902 * @brief Possible orient values for notify.
9904 * This values should be used in conjunction to elm_notify_orient_set() to
9905 * set the position in which the notify should appear(relative to its parent)
9906 * and in conjunction with elm_notify_orient_get() to know where the notify
9909 typedef enum _Elm_Notify_Orient
9911 ELM_NOTIFY_ORIENT_TOP, /**< Notify should appear in the top of parent, default */
9912 ELM_NOTIFY_ORIENT_CENTER, /**< Notify should appear in the center of parent */
9913 ELM_NOTIFY_ORIENT_BOTTOM, /**< Notify should appear in the bottom of parent */
9914 ELM_NOTIFY_ORIENT_LEFT, /**< Notify should appear in the left of parent */
9915 ELM_NOTIFY_ORIENT_RIGHT, /**< Notify should appear in the right of parent */
9916 ELM_NOTIFY_ORIENT_TOP_LEFT, /**< Notify should appear in the top left of parent */
9917 ELM_NOTIFY_ORIENT_TOP_RIGHT, /**< Notify should appear in the top right of parent */
9918 ELM_NOTIFY_ORIENT_BOTTOM_LEFT, /**< Notify should appear in the bottom left of parent */
9919 ELM_NOTIFY_ORIENT_BOTTOM_RIGHT, /**< Notify should appear in the bottom right of parent */
9920 ELM_NOTIFY_ORIENT_LAST /**< Sentinel value, @b don't use */
9921 } Elm_Notify_Orient;
9923 * @brief Add a new notify to the parent
9925 * @param parent The parent object
9926 * @return The new object or NULL if it cannot be created
9928 EAPI Evas_Object *elm_notify_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
9930 * @brief Set the content of the notify widget
9932 * @param obj The notify object
9933 * @param content The content will be filled in this notify object
9935 * Once the content object is set, a previously set one will be deleted. If
9936 * you want to keep that old content object, use the
9937 * elm_notify_content_unset() function.
9939 EAPI void elm_notify_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
9941 * @brief Unset the content of the notify widget
9943 * @param obj The notify object
9944 * @return The content that was being used
9946 * Unparent and return the content object which was set for this widget
9948 * @see elm_notify_content_set()
9950 EAPI Evas_Object *elm_notify_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
9952 * @brief Return the content of the notify widget
9954 * @param obj The notify object
9955 * @return The content that is being used
9957 * @see elm_notify_content_set()
9959 EAPI Evas_Object *elm_notify_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9961 * @brief Set the notify parent
9963 * @param obj The notify object
9964 * @param content The new parent
9966 * Once the parent object is set, a previously set one will be disconnected
9969 EAPI void elm_notify_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
9971 * @brief Get the notify parent
9973 * @param obj The notify object
9974 * @return The parent
9976 * @see elm_notify_parent_set()
9978 EAPI Evas_Object *elm_notify_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9980 * @brief Set the orientation
9982 * @param obj The notify object
9983 * @param orient The new orientation
9985 * Sets the position in which the notify will appear in its parent.
9987 * @see @ref Elm_Notify_Orient for possible values.
9989 EAPI void elm_notify_orient_set(Evas_Object *obj, Elm_Notify_Orient orient) EINA_ARG_NONNULL(1);
9991 * @brief Return the orientation
9992 * @param obj The notify object
9993 * @return The orientation of the notification
9995 * @see elm_notify_orient_set()
9996 * @see Elm_Notify_Orient
9998 EAPI Elm_Notify_Orient elm_notify_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10000 * @brief Set the time interval after which the notify window is going to be
10003 * @param obj The notify object
10004 * @param time The timeout in seconds
10006 * This function sets a timeout and starts the timer controlling when the
10007 * notify is hidden. Since calling evas_object_show() on a notify restarts
10008 * the timer controlling when the notify is hidden, setting this before the
10009 * notify is shown will in effect mean starting the timer when the notify is
10012 * @note Set a value <= 0.0 to disable a running timer.
10014 * @note If the value > 0.0 and the notify is previously visible, the
10015 * timer will be started with this value, canceling any running timer.
10017 EAPI void elm_notify_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
10019 * @brief Return the timeout value (in seconds)
10020 * @param obj the notify object
10022 * @see elm_notify_timeout_set()
10024 EAPI double elm_notify_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10026 * @brief Sets whether events should be passed to by a click outside
10029 * @param obj The notify object
10030 * @param repeats EINA_TRUE Events are repeats, else no
10032 * When true if the user clicks outside the window the events will be caught
10033 * by the others widgets, else the events are blocked.
10035 * @note The default value is EINA_TRUE.
10037 EAPI void elm_notify_repeat_events_set(Evas_Object *obj, Eina_Bool repeat) EINA_ARG_NONNULL(1);
10039 * @brief Return true if events are repeat below the notify object
10040 * @param obj the notify object
10042 * @see elm_notify_repeat_events_set()
10044 EAPI Eina_Bool elm_notify_repeat_events_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10050 * @defgroup Hover Hover
10052 * @image html img/widget/hover/preview-00.png
10053 * @image latex img/widget/hover/preview-00.eps
10055 * A Hover object will hover over its @p parent object at the @p target
10056 * location. Anything in the background will be given a darker coloring to
10057 * indicate that the hover object is on top (at the default theme). When the
10058 * hover is clicked it is dismissed(hidden), if the contents of the hover are
10059 * clicked that @b doesn't cause the hover to be dismissed.
10061 * @note The hover object will take up the entire space of @p target
10064 * Elementary has the following styles for the hover widget:
10068 * @li hoversel_vertical
10070 * The following are the available position for content:
10082 * Signals that you can add callbacks for are:
10083 * @li "clicked" - the user clicked the empty space in the hover to dismiss
10084 * @li "smart,changed" - a content object placed under the "smart"
10085 * policy was replaced to a new slot direction.
10087 * See @ref tutorial_hover for more information.
10091 typedef enum _Elm_Hover_Axis
10093 ELM_HOVER_AXIS_NONE, /**< ELM_HOVER_AXIS_NONE -- no prefered orientation */
10094 ELM_HOVER_AXIS_HORIZONTAL, /**< ELM_HOVER_AXIS_HORIZONTAL -- horizontal */
10095 ELM_HOVER_AXIS_VERTICAL, /**< ELM_HOVER_AXIS_VERTICAL -- vertical */
10096 ELM_HOVER_AXIS_BOTH /**< ELM_HOVER_AXIS_BOTH -- both */
10099 * @brief Adds a hover object to @p parent
10101 * @param parent The parent object
10102 * @return The hover object or NULL if one could not be created
10104 EAPI Evas_Object *elm_hover_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10106 * @brief Sets the target object for the hover.
10108 * @param obj The hover object
10109 * @param target The object to center the hover onto. The hover
10111 * This function will cause the hover to be centered on the target object.
10113 EAPI void elm_hover_target_set(Evas_Object *obj, Evas_Object *target) EINA_ARG_NONNULL(1);
10115 * @brief Gets the target object for the hover.
10117 * @param obj The hover object
10118 * @param parent The object to locate the hover over.
10120 * @see elm_hover_target_set()
10122 EAPI Evas_Object *elm_hover_target_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10124 * @brief Sets the parent object for the hover.
10126 * @param obj The hover object
10127 * @param parent The object to locate the hover over.
10129 * This function will cause the hover to take up the entire space that the
10130 * parent object fills.
10132 EAPI void elm_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
10134 * @brief Gets the parent object for the hover.
10136 * @param obj The hover object
10137 * @return The parent object to locate the hover over.
10139 * @see elm_hover_parent_set()
10141 EAPI Evas_Object *elm_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10143 * @brief Sets the content of the hover object and the direction in which it
10146 * @param obj The hover object
10147 * @param swallow The direction that the object will be displayed
10148 * at. Accepted values are "left", "top-left", "top", "top-right",
10149 * "right", "bottom-right", "bottom", "bottom-left", "middle" and
10151 * @param content The content to place at @p swallow
10153 * Once the content object is set for a given direction, a previously
10154 * set one (on the same direction) will be deleted. If you want to
10155 * keep that old content object, use the elm_hover_content_unset()
10158 * All directions may have contents at the same time, except for
10159 * "smart". This is a special placement hint and its use case
10160 * independs of the calculations coming from
10161 * elm_hover_best_content_location_get(). Its use is for cases when
10162 * one desires only one hover content, but with a dinamic special
10163 * placement within the hover area. The content's geometry, whenever
10164 * it changes, will be used to decide on a best location not
10165 * extrapolating the hover's parent object view to show it in (still
10166 * being the hover's target determinant of its medium part -- move and
10167 * resize it to simulate finger sizes, for example). If one of the
10168 * directions other than "smart" are used, a previously content set
10169 * using it will be deleted, and vice-versa.
10171 EAPI void elm_hover_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content) EINA_ARG_NONNULL(1);
10173 * @brief Get the content of the hover object, in a given direction.
10175 * Return the content object which was set for this widget in the
10176 * @p swallow direction.
10178 * @param obj The hover object
10179 * @param swallow The direction that the object was display at.
10180 * @return The content that was being used
10182 * @see elm_hover_content_set()
10184 EAPI Evas_Object *elm_hover_content_get(const Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
10186 * @brief Unset the content of the hover object, in a given direction.
10188 * Unparent and return the content object set at @p swallow direction.
10190 * @param obj The hover object
10191 * @param swallow The direction that the object was display at.
10192 * @return The content that was being used.
10194 * @see elm_hover_content_set()
10196 EAPI Evas_Object *elm_hover_content_unset(Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
10198 * @brief Returns the best swallow location for content in the hover.
10200 * @param obj The hover object
10201 * @param pref_axis The preferred orientation axis for the hover object to use
10202 * @return The edje location to place content into the hover or @c
10205 * Best is defined here as the location at which there is the most available
10208 * @p pref_axis may be one of
10209 * - @c ELM_HOVER_AXIS_NONE -- no prefered orientation
10210 * - @c ELM_HOVER_AXIS_HORIZONTAL -- horizontal
10211 * - @c ELM_HOVER_AXIS_VERTICAL -- vertical
10212 * - @c ELM_HOVER_AXIS_BOTH -- both
10214 * If ELM_HOVER_AXIS_HORIZONTAL is choosen the returned position will
10215 * nescessarily be along the horizontal axis("left" or "right"). If
10216 * ELM_HOVER_AXIS_VERTICAL is choosen the returned position will nescessarily
10217 * be along the vertical axis("top" or "bottom"). Chossing
10218 * ELM_HOVER_AXIS_BOTH or ELM_HOVER_AXIS_NONE has the same effect and the
10219 * returned position may be in either axis.
10221 * @see elm_hover_content_set()
10223 EAPI const char *elm_hover_best_content_location_get(const Evas_Object *obj, Elm_Hover_Axis pref_axis) EINA_ARG_NONNULL(1);
10230 * @defgroup Entry Entry
10232 * @image html img/widget/entry/preview-00.png
10233 * @image latex img/widget/entry/preview-00.eps width=\textwidth
10234 * @image html img/widget/entry/preview-01.png
10235 * @image latex img/widget/entry/preview-01.eps width=\textwidth
10236 * @image html img/widget/entry/preview-02.png
10237 * @image latex img/widget/entry/preview-02.eps width=\textwidth
10238 * @image html img/widget/entry/preview-03.png
10239 * @image latex img/widget/entry/preview-03.eps width=\textwidth
10241 * An entry is a convenience widget which shows a box that the user can
10242 * enter text into. Entries by default don't scroll, so they grow to
10243 * accomodate the entire text, resizing the parent window as needed. This
10244 * can be changed with the elm_entry_scrollable_set() function.
10246 * They can also be single line or multi line (the default) and when set
10247 * to multi line mode they support text wrapping in any of the modes
10248 * indicated by #Elm_Wrap_Type.
10250 * Other features include password mode, filtering of inserted text with
10251 * elm_entry_text_filter_append() and related functions, inline "items" and
10252 * formatted markup text.
10254 * @section entry-markup Formatted text
10256 * The markup tags supported by the Entry are defined by the theme, but
10257 * even when writing new themes or extensions it's a good idea to stick to
10258 * a sane default, to maintain coherency and avoid application breakages.
10259 * Currently defined by the default theme are the following tags:
10260 * @li \<br\>: Inserts a line break.
10261 * @li \<ps\>: Inserts a paragraph separator. This is preferred over line
10263 * @li \<tab\>: Inserts a tab.
10264 * @li \<em\>...\</em\>: Emphasis. Sets the @em oblique style for the
10266 * @li \<b\>...\</b\>: Sets the @b bold style for the enclosed text.
10267 * @li \<link\>...\</link\>: Underlines the enclosed text.
10268 * @li \<hilight\>...\</hilight\>: Hilights the enclosed text.
10270 * @section entry-special Special markups
10272 * Besides those used to format text, entries support two special markup
10273 * tags used to insert clickable portions of text or items inlined within
10276 * @subsection entry-anchors Anchors
10278 * Anchors are similar to HTML anchors. Text can be surrounded by \<a\> and
10279 * \</a\> tags and an event will be generated when this text is clicked,
10283 * This text is outside <a href=anc-01>but this one is an anchor</a>
10286 * The @c href attribute in the opening tag gives the name that will be
10287 * used to identify the anchor and it can be any valid utf8 string.
10289 * When an anchor is clicked, an @c "anchor,clicked" signal is emitted with
10290 * an #Elm_Entry_Anchor_Info in the @c event_info parameter for the
10291 * callback function. The same applies for "anchor,in" (mouse in), "anchor,out"
10292 * (mouse out), "anchor,down" (mouse down), and "anchor,up" (mouse up) events on
10295 * @subsection entry-items Items
10297 * Inlined in the text, any other @c Evas_Object can be inserted by using
10298 * \<item\> tags this way:
10301 * <item size=16x16 vsize=full href=emoticon/haha></item>
10304 * Just like with anchors, the @c href identifies each item, but these need,
10305 * in addition, to indicate their size, which is done using any one of
10306 * @c size, @c absize or @c relsize attributes. These attributes take their
10307 * value in the WxH format, where W is the width and H the height of the
10310 * @li absize: Absolute pixel size for the item. Whatever value is set will
10311 * be the item's size regardless of any scale value the object may have
10312 * been set to. The final line height will be adjusted to fit larger items.
10313 * @li size: Similar to @c absize, but it's adjusted to the scale value set
10315 * @li relsize: Size is adjusted for the item to fit within the current
10318 * Besides their size, items are specificed a @c vsize value that affects
10319 * how their final size and position are calculated. The possible values
10321 * @li ascent: Item will be placed within the line's baseline and its
10322 * ascent. That is, the height between the line where all characters are
10323 * positioned and the highest point in the line. For @c size and @c absize
10324 * items, the descent value will be added to the total line height to make
10325 * them fit. @c relsize items will be adjusted to fit within this space.
10326 * @li full: Items will be placed between the descent and ascent, or the
10327 * lowest point in the line and its highest.
10329 * The next image shows different configurations of items and how they
10330 * are the previously mentioned options affect their sizes. In all cases,
10331 * the green line indicates the ascent, blue for the baseline and red for
10334 * @image html entry_item.png
10335 * @image latex entry_item.eps width=\textwidth
10337 * And another one to show how size differs from absize. In the first one,
10338 * the scale value is set to 1.0, while the second one is using one of 2.0.
10340 * @image html entry_item_scale.png
10341 * @image latex entry_item_scale.eps width=\textwidth
10343 * After the size for an item is calculated, the entry will request an
10344 * object to place in its space. For this, the functions set with
10345 * elm_entry_item_provider_append() and related functions will be called
10346 * in order until one of them returns a @c non-NULL value. If no providers
10347 * are available, or all of them return @c NULL, then the entry falls back
10348 * to one of the internal defaults, provided the name matches with one of
10351 * All of the following are currently supported:
10354 * - emoticon/angry-shout
10355 * - emoticon/crazy-laugh
10356 * - emoticon/evil-laugh
10358 * - emoticon/goggle-smile
10359 * - emoticon/grumpy
10360 * - emoticon/grumpy-smile
10361 * - emoticon/guilty
10362 * - emoticon/guilty-smile
10364 * - emoticon/half-smile
10365 * - emoticon/happy-panting
10367 * - emoticon/indifferent
10369 * - emoticon/knowing-grin
10371 * - emoticon/little-bit-sorry
10372 * - emoticon/love-lots
10374 * - emoticon/minimal-smile
10375 * - emoticon/not-happy
10376 * - emoticon/not-impressed
10378 * - emoticon/opensmile
10381 * - emoticon/squint-laugh
10382 * - emoticon/surprised
10383 * - emoticon/suspicious
10384 * - emoticon/tongue-dangling
10385 * - emoticon/tongue-poke
10387 * - emoticon/unhappy
10388 * - emoticon/very-sorry
10391 * - emoticon/worried
10394 * Alternatively, an item may reference an image by its path, using
10395 * the URI form @c file:///path/to/an/image.png and the entry will then
10396 * use that image for the item.
10398 * @section entry-files Loading and saving files
10400 * Entries have convinience functions to load text from a file and save
10401 * changes back to it after a short delay. The automatic saving is enabled
10402 * by default, but can be disabled with elm_entry_autosave_set() and files
10403 * can be loaded directly as plain text or have any markup in them
10404 * recognized. See elm_entry_file_set() for more details.
10406 * @section entry-signals Emitted signals
10408 * This widget emits the following signals:
10410 * @li "changed": The text within the entry was changed.
10411 * @li "changed,user": The text within the entry was changed because of user interaction.
10412 * @li "activated": The enter key was pressed on a single line entry.
10413 * @li "press": A mouse button has been pressed on the entry.
10414 * @li "longpressed": A mouse button has been pressed and held for a couple
10416 * @li "clicked": The entry has been clicked (mouse press and release).
10417 * @li "clicked,double": The entry has been double clicked.
10418 * @li "clicked,triple": The entry has been triple clicked.
10419 * @li "focused": The entry has received focus.
10420 * @li "unfocused": The entry has lost focus.
10421 * @li "selection,paste": A paste of the clipboard contents was requested.
10422 * @li "selection,copy": A copy of the selected text into the clipboard was
10424 * @li "selection,cut": A cut of the selected text into the clipboard was
10426 * @li "selection,start": A selection has begun and no previous selection
10428 * @li "selection,changed": The current selection has changed.
10429 * @li "selection,cleared": The current selection has been cleared.
10430 * @li "cursor,changed": The cursor has changed position.
10431 * @li "anchor,clicked": An anchor has been clicked. The event_info
10432 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10433 * @li "anchor,in": Mouse cursor has moved into an anchor. The event_info
10434 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10435 * @li "anchor,out": Mouse cursor has moved out of an anchor. The event_info
10436 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10437 * @li "anchor,up": Mouse button has been unpressed on an anchor. The event_info
10438 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10439 * @li "anchor,down": Mouse button has been pressed on an anchor. The event_info
10440 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10441 * @li "preedit,changed": The preedit string has changed.
10443 * @section entry-examples
10445 * An overview of the Entry API can be seen in @ref entry_example_01
10450 * @typedef Elm_Entry_Anchor_Info
10452 * The info sent in the callback for the "anchor,clicked" signals emitted
10455 typedef struct _Elm_Entry_Anchor_Info Elm_Entry_Anchor_Info;
10457 * @struct _Elm_Entry_Anchor_Info
10459 * The info sent in the callback for the "anchor,clicked" signals emitted
10462 struct _Elm_Entry_Anchor_Info
10464 const char *name; /**< The name of the anchor, as stated in its href */
10465 int button; /**< The mouse button used to click on it */
10466 Evas_Coord x, /**< Anchor geometry, relative to canvas */
10467 y, /**< Anchor geometry, relative to canvas */
10468 w, /**< Anchor geometry, relative to canvas */
10469 h; /**< Anchor geometry, relative to canvas */
10472 * @typedef Elm_Entry_Filter_Cb
10473 * This callback type is used by entry filters to modify text.
10474 * @param data The data specified as the last param when adding the filter
10475 * @param entry The entry object
10476 * @param text A pointer to the location of the text being filtered. This data can be modified,
10477 * but any additional allocations must be managed by the user.
10478 * @see elm_entry_text_filter_append
10479 * @see elm_entry_text_filter_prepend
10481 typedef void (*Elm_Entry_Filter_Cb)(void *data, Evas_Object *entry, char **text);
10484 * This adds an entry to @p parent object.
10486 * By default, entries are:
10490 * @li autosave is enabled
10492 * @param parent The parent object
10493 * @return The new object or NULL if it cannot be created
10495 EAPI Evas_Object *elm_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10497 * Sets the entry to single line mode.
10499 * In single line mode, entries don't ever wrap when the text reaches the
10500 * edge, and instead they keep growing horizontally. Pressing the @c Enter
10501 * key will generate an @c "activate" event instead of adding a new line.
10503 * When @p single_line is @c EINA_FALSE, line wrapping takes effect again
10504 * and pressing enter will break the text into a different line
10505 * without generating any events.
10507 * @param obj The entry object
10508 * @param single_line If true, the text in the entry
10509 * will be on a single line.
10511 EAPI void elm_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line) EINA_ARG_NONNULL(1);
10513 * Gets whether the entry is set to be single line.
10515 * @param obj The entry object
10516 * @return single_line If true, the text in the entry is set to display
10517 * on a single line.
10519 * @see elm_entry_single_line_set()
10521 EAPI Eina_Bool elm_entry_single_line_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10523 * Sets the entry to password mode.
10525 * In password mode, entries are implicitly single line and the display of
10526 * any text in them is replaced with asterisks (*).
10528 * @param obj The entry object
10529 * @param password If true, password mode is enabled.
10531 EAPI void elm_entry_password_set(Evas_Object *obj, Eina_Bool password) EINA_ARG_NONNULL(1);
10533 * Gets whether the entry is set to password mode.
10535 * @param obj The entry object
10536 * @return If true, the entry is set to display all characters
10537 * as asterisks (*).
10539 * @see elm_entry_password_set()
10541 EAPI Eina_Bool elm_entry_password_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10543 * This sets the text displayed within the entry to @p entry.
10545 * @param obj The entry object
10546 * @param entry The text to be displayed
10548 * @deprecated Use elm_object_text_set() instead.
10550 EAPI void elm_entry_entry_set(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
10552 * This returns the text currently shown in object @p entry.
10553 * See also elm_entry_entry_set().
10555 * @param obj The entry object
10556 * @return The currently displayed text or NULL on failure
10558 * @deprecated Use elm_object_text_get() instead.
10560 EAPI const char *elm_entry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10562 * Appends @p entry to the text of the entry.
10564 * Adds the text in @p entry to the end of any text already present in the
10567 * The appended text is subject to any filters set for the widget.
10569 * @param obj The entry object
10570 * @param entry The text to be displayed
10572 * @see elm_entry_text_filter_append()
10574 EAPI void elm_entry_entry_append(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
10576 * Gets whether the entry is empty.
10578 * Empty means no text at all. If there are any markup tags, like an item
10579 * tag for which no provider finds anything, and no text is displayed, this
10580 * function still returns EINA_FALSE.
10582 * @param obj The entry object
10583 * @return EINA_TRUE if the entry is empty, EINA_FALSE otherwise.
10585 EAPI Eina_Bool elm_entry_is_empty(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10587 * Gets any selected text within the entry.
10589 * If there's any selected text in the entry, this function returns it as
10590 * a string in markup format. NULL is returned if no selection exists or
10591 * if an error occurred.
10593 * The returned value points to an internal string and should not be freed
10594 * or modified in any way. If the @p entry object is deleted or its
10595 * contents are changed, the returned pointer should be considered invalid.
10597 * @param obj The entry object
10598 * @return The selected text within the entry or NULL on failure
10600 EAPI const char *elm_entry_selection_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10602 * Inserts the given text into the entry at the current cursor position.
10604 * This inserts text at the cursor position as if it was typed
10605 * by the user (note that this also allows markup which a user
10606 * can't just "type" as it would be converted to escaped text, so this
10607 * call can be used to insert things like emoticon items or bold push/pop
10608 * tags, other font and color change tags etc.)
10610 * If any selection exists, it will be replaced by the inserted text.
10612 * The inserted text is subject to any filters set for the widget.
10614 * @param obj The entry object
10615 * @param entry The text to insert
10617 * @see elm_entry_text_filter_append()
10619 EAPI void elm_entry_entry_insert(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
10621 * Set the line wrap type to use on multi-line entries.
10623 * Sets the wrap type used by the entry to any of the specified in
10624 * #Elm_Wrap_Type. This tells how the text will be implicitly cut into a new
10625 * line (without inserting a line break or paragraph separator) when it
10626 * reaches the far edge of the widget.
10628 * Note that this only makes sense for multi-line entries. A widget set
10629 * to be single line will never wrap.
10631 * @param obj The entry object
10632 * @param wrap The wrap mode to use. See #Elm_Wrap_Type for details on them
10634 EAPI void elm_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
10636 * Gets the wrap mode the entry was set to use.
10638 * @param obj The entry object
10639 * @return Wrap type
10641 * @see also elm_entry_line_wrap_set()
10643 EAPI Elm_Wrap_Type elm_entry_line_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10645 * Sets if the entry is to be editable or not.
10647 * By default, entries are editable and when focused, any text input by the
10648 * user will be inserted at the current cursor position. But calling this
10649 * function with @p editable as EINA_FALSE will prevent the user from
10650 * inputting text into the entry.
10652 * The only way to change the text of a non-editable entry is to use
10653 * elm_object_text_set(), elm_entry_entry_insert() and other related
10656 * @param obj The entry object
10657 * @param editable If EINA_TRUE, user input will be inserted in the entry,
10658 * if not, the entry is read-only and no user input is allowed.
10660 EAPI void elm_entry_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
10662 * Gets whether the entry is editable or not.
10664 * @param obj The entry object
10665 * @return If true, the entry is editable by the user.
10666 * If false, it is not editable by the user
10668 * @see elm_entry_editable_set()
10670 EAPI Eina_Bool elm_entry_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10672 * This drops any existing text selection within the entry.
10674 * @param obj The entry object
10676 EAPI void elm_entry_select_none(Evas_Object *obj) EINA_ARG_NONNULL(1);
10678 * This selects all text within the entry.
10680 * @param obj The entry object
10682 EAPI void elm_entry_select_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
10684 * This moves the cursor one place to the right within the entry.
10686 * @param obj The entry object
10687 * @return EINA_TRUE upon success, EINA_FALSE upon failure
10689 EAPI Eina_Bool elm_entry_cursor_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
10691 * This moves the cursor one place to the left within the entry.
10693 * @param obj The entry object
10694 * @return EINA_TRUE upon success, EINA_FALSE upon failure
10696 EAPI Eina_Bool elm_entry_cursor_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
10698 * This moves the cursor one line up within the entry.
10700 * @param obj The entry object
10701 * @return EINA_TRUE upon success, EINA_FALSE upon failure
10703 EAPI Eina_Bool elm_entry_cursor_up(Evas_Object *obj) EINA_ARG_NONNULL(1);
10705 * This moves the cursor one line down within the entry.
10707 * @param obj The entry object
10708 * @return EINA_TRUE upon success, EINA_FALSE upon failure
10710 EAPI Eina_Bool elm_entry_cursor_down(Evas_Object *obj) EINA_ARG_NONNULL(1);
10712 * This moves the cursor to the beginning of the entry.
10714 * @param obj The entry object
10716 EAPI void elm_entry_cursor_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
10718 * This moves the cursor to the end of the entry.
10720 * @param obj The entry object
10722 EAPI void elm_entry_cursor_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
10724 * This moves the cursor to the beginning of the current line.
10726 * @param obj The entry object
10728 EAPI void elm_entry_cursor_line_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
10730 * This moves the cursor to the end of the current line.
10732 * @param obj The entry object
10734 EAPI void elm_entry_cursor_line_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
10736 * This begins a selection within the entry as though
10737 * the user were holding down the mouse button to make a selection.
10739 * @param obj The entry object
10741 EAPI void elm_entry_cursor_selection_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
10743 * This ends a selection within the entry as though
10744 * the user had just released the mouse button while making a selection.
10746 * @param obj The entry object
10748 EAPI void elm_entry_cursor_selection_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
10750 * Gets whether a format node exists at the current cursor position.
10752 * A format node is anything that defines how the text is rendered. It can
10753 * be a visible format node, such as a line break or a paragraph separator,
10754 * or an invisible one, such as bold begin or end tag.
10755 * This function returns whether any format node exists at the current
10758 * @param obj The entry object
10759 * @return EINA_TRUE if the current cursor position contains a format node,
10760 * EINA_FALSE otherwise.
10762 * @see elm_entry_cursor_is_visible_format_get()
10764 EAPI Eina_Bool elm_entry_cursor_is_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10766 * Gets if the current cursor position holds a visible format node.
10768 * @param obj The entry object
10769 * @return EINA_TRUE if the current cursor is a visible format, EINA_FALSE
10770 * if it's an invisible one or no format exists.
10772 * @see elm_entry_cursor_is_format_get()
10774 EAPI Eina_Bool elm_entry_cursor_is_visible_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10776 * Gets the character pointed by the cursor at its current position.
10778 * This function returns a string with the utf8 character stored at the
10779 * current cursor position.
10780 * Only the text is returned, any format that may exist will not be part
10781 * of the return value.
10783 * @param obj The entry object
10784 * @return The text pointed by the cursors.
10786 EAPI const char *elm_entry_cursor_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10788 * This function returns the geometry of the cursor.
10790 * It's useful if you want to draw something on the cursor (or where it is),
10791 * or for example in the case of scrolled entry where you want to show the
10794 * @param obj The entry object
10795 * @param x returned geometry
10796 * @param y returned geometry
10797 * @param w returned geometry
10798 * @param h returned geometry
10799 * @return EINA_TRUE upon success, EINA_FALSE upon failure
10801 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);
10803 * Sets the cursor position in the entry to the given value
10805 * The value in @p pos is the index of the character position within the
10806 * contents of the string as returned by elm_entry_cursor_pos_get().
10808 * @param obj The entry object
10809 * @param pos The position of the cursor
10811 EAPI void elm_entry_cursor_pos_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
10813 * Retrieves the current position of the cursor in the entry
10815 * @param obj The entry object
10816 * @return The cursor position
10818 EAPI int elm_entry_cursor_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10820 * This executes a "cut" action on the selected text in the entry.
10822 * @param obj The entry object
10824 EAPI void elm_entry_selection_cut(Evas_Object *obj) EINA_ARG_NONNULL(1);
10826 * This executes a "copy" action on the selected text in the entry.
10828 * @param obj The entry object
10830 EAPI void elm_entry_selection_copy(Evas_Object *obj) EINA_ARG_NONNULL(1);
10832 * This executes a "paste" action in the entry.
10834 * @param obj The entry object
10836 EAPI void elm_entry_selection_paste(Evas_Object *obj) EINA_ARG_NONNULL(1);
10838 * This clears and frees the items in a entry's contextual (longpress)
10841 * @param obj The entry object
10843 * @see elm_entry_context_menu_item_add()
10845 EAPI void elm_entry_context_menu_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
10847 * This adds an item to the entry's contextual menu.
10849 * A longpress on an entry will make the contextual menu show up, if this
10850 * hasn't been disabled with elm_entry_context_menu_disabled_set().
10851 * By default, this menu provides a few options like enabling selection mode,
10852 * which is useful on embedded devices that need to be explicit about it,
10853 * and when a selection exists it also shows the copy and cut actions.
10855 * With this function, developers can add other options to this menu to
10856 * perform any action they deem necessary.
10858 * @param obj The entry object
10859 * @param label The item's text label
10860 * @param icon_file The item's icon file
10861 * @param icon_type The item's icon type
10862 * @param func The callback to execute when the item is clicked
10863 * @param data The data to associate with the item for related functions
10865 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);
10867 * This disables the entry's contextual (longpress) menu.
10869 * @param obj The entry object
10870 * @param disabled If true, the menu is disabled
10872 EAPI void elm_entry_context_menu_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
10874 * This returns whether the entry's contextual (longpress) menu is
10877 * @param obj The entry object
10878 * @return If true, the menu is disabled
10880 EAPI Eina_Bool elm_entry_context_menu_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10882 * This appends a custom item provider to the list for that entry
10884 * This appends the given callback. The list is walked from beginning to end
10885 * with each function called given the item href string in the text. If the
10886 * function returns an object handle other than NULL (it should create an
10887 * object to do this), then this object is used to replace that item. If
10888 * not the next provider is called until one provides an item object, or the
10889 * default provider in entry does.
10891 * @param obj The entry object
10892 * @param func The function called to provide the item object
10893 * @param data The data passed to @p func
10895 * @see @ref entry-items
10897 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);
10899 * This prepends a custom item provider to the list for that entry
10901 * This prepends the given callback. See elm_entry_item_provider_append() for
10904 * @param obj The entry object
10905 * @param func The function called to provide the item object
10906 * @param data The data passed to @p func
10908 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);
10910 * This removes a custom item provider to the list for that entry
10912 * This removes the given callback. See elm_entry_item_provider_append() for
10915 * @param obj The entry object
10916 * @param func The function called to provide the item object
10917 * @param data The data passed to @p func
10919 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);
10921 * Append a filter function for text inserted in the entry
10923 * Append the given callback to the list. This functions will be called
10924 * whenever any text is inserted into the entry, with the text to be inserted
10925 * as a parameter. The callback function is free to alter the text in any way
10926 * it wants, but it must remember to free the given pointer and update it.
10927 * If the new text is to be discarded, the function can free it and set its
10928 * text parameter to NULL. This will also prevent any following filters from
10931 * @param obj The entry object
10932 * @param func The function to use as text filter
10933 * @param data User data to pass to @p func
10935 EAPI void elm_entry_text_filter_append(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
10937 * Prepend a filter function for text insdrted in the entry
10939 * Prepend the given callback to the list. See elm_entry_text_filter_append()
10940 * for more information
10942 * @param obj The entry object
10943 * @param func The function to use as text filter
10944 * @param data User data to pass to @p func
10946 EAPI void elm_entry_text_filter_prepend(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
10948 * Remove a filter from the list
10950 * Removes the given callback from the filter list. See
10951 * elm_entry_text_filter_append() for more information.
10953 * @param obj The entry object
10954 * @param func The filter function to remove
10955 * @param data The user data passed when adding the function
10957 EAPI void elm_entry_text_filter_remove(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
10959 * This converts a markup (HTML-like) string into UTF-8.
10961 * The returned string is a malloc'ed buffer and it should be freed when
10962 * not needed anymore.
10964 * @param s The string (in markup) to be converted
10965 * @return The converted string (in UTF-8). It should be freed.
10967 EAPI char *elm_entry_markup_to_utf8(const char *s) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
10969 * This converts a UTF-8 string into markup (HTML-like).
10971 * The returned string is a malloc'ed buffer and it should be freed when
10972 * not needed anymore.
10974 * @param s The string (in UTF-8) to be converted
10975 * @return The converted string (in markup). It should be freed.
10977 EAPI char *elm_entry_utf8_to_markup(const char *s) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
10979 * This sets the file (and implicitly loads it) for the text to display and
10980 * then edit. All changes are written back to the file after a short delay if
10981 * the entry object is set to autosave (which is the default).
10983 * If the entry had any other file set previously, any changes made to it
10984 * will be saved if the autosave feature is enabled, otherwise, the file
10985 * will be silently discarded and any non-saved changes will be lost.
10987 * @param obj The entry object
10988 * @param file The path to the file to load and save
10989 * @param format The file format
10991 EAPI void elm_entry_file_set(Evas_Object *obj, const char *file, Elm_Text_Format format) EINA_ARG_NONNULL(1);
10993 * Gets the file being edited by the entry.
10995 * This function can be used to retrieve any file set on the entry for
10996 * edition, along with the format used to load and save it.
10998 * @param obj The entry object
10999 * @param file The path to the file to load and save
11000 * @param format The file format
11002 EAPI void elm_entry_file_get(const Evas_Object *obj, const char **file, Elm_Text_Format *format) EINA_ARG_NONNULL(1);
11004 * This function writes any changes made to the file set with
11005 * elm_entry_file_set()
11007 * @param obj The entry object
11009 EAPI void elm_entry_file_save(Evas_Object *obj) EINA_ARG_NONNULL(1);
11011 * This sets the entry object to 'autosave' the loaded text file or not.
11013 * @param obj The entry object
11014 * @param autosave Autosave the loaded file or not
11016 * @see elm_entry_file_set()
11018 EAPI void elm_entry_autosave_set(Evas_Object *obj, Eina_Bool autosave) EINA_ARG_NONNULL(1);
11020 * This gets the entry object's 'autosave' status.
11022 * @param obj The entry object
11023 * @return Autosave the loaded file or not
11025 * @see elm_entry_file_set()
11027 EAPI Eina_Bool elm_entry_autosave_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11029 * Control pasting of text and images for the widget.
11031 * Normally the entry allows both text and images to be pasted. By setting
11032 * textonly to be true, this prevents images from being pasted.
11034 * Note this only changes the behaviour of text.
11036 * @param obj The entry object
11037 * @param textonly paste mode - EINA_TRUE is text only, EINA_FALSE is
11038 * text+image+other.
11040 EAPI void elm_entry_cnp_textonly_set(Evas_Object *obj, Eina_Bool textonly) EINA_ARG_NONNULL(1);
11042 * Getting elm_entry text paste/drop mode.
11044 * In textonly mode, only text may be pasted or dropped into the widget.
11046 * @param obj The entry object
11047 * @return If the widget only accepts text from pastes.
11049 EAPI Eina_Bool elm_entry_cnp_textonly_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11051 * Enable or disable scrolling in entry
11053 * Normally the entry is not scrollable unless you enable it with this call.
11055 * @param obj The entry object
11056 * @param scroll EINA_TRUE if it is to be scrollable, EINA_FALSE otherwise
11058 EAPI void elm_entry_scrollable_set(Evas_Object *obj, Eina_Bool scroll);
11060 * Get the scrollable state of the entry
11062 * Normally the entry is not scrollable. This gets the scrollable state
11063 * of the entry. See elm_entry_scrollable_set() for more information.
11065 * @param obj The entry object
11066 * @return The scrollable state
11068 EAPI Eina_Bool elm_entry_scrollable_get(const Evas_Object *obj);
11070 * This sets a widget to be displayed to the left of a scrolled entry.
11072 * @param obj The scrolled entry object
11073 * @param icon The widget to display on the left side of the scrolled
11076 * @note A previously set widget will be destroyed.
11077 * @note If the object being set does not have minimum size hints set,
11078 * it won't get properly displayed.
11080 * @see elm_entry_end_set()
11082 EAPI void elm_entry_icon_set(Evas_Object *obj, Evas_Object *icon);
11084 * Gets the leftmost widget of the scrolled entry. This object is
11085 * owned by the scrolled entry and should not be modified.
11087 * @param obj The scrolled entry object
11088 * @return the left widget inside the scroller
11090 EAPI Evas_Object *elm_entry_icon_get(const Evas_Object *obj);
11092 * Unset the leftmost widget of the scrolled entry, unparenting and
11095 * @param obj The scrolled entry object
11096 * @return the previously set icon sub-object of this entry, on
11099 * @see elm_entry_icon_set()
11101 EAPI Evas_Object *elm_entry_icon_unset(Evas_Object *obj);
11103 * Sets the visibility of the left-side widget of the scrolled entry,
11104 * set by elm_entry_icon_set().
11106 * @param obj The scrolled entry object
11107 * @param setting EINA_TRUE if the object should be displayed,
11108 * EINA_FALSE if not.
11110 EAPI void elm_entry_icon_visible_set(Evas_Object *obj, Eina_Bool setting);
11112 * This sets a widget to be displayed to the end of a scrolled entry.
11114 * @param obj The scrolled entry object
11115 * @param end The widget to display on the right side of the scrolled
11118 * @note A previously set widget will be destroyed.
11119 * @note If the object being set does not have minimum size hints set,
11120 * it won't get properly displayed.
11122 * @see elm_entry_icon_set
11124 EAPI void elm_entry_end_set(Evas_Object *obj, Evas_Object *end);
11126 * Gets the endmost widget of the scrolled entry. This object is owned
11127 * by the scrolled entry and should not be modified.
11129 * @param obj The scrolled entry object
11130 * @return the right widget inside the scroller
11132 EAPI Evas_Object *elm_entry_end_get(const Evas_Object *obj);
11134 * Unset the endmost widget of the scrolled entry, unparenting and
11137 * @param obj The scrolled entry object
11138 * @return the previously set icon sub-object of this entry, on
11141 * @see elm_entry_icon_set()
11143 EAPI Evas_Object *elm_entry_end_unset(Evas_Object *obj);
11145 * Sets the visibility of the end widget of the scrolled entry, set by
11146 * elm_entry_end_set().
11148 * @param obj The scrolled entry object
11149 * @param setting EINA_TRUE if the object should be displayed,
11150 * EINA_FALSE if not.
11152 EAPI void elm_entry_end_visible_set(Evas_Object *obj, Eina_Bool setting);
11154 * This sets the scrolled entry's scrollbar policy (ie. enabling/disabling
11157 * Setting an entry to single-line mode with elm_entry_single_line_set()
11158 * will automatically disable the display of scrollbars when the entry
11159 * moves inside its scroller.
11161 * @param obj The scrolled entry object
11162 * @param h The horizontal scrollbar policy to apply
11163 * @param v The vertical scrollbar policy to apply
11165 EAPI void elm_entry_scrollbar_policy_set(Evas_Object *obj, Elm_Scroller_Policy h, Elm_Scroller_Policy v);
11167 * This enables/disables bouncing within the entry.
11169 * This function sets whether the entry will bounce when scrolling reaches
11170 * the end of the contained entry.
11172 * @param obj The scrolled entry object
11173 * @param h The horizontal bounce state
11174 * @param v The vertical bounce state
11176 EAPI void elm_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce);
11178 * Get the bounce mode
11180 * @param obj The Entry object
11181 * @param h_bounce Allow bounce horizontally
11182 * @param v_bounce Allow bounce vertically
11184 EAPI void elm_entry_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce);
11186 /* pre-made filters for entries */
11188 * @typedef Elm_Entry_Filter_Limit_Size
11190 * Data for the elm_entry_filter_limit_size() entry filter.
11192 typedef struct _Elm_Entry_Filter_Limit_Size Elm_Entry_Filter_Limit_Size;
11194 * @struct _Elm_Entry_Filter_Limit_Size
11196 * Data for the elm_entry_filter_limit_size() entry filter.
11198 struct _Elm_Entry_Filter_Limit_Size
11200 int max_char_count; /**< The maximum number of characters allowed. */
11201 int max_byte_count; /**< The maximum number of bytes allowed*/
11204 * Filter inserted text based on user defined character and byte limits
11206 * Add this filter to an entry to limit the characters that it will accept
11207 * based the the contents of the provided #Elm_Entry_Filter_Limit_Size.
11208 * The funtion works on the UTF-8 representation of the string, converting
11209 * it from the set markup, thus not accounting for any format in it.
11211 * The user must create an #Elm_Entry_Filter_Limit_Size structure and pass
11212 * it as data when setting the filter. In it, it's possible to set limits
11213 * by character count or bytes (any of them is disabled if 0), and both can
11214 * be set at the same time. In that case, it first checks for characters,
11217 * The function will cut the inserted text in order to allow only the first
11218 * number of characters that are still allowed. The cut is made in
11219 * characters, even when limiting by bytes, in order to always contain
11220 * valid ones and avoid half unicode characters making it in.
11222 * This filter, like any others, does not apply when setting the entry text
11223 * directly with elm_object_text_set() (or the deprecated
11224 * elm_entry_entry_set()).
11226 EAPI void elm_entry_filter_limit_size(void *data, Evas_Object *entry, char **text) EINA_ARG_NONNULL(1, 2, 3);
11228 * @typedef Elm_Entry_Filter_Accept_Set
11230 * Data for the elm_entry_filter_accept_set() entry filter.
11232 typedef struct _Elm_Entry_Filter_Accept_Set Elm_Entry_Filter_Accept_Set;
11234 * @struct _Elm_Entry_Filter_Accept_Set
11236 * Data for the elm_entry_filter_accept_set() entry filter.
11238 struct _Elm_Entry_Filter_Accept_Set
11240 const char *accepted; /**< Set of characters accepted in the entry. */
11241 const char *rejected; /**< Set of characters rejected from the entry. */
11244 * Filter inserted text based on accepted or rejected sets of characters
11246 * Add this filter to an entry to restrict the set of accepted characters
11247 * based on the sets in the provided #Elm_Entry_Filter_Accept_Set.
11248 * This structure contains both accepted and rejected sets, but they are
11249 * mutually exclusive.
11251 * The @c accepted set takes preference, so if it is set, the filter will
11252 * only work based on the accepted characters, ignoring anything in the
11253 * @c rejected value. If @c accepted is @c NULL, then @c rejected is used.
11255 * In both cases, the function filters by matching utf8 characters to the
11256 * raw markup text, so it can be used to remove formatting tags.
11258 * This filter, like any others, does not apply when setting the entry text
11259 * directly with elm_object_text_set() (or the deprecated
11260 * elm_entry_entry_set()).
11262 EAPI void elm_entry_filter_accept_set(void *data, Evas_Object *entry, char **text) EINA_ARG_NONNULL(1, 3);
11267 /* composite widgets - these basically put together basic widgets above
11268 * in convenient packages that do more than basic stuff */
11272 * @defgroup Anchorview Anchorview
11274 * @image html img/widget/anchorview/preview-00.png
11275 * @image latex img/widget/anchorview/preview-00.eps
11277 * Anchorview is for displaying text that contains markup with anchors
11278 * like <c>\<a href=1234\>something\</\></c> in it.
11280 * Besides being styled differently, the anchorview widget provides the
11281 * necessary functionality so that clicking on these anchors brings up a
11282 * popup with user defined content such as "call", "add to contacts" or
11283 * "open web page". This popup is provided using the @ref Hover widget.
11285 * This widget is very similar to @ref Anchorblock, so refer to that
11286 * widget for an example. The only difference Anchorview has is that the
11287 * widget is already provided with scrolling functionality, so if the
11288 * text set to it is too large to fit in the given space, it will scroll,
11289 * whereas the @ref Anchorblock widget will keep growing to ensure all the
11290 * text can be displayed.
11292 * This widget emits the following signals:
11293 * @li "anchor,clicked": will be called when an anchor is clicked. The
11294 * @p event_info parameter on the callback will be a pointer of type
11295 * ::Elm_Entry_Anchorview_Info.
11297 * See @ref Anchorblock for an example on how to use both of them.
11306 * @typedef Elm_Entry_Anchorview_Info
11308 * The info sent in the callback for "anchor,clicked" signals emitted by
11309 * the Anchorview widget.
11311 typedef struct _Elm_Entry_Anchorview_Info Elm_Entry_Anchorview_Info;
11313 * @struct _Elm_Entry_Anchorview_Info
11315 * The info sent in the callback for "anchor,clicked" signals emitted by
11316 * the Anchorview widget.
11318 struct _Elm_Entry_Anchorview_Info
11320 const char *name; /**< Name of the anchor, as indicated in its href
11322 int button; /**< The mouse button used to click on it */
11323 Evas_Object *hover; /**< The hover object to use for the popup */
11325 Evas_Coord x, y, w, h;
11326 } anchor, /**< Geometry selection of text used as anchor */
11327 hover_parent; /**< Geometry of the object used as parent by the
11329 Eina_Bool hover_left : 1; /**< Hint indicating if there's space
11330 for content on the left side of
11331 the hover. Before calling the
11332 callback, the widget will make the
11333 necessary calculations to check
11334 which sides are fit to be set with
11335 content, based on the position the
11336 hover is activated and its distance
11337 to the edges of its parent object
11339 Eina_Bool hover_right : 1; /**< Hint indicating content fits on
11340 the right side of the hover.
11341 See @ref hover_left */
11342 Eina_Bool hover_top : 1; /**< Hint indicating content fits on top
11343 of the hover. See @ref hover_left */
11344 Eina_Bool hover_bottom : 1; /**< Hint indicating content fits
11345 below the hover. See @ref
11349 * Add a new Anchorview object
11351 * @param parent The parent object
11352 * @return The new object or NULL if it cannot be created
11354 EAPI Evas_Object *elm_anchorview_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
11356 * Set the text to show in the anchorview
11358 * Sets the text of the anchorview to @p text. This text can include markup
11359 * format tags, including <c>\<a href=anchorname\></c> to begin a segment of
11360 * text that will be specially styled and react to click events, ended with
11361 * either of \</a\> or \</\>. When clicked, the anchor will emit an
11362 * "anchor,clicked" signal that you can attach a callback to with
11363 * evas_object_smart_callback_add(). The name of the anchor given in the
11364 * event info struct will be the one set in the href attribute, in this
11365 * case, anchorname.
11367 * Other markup can be used to style the text in different ways, but it's
11368 * up to the style defined in the theme which tags do what.
11369 * @deprecated use elm_object_text_set() instead.
11371 EINA_DEPRECATED EAPI void elm_anchorview_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1);
11373 * Get the markup text set for the anchorview
11375 * Retrieves the text set on the anchorview, with markup tags included.
11377 * @param obj The anchorview object
11378 * @return The markup text set or @c NULL if nothing was set or an error
11380 * @deprecated use elm_object_text_set() instead.
11382 EINA_DEPRECATED EAPI const char *elm_anchorview_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11384 * Set the parent of the hover popup
11386 * Sets the parent object to use by the hover created by the anchorview
11387 * when an anchor is clicked. See @ref Hover for more details on this.
11388 * If no parent is set, the same anchorview object will be used.
11390 * @param obj The anchorview object
11391 * @param parent The object to use as parent for the hover
11393 EAPI void elm_anchorview_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
11395 * Get the parent of the hover popup
11397 * Get the object used as parent for the hover created by the anchorview
11398 * widget. See @ref Hover for more details on this.
11400 * @param obj The anchorview object
11401 * @return The object used as parent for the hover, NULL if none is set.
11403 EAPI Evas_Object *elm_anchorview_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11405 * Set the style that the hover should use
11407 * When creating the popup hover, anchorview will request that it's
11408 * themed according to @p style.
11410 * @param obj The anchorview object
11411 * @param style The style to use for the underlying hover
11413 * @see elm_object_style_set()
11415 EAPI void elm_anchorview_hover_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
11417 * Get the style that the hover should use
11419 * Get the style the hover created by anchorview will use.
11421 * @param obj The anchorview object
11422 * @return The style to use by the hover. NULL means the default is used.
11424 * @see elm_object_style_set()
11426 EAPI const char *elm_anchorview_hover_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11428 * Ends the hover popup in the anchorview
11430 * When an anchor is clicked, the anchorview widget will create a hover
11431 * object to use as a popup with user provided content. This function
11432 * terminates this popup, returning the anchorview to its normal state.
11434 * @param obj The anchorview object
11436 EAPI void elm_anchorview_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
11438 * Set bouncing behaviour when the scrolled content reaches an edge
11440 * Tell the internal scroller object whether it should bounce or not
11441 * when it reaches the respective edges for each axis.
11443 * @param obj The anchorview object
11444 * @param h_bounce Whether to bounce or not in the horizontal axis
11445 * @param v_bounce Whether to bounce or not in the vertical axis
11447 * @see elm_scroller_bounce_set()
11449 EAPI void elm_anchorview_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
11451 * Get the set bouncing behaviour of the internal scroller
11453 * Get whether the internal scroller should bounce when the edge of each
11454 * axis is reached scrolling.
11456 * @param obj The anchorview object
11457 * @param h_bounce Pointer where to store the bounce state of the horizontal
11459 * @param v_bounce Pointer where to store the bounce state of the vertical
11462 * @see elm_scroller_bounce_get()
11464 EAPI void elm_anchorview_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
11466 * Appends a custom item provider to the given anchorview
11468 * Appends the given function to the list of items providers. This list is
11469 * called, one function at a time, with the given @p data pointer, the
11470 * anchorview object and, in the @p item parameter, the item name as
11471 * referenced in its href string. Following functions in the list will be
11472 * called in order until one of them returns something different to NULL,
11473 * which should be an Evas_Object which will be used in place of the item
11476 * Items in the markup text take the form \<item relsize=16x16 vsize=full
11477 * href=item/name\>\</item\>
11479 * @param obj The anchorview object
11480 * @param func The function to add to the list of providers
11481 * @param data User data that will be passed to the callback function
11483 * @see elm_entry_item_provider_append()
11485 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);
11487 * Prepend a custom item provider to the given anchorview
11489 * Like elm_anchorview_item_provider_append(), but it adds the function
11490 * @p func to the beginning of the list, instead of the end.
11492 * @param obj The anchorview object
11493 * @param func The function to add to the list of providers
11494 * @param data User data that will be passed to the callback function
11496 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);
11498 * Remove a custom item provider from the list of the given anchorview
11500 * Removes the function and data pairing that matches @p func and @p data.
11501 * That is, unless the same function and same user data are given, the
11502 * function will not be removed from the list. This allows us to add the
11503 * same callback several times, with different @p data pointers and be
11504 * able to remove them later without conflicts.
11506 * @param obj The anchorview object
11507 * @param func The function to remove from the list
11508 * @param data The data matching the function to remove from the list
11510 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);
11517 * @defgroup Anchorblock Anchorblock
11519 * @image html img/widget/anchorblock/preview-00.png
11520 * @image latex img/widget/anchorblock/preview-00.eps
11522 * Anchorblock is for displaying text that contains markup with anchors
11523 * like <c>\<a href=1234\>something\</\></c> in it.
11525 * Besides being styled differently, the anchorblock widget provides the
11526 * necessary functionality so that clicking on these anchors brings up a
11527 * popup with user defined content such as "call", "add to contacts" or
11528 * "open web page". This popup is provided using the @ref Hover widget.
11530 * This widget emits the following signals:
11531 * @li "anchor,clicked": will be called when an anchor is clicked. The
11532 * @p event_info parameter on the callback will be a pointer of type
11533 * ::Elm_Entry_Anchorblock_Info.
11539 * Since examples are usually better than plain words, we might as well
11540 * try @ref tutorial_anchorblock_example "one".
11543 * @addtogroup Anchorblock
11547 * @typedef Elm_Entry_Anchorblock_Info
11549 * The info sent in the callback for "anchor,clicked" signals emitted by
11550 * the Anchorblock widget.
11552 typedef struct _Elm_Entry_Anchorblock_Info Elm_Entry_Anchorblock_Info;
11554 * @struct _Elm_Entry_Anchorblock_Info
11556 * The info sent in the callback for "anchor,clicked" signals emitted by
11557 * the Anchorblock widget.
11559 struct _Elm_Entry_Anchorblock_Info
11561 const char *name; /**< Name of the anchor, as indicated in its href
11563 int button; /**< The mouse button used to click on it */
11564 Evas_Object *hover; /**< The hover object to use for the popup */
11566 Evas_Coord x, y, w, h;
11567 } anchor, /**< Geometry selection of text used as anchor */
11568 hover_parent; /**< Geometry of the object used as parent by the
11570 Eina_Bool hover_left : 1; /**< Hint indicating if there's space
11571 for content on the left side of
11572 the hover. Before calling the
11573 callback, the widget will make the
11574 necessary calculations to check
11575 which sides are fit to be set with
11576 content, based on the position the
11577 hover is activated and its distance
11578 to the edges of its parent object
11580 Eina_Bool hover_right : 1; /**< Hint indicating content fits on
11581 the right side of the hover.
11582 See @ref hover_left */
11583 Eina_Bool hover_top : 1; /**< Hint indicating content fits on top
11584 of the hover. See @ref hover_left */
11585 Eina_Bool hover_bottom : 1; /**< Hint indicating content fits
11586 below the hover. See @ref
11590 * Add a new Anchorblock object
11592 * @param parent The parent object
11593 * @return The new object or NULL if it cannot be created
11595 EAPI Evas_Object *elm_anchorblock_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
11597 * Set the text to show in the anchorblock
11599 * Sets the text of the anchorblock to @p text. This text can include markup
11600 * format tags, including <c>\<a href=anchorname\></a></c> to begin a segment
11601 * of text that will be specially styled and react to click events, ended
11602 * with either of \</a\> or \</\>. When clicked, the anchor will emit an
11603 * "anchor,clicked" signal that you can attach a callback to with
11604 * evas_object_smart_callback_add(). The name of the anchor given in the
11605 * event info struct will be the one set in the href attribute, in this
11606 * case, anchorname.
11608 * Other markup can be used to style the text in different ways, but it's
11609 * up to the style defined in the theme which tags do what.
11610 * @deprecated use elm_object_text_set() instead.
11612 EINA_DEPRECATED EAPI void elm_anchorblock_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1);
11614 * Get the markup text set for the anchorblock
11616 * Retrieves the text set on the anchorblock, with markup tags included.
11618 * @param obj The anchorblock object
11619 * @return The markup text set or @c NULL if nothing was set or an error
11621 * @deprecated use elm_object_text_set() instead.
11623 EINA_DEPRECATED EAPI const char *elm_anchorblock_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11625 * Set the parent of the hover popup
11627 * Sets the parent object to use by the hover created by the anchorblock
11628 * when an anchor is clicked. See @ref Hover for more details on this.
11630 * @param obj The anchorblock object
11631 * @param parent The object to use as parent for the hover
11633 EAPI void elm_anchorblock_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
11635 * Get the parent of the hover popup
11637 * Get the object used as parent for the hover created by the anchorblock
11638 * widget. See @ref Hover for more details on this.
11639 * If no parent is set, the same anchorblock object will be used.
11641 * @param obj The anchorblock object
11642 * @return The object used as parent for the hover, NULL if none is set.
11644 EAPI Evas_Object *elm_anchorblock_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11646 * Set the style that the hover should use
11648 * When creating the popup hover, anchorblock will request that it's
11649 * themed according to @p style.
11651 * @param obj The anchorblock object
11652 * @param style The style to use for the underlying hover
11654 * @see elm_object_style_set()
11656 EAPI void elm_anchorblock_hover_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
11658 * Get the style that the hover should use
11660 * Get the style the hover created by anchorblock will use.
11662 * @param obj The anchorblock object
11663 * @return The style to use by the hover. NULL means the default is used.
11665 * @see elm_object_style_set()
11667 EAPI const char *elm_anchorblock_hover_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11669 * Ends the hover popup in the anchorblock
11671 * When an anchor is clicked, the anchorblock widget will create a hover
11672 * object to use as a popup with user provided content. This function
11673 * terminates this popup, returning the anchorblock to its normal state.
11675 * @param obj The anchorblock object
11677 EAPI void elm_anchorblock_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
11679 * Appends a custom item provider to the given anchorblock
11681 * Appends the given function to the list of items providers. This list is
11682 * called, one function at a time, with the given @p data pointer, the
11683 * anchorblock object and, in the @p item parameter, the item name as
11684 * referenced in its href string. Following functions in the list will be
11685 * called in order until one of them returns something different to NULL,
11686 * which should be an Evas_Object which will be used in place of the item
11689 * Items in the markup text take the form \<item relsize=16x16 vsize=full
11690 * href=item/name\>\</item\>
11692 * @param obj The anchorblock object
11693 * @param func The function to add to the list of providers
11694 * @param data User data that will be passed to the callback function
11696 * @see elm_entry_item_provider_append()
11698 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);
11700 * Prepend a custom item provider to the given anchorblock
11702 * Like elm_anchorblock_item_provider_append(), but it adds the function
11703 * @p func to the beginning of the list, instead of the end.
11705 * @param obj The anchorblock object
11706 * @param func The function to add to the list of providers
11707 * @param data User data that will be passed to the callback function
11709 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);
11711 * Remove a custom item provider from the list of the given anchorblock
11713 * Removes the function and data pairing that matches @p func and @p data.
11714 * That is, unless the same function and same user data are given, the
11715 * function will not be removed from the list. This allows us to add the
11716 * same callback several times, with different @p data pointers and be
11717 * able to remove them later without conflicts.
11719 * @param obj The anchorblock object
11720 * @param func The function to remove from the list
11721 * @param data The data matching the function to remove from the list
11723 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);
11729 * @defgroup Bubble Bubble
11731 * @image html img/widget/bubble/preview-00.png
11732 * @image latex img/widget/bubble/preview-00.eps
11733 * @image html img/widget/bubble/preview-01.png
11734 * @image latex img/widget/bubble/preview-01.eps
11735 * @image html img/widget/bubble/preview-02.png
11736 * @image latex img/widget/bubble/preview-02.eps
11738 * @brief The Bubble is a widget to show text similarly to how speech is
11739 * represented in comics.
11741 * The bubble widget contains 5 important visual elements:
11742 * @li The frame is a rectangle with rounded rectangles and an "arrow".
11743 * @li The @p icon is an image to which the frame's arrow points to.
11744 * @li The @p label is a text which appears to the right of the icon if the
11745 * corner is "top_left" or "bottom_left" and is right aligned to the frame
11747 * @li The @p info is a text which appears to the right of the label. Info's
11748 * font is of a ligther color than label.
11749 * @li The @p content is an evas object that is shown inside the frame.
11751 * The position of the arrow, icon, label and info depends on which corner is
11752 * selected. The four available corners are:
11753 * @li "top_left" - Default
11755 * @li "bottom_left"
11756 * @li "bottom_right"
11758 * Signals that you can add callbacks for are:
11759 * @li "clicked" - This is called when a user has clicked the bubble.
11761 * For an example of using a buble see @ref bubble_01_example_page "this".
11766 * Add a new bubble to the parent
11768 * @param parent The parent object
11769 * @return The new object or NULL if it cannot be created
11771 * This function adds a text bubble to the given parent evas object.
11773 EAPI Evas_Object *elm_bubble_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
11775 * Set the label of the bubble
11777 * @param obj The bubble object
11778 * @param label The string to set in the label
11780 * This function sets the title of the bubble. Where this appears depends on
11781 * the selected corner.
11782 * @deprecated use elm_object_text_set() instead.
11784 EINA_DEPRECATED EAPI void elm_bubble_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
11786 * Get the label of the bubble
11788 * @param obj The bubble object
11789 * @return The string of set in the label
11791 * This function gets the title of the bubble.
11792 * @deprecated use elm_object_text_get() instead.
11794 EINA_DEPRECATED EAPI const char *elm_bubble_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11796 * Set the info of the bubble
11798 * @param obj The bubble object
11799 * @param info The given info about the bubble
11801 * This function sets the info of the bubble. Where this appears depends on
11802 * the selected corner.
11803 * @deprecated use elm_object_text_part_set() instead. (with "info" as the parameter).
11805 EINA_DEPRECATED EAPI void elm_bubble_info_set(Evas_Object *obj, const char *info) EINA_ARG_NONNULL(1);
11807 * Get the info of the bubble
11809 * @param obj The bubble object
11811 * @return The "info" string of the bubble
11813 * This function gets the info text.
11814 * @deprecated use elm_object_text_part_get() instead. (with "info" as the parameter).
11816 EINA_DEPRECATED EAPI const char *elm_bubble_info_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11818 * Set the content to be shown in the bubble
11820 * Once the content object is set, a previously set one will be deleted.
11821 * If you want to keep the old content object, use the
11822 * elm_bubble_content_unset() function.
11824 * @param obj The bubble object
11825 * @param content The given content of the bubble
11827 * This function sets the content shown on the middle of the bubble.
11829 EAPI void elm_bubble_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
11831 * Get the content shown in the bubble
11833 * Return the content object which is set for this widget.
11835 * @param obj The bubble object
11836 * @return The content that is being used
11838 EAPI Evas_Object *elm_bubble_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11840 * Unset the content shown in the bubble
11842 * Unparent and return the content object which was set for this widget.
11844 * @param obj The bubble object
11845 * @return The content that was being used
11847 EAPI Evas_Object *elm_bubble_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
11849 * Set the icon of the bubble
11851 * Once the icon object is set, a previously set one will be deleted.
11852 * If you want to keep the old content object, use the
11853 * elm_icon_content_unset() function.
11855 * @param obj The bubble object
11856 * @param icon The given icon for the bubble
11858 EAPI void elm_bubble_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
11860 * Get the icon of the bubble
11862 * @param obj The bubble object
11863 * @return The icon for the bubble
11865 * This function gets the icon shown on the top left of bubble.
11867 EAPI Evas_Object *elm_bubble_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11869 * Unset the icon of the bubble
11871 * Unparent and return the icon object which was set for this widget.
11873 * @param obj The bubble object
11874 * @return The icon that was being used
11876 EAPI Evas_Object *elm_bubble_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
11878 * Set the corner of the bubble
11880 * @param obj The bubble object.
11881 * @param corner The given corner for the bubble.
11883 * This function sets the corner of the bubble. The corner will be used to
11884 * determine where the arrow in the frame points to and where label, icon and
11887 * Possible values for corner are:
11888 * @li "top_left" - Default
11890 * @li "bottom_left"
11891 * @li "bottom_right"
11893 EAPI void elm_bubble_corner_set(Evas_Object *obj, const char *corner) EINA_ARG_NONNULL(1, 2);
11895 * Get the corner of the bubble
11897 * @param obj The bubble object.
11898 * @return The given corner for the bubble.
11900 * This function gets the selected corner of the bubble.
11902 EAPI const char *elm_bubble_corner_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11908 * @defgroup Photo Photo
11910 * For displaying the photo of a person (contact). Simple yet
11911 * with a very specific purpose.
11913 * Signals that you can add callbacks for are:
11915 * "clicked" - This is called when a user has clicked the photo
11916 * "drag,start" - Someone started dragging the image out of the object
11917 * "drag,end" - Dragged item was dropped (somewhere)
11923 * Add a new photo to the parent
11925 * @param parent The parent object
11926 * @return The new object or NULL if it cannot be created
11930 EAPI Evas_Object *elm_photo_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
11933 * Set the file that will be used as photo
11935 * @param obj The photo object
11936 * @param file The path to file that will be used as photo
11938 * @return (1 = success, 0 = error)
11942 EAPI Eina_Bool elm_photo_file_set(Evas_Object *obj, const char *file) EINA_ARG_NONNULL(1);
11945 * Set the size that will be used on the photo
11947 * @param obj The photo object
11948 * @param size The size that the photo will be
11952 EAPI void elm_photo_size_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
11955 * Set if the photo should be completely visible or not.
11957 * @param obj The photo object
11958 * @param fill if true the photo will be completely visible
11962 EAPI void elm_photo_fill_inside_set(Evas_Object *obj, Eina_Bool fill) EINA_ARG_NONNULL(1);
11965 * Set editability of the photo.
11967 * An editable photo can be dragged to or from, and can be cut or
11968 * pasted too. Note that pasting an image or dropping an item on
11969 * the image will delete the existing content.
11971 * @param obj The photo object.
11972 * @param set To set of clear editablity.
11974 EAPI void elm_photo_editable_set(Evas_Object *obj, Eina_Bool set) EINA_ARG_NONNULL(1);
11980 /* gesture layer */
11982 * @defgroup Elm_Gesture_Layer Gesture Layer
11983 * Gesture Layer Usage:
11985 * Use Gesture Layer to detect gestures.
11986 * The advantage is that you don't have to implement
11987 * gesture detection, just set callbacks of gesture state.
11988 * By using gesture layer we make standard interface.
11990 * In order to use Gesture Layer you start with @ref elm_gesture_layer_add
11991 * with a parent object parameter.
11992 * Next 'activate' gesture layer with a @ref elm_gesture_layer_attach
11993 * call. Usually with same object as target (2nd parameter).
11995 * Now you need to tell gesture layer what gestures you follow.
11996 * This is done with @ref elm_gesture_layer_cb_set call.
11997 * By setting the callback you actually saying to gesture layer:
11998 * I would like to know when the gesture @ref Elm_Gesture_Types
11999 * switches to state @ref Elm_Gesture_State.
12001 * Next, you need to implement the actual action that follows the input
12002 * in your callback.
12004 * Note that if you like to stop being reported about a gesture, just set
12005 * all callbacks referring this gesture to NULL.
12006 * (again with @ref elm_gesture_layer_cb_set)
12008 * The information reported by gesture layer to your callback is depending
12009 * on @ref Elm_Gesture_Types:
12010 * @ref Elm_Gesture_Taps_Info is the info reported for tap gestures:
12011 * @ref ELM_GESTURE_N_TAPS, @ref ELM_GESTURE_N_LONG_TAPS,
12012 * @ref ELM_GESTURE_N_DOUBLE_TAPS, @ref ELM_GESTURE_N_TRIPLE_TAPS.
12014 * @ref Elm_Gesture_Momentum_Info is info reported for momentum gestures:
12015 * @ref ELM_GESTURE_MOMENTUM.
12017 * @ref Elm_Gesture_Line_Info is the info reported for line gestures:
12018 * (this also contains @ref Elm_Gesture_Momentum_Info internal structure)
12019 * @ref ELM_GESTURE_N_LINES, @ref ELM_GESTURE_N_FLICKS.
12020 * Note that we consider a flick as a line-gesture that should be completed
12021 * in flick-time-limit as defined in @ref Config.
12023 * @ref Elm_Gesture_Zoom_Info is the info reported for @ref ELM_GESTURE_ZOOM gesture.
12025 * @ref Elm_Gesture_Rotate_Info is the info reported for @ref ELM_GESTURE_ROTATE gesture.
12029 * @enum _Elm_Gesture_Types
12030 * Enum of supported gesture types.
12031 * @ingroup Elm_Gesture_Layer
12033 enum _Elm_Gesture_Types
12035 ELM_GESTURE_FIRST = 0,
12037 ELM_GESTURE_N_TAPS, /**< N fingers single taps */
12038 ELM_GESTURE_N_LONG_TAPS, /**< N fingers single long-taps */
12039 ELM_GESTURE_N_DOUBLE_TAPS, /**< N fingers double-single taps */
12040 ELM_GESTURE_N_TRIPLE_TAPS, /**< N fingers triple-single taps */
12042 ELM_GESTURE_MOMENTUM, /**< Reports momentum in the dircetion of move */
12044 ELM_GESTURE_N_LINES, /**< N fingers line gesture */
12045 ELM_GESTURE_N_FLICKS, /**< N fingers flick gesture */
12047 ELM_GESTURE_ZOOM, /**< Zoom */
12048 ELM_GESTURE_ROTATE, /**< Rotate */
12054 * @typedef Elm_Gesture_Types
12055 * gesture types enum
12056 * @ingroup Elm_Gesture_Layer
12058 typedef enum _Elm_Gesture_Types Elm_Gesture_Types;
12061 * @enum _Elm_Gesture_State
12062 * Enum of gesture states.
12063 * @ingroup Elm_Gesture_Layer
12065 enum _Elm_Gesture_State
12067 ELM_GESTURE_STATE_UNDEFINED = -1, /**< Gesture not STARTed */
12068 ELM_GESTURE_STATE_START, /**< Gesture STARTed */
12069 ELM_GESTURE_STATE_MOVE, /**< Gesture is ongoing */
12070 ELM_GESTURE_STATE_END, /**< Gesture completed */
12071 ELM_GESTURE_STATE_ABORT /**< Onging gesture was ABORTed */
12075 * @typedef Elm_Gesture_State
12076 * gesture states enum
12077 * @ingroup Elm_Gesture_Layer
12079 typedef enum _Elm_Gesture_State Elm_Gesture_State;
12082 * @struct _Elm_Gesture_Taps_Info
12083 * Struct holds taps info for user
12084 * @ingroup Elm_Gesture_Layer
12086 struct _Elm_Gesture_Taps_Info
12088 Evas_Coord x, y; /**< Holds center point between fingers */
12089 unsigned int n; /**< Number of fingers tapped */
12090 unsigned int timestamp; /**< event timestamp */
12094 * @typedef Elm_Gesture_Taps_Info
12095 * holds taps info for user
12096 * @ingroup Elm_Gesture_Layer
12098 typedef struct _Elm_Gesture_Taps_Info Elm_Gesture_Taps_Info;
12101 * @struct _Elm_Gesture_Momentum_Info
12102 * Struct holds momentum info for user
12103 * x1 and y1 are not necessarily in sync
12104 * x1 holds x value of x direction starting point
12105 * and same holds for y1.
12106 * This is noticeable when doing V-shape movement
12107 * @ingroup Elm_Gesture_Layer
12109 struct _Elm_Gesture_Momentum_Info
12110 { /* Report line ends, timestamps, and momentum computed */
12111 Evas_Coord x1; /**< Final-swipe direction starting point on X */
12112 Evas_Coord y1; /**< Final-swipe direction starting point on Y */
12113 Evas_Coord x2; /**< Final-swipe direction ending point on X */
12114 Evas_Coord y2; /**< Final-swipe direction ending point on Y */
12116 unsigned int tx; /**< Timestamp of start of final x-swipe */
12117 unsigned int ty; /**< Timestamp of start of final y-swipe */
12119 Evas_Coord mx; /**< Momentum on X */
12120 Evas_Coord my; /**< Momentum on Y */
12124 * @typedef Elm_Gesture_Momentum_Info
12125 * holds momentum info for user
12126 * @ingroup Elm_Gesture_Layer
12128 typedef struct _Elm_Gesture_Momentum_Info Elm_Gesture_Momentum_Info;
12131 * @struct _Elm_Gesture_Line_Info
12132 * Struct holds line info for user
12133 * @ingroup Elm_Gesture_Layer
12135 struct _Elm_Gesture_Line_Info
12136 { /* Report line ends, timestamps, and momentum computed */
12137 Elm_Gesture_Momentum_Info momentum; /**< Line momentum info */
12138 unsigned int n; /**< Number of fingers (lines) */
12139 /* FIXME should be radians, bot degrees */
12140 double angle; /**< Angle (direction) of lines */
12144 * @typedef Elm_Gesture_Line_Info
12145 * Holds line info for user
12146 * @ingroup Elm_Gesture_Layer
12148 typedef struct _Elm_Gesture_Line_Info Elm_Gesture_Line_Info;
12151 * @struct _Elm_Gesture_Zoom_Info
12152 * Struct holds zoom info for user
12153 * @ingroup Elm_Gesture_Layer
12155 struct _Elm_Gesture_Zoom_Info
12157 Evas_Coord x, y; /**< Holds zoom center point reported to user */
12158 Evas_Coord radius; /**< Holds radius between fingers reported to user */
12159 double zoom; /**< Zoom value: 1.0 means no zoom */
12160 double momentum; /**< Zoom momentum: zoom growth per second (NOT YET SUPPORTED) */
12164 * @typedef Elm_Gesture_Zoom_Info
12165 * Holds zoom info for user
12166 * @ingroup Elm_Gesture_Layer
12168 typedef struct _Elm_Gesture_Zoom_Info Elm_Gesture_Zoom_Info;
12171 * @struct _Elm_Gesture_Rotate_Info
12172 * Struct holds rotation info for user
12173 * @ingroup Elm_Gesture_Layer
12175 struct _Elm_Gesture_Rotate_Info
12177 Evas_Coord x, y; /**< Holds zoom center point reported to user */
12178 Evas_Coord radius; /**< Holds radius between fingers reported to user */
12179 double base_angle; /**< Holds start-angle */
12180 double angle; /**< Rotation value: 0.0 means no rotation */
12181 double momentum; /**< Rotation momentum: rotation done per second (NOT YET SUPPORTED) */
12185 * @typedef Elm_Gesture_Rotate_Info
12186 * Holds rotation info for user
12187 * @ingroup Elm_Gesture_Layer
12189 typedef struct _Elm_Gesture_Rotate_Info Elm_Gesture_Rotate_Info;
12192 * @typedef Elm_Gesture_Event_Cb
12193 * User callback used to stream gesture info from gesture layer
12194 * @param data user data
12195 * @param event_info gesture report info
12196 * Returns a flag field to be applied on the causing event.
12197 * You should probably return EVAS_EVENT_FLAG_ON_HOLD if your widget acted
12198 * upon the event, in an irreversible way.
12200 * @ingroup Elm_Gesture_Layer
12202 typedef Evas_Event_Flags (*Elm_Gesture_Event_Cb) (void *data, void *event_info);
12205 * Use function to set callbacks to be notified about
12206 * change of state of gesture.
12207 * When a user registers a callback with this function
12208 * this means this gesture has to be tested.
12210 * When ALL callbacks for a gesture are set to NULL
12211 * it means user isn't interested in gesture-state
12212 * and it will not be tested.
12214 * @param obj Pointer to gesture-layer.
12215 * @param idx The gesture you would like to track its state.
12216 * @param cb callback function pointer.
12217 * @param cb_type what event this callback tracks: START, MOVE, END, ABORT.
12218 * @param data user info to be sent to callback (usually, Smart Data)
12220 * @ingroup Elm_Gesture_Layer
12222 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);
12225 * Call this function to get repeat-events settings.
12227 * @param obj Pointer to gesture-layer.
12229 * @return repeat events settings.
12230 * @see elm_gesture_layer_hold_events_set()
12231 * @ingroup Elm_Gesture_Layer
12233 EAPI Eina_Bool elm_gesture_layer_hold_events_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
12236 * This function called in order to make gesture-layer repeat events.
12237 * Set this of you like to get the raw events only if gestures were not detected.
12238 * Clear this if you like gesture layer to fwd events as testing gestures.
12240 * @param obj Pointer to gesture-layer.
12241 * @param r Repeat: TRUE/FALSE
12243 * @ingroup Elm_Gesture_Layer
12245 EAPI void elm_gesture_layer_hold_events_set(Evas_Object *obj, Eina_Bool r) EINA_ARG_NONNULL(1);
12248 * This function sets step-value for zoom action.
12249 * Set step to any positive value.
12250 * Cancel step setting by setting to 0.0
12252 * @param obj Pointer to gesture-layer.
12253 * @param s new zoom step value.
12255 * @ingroup Elm_Gesture_Layer
12257 EAPI void elm_gesture_layer_zoom_step_set(Evas_Object *obj, double s) EINA_ARG_NONNULL(1);
12260 * This function sets step-value for rotate action.
12261 * Set step to any positive value.
12262 * Cancel step setting by setting to 0.0
12264 * @param obj Pointer to gesture-layer.
12265 * @param s new roatate step value.
12267 * @ingroup Elm_Gesture_Layer
12269 EAPI void elm_gesture_layer_rotate_step_set(Evas_Object *obj, double s) EINA_ARG_NONNULL(1);
12272 * This function called to attach gesture-layer to an Evas_Object.
12273 * @param obj Pointer to gesture-layer.
12274 * @param t Pointer to underlying object (AKA Target)
12276 * @return TRUE, FALSE on success, failure.
12278 * @ingroup Elm_Gesture_Layer
12280 EAPI Eina_Bool elm_gesture_layer_attach(Evas_Object *obj, Evas_Object *t) EINA_ARG_NONNULL(1, 2);
12283 * Call this function to construct a new gesture-layer object.
12284 * This does not activate the gesture layer. You have to
12285 * call elm_gesture_layer_attach in order to 'activate' gesture-layer.
12287 * @param parent the parent object.
12289 * @return Pointer to new gesture-layer object.
12291 * @ingroup Elm_Gesture_Layer
12293 EAPI Evas_Object *elm_gesture_layer_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12296 * @defgroup Thumb Thumb
12298 * @image html img/widget/thumb/preview-00.png
12299 * @image latex img/widget/thumb/preview-00.eps
12301 * A thumb object is used for displaying the thumbnail of an image or video.
12302 * You must have compiled Elementary with Ethumb_Client support and the DBus
12303 * service must be present and auto-activated in order to have thumbnails to
12306 * Once the thumbnail object becomes visible, it will check if there is a
12307 * previously generated thumbnail image for the file set on it. If not, it
12308 * will start generating this thumbnail.
12310 * Different config settings will cause different thumbnails to be generated
12311 * even on the same file.
12313 * Generated thumbnails are stored under @c $HOME/.thumbnails/. Check the
12314 * Ethumb documentation to change this path, and to see other configuration
12317 * Signals that you can add callbacks for are:
12319 * - "clicked" - This is called when a user has clicked the thumb without dragging
12321 * - "clicked,double" - This is called when a user has double-clicked the thumb.
12322 * - "press" - This is called when a user has pressed down the thumb.
12323 * - "generate,start" - The thumbnail generation started.
12324 * - "generate,stop" - The generation process stopped.
12325 * - "generate,error" - The generation failed.
12326 * - "load,error" - The thumbnail image loading failed.
12328 * available styles:
12332 * An example of use of thumbnail:
12334 * - @ref thumb_example_01
12338 * @addtogroup Thumb
12343 * @enum _Elm_Thumb_Animation_Setting
12344 * @typedef Elm_Thumb_Animation_Setting
12346 * Used to set if a video thumbnail is animating or not.
12350 typedef enum _Elm_Thumb_Animation_Setting
12352 ELM_THUMB_ANIMATION_START = 0, /**< Play animation once */
12353 ELM_THUMB_ANIMATION_LOOP, /**< Keep playing animation until stop is requested */
12354 ELM_THUMB_ANIMATION_STOP, /**< Stop playing the animation */
12355 ELM_THUMB_ANIMATION_LAST
12356 } Elm_Thumb_Animation_Setting;
12359 * Add a new thumb object to the parent.
12361 * @param parent The parent object.
12362 * @return The new object or NULL if it cannot be created.
12364 * @see elm_thumb_file_set()
12365 * @see elm_thumb_ethumb_client_get()
12369 EAPI Evas_Object *elm_thumb_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12371 * Reload thumbnail if it was generated before.
12373 * @param obj The thumb object to reload
12375 * This is useful if the ethumb client configuration changed, like its
12376 * size, aspect or any other property one set in the handle returned
12377 * by elm_thumb_ethumb_client_get().
12379 * If the options didn't change, the thumbnail won't be generated again, but
12380 * the old one will still be used.
12382 * @see elm_thumb_file_set()
12386 EAPI void elm_thumb_reload(Evas_Object *obj) EINA_ARG_NONNULL(1);
12388 * Set the file that will be used as thumbnail.
12390 * @param obj The thumb object.
12391 * @param file The path to file that will be used as thumb.
12392 * @param key The key used in case of an EET file.
12394 * The file can be an image or a video (in that case, acceptable extensions are:
12395 * avi, mp4, ogv, mov, mpg and wmv). To start the video animation, use the
12396 * function elm_thumb_animate().
12398 * @see elm_thumb_file_get()
12399 * @see elm_thumb_reload()
12400 * @see elm_thumb_animate()
12404 EAPI void elm_thumb_file_set(Evas_Object *obj, const char *file, const char *key) EINA_ARG_NONNULL(1);
12406 * Get the image or video path and key used to generate the thumbnail.
12408 * @param obj The thumb object.
12409 * @param file Pointer to filename.
12410 * @param key Pointer to key.
12412 * @see elm_thumb_file_set()
12413 * @see elm_thumb_path_get()
12417 EAPI void elm_thumb_file_get(const Evas_Object *obj, const char **file, const char **key) EINA_ARG_NONNULL(1);
12419 * Get the path and key to the image or video generated by ethumb.
12421 * One just need to make sure that the thumbnail was generated before getting
12422 * its path; otherwise, the path will be NULL. One way to do that is by asking
12423 * for the path when/after the "generate,stop" smart callback is called.
12425 * @param obj The thumb object.
12426 * @param file Pointer to thumb path.
12427 * @param key Pointer to thumb key.
12429 * @see elm_thumb_file_get()
12433 EAPI void elm_thumb_path_get(const Evas_Object *obj, const char **file, const char **key) EINA_ARG_NONNULL(1);
12435 * Set the animation state for the thumb object. If its content is an animated
12436 * video, you may start/stop the animation or tell it to play continuously and
12439 * @param obj The thumb object.
12440 * @param setting The animation setting.
12442 * @see elm_thumb_file_set()
12446 EAPI void elm_thumb_animate_set(Evas_Object *obj, Elm_Thumb_Animation_Setting s) EINA_ARG_NONNULL(1);
12448 * Get the animation state for the thumb object.
12450 * @param obj The thumb object.
12451 * @return getting The animation setting or @c ELM_THUMB_ANIMATION_LAST,
12454 * @see elm_thumb_animate_set()
12458 EAPI Elm_Thumb_Animation_Setting elm_thumb_animate_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12460 * Get the ethumb_client handle so custom configuration can be made.
12462 * @return Ethumb_Client instance or NULL.
12464 * This must be called before the objects are created to be sure no object is
12465 * visible and no generation started.
12467 * Example of usage:
12470 * #include <Elementary.h>
12471 * #ifndef ELM_LIB_QUICKLAUNCH
12473 * elm_main(int argc, char **argv)
12475 * Ethumb_Client *client;
12477 * elm_need_ethumb();
12481 * client = elm_thumb_ethumb_client_get();
12484 * ERR("could not get ethumb_client");
12487 * ethumb_client_size_set(client, 100, 100);
12488 * ethumb_client_crop_align_set(client, 0.5, 0.5);
12491 * // Create elm_thumb objects here
12501 * @note There's only one client handle for Ethumb, so once a configuration
12502 * change is done to it, any other request for thumbnails (for any thumbnail
12503 * object) will use that configuration. Thus, this configuration is global.
12507 EAPI void *elm_thumb_ethumb_client_get(void);
12509 * Get the ethumb_client connection state.
12511 * @return EINA_TRUE if the client is connected to the server or EINA_FALSE
12514 EAPI Eina_Bool elm_thumb_ethumb_client_connected(void);
12516 * Make the thumbnail 'editable'.
12518 * @param obj Thumb object.
12519 * @param set Turn on or off editability. Default is @c EINA_FALSE.
12521 * This means the thumbnail is a valid drag target for drag and drop, and can be
12522 * cut or pasted too.
12524 * @see elm_thumb_editable_get()
12528 EAPI Eina_Bool elm_thumb_editable_set(Evas_Object *obj, Eina_Bool edit) EINA_ARG_NONNULL(1);
12530 * Make the thumbnail 'editable'.
12532 * @param obj Thumb object.
12533 * @return Editability.
12535 * This means the thumbnail is a valid drag target for drag and drop, and can be
12536 * cut or pasted too.
12538 * @see elm_thumb_editable_set()
12542 EAPI Eina_Bool elm_thumb_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12549 * @defgroup Hoversel Hoversel
12551 * @image html img/widget/hoversel/preview-00.png
12552 * @image latex img/widget/hoversel/preview-00.eps
12554 * A hoversel is a button that pops up a list of items (automatically
12555 * choosing the direction to display) that have a label and, optionally, an
12556 * icon to select from. It is a convenience widget to avoid the need to do
12557 * all the piecing together yourself. It is intended for a small number of
12558 * items in the hoversel menu (no more than 8), though is capable of many
12561 * Signals that you can add callbacks for are:
12562 * "clicked" - the user clicked the hoversel button and popped up the sel
12563 * "selected" - an item in the hoversel list is selected. event_info is the item
12564 * "dismissed" - the hover is dismissed
12566 * See @ref tutorial_hoversel for an example.
12569 typedef struct _Elm_Hoversel_Item Elm_Hoversel_Item; /**< Item of Elm_Hoversel. Sub-type of Elm_Widget_Item */
12571 * @brief Add a new Hoversel object
12573 * @param parent The parent object
12574 * @return The new object or NULL if it cannot be created
12576 EAPI Evas_Object *elm_hoversel_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12578 * @brief This sets the hoversel to expand horizontally.
12580 * @param obj The hoversel object
12581 * @param horizontal If true, the hover will expand horizontally to the
12584 * @note The initial button will display horizontally regardless of this
12587 EAPI void elm_hoversel_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
12589 * @brief This returns whether the hoversel is set to expand horizontally.
12591 * @param obj The hoversel object
12592 * @return If true, the hover will expand horizontally to the right.
12594 * @see elm_hoversel_horizontal_set()
12596 EAPI Eina_Bool elm_hoversel_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12598 * @brief Set the Hover parent
12600 * @param obj The hoversel object
12601 * @param parent The parent to use
12603 * Sets the hover parent object, the area that will be darkened when the
12604 * hoversel is clicked. Should probably be the window that the hoversel is
12605 * in. See @ref Hover objects for more information.
12607 EAPI void elm_hoversel_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
12609 * @brief Get the Hover parent
12611 * @param obj The hoversel object
12612 * @return The used parent
12614 * Gets the hover parent object.
12616 * @see elm_hoversel_hover_parent_set()
12618 EAPI Evas_Object *elm_hoversel_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12620 * @brief Set the hoversel button label
12622 * @param obj The hoversel object
12623 * @param label The label text.
12625 * This sets the label of the button that is always visible (before it is
12626 * clicked and expanded).
12628 * @deprecated elm_object_text_set()
12630 EINA_DEPRECATED EAPI void elm_hoversel_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
12632 * @brief Get the hoversel button label
12634 * @param obj The hoversel object
12635 * @return The label text.
12637 * @deprecated elm_object_text_get()
12639 EINA_DEPRECATED EAPI const char *elm_hoversel_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12641 * @brief Set the icon of the hoversel button
12643 * @param obj The hoversel object
12644 * @param icon The icon object
12646 * Sets the icon of the button that is always visible (before it is clicked
12647 * and expanded). Once the icon object is set, a previously set one will be
12648 * deleted, if you want to keep that old content object, use the
12649 * elm_hoversel_icon_unset() function.
12651 * @see elm_button_icon_set()
12653 EAPI void elm_hoversel_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
12655 * @brief Get the icon of the hoversel button
12657 * @param obj The hoversel object
12658 * @return The icon object
12660 * Get the icon of the button that is always visible (before it is clicked
12661 * and expanded). Also see elm_button_icon_get().
12663 * @see elm_hoversel_icon_set()
12665 EAPI Evas_Object *elm_hoversel_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12667 * @brief Get and unparent the icon of the hoversel button
12669 * @param obj The hoversel object
12670 * @return The icon object that was being used
12672 * Unparent and return the icon of the button that is always visible
12673 * (before it is clicked and expanded).
12675 * @see elm_hoversel_icon_set()
12676 * @see elm_button_icon_unset()
12678 EAPI Evas_Object *elm_hoversel_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
12680 * @brief This triggers the hoversel popup from code, the same as if the user
12681 * had clicked the button.
12683 * @param obj The hoversel object
12685 EAPI void elm_hoversel_hover_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
12687 * @brief This dismisses the hoversel popup as if the user had clicked
12688 * outside the hover.
12690 * @param obj The hoversel object
12692 EAPI void elm_hoversel_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
12694 * @brief Returns whether the hoversel is expanded.
12696 * @param obj The hoversel object
12697 * @return This will return EINA_TRUE if the hoversel is expanded or
12698 * EINA_FALSE if it is not expanded.
12700 EAPI Eina_Bool elm_hoversel_expanded_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12702 * @brief This will remove all the children items from the hoversel.
12704 * @param obj The hoversel object
12706 * @warning Should @b not be called while the hoversel is active; use
12707 * elm_hoversel_expanded_get() to check first.
12709 * @see elm_hoversel_item_del_cb_set()
12710 * @see elm_hoversel_item_del()
12712 EAPI void elm_hoversel_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
12714 * @brief Get the list of items within the given hoversel.
12716 * @param obj The hoversel object
12717 * @return Returns a list of Elm_Hoversel_Item*
12719 * @see elm_hoversel_item_add()
12721 EAPI const Eina_List *elm_hoversel_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12723 * @brief Add an item to the hoversel button
12725 * @param obj The hoversel object
12726 * @param label The text label to use for the item (NULL if not desired)
12727 * @param icon_file An image file path on disk to use for the icon or standard
12728 * icon name (NULL if not desired)
12729 * @param icon_type The icon type if relevant
12730 * @param func Convenience function to call when this item is selected
12731 * @param data Data to pass to item-related functions
12732 * @return A handle to the item added.
12734 * This adds an item to the hoversel to show when it is clicked. Note: if you
12735 * need to use an icon from an edje file then use
12736 * elm_hoversel_item_icon_set() right after the this function, and set
12737 * icon_file to NULL here.
12739 * For more information on what @p icon_file and @p icon_type are see the
12740 * @ref Icon "icon documentation".
12742 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);
12744 * @brief Delete an item from the hoversel
12746 * @param item The item to delete
12748 * This deletes the item from the hoversel (should not be called while the
12749 * hoversel is active; use elm_hoversel_expanded_get() to check first).
12751 * @see elm_hoversel_item_add()
12752 * @see elm_hoversel_item_del_cb_set()
12754 EAPI void elm_hoversel_item_del(Elm_Hoversel_Item *item) EINA_ARG_NONNULL(1);
12756 * @brief Set the function to be called when an item from the hoversel is
12759 * @param item The item to set the callback on
12760 * @param func The function called
12762 * That function will receive these parameters:
12763 * @li void *item_data
12764 * @li Evas_Object *the_item_object
12765 * @li Elm_Hoversel_Item *the_object_struct
12767 * @see elm_hoversel_item_add()
12769 EAPI void elm_hoversel_item_del_cb_set(Elm_Hoversel_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
12771 * @brief This returns the data pointer supplied with elm_hoversel_item_add()
12772 * that will be passed to associated function callbacks.
12774 * @param item The item to get the data from
12775 * @return The data pointer set with elm_hoversel_item_add()
12777 * @see elm_hoversel_item_add()
12779 EAPI void *elm_hoversel_item_data_get(const Elm_Hoversel_Item *it) EINA_ARG_NONNULL(1);
12781 * @brief This returns the label text of the given hoversel item.
12783 * @param item The item to get the label
12784 * @return The label text of the hoversel item
12786 * @see elm_hoversel_item_add()
12788 EAPI const char *elm_hoversel_item_label_get(const Elm_Hoversel_Item *it) EINA_ARG_NONNULL(1);
12790 * @brief This sets the icon for the given hoversel item.
12792 * @param item The item to set the icon
12793 * @param icon_file An image file path on disk to use for the icon or standard
12795 * @param icon_group The edje group to use if @p icon_file is an edje file. Set this
12796 * to NULL if the icon is not an edje file
12797 * @param icon_type The icon type
12799 * The icon can be loaded from the standard set, from an image file, or from
12802 * @see elm_hoversel_item_add()
12804 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);
12806 * @brief Get the icon object of the hoversel item
12808 * @param item The item to get the icon from
12809 * @param icon_file The image file path on disk used for the icon or standard
12811 * @param icon_group The edje group used if @p icon_file is an edje file. NULL
12812 * if the icon is not an edje file
12813 * @param icon_type The icon type
12815 * @see elm_hoversel_item_icon_set()
12816 * @see elm_hoversel_item_add()
12818 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);
12824 * @defgroup Toolbar Toolbar
12825 * @ingroup Elementary
12827 * @image html img/widget/toolbar/preview-00.png
12828 * @image latex img/widget/toolbar/preview-00.eps width=\textwidth
12830 * @image html img/toolbar.png
12831 * @image latex img/toolbar.eps width=\textwidth
12833 * A toolbar is a widget that displays a list of items inside
12834 * a box. It can be scrollable, show a menu with items that don't fit
12835 * to toolbar size or even crop them.
12837 * Only one item can be selected at a time.
12839 * Items can have multiple states, or show menus when selected by the user.
12841 * Smart callbacks one can listen to:
12842 * - "clicked" - when the user clicks on a toolbar item and becomes selected.
12844 * Available styles for it:
12846 * - @c "transparent" - no background or shadow, just show the content
12848 * List of examples:
12849 * @li @ref toolbar_example_01
12850 * @li @ref toolbar_example_02
12851 * @li @ref toolbar_example_03
12855 * @addtogroup Toolbar
12860 * @enum _Elm_Toolbar_Shrink_Mode
12861 * @typedef Elm_Toolbar_Shrink_Mode
12863 * Set toolbar's items display behavior, it can be scrollabel,
12864 * show a menu with exceeding items, or simply hide them.
12866 * @note Default value is #ELM_TOOLBAR_SHRINK_MENU. It reads value
12869 * Values <b> don't </b> work as bitmask, only one can be choosen.
12871 * @see elm_toolbar_mode_shrink_set()
12872 * @see elm_toolbar_mode_shrink_get()
12876 typedef enum _Elm_Toolbar_Shrink_Mode
12878 ELM_TOOLBAR_SHRINK_NONE, /**< Set toolbar minimun size to fit all the items. */
12879 ELM_TOOLBAR_SHRINK_HIDE, /**< Hide exceeding items. */
12880 ELM_TOOLBAR_SHRINK_SCROLL, /**< Allow accessing exceeding items through a scroller. */
12881 ELM_TOOLBAR_SHRINK_MENU /**< Inserts a button to pop up a menu with exceeding items. */
12882 } Elm_Toolbar_Shrink_Mode;
12884 typedef struct _Elm_Toolbar_Item Elm_Toolbar_Item; /**< Item of Elm_Toolbar. Sub-type of Elm_Widget_Item. Can be created with elm_toolbar_item_append(), elm_toolbar_item_prepend() and functions to add items in relative positions, like elm_toolbar_item_insert_before(), and deleted with elm_toolbar_item_del(). */
12886 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(). */
12889 * Add a new toolbar widget to the given parent Elementary
12890 * (container) object.
12892 * @param parent The parent object.
12893 * @return a new toolbar widget handle or @c NULL, on errors.
12895 * This function inserts a new toolbar widget on the canvas.
12899 EAPI Evas_Object *elm_toolbar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12902 * Set the icon size, in pixels, to be used by toolbar items.
12904 * @param obj The toolbar object
12905 * @param icon_size The icon size in pixels
12907 * @note Default value is @c 32. It reads value from elm config.
12909 * @see elm_toolbar_icon_size_get()
12913 EAPI void elm_toolbar_icon_size_set(Evas_Object *obj, int icon_size) EINA_ARG_NONNULL(1);
12916 * Get the icon size, in pixels, to be used by toolbar items.
12918 * @param obj The toolbar object.
12919 * @return The icon size in pixels.
12921 * @see elm_toolbar_icon_size_set() for details.
12925 EAPI int elm_toolbar_icon_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12928 * Sets icon lookup order, for toolbar items' icons.
12930 * @param obj The toolbar object.
12931 * @param order The icon lookup order.
12933 * Icons added before calling this function will not be affected.
12934 * The default lookup order is #ELM_ICON_LOOKUP_THEME_FDO.
12936 * @see elm_toolbar_icon_order_lookup_get()
12940 EAPI void elm_toolbar_icon_order_lookup_set(Evas_Object *obj, Elm_Icon_Lookup_Order order) EINA_ARG_NONNULL(1);
12943 * Gets the icon lookup order.
12945 * @param obj The toolbar object.
12946 * @return The icon lookup order.
12948 * @see elm_toolbar_icon_order_lookup_set() for details.
12952 EAPI Elm_Icon_Lookup_Order elm_toolbar_icon_order_lookup_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12955 * Set whether the toolbar items' should be selected by the user or not.
12957 * @param obj The toolbar object.
12958 * @param wrap @c EINA_TRUE to disable selection or @c EINA_FALSE to
12961 * This will turn off the ability to select items entirely and they will
12962 * neither appear selected nor emit selected signals. The clicked
12963 * callback function will still be called.
12965 * Selection is enabled by default.
12967 * @see elm_toolbar_no_select_mode_get().
12971 EAPI void elm_toolbar_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
12974 * Set whether the toolbar items' should be selected by the user or not.
12976 * @param obj The toolbar object.
12977 * @return @c EINA_TRUE means items can be selected. @c EINA_FALSE indicates
12978 * they can't. If @p obj is @c NULL, @c EINA_FALSE is returned.
12980 * @see elm_toolbar_no_select_mode_set() for details.
12984 EAPI Eina_Bool elm_toolbar_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12987 * Append item to the toolbar.
12989 * @param obj The toolbar object.
12990 * @param icon A string with icon name or the absolute path of an image file.
12991 * @param label The label of the item.
12992 * @param func The function to call when the item is clicked.
12993 * @param data The data to associate with the item for related callbacks.
12994 * @return The created item or @c NULL upon failure.
12996 * A new item will be created and appended to the toolbar, i.e., will
12997 * be set as @b last item.
12999 * Items created with this method can be deleted with
13000 * elm_toolbar_item_del().
13002 * Associated @p data can be properly freed when item is deleted if a
13003 * callback function is set with elm_toolbar_item_del_cb_set().
13005 * If a function is passed as argument, it will be called everytime this item
13006 * is selected, i.e., the user clicks over an unselected item.
13007 * If such function isn't needed, just passing
13008 * @c NULL as @p func is enough. The same should be done for @p data.
13010 * Toolbar will load icon image from fdo or current theme.
13011 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
13012 * If an absolute path is provided it will load it direct from a file.
13014 * @see elm_toolbar_item_icon_set()
13015 * @see elm_toolbar_item_del()
13016 * @see elm_toolbar_item_del_cb_set()
13020 EAPI Elm_Toolbar_Item *elm_toolbar_item_append(Evas_Object *obj, const char *icon, const char *label, Evas_Smart_Cb func, const void *data) EINA_ARG_NONNULL(1);
13023 * Prepend item to the toolbar.
13025 * @param obj The toolbar object.
13026 * @param icon A string with icon name or the absolute path of an image file.
13027 * @param label The label of the item.
13028 * @param func The function to call when the item is clicked.
13029 * @param data The data to associate with the item for related callbacks.
13030 * @return The created item or @c NULL upon failure.
13032 * A new item will be created and prepended to the toolbar, i.e., will
13033 * be set as @b first item.
13035 * Items created with this method can be deleted with
13036 * elm_toolbar_item_del().
13038 * Associated @p data can be properly freed when item is deleted if a
13039 * callback function is set with elm_toolbar_item_del_cb_set().
13041 * If a function is passed as argument, it will be called everytime this item
13042 * is selected, i.e., the user clicks over an unselected item.
13043 * If such function isn't needed, just passing
13044 * @c NULL as @p func is enough. The same should be done for @p data.
13046 * Toolbar will load icon image from fdo or current theme.
13047 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
13048 * If an absolute path is provided it will load it direct from a file.
13050 * @see elm_toolbar_item_icon_set()
13051 * @see elm_toolbar_item_del()
13052 * @see elm_toolbar_item_del_cb_set()
13056 EAPI Elm_Toolbar_Item *elm_toolbar_item_prepend(Evas_Object *obj, const char *icon, const char *label, Evas_Smart_Cb func, const void *data) EINA_ARG_NONNULL(1);
13059 * Insert a new item into the toolbar object before item @p before.
13061 * @param obj The toolbar object.
13062 * @param before The toolbar item to insert before.
13063 * @param icon A string with icon name or the absolute path of an image file.
13064 * @param label The label of the item.
13065 * @param func The function to call when the item is clicked.
13066 * @param data The data to associate with the item for related callbacks.
13067 * @return The created item or @c NULL upon failure.
13069 * A new item will be created and added to the toolbar. Its position in
13070 * this toolbar will be just before item @p before.
13072 * Items created with this method can be deleted with
13073 * elm_toolbar_item_del().
13075 * Associated @p data can be properly freed when item is deleted if a
13076 * callback function is set with elm_toolbar_item_del_cb_set().
13078 * If a function is passed as argument, it will be called everytime this item
13079 * is selected, i.e., the user clicks over an unselected item.
13080 * If such function isn't needed, just passing
13081 * @c NULL as @p func is enough. The same should be done for @p data.
13083 * Toolbar will load icon image from fdo or current theme.
13084 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
13085 * If an absolute path is provided it will load it direct from a file.
13087 * @see elm_toolbar_item_icon_set()
13088 * @see elm_toolbar_item_del()
13089 * @see elm_toolbar_item_del_cb_set()
13093 EAPI Elm_Toolbar_Item *elm_toolbar_item_insert_before(Evas_Object *obj, Elm_Toolbar_Item *before, const char *icon, const char *label, Evas_Smart_Cb func, const void *data) EINA_ARG_NONNULL(1);
13096 * Insert a new item into the toolbar object after item @p after.
13098 * @param obj The toolbar object.
13099 * @param before The toolbar item to insert before.
13100 * @param icon A string with icon name or the absolute path of an image file.
13101 * @param label The label of the item.
13102 * @param func The function to call when the item is clicked.
13103 * @param data The data to associate with the item for related callbacks.
13104 * @return The created item or @c NULL upon failure.
13106 * A new item will be created and added to the toolbar. Its position in
13107 * this toolbar will be just after item @p after.
13109 * Items created with this method can be deleted with
13110 * elm_toolbar_item_del().
13112 * Associated @p data can be properly freed when item is deleted if a
13113 * callback function is set with elm_toolbar_item_del_cb_set().
13115 * If a function is passed as argument, it will be called everytime this item
13116 * is selected, i.e., the user clicks over an unselected item.
13117 * If such function isn't needed, just passing
13118 * @c NULL as @p func is enough. The same should be done for @p data.
13120 * Toolbar will load icon image from fdo or current theme.
13121 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
13122 * If an absolute path is provided it will load it direct from a file.
13124 * @see elm_toolbar_item_icon_set()
13125 * @see elm_toolbar_item_del()
13126 * @see elm_toolbar_item_del_cb_set()
13130 EAPI Elm_Toolbar_Item *elm_toolbar_item_insert_after(Evas_Object *obj, Elm_Toolbar_Item *after, const char *icon, const char *label, Evas_Smart_Cb func, const void *data) EINA_ARG_NONNULL(1);
13133 * Get the first item in the given toolbar widget's list of
13136 * @param obj The toolbar object
13137 * @return The first item or @c NULL, if it has no items (and on
13140 * @see elm_toolbar_item_append()
13141 * @see elm_toolbar_last_item_get()
13145 EAPI Elm_Toolbar_Item *elm_toolbar_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13148 * Get the last item in the given toolbar widget's list of
13151 * @param obj The toolbar object
13152 * @return The last item or @c NULL, if it has no items (and on
13155 * @see elm_toolbar_item_prepend()
13156 * @see elm_toolbar_first_item_get()
13160 EAPI Elm_Toolbar_Item *elm_toolbar_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13163 * Get the item after @p item in toolbar.
13165 * @param item The toolbar item.
13166 * @return The item after @p item, or @c NULL if none or on failure.
13168 * @note If it is the last item, @c NULL will be returned.
13170 * @see elm_toolbar_item_append()
13174 EAPI Elm_Toolbar_Item *elm_toolbar_item_next_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13177 * Get the item before @p item in toolbar.
13179 * @param item The toolbar item.
13180 * @return The item before @p item, or @c NULL if none or on failure.
13182 * @note If it is the first item, @c NULL will be returned.
13184 * @see elm_toolbar_item_prepend()
13188 EAPI Elm_Toolbar_Item *elm_toolbar_item_prev_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13191 * Get the toolbar object from an item.
13193 * @param item The item.
13194 * @return The toolbar object.
13196 * This returns the toolbar object itself that an item belongs to.
13200 EAPI Evas_Object *elm_toolbar_item_toolbar_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13203 * Set the priority of a toolbar item.
13205 * @param item The toolbar item.
13206 * @param priority The item priority. The default is zero.
13208 * This is used only when the toolbar shrink mode is set to
13209 * #ELM_TOOLBAR_SHRINK_MENU or #ELM_TOOLBAR_SHRINK_HIDE.
13210 * When space is less than required, items with low priority
13211 * will be removed from the toolbar and added to a dynamically-created menu,
13212 * while items with higher priority will remain on the toolbar,
13213 * with the same order they were added.
13215 * @see elm_toolbar_item_priority_get()
13219 EAPI void elm_toolbar_item_priority_set(Elm_Toolbar_Item *item, int priority) EINA_ARG_NONNULL(1);
13222 * Get the priority of a toolbar item.
13224 * @param item The toolbar item.
13225 * @return The @p item priority, or @c 0 on failure.
13227 * @see elm_toolbar_item_priority_set() for details.
13231 EAPI int elm_toolbar_item_priority_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13234 * Get the label of item.
13236 * @param item The item of toolbar.
13237 * @return The label of item.
13239 * The return value is a pointer to the label associated to @p item when
13240 * it was created, with function elm_toolbar_item_append() or similar,
13242 * with function elm_toolbar_item_label_set. If no label
13243 * was passed as argument, it will return @c NULL.
13245 * @see elm_toolbar_item_label_set() for more details.
13246 * @see elm_toolbar_item_append()
13250 EAPI const char *elm_toolbar_item_label_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13253 * Set the label of item.
13255 * @param item The item of toolbar.
13256 * @param text The label of item.
13258 * The label to be displayed by the item.
13259 * Label will be placed at icons bottom (if set).
13261 * If a label was passed as argument on item creation, with function
13262 * elm_toolbar_item_append() or similar, it will be already
13263 * displayed by the item.
13265 * @see elm_toolbar_item_label_get()
13266 * @see elm_toolbar_item_append()
13270 EAPI void elm_toolbar_item_label_set(Elm_Toolbar_Item *item, const char *label) EINA_ARG_NONNULL(1);
13273 * Return the data associated with a given toolbar widget item.
13275 * @param item The toolbar widget item handle.
13276 * @return The data associated with @p item.
13278 * @see elm_toolbar_item_data_set()
13282 EAPI void *elm_toolbar_item_data_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13285 * Set the data associated with a given toolbar widget item.
13287 * @param item The toolbar widget item handle.
13288 * @param data The new data pointer to set to @p item.
13290 * This sets new item data on @p item.
13292 * @warning The old data pointer won't be touched by this function, so
13293 * the user had better to free that old data himself/herself.
13297 EAPI void elm_toolbar_item_data_set(Elm_Toolbar_Item *item, const void *data) EINA_ARG_NONNULL(1);
13300 * Returns a pointer to a toolbar item by its label.
13302 * @param obj The toolbar object.
13303 * @param label The label of the item to find.
13305 * @return The pointer to the toolbar item matching @p label or @c NULL
13310 EAPI Elm_Toolbar_Item *elm_toolbar_item_find_by_label(const Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
13313 * Get whether the @p item is selected or not.
13315 * @param item The toolbar item.
13316 * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
13317 * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
13319 * @see elm_toolbar_selected_item_set() for details.
13320 * @see elm_toolbar_item_selected_get()
13324 EAPI Eina_Bool elm_toolbar_item_selected_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13327 * Set the selected state of an item.
13329 * @param item The toolbar item
13330 * @param selected The selected state
13332 * This sets the selected state of the given item @p it.
13333 * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
13335 * If a new item is selected the previosly selected will be unselected.
13336 * Previoulsy selected item can be get with function
13337 * elm_toolbar_selected_item_get().
13339 * Selected items will be highlighted.
13341 * @see elm_toolbar_item_selected_get()
13342 * @see elm_toolbar_selected_item_get()
13346 EAPI void elm_toolbar_item_selected_set(Elm_Toolbar_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
13349 * Get the selected item.
13351 * @param obj The toolbar object.
13352 * @return The selected toolbar item.
13354 * The selected item can be unselected with function
13355 * elm_toolbar_item_selected_set().
13357 * The selected item always will be highlighted on toolbar.
13359 * @see elm_toolbar_selected_items_get()
13363 EAPI Elm_Toolbar_Item *elm_toolbar_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13366 * Set the icon associated with @p item.
13368 * @param obj The parent of this item.
13369 * @param item The toolbar item.
13370 * @param icon A string with icon name or the absolute path of an image file.
13372 * Toolbar will load icon image from fdo or current theme.
13373 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
13374 * If an absolute path is provided it will load it direct from a file.
13376 * @see elm_toolbar_icon_order_lookup_set()
13377 * @see elm_toolbar_icon_order_lookup_get()
13381 EAPI void elm_toolbar_item_icon_set(Elm_Toolbar_Item *item, const char *icon) EINA_ARG_NONNULL(1);
13384 * Get the string used to set the icon of @p item.
13386 * @param item The toolbar item.
13387 * @return The string associated with the icon object.
13389 * @see elm_toolbar_item_icon_set() for details.
13393 EAPI const char *elm_toolbar_item_icon_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13396 * Delete them item from the toolbar.
13398 * @param item The item of toolbar to be deleted.
13400 * @see elm_toolbar_item_append()
13401 * @see elm_toolbar_item_del_cb_set()
13405 EAPI void elm_toolbar_item_del(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13408 * Set the function called when a toolbar item is freed.
13410 * @param item The item to set the callback on.
13411 * @param func The function called.
13413 * If there is a @p func, then it will be called prior item's memory release.
13414 * That will be called with the following arguments:
13416 * @li item's Evas object;
13419 * This way, a data associated to a toolbar item could be properly freed.
13423 EAPI void elm_toolbar_item_del_cb_set(Elm_Toolbar_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
13426 * Get a value whether toolbar item is disabled or not.
13428 * @param item The item.
13429 * @return The disabled state.
13431 * @see elm_toolbar_item_disabled_set() for more details.
13435 EAPI Eina_Bool elm_toolbar_item_disabled_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13438 * Sets the disabled/enabled state of a toolbar item.
13440 * @param item The item.
13441 * @param disabled The disabled state.
13443 * A disabled item cannot be selected or unselected. It will also
13444 * change its appearance (generally greyed out). This sets the
13445 * disabled state (@c EINA_TRUE for disabled, @c EINA_FALSE for
13450 EAPI void elm_toolbar_item_disabled_set(Elm_Toolbar_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
13453 * Set or unset item as a separator.
13455 * @param item The toolbar item.
13456 * @param setting @c EINA_TRUE to set item @p item as separator or
13457 * @c EINA_FALSE to unset, i.e., item will be used as a regular item.
13459 * Items aren't set as separator by default.
13461 * If set as separator it will display separator theme, so won't display
13464 * @see elm_toolbar_item_separator_get()
13468 EAPI void elm_toolbar_item_separator_set(Elm_Toolbar_Item *item, Eina_Bool separator) EINA_ARG_NONNULL(1);
13471 * Get a value whether item is a separator or not.
13473 * @param item The toolbar item.
13474 * @return @c EINA_TRUE means item @p it is a separator. @c EINA_FALSE
13475 * indicates it's not. If @p it is @c NULL, @c EINA_FALSE is returned.
13477 * @see elm_toolbar_item_separator_set() for details.
13481 EAPI Eina_Bool elm_toolbar_item_separator_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13484 * Set the shrink state of toolbar @p obj.
13486 * @param obj The toolbar object.
13487 * @param shrink_mode Toolbar's items display behavior.
13489 * The toolbar won't scroll if #ELM_TOOLBAR_SHRINK_NONE,
13490 * but will enforce a minimun size so all the items will fit, won't scroll
13491 * and won't show the items that don't fit if #ELM_TOOLBAR_SHRINK_HIDE,
13492 * will scroll if #ELM_TOOLBAR_SHRINK_SCROLL, and will create a button to
13493 * pop up excess elements with #ELM_TOOLBAR_SHRINK_MENU.
13497 EAPI void elm_toolbar_mode_shrink_set(Evas_Object *obj, Elm_Toolbar_Shrink_Mode shrink_mode) EINA_ARG_NONNULL(1);
13500 * Get the shrink mode of toolbar @p obj.
13502 * @param obj The toolbar object.
13503 * @return Toolbar's items display behavior.
13505 * @see elm_toolbar_mode_shrink_set() for details.
13509 EAPI Elm_Toolbar_Shrink_Mode elm_toolbar_mode_shrink_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13512 * Enable/disable homogenous mode.
13514 * @param obj The toolbar object
13515 * @param homogeneous Assume the items within the toolbar are of the
13516 * same size (EINA_TRUE = on, EINA_FALSE = off). Default is @c EINA_FALSE.
13518 * This will enable the homogeneous mode where items are of the same size.
13519 * @see elm_toolbar_homogeneous_get()
13523 EAPI void elm_toolbar_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
13526 * Get whether the homogenous mode is enabled.
13528 * @param obj The toolbar object.
13529 * @return Assume the items within the toolbar are of the same height
13530 * and width (EINA_TRUE = on, EINA_FALSE = off).
13532 * @see elm_toolbar_homogeneous_set()
13536 EAPI Eina_Bool elm_toolbar_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13539 * Enable/disable homogenous mode.
13541 * @param obj The toolbar object
13542 * @param homogeneous Assume the items within the toolbar are of the
13543 * same size (EINA_TRUE = on, EINA_FALSE = off). Default is @c EINA_FALSE.
13545 * This will enable the homogeneous mode where items are of the same size.
13546 * @see elm_toolbar_homogeneous_get()
13548 * @deprecated use elm_toolbar_homogeneous_set() instead.
13552 EINA_DEPRECATED EAPI void elm_toolbar_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
13555 * Get whether the homogenous mode is enabled.
13557 * @param obj The toolbar object.
13558 * @return Assume the items within the toolbar are of the same height
13559 * and width (EINA_TRUE = on, EINA_FALSE = off).
13561 * @see elm_toolbar_homogeneous_set()
13562 * @deprecated use elm_toolbar_homogeneous_get() instead.
13566 EINA_DEPRECATED EAPI Eina_Bool elm_toolbar_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13569 * Set the parent object of the toolbar items' menus.
13571 * @param obj The toolbar object.
13572 * @param parent The parent of the menu objects.
13574 * Each item can be set as item menu, with elm_toolbar_item_menu_set().
13576 * For more details about setting the parent for toolbar menus, see
13577 * elm_menu_parent_set().
13579 * @see elm_menu_parent_set() for details.
13580 * @see elm_toolbar_item_menu_set() for details.
13584 EAPI void elm_toolbar_menu_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
13587 * Get the parent object of the toolbar items' menus.
13589 * @param obj The toolbar object.
13590 * @return The parent of the menu objects.
13592 * @see elm_toolbar_menu_parent_set() for details.
13596 EAPI Evas_Object *elm_toolbar_menu_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13599 * Set the alignment of the items.
13601 * @param obj The toolbar object.
13602 * @param align The new alignment, a float between <tt> 0.0 </tt>
13603 * and <tt> 1.0 </tt>.
13605 * Alignment of toolbar items, from <tt> 0.0 </tt> to indicates to align
13606 * left, to <tt> 1.0 </tt>, to align to right. <tt> 0.5 </tt> centralize
13609 * Centered items by default.
13611 * @see elm_toolbar_align_get()
13615 EAPI void elm_toolbar_align_set(Evas_Object *obj, double align) EINA_ARG_NONNULL(1);
13618 * Get the alignment of the items.
13620 * @param obj The toolbar object.
13621 * @return toolbar items alignment, a float between <tt> 0.0 </tt> and
13624 * @see elm_toolbar_align_set() for details.
13628 EAPI double elm_toolbar_align_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13631 * Set whether the toolbar item opens a menu.
13633 * @param item The toolbar item.
13634 * @param menu If @c EINA_TRUE, @p item will opens a menu when selected.
13636 * A toolbar item can be set to be a menu, using this function.
13638 * Once it is set to be a menu, it can be manipulated through the
13639 * menu-like function elm_toolbar_menu_parent_set() and the other
13640 * elm_menu functions, using the Evas_Object @c menu returned by
13641 * elm_toolbar_item_menu_get().
13643 * So, items to be displayed in this item's menu should be added with
13644 * elm_menu_item_add().
13646 * The following code exemplifies the most basic usage:
13648 * tb = elm_toolbar_add(win)
13649 * item = elm_toolbar_item_append(tb, "refresh", "Menu", NULL, NULL);
13650 * elm_toolbar_item_menu_set(item, EINA_TRUE);
13651 * elm_toolbar_menu_parent_set(tb, win);
13652 * menu = elm_toolbar_item_menu_get(item);
13653 * elm_menu_item_add(menu, NULL, "edit-cut", "Cut", NULL, NULL);
13654 * menu_item = elm_menu_item_add(menu, NULL, "edit-copy", "Copy", NULL,
13658 * @see elm_toolbar_item_menu_get()
13662 EAPI void elm_toolbar_item_menu_set(Elm_Toolbar_Item *item, Eina_Bool menu) EINA_ARG_NONNULL(1);
13665 * Get toolbar item's menu.
13667 * @param item The toolbar item.
13668 * @return Item's menu object or @c NULL on failure.
13670 * If @p item wasn't set as menu item with elm_toolbar_item_menu_set(),
13671 * this function will set it.
13673 * @see elm_toolbar_item_menu_set() for details.
13677 EAPI Evas_Object *elm_toolbar_item_menu_get(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13680 * Add a new state to @p item.
13682 * @param item The item.
13683 * @param icon A string with icon name or the absolute path of an image file.
13684 * @param label The label of the new state.
13685 * @param func The function to call when the item is clicked when this
13686 * state is selected.
13687 * @param data The data to associate with the state.
13688 * @return The toolbar item state, or @c NULL upon failure.
13690 * Toolbar will load icon image from fdo or current theme.
13691 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
13692 * If an absolute path is provided it will load it direct from a file.
13694 * States created with this function can be removed with
13695 * elm_toolbar_item_state_del().
13697 * @see elm_toolbar_item_state_del()
13698 * @see elm_toolbar_item_state_sel()
13699 * @see elm_toolbar_item_state_get()
13703 EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_add(Elm_Toolbar_Item *item, const char *icon, const char *label, Evas_Smart_Cb func, const void *data) EINA_ARG_NONNULL(1);
13706 * Delete a previoulsy added state to @p item.
13708 * @param item The toolbar item.
13709 * @param state The state to be deleted.
13710 * @return @c EINA_TRUE on success or @c EINA_FALSE on failure.
13712 * @see elm_toolbar_item_state_add()
13714 EAPI Eina_Bool elm_toolbar_item_state_del(Elm_Toolbar_Item *item, Elm_Toolbar_Item_State *state) EINA_ARG_NONNULL(1);
13717 * Set @p state as the current state of @p it.
13719 * @param it The item.
13720 * @param state The state to use.
13721 * @return @c EINA_TRUE on success or @c EINA_FALSE on failure.
13723 * If @p state is @c NULL, it won't select any state and the default item's
13724 * icon and label will be used. It's the same behaviour than
13725 * elm_toolbar_item_state_unser().
13727 * @see elm_toolbar_item_state_unset()
13731 EAPI Eina_Bool elm_toolbar_item_state_set(Elm_Toolbar_Item *it, Elm_Toolbar_Item_State *state) EINA_ARG_NONNULL(1);
13734 * Unset the state of @p it.
13736 * @param it The item.
13738 * The default icon and label from this item will be displayed.
13740 * @see elm_toolbar_item_state_set() for more details.
13744 EAPI void elm_toolbar_item_state_unset(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
13747 * Get the current state of @p it.
13749 * @param item The item.
13750 * @return The selected state or @c NULL if none is selected or on failure.
13752 * @see elm_toolbar_item_state_set() for details.
13753 * @see elm_toolbar_item_state_unset()
13754 * @see elm_toolbar_item_state_add()
13758 EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_get(const Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
13761 * Get the state after selected state in toolbar's @p item.
13763 * @param it The toolbar item to change state.
13764 * @return The state after current state, or @c NULL on failure.
13766 * If last state is selected, this function will return first state.
13768 * @see elm_toolbar_item_state_set()
13769 * @see elm_toolbar_item_state_add()
13773 EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_next(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
13776 * Get the state before selected state in toolbar's @p item.
13778 * @param it The toolbar item to change state.
13779 * @return The state before current state, or @c NULL on failure.
13781 * If first state is selected, this function will return last state.
13783 * @see elm_toolbar_item_state_set()
13784 * @see elm_toolbar_item_state_add()
13788 EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_prev(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
13791 * Set the text to be shown in a given toolbar item's tooltips.
13793 * @param item Target item.
13794 * @param text The text to set in the content.
13796 * Setup the text as tooltip to object. The item can have only one tooltip,
13797 * so any previous tooltip data - set with this function or
13798 * elm_toolbar_item_tooltip_content_cb_set() - is removed.
13800 * @see elm_object_tooltip_text_set() for more details.
13804 EAPI void elm_toolbar_item_tooltip_text_set(Elm_Toolbar_Item *item, const char *text) EINA_ARG_NONNULL(1);
13807 * Set the content to be shown in the tooltip item.
13809 * Setup the tooltip to item. The item can have only one tooltip,
13810 * so any previous tooltip data is removed. @p func(with @p data) will
13811 * be called every time that need show the tooltip and it should
13812 * return a valid Evas_Object. This object is then managed fully by
13813 * tooltip system and is deleted when the tooltip is gone.
13815 * @param item the toolbar item being attached a tooltip.
13816 * @param func the function used to create the tooltip contents.
13817 * @param data what to provide to @a func as callback data/context.
13818 * @param del_cb called when data is not needed anymore, either when
13819 * another callback replaces @a func, the tooltip is unset with
13820 * elm_toolbar_item_tooltip_unset() or the owner @a item
13821 * dies. This callback receives as the first parameter the
13822 * given @a data, and @c event_info is the item.
13824 * @see elm_object_tooltip_content_cb_set() for more details.
13828 EAPI void elm_toolbar_item_tooltip_content_cb_set(Elm_Toolbar_Item *item, Elm_Tooltip_Item_Content_Cb func, const void *data, Evas_Smart_Cb del_cb) EINA_ARG_NONNULL(1);
13831 * Unset tooltip from item.
13833 * @param item toolbar item to remove previously set tooltip.
13835 * Remove tooltip from item. The callback provided as del_cb to
13836 * elm_toolbar_item_tooltip_content_cb_set() will be called to notify
13837 * it is not used anymore.
13839 * @see elm_object_tooltip_unset() for more details.
13840 * @see elm_toolbar_item_tooltip_content_cb_set()
13844 EAPI void elm_toolbar_item_tooltip_unset(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13847 * Sets a different style for this item tooltip.
13849 * @note before you set a style you should define a tooltip with
13850 * elm_toolbar_item_tooltip_content_cb_set() or
13851 * elm_toolbar_item_tooltip_text_set()
13853 * @param item toolbar item with tooltip already set.
13854 * @param style the theme style to use (default, transparent, ...)
13856 * @see elm_object_tooltip_style_set() for more details.
13860 EAPI void elm_toolbar_item_tooltip_style_set(Elm_Toolbar_Item *item, const char *style) EINA_ARG_NONNULL(1);
13863 * Get the style for this item tooltip.
13865 * @param item toolbar item with tooltip already set.
13866 * @return style the theme style in use, defaults to "default". If the
13867 * object does not have a tooltip set, then NULL is returned.
13869 * @see elm_object_tooltip_style_get() for more details.
13870 * @see elm_toolbar_item_tooltip_style_set()
13874 EAPI const char *elm_toolbar_item_tooltip_style_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13877 * Set the type of mouse pointer/cursor decoration to be shown,
13878 * when the mouse pointer is over the given toolbar widget item
13880 * @param item toolbar item to customize cursor on
13881 * @param cursor the cursor type's name
13883 * This function works analogously as elm_object_cursor_set(), but
13884 * here the cursor's changing area is restricted to the item's
13885 * area, and not the whole widget's. Note that that item cursors
13886 * have precedence over widget cursors, so that a mouse over an
13887 * item with custom cursor set will always show @b that cursor.
13889 * If this function is called twice for an object, a previously set
13890 * cursor will be unset on the second call.
13892 * @see elm_object_cursor_set()
13893 * @see elm_toolbar_item_cursor_get()
13894 * @see elm_toolbar_item_cursor_unset()
13898 EAPI void elm_toolbar_item_cursor_set(Elm_Toolbar_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
13901 * Get the type of mouse pointer/cursor decoration set to be shown,
13902 * when the mouse pointer is over the given toolbar widget item
13904 * @param item toolbar item with custom cursor set
13905 * @return the cursor type's name or @c NULL, if no custom cursors
13906 * were set to @p item (and on errors)
13908 * @see elm_object_cursor_get()
13909 * @see elm_toolbar_item_cursor_set()
13910 * @see elm_toolbar_item_cursor_unset()
13914 EAPI const char *elm_toolbar_item_cursor_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13917 * Unset any custom mouse pointer/cursor decoration set to be
13918 * shown, when the mouse pointer is over the given toolbar widget
13919 * item, thus making it show the @b default cursor again.
13921 * @param item a toolbar item
13923 * Use this call to undo any custom settings on this item's cursor
13924 * decoration, bringing it back to defaults (no custom style set).
13926 * @see elm_object_cursor_unset()
13927 * @see elm_toolbar_item_cursor_set()
13931 EAPI void elm_toolbar_item_cursor_unset(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13934 * Set a different @b style for a given custom cursor set for a
13937 * @param item toolbar item with custom cursor set
13938 * @param style the <b>theme style</b> to use (e.g. @c "default",
13939 * @c "transparent", etc)
13941 * This function only makes sense when one is using custom mouse
13942 * cursor decorations <b>defined in a theme file</b>, which can have,
13943 * given a cursor name/type, <b>alternate styles</b> on it. It
13944 * works analogously as elm_object_cursor_style_set(), but here
13945 * applyed only to toolbar item objects.
13947 * @warning Before you set a cursor style you should have definen a
13948 * custom cursor previously on the item, with
13949 * elm_toolbar_item_cursor_set()
13951 * @see elm_toolbar_item_cursor_engine_only_set()
13952 * @see elm_toolbar_item_cursor_style_get()
13956 EAPI void elm_toolbar_item_cursor_style_set(Elm_Toolbar_Item *item, const char *style) EINA_ARG_NONNULL(1);
13959 * Get the current @b style set for a given toolbar item's custom
13962 * @param item toolbar item with custom cursor set.
13963 * @return style the cursor style in use. If the object does not
13964 * have a cursor set, then @c NULL is returned.
13966 * @see elm_toolbar_item_cursor_style_set() for more details
13970 EAPI const char *elm_toolbar_item_cursor_style_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13973 * Set if the (custom)cursor for a given toolbar item should be
13974 * searched in its theme, also, or should only rely on the
13975 * rendering engine.
13977 * @param item item with custom (custom) cursor already set on
13978 * @param engine_only Use @c EINA_TRUE to have cursors looked for
13979 * only on those provided by the rendering engine, @c EINA_FALSE to
13980 * have them searched on the widget's theme, as well.
13982 * @note This call is of use only if you've set a custom cursor
13983 * for toolbar items, with elm_toolbar_item_cursor_set().
13985 * @note By default, cursors will only be looked for between those
13986 * provided by the rendering engine.
13990 EAPI void elm_toolbar_item_cursor_engine_only_set(Elm_Toolbar_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
13993 * Get if the (custom) cursor for a given toolbar item is being
13994 * searched in its theme, also, or is only relying on the rendering
13997 * @param item a toolbar item
13998 * @return @c EINA_TRUE, if cursors are being looked for only on
13999 * those provided by the rendering engine, @c EINA_FALSE if they
14000 * are being searched on the widget's theme, as well.
14002 * @see elm_toolbar_item_cursor_engine_only_set(), for more details
14006 EAPI Eina_Bool elm_toolbar_item_cursor_engine_only_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14009 * Change a toolbar's orientation
14010 * @param obj The toolbar object
14011 * @param vertical If @c EINA_TRUE, the toolbar is vertical
14012 * By default, a toolbar will be horizontal. Use this function to create a vertical toolbar.
14015 EAPI void elm_toolbar_orientation_set(Evas_Object *obj, Eina_Bool vertical) EINA_ARG_NONNULL(1);
14018 * Get a toolbar's orientation
14019 * @param obj The toolbar object
14020 * @return If @c EINA_TRUE, the toolbar is vertical
14021 * By default, a toolbar will be horizontal. Use this function to determine whether a toolbar is vertical.
14024 EAPI Eina_Bool elm_toolbar_orientation_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
14031 * @defgroup Tooltips Tooltips
14033 * The Tooltip is an (internal, for now) smart object used to show a
14034 * content in a frame on mouse hover of objects(or widgets), with
14035 * tips/information about them.
14040 EAPI double elm_tooltip_delay_get(void);
14041 EAPI Eina_Bool elm_tooltip_delay_set(double delay);
14042 EAPI void elm_object_tooltip_show(Evas_Object *obj) EINA_ARG_NONNULL(1);
14043 EAPI void elm_object_tooltip_hide(Evas_Object *obj) EINA_ARG_NONNULL(1);
14044 EAPI void elm_object_tooltip_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1, 2);
14045 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);
14046 EAPI void elm_object_tooltip_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
14047 EAPI void elm_object_tooltip_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
14048 EAPI const char *elm_object_tooltip_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14049 EAPI Eina_Bool elm_tooltip_size_restrict_disable(Evas_Object *obj, Eina_Bool disable); EINA_ARG_NONNULL(1);
14050 EAPI Eina_Bool elm_tooltip_size_restrict_disabled_get(const Evas_Object *obj); EINA_ARG_NONNULL(1);
14057 * @defgroup Cursors Cursors
14059 * The Elementary cursor is an internal smart object used to
14060 * customize the mouse cursor displayed over objects (or
14061 * widgets). In the most common scenario, the cursor decoration
14062 * comes from the graphical @b engine Elementary is running
14063 * on. Those engines may provide different decorations for cursors,
14064 * and Elementary provides functions to choose them (think of X11
14065 * cursors, as an example).
14067 * There's also the possibility of, besides using engine provided
14068 * cursors, also use ones coming from Edje theming files. Both
14069 * globally and per widget, Elementary makes it possible for one to
14070 * make the cursors lookup to be held on engines only or on
14071 * Elementary's theme file, too.
14077 * Set the cursor to be shown when mouse is over the object
14079 * Set the cursor that will be displayed when mouse is over the
14080 * object. The object can have only one cursor set to it, so if
14081 * this function is called twice for an object, the previous set
14083 * If using X cursors, a definition of all the valid cursor names
14084 * is listed on Elementary_Cursors.h. If an invalid name is set
14085 * the default cursor will be used.
14087 * @param obj the object being set a cursor.
14088 * @param cursor the cursor name to be used.
14092 EAPI void elm_object_cursor_set(Evas_Object *obj, const char *cursor) EINA_ARG_NONNULL(1);
14095 * Get the cursor to be shown when mouse is over the object
14097 * @param obj an object with cursor already set.
14098 * @return the cursor name.
14102 EAPI const char *elm_object_cursor_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14105 * Unset cursor for object
14107 * Unset cursor for object, and set the cursor to default if the mouse
14108 * was over this object.
14110 * @param obj Target object
14111 * @see elm_object_cursor_set()
14115 EAPI void elm_object_cursor_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
14118 * Sets a different style for this object cursor.
14120 * @note before you set a style you should define a cursor with
14121 * elm_object_cursor_set()
14123 * @param obj an object with cursor already set.
14124 * @param style the theme style to use (default, transparent, ...)
14128 EAPI void elm_object_cursor_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
14131 * Get the style for this object cursor.
14133 * @param obj an object with cursor already set.
14134 * @return style the theme style in use, defaults to "default". If the
14135 * object does not have a cursor set, then NULL is returned.
14139 EAPI const char *elm_object_cursor_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14142 * Set if the cursor set should be searched on the theme or should use
14143 * the provided by the engine, only.
14145 * @note before you set if should look on theme you should define a cursor
14146 * with elm_object_cursor_set(). By default it will only look for cursors
14147 * provided by the engine.
14149 * @param obj an object with cursor already set.
14150 * @param engine_only boolean to define it cursors should be looked only
14151 * between the provided by the engine or searched on widget's theme as well.
14155 EAPI void elm_object_cursor_engine_only_set(Evas_Object *obj, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
14158 * Get the cursor engine only usage for this object cursor.
14160 * @param obj an object with cursor already set.
14161 * @return engine_only boolean to define it cursors should be
14162 * looked only between the provided by the engine or searched on
14163 * widget's theme as well. If the object does not have a cursor
14164 * set, then EINA_FALSE is returned.
14168 EAPI Eina_Bool elm_object_cursor_engine_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14171 * Get the configured cursor engine only usage
14173 * This gets the globally configured exclusive usage of engine cursors.
14175 * @return 1 if only engine cursors should be used
14178 EAPI int elm_cursor_engine_only_get(void);
14181 * Set the configured cursor engine only usage
14183 * This sets the globally configured exclusive usage of engine cursors.
14184 * It won't affect cursors set before changing this value.
14186 * @param engine_only If 1 only engine cursors will be enabled, if 0 will
14187 * look for them on theme before.
14188 * @return EINA_TRUE if value is valid and setted (0 or 1)
14191 EAPI Eina_Bool elm_cursor_engine_only_set(int engine_only);
14198 * @defgroup Menu Menu
14200 * @image html img/widget/menu/preview-00.png
14201 * @image latex img/widget/menu/preview-00.eps
14203 * A menu is a list of items displayed above its parent. When the menu is
14204 * showing its parent is darkened. Each item can have a sub-menu. The menu
14205 * object can be used to display a menu on a right click event, in a toolbar,
14208 * Signals that you can add callbacks for are:
14209 * @li "clicked" - the user clicked the empty space in the menu to dismiss.
14210 * event_info is NULL.
14212 * @see @ref tutorial_menu
14215 typedef struct _Elm_Menu_Item Elm_Menu_Item; /**< Item of Elm_Menu. Sub-type of Elm_Widget_Item */
14217 * @brief Add a new menu to the parent
14219 * @param parent The parent object.
14220 * @return The new object or NULL if it cannot be created.
14222 EAPI Evas_Object *elm_menu_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
14224 * @brief Set the parent for the given menu widget
14226 * @param obj The menu object.
14227 * @param parent The new parent.
14229 EAPI void elm_menu_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
14231 * @brief Get the parent for the given menu widget
14233 * @param obj The menu object.
14234 * @return The parent.
14236 * @see elm_menu_parent_set()
14238 EAPI Evas_Object *elm_menu_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14240 * @brief Move the menu to a new position
14242 * @param obj The menu object.
14243 * @param x The new position.
14244 * @param y The new position.
14246 * Sets the top-left position of the menu to (@p x,@p y).
14248 * @note @p x and @p y coordinates are relative to parent.
14250 EAPI void elm_menu_move(Evas_Object *obj, Evas_Coord x, Evas_Coord y) EINA_ARG_NONNULL(1);
14252 * @brief Close a opened menu
14254 * @param obj the menu object
14257 * Hides the menu and all it's sub-menus.
14259 EAPI void elm_menu_close(Evas_Object *obj) EINA_ARG_NONNULL(1);
14261 * @brief Returns a list of @p item's items.
14263 * @param obj The menu object
14264 * @return An Eina_List* of @p item's items
14266 EAPI const Eina_List *elm_menu_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14268 * @brief Get the Evas_Object of an Elm_Menu_Item
14270 * @param item The menu item object.
14271 * @return The edje object containing the swallowed content
14273 * @warning Don't manipulate this object!
14275 EAPI Evas_Object *elm_menu_item_object_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
14277 * @brief Add an item at the end of the given menu widget
14279 * @param obj The menu object.
14280 * @param parent The parent menu item (optional)
14281 * @param icon A icon display on the item. The icon will be destryed by the menu.
14282 * @param label The label of the item.
14283 * @param func Function called when the user select the item.
14284 * @param data Data sent by the callback.
14285 * @return Returns the new item.
14287 EAPI Elm_Menu_Item *elm_menu_item_add(Evas_Object *obj, Elm_Menu_Item *parent, const char *icon, const char *label, Evas_Smart_Cb func, const void *data) EINA_ARG_NONNULL(1);
14289 * @brief Add an object swallowed in an item at the end of the given menu
14292 * @param obj The menu object.
14293 * @param parent The parent menu item (optional)
14294 * @param subobj The object to swallow
14295 * @param func Function called when the user select the item.
14296 * @param data Data sent by the callback.
14297 * @return Returns the new item.
14299 * Add an evas object as an item to the menu.
14301 EAPI Elm_Menu_Item *elm_menu_item_add_object(Evas_Object *obj, Elm_Menu_Item *parent, Evas_Object *subobj, Evas_Smart_Cb func, const void *data) EINA_ARG_NONNULL(1);
14303 * @brief Set the label of a menu item
14305 * @param item The menu item object.
14306 * @param label The label to set for @p item
14308 * @warning Don't use this funcion on items created with
14309 * elm_menu_item_add_object() or elm_menu_item_separator_add().
14311 EAPI void elm_menu_item_label_set(Elm_Menu_Item *item, const char *label) EINA_ARG_NONNULL(1);
14313 * @brief Get the label of a menu item
14315 * @param item The menu item object.
14316 * @return The label of @p item
14318 EAPI const char *elm_menu_item_label_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
14320 * @brief Set the icon of a menu item to the standard icon with name @p icon
14322 * @param item The menu item object.
14323 * @param icon The icon object to set for the content of @p item
14325 * Once this icon is set, any previously set icon will be deleted.
14327 EAPI void elm_menu_item_object_icon_name_set(Elm_Menu_Item *item, const char *icon) EINA_ARG_NONNULL(1, 2);
14329 * @brief Get the string representation from the icon of a menu item
14331 * @param item The menu item object.
14332 * @return The string representation of @p item's icon or NULL
14334 * @see elm_menu_item_object_icon_name_set()
14336 EAPI const char *elm_menu_item_object_icon_name_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
14338 * @brief Set the content object of a menu item
14340 * @param item The menu item object
14341 * @param The content object or NULL
14342 * @return EINA_TRUE on success, else EINA_FALSE
14344 * Use this function to change the object swallowed by a menu item, deleting
14345 * any previously swallowed object.
14347 EAPI Eina_Bool elm_menu_item_object_content_set(Elm_Menu_Item *item, Evas_Object *obj) EINA_ARG_NONNULL(1);
14349 * @brief Get the content object of a menu item
14351 * @param item The menu item object
14352 * @return The content object or NULL
14353 * @note If @p item was added with elm_menu_item_add_object, this
14354 * function will return the object passed, else it will return the
14357 * @see elm_menu_item_object_content_set()
14359 EAPI Evas_Object *elm_menu_item_object_content_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
14361 * @brief Set the selected state of @p item.
14363 * @param item The menu item object.
14364 * @param selected The selected/unselected state of the item
14366 EAPI void elm_menu_item_selected_set(Elm_Menu_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
14368 * @brief Get the selected state of @p item.
14370 * @param item The menu item object.
14371 * @return The selected/unselected state of the item
14373 * @see elm_menu_item_selected_set()
14375 EAPI Eina_Bool elm_menu_item_selected_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
14377 * @brief Set the disabled state of @p item.
14379 * @param item The menu item object.
14380 * @param disabled The enabled/disabled state of the item
14382 EAPI void elm_menu_item_disabled_set(Elm_Menu_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
14384 * @brief Get the disabled state of @p item.
14386 * @param item The menu item object.
14387 * @return The enabled/disabled state of the item
14389 * @see elm_menu_item_disabled_set()
14391 EAPI Eina_Bool elm_menu_item_disabled_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
14393 * @brief Add a separator item to menu @p obj under @p parent.
14395 * @param obj The menu object
14396 * @param parent The item to add the separator under
14397 * @return The created item or NULL on failure
14399 * This is item is a @ref Separator.
14401 EAPI Elm_Menu_Item *elm_menu_item_separator_add(Evas_Object *obj, Elm_Menu_Item *parent) EINA_ARG_NONNULL(1);
14403 * @brief Returns whether @p item is a separator.
14405 * @param item The item to check
14406 * @return If true, @p item is a separator
14408 * @see elm_menu_item_separator_add()
14410 EAPI Eina_Bool elm_menu_item_is_separator(Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
14412 * @brief Deletes an item from the menu.
14414 * @param item The item to delete.
14416 * @see elm_menu_item_add()
14418 EAPI void elm_menu_item_del(Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
14420 * @brief Set the function called when a menu item is deleted.
14422 * @param item The item to set the callback on
14423 * @param func The function called
14425 * @see elm_menu_item_add()
14426 * @see elm_menu_item_del()
14428 EAPI void elm_menu_item_del_cb_set(Elm_Menu_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
14430 * @brief Returns the data associated with menu item @p item.
14432 * @param item The item
14433 * @return The data associated with @p item or NULL if none was set.
14435 * This is the data set with elm_menu_add() or elm_menu_item_data_set().
14437 EAPI void *elm_menu_item_data_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
14439 * @brief Sets the data to be associated with menu item @p item.
14441 * @param item The item
14442 * @param data The data to be associated with @p item
14444 EAPI void elm_menu_item_data_set(Elm_Menu_Item *item, const void *data) EINA_ARG_NONNULL(1);
14446 * @brief Returns a list of @p item's subitems.
14448 * @param item The item
14449 * @return An Eina_List* of @p item's subitems
14451 * @see elm_menu_add()
14453 EAPI const Eina_List *elm_menu_item_subitems_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
14455 * @brief Get the position of a menu item
14457 * @param item The menu item
14458 * @return The item's index
14460 * This function returns the index position of a menu item in a menu.
14461 * For a sub-menu, this number is relative to the first item in the sub-menu.
14463 * @note Index values begin with 0
14465 EAPI unsigned int elm_menu_item_index_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1) EINA_PURE;
14467 * @brief @brief Return a menu item's owner menu
14469 * @param item The menu item
14470 * @return The menu object owning @p item, or NULL on failure
14472 * Use this function to get the menu object owning an item.
14474 EAPI Evas_Object *elm_menu_item_menu_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1) EINA_PURE;
14476 * @brief Get the selected item in the menu
14478 * @param obj The menu object
14479 * @return The selected item, or NULL if none
14481 * @see elm_menu_item_selected_get()
14482 * @see elm_menu_item_selected_set()
14484 EAPI Elm_Menu_Item *elm_menu_selected_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
14486 * @brief Get the last item in the menu
14488 * @param obj The menu object
14489 * @return The last item, or NULL if none
14491 EAPI Elm_Menu_Item *elm_menu_last_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
14493 * @brief Get the first item in the menu
14495 * @param obj The menu object
14496 * @return The first item, or NULL if none
14498 EAPI Elm_Menu_Item *elm_menu_first_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
14500 * @brief Get the next item in the menu.
14502 * @param item The menu item object.
14503 * @return The item after it, or NULL if none
14505 EAPI Elm_Menu_Item *elm_menu_item_next_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
14507 * @brief Get the previous item in the menu.
14509 * @param item The menu item object.
14510 * @return The item before it, or NULL if none
14512 EAPI Elm_Menu_Item *elm_menu_item_prev_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
14518 * @defgroup List List
14519 * @ingroup Elementary
14521 * @image html img/widget/list/preview-00.png
14522 * @image latex img/widget/list/preview-00.eps width=\textwidth
14524 * @image html img/list.png
14525 * @image latex img/list.eps width=\textwidth
14527 * A list widget is a container whose children are displayed vertically or
14528 * horizontally, in order, and can be selected.
14529 * The list can accept only one or multiple items selection. Also has many
14530 * modes of items displaying.
14532 * A list is a very simple type of list widget. For more robust
14533 * lists, @ref Genlist should probably be used.
14535 * Smart callbacks one can listen to:
14536 * - @c "activated" - The user has double-clicked or pressed
14537 * (enter|return|spacebar) on an item. The @c event_info parameter
14538 * is the item that was activated.
14539 * - @c "clicked,double" - The user has double-clicked an item.
14540 * The @c event_info parameter is the item that was double-clicked.
14541 * - "selected" - when the user selected an item
14542 * - "unselected" - when the user unselected an item
14543 * - "longpressed" - an item in the list is long-pressed
14544 * - "scroll,edge,top" - the list is scrolled until the top edge
14545 * - "scroll,edge,bottom" - the list is scrolled until the bottom edge
14546 * - "scroll,edge,left" - the list is scrolled until the left edge
14547 * - "scroll,edge,right" - the list is scrolled until the right edge
14549 * Available styles for it:
14552 * List of examples:
14553 * @li @ref list_example_01
14554 * @li @ref list_example_02
14555 * @li @ref list_example_03
14564 * @enum _Elm_List_Mode
14565 * @typedef Elm_List_Mode
14567 * Set list's resize behavior, transverse axis scroll and
14568 * items cropping. See each mode's description for more details.
14570 * @note Default value is #ELM_LIST_SCROLL.
14572 * Values <b> don't </b> work as bitmask, only one can be choosen.
14574 * @see elm_list_mode_set()
14575 * @see elm_list_mode_get()
14579 typedef enum _Elm_List_Mode
14581 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. */
14582 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). */
14583 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. */
14584 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. */
14585 ELM_LIST_LAST /**< Indicates error if returned by elm_list_mode_get() */
14588 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(). */
14591 * Add a new list widget to the given parent Elementary
14592 * (container) object.
14594 * @param parent The parent object.
14595 * @return a new list widget handle or @c NULL, on errors.
14597 * This function inserts a new list widget on the canvas.
14601 EAPI Evas_Object *elm_list_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
14606 * @param obj The list object
14608 * @note Call before running show() on the list object.
14609 * @warning If not called, it won't display the list properly.
14612 * li = elm_list_add(win);
14613 * elm_list_item_append(li, "First", NULL, NULL, NULL, NULL);
14614 * elm_list_item_append(li, "Second", NULL, NULL, NULL, NULL);
14616 * evas_object_show(li);
14621 EAPI void elm_list_go(Evas_Object *obj) EINA_ARG_NONNULL(1);
14624 * Enable or disable multiple items selection on the list object.
14626 * @param obj The list object
14627 * @param multi @c EINA_TRUE to enable multi selection or @c EINA_FALSE to
14630 * Disabled by default. If disabled, the user can select a single item of
14631 * the list each time. Selected items are highlighted on list.
14632 * If enabled, many items can be selected.
14634 * If a selected item is selected again, it will be unselected.
14636 * @see elm_list_multi_select_get()
14640 EAPI void elm_list_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
14643 * Get a value whether multiple items selection is enabled or not.
14645 * @see elm_list_multi_select_set() for details.
14647 * @param obj The list object.
14648 * @return @c EINA_TRUE means multiple items selection is enabled.
14649 * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
14650 * @c EINA_FALSE is returned.
14654 EAPI Eina_Bool elm_list_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14657 * Set which mode to use for the list object.
14659 * @param obj The list object
14660 * @param mode One of #Elm_List_Mode: #ELM_LIST_COMPRESS, #ELM_LIST_SCROLL,
14661 * #ELM_LIST_LIMIT or #ELM_LIST_EXPAND.
14663 * Set list's resize behavior, transverse axis scroll and
14664 * items cropping. See each mode's description for more details.
14666 * @note Default value is #ELM_LIST_SCROLL.
14668 * Only one can be set, if a previous one was set, it will be changed
14669 * by the new mode set. Bitmask won't work as well.
14671 * @see elm_list_mode_get()
14675 EAPI void elm_list_mode_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
14678 * Get the mode the list is at.
14680 * @param obj The list object
14681 * @return One of #Elm_List_Mode: #ELM_LIST_COMPRESS, #ELM_LIST_SCROLL,
14682 * #ELM_LIST_LIMIT, #ELM_LIST_EXPAND or #ELM_LIST_LAST on errors.
14684 * @note see elm_list_mode_set() for more information.
14688 EAPI Elm_List_Mode elm_list_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14691 * Enable or disable horizontal mode on the list object.
14693 * @param obj The list object.
14694 * @param horizontal @c EINA_TRUE to enable horizontal or @c EINA_FALSE to
14695 * disable it, i.e., to enable vertical mode.
14697 * @note Vertical mode is set by default.
14699 * On horizontal mode items are displayed on list from left to right,
14700 * instead of from top to bottom. Also, the list will scroll horizontally.
14701 * Each item will presents left icon on top and right icon, or end, at
14704 * @see elm_list_horizontal_get()
14708 EAPI void elm_list_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
14711 * Get a value whether horizontal mode is enabled or not.
14713 * @param obj The list object.
14714 * @return @c EINA_TRUE means horizontal mode selection is enabled.
14715 * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
14716 * @c EINA_FALSE is returned.
14718 * @see elm_list_horizontal_set() for details.
14722 EAPI Eina_Bool elm_list_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14725 * Enable or disable always select mode on the list object.
14727 * @param obj The list object
14728 * @param always_select @c EINA_TRUE to enable always select mode or
14729 * @c EINA_FALSE to disable it.
14731 * @note Always select mode is disabled by default.
14733 * Default behavior of list items is to only call its callback function
14734 * the first time it's pressed, i.e., when it is selected. If a selected
14735 * item is pressed again, and multi-select is disabled, it won't call
14736 * this function (if multi-select is enabled it will unselect the item).
14738 * If always select is enabled, it will call the callback function
14739 * everytime a item is pressed, so it will call when the item is selected,
14740 * and again when a selected item is pressed.
14742 * @see elm_list_always_select_mode_get()
14743 * @see elm_list_multi_select_set()
14747 EAPI void elm_list_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
14750 * Get a value whether always select mode is enabled or not, meaning that
14751 * an item will always call its callback function, even if already selected.
14753 * @param obj The list object
14754 * @return @c EINA_TRUE means horizontal mode selection is enabled.
14755 * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
14756 * @c EINA_FALSE is returned.
14758 * @see elm_list_always_select_mode_set() for details.
14762 EAPI Eina_Bool elm_list_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14765 * Set bouncing behaviour when the scrolled content reaches an edge.
14767 * Tell the internal scroller object whether it should bounce or not
14768 * when it reaches the respective edges for each axis.
14770 * @param obj The list object
14771 * @param h_bounce Whether to bounce or not in the horizontal axis.
14772 * @param v_bounce Whether to bounce or not in the vertical axis.
14774 * @see elm_scroller_bounce_set()
14778 EAPI void elm_list_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
14781 * Get the bouncing behaviour of the internal scroller.
14783 * Get whether the internal scroller should bounce when the edge of each
14784 * axis is reached scrolling.
14786 * @param obj The list object.
14787 * @param h_bounce Pointer where to store the bounce state of the horizontal
14789 * @param v_bounce Pointer where to store the bounce state of the vertical
14792 * @see elm_scroller_bounce_get()
14793 * @see elm_list_bounce_set()
14797 EAPI void elm_list_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
14800 * Set the scrollbar policy.
14802 * @param obj The list object
14803 * @param policy_h Horizontal scrollbar policy.
14804 * @param policy_v Vertical scrollbar policy.
14806 * This sets the scrollbar visibility policy for the given scroller.
14807 * #ELM_SCROLLER_POLICY_AUTO means the scrollber is made visible if it
14808 * is needed, and otherwise kept hidden. #ELM_SCROLLER_POLICY_ON turns
14809 * it on all the time, and #ELM_SCROLLER_POLICY_OFF always keeps it off.
14810 * This applies respectively for the horizontal and vertical scrollbars.
14812 * The both are disabled by default, i.e., are set to
14813 * #ELM_SCROLLER_POLICY_OFF.
14817 EAPI void elm_list_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
14820 * Get the scrollbar policy.
14822 * @see elm_list_scroller_policy_get() for details.
14824 * @param obj The list object.
14825 * @param policy_h Pointer where to store horizontal scrollbar policy.
14826 * @param policy_v Pointer where to store vertical scrollbar policy.
14830 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);
14833 * Append a new item to the list object.
14835 * @param obj The list object.
14836 * @param label The label of the list item.
14837 * @param icon The icon object to use for the left side of the item. An
14838 * icon can be any Evas object, but usually it is an icon created
14839 * with elm_icon_add().
14840 * @param end The icon object to use for the right side of the item. An
14841 * icon can be any Evas object.
14842 * @param func The function to call when the item is clicked.
14843 * @param data The data to associate with the item for related callbacks.
14845 * @return The created item or @c NULL upon failure.
14847 * A new item will be created and appended to the list, i.e., will
14848 * be set as @b last item.
14850 * Items created with this method can be deleted with
14851 * elm_list_item_del().
14853 * Associated @p data can be properly freed when item is deleted if a
14854 * callback function is set with elm_list_item_del_cb_set().
14856 * If a function is passed as argument, it will be called everytime this item
14857 * is selected, i.e., the user clicks over an unselected item.
14858 * If always select is enabled it will call this function every time
14859 * user clicks over an item (already selected or not).
14860 * If such function isn't needed, just passing
14861 * @c NULL as @p func is enough. The same should be done for @p data.
14863 * Simple example (with no function callback or data associated):
14865 * li = elm_list_add(win);
14866 * ic = elm_icon_add(win);
14867 * elm_icon_file_set(ic, "path/to/image", NULL);
14868 * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
14869 * elm_list_item_append(li, "label", ic, NULL, NULL, NULL);
14871 * evas_object_show(li);
14874 * @see elm_list_always_select_mode_set()
14875 * @see elm_list_item_del()
14876 * @see elm_list_item_del_cb_set()
14877 * @see elm_list_clear()
14878 * @see elm_icon_add()
14882 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);
14885 * Prepend a new item to the list object.
14887 * @param obj The list object.
14888 * @param label The label of the list item.
14889 * @param icon The icon object to use for the left side of the item. An
14890 * icon can be any Evas object, but usually it is an icon created
14891 * with elm_icon_add().
14892 * @param end The icon object to use for the right side of the item. An
14893 * icon can be any Evas object.
14894 * @param func The function to call when the item is clicked.
14895 * @param data The data to associate with the item for related callbacks.
14897 * @return The created item or @c NULL upon failure.
14899 * A new item will be created and prepended to the list, i.e., will
14900 * be set as @b first item.
14902 * Items created with this method can be deleted with
14903 * elm_list_item_del().
14905 * Associated @p data can be properly freed when item is deleted if a
14906 * callback function is set with elm_list_item_del_cb_set().
14908 * If a function is passed as argument, it will be called everytime this item
14909 * is selected, i.e., the user clicks over an unselected item.
14910 * If always select is enabled it will call this function every time
14911 * user clicks over an item (already selected or not).
14912 * If such function isn't needed, just passing
14913 * @c NULL as @p func is enough. The same should be done for @p data.
14915 * @see elm_list_item_append() for a simple code example.
14916 * @see elm_list_always_select_mode_set()
14917 * @see elm_list_item_del()
14918 * @see elm_list_item_del_cb_set()
14919 * @see elm_list_clear()
14920 * @see elm_icon_add()
14924 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);
14927 * Insert a new item into the list object before item @p before.
14929 * @param obj The list object.
14930 * @param before The list item to insert before.
14931 * @param label The label of the list item.
14932 * @param icon The icon object to use for the left side of the item. An
14933 * icon can be any Evas object, but usually it is an icon created
14934 * with elm_icon_add().
14935 * @param end The icon object to use for the right side of the item. An
14936 * icon can be any Evas object.
14937 * @param func The function to call when the item is clicked.
14938 * @param data The data to associate with the item for related callbacks.
14940 * @return The created item or @c NULL upon failure.
14942 * A new item will be created and added to the list. Its position in
14943 * this list will be just before item @p before.
14945 * Items created with this method can be deleted with
14946 * elm_list_item_del().
14948 * Associated @p data can be properly freed when item is deleted if a
14949 * callback function is set with elm_list_item_del_cb_set().
14951 * If a function is passed as argument, it will be called everytime this item
14952 * is selected, i.e., the user clicks over an unselected item.
14953 * If always select is enabled it will call this function every time
14954 * user clicks over an item (already selected or not).
14955 * If such function isn't needed, just passing
14956 * @c NULL as @p func is enough. The same should be done for @p data.
14958 * @see elm_list_item_append() for a simple code example.
14959 * @see elm_list_always_select_mode_set()
14960 * @see elm_list_item_del()
14961 * @see elm_list_item_del_cb_set()
14962 * @see elm_list_clear()
14963 * @see elm_icon_add()
14967 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);
14970 * Insert a new item into the list object after item @p after.
14972 * @param obj The list object.
14973 * @param after The list item to insert after.
14974 * @param label The label of the list item.
14975 * @param icon The icon object to use for the left side of the item. An
14976 * icon can be any Evas object, but usually it is an icon created
14977 * with elm_icon_add().
14978 * @param end The icon object to use for the right side of the item. An
14979 * icon can be any Evas object.
14980 * @param func The function to call when the item is clicked.
14981 * @param data The data to associate with the item for related callbacks.
14983 * @return The created item or @c NULL upon failure.
14985 * A new item will be created and added to the list. Its position in
14986 * this list will be just after item @p after.
14988 * Items created with this method can be deleted with
14989 * elm_list_item_del().
14991 * Associated @p data can be properly freed when item is deleted if a
14992 * callback function is set with elm_list_item_del_cb_set().
14994 * If a function is passed as argument, it will be called everytime this item
14995 * is selected, i.e., the user clicks over an unselected item.
14996 * If always select is enabled it will call this function every time
14997 * user clicks over an item (already selected or not).
14998 * If such function isn't needed, just passing
14999 * @c NULL as @p func is enough. The same should be done for @p data.
15001 * @see elm_list_item_append() for a simple code example.
15002 * @see elm_list_always_select_mode_set()
15003 * @see elm_list_item_del()
15004 * @see elm_list_item_del_cb_set()
15005 * @see elm_list_clear()
15006 * @see elm_icon_add()
15010 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);
15013 * Insert a new item into the sorted list object.
15015 * @param obj The list object.
15016 * @param label The label of the list item.
15017 * @param icon The icon object to use for the left side of the item. An
15018 * icon can be any Evas object, but usually it is an icon created
15019 * with elm_icon_add().
15020 * @param end The icon object to use for the right side of the item. An
15021 * icon can be any Evas object.
15022 * @param func The function to call when the item is clicked.
15023 * @param data The data to associate with the item for related callbacks.
15024 * @param cmp_func The comparing function to be used to sort list
15025 * items <b>by #Elm_List_Item item handles</b>. This function will
15026 * receive two items and compare them, returning a non-negative integer
15027 * if the second item should be place after the first, or negative value
15028 * if should be placed before.
15030 * @return The created item or @c NULL upon failure.
15032 * @note This function inserts values into a list object assuming it was
15033 * sorted and the result will be sorted.
15035 * A new item will be created and added to the list. Its position in
15036 * this list will be found comparing the new item with previously inserted
15037 * items using function @p cmp_func.
15039 * Items created with this method can be deleted with
15040 * elm_list_item_del().
15042 * Associated @p data can be properly freed when item is deleted if a
15043 * callback function is set with elm_list_item_del_cb_set().
15045 * If a function is passed as argument, it will be called everytime this item
15046 * is selected, i.e., the user clicks over an unselected item.
15047 * If always select is enabled it will call this function every time
15048 * user clicks over an item (already selected or not).
15049 * If such function isn't needed, just passing
15050 * @c NULL as @p func is enough. The same should be done for @p data.
15052 * @see elm_list_item_append() for a simple code example.
15053 * @see elm_list_always_select_mode_set()
15054 * @see elm_list_item_del()
15055 * @see elm_list_item_del_cb_set()
15056 * @see elm_list_clear()
15057 * @see elm_icon_add()
15061 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);
15064 * Remove all list's items.
15066 * @param obj The list object
15068 * @see elm_list_item_del()
15069 * @see elm_list_item_append()
15073 EAPI void elm_list_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
15076 * Get a list of all the list items.
15078 * @param obj The list object
15079 * @return An @c Eina_List of list items, #Elm_List_Item,
15080 * or @c NULL on failure.
15082 * @see elm_list_item_append()
15083 * @see elm_list_item_del()
15084 * @see elm_list_clear()
15088 EAPI const Eina_List *elm_list_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15091 * Get the selected item.
15093 * @param obj The list object.
15094 * @return The selected list item.
15096 * The selected item can be unselected with function
15097 * elm_list_item_selected_set().
15099 * The selected item always will be highlighted on list.
15101 * @see elm_list_selected_items_get()
15105 EAPI Elm_List_Item *elm_list_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15108 * Return a list of the currently selected list items.
15110 * @param obj The list object.
15111 * @return An @c Eina_List of list items, #Elm_List_Item,
15112 * or @c NULL on failure.
15114 * Multiple items can be selected if multi select is enabled. It can be
15115 * done with elm_list_multi_select_set().
15117 * @see elm_list_selected_item_get()
15118 * @see elm_list_multi_select_set()
15122 EAPI const Eina_List *elm_list_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15125 * Set the selected state of an item.
15127 * @param item The list item
15128 * @param selected The selected state
15130 * This sets the selected state of the given item @p it.
15131 * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
15133 * If a new item is selected the previosly selected will be unselected,
15134 * unless multiple selection is enabled with elm_list_multi_select_set().
15135 * Previoulsy selected item can be get with function
15136 * elm_list_selected_item_get().
15138 * Selected items will be highlighted.
15140 * @see elm_list_item_selected_get()
15141 * @see elm_list_selected_item_get()
15142 * @see elm_list_multi_select_set()
15146 EAPI void elm_list_item_selected_set(Elm_List_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
15149 * Get whether the @p item is selected or not.
15151 * @param item The list item.
15152 * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
15153 * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
15155 * @see elm_list_selected_item_set() for details.
15156 * @see elm_list_item_selected_get()
15160 EAPI Eina_Bool elm_list_item_selected_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15163 * Set or unset item as a separator.
15165 * @param it The list item.
15166 * @param setting @c EINA_TRUE to set item @p it as separator or
15167 * @c EINA_FALSE to unset, i.e., item will be used as a regular item.
15169 * Items aren't set as separator by default.
15171 * If set as separator it will display separator theme, so won't display
15174 * @see elm_list_item_separator_get()
15178 EAPI void elm_list_item_separator_set(Elm_List_Item *it, Eina_Bool setting) EINA_ARG_NONNULL(1);
15181 * Get a value whether item is a separator or not.
15183 * @see elm_list_item_separator_set() for details.
15185 * @param it The list item.
15186 * @return @c EINA_TRUE means item @p it is a separator. @c EINA_FALSE
15187 * indicates it's not. If @p it is @c NULL, @c EINA_FALSE is returned.
15191 EAPI Eina_Bool elm_list_item_separator_get(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
15194 * Show @p item in the list view.
15196 * @param item The list item to be shown.
15198 * It won't animate list until item is visible. If such behavior is wanted,
15199 * use elm_list_bring_in() intead.
15203 EAPI void elm_list_item_show(Elm_List_Item *item) EINA_ARG_NONNULL(1);
15206 * Bring in the given item to list view.
15208 * @param item The item.
15210 * This causes list to jump to the given item @p item and show it
15211 * (by scrolling), if it is not fully visible.
15213 * This may use animation to do so and take a period of time.
15215 * If animation isn't wanted, elm_list_item_show() can be used.
15219 EAPI void elm_list_item_bring_in(Elm_List_Item *item) EINA_ARG_NONNULL(1);
15222 * Delete them item from the list.
15224 * @param item The item of list to be deleted.
15226 * If deleting all list items is required, elm_list_clear()
15227 * should be used instead of getting items list and deleting each one.
15229 * @see elm_list_clear()
15230 * @see elm_list_item_append()
15231 * @see elm_list_item_del_cb_set()
15235 EAPI void elm_list_item_del(Elm_List_Item *item) EINA_ARG_NONNULL(1);
15238 * Set the function called when a list item is freed.
15240 * @param item The item to set the callback on
15241 * @param func The function called
15243 * If there is a @p func, then it will be called prior item's memory release.
15244 * That will be called with the following arguments:
15246 * @li item's Evas object;
15249 * This way, a data associated to a list item could be properly freed.
15253 EAPI void elm_list_item_del_cb_set(Elm_List_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
15256 * Get the data associated to the item.
15258 * @param item The list item
15259 * @return The data associated to @p item
15261 * The return value is a pointer to data associated to @p item when it was
15262 * created, with function elm_list_item_append() or similar. If no data
15263 * was passed as argument, it will return @c NULL.
15265 * @see elm_list_item_append()
15269 EAPI void *elm_list_item_data_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15272 * Get the left side icon associated to the item.
15274 * @param item The list item
15275 * @return The left side icon associated to @p item
15277 * The return value is a pointer to the icon associated to @p item when
15279 * created, with function elm_list_item_append() or similar, or later
15280 * with function elm_list_item_icon_set(). If no icon
15281 * was passed as argument, it will return @c NULL.
15283 * @see elm_list_item_append()
15284 * @see elm_list_item_icon_set()
15288 EAPI Evas_Object *elm_list_item_icon_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15291 * Set the left side icon associated to the item.
15293 * @param item The list item
15294 * @param icon The left side icon object to associate with @p item
15296 * The icon object to use at left side of the item. An
15297 * icon can be any Evas object, but usually it is an icon created
15298 * with elm_icon_add().
15300 * Once the icon object is set, a previously set one will be deleted.
15301 * @warning Setting the same icon for two items will cause the icon to
15302 * dissapear from the first item.
15304 * If an icon was passed as argument on item creation, with function
15305 * elm_list_item_append() or similar, it will be already
15306 * associated to the item.
15308 * @see elm_list_item_append()
15309 * @see elm_list_item_icon_get()
15313 EAPI void elm_list_item_icon_set(Elm_List_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
15316 * Get the right side icon associated to the item.
15318 * @param item The list item
15319 * @return The right side icon associated to @p item
15321 * The return value is a pointer to the icon associated to @p item when
15323 * created, with function elm_list_item_append() or similar, or later
15324 * with function elm_list_item_icon_set(). If no icon
15325 * was passed as argument, it will return @c NULL.
15327 * @see elm_list_item_append()
15328 * @see elm_list_item_icon_set()
15332 EAPI Evas_Object *elm_list_item_end_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15335 * Set the right side icon associated to the item.
15337 * @param item The list item
15338 * @param end The right side icon object to associate with @p item
15340 * The icon object to use at right side of the item. An
15341 * icon can be any Evas object, but usually it is an icon created
15342 * with elm_icon_add().
15344 * Once the icon object is set, a previously set one will be deleted.
15345 * @warning Setting the same icon for two items will cause the icon to
15346 * dissapear from the first item.
15348 * If an icon was passed as argument on item creation, with function
15349 * elm_list_item_append() or similar, it will be already
15350 * associated to the item.
15352 * @see elm_list_item_append()
15353 * @see elm_list_item_end_get()
15357 EAPI void elm_list_item_end_set(Elm_List_Item *item, Evas_Object *end) EINA_ARG_NONNULL(1);
15360 * Gets the base object of the item.
15362 * @param item The list item
15363 * @return The base object associated with @p item
15365 * Base object is the @c Evas_Object that represents that item.
15369 EAPI Evas_Object *elm_list_item_object_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15370 EINA_DEPRECATED EAPI Evas_Object *elm_list_item_base_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15373 * Get the label of item.
15375 * @param item The item of list.
15376 * @return The label of item.
15378 * The return value is a pointer to the label associated to @p item when
15379 * it was created, with function elm_list_item_append(), or later
15380 * with function elm_list_item_label_set. If no label
15381 * was passed as argument, it will return @c NULL.
15383 * @see elm_list_item_label_set() for more details.
15384 * @see elm_list_item_append()
15388 EAPI const char *elm_list_item_label_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15391 * Set the label of item.
15393 * @param item The item of list.
15394 * @param text The label of item.
15396 * The label to be displayed by the item.
15397 * Label will be placed between left and right side icons (if set).
15399 * If a label was passed as argument on item creation, with function
15400 * elm_list_item_append() or similar, it will be already
15401 * displayed by the item.
15403 * @see elm_list_item_label_get()
15404 * @see elm_list_item_append()
15408 EAPI void elm_list_item_label_set(Elm_List_Item *item, const char *text) EINA_ARG_NONNULL(1);
15412 * Get the item before @p it in list.
15414 * @param it The list item.
15415 * @return The item before @p it, or @c NULL if none or on failure.
15417 * @note If it is the first item, @c NULL will be returned.
15419 * @see elm_list_item_append()
15420 * @see elm_list_items_get()
15424 EAPI Elm_List_Item *elm_list_item_prev(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
15427 * Get the item after @p it in list.
15429 * @param it The list item.
15430 * @return The item after @p it, or @c NULL if none or on failure.
15432 * @note If it is the last item, @c NULL will be returned.
15434 * @see elm_list_item_append()
15435 * @see elm_list_items_get()
15439 EAPI Elm_List_Item *elm_list_item_next(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
15442 * Sets the disabled/enabled state of a list item.
15444 * @param it The item.
15445 * @param disabled The disabled state.
15447 * A disabled item cannot be selected or unselected. It will also
15448 * change its appearance (generally greyed out). This sets the
15449 * disabled state (@c EINA_TRUE for disabled, @c EINA_FALSE for
15454 EAPI void elm_list_item_disabled_set(Elm_List_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1);
15457 * Get a value whether list item is disabled or not.
15459 * @param it The item.
15460 * @return The disabled state.
15462 * @see elm_list_item_disabled_set() for more details.
15466 EAPI Eina_Bool elm_list_item_disabled_get(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
15469 * Set the text to be shown in a given list item's tooltips.
15471 * @param item Target item.
15472 * @param text The text to set in the content.
15474 * Setup the text as tooltip to object. The item can have only one tooltip,
15475 * so any previous tooltip data - set with this function or
15476 * elm_list_item_tooltip_content_cb_set() - is removed.
15478 * @see elm_object_tooltip_text_set() for more details.
15482 EAPI void elm_list_item_tooltip_text_set(Elm_List_Item *item, const char *text) EINA_ARG_NONNULL(1);
15486 * @brief Disable size restrictions on an object's tooltip
15487 * @param item The tooltip's anchor object
15488 * @param disable If EINA_TRUE, size restrictions are disabled
15489 * @return EINA_FALSE on failure, EINA_TRUE on success
15491 * This function allows a tooltip to expand beyond its parant window's canvas.
15492 * It will instead be limited only by the size of the display.
15494 EAPI Eina_Bool elm_list_item_tooltip_size_restrict_disable(Elm_List_Item *item, Eina_Bool disable) EINA_ARG_NONNULL(1);
15496 * @brief Retrieve size restriction state of an object's tooltip
15497 * @param obj The tooltip's anchor object
15498 * @return If EINA_TRUE, size restrictions are disabled
15500 * This function returns whether a tooltip is allowed to expand beyond
15501 * its parant window's canvas.
15502 * It will instead be limited only by the size of the display.
15504 EAPI Eina_Bool elm_list_item_tooltip_size_restrict_disabled_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15507 * Set the content to be shown in the tooltip item.
15509 * Setup the tooltip to item. The item can have only one tooltip,
15510 * so any previous tooltip data is removed. @p func(with @p data) will
15511 * be called every time that need show the tooltip and it should
15512 * return a valid Evas_Object. This object is then managed fully by
15513 * tooltip system and is deleted when the tooltip is gone.
15515 * @param item the list item being attached a tooltip.
15516 * @param func the function used to create the tooltip contents.
15517 * @param data what to provide to @a func as callback data/context.
15518 * @param del_cb called when data is not needed anymore, either when
15519 * another callback replaces @a func, the tooltip is unset with
15520 * elm_list_item_tooltip_unset() or the owner @a item
15521 * dies. This callback receives as the first parameter the
15522 * given @a data, and @c event_info is the item.
15524 * @see elm_object_tooltip_content_cb_set() for more details.
15528 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);
15531 * Unset tooltip from item.
15533 * @param item list item to remove previously set tooltip.
15535 * Remove tooltip from item. The callback provided as del_cb to
15536 * elm_list_item_tooltip_content_cb_set() will be called to notify
15537 * it is not used anymore.
15539 * @see elm_object_tooltip_unset() for more details.
15540 * @see elm_list_item_tooltip_content_cb_set()
15544 EAPI void elm_list_item_tooltip_unset(Elm_List_Item *item) EINA_ARG_NONNULL(1);
15547 * Sets a different style for this item tooltip.
15549 * @note before you set a style you should define a tooltip with
15550 * elm_list_item_tooltip_content_cb_set() or
15551 * elm_list_item_tooltip_text_set()
15553 * @param item list item with tooltip already set.
15554 * @param style the theme style to use (default, transparent, ...)
15556 * @see elm_object_tooltip_style_set() for more details.
15560 EAPI void elm_list_item_tooltip_style_set(Elm_List_Item *item, const char *style) EINA_ARG_NONNULL(1);
15563 * Get the style for this item tooltip.
15565 * @param item list item with tooltip already set.
15566 * @return style the theme style in use, defaults to "default". If the
15567 * object does not have a tooltip set, then NULL is returned.
15569 * @see elm_object_tooltip_style_get() for more details.
15570 * @see elm_list_item_tooltip_style_set()
15574 EAPI const char *elm_list_item_tooltip_style_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15577 * Set the type of mouse pointer/cursor decoration to be shown,
15578 * when the mouse pointer is over the given list widget item
15580 * @param item list item to customize cursor on
15581 * @param cursor the cursor type's name
15583 * This function works analogously as elm_object_cursor_set(), but
15584 * here the cursor's changing area is restricted to the item's
15585 * area, and not the whole widget's. Note that that item cursors
15586 * have precedence over widget cursors, so that a mouse over an
15587 * item with custom cursor set will always show @b that cursor.
15589 * If this function is called twice for an object, a previously set
15590 * cursor will be unset on the second call.
15592 * @see elm_object_cursor_set()
15593 * @see elm_list_item_cursor_get()
15594 * @see elm_list_item_cursor_unset()
15598 EAPI void elm_list_item_cursor_set(Elm_List_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
15601 * Get the type of mouse pointer/cursor decoration set to be shown,
15602 * when the mouse pointer is over the given list widget item
15604 * @param item list item with custom cursor set
15605 * @return the cursor type's name or @c NULL, if no custom cursors
15606 * were set to @p item (and on errors)
15608 * @see elm_object_cursor_get()
15609 * @see elm_list_item_cursor_set()
15610 * @see elm_list_item_cursor_unset()
15614 EAPI const char *elm_list_item_cursor_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15617 * Unset any custom mouse pointer/cursor decoration set to be
15618 * shown, when the mouse pointer is over the given list widget
15619 * item, thus making it show the @b default cursor again.
15621 * @param item a list item
15623 * Use this call to undo any custom settings on this item's cursor
15624 * decoration, bringing it back to defaults (no custom style set).
15626 * @see elm_object_cursor_unset()
15627 * @see elm_list_item_cursor_set()
15631 EAPI void elm_list_item_cursor_unset(Elm_List_Item *item) EINA_ARG_NONNULL(1);
15634 * Set a different @b style for a given custom cursor set for a
15637 * @param item list item with custom cursor set
15638 * @param style the <b>theme style</b> to use (e.g. @c "default",
15639 * @c "transparent", etc)
15641 * This function only makes sense when one is using custom mouse
15642 * cursor decorations <b>defined in a theme file</b>, which can have,
15643 * given a cursor name/type, <b>alternate styles</b> on it. It
15644 * works analogously as elm_object_cursor_style_set(), but here
15645 * applyed only to list item objects.
15647 * @warning Before you set a cursor style you should have definen a
15648 * custom cursor previously on the item, with
15649 * elm_list_item_cursor_set()
15651 * @see elm_list_item_cursor_engine_only_set()
15652 * @see elm_list_item_cursor_style_get()
15656 EAPI void elm_list_item_cursor_style_set(Elm_List_Item *item, const char *style) EINA_ARG_NONNULL(1);
15659 * Get the current @b style set for a given list item's custom
15662 * @param item list item with custom cursor set.
15663 * @return style the cursor style in use. If the object does not
15664 * have a cursor set, then @c NULL is returned.
15666 * @see elm_list_item_cursor_style_set() for more details
15670 EAPI const char *elm_list_item_cursor_style_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15673 * Set if the (custom)cursor for a given list item should be
15674 * searched in its theme, also, or should only rely on the
15675 * rendering engine.
15677 * @param item item with custom (custom) cursor already set on
15678 * @param engine_only Use @c EINA_TRUE to have cursors looked for
15679 * only on those provided by the rendering engine, @c EINA_FALSE to
15680 * have them searched on the widget's theme, as well.
15682 * @note This call is of use only if you've set a custom cursor
15683 * for list items, with elm_list_item_cursor_set().
15685 * @note By default, cursors will only be looked for between those
15686 * provided by the rendering engine.
15690 EAPI void elm_list_item_cursor_engine_only_set(Elm_List_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
15693 * Get if the (custom) cursor for a given list item is being
15694 * searched in its theme, also, or is only relying on the rendering
15697 * @param item a list item
15698 * @return @c EINA_TRUE, if cursors are being looked for only on
15699 * those provided by the rendering engine, @c EINA_FALSE if they
15700 * are being searched on the widget's theme, as well.
15702 * @see elm_list_item_cursor_engine_only_set(), for more details
15706 EAPI Eina_Bool elm_list_item_cursor_engine_only_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15713 * @defgroup Slider Slider
15714 * @ingroup Elementary
15716 * @image html img/widget/slider/preview-00.png
15717 * @image latex img/widget/slider/preview-00.eps width=\textwidth
15719 * The slider adds a dragable “slider” widget for selecting the value of
15720 * something within a range.
15722 * A slider can be horizontal or vertical. It can contain an Icon and has a
15723 * primary label as well as a units label (that is formatted with floating
15724 * point values and thus accepts a printf-style format string, like
15725 * “%1.2f units”. There is also an indicator string that may be somewhere
15726 * else (like on the slider itself) that also accepts a format string like
15727 * units. Label, Icon Unit and Indicator strings/objects are optional.
15729 * A slider may be inverted which means values invert, with high vales being
15730 * on the left or top and low values on the right or bottom (as opposed to
15731 * normally being low on the left or top and high on the bottom and right).
15733 * The slider should have its minimum and maximum values set by the
15734 * application with elm_slider_min_max_set() and value should also be set by
15735 * the application before use with elm_slider_value_set(). The span of the
15736 * slider is its length (horizontally or vertically). This will be scaled by
15737 * the object or applications scaling factor. At any point code can query the
15738 * slider for its value with elm_slider_value_get().
15740 * Smart callbacks one can listen to:
15741 * - "changed" - Whenever the slider value is changed by the user.
15742 * - "slider,drag,start" - dragging the slider indicator around has started.
15743 * - "slider,drag,stop" - dragging the slider indicator around has stopped.
15744 * - "delay,changed" - A short time after the value is changed by the user.
15745 * This will be called only when the user stops dragging for
15746 * a very short period or when they release their
15747 * finger/mouse, so it avoids possibly expensive reactions to
15748 * the value change.
15750 * Available styles for it:
15753 * Here is an example on its usage:
15754 * @li @ref slider_example
15758 * @addtogroup Slider
15763 * Add a new slider widget to the given parent Elementary
15764 * (container) object.
15766 * @param parent The parent object.
15767 * @return a new slider widget handle or @c NULL, on errors.
15769 * This function inserts a new slider widget on the canvas.
15773 EAPI Evas_Object *elm_slider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
15776 * Set the label of a given slider widget
15778 * @param obj The progress bar object
15779 * @param label The text label string, in UTF-8
15782 * @deprecated use elm_object_text_set() instead.
15784 EINA_DEPRECATED EAPI void elm_slider_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
15787 * Get the label of a given slider widget
15789 * @param obj The progressbar object
15790 * @return The text label string, in UTF-8
15793 * @deprecated use elm_object_text_get() instead.
15795 EINA_DEPRECATED EAPI const char *elm_slider_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15798 * Set the icon object of the slider object.
15800 * @param obj The slider object.
15801 * @param icon The icon object.
15803 * On horizontal mode, icon is placed at left, and on vertical mode,
15806 * @note Once the icon object is set, a previously set one will be deleted.
15807 * If you want to keep that old content object, use the
15808 * elm_slider_icon_unset() function.
15810 * @warning If the object being set does not have minimum size hints set,
15811 * it won't get properly displayed.
15815 EAPI void elm_slider_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
15818 * Unset an icon set on a given slider widget.
15820 * @param obj The slider object.
15821 * @return The icon object that was being used, if any was set, or
15822 * @c NULL, otherwise (and on errors).
15824 * On horizontal mode, icon is placed at left, and on vertical mode,
15827 * This call will unparent and return the icon object which was set
15828 * for this widget, previously, on success.
15830 * @see elm_slider_icon_set() for more details
15831 * @see elm_slider_icon_get()
15835 EAPI Evas_Object *elm_slider_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
15838 * Retrieve the icon object set for a given slider widget.
15840 * @param obj The slider object.
15841 * @return The icon object's handle, if @p obj had one set, or @c NULL,
15842 * otherwise (and on errors).
15844 * On horizontal mode, icon is placed at left, and on vertical mode,
15847 * @see elm_slider_icon_set() for more details
15848 * @see elm_slider_icon_unset()
15852 EAPI Evas_Object *elm_slider_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15855 * Set the end object of the slider object.
15857 * @param obj The slider object.
15858 * @param end The end object.
15860 * On horizontal mode, end is placed at left, and on vertical mode,
15861 * placed at bottom.
15863 * @note Once the icon object is set, a previously set one will be deleted.
15864 * If you want to keep that old content object, use the
15865 * elm_slider_end_unset() function.
15867 * @warning If the object being set does not have minimum size hints set,
15868 * it won't get properly displayed.
15872 EAPI void elm_slider_end_set(Evas_Object *obj, Evas_Object *end) EINA_ARG_NONNULL(1);
15875 * Unset an end object set on a given slider widget.
15877 * @param obj The slider object.
15878 * @return The end object that was being used, if any was set, or
15879 * @c NULL, otherwise (and on errors).
15881 * On horizontal mode, end is placed at left, and on vertical mode,
15882 * placed at bottom.
15884 * This call will unparent and return the icon object which was set
15885 * for this widget, previously, on success.
15887 * @see elm_slider_end_set() for more details.
15888 * @see elm_slider_end_get()
15892 EAPI Evas_Object *elm_slider_end_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
15895 * Retrieve the end object set for a given slider widget.
15897 * @param obj The slider object.
15898 * @return The end object's handle, if @p obj had one set, or @c NULL,
15899 * otherwise (and on errors).
15901 * On horizontal mode, icon is placed at right, and on vertical mode,
15902 * placed at bottom.
15904 * @see elm_slider_end_set() for more details.
15905 * @see elm_slider_end_unset()
15909 EAPI Evas_Object *elm_slider_end_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15912 * Set the (exact) length of the bar region of a given slider widget.
15914 * @param obj The slider object.
15915 * @param size The length of the slider's bar region.
15917 * This sets the minimum width (when in horizontal mode) or height
15918 * (when in vertical mode) of the actual bar area of the slider
15919 * @p obj. This in turn affects the object's minimum size. Use
15920 * this when you're not setting other size hints expanding on the
15921 * given direction (like weight and alignment hints) and you would
15922 * like it to have a specific size.
15924 * @note Icon, end, label, indicator and unit text around @p obj
15925 * will require their
15926 * own space, which will make @p obj to require more the @p size,
15929 * @see elm_slider_span_size_get()
15933 EAPI void elm_slider_span_size_set(Evas_Object *obj, Evas_Coord size) EINA_ARG_NONNULL(1);
15936 * Get the length set for the bar region of a given slider widget
15938 * @param obj The slider object.
15939 * @return The length of the slider's bar region.
15941 * If that size was not set previously, with
15942 * elm_slider_span_size_set(), this call will return @c 0.
15946 EAPI Evas_Coord elm_slider_span_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15949 * Set the format string for the unit label.
15951 * @param obj The slider object.
15952 * @param format The format string for the unit display.
15954 * Unit label is displayed all the time, if set, after slider's bar.
15955 * In horizontal mode, at right and in vertical mode, at bottom.
15957 * If @c NULL, unit label won't be visible. If not it sets the format
15958 * string for the label text. To the label text is provided a floating point
15959 * value, so the label text can display up to 1 floating point value.
15960 * Note that this is optional.
15962 * Use a format string such as "%1.2f meters" for example, and it will
15963 * display values like: "3.14 meters" for a value equal to 3.14159.
15965 * Default is unit label disabled.
15967 * @see elm_slider_indicator_format_get()
15971 EAPI void elm_slider_unit_format_set(Evas_Object *obj, const char *format) EINA_ARG_NONNULL(1);
15974 * Get the unit label format of the slider.
15976 * @param obj The slider object.
15977 * @return The unit label format string in UTF-8.
15979 * Unit label is displayed all the time, if set, after slider's bar.
15980 * In horizontal mode, at right and in vertical mode, at bottom.
15982 * @see elm_slider_unit_format_set() for more
15983 * information on how this works.
15987 EAPI const char *elm_slider_unit_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15990 * Set the format string for the indicator label.
15992 * @param obj The slider object.
15993 * @param indicator The format string for the indicator display.
15995 * The slider may display its value somewhere else then unit label,
15996 * for example, above the slider knob that is dragged around. This function
15997 * sets the format string used for this.
15999 * If @c NULL, indicator label won't be visible. If not it sets the format
16000 * string for the label text. To the label text is provided a floating point
16001 * value, so the label text can display up to 1 floating point value.
16002 * Note that this is optional.
16004 * Use a format string such as "%1.2f meters" for example, and it will
16005 * display values like: "3.14 meters" for a value equal to 3.14159.
16007 * Default is indicator label disabled.
16009 * @see elm_slider_indicator_format_get()
16013 EAPI void elm_slider_indicator_format_set(Evas_Object *obj, const char *indicator) EINA_ARG_NONNULL(1);
16016 * Get the indicator label format of the slider.
16018 * @param obj The slider object.
16019 * @return The indicator label format string in UTF-8.
16021 * The slider may display its value somewhere else then unit label,
16022 * for example, above the slider knob that is dragged around. This function
16023 * gets the format string used for this.
16025 * @see elm_slider_indicator_format_set() for more
16026 * information on how this works.
16030 EAPI const char *elm_slider_indicator_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16033 * Set the format function pointer for the indicator label
16035 * @param obj The slider object.
16036 * @param func The indicator format function.
16037 * @param free_func The freeing function for the format string.
16039 * Set the callback function to format the indicator string.
16041 * @see elm_slider_indicator_format_set() for more info on how this works.
16045 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);
16048 * Set the format function pointer for the units label
16050 * @param obj The slider object.
16051 * @param func The units format function.
16052 * @param free_func The freeing function for the format string.
16054 * Set the callback function to format the indicator string.
16056 * @see elm_slider_units_format_set() for more info on how this works.
16060 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);
16063 * Set the orientation of a given slider widget.
16065 * @param obj The slider object.
16066 * @param horizontal Use @c EINA_TRUE to make @p obj to be
16067 * @b horizontal, @c EINA_FALSE to make it @b vertical.
16069 * Use this function to change how your slider is to be
16070 * disposed: vertically or horizontally.
16072 * By default it's displayed horizontally.
16074 * @see elm_slider_horizontal_get()
16078 EAPI void elm_slider_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
16081 * Retrieve the orientation of a given slider widget
16083 * @param obj The slider object.
16084 * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
16085 * @c EINA_FALSE if it's @b vertical (and on errors).
16087 * @see elm_slider_horizontal_set() for more details.
16091 EAPI Eina_Bool elm_slider_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16094 * Set the minimum and maximum values for the slider.
16096 * @param obj The slider object.
16097 * @param min The minimum value.
16098 * @param max The maximum value.
16100 * Define the allowed range of values to be selected by the user.
16102 * If actual value is less than @p min, it will be updated to @p min. If it
16103 * is bigger then @p max, will be updated to @p max. Actual value can be
16104 * get with elm_slider_value_get().
16106 * By default, min is equal to 0.0, and max is equal to 1.0.
16108 * @warning Maximum must be greater than minimum, otherwise behavior
16111 * @see elm_slider_min_max_get()
16115 EAPI void elm_slider_min_max_set(Evas_Object *obj, double min, double max) EINA_ARG_NONNULL(1);
16118 * Get the minimum and maximum values of the slider.
16120 * @param obj The slider object.
16121 * @param min Pointer where to store the minimum value.
16122 * @param max Pointer where to store the maximum value.
16124 * @note If only one value is needed, the other pointer can be passed
16127 * @see elm_slider_min_max_set() for details.
16131 EAPI void elm_slider_min_max_get(const Evas_Object *obj, double *min, double *max) EINA_ARG_NONNULL(1);
16134 * Set the value the slider displays.
16136 * @param obj The slider object.
16137 * @param val The value to be displayed.
16139 * Value will be presented on the unit label following format specified with
16140 * elm_slider_unit_format_set() and on indicator with
16141 * elm_slider_indicator_format_set().
16143 * @warning The value must to be between min and max values. This values
16144 * are set by elm_slider_min_max_set().
16146 * @see elm_slider_value_get()
16147 * @see elm_slider_unit_format_set()
16148 * @see elm_slider_indicator_format_set()
16149 * @see elm_slider_min_max_set()
16153 EAPI void elm_slider_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
16156 * Get the value displayed by the spinner.
16158 * @param obj The spinner object.
16159 * @return The value displayed.
16161 * @see elm_spinner_value_set() for details.
16165 EAPI double elm_slider_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16168 * Invert a given slider widget's displaying values order
16170 * @param obj The slider object.
16171 * @param inverted Use @c EINA_TRUE to make @p obj inverted,
16172 * @c EINA_FALSE to bring it back to default, non-inverted values.
16174 * A slider may be @b inverted, in which state it gets its
16175 * values inverted, with high vales being on the left or top and
16176 * low values on the right or bottom, as opposed to normally have
16177 * the low values on the former and high values on the latter,
16178 * respectively, for horizontal and vertical modes.
16180 * @see elm_slider_inverted_get()
16184 EAPI void elm_slider_inverted_set(Evas_Object *obj, Eina_Bool inverted) EINA_ARG_NONNULL(1);
16187 * Get whether a given slider widget's displaying values are
16190 * @param obj The slider object.
16191 * @return @c EINA_TRUE, if @p obj has inverted values,
16192 * @c EINA_FALSE otherwise (and on errors).
16194 * @see elm_slider_inverted_set() for more details.
16198 EAPI Eina_Bool elm_slider_inverted_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16201 * Set whether to enlarge slider indicator (augmented knob) or not.
16203 * @param obj The slider object.
16204 * @param show @c EINA_TRUE will make it enlarge, @c EINA_FALSE will
16205 * let the knob always at default size.
16207 * By default, indicator will be bigger while dragged by the user.
16209 * @warning It won't display values set with
16210 * elm_slider_indicator_format_set() if you disable indicator.
16214 EAPI void elm_slider_indicator_show_set(Evas_Object *obj, Eina_Bool show) EINA_ARG_NONNULL(1);
16217 * Get whether a given slider widget's enlarging indicator or not.
16219 * @param obj The slider object.
16220 * @return @c EINA_TRUE, if @p obj is enlarging indicator, or
16221 * @c EINA_FALSE otherwise (and on errors).
16223 * @see elm_slider_indicator_show_set() for details.
16227 EAPI Eina_Bool elm_slider_indicator_show_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16234 * @addtogroup Actionslider Actionslider
16236 * @image html img/widget/actionslider/preview-00.png
16237 * @image latex img/widget/actionslider/preview-00.eps
16239 * A actionslider is a switcher for 2 or 3 labels with customizable magnet
16240 * properties. The indicator is the element the user drags to choose a label.
16241 * When the position is set with magnet, when released the indicator will be
16242 * moved to it if it's nearest the magnetized position.
16244 * @note By default all positions are set as enabled.
16246 * Signals that you can add callbacks for are:
16248 * "selected" - when user selects an enabled position (the label is passed
16251 * "pos_changed" - when the indicator reaches any of the positions("left",
16252 * "right" or "center").
16254 * See an example of actionslider usage @ref actionslider_example_page "here"
16257 typedef enum _Elm_Actionslider_Pos
16259 ELM_ACTIONSLIDER_NONE = 0,
16260 ELM_ACTIONSLIDER_LEFT = 1 << 0,
16261 ELM_ACTIONSLIDER_CENTER = 1 << 1,
16262 ELM_ACTIONSLIDER_RIGHT = 1 << 2,
16263 ELM_ACTIONSLIDER_ALL = (1 << 3) -1
16264 } Elm_Actionslider_Pos;
16267 * Add a new actionslider to the parent.
16269 * @param parent The parent object
16270 * @return The new actionslider object or NULL if it cannot be created
16272 EAPI Evas_Object *elm_actionslider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
16274 * Set actionslider labels.
16276 * @param obj The actionslider object
16277 * @param left_label The label to be set on the left.
16278 * @param center_label The label to be set on the center.
16279 * @param right_label The label to be set on the right.
16280 * @deprecated use elm_object_text_set() instead.
16282 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);
16284 * Get actionslider labels.
16286 * @param obj The actionslider object
16287 * @param left_label A char** to place the left_label of @p obj into.
16288 * @param center_label A char** to place the center_label of @p obj into.
16289 * @param right_label A char** to place the right_label of @p obj into.
16290 * @deprecated use elm_object_text_set() instead.
16292 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);
16294 * Get actionslider selected label.
16296 * @param obj The actionslider object
16297 * @return The selected label
16299 EAPI const char *elm_actionslider_selected_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16301 * Set actionslider indicator position.
16303 * @param obj The actionslider object.
16304 * @param pos The position of the indicator.
16306 EAPI void elm_actionslider_indicator_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
16308 * Get actionslider indicator position.
16310 * @param obj The actionslider object.
16311 * @return The position of the indicator.
16313 EAPI Elm_Actionslider_Pos elm_actionslider_indicator_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16315 * Set actionslider magnet position. To make multiple positions magnets @c or
16316 * them together(e.g.: ELM_ACTIONSLIDER_LEFT | ELM_ACTIONSLIDER_RIGHT)
16318 * @param obj The actionslider object.
16319 * @param pos Bit mask indicating the magnet positions.
16321 EAPI void elm_actionslider_magnet_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
16323 * Get actionslider magnet position.
16325 * @param obj The actionslider object.
16326 * @return The positions with magnet property.
16328 EAPI Elm_Actionslider_Pos elm_actionslider_magnet_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16330 * Set actionslider enabled position. To set multiple positions as enabled @c or
16331 * them together(e.g.: ELM_ACTIONSLIDER_LEFT | ELM_ACTIONSLIDER_RIGHT).
16333 * @note All the positions are enabled by default.
16335 * @param obj The actionslider object.
16336 * @param pos Bit mask indicating the enabled positions.
16338 EAPI void elm_actionslider_enabled_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
16340 * Get actionslider enabled position.
16342 * @param obj The actionslider object.
16343 * @return The enabled positions.
16345 EAPI Elm_Actionslider_Pos elm_actionslider_enabled_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16347 * Set the label used on the indicator.
16349 * @param obj The actionslider object
16350 * @param label The label to be set on the indicator.
16351 * @deprecated use elm_object_text_set() instead.
16353 EINA_DEPRECATED EAPI void elm_actionslider_indicator_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
16355 * Get the label used on the indicator object.
16357 * @param obj The actionslider object
16358 * @return The indicator label
16359 * @deprecated use elm_object_text_get() instead.
16361 EINA_DEPRECATED EAPI const char *elm_actionslider_indicator_label_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
16367 * @defgroup Genlist Genlist
16369 * @image html img/widget/genlist/preview-00.png
16370 * @image latex img/widget/genlist/preview-00.eps
16371 * @image html img/genlist.png
16372 * @image latex img/genlist.eps
16374 * This widget aims to have more expansive list than the simple list in
16375 * Elementary that could have more flexible items and allow many more entries
16376 * while still being fast and low on memory usage. At the same time it was
16377 * also made to be able to do tree structures. But the price to pay is more
16378 * complexity when it comes to usage. If all you want is a simple list with
16379 * icons and a single label, use the normal @ref List object.
16381 * Genlist has a fairly large API, mostly because it's relatively complex,
16382 * trying to be both expansive, powerful and efficient. First we will begin
16383 * an overview on the theory behind genlist.
16385 * @section Genlist_Item_Class Genlist item classes - creating items
16387 * In order to have the ability to add and delete items on the fly, genlist
16388 * implements a class (callback) system where the application provides a
16389 * structure with information about that type of item (genlist may contain
16390 * multiple different items with different classes, states and styles).
16391 * Genlist will call the functions in this struct (methods) when an item is
16392 * "realized" (i.e., created dynamically, while the user is scrolling the
16393 * grid). All objects will simply be deleted when no longer needed with
16394 * evas_object_del(). The #Elm_Genlist_Item_Class structure contains the
16395 * following members:
16396 * - @c item_style - This is a constant string and simply defines the name
16397 * of the item style. It @b must be specified and the default should be @c
16399 * - @c mode_item_style - This is a constant string and simply defines the
16400 * name of the style that will be used for mode animations. It can be left
16401 * as @c NULL if you don't plan to use Genlist mode. See
16402 * elm_genlist_item_mode_set() for more info.
16404 * - @c func - A struct with pointers to functions that will be called when
16405 * an item is going to be actually created. All of them receive a @c data
16406 * parameter that will point to the same data passed to
16407 * elm_genlist_item_append() and related item creation functions, and a @c
16408 * obj parameter that points to the genlist object itself.
16410 * The function pointers inside @c func are @c label_get, @c icon_get, @c
16411 * state_get and @c del. The 3 first functions also receive a @c part
16412 * parameter described below. A brief description of these functions follows:
16414 * - @c label_get - The @c part parameter is the name string of one of the
16415 * existing text parts in the Edje group implementing the item's theme.
16416 * This function @b must return a strdup'()ed string, as the caller will
16417 * free() it when done. See #Elm_Genlist_Item_Label_Get_Cb.
16418 * - @c icon_get - The @c part parameter is the name string of one of the
16419 * existing (icon) swallow parts in the Edje group implementing the item's
16420 * theme. It must return @c NULL, when no icon is desired, or a valid
16421 * object handle, otherwise. The object will be deleted by the genlist on
16422 * its deletion or when the item is "unrealized". See
16423 * #Elm_Genlist_Item_Icon_Get_Cb.
16424 * - @c func.state_get - The @c part parameter is the name string of one of
16425 * the state parts in the Edje group implementing the item's theme. Return
16426 * @c EINA_FALSE for false/off or @c EINA_TRUE for true/on. Genlists will
16427 * emit a signal to its theming Edje object with @c "elm,state,XXX,active"
16428 * and @c "elm" as "emission" and "source" arguments, respectively, when
16429 * the state is true (the default is false), where @c XXX is the name of
16430 * the (state) part. See #Elm_Genlist_Item_State_Get_Cb.
16431 * - @c func.del - This is intended for use when genlist items are deleted,
16432 * so any data attached to the item (e.g. its data parameter on creation)
16433 * can be deleted. See #Elm_Genlist_Item_Del_Cb.
16435 * available item styles:
16437 * - default_style - The text part is a textblock
16439 * @image html img/widget/genlist/preview-04.png
16440 * @image latex img/widget/genlist/preview-04.eps
16444 * @image html img/widget/genlist/preview-01.png
16445 * @image latex img/widget/genlist/preview-01.eps
16447 * - icon_top_text_bottom
16449 * @image html img/widget/genlist/preview-02.png
16450 * @image latex img/widget/genlist/preview-02.eps
16454 * @image html img/widget/genlist/preview-03.png
16455 * @image latex img/widget/genlist/preview-03.eps
16457 * @section Genlist_Items Structure of items
16459 * An item in a genlist can have 0 or more text labels (they can be regular
16460 * text or textblock Evas objects - that's up to the style to determine), 0
16461 * or more icons (which are simply objects swallowed into the genlist item's
16462 * theming Edje object) and 0 or more <b>boolean states</b>, which have the
16463 * behavior left to the user to define. The Edje part names for each of
16464 * these properties will be looked up, in the theme file for the genlist,
16465 * under the Edje (string) data items named @c "labels", @c "icons" and @c
16466 * "states", respectively. For each of those properties, if more than one
16467 * part is provided, they must have names listed separated by spaces in the
16468 * data fields. For the default genlist item theme, we have @b one label
16469 * part (@c "elm.text"), @b two icon parts (@c "elm.swalllow.icon" and @c
16470 * "elm.swallow.end") and @b no state parts.
16472 * A genlist item may be at one of several styles. Elementary provides one
16473 * by default - "default", but this can be extended by system or application
16474 * custom themes/overlays/extensions (see @ref Theme "themes" for more
16477 * @section Genlist_Manipulation Editing and Navigating
16479 * Items can be added by several calls. All of them return a @ref
16480 * Elm_Genlist_Item handle that is an internal member inside the genlist.
16481 * They all take a data parameter that is meant to be used for a handle to
16482 * the applications internal data (eg the struct with the original item
16483 * data). The parent parameter is the parent genlist item this belongs to if
16484 * it is a tree or an indexed group, and NULL if there is no parent. The
16485 * flags can be a bitmask of #ELM_GENLIST_ITEM_NONE,
16486 * #ELM_GENLIST_ITEM_SUBITEMS and #ELM_GENLIST_ITEM_GROUP. If
16487 * #ELM_GENLIST_ITEM_SUBITEMS is set then this item is displayed as an item
16488 * that is able to expand and have child items. If ELM_GENLIST_ITEM_GROUP
16489 * is set then this item is group index item that is displayed at the top
16490 * until the next group comes. The func parameter is a convenience callback
16491 * that is called when the item is selected and the data parameter will be
16492 * the func_data parameter, obj be the genlist object and event_info will be
16493 * the genlist item.
16495 * elm_genlist_item_append() adds an item to the end of the list, or if
16496 * there is a parent, to the end of all the child items of the parent.
16497 * elm_genlist_item_prepend() is the same but adds to the beginning of
16498 * the list or children list. elm_genlist_item_insert_before() inserts at
16499 * item before another item and elm_genlist_item_insert_after() inserts after
16500 * the indicated item.
16502 * The application can clear the list with elm_genlist_clear() which deletes
16503 * all the items in the list and elm_genlist_item_del() will delete a specific
16504 * item. elm_genlist_item_subitems_clear() will clear all items that are
16505 * children of the indicated parent item.
16507 * To help inspect list items you can jump to the item at the top of the list
16508 * with elm_genlist_first_item_get() which will return the item pointer, and
16509 * similarly elm_genlist_last_item_get() gets the item at the end of the list.
16510 * elm_genlist_item_next_get() and elm_genlist_item_prev_get() get the next
16511 * and previous items respectively relative to the indicated item. Using
16512 * these calls you can walk the entire item list/tree. Note that as a tree
16513 * the items are flattened in the list, so elm_genlist_item_parent_get() will
16514 * let you know which item is the parent (and thus know how to skip them if
16517 * @section Genlist_Muti_Selection Multi-selection
16519 * If the application wants multiple items to be able to be selected,
16520 * elm_genlist_multi_select_set() can enable this. If the list is
16521 * single-selection only (the default), then elm_genlist_selected_item_get()
16522 * will return the selected item, if any, or NULL I none is selected. If the
16523 * list is multi-select then elm_genlist_selected_items_get() will return a
16524 * list (that is only valid as long as no items are modified (added, deleted,
16525 * selected or unselected)).
16527 * @section Genlist_Usage_Hints Usage hints
16529 * There are also convenience functions. elm_genlist_item_genlist_get() will
16530 * return the genlist object the item belongs to. elm_genlist_item_show()
16531 * will make the scroller scroll to show that specific item so its visible.
16532 * elm_genlist_item_data_get() returns the data pointer set by the item
16533 * creation functions.
16535 * If an item changes (state of boolean changes, label or icons change),
16536 * then use elm_genlist_item_update() to have genlist update the item with
16537 * the new state. Genlist will re-realize the item thus call the functions
16538 * in the _Elm_Genlist_Item_Class for that item.
16540 * To programmatically (un)select an item use elm_genlist_item_selected_set().
16541 * To get its selected state use elm_genlist_item_selected_get(). Similarly
16542 * to expand/contract an item and get its expanded state, use
16543 * elm_genlist_item_expanded_set() and elm_genlist_item_expanded_get(). And
16544 * again to make an item disabled (unable to be selected and appear
16545 * differently) use elm_genlist_item_disabled_set() to set this and
16546 * elm_genlist_item_disabled_get() to get the disabled state.
16548 * In general to indicate how the genlist should expand items horizontally to
16549 * fill the list area, use elm_genlist_horizontal_set(). Valid modes are
16550 * ELM_LIST_LIMIT and ELM_LIST_SCROLL . The default is ELM_LIST_SCROLL. This
16551 * mode means that if items are too wide to fit, the scroller will scroll
16552 * horizontally. Otherwise items are expanded to fill the width of the
16553 * viewport of the scroller. If it is ELM_LIST_LIMIT, items will be expanded
16554 * to the viewport width and limited to that size. This can be combined with
16555 * a different style that uses edjes' ellipsis feature (cutting text off like
16558 * Items will only call their selection func and callback when first becoming
16559 * selected. Any further clicks will do nothing, unless you enable always
16560 * select with elm_genlist_always_select_mode_set(). This means even if
16561 * selected, every click will make the selected callbacks be called.
16562 * elm_genlist_no_select_mode_set() will turn off the ability to select
16563 * items entirely and they will neither appear selected nor call selected
16564 * callback functions.
16566 * Remember that you can create new styles and add your own theme augmentation
16567 * per application with elm_theme_extension_add(). If you absolutely must
16568 * have a specific style that overrides any theme the user or system sets up
16569 * you can use elm_theme_overlay_add() to add such a file.
16571 * @section Genlist_Implementation Implementation
16573 * Evas tracks every object you create. Every time it processes an event
16574 * (mouse move, down, up etc.) it needs to walk through objects and find out
16575 * what event that affects. Even worse every time it renders display updates,
16576 * in order to just calculate what to re-draw, it needs to walk through many
16577 * many many objects. Thus, the more objects you keep active, the more
16578 * overhead Evas has in just doing its work. It is advisable to keep your
16579 * active objects to the minimum working set you need. Also remember that
16580 * object creation and deletion carries an overhead, so there is a
16581 * middle-ground, which is not easily determined. But don't keep massive lists
16582 * of objects you can't see or use. Genlist does this with list objects. It
16583 * creates and destroys them dynamically as you scroll around. It groups them
16584 * into blocks so it can determine the visibility etc. of a whole block at
16585 * once as opposed to having to walk the whole list. This 2-level list allows
16586 * for very large numbers of items to be in the list (tests have used up to
16587 * 2,000,000 items). Also genlist employs a queue for adding items. As items
16588 * may be different sizes, every item added needs to be calculated as to its
16589 * size and thus this presents a lot of overhead on populating the list, this
16590 * genlist employs a queue. Any item added is queued and spooled off over
16591 * time, actually appearing some time later, so if your list has many members
16592 * you may find it takes a while for them to all appear, with your process
16593 * consuming a lot of CPU while it is busy spooling.
16595 * Genlist also implements a tree structure, but it does so with callbacks to
16596 * the application, with the application filling in tree structures when
16597 * requested (allowing for efficient building of a very deep tree that could
16598 * even be used for file-management). See the above smart signal callbacks for
16601 * @section Genlist_Smart_Events Genlist smart events
16603 * Signals that you can add callbacks for are:
16604 * - @c "activated" - The user has double-clicked or pressed
16605 * (enter|return|spacebar) on an item. The @c event_info parameter is the
16606 * item that was activated.
16607 * - @c "clicked,double" - The user has double-clicked an item. The @c
16608 * event_info parameter is the item that was double-clicked.
16609 * - @c "selected" - This is called when a user has made an item selected.
16610 * The event_info parameter is the genlist item that was selected.
16611 * - @c "unselected" - This is called when a user has made an item
16612 * unselected. The event_info parameter is the genlist item that was
16614 * - @c "expanded" - This is called when elm_genlist_item_expanded_set() is
16615 * called and the item is now meant to be expanded. The event_info
16616 * parameter is the genlist item that was indicated to expand. It is the
16617 * job of this callback to then fill in the child items.
16618 * - @c "contracted" - This is called when elm_genlist_item_expanded_set() is
16619 * called and the item is now meant to be contracted. The event_info
16620 * parameter is the genlist item that was indicated to contract. It is the
16621 * job of this callback to then delete the child items.
16622 * - @c "expand,request" - This is called when a user has indicated they want
16623 * to expand a tree branch item. The callback should decide if the item can
16624 * expand (has any children) and then call elm_genlist_item_expanded_set()
16625 * appropriately to set the state. The event_info parameter is the genlist
16626 * item that was indicated to expand.
16627 * - @c "contract,request" - This is called when a user has indicated they
16628 * want to contract a tree branch item. The callback should decide if the
16629 * item can contract (has any children) and then call
16630 * elm_genlist_item_expanded_set() appropriately to set the state. The
16631 * event_info parameter is the genlist item that was indicated to contract.
16632 * - @c "realized" - This is called when the item in the list is created as a
16633 * real evas object. event_info parameter is the genlist item that was
16634 * created. The object may be deleted at any time, so it is up to the
16635 * caller to not use the object pointer from elm_genlist_item_object_get()
16636 * in a way where it may point to freed objects.
16637 * - @c "unrealized" - This is called just before an item is unrealized.
16638 * After this call icon objects provided will be deleted and the item
16639 * object itself delete or be put into a floating cache.
16640 * - @c "drag,start,up" - This is called when the item in the list has been
16641 * dragged (not scrolled) up.
16642 * - @c "drag,start,down" - This is called when the item in the list has been
16643 * dragged (not scrolled) down.
16644 * - @c "drag,start,left" - This is called when the item in the list has been
16645 * dragged (not scrolled) left.
16646 * - @c "drag,start,right" - This is called when the item in the list has
16647 * been dragged (not scrolled) right.
16648 * - @c "drag,stop" - This is called when the item in the list has stopped
16650 * - @c "drag" - This is called when the item in the list is being dragged.
16651 * - @c "longpressed" - This is called when the item is pressed for a certain
16652 * amount of time. By default it's 1 second.
16653 * - @c "scroll,anim,start" - This is called when scrolling animation has
16655 * - @c "scroll,anim,stop" - This is called when scrolling animation has
16657 * - @c "scroll,drag,start" - This is called when dragging the content has
16659 * - @c "scroll,drag,stop" - This is called when dragging the content has
16661 * - @c "scroll,edge,top" - This is called when the genlist is scrolled until
16663 * - @c "scroll,edge,bottom" - This is called when the genlist is scrolled
16664 * until the bottom edge.
16665 * - @c "scroll,edge,left" - This is called when the genlist is scrolled
16666 * until the left edge.
16667 * - @c "scroll,edge,right" - This is called when the genlist is scrolled
16668 * until the right edge.
16669 * - @c "multi,swipe,left" - This is called when the genlist is multi-touch
16671 * - @c "multi,swipe,right" - This is called when the genlist is multi-touch
16673 * - @c "multi,swipe,up" - This is called when the genlist is multi-touch
16675 * - @c "multi,swipe,down" - This is called when the genlist is multi-touch
16677 * - @c "multi,pinch,out" - This is called when the genlist is multi-touch
16678 * pinched out. "- @c multi,pinch,in" - This is called when the genlist is
16679 * multi-touch pinched in.
16680 * - @c "swipe" - This is called when the genlist is swiped.
16682 * @section Genlist_Examples Examples
16684 * Here is a list of examples that use the genlist, trying to show some of
16685 * its capabilities:
16686 * - @ref genlist_example_01
16687 * - @ref genlist_example_02
16688 * - @ref genlist_example_03
16689 * - @ref genlist_example_04
16690 * - @ref genlist_example_05
16694 * @addtogroup Genlist
16699 * @enum _Elm_Genlist_Item_Flags
16700 * @typedef Elm_Genlist_Item_Flags
16702 * Defines if the item is of any special type (has subitems or it's the
16703 * index of a group), or is just a simple item.
16707 typedef enum _Elm_Genlist_Item_Flags
16709 ELM_GENLIST_ITEM_NONE = 0, /**< simple item */
16710 ELM_GENLIST_ITEM_SUBITEMS = (1 << 0), /**< may expand and have child items */
16711 ELM_GENLIST_ITEM_GROUP = (1 << 1) /**< index of a group of items */
16712 } Elm_Genlist_Item_Flags;
16713 typedef struct _Elm_Genlist_Item_Class Elm_Genlist_Item_Class; /**< Genlist item class definition structs */
16714 typedef struct _Elm_Genlist_Item Elm_Genlist_Item; /**< Item of Elm_Genlist. Sub-type of Elm_Widget_Item */
16715 typedef struct _Elm_Genlist_Item_Class_Func Elm_Genlist_Item_Class_Func; /**< Class functions for genlist item class */
16716 typedef char *(*Elm_Genlist_Item_Label_Get_Cb) (void *data, Evas_Object *obj, const char *part); /**< Label fetching class function for genlist item classes. */
16717 typedef Evas_Object *(*Elm_Genlist_Item_Icon_Get_Cb) (void *data, Evas_Object *obj, const char *part); /**< Icon fetching class function for genlist item classes. */
16718 typedef Eina_Bool (*Elm_Genlist_Item_State_Get_Cb) (void *data, Evas_Object *obj, const char *part); /**< State fetching class function for genlist item classes. */
16719 typedef void (*Elm_Genlist_Item_Del_Cb) (void *data, Evas_Object *obj); /**< Deletion class function for genlist item classes. */
16720 typedef void (*GenlistItemMovedFunc) (Evas_Object *obj, Elm_Genlist_Item *item, Elm_Genlist_Item *rel_item, Eina_Bool move_after); /** TODO: remove this by SeoZ **/
16722 typedef char *(*GenlistItemLabelGetFunc) (void *data, Evas_Object *obj, const char *part) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Genlist_Item_Label_Get_Cb instead. */
16723 typedef Evas_Object *(*GenlistItemIconGetFunc) (void *data, Evas_Object *obj, const char *part) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Genlist_Item_Icon_Get_Cb instead. */
16724 typedef Eina_Bool (*GenlistItemStateGetFunc) (void *data, Evas_Object *obj, const char *part) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Genlist_Item_State_Get_Cb instead. */
16725 typedef void (*GenlistItemDelFunc) (void *data, Evas_Object *obj) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Genlist_Item_Del_Cb instead. */
16728 * @struct _Elm_Genlist_Item_Class
16730 * Genlist item class definition structs.
16732 * This struct contains the style and fetching functions that will define the
16733 * contents of each item.
16735 * @see @ref Genlist_Item_Class
16737 struct _Elm_Genlist_Item_Class
16739 const char *item_style; /**< style of this class. */
16742 Elm_Genlist_Item_Label_Get_Cb label_get; /**< Label fetching class function for genlist item classes.*/
16743 Elm_Genlist_Item_Icon_Get_Cb icon_get; /**< Icon fetching class function for genlist item classes. */
16744 Elm_Genlist_Item_State_Get_Cb state_get; /**< State fetching class function for genlist item classes. */
16745 Elm_Genlist_Item_Del_Cb del; /**< Deletion class function for genlist item classes. */
16746 GenlistItemMovedFunc moved; // TODO: do not use this. change this to smart callback.
16748 const char *mode_item_style;
16752 * Add a new genlist widget to the given parent Elementary
16753 * (container) object
16755 * @param parent The parent object
16756 * @return a new genlist widget handle or @c NULL, on errors
16758 * This function inserts a new genlist widget on the canvas.
16760 * @see elm_genlist_item_append()
16761 * @see elm_genlist_item_del()
16762 * @see elm_genlist_clear()
16766 EAPI Evas_Object *elm_genlist_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
16768 * Remove all items from a given genlist widget.
16770 * @param obj The genlist object
16772 * This removes (and deletes) all items in @p obj, leaving it empty.
16774 * @see elm_genlist_item_del(), to remove just one item.
16778 EAPI void elm_genlist_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
16780 * Enable or disable multi-selection in the genlist
16782 * @param obj The genlist object
16783 * @param multi Multi-select enable/disable. Default is disabled.
16785 * This enables (@c EINA_TRUE) or disables (@c EINA_FALSE) multi-selection in
16786 * the list. This allows more than 1 item to be selected. To retrieve the list
16787 * of selected items, use elm_genlist_selected_items_get().
16789 * @see elm_genlist_selected_items_get()
16790 * @see elm_genlist_multi_select_get()
16794 EAPI void elm_genlist_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
16796 * Gets if multi-selection in genlist is enabled or disabled.
16798 * @param obj The genlist object
16799 * @return Multi-select enabled/disabled
16800 * (@c EINA_TRUE = enabled/@c EINA_FALSE = disabled). Default is @c EINA_FALSE.
16802 * @see elm_genlist_multi_select_set()
16806 EAPI Eina_Bool elm_genlist_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16808 * This sets the horizontal stretching mode.
16810 * @param obj The genlist object
16811 * @param mode The mode to use (one of #ELM_LIST_SCROLL or #ELM_LIST_LIMIT).
16813 * This sets the mode used for sizing items horizontally. Valid modes
16814 * are #ELM_LIST_LIMIT and #ELM_LIST_SCROLL. The default is
16815 * ELM_LIST_SCROLL. This mode means that if items are too wide to fit,
16816 * the scroller will scroll horizontally. Otherwise items are expanded
16817 * to fill the width of the viewport of the scroller. If it is
16818 * ELM_LIST_LIMIT, items will be expanded to the viewport width and
16819 * limited to that size.
16821 * @see elm_genlist_horizontal_get()
16825 EAPI void elm_genlist_horizontal_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
16826 EINA_DEPRECATED EAPI void elm_genlist_horizontal_mode_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
16828 * Gets the horizontal stretching mode.
16830 * @param obj The genlist object
16831 * @return The mode to use
16832 * (#ELM_LIST_LIMIT, #ELM_LIST_SCROLL)
16834 * @see elm_genlist_horizontal_set()
16838 EAPI Elm_List_Mode elm_genlist_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16839 EINA_DEPRECATED EAPI Elm_List_Mode elm_genlist_horizontal_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16841 * Set the always select mode.
16843 * @param obj The genlist object
16844 * @param always_select The always select mode (@c EINA_TRUE = on, @c
16845 * EINA_FALSE = off). Default is @c EINA_FALSE.
16847 * Items will only call their selection func and callback when first
16848 * becoming selected. Any further clicks will do nothing, unless you
16849 * enable always select with elm_genlist_always_select_mode_set().
16850 * This means that, even if selected, every click will make the selected
16851 * callbacks be called.
16853 * @see elm_genlist_always_select_mode_get()
16857 EAPI void elm_genlist_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
16859 * Get the always select mode.
16861 * @param obj The genlist object
16862 * @return The always select mode
16863 * (@c EINA_TRUE = on, @c EINA_FALSE = off)
16865 * @see elm_genlist_always_select_mode_set()
16869 EAPI Eina_Bool elm_genlist_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16871 * Enable/disable the no select mode.
16873 * @param obj The genlist object
16874 * @param no_select The no select mode
16875 * (EINA_TRUE = on, EINA_FALSE = off)
16877 * This will turn off the ability to select items entirely and they
16878 * will neither appear selected nor call selected callback functions.
16880 * @see elm_genlist_no_select_mode_get()
16884 EAPI void elm_genlist_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
16886 * Gets whether the no select mode is enabled.
16888 * @param obj The genlist object
16889 * @return The no select mode
16890 * (@c EINA_TRUE = on, @c EINA_FALSE = off)
16892 * @see elm_genlist_no_select_mode_set()
16896 EAPI Eina_Bool elm_genlist_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16898 * Enable/disable compress mode.
16900 * @param obj The genlist object
16901 * @param compress The compress mode
16902 * (@c EINA_TRUE = on, @c EINA_FALSE = off). Default is @c EINA_FALSE.
16904 * This will enable the compress mode where items are "compressed"
16905 * horizontally to fit the genlist scrollable viewport width. This is
16906 * special for genlist. Do not rely on
16907 * elm_genlist_horizontal_set() being set to @c ELM_LIST_COMPRESS to
16908 * work as genlist needs to handle it specially.
16910 * @see elm_genlist_compress_mode_get()
16914 EAPI void elm_genlist_compress_mode_set(Evas_Object *obj, Eina_Bool compress) EINA_ARG_NONNULL(1);
16916 * Get whether the compress mode is enabled.
16918 * @param obj The genlist object
16919 * @return The compress mode
16920 * (@c EINA_TRUE = on, @c EINA_FALSE = off)
16922 * @see elm_genlist_compress_mode_set()
16926 EAPI Eina_Bool elm_genlist_compress_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16928 * Enable/disable height-for-width mode.
16930 * @param obj The genlist object
16931 * @param setting The height-for-width mode (@c EINA_TRUE = on,
16932 * @c EINA_FALSE = off). Default is @c EINA_FALSE.
16934 * With height-for-width mode the item width will be fixed (restricted
16935 * to a minimum of) to the list width when calculating its size in
16936 * order to allow the height to be calculated based on it. This allows,
16937 * for instance, text block to wrap lines if the Edje part is
16938 * configured with "text.min: 0 1".
16940 * @note This mode will make list resize slower as it will have to
16941 * recalculate every item height again whenever the list width
16944 * @note When height-for-width mode is enabled, it also enables
16945 * compress mode (see elm_genlist_compress_mode_set()) and
16946 * disables homogeneous (see elm_genlist_homogeneous_set()).
16950 EAPI void elm_genlist_height_for_width_mode_set(Evas_Object *obj, Eina_Bool height_for_width) EINA_ARG_NONNULL(1);
16952 * Get whether the height-for-width mode is enabled.
16954 * @param obj The genlist object
16955 * @return The height-for-width mode (@c EINA_TRUE = on, @c EINA_FALSE =
16960 EAPI Eina_Bool elm_genlist_height_for_width_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16962 * Enable/disable horizontal and vertical bouncing effect.
16964 * @param obj The genlist object
16965 * @param h_bounce Allow bounce horizontally (@c EINA_TRUE = on, @c
16966 * EINA_FALSE = off). Default is @c EINA_FALSE.
16967 * @param v_bounce Allow bounce vertically (@c EINA_TRUE = on, @c
16968 * EINA_FALSE = off). Default is @c EINA_TRUE.
16970 * This will enable or disable the scroller bouncing effect for the
16971 * genlist. See elm_scroller_bounce_set() for details.
16973 * @see elm_scroller_bounce_set()
16974 * @see elm_genlist_bounce_get()
16978 EAPI void elm_genlist_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
16980 * Get whether the horizontal and vertical bouncing effect is enabled.
16982 * @param obj The genlist object
16983 * @param h_bounce Pointer to a bool to receive if the bounce horizontally
16985 * @param v_bounce Pointer to a bool to receive if the bounce vertically
16988 * @see elm_genlist_bounce_set()
16992 EAPI void elm_genlist_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
16994 * Enable/disable homogenous mode.
16996 * @param obj The genlist object
16997 * @param homogeneous Assume the items within the genlist are of the
16998 * same height and width (EINA_TRUE = on, EINA_FALSE = off). Default is @c
17001 * This will enable the homogeneous mode where items are of the same
17002 * height and width so that genlist may do the lazy-loading at its
17003 * maximum (which increases the performance for scrolling the list). This
17004 * implies 'compressed' mode.
17006 * @see elm_genlist_compress_mode_set()
17007 * @see elm_genlist_homogeneous_get()
17011 EAPI void elm_genlist_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
17013 * Get whether the homogenous mode is enabled.
17015 * @param obj The genlist object
17016 * @return Assume the items within the genlist are of the same height
17017 * and width (EINA_TRUE = on, EINA_FALSE = off)
17019 * @see elm_genlist_homogeneous_set()
17023 EAPI Eina_Bool elm_genlist_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17025 * Set the maximum number of items within an item block
17027 * @param obj The genlist object
17028 * @param n Maximum number of items within an item block. Default is 32.
17030 * This will configure the block count to tune to the target with
17031 * particular performance matrix.
17033 * A block of objects will be used to reduce the number of operations due to
17034 * many objects in the screen. It can determine the visibility, or if the
17035 * object has changed, it theme needs to be updated, etc. doing this kind of
17036 * calculation to the entire block, instead of per object.
17038 * The default value for the block count is enough for most lists, so unless
17039 * you know you will have a lot of objects visible in the screen at the same
17040 * time, don't try to change this.
17042 * @see elm_genlist_block_count_get()
17043 * @see @ref Genlist_Implementation
17047 EAPI void elm_genlist_block_count_set(Evas_Object *obj, int n) EINA_ARG_NONNULL(1);
17049 * Get the maximum number of items within an item block
17051 * @param obj The genlist object
17052 * @return Maximum number of items within an item block
17054 * @see elm_genlist_block_count_set()
17058 EAPI int elm_genlist_block_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17060 * Set the timeout in seconds for the longpress event.
17062 * @param obj The genlist object
17063 * @param timeout timeout in seconds. Default is 1.
17065 * This option will change how long it takes to send an event "longpressed"
17066 * after the mouse down signal is sent to the list. If this event occurs, no
17067 * "clicked" event will be sent.
17069 * @see elm_genlist_longpress_timeout_set()
17073 EAPI void elm_genlist_longpress_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
17075 * Get the timeout in seconds for the longpress event.
17077 * @param obj The genlist object
17078 * @return timeout in seconds
17080 * @see elm_genlist_longpress_timeout_get()
17084 EAPI double elm_genlist_longpress_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17086 * Append a new item in a given genlist widget.
17088 * @param obj The genlist object
17089 * @param itc The item class for the item
17090 * @param data The item data
17091 * @param parent The parent item, or NULL if none
17092 * @param flags Item flags
17093 * @param func Convenience function called when the item is selected
17094 * @param func_data Data passed to @p func above.
17095 * @return A handle to the item added or @c NULL if not possible
17097 * This adds the given item to the end of the list or the end of
17098 * the children list if the @p parent is given.
17100 * @see elm_genlist_item_prepend()
17101 * @see elm_genlist_item_insert_before()
17102 * @see elm_genlist_item_insert_after()
17103 * @see elm_genlist_item_del()
17107 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);
17109 * Prepend a new item in a given genlist widget.
17111 * @param obj The genlist object
17112 * @param itc The item class for the item
17113 * @param data The item data
17114 * @param parent The parent item, or NULL if none
17115 * @param flags Item flags
17116 * @param func Convenience function called when the item is selected
17117 * @param func_data Data passed to @p func above.
17118 * @return A handle to the item added or NULL if not possible
17120 * This adds an item to the beginning of the list or beginning of the
17121 * children of the parent if given.
17123 * @see elm_genlist_item_append()
17124 * @see elm_genlist_item_insert_before()
17125 * @see elm_genlist_item_insert_after()
17126 * @see elm_genlist_item_del()
17130 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);
17132 * Insert an item before another in a genlist widget
17134 * @param obj The genlist object
17135 * @param itc The item class for the item
17136 * @param data The item data
17137 * @param before The item to place this new one before.
17138 * @param flags Item flags
17139 * @param func Convenience function called when the item is selected
17140 * @param func_data Data passed to @p func above.
17141 * @return A handle to the item added or @c NULL if not possible
17143 * This inserts an item before another in the list. It will be in the
17144 * same tree level or group as the item it is inserted before.
17146 * @see elm_genlist_item_append()
17147 * @see elm_genlist_item_prepend()
17148 * @see elm_genlist_item_insert_after()
17149 * @see elm_genlist_item_del()
17153 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);
17155 * Insert an item after another in a genlist widget
17157 * @param obj The genlist object
17158 * @param itc The item class for the item
17159 * @param data The item data
17160 * @param after The item to place this new one after.
17161 * @param flags Item flags
17162 * @param func Convenience function called when the item is selected
17163 * @param func_data Data passed to @p func above.
17164 * @return A handle to the item added or @c NULL if not possible
17166 * This inserts an item after another in the list. It will be in the
17167 * same tree level or group as the item it is inserted after.
17169 * @see elm_genlist_item_append()
17170 * @see elm_genlist_item_prepend()
17171 * @see elm_genlist_item_insert_before()
17172 * @see elm_genlist_item_del()
17176 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);
17178 * Insert a new item into the sorted genlist object
17180 * @param obj The genlist object
17181 * @param itc The item class for the item
17182 * @param data The item data
17183 * @param parent The parent item, or NULL if none
17184 * @param flags Item flags
17185 * @param comp The function called for the sort
17186 * @param func Convenience function called when item selected
17187 * @param func_data Data passed to @p func above.
17188 * @return A handle to the item added or NULL if not possible
17192 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);
17193 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);
17194 /* operations to retrieve existing items */
17196 * Get the selectd item in the genlist.
17198 * @param obj The genlist object
17199 * @return The selected item, or NULL if none is selected.
17201 * This gets the selected item in the list (if multi-selection is enabled, only
17202 * the item that was first selected in the list is returned - which is not very
17203 * useful, so see elm_genlist_selected_items_get() for when multi-selection is
17206 * If no item is selected, NULL is returned.
17208 * @see elm_genlist_selected_items_get()
17212 EAPI Elm_Genlist_Item *elm_genlist_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17214 * Get a list of selected items in the genlist.
17216 * @param obj The genlist object
17217 * @return The list of selected items, or NULL if none are selected.
17219 * It returns a list of the selected items. This list pointer is only valid so
17220 * long as the selection doesn't change (no items are selected or unselected, or
17221 * unselected implicitly by deletion). The list contains Elm_Genlist_Item
17222 * pointers. The order of the items in this list is the order which they were
17223 * selected, i.e. the first item in this list is the first item that was
17224 * selected, and so on.
17226 * @note If not in multi-select mode, consider using function
17227 * elm_genlist_selected_item_get() instead.
17229 * @see elm_genlist_multi_select_set()
17230 * @see elm_genlist_selected_item_get()
17234 EAPI const Eina_List *elm_genlist_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17236 * Get a list of realized items in genlist
17238 * @param obj The genlist object
17239 * @return The list of realized items, nor NULL if none are realized.
17241 * This returns a list of the realized items in the genlist. The list
17242 * contains Elm_Genlist_Item pointers. The list must be freed by the
17243 * caller when done with eina_list_free(). The item pointers in the
17244 * list are only valid so long as those items are not deleted or the
17245 * genlist is not deleted.
17247 * @see elm_genlist_realized_items_update()
17251 EAPI Eina_List *elm_genlist_realized_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17253 * Get the item that is at the x, y canvas coords.
17255 * @param obj The gelinst object.
17256 * @param x The input x coordinate
17257 * @param y The input y coordinate
17258 * @param posret The position relative to the item returned here
17259 * @return The item at the coordinates or NULL if none
17261 * This returns the item at the given coordinates (which are canvas
17262 * relative, not object-relative). If an item is at that coordinate,
17263 * that item handle is returned, and if @p posret is not NULL, the
17264 * integer pointed to is set to a value of -1, 0 or 1, depending if
17265 * the coordinate is on the upper portion of that item (-1), on the
17266 * middle section (0) or on the lower part (1). If NULL is returned as
17267 * an item (no item found there), then posret may indicate -1 or 1
17268 * based if the coordinate is above or below all items respectively in
17273 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);
17275 * Get the first item in the genlist
17277 * This returns the first item in the list.
17279 * @param obj The genlist object
17280 * @return The first item, or NULL if none
17284 EAPI Elm_Genlist_Item *elm_genlist_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17286 * Get the last item in the genlist
17288 * This returns the last item in the list.
17290 * @return The last item, or NULL if none
17294 EAPI Elm_Genlist_Item *elm_genlist_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17296 * Set the scrollbar policy
17298 * @param obj The genlist object
17299 * @param policy_h Horizontal scrollbar policy.
17300 * @param policy_v Vertical scrollbar policy.
17302 * This sets the scrollbar visibility policy for the given genlist
17303 * scroller. #ELM_SMART_SCROLLER_POLICY_AUTO means the scrollbar is
17304 * made visible if it is needed, and otherwise kept hidden.
17305 * #ELM_SMART_SCROLLER_POLICY_ON turns it on all the time, and
17306 * #ELM_SMART_SCROLLER_POLICY_OFF always keeps it off. This applies
17307 * respectively for the horizontal and vertical scrollbars. Default is
17308 * #ELM_SMART_SCROLLER_POLICY_AUTO
17310 * @see elm_genlist_scroller_policy_get()
17314 EAPI void elm_genlist_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
17316 * Get the scrollbar policy
17318 * @param obj The genlist object
17319 * @param policy_h Pointer to store the horizontal scrollbar policy.
17320 * @param policy_v Pointer to store the vertical scrollbar policy.
17322 * @see elm_genlist_scroller_policy_set()
17326 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);
17328 * Get the @b next item in a genlist widget's internal list of items,
17329 * given a handle to one of those items.
17331 * @param item The genlist item to fetch next from
17332 * @return The item after @p item, or @c NULL if there's none (and
17335 * This returns the item placed after the @p item, on the container
17338 * @see elm_genlist_item_prev_get()
17342 EAPI Elm_Genlist_Item *elm_genlist_item_next_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17344 * Get the @b previous item in a genlist widget's internal list of items,
17345 * given a handle to one of those items.
17347 * @param item The genlist item to fetch previous from
17348 * @return The item before @p item, or @c NULL if there's none (and
17351 * This returns the item placed before the @p item, on the container
17354 * @see elm_genlist_item_next_get()
17358 EAPI Elm_Genlist_Item *elm_genlist_item_prev_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17360 * Get the genlist object's handle which contains a given genlist
17363 * @param item The item to fetch the container from
17364 * @return The genlist (parent) object
17366 * This returns the genlist object itself that an item belongs to.
17370 EAPI Evas_Object *elm_genlist_item_genlist_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17372 * Get the parent item of the given item
17374 * @param it The item
17375 * @return The parent of the item or @c NULL if it has no parent.
17377 * This returns the item that was specified as parent of the item @p it on
17378 * elm_genlist_item_append() and insertion related functions.
17382 EAPI Elm_Genlist_Item *elm_genlist_item_parent_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
17384 * Remove all sub-items (children) of the given item
17386 * @param it The item
17388 * This removes all items that are children (and their descendants) of the
17389 * given item @p it.
17391 * @see elm_genlist_clear()
17392 * @see elm_genlist_item_del()
17396 EAPI void elm_genlist_item_subitems_clear(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17398 * Set whether a given genlist item is selected or not
17400 * @param it The item
17401 * @param selected Use @c EINA_TRUE, to make it selected, @c
17402 * EINA_FALSE to make it unselected
17404 * This sets the selected state of an item. If multi selection is
17405 * not enabled on the containing genlist and @p selected is @c
17406 * EINA_TRUE, any other previously selected items will get
17407 * unselected in favor of this new one.
17409 * @see elm_genlist_item_selected_get()
17413 EAPI void elm_genlist_item_selected_set(Elm_Genlist_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
17415 * Get whether a given genlist item is selected or not
17417 * @param it The item
17418 * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
17420 * @see elm_genlist_item_selected_set() for more details
17424 EAPI Eina_Bool elm_genlist_item_selected_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17426 * Sets the expanded state of an item.
17428 * @param it The item
17429 * @param expanded The expanded state (@c EINA_TRUE expanded, @c EINA_FALSE not expanded).
17431 * This function flags the item of type #ELM_GENLIST_ITEM_SUBITEMS as
17434 * The theme will respond to this change visually, and a signal "expanded" or
17435 * "contracted" will be sent from the genlist with a pointer to the item that
17436 * has been expanded/contracted.
17438 * Calling this function won't show or hide any child of this item (if it is
17439 * a parent). You must manually delete and create them on the callbacks fo
17440 * the "expanded" or "contracted" signals.
17442 * @see elm_genlist_item_expanded_get()
17446 EAPI void elm_genlist_item_expanded_set(Elm_Genlist_Item *item, Eina_Bool expanded) EINA_ARG_NONNULL(1);
17448 * Get the expanded state of an item
17450 * @param it The item
17451 * @return The expanded state
17453 * This gets the expanded state of an item.
17455 * @see elm_genlist_item_expanded_set()
17459 EAPI Eina_Bool elm_genlist_item_expanded_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17461 * Get the depth of expanded item
17463 * @param it The genlist item object
17464 * @return The depth of expanded item
17468 EAPI int elm_genlist_item_expanded_depth_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
17470 * Set whether a given genlist item is disabled or not.
17472 * @param it The item
17473 * @param disabled Use @c EINA_TRUE, true disable it, @c EINA_FALSE
17474 * to enable it back.
17476 * A disabled item cannot be selected or unselected. It will also
17477 * change its appearance, to signal the user it's disabled.
17479 * @see elm_genlist_item_disabled_get()
17483 EAPI void elm_genlist_item_disabled_set(Elm_Genlist_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
17485 * Get whether a given genlist item is disabled or not.
17487 * @param it The item
17488 * @return @c EINA_TRUE, if it's disabled, @c EINA_FALSE otherwise
17491 * @see elm_genlist_item_disabled_set() for more details
17495 EAPI Eina_Bool elm_genlist_item_disabled_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17497 * Sets the display only state of an item.
17499 * @param it The item
17500 * @param display_only @c EINA_TRUE if the item is display only, @c
17501 * EINA_FALSE otherwise.
17503 * A display only item cannot be selected or unselected. It is for
17504 * display only and not selecting or otherwise clicking, dragging
17505 * etc. by the user, thus finger size rules will not be applied to
17508 * It's good to set group index items to display only state.
17510 * @see elm_genlist_item_display_only_get()
17514 EAPI void elm_genlist_item_display_only_set(Elm_Genlist_Item *it, Eina_Bool display_only) EINA_ARG_NONNULL(1);
17516 * Get the display only state of an item
17518 * @param it The item
17519 * @return @c EINA_TRUE if the item is display only, @c
17520 * EINA_FALSE otherwise.
17522 * @see elm_genlist_item_display_only_set()
17526 EAPI Eina_Bool elm_genlist_item_display_only_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
17528 * Show the portion of a genlist's internal list containing a given
17529 * item, immediately.
17531 * @param it The item to display
17533 * This causes genlist to jump to the given item @p it and show it (by
17534 * immediately scrolling to that position), if it is not fully visible.
17536 * @see elm_genlist_item_bring_in()
17537 * @see elm_genlist_item_top_show()
17538 * @see elm_genlist_item_middle_show()
17542 EAPI void elm_genlist_item_show(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17544 * Animatedly bring in, to the visible are of a genlist, a given
17547 * @param it The item to display
17549 * This causes genlist to jump to the given item @p it and show it (by
17550 * animatedly scrolling), if it is not fully visible. This may use animation
17551 * to do so and take a period of time
17553 * @see elm_genlist_item_show()
17554 * @see elm_genlist_item_top_bring_in()
17555 * @see elm_genlist_item_middle_bring_in()
17559 EAPI void elm_genlist_item_bring_in(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17561 * Show the portion of a genlist's internal list containing a given
17562 * item, immediately.
17564 * @param it The item to display
17566 * This causes genlist to jump to the given item @p it and show it (by
17567 * immediately scrolling to that position), if it is not fully visible.
17569 * The item will be positioned at the top of the genlist viewport.
17571 * @see elm_genlist_item_show()
17572 * @see elm_genlist_item_top_bring_in()
17576 EAPI void elm_genlist_item_top_show(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17578 * Animatedly bring in, to the visible are of a genlist, a given
17581 * @param it The item
17583 * This causes genlist to jump to the given item @p it and show it (by
17584 * animatedly scrolling), if it is not fully visible. This may use animation
17585 * to do so and take a period of time
17587 * The item will be positioned at the top of the genlist viewport.
17589 * @see elm_genlist_item_bring_in()
17590 * @see elm_genlist_item_top_show()
17594 EAPI void elm_genlist_item_top_bring_in(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17596 * Show the portion of a genlist's internal list containing a given
17597 * item, immediately.
17599 * @param it The item to display
17601 * This causes genlist to jump to the given item @p it and show it (by
17602 * immediately scrolling to that position), if it is not fully visible.
17604 * The item will be positioned at the middle of the genlist viewport.
17606 * @see elm_genlist_item_show()
17607 * @see elm_genlist_item_middle_bring_in()
17611 EAPI void elm_genlist_item_middle_show(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
17613 * Animatedly bring in, to the visible are of a genlist, a given
17616 * @param it The item
17618 * This causes genlist to jump to the given item @p it and show it (by
17619 * animatedly scrolling), if it is not fully visible. This may use animation
17620 * to do so and take a period of time
17622 * The item will be positioned at the middle of the genlist viewport.
17624 * @see elm_genlist_item_bring_in()
17625 * @see elm_genlist_item_middle_show()
17629 EAPI void elm_genlist_item_middle_bring_in(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
17631 * Remove a genlist item from the its parent, deleting it.
17633 * @param item The item to be removed.
17634 * @return @c EINA_TRUE on success or @c EINA_FALSE, otherwise.
17636 * @see elm_genlist_clear(), to remove all items in a genlist at
17641 EAPI void elm_genlist_item_del(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17643 * Return the data associated to a given genlist item
17645 * @param item The genlist item.
17646 * @return the data associated to this item.
17648 * This returns the @c data value passed on the
17649 * elm_genlist_item_append() and related item addition calls.
17651 * @see elm_genlist_item_append()
17652 * @see elm_genlist_item_data_set()
17656 EAPI void *elm_genlist_item_data_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17658 * Set the data associated to a given genlist item
17660 * @param item The genlist item
17661 * @param data The new data pointer to set on it
17663 * This @b overrides the @c data value passed on the
17664 * elm_genlist_item_append() and related item addition calls. This
17665 * function @b won't call elm_genlist_item_update() automatically,
17666 * so you'd issue it afterwards if you want to hove the item
17667 * updated to reflect the that new data.
17669 * @see elm_genlist_item_data_get()
17673 EAPI void elm_genlist_item_data_set(Elm_Genlist_Item *it, const void *data) EINA_ARG_NONNULL(1);
17675 * Tells genlist to "orphan" icons fetchs by the item class
17677 * @param it The item
17679 * This instructs genlist to release references to icons in the item,
17680 * meaning that they will no longer be managed by genlist and are
17681 * floating "orphans" that can be re-used elsewhere if the user wants
17686 EAPI void elm_genlist_item_icons_orphan(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
17688 * Get the real Evas object created to implement the view of a
17689 * given genlist item
17691 * @param item The genlist item.
17692 * @return the Evas object implementing this item's view.
17694 * This returns the actual Evas object used to implement the
17695 * specified genlist item's view. This may be @c NULL, as it may
17696 * not have been created or may have been deleted, at any time, by
17697 * the genlist. <b>Do not modify this object</b> (move, resize,
17698 * show, hide, etc.), as the genlist is controlling it. This
17699 * function is for querying, emitting custom signals or hooking
17700 * lower level callbacks for events on that object. Do not delete
17701 * this object under any circumstances.
17703 * @see elm_genlist_item_data_get()
17707 EAPI const Evas_Object *elm_genlist_item_object_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
17709 * Update the contents of an item
17711 * @param it The item
17713 * This updates an item by calling all the item class functions again
17714 * to get the icons, labels and states. Use this when the original
17715 * item data has changed and the changes are desired to be reflected.
17717 * Use elm_genlist_realized_items_update() to update all already realized
17720 * @see elm_genlist_realized_items_update()
17724 EAPI void elm_genlist_item_update(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17726 * Update the item class of an item
17728 * @param it The item
17729 * @param itc The item class for the item
17731 * This sets another class fo the item, changing the way that it is
17732 * displayed. After changing the item class, elm_genlist_item_update() is
17733 * called on the item @p it.
17737 EAPI void elm_genlist_item_item_class_update(Elm_Genlist_Item *it, const Elm_Genlist_Item_Class *itc) EINA_ARG_NONNULL(1, 2);
17738 EAPI const Elm_Genlist_Item_Class *elm_genlist_item_item_class_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
17740 * Set the text to be shown in a given genlist item's tooltips.
17742 * @param item The genlist item
17743 * @param text The text to set in the content
17745 * This call will setup the text to be used as tooltip to that item
17746 * (analogous to elm_object_tooltip_text_set(), but being item
17747 * tooltips with higher precedence than object tooltips). It can
17748 * have only one tooltip at a time, so any previous tooltip data
17749 * will get removed.
17751 * In order to set an icon or something else as a tooltip, look at
17752 * elm_genlist_item_tooltip_content_cb_set().
17756 EAPI void elm_genlist_item_tooltip_text_set(Elm_Genlist_Item *item, const char *text) EINA_ARG_NONNULL(1);
17758 * Set the content to be shown in a given genlist item's tooltips
17760 * @param item The genlist item.
17761 * @param func The function returning the tooltip contents.
17762 * @param data What to provide to @a func as callback data/context.
17763 * @param del_cb Called when data is not needed anymore, either when
17764 * another callback replaces @p func, the tooltip is unset with
17765 * elm_genlist_item_tooltip_unset() or the owner @p item
17766 * dies. This callback receives as its first parameter the
17767 * given @p data, being @c event_info the item handle.
17769 * This call will setup the tooltip's contents to @p item
17770 * (analogous to elm_object_tooltip_content_cb_set(), but being
17771 * item tooltips with higher precedence than object tooltips). It
17772 * can have only one tooltip at a time, so any previous tooltip
17773 * content will get removed. @p func (with @p data) will be called
17774 * every time Elementary needs to show the tooltip and it should
17775 * return a valid Evas object, which will be fully managed by the
17776 * tooltip system, getting deleted when the tooltip is gone.
17778 * In order to set just a text as a tooltip, look at
17779 * elm_genlist_item_tooltip_text_set().
17783 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);
17785 * Unset a tooltip from a given genlist item
17787 * @param item genlist item to remove a previously set tooltip from.
17789 * This call removes any tooltip set on @p item. The callback
17790 * provided as @c del_cb to
17791 * elm_genlist_item_tooltip_content_cb_set() will be called to
17792 * notify it is not used anymore (and have resources cleaned, if
17795 * @see elm_genlist_item_tooltip_content_cb_set()
17799 EAPI void elm_genlist_item_tooltip_unset(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17801 * Set a different @b style for a given genlist item's tooltip.
17803 * @param item genlist item with tooltip set
17804 * @param style the <b>theme style</b> to use on tooltips (e.g. @c
17805 * "default", @c "transparent", etc)
17807 * Tooltips can have <b>alternate styles</b> to be displayed on,
17808 * which are defined by the theme set on Elementary. This function
17809 * works analogously as elm_object_tooltip_style_set(), but here
17810 * applied only to genlist item objects. The default style for
17811 * tooltips is @c "default".
17813 * @note before you set a style you should define a tooltip with
17814 * elm_genlist_item_tooltip_content_cb_set() or
17815 * elm_genlist_item_tooltip_text_set()
17817 * @see elm_genlist_item_tooltip_style_get()
17821 EAPI void elm_genlist_item_tooltip_style_set(Elm_Genlist_Item *item, const char *style) EINA_ARG_NONNULL(1);
17823 * Get the style set a given genlist item's tooltip.
17825 * @param item genlist item with tooltip already set on.
17826 * @return style the theme style in use, which defaults to
17827 * "default". If the object does not have a tooltip set,
17828 * then @c NULL is returned.
17830 * @see elm_genlist_item_tooltip_style_set() for more details
17834 EAPI const char *elm_genlist_item_tooltip_style_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17836 * @brief Disable size restrictions on an object's tooltip
17837 * @param item The tooltip's anchor object
17838 * @param disable If EINA_TRUE, size restrictions are disabled
17839 * @return EINA_FALSE on failure, EINA_TRUE on success
17841 * This function allows a tooltip to expand beyond its parant window's canvas.
17842 * It will instead be limited only by the size of the display.
17844 EAPI Eina_Bool elm_genlist_item_tooltip_size_restrict_disable(Elm_Genlist_Item *item, Eina_Bool disable);
17846 * @brief Retrieve size restriction state of an object's tooltip
17847 * @param item The tooltip's anchor object
17848 * @return If EINA_TRUE, size restrictions are disabled
17850 * This function returns whether a tooltip is allowed to expand beyond
17851 * its parant window's canvas.
17852 * It will instead be limited only by the size of the display.
17854 EAPI Eina_Bool elm_genlist_item_tooltip_size_restrict_disabled_get(const Elm_Genlist_Item *item);
17856 * Set the type of mouse pointer/cursor decoration to be shown,
17857 * when the mouse pointer is over the given genlist widget item
17859 * @param item genlist item to customize cursor on
17860 * @param cursor the cursor type's name
17862 * This function works analogously as elm_object_cursor_set(), but
17863 * here the cursor's changing area is restricted to the item's
17864 * area, and not the whole widget's. Note that that item cursors
17865 * have precedence over widget cursors, so that a mouse over @p
17866 * item will always show cursor @p type.
17868 * If this function is called twice for an object, a previously set
17869 * cursor will be unset on the second call.
17871 * @see elm_object_cursor_set()
17872 * @see elm_genlist_item_cursor_get()
17873 * @see elm_genlist_item_cursor_unset()
17877 EAPI void elm_genlist_item_cursor_set(Elm_Genlist_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
17879 * Get the type of mouse pointer/cursor decoration set to be shown,
17880 * when the mouse pointer is over the given genlist widget item
17882 * @param item genlist item with custom cursor set
17883 * @return the cursor type's name or @c NULL, if no custom cursors
17884 * were set to @p item (and on errors)
17886 * @see elm_object_cursor_get()
17887 * @see elm_genlist_item_cursor_set() for more details
17888 * @see elm_genlist_item_cursor_unset()
17892 EAPI const char *elm_genlist_item_cursor_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17894 * Unset any custom mouse pointer/cursor decoration set to be
17895 * shown, when the mouse pointer is over the given genlist widget
17896 * item, thus making it show the @b default cursor again.
17898 * @param item a genlist item
17900 * Use this call to undo any custom settings on this item's cursor
17901 * decoration, bringing it back to defaults (no custom style set).
17903 * @see elm_object_cursor_unset()
17904 * @see elm_genlist_item_cursor_set() for more details
17908 EAPI void elm_genlist_item_cursor_unset(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17910 * Set a different @b style for a given custom cursor set for a
17913 * @param item genlist item with custom cursor set
17914 * @param style the <b>theme style</b> to use (e.g. @c "default",
17915 * @c "transparent", etc)
17917 * This function only makes sense when one is using custom mouse
17918 * cursor decorations <b>defined in a theme file</b> , which can
17919 * have, given a cursor name/type, <b>alternate styles</b> on
17920 * it. It works analogously as elm_object_cursor_style_set(), but
17921 * here applied only to genlist item objects.
17923 * @warning Before you set a cursor style you should have defined a
17924 * custom cursor previously on the item, with
17925 * elm_genlist_item_cursor_set()
17927 * @see elm_genlist_item_cursor_engine_only_set()
17928 * @see elm_genlist_item_cursor_style_get()
17932 EAPI void elm_genlist_item_cursor_style_set(Elm_Genlist_Item *item, const char *style) EINA_ARG_NONNULL(1);
17934 * Get the current @b style set for a given genlist item's custom
17937 * @param item genlist item with custom cursor set.
17938 * @return style the cursor style in use. If the object does not
17939 * have a cursor set, then @c NULL is returned.
17941 * @see elm_genlist_item_cursor_style_set() for more details
17945 EAPI const char *elm_genlist_item_cursor_style_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17947 * Set if the (custom) cursor for a given genlist item should be
17948 * searched in its theme, also, or should only rely on the
17949 * rendering engine.
17951 * @param item item with custom (custom) cursor already set on
17952 * @param engine_only Use @c EINA_TRUE to have cursors looked for
17953 * only on those provided by the rendering engine, @c EINA_FALSE to
17954 * have them searched on the widget's theme, as well.
17956 * @note This call is of use only if you've set a custom cursor
17957 * for genlist items, with elm_genlist_item_cursor_set().
17959 * @note By default, cursors will only be looked for between those
17960 * provided by the rendering engine.
17964 EAPI void elm_genlist_item_cursor_engine_only_set(Elm_Genlist_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
17966 * Get if the (custom) cursor for a given genlist item is being
17967 * searched in its theme, also, or is only relying on the rendering
17970 * @param item a genlist item
17971 * @return @c EINA_TRUE, if cursors are being looked for only on
17972 * those provided by the rendering engine, @c EINA_FALSE if they
17973 * are being searched on the widget's theme, as well.
17975 * @see elm_genlist_item_cursor_engine_only_set(), for more details
17979 EAPI Eina_Bool elm_genlist_item_cursor_engine_only_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17981 * Update the contents of all realized items.
17983 * @param obj The genlist object.
17985 * This updates all realized items by calling all the item class functions again
17986 * to get the icons, labels and states. Use this when the original
17987 * item data has changed and the changes are desired to be reflected.
17989 * To update just one item, use elm_genlist_item_update().
17991 * @see elm_genlist_realized_items_get()
17992 * @see elm_genlist_item_update()
17996 EAPI void elm_genlist_realized_items_update(Evas_Object *obj) EINA_ARG_NONNULL(1);
17998 * Activate a genlist mode on an item
18000 * @param item The genlist item
18001 * @param mode Mode name
18002 * @param mode_set Boolean to define set or unset mode.
18004 * A genlist mode is a different way of selecting an item. Once a mode is
18005 * activated on an item, any other selected item is immediately unselected.
18006 * This feature provides an easy way of implementing a new kind of animation
18007 * for selecting an item, without having to entirely rewrite the item style
18008 * theme. However, the elm_genlist_selected_* API can't be used to get what
18009 * item is activate for a mode.
18011 * The current item style will still be used, but applying a genlist mode to
18012 * an item will select it using a different kind of animation.
18014 * The current active item for a mode can be found by
18015 * elm_genlist_mode_item_get().
18017 * The characteristics of genlist mode are:
18018 * - Only one mode can be active at any time, and for only one item.
18019 * - Genlist handles deactivating other items when one item is activated.
18020 * - A mode is defined in the genlist theme (edc), and more modes can easily
18022 * - A mode style and the genlist item style are different things. They
18023 * can be combined to provide a default style to the item, with some kind
18024 * of animation for that item when the mode is activated.
18026 * When a mode is activated on an item, a new view for that item is created.
18027 * The theme of this mode defines the animation that will be used to transit
18028 * the item from the old view to the new view. This second (new) view will be
18029 * active for that item while the mode is active on the item, and will be
18030 * destroyed after the mode is totally deactivated from that item.
18032 * @see elm_genlist_mode_get()
18033 * @see elm_genlist_mode_item_get()
18037 EAPI void elm_genlist_item_mode_set(Elm_Genlist_Item *it, const char *mode_type, Eina_Bool mode_set) EINA_ARG_NONNULL(1, 2);
18039 * Get the last (or current) genlist mode used.
18041 * @param obj The genlist object
18043 * This function just returns the name of the last used genlist mode. It will
18044 * be the current mode if it's still active.
18046 * @see elm_genlist_item_mode_set()
18047 * @see elm_genlist_mode_item_get()
18051 EAPI const char *elm_genlist_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18053 * Get active genlist mode item
18055 * @param obj The genlist object
18056 * @return The active item for that current mode. Or @c NULL if no item is
18057 * activated with any mode.
18059 * This function returns the item that was activated with a mode, by the
18060 * function elm_genlist_item_mode_set().
18062 * @see elm_genlist_item_mode_set()
18063 * @see elm_genlist_mode_get()
18067 EAPI const Elm_Genlist_Item *elm_genlist_mode_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18072 * @param obj The genlist object
18073 * @param reorder_mode The reorder mode
18074 * (EINA_TRUE = on, EINA_FALSE = off)
18078 EAPI void elm_genlist_reorder_mode_set(Evas_Object *obj, Eina_Bool reorder_mode) EINA_ARG_NONNULL(1);
18081 * Get the reorder mode
18083 * @param obj The genlist object
18084 * @return The reorder mode
18085 * (EINA_TRUE = on, EINA_FALSE = off)
18089 EAPI Eina_Bool elm_genlist_reorder_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18096 * @defgroup Check Check
18098 * @image html img/widget/check/preview-00.png
18099 * @image latex img/widget/check/preview-00.eps
18100 * @image html img/widget/check/preview-01.png
18101 * @image latex img/widget/check/preview-01.eps
18102 * @image html img/widget/check/preview-02.png
18103 * @image latex img/widget/check/preview-02.eps
18105 * @brief The check widget allows for toggling a value between true and
18108 * Check objects are a lot like radio objects in layout and functionality
18109 * except they do not work as a group, but independently and only toggle the
18110 * value of a boolean from false to true (0 or 1). elm_check_state_set() sets
18111 * the boolean state (1 for true, 0 for false), and elm_check_state_get()
18112 * returns the current state. For convenience, like the radio objects, you
18113 * can set a pointer to a boolean directly with elm_check_state_pointer_set()
18114 * for it to modify.
18116 * Signals that you can add callbacks for are:
18117 * "changed" - This is called whenever the user changes the state of one of
18118 * the check object(event_info is NULL).
18120 * @ref tutorial_check should give you a firm grasp of how to use this widget.
18124 * @brief Add a new Check object
18126 * @param parent The parent object
18127 * @return The new object or NULL if it cannot be created
18129 EAPI Evas_Object *elm_check_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
18131 * @brief Set the text label of the check object
18133 * @param obj The check object
18134 * @param label The text label string in UTF-8
18136 * @deprecated use elm_object_text_set() instead.
18138 EINA_DEPRECATED EAPI void elm_check_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
18140 * @brief Get the text label of the check object
18142 * @param obj The check object
18143 * @return The text label string in UTF-8
18145 * @deprecated use elm_object_text_get() instead.
18147 EINA_DEPRECATED EAPI const char *elm_check_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18149 * @brief Set the icon object of the check object
18151 * @param obj The check object
18152 * @param icon The icon object
18154 * Once the icon object is set, a previously set one will be deleted.
18155 * If you want to keep that old content object, use the
18156 * elm_check_icon_unset() function.
18158 EAPI void elm_check_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
18160 * @brief Get the icon object of the check object
18162 * @param obj The check object
18163 * @return The icon object
18165 EAPI Evas_Object *elm_check_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18167 * @brief Unset the icon used for the check object
18169 * @param obj The check object
18170 * @return The icon object that was being used
18172 * Unparent and return the icon object which was set for this widget.
18174 EAPI Evas_Object *elm_check_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
18176 * @brief Set the on/off state of the check object
18178 * @param obj The check object
18179 * @param state The state to use (1 == on, 0 == off)
18181 * This sets the state of the check. If set
18182 * with elm_check_state_pointer_set() the state of that variable is also
18183 * changed. Calling this @b doesn't cause the "changed" signal to be emited.
18185 EAPI void elm_check_state_set(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
18187 * @brief Get the state of the check object
18189 * @param obj The check object
18190 * @return The boolean state
18192 EAPI Eina_Bool elm_check_state_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18194 * @brief Set a convenience pointer to a boolean to change
18196 * @param obj The check object
18197 * @param statep Pointer to the boolean to modify
18199 * This sets a pointer to a boolean, that, in addition to the check objects
18200 * state will also be modified directly. To stop setting the object pointed
18201 * to simply use NULL as the @p statep parameter. If @p statep is not NULL,
18202 * then when this is called, the check objects state will also be modified to
18203 * reflect the value of the boolean @p statep points to, just like calling
18204 * elm_check_state_set().
18206 EAPI void elm_check_state_pointer_set(Evas_Object *obj, Eina_Bool *statep) EINA_ARG_NONNULL(1);
18212 * @defgroup Radio Radio
18214 * @image html img/widget/radio/preview-00.png
18215 * @image latex img/widget/radio/preview-00.eps
18217 * @brief Radio is a widget that allows for 1 or more options to be displayed
18218 * and have the user choose only 1 of them.
18220 * A radio object contains an indicator, an optional Label and an optional
18221 * icon object. While it's possible to have a group of only one radio they,
18222 * are normally used in groups of 2 or more. To add a radio to a group use
18223 * elm_radio_group_add(). The radio object(s) will select from one of a set
18224 * of integer values, so any value they are configuring needs to be mapped to
18225 * a set of integers. To configure what value that radio object represents,
18226 * use elm_radio_state_value_set() to set the integer it represents. To set
18227 * the value the whole group(which one is currently selected) is to indicate
18228 * use elm_radio_value_set() on any group member, and to get the groups value
18229 * use elm_radio_value_get(). For convenience the radio objects are also able
18230 * to directly set an integer(int) to the value that is selected. To specify
18231 * the pointer to this integer to modify, use elm_radio_value_pointer_set().
18232 * The radio objects will modify this directly. That implies the pointer must
18233 * point to valid memory for as long as the radio objects exist.
18235 * Signals that you can add callbacks for are:
18236 * @li changed - This is called whenever the user changes the state of one of
18237 * the radio objects within the group of radio objects that work together.
18239 * @ref tutorial_radio show most of this API in action.
18243 * @brief Add a new radio to the parent
18245 * @param parent The parent object
18246 * @return The new object or NULL if it cannot be created
18248 EAPI Evas_Object *elm_radio_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
18250 * @brief Set the text label of the radio object
18252 * @param obj The radio object
18253 * @param label The text label string in UTF-8
18255 * @deprecated use elm_object_text_set() instead.
18257 EINA_DEPRECATED EAPI void elm_radio_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
18259 * @brief Get the text label of the radio object
18261 * @param obj The radio object
18262 * @return The text label string in UTF-8
18264 * @deprecated use elm_object_text_set() instead.
18266 EINA_DEPRECATED EAPI const char *elm_radio_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18268 * @brief Set the icon object of the radio object
18270 * @param obj The radio object
18271 * @param icon The icon object
18273 * Once the icon object is set, a previously set one will be deleted. If you
18274 * want to keep that old content object, use the elm_radio_icon_unset()
18277 EAPI void elm_radio_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
18279 * @brief Get the icon object of the radio object
18281 * @param obj The radio object
18282 * @return The icon object
18284 * @see elm_radio_icon_set()
18286 EAPI Evas_Object *elm_radio_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18288 * @brief Unset the icon used for the radio object
18290 * @param obj The radio object
18291 * @return The icon object that was being used
18293 * Unparent and return the icon object which was set for this widget.
18295 * @see elm_radio_icon_set()
18297 EAPI Evas_Object *elm_radio_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
18299 * @brief Add this radio to a group of other radio objects
18301 * @param obj The radio object
18302 * @param group Any object whose group the @p obj is to join.
18304 * Radio objects work in groups. Each member should have a different integer
18305 * value assigned. In order to have them work as a group, they need to know
18306 * about each other. This adds the given radio object to the group of which
18307 * the group object indicated is a member.
18309 EAPI void elm_radio_group_add(Evas_Object *obj, Evas_Object *group) EINA_ARG_NONNULL(1);
18311 * @brief Set the integer value that this radio object represents
18313 * @param obj The radio object
18314 * @param value The value to use if this radio object is selected
18316 * This sets the value of the radio.
18318 EAPI void elm_radio_state_value_set(Evas_Object *obj, int value) EINA_ARG_NONNULL(1);
18320 * @brief Get the integer value that this radio object represents
18322 * @param obj The radio object
18323 * @return The value used if this radio object is selected
18325 * This gets the value of the radio.
18327 * @see elm_radio_value_set()
18329 EAPI int elm_radio_state_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18331 * @brief Set the value of the radio.
18333 * @param obj The radio object
18334 * @param value The value to use for the group
18336 * This sets the value of the radio group and will also set the value if
18337 * pointed to, to the value supplied, but will not call any callbacks.
18339 EAPI void elm_radio_value_set(Evas_Object *obj, int value) EINA_ARG_NONNULL(1);
18341 * @brief Get the state of the radio object
18343 * @param obj The radio object
18344 * @return The integer state
18346 EAPI int elm_radio_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18348 * @brief Set a convenience pointer to a integer to change
18350 * @param obj The radio object
18351 * @param valuep Pointer to the integer to modify
18353 * This sets a pointer to a integer, that, in addition to the radio objects
18354 * state will also be modified directly. To stop setting the object pointed
18355 * to simply use NULL as the @p valuep argument. If valuep is not NULL, then
18356 * when this is called, the radio objects state will also be modified to
18357 * reflect the value of the integer valuep points to, just like calling
18358 * elm_radio_value_set().
18360 EAPI void elm_radio_value_pointer_set(Evas_Object *obj, int *valuep) EINA_ARG_NONNULL(1);
18366 * @defgroup Pager Pager
18368 * @image html img/widget/pager/preview-00.png
18369 * @image latex img/widget/pager/preview-00.eps
18371 * @brief Widget that allows flipping between 1 or more “pages” of objects.
18373 * The flipping between “pages” of objects is animated. All content in pager
18374 * is kept in a stack, the last content to be added will be on the top of the
18375 * stack(be visible).
18377 * Objects can be pushed or popped from the stack or deleted as normal.
18378 * Pushes and pops will animate (and a pop will delete the object once the
18379 * animation is finished). Any object already in the pager can be promoted to
18380 * the top(from its current stacking position) through the use of
18381 * elm_pager_content_promote(). Objects are pushed to the top with
18382 * elm_pager_content_push() and when the top item is no longer wanted, simply
18383 * pop it with elm_pager_content_pop() and it will also be deleted. If an
18384 * object is no longer needed and is not the top item, just delete it as
18385 * normal. You can query which objects are the top and bottom with
18386 * elm_pager_content_bottom_get() and elm_pager_content_top_get().
18388 * Signals that you can add callbacks for are:
18389 * "hide,finished" - when the previous page is hided
18391 * This widget has the following styles available:
18394 * @li fade_translucide
18395 * @li fade_invisible
18396 * @note This styles affect only the flipping animations, the appearance when
18397 * not animating is unaffected by styles.
18399 * @ref tutorial_pager gives a good overview of the usage of the API.
18403 * Add a new pager to the parent
18405 * @param parent The parent object
18406 * @return The new object or NULL if it cannot be created
18410 EAPI Evas_Object *elm_pager_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
18412 * @brief Push an object to the top of the pager stack (and show it).
18414 * @param obj The pager object
18415 * @param content The object to push
18417 * The object pushed becomes a child of the pager, it will be controlled and
18418 * deleted when the pager is deleted.
18420 * @note If the content is already in the stack use
18421 * elm_pager_content_promote().
18422 * @warning Using this function on @p content already in the stack results in
18423 * undefined behavior.
18425 EAPI void elm_pager_content_push(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
18427 * @brief Pop the object that is on top of the stack
18429 * @param obj The pager object
18431 * This pops the object that is on the top(visible) of the pager, makes it
18432 * disappear, then deletes the object. The object that was underneath it on
18433 * the stack will become visible.
18435 EAPI void elm_pager_content_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
18437 * @brief Moves an object already in the pager stack to the top of the stack.
18439 * @param obj The pager object
18440 * @param content The object to promote
18442 * This will take the @p content and move it to the top of the stack as
18443 * if it had been pushed there.
18445 * @note If the content isn't already in the stack use
18446 * elm_pager_content_push().
18447 * @warning Using this function on @p content not already in the stack
18448 * results in undefined behavior.
18450 EAPI void elm_pager_content_promote(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
18452 * @brief Return the object at the bottom of the pager stack
18454 * @param obj The pager object
18455 * @return The bottom object or NULL if none
18457 EAPI Evas_Object *elm_pager_content_bottom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18459 * @brief Return the object at the top of the pager stack
18461 * @param obj The pager object
18462 * @return The top object or NULL if none
18464 EAPI Evas_Object *elm_pager_content_top_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18470 * @defgroup Slideshow Slideshow
18472 * @image html img/widget/slideshow/preview-00.png
18473 * @image latex img/widget/slideshow/preview-00.eps
18475 * This widget, as the name indicates, is a pre-made image
18476 * slideshow panel, with API functions acting on (child) image
18477 * items presentation. Between those actions, are:
18478 * - advance to next/previous image
18479 * - select the style of image transition animation
18480 * - set the exhibition time for each image
18481 * - start/stop the slideshow
18483 * The transition animations are defined in the widget's theme,
18484 * consequently new animations can be added without having to
18485 * update the widget's code.
18487 * @section Slideshow_Items Slideshow items
18489 * For slideshow items, just like for @ref Genlist "genlist" ones,
18490 * the user defines a @b classes, specifying functions that will be
18491 * called on the item's creation and deletion times.
18493 * The #Elm_Slideshow_Item_Class structure contains the following
18496 * - @c func.get - When an item is displayed, this function is
18497 * called, and it's where one should create the item object, de
18498 * facto. For example, the object can be a pure Evas image object
18499 * or an Elementary @ref Photocam "photocam" widget. See
18500 * #SlideshowItemGetFunc.
18501 * - @c func.del - When an item is no more displayed, this function
18502 * is called, where the user must delete any data associated to
18503 * the item. See #SlideshowItemDelFunc.
18505 * @section Slideshow_Caching Slideshow caching
18507 * The slideshow provides facilities to have items adjacent to the
18508 * one being displayed <b>already "realized"</b> (i.e. loaded) for
18509 * you, so that the system does not have to decode image data
18510 * anymore at the time it has to actually switch images on its
18511 * viewport. The user is able to set the numbers of items to be
18512 * cached @b before and @b after the current item, in the widget's
18515 * Smart events one can add callbacks for are:
18517 * - @c "changed" - when the slideshow switches its view to a new
18520 * List of examples for the slideshow widget:
18521 * @li @ref slideshow_example
18525 * @addtogroup Slideshow
18529 typedef struct _Elm_Slideshow_Item_Class Elm_Slideshow_Item_Class; /**< Slideshow item class definition struct */
18530 typedef struct _Elm_Slideshow_Item_Class_Func Elm_Slideshow_Item_Class_Func; /**< Class functions for slideshow item classes. */
18531 typedef struct _Elm_Slideshow_Item Elm_Slideshow_Item; /**< Slideshow item handle */
18532 typedef Evas_Object *(*SlideshowItemGetFunc) (void *data, Evas_Object *obj); /**< Image fetching class function for slideshow item classes. */
18533 typedef void (*SlideshowItemDelFunc) (void *data, Evas_Object *obj); /**< Deletion class function for slideshow item classes. */
18536 * @struct _Elm_Slideshow_Item_Class
18538 * Slideshow item class definition. See @ref Slideshow_Items for
18541 struct _Elm_Slideshow_Item_Class
18543 struct _Elm_Slideshow_Item_Class_Func
18545 SlideshowItemGetFunc get;
18546 SlideshowItemDelFunc del;
18548 }; /**< #Elm_Slideshow_Item_Class member definitions */
18551 * Add a new slideshow widget to the given parent Elementary
18552 * (container) object
18554 * @param parent The parent object
18555 * @return A new slideshow widget handle or @c NULL, on errors
18557 * This function inserts a new slideshow widget on the canvas.
18559 * @ingroup Slideshow
18561 EAPI Evas_Object *elm_slideshow_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
18564 * Add (append) a new item in a given slideshow widget.
18566 * @param obj The slideshow object
18567 * @param itc The item class for the item
18568 * @param data The item's data
18569 * @return A handle to the item added or @c NULL, on errors
18571 * Add a new item to @p obj's internal list of items, appending it.
18572 * The item's class must contain the function really fetching the
18573 * image object to show for this item, which could be an Evas image
18574 * object or an Elementary photo, for example. The @p data
18575 * parameter is going to be passed to both class functions of the
18578 * @see #Elm_Slideshow_Item_Class
18579 * @see elm_slideshow_item_sorted_insert()
18581 * @ingroup Slideshow
18583 EAPI Elm_Slideshow_Item *elm_slideshow_item_add(Evas_Object *obj, const Elm_Slideshow_Item_Class *itc, const void *data) EINA_ARG_NONNULL(1);
18586 * Insert a new item into the given slideshow widget, using the @p func
18587 * function to sort items (by item handles).
18589 * @param obj The slideshow object
18590 * @param itc The item class for the item
18591 * @param data The item's data
18592 * @param func The comparing function to be used to sort slideshow
18593 * items <b>by #Elm_Slideshow_Item item handles</b>
18594 * @return Returns The slideshow item handle, on success, or
18595 * @c NULL, on errors
18597 * Add a new item to @p obj's internal list of items, in a position
18598 * determined by the @p func comparing function. The item's class
18599 * must contain the function really fetching the image object to
18600 * show for this item, which could be an Evas image object or an
18601 * Elementary photo, for example. The @p data parameter is going to
18602 * be passed to both class functions of the item.
18604 * @see #Elm_Slideshow_Item_Class
18605 * @see elm_slideshow_item_add()
18607 * @ingroup Slideshow
18609 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);
18612 * Display a given slideshow widget's item, programmatically.
18614 * @param obj The slideshow object
18615 * @param item The item to display on @p obj's viewport
18617 * The change between the current item and @p item will use the
18618 * transition @p obj is set to use (@see
18619 * elm_slideshow_transition_set()).
18621 * @ingroup Slideshow
18623 EAPI void elm_slideshow_show(Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
18626 * Slide to the @b next item, in a given slideshow widget
18628 * @param obj The slideshow object
18630 * The sliding animation @p obj is set to use will be the
18631 * transition effect used, after this call is issued.
18633 * @note If the end of the slideshow's internal list of items is
18634 * reached, it'll wrap around to the list's beginning, again.
18636 * @ingroup Slideshow
18638 EAPI void elm_slideshow_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
18641 * Slide to the @b previous item, in a given slideshow widget
18643 * @param obj The slideshow object
18645 * The sliding animation @p obj is set to use will be the
18646 * transition effect used, after this call is issued.
18648 * @note If the beginning of the slideshow's internal list of items
18649 * is reached, it'll wrap around to the list's end, again.
18651 * @ingroup Slideshow
18653 EAPI void elm_slideshow_previous(Evas_Object *obj) EINA_ARG_NONNULL(1);
18656 * Returns the list of sliding transition/effect names available, for a
18657 * given slideshow widget.
18659 * @param obj The slideshow object
18660 * @return The list of transitions (list of @b stringshared strings
18663 * The transitions, which come from @p obj's theme, must be an EDC
18664 * data item named @c "transitions" on the theme file, with (prefix)
18665 * names of EDC programs actually implementing them.
18667 * The available transitions for slideshows on the default theme are:
18668 * - @c "fade" - the current item fades out, while the new one
18669 * fades in to the slideshow's viewport.
18670 * - @c "black_fade" - the current item fades to black, and just
18671 * then, the new item will fade in.
18672 * - @c "horizontal" - the current item slides horizontally, until
18673 * it gets out of the slideshow's viewport, while the new item
18674 * comes from the left to take its place.
18675 * - @c "vertical" - the current item slides vertically, until it
18676 * gets out of the slideshow's viewport, while the new item comes
18677 * from the bottom to take its place.
18678 * - @c "square" - the new item starts to appear from the middle of
18679 * the current one, but with a tiny size, growing until its
18680 * target (full) size and covering the old one.
18682 * @warning The stringshared strings get no new references
18683 * exclusive to the user grabbing the list, here, so if you'd like
18684 * to use them out of this call's context, you'd better @c
18685 * eina_stringshare_ref() them.
18687 * @see elm_slideshow_transition_set()
18689 * @ingroup Slideshow
18691 EAPI const Eina_List *elm_slideshow_transitions_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18694 * Set the current slide transition/effect in use for a given
18697 * @param obj The slideshow object
18698 * @param transition The new transition's name string
18700 * If @p transition is implemented in @p obj's theme (i.e., is
18701 * contained in the list returned by
18702 * elm_slideshow_transitions_get()), this new sliding effect will
18703 * be used on the widget.
18705 * @see elm_slideshow_transitions_get() for more details
18707 * @ingroup Slideshow
18709 EAPI void elm_slideshow_transition_set(Evas_Object *obj, const char *transition) EINA_ARG_NONNULL(1);
18712 * Get the current slide transition/effect in use for a given
18715 * @param obj The slideshow object
18716 * @return The current transition's name
18718 * @see elm_slideshow_transition_set() for more details
18720 * @ingroup Slideshow
18722 EAPI const char *elm_slideshow_transition_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18725 * Set the interval between each image transition on a given
18726 * slideshow widget, <b>and start the slideshow, itself</b>
18728 * @param obj The slideshow object
18729 * @param timeout The new displaying timeout for images
18731 * After this call, the slideshow widget will start cycling its
18732 * view, sequentially and automatically, with the images of the
18733 * items it has. The time between each new image displayed is going
18734 * to be @p timeout, in @b seconds. If a different timeout was set
18735 * previously and an slideshow was in progress, it will continue
18736 * with the new time between transitions, after this call.
18738 * @note A value less than or equal to 0 on @p timeout will disable
18739 * the widget's internal timer, thus halting any slideshow which
18740 * could be happening on @p obj.
18742 * @see elm_slideshow_timeout_get()
18744 * @ingroup Slideshow
18746 EAPI void elm_slideshow_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
18749 * Get the interval set for image transitions on a given slideshow
18752 * @param obj The slideshow object
18753 * @return Returns the timeout set on it
18755 * @see elm_slideshow_timeout_set() for more details
18757 * @ingroup Slideshow
18759 EAPI double elm_slideshow_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18762 * Set if, after a slideshow is started, for a given slideshow
18763 * widget, its items should be displayed cyclically or not.
18765 * @param obj The slideshow object
18766 * @param loop Use @c EINA_TRUE to make it cycle through items or
18767 * @c EINA_FALSE for it to stop at the end of @p obj's internal
18770 * @note elm_slideshow_next() and elm_slideshow_previous() will @b
18771 * ignore what is set by this functions, i.e., they'll @b always
18772 * cycle through items. This affects only the "automatic"
18773 * slideshow, as set by elm_slideshow_timeout_set().
18775 * @see elm_slideshow_loop_get()
18777 * @ingroup Slideshow
18779 EAPI void elm_slideshow_loop_set(Evas_Object *obj, Eina_Bool loop) EINA_ARG_NONNULL(1);
18782 * Get if, after a slideshow is started, for a given slideshow
18783 * widget, its items are to be displayed cyclically or not.
18785 * @param obj The slideshow object
18786 * @return @c EINA_TRUE, if the items in @p obj will be cycled
18787 * through or @c EINA_FALSE, otherwise
18789 * @see elm_slideshow_loop_set() for more details
18791 * @ingroup Slideshow
18793 EAPI Eina_Bool elm_slideshow_loop_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18796 * Remove all items from a given slideshow widget
18798 * @param obj The slideshow object
18800 * This removes (and deletes) all items in @p obj, leaving it
18803 * @see elm_slideshow_item_del(), to remove just one item.
18805 * @ingroup Slideshow
18807 EAPI void elm_slideshow_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
18810 * Get the internal list of items in a given slideshow widget.
18812 * @param obj The slideshow object
18813 * @return The list of items (#Elm_Slideshow_Item as data) or
18814 * @c NULL on errors.
18816 * This list is @b not to be modified in any way and must not be
18817 * freed. Use the list members with functions like
18818 * elm_slideshow_item_del(), elm_slideshow_item_data_get().
18820 * @warning This list is only valid until @p obj object's internal
18821 * items list is changed. It should be fetched again with another
18822 * call to this function when changes happen.
18824 * @ingroup Slideshow
18826 EAPI const Eina_List *elm_slideshow_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18829 * Delete a given item from a slideshow widget.
18831 * @param item The slideshow item
18833 * @ingroup Slideshow
18835 EAPI void elm_slideshow_item_del(Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
18838 * Return the data associated with a given slideshow item
18840 * @param item The slideshow item
18841 * @return Returns the data associated to this item
18843 * @ingroup Slideshow
18845 EAPI void *elm_slideshow_item_data_get(const Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
18848 * Returns the currently displayed item, in a given slideshow widget
18850 * @param obj The slideshow object
18851 * @return A handle to the item being displayed in @p obj or
18852 * @c NULL, if none is (and on errors)
18854 * @ingroup Slideshow
18856 EAPI Elm_Slideshow_Item *elm_slideshow_item_current_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18859 * Get the real Evas object created to implement the view of a
18860 * given slideshow item
18862 * @param item The slideshow item.
18863 * @return the Evas object implementing this item's view.
18865 * This returns the actual Evas object used to implement the
18866 * specified slideshow item's view. This may be @c NULL, as it may
18867 * not have been created or may have been deleted, at any time, by
18868 * the slideshow. <b>Do not modify this object</b> (move, resize,
18869 * show, hide, etc.), as the slideshow is controlling it. This
18870 * function is for querying, emitting custom signals or hooking
18871 * lower level callbacks for events on that object. Do not delete
18872 * this object under any circumstances.
18874 * @see elm_slideshow_item_data_get()
18876 * @ingroup Slideshow
18878 EAPI Evas_Object* elm_slideshow_item_object_get(const Elm_Slideshow_Item* item) EINA_ARG_NONNULL(1);
18881 * Get the the item, in a given slideshow widget, placed at
18882 * position @p nth, in its internal items list
18884 * @param obj The slideshow object
18885 * @param nth The number of the item to grab a handle to (0 being
18887 * @return The item stored in @p obj at position @p nth or @c NULL,
18888 * if there's no item with that index (and on errors)
18890 * @ingroup Slideshow
18892 EAPI Elm_Slideshow_Item *elm_slideshow_item_nth_get(const Evas_Object *obj, unsigned int nth) EINA_ARG_NONNULL(1);
18895 * Set the current slide layout in use for a given slideshow widget
18897 * @param obj The slideshow object
18898 * @param layout The new layout's name string
18900 * If @p layout is implemented in @p obj's theme (i.e., is contained
18901 * in the list returned by elm_slideshow_layouts_get()), this new
18902 * images layout will be used on the widget.
18904 * @see elm_slideshow_layouts_get() for more details
18906 * @ingroup Slideshow
18908 EAPI void elm_slideshow_layout_set(Evas_Object *obj, const char *layout) EINA_ARG_NONNULL(1);
18911 * Get the current slide layout in use for a given slideshow widget
18913 * @param obj The slideshow object
18914 * @return The current layout's name
18916 * @see elm_slideshow_layout_set() for more details
18918 * @ingroup Slideshow
18920 EAPI const char *elm_slideshow_layout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18923 * Returns the list of @b layout names available, for a given
18924 * slideshow widget.
18926 * @param obj The slideshow object
18927 * @return The list of layouts (list of @b stringshared strings
18930 * Slideshow layouts will change how the widget is to dispose each
18931 * image item in its viewport, with regard to cropping, scaling,
18934 * The layouts, which come from @p obj's theme, must be an EDC
18935 * data item name @c "layouts" on the theme file, with (prefix)
18936 * names of EDC programs actually implementing them.
18938 * The available layouts for slideshows on the default theme are:
18939 * - @c "fullscreen" - item images with original aspect, scaled to
18940 * touch top and down slideshow borders or, if the image's heigh
18941 * is not enough, left and right slideshow borders.
18942 * - @c "not_fullscreen" - the same behavior as the @c "fullscreen"
18943 * one, but always leaving 10% of the slideshow's dimensions of
18944 * distance between the item image's borders and the slideshow
18945 * borders, for each axis.
18947 * @warning The stringshared strings get no new references
18948 * exclusive to the user grabbing the list, here, so if you'd like
18949 * to use them out of this call's context, you'd better @c
18950 * eina_stringshare_ref() them.
18952 * @see elm_slideshow_layout_set()
18954 * @ingroup Slideshow
18956 EAPI const Eina_List *elm_slideshow_layouts_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18959 * Set the number of items to cache, on a given slideshow widget,
18960 * <b>before the current item</b>
18962 * @param obj The slideshow object
18963 * @param count Number of items to cache before the current one
18965 * The default value for this property is @c 2. See
18966 * @ref Slideshow_Caching "slideshow caching" for more details.
18968 * @see elm_slideshow_cache_before_get()
18970 * @ingroup Slideshow
18972 EAPI void elm_slideshow_cache_before_set(Evas_Object *obj, int count) EINA_ARG_NONNULL(1);
18975 * Retrieve the number of items to cache, on a given slideshow widget,
18976 * <b>before the current item</b>
18978 * @param obj The slideshow object
18979 * @return The number of items set to be cached before the current one
18981 * @see elm_slideshow_cache_before_set() for more details
18983 * @ingroup Slideshow
18985 EAPI int elm_slideshow_cache_before_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18988 * Set the number of items to cache, on a given slideshow widget,
18989 * <b>after the current item</b>
18991 * @param obj The slideshow object
18992 * @param count Number of items to cache after the current one
18994 * The default value for this property is @c 2. See
18995 * @ref Slideshow_Caching "slideshow caching" for more details.
18997 * @see elm_slideshow_cache_after_get()
18999 * @ingroup Slideshow
19001 EAPI void elm_slideshow_cache_after_set(Evas_Object *obj, int count) EINA_ARG_NONNULL(1);
19004 * Retrieve the number of items to cache, on a given slideshow widget,
19005 * <b>after the current item</b>
19007 * @param obj The slideshow object
19008 * @return The number of items set to be cached after the current one
19010 * @see elm_slideshow_cache_after_set() for more details
19012 * @ingroup Slideshow
19014 EAPI int elm_slideshow_cache_after_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19017 * Get the number of items stored in a given slideshow widget
19019 * @param obj The slideshow object
19020 * @return The number of items on @p obj, at the moment of this call
19022 * @ingroup Slideshow
19024 EAPI unsigned int elm_slideshow_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19031 * @defgroup Fileselector File Selector
19033 * @image html img/widget/fileselector/preview-00.png
19034 * @image latex img/widget/fileselector/preview-00.eps
19036 * A file selector is a widget that allows a user to navigate
19037 * through a file system, reporting file selections back via its
19040 * It contains shortcut buttons for home directory (@c ~) and to
19041 * jump one directory upwards (..), as well as cancel/ok buttons to
19042 * confirm/cancel a given selection. After either one of those two
19043 * former actions, the file selector will issue its @c "done" smart
19046 * There's a text entry on it, too, showing the name of the current
19047 * selection. There's the possibility of making it editable, so it
19048 * is useful on file saving dialogs on applications, where one
19049 * gives a file name to save contents to, in a given directory in
19050 * the system. This custom file name will be reported on the @c
19051 * "done" smart callback (explained in sequence).
19053 * Finally, it has a view to display file system items into in two
19058 * If Elementary is built with support of the Ethumb thumbnailing
19059 * library, the second form of view will display preview thumbnails
19060 * of files which it supports.
19062 * Smart callbacks one can register to:
19064 * - @c "selected" - the user has clicked on a file (when not in
19065 * folders-only mode) or directory (when in folders-only mode)
19066 * - @c "directory,open" - the list has been populated with new
19067 * content (@c event_info is a pointer to the directory's
19068 * path, a @b stringshared string)
19069 * - @c "done" - the user has clicked on the "ok" or "cancel"
19070 * buttons (@c event_info is a pointer to the selection's
19071 * path, a @b stringshared string)
19073 * Here is an example on its usage:
19074 * @li @ref fileselector_example
19078 * @addtogroup Fileselector
19083 * Defines how a file selector widget is to layout its contents
19084 * (file system entries).
19086 typedef enum _Elm_Fileselector_Mode
19088 ELM_FILESELECTOR_LIST = 0, /**< layout as a list */
19089 ELM_FILESELECTOR_GRID, /**< layout as a grid */
19090 ELM_FILESELECTOR_LAST /**< sentinel (helper) value, not used */
19091 } Elm_Fileselector_Mode;
19094 * Add a new file selector widget to the given parent Elementary
19095 * (container) object
19097 * @param parent The parent object
19098 * @return a new file selector widget handle or @c NULL, on errors
19100 * This function inserts a new file selector widget on the canvas.
19102 * @ingroup Fileselector
19104 EAPI Evas_Object *elm_fileselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
19107 * Enable/disable the file name entry box where the user can type
19108 * in a name for a file, in a given file selector widget
19110 * @param obj The file selector object
19111 * @param is_save @c EINA_TRUE to make the file selector a "saving
19112 * dialog", @c EINA_FALSE otherwise
19114 * Having the entry editable is useful on file saving dialogs on
19115 * applications, where one gives a file name to save contents to,
19116 * in a given directory in the system. This custom file name will
19117 * be reported on the @c "done" smart callback.
19119 * @see elm_fileselector_is_save_get()
19121 * @ingroup Fileselector
19123 EAPI void elm_fileselector_is_save_set(Evas_Object *obj, Eina_Bool is_save) EINA_ARG_NONNULL(1);
19126 * Get whether the given file selector is in "saving dialog" mode
19128 * @param obj The file selector object
19129 * @return @c EINA_TRUE, if the file selector is in "saving dialog"
19130 * mode, @c EINA_FALSE otherwise (and on errors)
19132 * @see elm_fileselector_is_save_set() for more details
19134 * @ingroup Fileselector
19136 EAPI Eina_Bool elm_fileselector_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19139 * Enable/disable folder-only view for a given file selector widget
19141 * @param obj The file selector object
19142 * @param only @c EINA_TRUE to make @p obj only display
19143 * directories, @c EINA_FALSE to make files to be displayed in it
19146 * If enabled, the widget's view will only display folder items,
19149 * @see elm_fileselector_folder_only_get()
19151 * @ingroup Fileselector
19153 EAPI void elm_fileselector_folder_only_set(Evas_Object *obj, Eina_Bool only) EINA_ARG_NONNULL(1);
19156 * Get whether folder-only view is set for a given file selector
19159 * @param obj The file selector object
19160 * @return only @c EINA_TRUE if @p obj is only displaying
19161 * directories, @c EINA_FALSE if files are being displayed in it
19162 * too (and on errors)
19164 * @see elm_fileselector_folder_only_get()
19166 * @ingroup Fileselector
19168 EAPI Eina_Bool elm_fileselector_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19171 * Enable/disable the "ok" and "cancel" buttons on a given file
19174 * @param obj The file selector object
19175 * @param only @c EINA_TRUE to show them, @c EINA_FALSE to hide.
19177 * @note A file selector without those buttons will never emit the
19178 * @c "done" smart event, and is only usable if one is just hooking
19179 * to the other two events.
19181 * @see elm_fileselector_buttons_ok_cancel_get()
19183 * @ingroup Fileselector
19185 EAPI void elm_fileselector_buttons_ok_cancel_set(Evas_Object *obj, Eina_Bool buttons) EINA_ARG_NONNULL(1);
19188 * Get whether the "ok" and "cancel" buttons on a given file
19189 * selector widget are being shown.
19191 * @param obj The file selector object
19192 * @return @c EINA_TRUE if they are being shown, @c EINA_FALSE
19193 * otherwise (and on errors)
19195 * @see elm_fileselector_buttons_ok_cancel_set() for more details
19197 * @ingroup Fileselector
19199 EAPI Eina_Bool elm_fileselector_buttons_ok_cancel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19202 * Enable/disable a tree view in the given file selector widget,
19203 * <b>if it's in @c #ELM_FILESELECTOR_LIST mode</b>
19205 * @param obj The file selector object
19206 * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
19209 * In a tree view, arrows are created on the sides of directories,
19210 * allowing them to expand in place.
19212 * @note If it's in other mode, the changes made by this function
19213 * will only be visible when one switches back to "list" mode.
19215 * @see elm_fileselector_expandable_get()
19217 * @ingroup Fileselector
19219 EAPI void elm_fileselector_expandable_set(Evas_Object *obj, Eina_Bool expand) EINA_ARG_NONNULL(1);
19222 * Get whether tree view is enabled for the given file selector
19225 * @param obj The file selector object
19226 * @return @c EINA_TRUE if @p obj is in tree view, @c EINA_FALSE
19227 * otherwise (and or errors)
19229 * @see elm_fileselector_expandable_set() for more details
19231 * @ingroup Fileselector
19233 EAPI Eina_Bool elm_fileselector_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19236 * Set, programmatically, the @b directory that a given file
19237 * selector widget will display contents from
19239 * @param obj The file selector object
19240 * @param path The path to display in @p obj
19242 * This will change the @b directory that @p obj is displaying. It
19243 * will also clear the text entry area on the @p obj object, which
19244 * displays select files' names.
19246 * @see elm_fileselector_path_get()
19248 * @ingroup Fileselector
19250 EAPI void elm_fileselector_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
19253 * Get the parent directory's path that a given file selector
19254 * widget is displaying
19256 * @param obj The file selector object
19257 * @return The (full) path of the directory the file selector is
19258 * displaying, a @b stringshared string
19260 * @see elm_fileselector_path_set()
19262 * @ingroup Fileselector
19264 EAPI const char *elm_fileselector_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19267 * Set, programmatically, the currently selected file/directory in
19268 * the given file selector widget
19270 * @param obj The file selector object
19271 * @param path The (full) path to a file or directory
19272 * @return @c EINA_TRUE on success, @c EINA_FALSE on failure. The
19273 * latter case occurs if the directory or file pointed to do not
19276 * @see elm_fileselector_selected_get()
19278 * @ingroup Fileselector
19280 EAPI Eina_Bool elm_fileselector_selected_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
19283 * Get the currently selected item's (full) path, in the given file
19286 * @param obj The file selector object
19287 * @return The absolute path of the selected item, a @b
19288 * stringshared string
19290 * @note Custom editions on @p obj object's text entry, if made,
19291 * will appear on the return string of this function, naturally.
19293 * @see elm_fileselector_selected_set() for more details
19295 * @ingroup Fileselector
19297 EAPI const char *elm_fileselector_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19300 * Set the mode in which a given file selector widget will display
19301 * (layout) file system entries in its view
19303 * @param obj The file selector object
19304 * @param mode The mode of the fileselector, being it one of
19305 * #ELM_FILESELECTOR_LIST (default) or #ELM_FILESELECTOR_GRID. The
19306 * first one, naturally, will display the files in a list. The
19307 * latter will make the widget to display its entries in a grid
19310 * @note By using elm_fileselector_expandable_set(), the user may
19311 * trigger a tree view for that list.
19313 * @note If Elementary is built with support of the Ethumb
19314 * thumbnailing library, the second form of view will display
19315 * preview thumbnails of files which it supports. You must have
19316 * elm_need_ethumb() called in your Elementary for thumbnailing to
19319 * @see elm_fileselector_expandable_set().
19320 * @see elm_fileselector_mode_get().
19322 * @ingroup Fileselector
19324 EAPI void elm_fileselector_mode_set(Evas_Object *obj, Elm_Fileselector_Mode mode) EINA_ARG_NONNULL(1);
19327 * Get the mode in which a given file selector widget is displaying
19328 * (layouting) file system entries in its view
19330 * @param obj The fileselector object
19331 * @return The mode in which the fileselector is at
19333 * @see elm_fileselector_mode_set() for more details
19335 * @ingroup Fileselector
19337 EAPI Elm_Fileselector_Mode elm_fileselector_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19344 * @defgroup Progressbar Progress bar
19346 * The progress bar is a widget for visually representing the
19347 * progress status of a given job/task.
19349 * A progress bar may be horizontal or vertical. It may display an
19350 * icon besides it, as well as primary and @b units labels. The
19351 * former is meant to label the widget as a whole, while the
19352 * latter, which is formatted with floating point values (and thus
19353 * accepts a <c>printf</c>-style format string, like <c>"%1.2f
19354 * units"</c>), is meant to label the widget's <b>progress
19355 * value</b>. Label, icon and unit strings/objects are @b optional
19356 * for progress bars.
19358 * A progress bar may be @b inverted, in which state it gets its
19359 * values inverted, with high values being on the left or top and
19360 * low values on the right or bottom, as opposed to normally have
19361 * the low values on the former and high values on the latter,
19362 * respectively, for horizontal and vertical modes.
19364 * The @b span of the progress, as set by
19365 * elm_progressbar_span_size_set(), is its length (horizontally or
19366 * vertically), unless one puts size hints on the widget to expand
19367 * on desired directions, by any container. That length will be
19368 * scaled by the object or applications scaling factor. At any
19369 * point code can query the progress bar for its value with
19370 * elm_progressbar_value_get().
19372 * Available widget styles for progress bars:
19374 * - @c "wheel" (simple style, no text, no progression, only
19375 * "pulse" effect is available)
19377 * Here is an example on its usage:
19378 * @li @ref progressbar_example
19382 * Add a new progress bar widget to the given parent Elementary
19383 * (container) object
19385 * @param parent The parent object
19386 * @return a new progress bar widget handle or @c NULL, on errors
19388 * This function inserts a new progress bar widget on the canvas.
19390 * @ingroup Progressbar
19392 EAPI Evas_Object *elm_progressbar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
19395 * Set whether a given progress bar widget is at "pulsing mode" or
19398 * @param obj The progress bar object
19399 * @param pulse @c EINA_TRUE to put @p obj in pulsing mode,
19400 * @c EINA_FALSE to put it back to its default one
19402 * By default, progress bars will display values from the low to
19403 * high value boundaries. There are, though, contexts in which the
19404 * state of progression of a given task is @b unknown. For those,
19405 * one can set a progress bar widget to a "pulsing state", to give
19406 * the user an idea that some computation is being held, but
19407 * without exact progress values. In the default theme it will
19408 * animate its bar with the contents filling in constantly and back
19409 * to non-filled, in a loop. To start and stop this pulsing
19410 * animation, one has to explicitly call elm_progressbar_pulse().
19412 * @see elm_progressbar_pulse_get()
19413 * @see elm_progressbar_pulse()
19415 * @ingroup Progressbar
19417 EAPI void elm_progressbar_pulse_set(Evas_Object *obj, Eina_Bool pulse) EINA_ARG_NONNULL(1);
19420 * Get whether a given progress bar widget is at "pulsing mode" or
19423 * @param obj The progress bar object
19424 * @return @c EINA_TRUE, if @p obj is in pulsing mode, @c EINA_FALSE
19425 * if it's in the default one (and on errors)
19427 * @ingroup Progressbar
19429 EAPI Eina_Bool elm_progressbar_pulse_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19432 * Start/stop a given progress bar "pulsing" animation, if its
19435 * @param obj The progress bar object
19436 * @param state @c EINA_TRUE, to @b start the pulsing animation,
19437 * @c EINA_FALSE to @b stop it
19439 * @note This call won't do anything if @p obj is not under "pulsing mode".
19441 * @see elm_progressbar_pulse_set() for more details.
19443 * @ingroup Progressbar
19445 EAPI void elm_progressbar_pulse(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
19448 * Set the progress value (in percentage) on a given progress bar
19451 * @param obj The progress bar object
19452 * @param val The progress value (@b must be between @c 0.0 and @c
19455 * Use this call to set progress bar levels.
19457 * @note If you passes a value out of the specified range for @p
19458 * val, it will be interpreted as the @b closest of the @b boundary
19459 * values in the range.
19461 * @ingroup Progressbar
19463 EAPI void elm_progressbar_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
19466 * Get the progress value (in percentage) on a given progress bar
19469 * @param obj The progress bar object
19470 * @return The value of the progressbar
19472 * @see elm_progressbar_value_set() for more details
19474 * @ingroup Progressbar
19476 EAPI double elm_progressbar_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19479 * Set the label of a given progress bar widget
19481 * @param obj The progress bar object
19482 * @param label The text label string, in UTF-8
19484 * @ingroup Progressbar
19485 * @deprecated use elm_object_text_set() instead.
19487 EINA_DEPRECATED EAPI void elm_progressbar_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
19490 * Get the label of a given progress bar widget
19492 * @param obj The progressbar object
19493 * @return The text label string, in UTF-8
19495 * @ingroup Progressbar
19496 * @deprecated use elm_object_text_set() instead.
19498 EINA_DEPRECATED EAPI const char *elm_progressbar_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19501 * Set the icon object of a given progress bar widget
19503 * @param obj The progress bar object
19504 * @param icon The icon object
19506 * Use this call to decorate @p obj with an icon next to it.
19508 * @note Once the icon object is set, a previously set one will be
19509 * deleted. If you want to keep that old content object, use the
19510 * elm_progressbar_icon_unset() function.
19512 * @see elm_progressbar_icon_get()
19514 * @ingroup Progressbar
19516 EAPI void elm_progressbar_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
19519 * Retrieve the icon object set for a given progress bar widget
19521 * @param obj The progress bar object
19522 * @return The icon object's handle, if @p obj had one set, or @c NULL,
19523 * otherwise (and on errors)
19525 * @see elm_progressbar_icon_set() for more details
19527 * @ingroup Progressbar
19529 EAPI Evas_Object *elm_progressbar_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19532 * Unset an icon set on a given progress bar widget
19534 * @param obj The progress bar object
19535 * @return The icon object that was being used, if any was set, or
19536 * @c NULL, otherwise (and on errors)
19538 * This call will unparent and return the icon object which was set
19539 * for this widget, previously, on success.
19541 * @see elm_progressbar_icon_set() for more details
19543 * @ingroup Progressbar
19545 EAPI Evas_Object *elm_progressbar_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
19548 * Set the (exact) length of the bar region of a given progress bar
19551 * @param obj The progress bar object
19552 * @param size The length of the progress bar's bar region
19554 * This sets the minimum width (when in horizontal mode) or height
19555 * (when in vertical mode) of the actual bar area of the progress
19556 * bar @p obj. This in turn affects the object's minimum size. Use
19557 * this when you're not setting other size hints expanding on the
19558 * given direction (like weight and alignment hints) and you would
19559 * like it to have a specific size.
19561 * @note Icon, label and unit text around @p obj will require their
19562 * own space, which will make @p obj to require more the @p size,
19565 * @see elm_progressbar_span_size_get()
19567 * @ingroup Progressbar
19569 EAPI void elm_progressbar_span_size_set(Evas_Object *obj, Evas_Coord size) EINA_ARG_NONNULL(1);
19572 * Get the length set for the bar region of a given progress bar
19575 * @param obj The progress bar object
19576 * @return The length of the progress bar's bar region
19578 * If that size was not set previously, with
19579 * elm_progressbar_span_size_set(), this call will return @c 0.
19581 * @ingroup Progressbar
19583 EAPI Evas_Coord elm_progressbar_span_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19586 * Set the format string for a given progress bar widget's units
19589 * @param obj The progress bar object
19590 * @param format The format string for @p obj's units label
19592 * If @c NULL is passed on @p format, it will make @p obj's units
19593 * area to be hidden completely. If not, it'll set the <b>format
19594 * string</b> for the units label's @b text. The units label is
19595 * provided a floating point value, so the units text is up display
19596 * at most one floating point falue. Note that the units label is
19597 * optional. Use a format string such as "%1.2f meters" for
19600 * @note The default format string for a progress bar is an integer
19601 * percentage, as in @c "%.0f %%".
19603 * @see elm_progressbar_unit_format_get()
19605 * @ingroup Progressbar
19607 EAPI void elm_progressbar_unit_format_set(Evas_Object *obj, const char *format) EINA_ARG_NONNULL(1);
19610 * Retrieve the format string set for a given progress bar widget's
19613 * @param obj The progress bar object
19614 * @return The format set string for @p obj's units label or
19615 * @c NULL, if none was set (and on errors)
19617 * @see elm_progressbar_unit_format_set() for more details
19619 * @ingroup Progressbar
19621 EAPI const char *elm_progressbar_unit_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19624 * Set the orientation of a given progress bar widget
19626 * @param obj The progress bar object
19627 * @param horizontal Use @c EINA_TRUE to make @p obj to be
19628 * @b horizontal, @c EINA_FALSE to make it @b vertical
19630 * Use this function to change how your progress bar is to be
19631 * disposed: vertically or horizontally.
19633 * @see elm_progressbar_horizontal_get()
19635 * @ingroup Progressbar
19637 EAPI void elm_progressbar_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
19640 * Retrieve the orientation of a given progress bar widget
19642 * @param obj The progress bar object
19643 * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
19644 * @c EINA_FALSE if it's @b vertical (and on errors)
19646 * @see elm_progressbar_horizontal_set() for more details
19648 * @ingroup Progressbar
19650 EAPI Eina_Bool elm_progressbar_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19653 * Invert a given progress bar widget's displaying values order
19655 * @param obj The progress bar object
19656 * @param inverted Use @c EINA_TRUE to make @p obj inverted,
19657 * @c EINA_FALSE to bring it back to default, non-inverted values.
19659 * A progress bar may be @b inverted, in which state it gets its
19660 * values inverted, with high values being on the left or top and
19661 * low values on the right or bottom, as opposed to normally have
19662 * the low values on the former and high values on the latter,
19663 * respectively, for horizontal and vertical modes.
19665 * @see elm_progressbar_inverted_get()
19667 * @ingroup Progressbar
19669 EAPI void elm_progressbar_inverted_set(Evas_Object *obj, Eina_Bool inverted) EINA_ARG_NONNULL(1);
19672 * Get whether a given progress bar widget's displaying values are
19675 * @param obj The progress bar object
19676 * @return @c EINA_TRUE, if @p obj has inverted values,
19677 * @c EINA_FALSE otherwise (and on errors)
19679 * @see elm_progressbar_inverted_set() for more details
19681 * @ingroup Progressbar
19683 EAPI Eina_Bool elm_progressbar_inverted_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19686 * @defgroup Separator Separator
19688 * @brief Separator is a very thin object used to separate other objects.
19690 * A separator can be vertical or horizontal.
19692 * @ref tutorial_separator is a good example of how to use a separator.
19696 * @brief Add a separator object to @p parent
19698 * @param parent The parent object
19700 * @return The separator object, or NULL upon failure
19702 EAPI Evas_Object *elm_separator_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
19704 * @brief Set the horizontal mode of a separator object
19706 * @param obj The separator object
19707 * @param horizontal If true, the separator is horizontal
19709 EAPI void elm_separator_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
19711 * @brief Get the horizontal mode of a separator object
19713 * @param obj The separator object
19714 * @return If true, the separator is horizontal
19716 * @see elm_separator_horizontal_set()
19718 EAPI Eina_Bool elm_separator_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19724 * @defgroup Spinner Spinner
19725 * @ingroup Elementary
19727 * @image html img/widget/spinner/preview-00.png
19728 * @image latex img/widget/spinner/preview-00.eps
19730 * A spinner is a widget which allows the user to increase or decrease
19731 * numeric values using arrow buttons, or edit values directly, clicking
19732 * over it and typing the new value.
19734 * By default the spinner will not wrap and has a label
19735 * of "%.0f" (just showing the integer value of the double).
19737 * A spinner has a label that is formatted with floating
19738 * point values and thus accepts a printf-style format string, like
19741 * It also allows specific values to be replaced by pre-defined labels.
19743 * Smart callbacks one can register to:
19745 * - "changed" - Whenever the spinner value is changed.
19746 * - "delay,changed" - A short time after the value is changed by the user.
19747 * This will be called only when the user stops dragging for a very short
19748 * period or when they release their finger/mouse, so it avoids possibly
19749 * expensive reactions to the value change.
19751 * Available styles for it:
19753 * - @c "vertical": up/down buttons at the right side and text left aligned.
19755 * Here is an example on its usage:
19756 * @ref spinner_example
19760 * @addtogroup Spinner
19765 * Add a new spinner widget to the given parent Elementary
19766 * (container) object.
19768 * @param parent The parent object.
19769 * @return a new spinner widget handle or @c NULL, on errors.
19771 * This function inserts a new spinner widget on the canvas.
19776 EAPI Evas_Object *elm_spinner_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
19779 * Set the format string of the displayed label.
19781 * @param obj The spinner object.
19782 * @param fmt The format string for the label display.
19784 * If @c NULL, this sets the format to "%.0f". If not it sets the format
19785 * string for the label text. The label text is provided a floating point
19786 * value, so the label text can display up to 1 floating point value.
19787 * Note that this is optional.
19789 * Use a format string such as "%1.2f meters" for example, and it will
19790 * display values like: "3.14 meters" for a value equal to 3.14159.
19792 * Default is "%0.f".
19794 * @see elm_spinner_label_format_get()
19798 EAPI void elm_spinner_label_format_set(Evas_Object *obj, const char *fmt) EINA_ARG_NONNULL(1);
19801 * Get the label format of the spinner.
19803 * @param obj The spinner object.
19804 * @return The text label format string in UTF-8.
19806 * @see elm_spinner_label_format_set() for details.
19810 EAPI const char *elm_spinner_label_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19813 * Set the minimum and maximum values for the spinner.
19815 * @param obj The spinner object.
19816 * @param min The minimum value.
19817 * @param max The maximum value.
19819 * Define the allowed range of values to be selected by the user.
19821 * If actual value is less than @p min, it will be updated to @p min. If it
19822 * is bigger then @p max, will be updated to @p max. Actual value can be
19823 * get with elm_spinner_value_get().
19825 * By default, min is equal to 0, and max is equal to 100.
19827 * @warning Maximum must be greater than minimum.
19829 * @see elm_spinner_min_max_get()
19833 EAPI void elm_spinner_min_max_set(Evas_Object *obj, double min, double max) EINA_ARG_NONNULL(1);
19836 * Get the minimum and maximum values of the spinner.
19838 * @param obj The spinner object.
19839 * @param min Pointer where to store the minimum value.
19840 * @param max Pointer where to store the maximum value.
19842 * @note If only one value is needed, the other pointer can be passed
19845 * @see elm_spinner_min_max_set() for details.
19849 EAPI void elm_spinner_min_max_get(const Evas_Object *obj, double *min, double *max) EINA_ARG_NONNULL(1);
19852 * Set the step used to increment or decrement the spinner value.
19854 * @param obj The spinner object.
19855 * @param step The step value.
19857 * This value will be incremented or decremented to the displayed value.
19858 * It will be incremented while the user keep right or top arrow pressed,
19859 * and will be decremented while the user keep left or bottom arrow pressed.
19861 * The interval to increment / decrement can be set with
19862 * elm_spinner_interval_set().
19864 * By default step value is equal to 1.
19866 * @see elm_spinner_step_get()
19870 EAPI void elm_spinner_step_set(Evas_Object *obj, double step) EINA_ARG_NONNULL(1);
19873 * Get the step used to increment or decrement the spinner value.
19875 * @param obj The spinner object.
19876 * @return The step value.
19878 * @see elm_spinner_step_get() for more details.
19882 EAPI double elm_spinner_step_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19885 * Set the value the spinner displays.
19887 * @param obj The spinner object.
19888 * @param val The value to be displayed.
19890 * Value will be presented on the label following format specified with
19891 * elm_spinner_format_set().
19893 * @warning The value must to be between min and max values. This values
19894 * are set by elm_spinner_min_max_set().
19896 * @see elm_spinner_value_get().
19897 * @see elm_spinner_format_set().
19898 * @see elm_spinner_min_max_set().
19902 EAPI void elm_spinner_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
19905 * Get the value displayed by the spinner.
19907 * @param obj The spinner object.
19908 * @return The value displayed.
19910 * @see elm_spinner_value_set() for details.
19914 EAPI double elm_spinner_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19917 * Set whether the spinner should wrap when it reaches its
19918 * minimum or maximum value.
19920 * @param obj The spinner object.
19921 * @param wrap @c EINA_TRUE to enable wrap or @c EINA_FALSE to
19924 * Disabled by default. If disabled, when the user tries to increment the
19926 * but displayed value plus step value is bigger than maximum value,
19928 * won't allow it. The same happens when the user tries to decrement it,
19929 * but the value less step is less than minimum value.
19931 * When wrap is enabled, in such situations it will allow these changes,
19932 * but will get the value that would be less than minimum and subtracts
19933 * from maximum. Or add the value that would be more than maximum to
19937 * @li min value = 10
19938 * @li max value = 50
19939 * @li step value = 20
19940 * @li displayed value = 20
19942 * When the user decrement value (using left or bottom arrow), it will
19943 * displays @c 40, because max - (min - (displayed - step)) is
19944 * @c 50 - (@c 10 - (@c 20 - @c 20)) = @c 40.
19946 * @see elm_spinner_wrap_get().
19950 EAPI void elm_spinner_wrap_set(Evas_Object *obj, Eina_Bool wrap) EINA_ARG_NONNULL(1);
19953 * Get whether the spinner should wrap when it reaches its
19954 * minimum or maximum value.
19956 * @param obj The spinner object
19957 * @return @c EINA_TRUE means wrap is enabled. @c EINA_FALSE indicates
19958 * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
19960 * @see elm_spinner_wrap_set() for details.
19964 EAPI Eina_Bool elm_spinner_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19967 * Set whether the spinner can be directly edited by the user or not.
19969 * @param obj The spinner object.
19970 * @param editable @c EINA_TRUE to allow users to edit it or @c EINA_FALSE to
19971 * don't allow users to edit it directly.
19973 * Spinner objects can have edition @b disabled, in which state they will
19974 * be changed only by arrows.
19975 * Useful for contexts
19976 * where you don't want your users to interact with it writting the value.
19978 * when using special values, the user can see real value instead
19979 * of special label on edition.
19981 * It's enabled by default.
19983 * @see elm_spinner_editable_get()
19987 EAPI void elm_spinner_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
19990 * Get whether the spinner can be directly edited by the user or not.
19992 * @param obj The spinner object.
19993 * @return @c EINA_TRUE means edition is enabled. @c EINA_FALSE indicates
19994 * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
19996 * @see elm_spinner_editable_set() for details.
20000 EAPI Eina_Bool elm_spinner_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20003 * Set a special string to display in the place of the numerical value.
20005 * @param obj The spinner object.
20006 * @param value The value to be replaced.
20007 * @param label The label to be used.
20009 * It's useful for cases when a user should select an item that is
20010 * better indicated by a label than a value. For example, weekdays or months.
20014 * sp = elm_spinner_add(win);
20015 * elm_spinner_min_max_set(sp, 1, 3);
20016 * elm_spinner_special_value_add(sp, 1, "January");
20017 * elm_spinner_special_value_add(sp, 2, "February");
20018 * elm_spinner_special_value_add(sp, 3, "March");
20019 * evas_object_show(sp);
20024 EAPI void elm_spinner_special_value_add(Evas_Object *obj, double value, const char *label) EINA_ARG_NONNULL(1);
20027 * Set the interval on time updates for an user mouse button hold
20028 * on spinner widgets' arrows.
20030 * @param obj The spinner object.
20031 * @param interval The (first) interval value in seconds.
20033 * This interval value is @b decreased while the user holds the
20034 * mouse pointer either incrementing or decrementing spinner's value.
20036 * This helps the user to get to a given value distant from the
20037 * current one easier/faster, as it will start to change quicker and
20038 * quicker on mouse button holds.
20040 * The calculation for the next change interval value, starting from
20041 * the one set with this call, is the previous interval divided by
20042 * @c 1.05, so it decreases a little bit.
20044 * The default starting interval value for automatic changes is
20047 * @see elm_spinner_interval_get()
20051 EAPI void elm_spinner_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
20054 * Get the interval on time updates for an user mouse button hold
20055 * on spinner widgets' arrows.
20057 * @param obj The spinner object.
20058 * @return The (first) interval value, in seconds, set on it.
20060 * @see elm_spinner_interval_set() for more details.
20064 EAPI double elm_spinner_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20071 * @defgroup Index Index
20073 * @image html img/widget/index/preview-00.png
20074 * @image latex img/widget/index/preview-00.eps
20076 * An index widget gives you an index for fast access to whichever
20077 * group of other UI items one might have. It's a list of text
20078 * items (usually letters, for alphabetically ordered access).
20080 * Index widgets are by default hidden and just appear when the
20081 * user clicks over it's reserved area in the canvas. In its
20082 * default theme, it's an area one @ref Fingers "finger" wide on
20083 * the right side of the index widget's container.
20085 * When items on the index are selected, smart callbacks get
20086 * called, so that its user can make other container objects to
20087 * show a given area or child object depending on the index item
20088 * selected. You'd probably be using an index together with @ref
20089 * List "lists", @ref Genlist "generic lists" or @ref Gengrid
20092 * Smart events one can add callbacks for are:
20093 * - @c "changed" - When the selected index item changes. @c
20094 * event_info is the selected item's data pointer.
20095 * - @c "delay,changed" - When the selected index item changes, but
20096 * after a small idling period. @c event_info is the selected
20097 * item's data pointer.
20098 * - @c "selected" - When the user releases a mouse button and
20099 * selects an item. @c event_info is the selected item's data
20101 * - @c "level,up" - when the user moves a finger from the first
20102 * level to the second level
20103 * - @c "level,down" - when the user moves a finger from the second
20104 * level to the first level
20106 * The @c "delay,changed" event is so that it'll wait a small time
20107 * before actually reporting those events and, moreover, just the
20108 * last event happening on those time frames will actually be
20111 * Here are some examples on its usage:
20112 * @li @ref index_example_01
20113 * @li @ref index_example_02
20117 * @addtogroup Index
20121 typedef struct _Elm_Index_Item Elm_Index_Item; /**< Opaque handle for items of Elementary index widgets */
20124 * Add a new index widget to the given parent Elementary
20125 * (container) object
20127 * @param parent The parent object
20128 * @return a new index widget handle or @c NULL, on errors
20130 * This function inserts a new index widget on the canvas.
20134 EAPI Evas_Object *elm_index_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20137 * Set whether a given index widget is or not visible,
20140 * @param obj The index object
20141 * @param active @c EINA_TRUE to show it, @c EINA_FALSE to hide it
20143 * Not to be confused with visible as in @c evas_object_show() --
20144 * visible with regard to the widget's auto hiding feature.
20146 * @see elm_index_active_get()
20150 EAPI void elm_index_active_set(Evas_Object *obj, Eina_Bool active) EINA_ARG_NONNULL(1);
20153 * Get whether a given index widget is currently visible or not.
20155 * @param obj The index object
20156 * @return @c EINA_TRUE, if it's shown, @c EINA_FALSE otherwise
20158 * @see elm_index_active_set() for more details
20162 EAPI Eina_Bool elm_index_active_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20165 * Set the items level for a given index widget.
20167 * @param obj The index object.
20168 * @param level @c 0 or @c 1, the currently implemented levels.
20170 * @see elm_index_item_level_get()
20174 EAPI void elm_index_item_level_set(Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
20177 * Get the items level set for a given index widget.
20179 * @param obj The index object.
20180 * @return @c 0 or @c 1, which are the levels @p obj might be at.
20182 * @see elm_index_item_level_set() for more information
20186 EAPI int elm_index_item_level_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20189 * Returns the last selected item's data, for a given index widget.
20191 * @param obj The index object.
20192 * @return The item @b data associated to the last selected item on
20193 * @p obj (or @c NULL, on errors).
20195 * @warning The returned value is @b not an #Elm_Index_Item item
20196 * handle, but the data associated to it (see the @c item parameter
20197 * in elm_index_item_append(), as an example).
20201 EAPI void *elm_index_item_selected_get(const Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
20204 * Append a new item on a given index widget.
20206 * @param obj The index object.
20207 * @param letter Letter under which the item should be indexed
20208 * @param item The item data to set for the index's item
20210 * Despite the most common usage of the @p letter argument is for
20211 * single char strings, one could use arbitrary strings as index
20214 * @c item will be the pointer returned back on @c "changed", @c
20215 * "delay,changed" and @c "selected" smart events.
20219 EAPI void elm_index_item_append(Evas_Object *obj, const char *letter, const void *item) EINA_ARG_NONNULL(1);
20222 * Prepend a new item on a given index widget.
20224 * @param obj The index object.
20225 * @param letter Letter under which the item should be indexed
20226 * @param item The item data to set for the index's item
20228 * Despite the most common usage of the @p letter argument is for
20229 * single char strings, one could use arbitrary strings as index
20232 * @c item will be the pointer returned back on @c "changed", @c
20233 * "delay,changed" and @c "selected" smart events.
20237 EAPI void elm_index_item_prepend(Evas_Object *obj, const char *letter, const void *item) EINA_ARG_NONNULL(1);
20240 * Append a new item, on a given index widget, <b>after the item
20241 * having @p relative as data</b>.
20243 * @param obj The index object.
20244 * @param letter Letter under which the item should be indexed
20245 * @param item The item data to set for the index's item
20246 * @param relative The item data of the index item to be the
20247 * predecessor of this new one
20249 * Despite the most common usage of the @p letter argument is for
20250 * single char strings, one could use arbitrary strings as index
20253 * @c item will be the pointer returned back on @c "changed", @c
20254 * "delay,changed" and @c "selected" smart events.
20256 * @note If @p relative is @c NULL or if it's not found to be data
20257 * set on any previous item on @p obj, this function will behave as
20258 * elm_index_item_append().
20262 EAPI void elm_index_item_append_relative(Evas_Object *obj, const char *letter, const void *item, const void *relative) EINA_ARG_NONNULL(1);
20265 * Prepend a new item, on a given index widget, <b>after the item
20266 * having @p relative as data</b>.
20268 * @param obj The index object.
20269 * @param letter Letter under which the item should be indexed
20270 * @param item The item data to set for the index's item
20271 * @param relative The item data of the index item to be the
20272 * successor of this new one
20274 * Despite the most common usage of the @p letter argument is for
20275 * single char strings, one could use arbitrary strings as index
20278 * @c item will be the pointer returned back on @c "changed", @c
20279 * "delay,changed" and @c "selected" smart events.
20281 * @note If @p relative is @c NULL or if it's not found to be data
20282 * set on any previous item on @p obj, this function will behave as
20283 * elm_index_item_prepend().
20287 EAPI void elm_index_item_prepend_relative(Evas_Object *obj, const char *letter, const void *item, const void *relative) EINA_ARG_NONNULL(1);
20290 * Insert a new item into the given index widget, using @p cmp_func
20291 * function to sort items (by item handles).
20293 * @param obj The index object.
20294 * @param letter Letter under which the item should be indexed
20295 * @param item The item data to set for the index's item
20296 * @param cmp_func The comparing function to be used to sort index
20297 * items <b>by #Elm_Index_Item item handles</b>
20298 * @param cmp_data_func A @b fallback function to be called for the
20299 * sorting of index items <b>by item data</b>). It will be used
20300 * when @p cmp_func returns @c 0 (equality), which means an index
20301 * item with provided item data already exists. To decide which
20302 * data item should be pointed to by the index item in question, @p
20303 * cmp_data_func will be used. If @p cmp_data_func returns a
20304 * non-negative value, the previous index item data will be
20305 * replaced by the given @p item pointer. If the previous data need
20306 * to be freed, it should be done by the @p cmp_data_func function,
20307 * because all references to it will be lost. If this function is
20308 * not provided (@c NULL is given), index items will be @b
20309 * duplicated, if @p cmp_func returns @c 0.
20311 * Despite the most common usage of the @p letter argument is for
20312 * single char strings, one could use arbitrary strings as index
20315 * @c item will be the pointer returned back on @c "changed", @c
20316 * "delay,changed" and @c "selected" smart events.
20320 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);
20323 * Remove an item from a given index widget, <b>to be referenced by
20324 * it's data value</b>.
20326 * @param obj The index object
20327 * @param item The item's data pointer for the item to be removed
20330 * If a deletion callback is set, via elm_index_item_del_cb_set(),
20331 * that callback function will be called by this one.
20333 * @warning The item to be removed from @p obj will be found via
20334 * its item data pointer, and not by an #Elm_Index_Item handle.
20338 EAPI void elm_index_item_del(Evas_Object *obj, const void *item) EINA_ARG_NONNULL(1);
20341 * Find a given index widget's item, <b>using item data</b>.
20343 * @param obj The index object
20344 * @param item The item data pointed to by the desired index item
20345 * @return The index item handle, if found, or @c NULL otherwise
20349 EAPI Elm_Index_Item *elm_index_item_find(Evas_Object *obj, const void *item) EINA_ARG_NONNULL(1);
20352 * Removes @b all items from a given index widget.
20354 * @param obj The index object.
20356 * If deletion callbacks are set, via elm_index_item_del_cb_set(),
20357 * that callback function will be called for each item in @p obj.
20361 EAPI void elm_index_item_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
20364 * Go to a given items level on a index widget
20366 * @param obj The index object
20367 * @param level The index level (one of @c 0 or @c 1)
20371 EAPI void elm_index_item_go(Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
20374 * Return the data associated with a given index widget item
20376 * @param it The index widget item handle
20377 * @return The data associated with @p it
20379 * @see elm_index_item_data_set()
20383 EAPI void *elm_index_item_data_get(const Elm_Index_Item *item) EINA_ARG_NONNULL(1);
20386 * Set the data associated with a given index widget item
20388 * @param it The index widget item handle
20389 * @param data The new data pointer to set to @p it
20391 * This sets new item data on @p it.
20393 * @warning The old data pointer won't be touched by this function, so
20394 * the user had better to free that old data himself/herself.
20398 EAPI void elm_index_item_data_set(Elm_Index_Item *it, const void *data) EINA_ARG_NONNULL(1);
20401 * Set the function to be called when a given index widget item is freed.
20403 * @param it The item to set the callback on
20404 * @param func The function to call on the item's deletion
20406 * When called, @p func will have both @c data and @c event_info
20407 * arguments with the @p it item's data value and, naturally, the
20408 * @c obj argument with a handle to the parent index widget.
20412 EAPI void elm_index_item_del_cb_set(Elm_Index_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
20415 * Get the letter (string) set on a given index widget item.
20417 * @param it The index item handle
20418 * @return The letter string set on @p it
20422 EAPI const char *elm_index_item_letter_get(const Elm_Index_Item *item) EINA_ARG_NONNULL(1);
20429 * @defgroup Photocam Photocam
20431 * @image html img/widget/photocam/preview-00.png
20432 * @image latex img/widget/photocam/preview-00.eps
20434 * This is a widget specifically for displaying high-resolution digital
20435 * camera photos giving speedy feedback (fast load), low memory footprint
20436 * and zooming and panning as well as fitting logic. It is entirely focused
20437 * on jpeg images, and takes advantage of properties of the jpeg format (via
20438 * evas loader features in the jpeg loader).
20440 * Signals that you can add callbacks for are:
20441 * @li "clicked" - This is called when a user has clicked the photo without
20443 * @li "press" - This is called when a user has pressed down on the photo.
20444 * @li "longpressed" - This is called when a user has pressed down on the
20445 * photo for a long time without dragging around.
20446 * @li "clicked,double" - This is called when a user has double-clicked the
20448 * @li "load" - Photo load begins.
20449 * @li "loaded" - This is called when the image file load is complete for the
20450 * first view (low resolution blurry version).
20451 * @li "load,detail" - Photo detailed data load begins.
20452 * @li "loaded,detail" - This is called when the image file load is complete
20453 * for the detailed image data (full resolution needed).
20454 * @li "zoom,start" - Zoom animation started.
20455 * @li "zoom,stop" - Zoom animation stopped.
20456 * @li "zoom,change" - Zoom changed when using an auto zoom mode.
20457 * @li "scroll" - the content has been scrolled (moved)
20458 * @li "scroll,anim,start" - scrolling animation has started
20459 * @li "scroll,anim,stop" - scrolling animation has stopped
20460 * @li "scroll,drag,start" - dragging the contents around has started
20461 * @li "scroll,drag,stop" - dragging the contents around has stopped
20463 * @ref tutorial_photocam shows the API in action.
20467 * @brief Types of zoom available.
20469 typedef enum _Elm_Photocam_Zoom_Mode
20471 ELM_PHOTOCAM_ZOOM_MODE_MANUAL = 0, /**< Zoom controled normally by elm_photocam_zoom_set */
20472 ELM_PHOTOCAM_ZOOM_MODE_AUTO_FIT, /**< Zoom until photo fits in photocam */
20473 ELM_PHOTOCAM_ZOOM_MODE_AUTO_FILL, /**< Zoom until photo fills photocam */
20474 ELM_PHOTOCAM_ZOOM_MODE_LAST
20475 } Elm_Photocam_Zoom_Mode;
20477 * @brief Add a new Photocam object
20479 * @param parent The parent object
20480 * @return The new object or NULL if it cannot be created
20482 EAPI Evas_Object *elm_photocam_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20484 * @brief Set the photo file to be shown
20486 * @param obj The photocam object
20487 * @param file The photo file
20488 * @return The return error (see EVAS_LOAD_ERROR_NONE, EVAS_LOAD_ERROR_GENERIC etc.)
20490 * This sets (and shows) the specified file (with a relative or absolute
20491 * path) and will return a load error (same error that
20492 * evas_object_image_load_error_get() will return). The image will change and
20493 * adjust its size at this point and begin a background load process for this
20494 * photo that at some time in the future will be displayed at the full
20497 EAPI Evas_Load_Error elm_photocam_file_set(Evas_Object *obj, const char *file) EINA_ARG_NONNULL(1);
20499 * @brief Returns the path of the current image file
20501 * @param obj The photocam object
20502 * @return Returns the path
20504 * @see elm_photocam_file_set()
20506 EAPI const char *elm_photocam_file_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20508 * @brief Set the zoom level of the photo
20510 * @param obj The photocam object
20511 * @param zoom The zoom level to set
20513 * This sets the zoom level. 1 will be 1:1 pixel for pixel. 2 will be 2:1
20514 * (that is 2x2 photo pixels will display as 1 on-screen pixel). 4:1 will be
20515 * 4x4 photo pixels as 1 screen pixel, and so on. The @p zoom parameter must
20516 * be greater than 0. It is usggested to stick to powers of 2. (1, 2, 4, 8,
20519 EAPI void elm_photocam_zoom_set(Evas_Object *obj, double zoom) EINA_ARG_NONNULL(1);
20521 * @brief Get the zoom level of the photo
20523 * @param obj The photocam object
20524 * @return The current zoom level
20526 * This returns the current zoom level of the photocam object. Note that if
20527 * you set the fill mode to other than ELM_PHOTOCAM_ZOOM_MODE_MANUAL
20528 * (which is the default), the zoom level may be changed at any time by the
20529 * photocam object itself to account for photo size and photocam viewpoer
20532 * @see elm_photocam_zoom_set()
20533 * @see elm_photocam_zoom_mode_set()
20535 EAPI double elm_photocam_zoom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20537 * @brief Set the zoom mode
20539 * @param obj The photocam object
20540 * @param mode The desired mode
20542 * This sets the zoom mode to manual or one of several automatic levels.
20543 * Manual (ELM_PHOTOCAM_ZOOM_MODE_MANUAL) means that zoom is set manually by
20544 * elm_photocam_zoom_set() and will stay at that level until changed by code
20545 * or until zoom mode is changed. This is the default mode. The Automatic
20546 * modes will allow the photocam object to automatically adjust zoom mode
20547 * based on properties. ELM_PHOTOCAM_ZOOM_MODE_AUTO_FIT) will adjust zoom so
20548 * the photo fits EXACTLY inside the scroll frame with no pixels outside this
20549 * area. ELM_PHOTOCAM_ZOOM_MODE_AUTO_FILL will be similar but ensure no
20550 * pixels within the frame are left unfilled.
20552 EAPI void elm_photocam_zoom_mode_set(Evas_Object *obj, Elm_Photocam_Zoom_Mode mode) EINA_ARG_NONNULL(1);
20554 * @brief Get the zoom mode
20556 * @param obj The photocam object
20557 * @return The current zoom mode
20559 * This gets the current zoom mode of the photocam object.
20561 * @see elm_photocam_zoom_mode_set()
20563 EAPI Elm_Photocam_Zoom_Mode elm_photocam_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20565 * @brief Get the current image pixel width and height
20567 * @param obj The photocam object
20568 * @param w A pointer to the width return
20569 * @param h A pointer to the height return
20571 * This gets the current photo pixel width and height (for the original).
20572 * The size will be returned in the integers @p w and @p h that are pointed
20575 EAPI void elm_photocam_image_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
20577 * @brief Get the area of the image that is currently shown
20580 * @param x A pointer to the X-coordinate of region
20581 * @param y A pointer to the Y-coordinate of region
20582 * @param w A pointer to the width
20583 * @param h A pointer to the height
20585 * @see elm_photocam_image_region_show()
20586 * @see elm_photocam_image_region_bring_in()
20588 EAPI void elm_photocam_region_get(const Evas_Object *obj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
20590 * @brief Set the viewed portion of the image
20592 * @param obj The photocam object
20593 * @param x X-coordinate of region in image original pixels
20594 * @param y Y-coordinate of region in image original pixels
20595 * @param w Width of region in image original pixels
20596 * @param h Height of region in image original pixels
20598 * This shows the region of the image without using animation.
20600 EAPI void elm_photocam_image_region_show(Evas_Object *obj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
20602 * @brief Bring in the viewed portion of the image
20604 * @param obj The photocam object
20605 * @param x X-coordinate of region in image original pixels
20606 * @param y Y-coordinate of region in image original pixels
20607 * @param w Width of region in image original pixels
20608 * @param h Height of region in image original pixels
20610 * This shows the region of the image using animation.
20612 EAPI void elm_photocam_image_region_bring_in(Evas_Object *obj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
20614 * @brief Set the paused state for photocam
20616 * @param obj The photocam object
20617 * @param paused The pause state to set
20619 * This sets the paused state to on(EINA_TRUE) or off (EINA_FALSE) for
20620 * photocam. The default is off. This will stop zooming using animation on
20621 * zoom levels changes and change instantly. This will stop any existing
20622 * animations that are running.
20624 EAPI void elm_photocam_paused_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
20626 * @brief Get the paused state for photocam
20628 * @param obj The photocam object
20629 * @return The current paused state
20631 * This gets the current paused state for the photocam object.
20633 * @see elm_photocam_paused_set()
20635 EAPI Eina_Bool elm_photocam_paused_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20637 * @brief Get the internal low-res image used for photocam
20639 * @param obj The photocam object
20640 * @return The internal image object handle, or NULL if none exists
20642 * This gets the internal image object inside photocam. Do not modify it. It
20643 * is for inspection only, and hooking callbacks to. Nothing else. It may be
20644 * deleted at any time as well.
20646 EAPI Evas_Object *elm_photocam_internal_image_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20648 * @brief Set the photocam scrolling bouncing.
20650 * @param obj The photocam object
20651 * @param h_bounce bouncing for horizontal
20652 * @param v_bounce bouncing for vertical
20654 EAPI void elm_photocam_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
20656 * @brief Get the photocam scrolling bouncing.
20658 * @param obj The photocam object
20659 * @param h_bounce bouncing for horizontal
20660 * @param v_bounce bouncing for vertical
20662 * @see elm_photocam_bounce_set()
20664 EAPI void elm_photocam_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
20670 * @defgroup Map Map
20671 * @ingroup Elementary
20673 * @image html img/widget/map/preview-00.png
20674 * @image latex img/widget/map/preview-00.eps
20676 * This is a widget specifically for displaying a map. It uses basically
20677 * OpenStreetMap provider http://www.openstreetmap.org/,
20678 * but custom providers can be added.
20680 * It supports some basic but yet nice features:
20681 * @li zoom and scroll
20682 * @li markers with content to be displayed when user clicks over it
20683 * @li group of markers
20686 * Smart callbacks one can listen to:
20688 * - "clicked" - This is called when a user has clicked the map without
20690 * - "press" - This is called when a user has pressed down on the map.
20691 * - "longpressed" - This is called when a user has pressed down on the map
20692 * for a long time without dragging around.
20693 * - "clicked,double" - This is called when a user has double-clicked
20695 * - "load,detail" - Map detailed data load begins.
20696 * - "loaded,detail" - This is called when all currently visible parts of
20697 * the map are loaded.
20698 * - "zoom,start" - Zoom animation started.
20699 * - "zoom,stop" - Zoom animation stopped.
20700 * - "zoom,change" - Zoom changed when using an auto zoom mode.
20701 * - "scroll" - the content has been scrolled (moved).
20702 * - "scroll,anim,start" - scrolling animation has started.
20703 * - "scroll,anim,stop" - scrolling animation has stopped.
20704 * - "scroll,drag,start" - dragging the contents around has started.
20705 * - "scroll,drag,stop" - dragging the contents around has stopped.
20706 * - "downloaded" - This is called when all currently required map images
20708 * - "route,load" - This is called when route request begins.
20709 * - "route,loaded" - This is called when route request ends.
20710 * - "name,load" - This is called when name request begins.
20711 * - "name,loaded- This is called when name request ends.
20713 * Available style for map widget:
20716 * Available style for markers:
20721 * Available style for marker bubble:
20724 * List of examples:
20725 * @li @ref map_example_01
20726 * @li @ref map_example_02
20727 * @li @ref map_example_03
20736 * @enum _Elm_Map_Zoom_Mode
20737 * @typedef Elm_Map_Zoom_Mode
20739 * Set map's zoom behavior. It can be set to manual or automatic.
20741 * Default value is #ELM_MAP_ZOOM_MODE_MANUAL.
20743 * Values <b> don't </b> work as bitmask, only one can be choosen.
20745 * @note Valid sizes are 2^zoom, consequently the map may be smaller
20746 * than the scroller view.
20748 * @see elm_map_zoom_mode_set()
20749 * @see elm_map_zoom_mode_get()
20753 typedef enum _Elm_Map_Zoom_Mode
20755 ELM_MAP_ZOOM_MODE_MANUAL, /**< Zoom controled manually by elm_map_zoom_set(). It's set by default. */
20756 ELM_MAP_ZOOM_MODE_AUTO_FIT, /**< Zoom until map fits inside the scroll frame with no pixels outside this area. */
20757 ELM_MAP_ZOOM_MODE_AUTO_FILL, /**< Zoom until map fills scroll, ensuring no pixels are left unfilled. */
20758 ELM_MAP_ZOOM_MODE_LAST
20759 } Elm_Map_Zoom_Mode;
20762 * @enum _Elm_Map_Route_Sources
20763 * @typedef Elm_Map_Route_Sources
20765 * Set route service to be used. By default used source is
20766 * #ELM_MAP_ROUTE_SOURCE_YOURS.
20768 * @see elm_map_route_source_set()
20769 * @see elm_map_route_source_get()
20773 typedef enum _Elm_Map_Route_Sources
20775 ELM_MAP_ROUTE_SOURCE_YOURS, /**< Routing service http://www.yournavigation.org/ . Set by default.*/
20776 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. */
20777 ELM_MAP_ROUTE_SOURCE_ORS, /**< Open Route Service: http://www.openrouteservice.org/ . It's not working with Map yet. */
20778 ELM_MAP_ROUTE_SOURCE_LAST
20779 } Elm_Map_Route_Sources;
20781 typedef enum _Elm_Map_Name_Sources
20783 ELM_MAP_NAME_SOURCE_NOMINATIM,
20784 ELM_MAP_NAME_SOURCE_LAST
20785 } Elm_Map_Name_Sources;
20788 * @enum _Elm_Map_Route_Type
20789 * @typedef Elm_Map_Route_Type
20791 * Set type of transport used on route.
20793 * @see elm_map_route_add()
20797 typedef enum _Elm_Map_Route_Type
20799 ELM_MAP_ROUTE_TYPE_MOTOCAR, /**< Route should consider an automobile will be used. */
20800 ELM_MAP_ROUTE_TYPE_BICYCLE, /**< Route should consider a bicycle will be used by the user. */
20801 ELM_MAP_ROUTE_TYPE_FOOT, /**< Route should consider user will be walking. */
20802 ELM_MAP_ROUTE_TYPE_LAST
20803 } Elm_Map_Route_Type;
20806 * @enum _Elm_Map_Route_Method
20807 * @typedef Elm_Map_Route_Method
20809 * Set the routing method, what should be priorized, time or distance.
20811 * @see elm_map_route_add()
20815 typedef enum _Elm_Map_Route_Method
20817 ELM_MAP_ROUTE_METHOD_FASTEST, /**< Route should priorize time. */
20818 ELM_MAP_ROUTE_METHOD_SHORTEST, /**< Route should priorize distance. */
20819 ELM_MAP_ROUTE_METHOD_LAST
20820 } Elm_Map_Route_Method;
20822 typedef enum _Elm_Map_Name_Method
20824 ELM_MAP_NAME_METHOD_SEARCH,
20825 ELM_MAP_NAME_METHOD_REVERSE,
20826 ELM_MAP_NAME_METHOD_LAST
20827 } Elm_Map_Name_Method;
20829 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(). */
20830 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(). */
20831 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(). */
20832 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(). */
20833 typedef struct _Elm_Map_Name Elm_Map_Name; /**< A handle for specific coordinates. */
20834 typedef struct _Elm_Map_Track Elm_Map_Track;
20836 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. */
20837 typedef void (*ElmMapMarkerDelFunc) (Evas_Object *obj, Elm_Map_Marker *marker, void *data, Evas_Object *o); /**< Function to delete bubble content for marker classes. */
20838 typedef Evas_Object *(*ElmMapMarkerIconGetFunc) (Evas_Object *obj, Elm_Map_Marker *marker, void *data); /**< Icon fetching class function for marker classes. */
20839 typedef Evas_Object *(*ElmMapGroupIconGetFunc) (Evas_Object *obj, void *data); /**< Icon fetching class function for markers group classes. */
20841 typedef char *(*ElmMapModuleSourceFunc) (void);
20842 typedef int (*ElmMapModuleZoomMinFunc) (void);
20843 typedef int (*ElmMapModuleZoomMaxFunc) (void);
20844 typedef char *(*ElmMapModuleUrlFunc) (Evas_Object *obj, int x, int y, int zoom);
20845 typedef int (*ElmMapModuleRouteSourceFunc) (void);
20846 typedef char *(*ElmMapModuleRouteUrlFunc) (Evas_Object *obj, char *type_name, int method, double flon, double flat, double tlon, double tlat);
20847 typedef char *(*ElmMapModuleNameUrlFunc) (Evas_Object *obj, int method, char *name, double lon, double lat);
20848 typedef Eina_Bool (*ElmMapModuleGeoIntoCoordFunc) (const Evas_Object *obj, int zoom, double lon, double lat, int size, int *x, int *y);
20849 typedef Eina_Bool (*ElmMapModuleCoordIntoGeoFunc) (const Evas_Object *obj, int zoom, int x, int y, int size, double *lon, double *lat);
20852 * Add a new map widget to the given parent Elementary (container) object.
20854 * @param parent The parent object.
20855 * @return a new map widget handle or @c NULL, on errors.
20857 * This function inserts a new map widget on the canvas.
20861 EAPI Evas_Object *elm_map_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20864 * Set the zoom level of the map.
20866 * @param obj The map object.
20867 * @param zoom The zoom level to set.
20869 * This sets the zoom level.
20871 * It will respect limits defined by elm_map_source_zoom_min_set() and
20872 * elm_map_source_zoom_max_set().
20874 * By default these values are 0 (world map) and 18 (maximum zoom).
20876 * This function should be used when zoom mode is set to
20877 * #ELM_MAP_ZOOM_MODE_MANUAL. This is the default mode, and can be set
20878 * with elm_map_zoom_mode_set().
20880 * @see elm_map_zoom_mode_set().
20881 * @see elm_map_zoom_get().
20885 EAPI void elm_map_zoom_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
20888 * Get the zoom level of the map.
20890 * @param obj The map object.
20891 * @return The current zoom level.
20893 * This returns the current zoom level of the map object.
20895 * Note that if you set the fill mode to other than #ELM_MAP_ZOOM_MODE_MANUAL
20896 * (which is the default), the zoom level may be changed at any time by the
20897 * map object itself to account for map size and map viewport size.
20899 * @see elm_map_zoom_set() for details.
20903 EAPI int elm_map_zoom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20906 * Set the zoom mode used by the map object.
20908 * @param obj The map object.
20909 * @param mode The zoom mode of the map, being it one of
20910 * #ELM_MAP_ZOOM_MODE_MANUAL (default), #ELM_MAP_ZOOM_MODE_AUTO_FIT,
20911 * or #ELM_MAP_ZOOM_MODE_AUTO_FILL.
20913 * This sets the zoom mode to manual or one of the automatic levels.
20914 * Manual (#ELM_MAP_ZOOM_MODE_MANUAL) means that zoom is set manually by
20915 * elm_map_zoom_set() and will stay at that level until changed by code
20916 * or until zoom mode is changed. This is the default mode.
20918 * The Automatic modes will allow the map object to automatically
20919 * adjust zoom mode based on properties. #ELM_MAP_ZOOM_MODE_AUTO_FIT will
20920 * adjust zoom so the map fits inside the scroll frame with no pixels
20921 * outside this area. #ELM_MAP_ZOOM_MODE_AUTO_FILL will be similar but
20922 * ensure no pixels within the frame are left unfilled. Do not forget that
20923 * the valid sizes are 2^zoom, consequently the map may be smaller than
20924 * the scroller view.
20926 * @see elm_map_zoom_set()
20930 EAPI void elm_map_zoom_mode_set(Evas_Object *obj, Elm_Map_Zoom_Mode mode) EINA_ARG_NONNULL(1);
20933 * Get the zoom mode used by the map object.
20935 * @param obj The map object.
20936 * @return The zoom mode of the map, being it one of
20937 * #ELM_MAP_ZOOM_MODE_MANUAL (default), #ELM_MAP_ZOOM_MODE_AUTO_FIT,
20938 * or #ELM_MAP_ZOOM_MODE_AUTO_FILL.
20940 * This function returns the current zoom mode used by the map object.
20942 * @see elm_map_zoom_mode_set() for more details.
20946 EAPI Elm_Map_Zoom_Mode elm_map_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20949 * Get the current coordinates of the map.
20951 * @param obj The map object.
20952 * @param lon Pointer where to store longitude.
20953 * @param lat Pointer where to store latitude.
20955 * This gets the current center coordinates of the map object. It can be
20956 * set by elm_map_geo_region_bring_in() and elm_map_geo_region_show().
20958 * @see elm_map_geo_region_bring_in()
20959 * @see elm_map_geo_region_show()
20963 EAPI void elm_map_geo_region_get(const Evas_Object *obj, double *lon, double *lat) EINA_ARG_NONNULL(1);
20966 * Animatedly bring in given coordinates to the center of the map.
20968 * @param obj The map object.
20969 * @param lon Longitude to center at.
20970 * @param lat Latitude to center at.
20972 * This causes map to jump to the given @p lat and @p lon coordinates
20973 * and show it (by scrolling) in the center of the viewport, if it is not
20974 * already centered. This will use animation to do so and take a period
20975 * of time to complete.
20977 * @see elm_map_geo_region_show() for a function to avoid animation.
20978 * @see elm_map_geo_region_get()
20982 EAPI void elm_map_geo_region_bring_in(Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
20985 * Show the given coordinates at the center of the map, @b immediately.
20987 * @param obj The map object.
20988 * @param lon Longitude to center at.
20989 * @param lat Latitude to center at.
20991 * This causes map to @b redraw its viewport's contents to the
20992 * region contining the given @p lat and @p lon, that will be moved to the
20993 * center of the map.
20995 * @see elm_map_geo_region_bring_in() for a function to move with animation.
20996 * @see elm_map_geo_region_get()
21000 EAPI void elm_map_geo_region_show(Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
21003 * Pause or unpause the map.
21005 * @param obj The map object.
21006 * @param paused Use @c EINA_TRUE to pause the map @p obj or @c EINA_FALSE
21009 * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
21012 * The default is off.
21014 * This will stop zooming using animation, changing zoom levels will
21015 * change instantly. This will stop any existing animations that are running.
21017 * @see elm_map_paused_get()
21021 EAPI void elm_map_paused_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
21024 * Get a value whether map is paused or not.
21026 * @param obj The map object.
21027 * @return @c EINA_TRUE means map is pause. @c EINA_FALSE indicates
21028 * it is not. If @p obj is @c NULL, @c EINA_FALSE is returned.
21030 * This gets the current paused state for the map object.
21032 * @see elm_map_paused_set() for details.
21036 EAPI Eina_Bool elm_map_paused_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21039 * Set to show markers during zoom level changes or not.
21041 * @param obj The map object.
21042 * @param paused Use @c EINA_TRUE to @b not show markers or @c EINA_FALSE
21045 * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
21048 * The default is off.
21050 * This will stop zooming using animation, changing zoom levels will
21051 * change instantly. This will stop any existing animations that are running.
21053 * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
21056 * The default is off.
21058 * Enabling it will force the map to stop displaying the markers during
21059 * zoom level changes. Set to on if you have a large number of markers.
21061 * @see elm_map_paused_markers_get()
21065 EAPI void elm_map_paused_markers_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
21068 * Get a value whether markers will be displayed on zoom level changes or not
21070 * @param obj The map object.
21071 * @return @c EINA_TRUE means map @b won't display markers or @c EINA_FALSE
21072 * indicates it will. If @p obj is @c NULL, @c EINA_FALSE is returned.
21074 * This gets the current markers paused state for the map object.
21076 * @see elm_map_paused_markers_set() for details.
21080 EAPI Eina_Bool elm_map_paused_markers_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21083 * Get the information of downloading status.
21085 * @param obj The map object.
21086 * @param try_num Pointer where to store number of tiles being downloaded.
21087 * @param finish_num Pointer where to store number of tiles successfully
21090 * This gets the current downloading status for the map object, the number
21091 * of tiles being downloaded and the number of tiles already downloaded.
21095 EAPI void elm_map_utils_downloading_status_get(const Evas_Object *obj, int *try_num, int *finish_num) EINA_ARG_NONNULL(1, 2, 3);
21098 * Convert a pixel coordinate (x,y) into a geographic coordinate
21099 * (longitude, latitude).
21101 * @param obj The map object.
21102 * @param x the coordinate.
21103 * @param y the coordinate.
21104 * @param size the size in pixels of the map.
21105 * The map is a square and generally his size is : pow(2.0, zoom)*256.
21106 * @param lon Pointer where to store the longitude that correspond to x.
21107 * @param lat Pointer where to store the latitude that correspond to y.
21109 * @note Origin pixel point is the top left corner of the viewport.
21110 * Map zoom and size are taken on account.
21112 * @see elm_map_utils_convert_geo_into_coord() if you need the inverse.
21116 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);
21119 * Convert a geographic coordinate (longitude, latitude) into a pixel
21120 * coordinate (x, y).
21122 * @param obj The map object.
21123 * @param lon the longitude.
21124 * @param lat the latitude.
21125 * @param size the size in pixels of the map. The map is a square
21126 * and generally his size is : pow(2.0, zoom)*256.
21127 * @param x Pointer where to store the horizontal pixel coordinate that
21128 * correspond to the longitude.
21129 * @param y Pointer where to store the vertical pixel coordinate that
21130 * correspond to the latitude.
21132 * @note Origin pixel point is the top left corner of the viewport.
21133 * Map zoom and size are taken on account.
21135 * @see elm_map_utils_convert_coord_into_geo() if you need the inverse.
21139 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);
21142 * Convert a geographic coordinate (longitude, latitude) into a name
21145 * @param obj The map object.
21146 * @param lon the longitude.
21147 * @param lat the latitude.
21148 * @return name A #Elm_Map_Name handle for this coordinate.
21150 * To get the string for this address, elm_map_name_address_get()
21153 * @see elm_map_utils_convert_name_into_coord() if you need the inverse.
21157 EAPI Elm_Map_Name *elm_map_utils_convert_coord_into_name(const Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
21160 * Convert a name (address) into a geographic coordinate
21161 * (longitude, latitude).
21163 * @param obj The map object.
21164 * @param name The address.
21165 * @return name A #Elm_Map_Name handle for this address.
21167 * To get the longitude and latitude, elm_map_name_region_get()
21170 * @see elm_map_utils_convert_coord_into_name() if you need the inverse.
21174 EAPI Elm_Map_Name *elm_map_utils_convert_name_into_coord(const Evas_Object *obj, char *address) EINA_ARG_NONNULL(1, 2);
21177 * Convert a pixel coordinate into a rotated pixel coordinate.
21179 * @param obj The map object.
21180 * @param x horizontal coordinate of the point to rotate.
21181 * @param y vertical coordinate of the point to rotate.
21182 * @param cx rotation's center horizontal position.
21183 * @param cy rotation's center vertical position.
21184 * @param degree amount of degrees from 0.0 to 360.0 to rotate arount Z axis.
21185 * @param xx Pointer where to store rotated x.
21186 * @param yy Pointer where to store rotated y.
21190 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);
21193 * Add a new marker to the map object.
21195 * @param obj The map object.
21196 * @param lon The longitude of the marker.
21197 * @param lat The latitude of the marker.
21198 * @param clas The class, to use when marker @b isn't grouped to others.
21199 * @param clas_group The class group, to use when marker is grouped to others
21200 * @param data The data passed to the callbacks.
21202 * @return The created marker or @c NULL upon failure.
21204 * A marker will be created and shown in a specific point of the map, defined
21205 * by @p lon and @p lat.
21207 * It will be displayed using style defined by @p class when this marker
21208 * is displayed alone (not grouped). A new class can be created with
21209 * elm_map_marker_class_new().
21211 * If the marker is grouped to other markers, it will be displayed with
21212 * style defined by @p class_group. Markers with the same group are grouped
21213 * if they are close. A new group class can be created with
21214 * elm_map_marker_group_class_new().
21216 * Markers created with this method can be deleted with
21217 * elm_map_marker_remove().
21219 * A marker can have associated content to be displayed by a bubble,
21220 * when a user click over it, as well as an icon. These objects will
21221 * be fetch using class' callback functions.
21223 * @see elm_map_marker_class_new()
21224 * @see elm_map_marker_group_class_new()
21225 * @see elm_map_marker_remove()
21229 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);
21232 * Set the maximum numbers of markers' content to be displayed in a group.
21234 * @param obj The map object.
21235 * @param max The maximum numbers of items displayed in a bubble.
21237 * A bubble will be displayed when the user clicks over the group,
21238 * and will place the content of markers that belong to this group
21241 * A group can have a long list of markers, consequently the creation
21242 * of the content of the bubble can be very slow.
21244 * In order to avoid this, a maximum number of items is displayed
21247 * By default this number is 30.
21249 * Marker with the same group class are grouped if they are close.
21251 * @see elm_map_marker_add()
21255 EAPI void elm_map_max_marker_per_group_set(Evas_Object *obj, int max) EINA_ARG_NONNULL(1);
21258 * Remove a marker from the map.
21260 * @param marker The marker to remove.
21262 * @see elm_map_marker_add()
21266 EAPI void elm_map_marker_remove(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
21269 * Get the current coordinates of the marker.
21271 * @param marker marker.
21272 * @param lat Pointer where to store the marker's latitude.
21273 * @param lon Pointer where to store the marker's longitude.
21275 * These values are set when adding markers, with function
21276 * elm_map_marker_add().
21278 * @see elm_map_marker_add()
21282 EAPI void elm_map_marker_region_get(const Elm_Map_Marker *marker, double *lon, double *lat) EINA_ARG_NONNULL(1);
21285 * Animatedly bring in given marker to the center of the map.
21287 * @param marker The marker to center at.
21289 * This causes map to jump to the given @p marker's coordinates
21290 * and show it (by scrolling) in the center of the viewport, if it is not
21291 * already centered. This will use animation to do so and take a period
21292 * of time to complete.
21294 * @see elm_map_marker_show() for a function to avoid animation.
21295 * @see elm_map_marker_region_get()
21299 EAPI void elm_map_marker_bring_in(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
21302 * Show the given marker at the center of the map, @b immediately.
21304 * @param marker The marker to center at.
21306 * This causes map to @b redraw its viewport's contents to the
21307 * region contining the given @p marker's coordinates, that will be
21308 * moved to the center of the map.
21310 * @see elm_map_marker_bring_in() for a function to move with animation.
21311 * @see elm_map_markers_list_show() if more than one marker need to be
21313 * @see elm_map_marker_region_get()
21317 EAPI void elm_map_marker_show(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
21320 * Move and zoom the map to display a list of markers.
21322 * @param markers A list of #Elm_Map_Marker handles.
21324 * The map will be centered on the center point of the markers in the list.
21325 * Then the map will be zoomed in order to fit the markers using the maximum
21326 * zoom which allows display of all the markers.
21328 * @warning All the markers should belong to the same map object.
21330 * @see elm_map_marker_show() to show a single marker.
21331 * @see elm_map_marker_bring_in()
21335 EAPI void elm_map_markers_list_show(Eina_List *markers) EINA_ARG_NONNULL(1);
21338 * Get the Evas object returned by the ElmMapMarkerGetFunc callback
21340 * @param marker The marker wich content should be returned.
21341 * @return Return the evas object if it exists, else @c NULL.
21343 * To set callback function #ElmMapMarkerGetFunc for the marker class,
21344 * elm_map_marker_class_get_cb_set() should be used.
21346 * This content is what will be inside the bubble that will be displayed
21347 * when an user clicks over the marker.
21349 * This returns the actual Evas object used to be placed inside
21350 * the bubble. This may be @c NULL, as it may
21351 * not have been created or may have been deleted, at any time, by
21352 * the map. <b>Do not modify this object</b> (move, resize,
21353 * show, hide, etc.), as the map is controlling it. This
21354 * function is for querying, emitting custom signals or hooking
21355 * lower level callbacks for events on that object. Do not delete
21356 * this object under any circumstances.
21360 EAPI Evas_Object *elm_map_marker_object_get(const Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
21363 * Update the marker
21365 * @param marker The marker to be updated.
21367 * If a content is set to this marker, it will call function to delete it,
21368 * #ElmMapMarkerDelFunc, and then will fetch the content again with
21369 * #ElmMapMarkerGetFunc.
21371 * These functions are set for the marker class with
21372 * elm_map_marker_class_get_cb_set() and elm_map_marker_class_del_cb_set().
21376 EAPI void elm_map_marker_update(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
21379 * Close all the bubbles opened by the user.
21381 * @param obj The map object.
21383 * A bubble is displayed with a content fetched with #ElmMapMarkerGetFunc
21384 * when the user clicks on a marker.
21386 * This functions is set for the marker class with
21387 * elm_map_marker_class_get_cb_set().
21391 EAPI void elm_map_bubbles_close(Evas_Object *obj) EINA_ARG_NONNULL(1);
21394 * Create a new group class.
21396 * @param obj The map object.
21397 * @return Returns the new group class.
21399 * Each marker must be associated to a group class. Markers in the same
21400 * group are grouped if they are close.
21402 * The group class defines the style of the marker when a marker is grouped
21403 * to others markers. When it is alone, another class will be used.
21405 * A group class will need to be provided when creating a marker with
21406 * elm_map_marker_add().
21408 * Some properties and functions can be set by class, as:
21409 * - style, with elm_map_group_class_style_set()
21410 * - data - to be associated to the group class. It can be set using
21411 * elm_map_group_class_data_set().
21412 * - min zoom to display markers, set with
21413 * elm_map_group_class_zoom_displayed_set().
21414 * - max zoom to group markers, set using
21415 * elm_map_group_class_zoom_grouped_set().
21416 * - visibility - set if markers will be visible or not, set with
21417 * elm_map_group_class_hide_set().
21418 * - #ElmMapGroupIconGetFunc - used to fetch icon for markers group classes.
21419 * It can be set using elm_map_group_class_icon_cb_set().
21421 * @see elm_map_marker_add()
21422 * @see elm_map_group_class_style_set()
21423 * @see elm_map_group_class_data_set()
21424 * @see elm_map_group_class_zoom_displayed_set()
21425 * @see elm_map_group_class_zoom_grouped_set()
21426 * @see elm_map_group_class_hide_set()
21427 * @see elm_map_group_class_icon_cb_set()
21431 EAPI Elm_Map_Group_Class *elm_map_group_class_new(Evas_Object *obj) EINA_ARG_NONNULL(1);
21434 * Set the marker's style of a group class.
21436 * @param clas The group class.
21437 * @param style The style to be used by markers.
21439 * Each marker must be associated to a group class, and will use the style
21440 * defined by such class when grouped to other markers.
21442 * The following styles are provided by default theme:
21443 * @li @c radio - blue circle
21444 * @li @c radio2 - green circle
21447 * @see elm_map_group_class_new() for more details.
21448 * @see elm_map_marker_add()
21452 EAPI void elm_map_group_class_style_set(Elm_Map_Group_Class *clas, const char *style) EINA_ARG_NONNULL(1);
21455 * Set the icon callback function of a group class.
21457 * @param clas The group class.
21458 * @param icon_get The callback function that will return the icon.
21460 * Each marker must be associated to a group class, and it can display a
21461 * custom icon. The function @p icon_get must return this icon.
21463 * @see elm_map_group_class_new() for more details.
21464 * @see elm_map_marker_add()
21468 EAPI void elm_map_group_class_icon_cb_set(Elm_Map_Group_Class *clas, ElmMapGroupIconGetFunc icon_get) EINA_ARG_NONNULL(1);
21471 * Set the data associated to the group class.
21473 * @param clas The group class.
21474 * @param data The new user data.
21476 * This data will be passed for callback functions, like icon get callback,
21477 * that can be set with elm_map_group_class_icon_cb_set().
21479 * If a data was previously set, the object will lose the pointer for it,
21480 * so if needs to be freed, you must do it yourself.
21482 * @see elm_map_group_class_new() for more details.
21483 * @see elm_map_group_class_icon_cb_set()
21484 * @see elm_map_marker_add()
21488 EAPI void elm_map_group_class_data_set(Elm_Map_Group_Class *clas, void *data) EINA_ARG_NONNULL(1);
21491 * Set the minimum zoom from where the markers are displayed.
21493 * @param clas The group class.
21494 * @param zoom The minimum zoom.
21496 * Markers only will be displayed when the map is displayed at @p zoom
21499 * @see elm_map_group_class_new() for more details.
21500 * @see elm_map_marker_add()
21504 EAPI void elm_map_group_class_zoom_displayed_set(Elm_Map_Group_Class *clas, int zoom) EINA_ARG_NONNULL(1);
21507 * Set the zoom from where the markers are no more grouped.
21509 * @param clas The group class.
21510 * @param zoom The maximum zoom.
21512 * Markers only will be grouped when the map is displayed at
21513 * less than @p zoom.
21515 * @see elm_map_group_class_new() for more details.
21516 * @see elm_map_marker_add()
21520 EAPI void elm_map_group_class_zoom_grouped_set(Elm_Map_Group_Class *clas, int zoom) EINA_ARG_NONNULL(1);
21523 * Set if the markers associated to the group class @clas are hidden or not.
21525 * @param clas The group class.
21526 * @param hide Use @c EINA_TRUE to hide markers or @c EINA_FALSE
21529 * If @p hide is @c EINA_TRUE the markers will be hidden, but default
21534 EAPI void elm_map_group_class_hide_set(Evas_Object *obj, Elm_Map_Group_Class *clas, Eina_Bool hide) EINA_ARG_NONNULL(1, 2);
21537 * Create a new marker class.
21539 * @param obj The map object.
21540 * @return Returns the new group class.
21542 * Each marker must be associated to a class.
21544 * The marker class defines the style of the marker when a marker is
21545 * displayed alone, i.e., not grouped to to others markers. When grouped
21546 * it will use group class style.
21548 * A marker class will need to be provided when creating a marker with
21549 * elm_map_marker_add().
21551 * Some properties and functions can be set by class, as:
21552 * - style, with elm_map_marker_class_style_set()
21553 * - #ElmMapMarkerIconGetFunc - used to fetch icon for markers classes.
21554 * It can be set using elm_map_marker_class_icon_cb_set().
21555 * - #ElmMapMarkerGetFunc - used to fetch bubble content for marker classes.
21556 * Set using elm_map_marker_class_get_cb_set().
21557 * - #ElmMapMarkerDelFunc - used to delete bubble content for marker classes.
21558 * Set using elm_map_marker_class_del_cb_set().
21560 * @see elm_map_marker_add()
21561 * @see elm_map_marker_class_style_set()
21562 * @see elm_map_marker_class_icon_cb_set()
21563 * @see elm_map_marker_class_get_cb_set()
21564 * @see elm_map_marker_class_del_cb_set()
21568 EAPI Elm_Map_Marker_Class *elm_map_marker_class_new(Evas_Object *obj) EINA_ARG_NONNULL(1);
21571 * Set the marker's style of a marker class.
21573 * @param clas The marker class.
21574 * @param style The style to be used by markers.
21576 * Each marker must be associated to a marker class, and will use the style
21577 * defined by such class when alone, i.e., @b not grouped to other markers.
21579 * The following styles are provided by default theme:
21584 * @see elm_map_marker_class_new() for more details.
21585 * @see elm_map_marker_add()
21589 EAPI void elm_map_marker_class_style_set(Elm_Map_Marker_Class *clas, const char *style) EINA_ARG_NONNULL(1);
21592 * Set the icon callback function of a marker class.
21594 * @param clas The marker class.
21595 * @param icon_get The callback function that will return the icon.
21597 * Each marker must be associated to a marker class, and it can display a
21598 * custom icon. The function @p icon_get must return this icon.
21600 * @see elm_map_marker_class_new() for more details.
21601 * @see elm_map_marker_add()
21605 EAPI void elm_map_marker_class_icon_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerIconGetFunc icon_get) EINA_ARG_NONNULL(1);
21608 * Set the bubble content callback function of a marker class.
21610 * @param clas The marker class.
21611 * @param get The callback function that will return the content.
21613 * Each marker must be associated to a marker class, and it can display a
21614 * a content on a bubble that opens when the user click over the marker.
21615 * The function @p get must return this content object.
21617 * If this content will need to be deleted, elm_map_marker_class_del_cb_set()
21620 * @see elm_map_marker_class_new() for more details.
21621 * @see elm_map_marker_class_del_cb_set()
21622 * @see elm_map_marker_add()
21626 EAPI void elm_map_marker_class_get_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerGetFunc get) EINA_ARG_NONNULL(1);
21629 * Set the callback function used to delete bubble content of a marker class.
21631 * @param clas The marker class.
21632 * @param del The callback function that will delete the content.
21634 * Each marker must be associated to a marker class, and it can display a
21635 * a content on a bubble that opens when the user click over the marker.
21636 * The function to return such content can be set with
21637 * elm_map_marker_class_get_cb_set().
21639 * If this content must be freed, a callback function need to be
21640 * set for that task with this function.
21642 * If this callback is defined it will have to delete (or not) the
21643 * object inside, but if the callback is not defined the object will be
21644 * destroyed with evas_object_del().
21646 * @see elm_map_marker_class_new() for more details.
21647 * @see elm_map_marker_class_get_cb_set()
21648 * @see elm_map_marker_add()
21652 EAPI void elm_map_marker_class_del_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerDelFunc del) EINA_ARG_NONNULL(1);
21655 * Get the list of available sources.
21657 * @param obj The map object.
21658 * @return The source names list.
21660 * It will provide a list with all available sources, that can be set as
21661 * current source with elm_map_source_name_set(), or get with
21662 * elm_map_source_name_get().
21664 * Available sources:
21670 * @see elm_map_source_name_set() for more details.
21671 * @see elm_map_source_name_get()
21675 EAPI const char **elm_map_source_names_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21678 * Set the source of the map.
21680 * @param obj The map object.
21681 * @param source The source to be used.
21683 * Map widget retrieves images that composes the map from a web service.
21684 * This web service can be set with this method.
21686 * A different service can return a different maps with different
21687 * information and it can use different zoom values.
21689 * The @p source_name need to match one of the names provided by
21690 * elm_map_source_names_get().
21692 * The current source can be get using elm_map_source_name_get().
21694 * @see elm_map_source_names_get()
21695 * @see elm_map_source_name_get()
21700 EAPI void elm_map_source_name_set(Evas_Object *obj, const char *source_name) EINA_ARG_NONNULL(1);
21703 * Get the name of currently used source.
21705 * @param obj The map object.
21706 * @return Returns the name of the source in use.
21708 * @see elm_map_source_name_set() for more details.
21712 EAPI const char *elm_map_source_name_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21715 * Set the source of the route service to be used by the map.
21717 * @param obj The map object.
21718 * @param source The route service to be used, being it one of
21719 * #ELM_MAP_ROUTE_SOURCE_YOURS (default), #ELM_MAP_ROUTE_SOURCE_MONAV,
21720 * and #ELM_MAP_ROUTE_SOURCE_ORS.
21722 * Each one has its own algorithm, so the route retrieved may
21723 * differ depending on the source route. Now, only the default is working.
21725 * #ELM_MAP_ROUTE_SOURCE_YOURS is the routing service provided at
21726 * http://www.yournavigation.org/.
21728 * #ELM_MAP_ROUTE_SOURCE_MONAV, offers exact routing without heuristic
21729 * assumptions. Its routing core is based on Contraction Hierarchies.
21731 * #ELM_MAP_ROUTE_SOURCE_ORS, is provided at http://www.openrouteservice.org/
21733 * @see elm_map_route_source_get().
21737 EAPI void elm_map_route_source_set(Evas_Object *obj, Elm_Map_Route_Sources source) EINA_ARG_NONNULL(1);
21740 * Get the current route source.
21742 * @param obj The map object.
21743 * @return The source of the route service used by the map.
21745 * @see elm_map_route_source_set() for details.
21749 EAPI Elm_Map_Route_Sources elm_map_route_source_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21752 * Set the minimum zoom of the source.
21754 * @param obj The map object.
21755 * @param zoom New minimum zoom value to be used.
21757 * By default, it's 0.
21761 EAPI void elm_map_source_zoom_min_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
21764 * Get the minimum zoom of the source.
21766 * @param obj The map object.
21767 * @return Returns the minimum zoom of the source.
21769 * @see elm_map_source_zoom_min_set() for details.
21773 EAPI int elm_map_source_zoom_min_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21776 * Set the maximum zoom of the source.
21778 * @param obj The map object.
21779 * @param zoom New maximum zoom value to be used.
21781 * By default, it's 18.
21785 EAPI void elm_map_source_zoom_max_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
21788 * Get the maximum zoom of the source.
21790 * @param obj The map object.
21791 * @return Returns the maximum zoom of the source.
21793 * @see elm_map_source_zoom_min_set() for details.
21797 EAPI int elm_map_source_zoom_max_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21800 * Set the user agent used by the map object to access routing services.
21802 * @param obj The map object.
21803 * @param user_agent The user agent to be used by the map.
21805 * User agent is a client application implementing a network protocol used
21806 * in communications within a client–server distributed computing system
21808 * The @p user_agent identification string will transmitted in a header
21809 * field @c User-Agent.
21811 * @see elm_map_user_agent_get()
21815 EAPI void elm_map_user_agent_set(Evas_Object *obj, const char *user_agent) EINA_ARG_NONNULL(1, 2);
21818 * Get the user agent used by the map object.
21820 * @param obj The map object.
21821 * @return The user agent identification string used by the map.
21823 * @see elm_map_user_agent_set() for details.
21827 EAPI const char *elm_map_user_agent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21830 * Add a new route to the map object.
21832 * @param obj The map object.
21833 * @param type The type of transport to be considered when tracing a route.
21834 * @param method The routing method, what should be priorized.
21835 * @param flon The start longitude.
21836 * @param flat The start latitude.
21837 * @param tlon The destination longitude.
21838 * @param tlat The destination latitude.
21840 * @return The created route or @c NULL upon failure.
21842 * A route will be traced by point on coordinates (@p flat, @p flon)
21843 * to point on coordinates (@p tlat, @p tlon), using the route service
21844 * set with elm_map_route_source_set().
21846 * It will take @p type on consideration to define the route,
21847 * depending if the user will be walking or driving, the route may vary.
21848 * One of #ELM_MAP_ROUTE_TYPE_MOTOCAR, #ELM_MAP_ROUTE_TYPE_BICYCLE, or
21849 * #ELM_MAP_ROUTE_TYPE_FOOT need to be used.
21851 * Another parameter is what the route should priorize, the minor distance
21852 * or the less time to be spend on the route. So @p method should be one
21853 * of #ELM_MAP_ROUTE_METHOD_SHORTEST or #ELM_MAP_ROUTE_METHOD_FASTEST.
21855 * Routes created with this method can be deleted with
21856 * elm_map_route_remove(), colored with elm_map_route_color_set(),
21857 * and distance can be get with elm_map_route_distance_get().
21859 * @see elm_map_route_remove()
21860 * @see elm_map_route_color_set()
21861 * @see elm_map_route_distance_get()
21862 * @see elm_map_route_source_set()
21866 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);
21869 * Remove a route from the map.
21871 * @param route The route to remove.
21873 * @see elm_map_route_add()
21877 EAPI void elm_map_route_remove(Elm_Map_Route *route) EINA_ARG_NONNULL(1);
21880 * Set the route color.
21882 * @param route The route object.
21883 * @param r Red channel value, from 0 to 255.
21884 * @param g Green channel value, from 0 to 255.
21885 * @param b Blue channel value, from 0 to 255.
21886 * @param a Alpha channel value, from 0 to 255.
21888 * It uses an additive color model, so each color channel represents
21889 * how much of each primary colors must to be used. 0 represents
21890 * ausence of this color, so if all of the three are set to 0,
21891 * the color will be black.
21893 * These component values should be integers in the range 0 to 255,
21894 * (single 8-bit byte).
21896 * This sets the color used for the route. By default, it is set to
21897 * solid red (r = 255, g = 0, b = 0, a = 255).
21899 * For alpha channel, 0 represents completely transparent, and 255, opaque.
21901 * @see elm_map_route_color_get()
21905 EAPI void elm_map_route_color_set(Elm_Map_Route *route, int r, int g , int b, int a) EINA_ARG_NONNULL(1);
21908 * Get the route color.
21910 * @param route The route object.
21911 * @param r Pointer where to store the red channel value.
21912 * @param g Pointer where to store the green channel value.
21913 * @param b Pointer where to store the blue channel value.
21914 * @param a Pointer where to store the alpha channel value.
21916 * @see elm_map_route_color_set() for details.
21920 EAPI void elm_map_route_color_get(const Elm_Map_Route *route, int *r, int *g , int *b, int *a) EINA_ARG_NONNULL(1);
21923 * Get the route distance in kilometers.
21925 * @param route The route object.
21926 * @return The distance of route (unit : km).
21930 EAPI double elm_map_route_distance_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
21933 * Get the information of route nodes.
21935 * @param route The route object.
21936 * @return Returns a string with the nodes of route.
21940 EAPI const char *elm_map_route_node_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
21943 * Get the information of route waypoint.
21945 * @param route the route object.
21946 * @return Returns a string with information about waypoint of route.
21950 EAPI const char *elm_map_route_waypoint_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
21953 * Get the address of the name.
21955 * @param name The name handle.
21956 * @return Returns the address string of @p name.
21958 * This gets the coordinates of the @p name, created with one of the
21959 * conversion functions.
21961 * @see elm_map_utils_convert_name_into_coord()
21962 * @see elm_map_utils_convert_coord_into_name()
21966 EAPI const char *elm_map_name_address_get(const Elm_Map_Name *name) EINA_ARG_NONNULL(1);
21969 * Get the current coordinates of the name.
21971 * @param name The name handle.
21972 * @param lat Pointer where to store the latitude.
21973 * @param lon Pointer where to store The longitude.
21975 * This gets the coordinates of the @p name, created with one of the
21976 * conversion functions.
21978 * @see elm_map_utils_convert_name_into_coord()
21979 * @see elm_map_utils_convert_coord_into_name()
21983 EAPI void elm_map_name_region_get(const Elm_Map_Name *name, double *lon, double *lat) EINA_ARG_NONNULL(1);
21986 * Remove a name from the map.
21988 * @param name The name to remove.
21990 * Basically the struct handled by @p name will be freed, so convertions
21991 * between address and coordinates will be lost.
21993 * @see elm_map_utils_convert_name_into_coord()
21994 * @see elm_map_utils_convert_coord_into_name()
21998 EAPI void elm_map_name_remove(Elm_Map_Name *name) EINA_ARG_NONNULL(1);
22003 * @param obj The map object.
22004 * @param degree Angle from 0.0 to 360.0 to rotate arount Z axis.
22005 * @param cx Rotation's center horizontal position.
22006 * @param cy Rotation's center vertical position.
22008 * @see elm_map_rotate_get()
22012 EAPI void elm_map_rotate_set(Evas_Object *obj, double degree, Evas_Coord cx, Evas_Coord cy) EINA_ARG_NONNULL(1);
22015 * Get the rotate degree of the map
22017 * @param obj The map object
22018 * @param degree Pointer where to store degrees from 0.0 to 360.0
22019 * to rotate arount Z axis.
22020 * @param cx Pointer where to store rotation's center horizontal position.
22021 * @param cy Pointer where to store rotation's center vertical position.
22023 * @see elm_map_rotate_set() to set map rotation.
22027 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);
22030 * Enable or disable mouse wheel to be used to zoom in / out the map.
22032 * @param obj The map object.
22033 * @param disabled Use @c EINA_TRUE to disable mouse wheel or @c EINA_FALSE
22036 * Mouse wheel can be used for the user to zoom in or zoom out the map.
22038 * It's disabled by default.
22040 * @see elm_map_wheel_disabled_get()
22044 EAPI void elm_map_wheel_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
22047 * Get a value whether mouse wheel is enabled or not.
22049 * @param obj The map object.
22050 * @return @c EINA_TRUE means map is disabled. @c EINA_FALSE indicates
22051 * it is enabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
22053 * Mouse wheel can be used for the user to zoom in or zoom out the map.
22055 * @see elm_map_wheel_disabled_set() for details.
22059 EAPI Eina_Bool elm_map_wheel_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22063 * Add a track on the map
22065 * @param obj The map object.
22066 * @param emap The emap route object.
22067 * @return The route object. This is an elm object of type Route.
22069 * @see elm_route_add() for details.
22073 EAPI Evas_Object *elm_map_track_add(Evas_Object *obj, EMap_Route *emap) EINA_ARG_NONNULL(1);
22077 * Remove a track from the map
22079 * @param obj The map object.
22080 * @param route The track to remove.
22084 EAPI void elm_map_track_remove(Evas_Object *obj, Evas_Object *route) EINA_ARG_NONNULL(1);
22091 EAPI Evas_Object *elm_route_add(Evas_Object *parent);
22093 EAPI void elm_route_emap_set(Evas_Object *obj, EMap_Route *emap);
22095 EAPI double elm_route_lon_min_get(Evas_Object *obj);
22096 EAPI double elm_route_lat_min_get(Evas_Object *obj);
22097 EAPI double elm_route_lon_max_get(Evas_Object *obj);
22098 EAPI double elm_route_lat_max_get(Evas_Object *obj);
22102 * @defgroup Panel Panel
22104 * @image html img/widget/panel/preview-00.png
22105 * @image latex img/widget/panel/preview-00.eps
22107 * @brief A panel is a type of animated container that contains subobjects.
22108 * It can be expanded or contracted by clicking the button on it's edge.
22110 * Orientations are as follows:
22111 * @li ELM_PANEL_ORIENT_TOP
22112 * @li ELM_PANEL_ORIENT_LEFT
22113 * @li ELM_PANEL_ORIENT_RIGHT
22115 * @ref tutorial_panel shows one way to use this widget.
22118 typedef enum _Elm_Panel_Orient
22120 ELM_PANEL_ORIENT_TOP, /**< Panel (dis)appears from the top */
22121 ELM_PANEL_ORIENT_BOTTOM, /**< Not implemented */
22122 ELM_PANEL_ORIENT_LEFT, /**< Panel (dis)appears from the left */
22123 ELM_PANEL_ORIENT_RIGHT, /**< Panel (dis)appears from the right */
22124 } Elm_Panel_Orient;
22126 * @brief Adds a panel object
22128 * @param parent The parent object
22130 * @return The panel object, or NULL on failure
22132 EAPI Evas_Object *elm_panel_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22134 * @brief Sets the orientation of the panel
22136 * @param parent The parent object
22137 * @param orient The panel orientation. Can be one of the following:
22138 * @li ELM_PANEL_ORIENT_TOP
22139 * @li ELM_PANEL_ORIENT_LEFT
22140 * @li ELM_PANEL_ORIENT_RIGHT
22142 * Sets from where the panel will (dis)appear.
22144 EAPI void elm_panel_orient_set(Evas_Object *obj, Elm_Panel_Orient orient) EINA_ARG_NONNULL(1);
22146 * @brief Get the orientation of the panel.
22148 * @param obj The panel object
22149 * @return The Elm_Panel_Orient, or ELM_PANEL_ORIENT_LEFT on failure.
22151 EAPI Elm_Panel_Orient elm_panel_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22153 * @brief Set the content of the panel.
22155 * @param obj The panel object
22156 * @param content The panel content
22158 * Once the content object is set, a previously set one will be deleted.
22159 * If you want to keep that old content object, use the
22160 * elm_panel_content_unset() function.
22162 EAPI void elm_panel_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
22164 * @brief Get the content of the panel.
22166 * @param obj The panel object
22167 * @return The content that is being used
22169 * Return the content object which is set for this widget.
22171 * @see elm_panel_content_set()
22173 EAPI Evas_Object *elm_panel_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22175 * @brief Unset the content of the panel.
22177 * @param obj The panel object
22178 * @return The content that was being used
22180 * Unparent and return the content object which was set for this widget.
22182 * @see elm_panel_content_set()
22184 EAPI Evas_Object *elm_panel_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
22186 * @brief Set the state of the panel.
22188 * @param obj The panel object
22189 * @param hidden If true, the panel will run the animation to contract
22191 EAPI void elm_panel_hidden_set(Evas_Object *obj, Eina_Bool hidden) EINA_ARG_NONNULL(1);
22193 * @brief Get the state of the panel.
22195 * @param obj The panel object
22196 * @param hidden If true, the panel is in the "hide" state
22198 EAPI Eina_Bool elm_panel_hidden_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22200 * @brief Toggle the hidden state of the panel from code
22202 * @param obj The panel object
22204 EAPI void elm_panel_toggle(Evas_Object *obj) EINA_ARG_NONNULL(1);
22210 * @defgroup Panes Panes
22211 * @ingroup Elementary
22213 * @image html img/widget/panes/preview-00.png
22214 * @image latex img/widget/panes/preview-00.eps width=\textwidth
22216 * @image html img/panes.png
22217 * @image latex img/panes.eps width=\textwidth
22219 * The panes adds a dragable bar between two contents. When dragged
22220 * this bar will resize contents size.
22222 * Panes can be displayed vertically or horizontally, and contents
22223 * size proportion can be customized (homogeneous by default).
22225 * Smart callbacks one can listen to:
22226 * - "press" - The panes has been pressed (button wasn't released yet).
22227 * - "unpressed" - The panes was released after being pressed.
22228 * - "clicked" - The panes has been clicked>
22229 * - "clicked,double" - The panes has been double clicked
22231 * Available styles for it:
22234 * Here is an example on its usage:
22235 * @li @ref panes_example
22239 * @addtogroup Panes
22244 * Add a new panes widget to the given parent Elementary
22245 * (container) object.
22247 * @param parent The parent object.
22248 * @return a new panes widget handle or @c NULL, on errors.
22250 * This function inserts a new panes widget on the canvas.
22254 EAPI Evas_Object *elm_panes_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22257 * Set the left content of the panes widget.
22259 * @param obj The panes object.
22260 * @param content The new left content object.
22262 * Once the content object is set, a previously set one will be deleted.
22263 * If you want to keep that old content object, use the
22264 * elm_panes_content_left_unset() function.
22266 * If panes is displayed vertically, left content will be displayed at
22269 * @see elm_panes_content_left_get()
22270 * @see elm_panes_content_right_set() to set content on the other side.
22274 EAPI void elm_panes_content_left_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
22277 * Set the right content of the panes widget.
22279 * @param obj The panes object.
22280 * @param content The new right content object.
22282 * Once the content object is set, a previously set one will be deleted.
22283 * If you want to keep that old content object, use the
22284 * elm_panes_content_right_unset() function.
22286 * If panes is displayed vertically, left content will be displayed at
22289 * @see elm_panes_content_right_get()
22290 * @see elm_panes_content_left_set() to set content on the other side.
22294 EAPI void elm_panes_content_right_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
22297 * Get the left content of the panes.
22299 * @param obj The panes object.
22300 * @return The left content object that is being used.
22302 * Return the left content object which is set for this widget.
22304 * @see elm_panes_content_left_set() for details.
22308 EAPI Evas_Object *elm_panes_content_left_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22311 * Get the right content of the panes.
22313 * @param obj The panes object
22314 * @return The right content object that is being used
22316 * Return the right content object which is set for this widget.
22318 * @see elm_panes_content_right_set() for details.
22322 EAPI Evas_Object *elm_panes_content_right_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22325 * Unset the left content used for the panes.
22327 * @param obj The panes object.
22328 * @return The left content object that was being used.
22330 * Unparent and return the left content object which was set for this widget.
22332 * @see elm_panes_content_left_set() for details.
22333 * @see elm_panes_content_left_get().
22337 EAPI Evas_Object *elm_panes_content_left_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
22340 * Unset the right content used for the panes.
22342 * @param obj The panes object.
22343 * @return The right content object that was being used.
22345 * Unparent and return the right content object which was set for this
22348 * @see elm_panes_content_right_set() for details.
22349 * @see elm_panes_content_right_get().
22353 EAPI Evas_Object *elm_panes_content_right_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
22356 * Get the size proportion of panes widget's left side.
22358 * @param obj The panes object.
22359 * @return float value between 0.0 and 1.0 representing size proportion
22362 * @see elm_panes_content_left_size_set() for more details.
22366 EAPI double elm_panes_content_left_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22369 * Set the size proportion of panes widget's left side.
22371 * @param obj The panes object.
22372 * @param size Value between 0.0 and 1.0 representing size proportion
22375 * By default it's homogeneous, i.e., both sides have the same size.
22377 * If something different is required, it can be set with this function.
22378 * For example, if the left content should be displayed over
22379 * 75% of the panes size, @p size should be passed as @c 0.75.
22380 * This way, right content will be resized to 25% of panes size.
22382 * If displayed vertically, left content is displayed at top, and
22383 * right content at bottom.
22385 * @note This proportion will change when user drags the panes bar.
22387 * @see elm_panes_content_left_size_get()
22391 EAPI void elm_panes_content_left_size_set(Evas_Object *obj, double size) EINA_ARG_NONNULL(1);
22394 * Set the orientation of a given panes widget.
22396 * @param obj The panes object.
22397 * @param horizontal Use @c EINA_TRUE to make @p obj to be
22398 * @b horizontal, @c EINA_FALSE to make it @b vertical.
22400 * Use this function to change how your panes is to be
22401 * disposed: vertically or horizontally.
22403 * By default it's displayed horizontally.
22405 * @see elm_panes_horizontal_get()
22409 EAPI void elm_panes_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
22412 * Retrieve the orientation of a given panes widget.
22414 * @param obj The panes object.
22415 * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
22416 * @c EINA_FALSE if it's @b vertical (and on errors).
22418 * @see elm_panes_horizontal_set() for more details.
22422 EAPI Eina_Bool elm_panes_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22429 * @defgroup Flip Flip
22431 * @image html img/widget/flip/preview-00.png
22432 * @image latex img/widget/flip/preview-00.eps
22434 * This widget holds 2 content objects(Evas_Object): one on the front and one
22435 * on the back. It allows you to flip from front to back and vice-versa using
22436 * various animations.
22438 * If either the front or back contents are not set the flip will treat that
22439 * as transparent. So if you wore to set the front content but not the back,
22440 * and then call elm_flip_go() you would see whatever is below the flip.
22442 * For a list of supported animations see elm_flip_go().
22444 * Signals that you can add callbacks for are:
22445 * "animate,begin" - when a flip animation was started
22446 * "animate,done" - when a flip animation is finished
22448 * @ref tutorial_flip show how to use most of the API.
22452 typedef enum _Elm_Flip_Mode
22454 ELM_FLIP_ROTATE_Y_CENTER_AXIS,
22455 ELM_FLIP_ROTATE_X_CENTER_AXIS,
22456 ELM_FLIP_ROTATE_XZ_CENTER_AXIS,
22457 ELM_FLIP_ROTATE_YZ_CENTER_AXIS,
22458 ELM_FLIP_CUBE_LEFT,
22459 ELM_FLIP_CUBE_RIGHT,
22461 ELM_FLIP_CUBE_DOWN,
22462 ELM_FLIP_PAGE_LEFT,
22463 ELM_FLIP_PAGE_RIGHT,
22467 typedef enum _Elm_Flip_Interaction
22469 ELM_FLIP_INTERACTION_NONE,
22470 ELM_FLIP_INTERACTION_ROTATE,
22471 ELM_FLIP_INTERACTION_CUBE,
22472 ELM_FLIP_INTERACTION_PAGE
22473 } Elm_Flip_Interaction;
22474 typedef enum _Elm_Flip_Direction
22476 ELM_FLIP_DIRECTION_UP, /**< Allows interaction with the top of the widget */
22477 ELM_FLIP_DIRECTION_DOWN, /**< Allows interaction with the bottom of the widget */
22478 ELM_FLIP_DIRECTION_LEFT, /**< Allows interaction with the left portion of the widget */
22479 ELM_FLIP_DIRECTION_RIGHT /**< Allows interaction with the right portion of the widget */
22480 } Elm_Flip_Direction;
22482 * @brief Add a new flip to the parent
22484 * @param parent The parent object
22485 * @return The new object or NULL if it cannot be created
22487 EAPI Evas_Object *elm_flip_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22489 * @brief Set the front content of the flip widget.
22491 * @param obj The flip object
22492 * @param content The new front content object
22494 * Once the content object is set, a previously set one will be deleted.
22495 * If you want to keep that old content object, use the
22496 * elm_flip_content_front_unset() function.
22498 EAPI void elm_flip_content_front_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
22500 * @brief Set the back content of the flip widget.
22502 * @param obj The flip object
22503 * @param content The new back content object
22505 * Once the content object is set, a previously set one will be deleted.
22506 * If you want to keep that old content object, use the
22507 * elm_flip_content_back_unset() function.
22509 EAPI void elm_flip_content_back_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
22511 * @brief Get the front content used for the flip
22513 * @param obj The flip object
22514 * @return The front content object that is being used
22516 * Return the front content object which is set for this widget.
22518 EAPI Evas_Object *elm_flip_content_front_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22520 * @brief Get the back content used for the flip
22522 * @param obj The flip object
22523 * @return The back content object that is being used
22525 * Return the back content object which is set for this widget.
22527 EAPI Evas_Object *elm_flip_content_back_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22529 * @brief Unset the front content used for the flip
22531 * @param obj The flip object
22532 * @return The front content object that was being used
22534 * Unparent and return the front content object which was set for this widget.
22536 EAPI Evas_Object *elm_flip_content_front_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
22538 * @brief Unset the back content used for the flip
22540 * @param obj The flip object
22541 * @return The back content object that was being used
22543 * Unparent and return the back content object which was set for this widget.
22545 EAPI Evas_Object *elm_flip_content_back_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
22547 * @brief Get flip front visibility state
22549 * @param obj The flip objct
22550 * @return EINA_TRUE if front front is showing, EINA_FALSE if the back is
22553 EAPI Eina_Bool elm_flip_front_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22555 * @brief Set flip perspective
22557 * @param obj The flip object
22558 * @param foc The coordinate to set the focus on
22559 * @param x The X coordinate
22560 * @param y The Y coordinate
22562 * @warning This function currently does nothing.
22564 EAPI void elm_flip_perspective_set(Evas_Object *obj, Evas_Coord foc, Evas_Coord x, Evas_Coord y) EINA_ARG_NONNULL(1);
22566 * @brief Runs the flip animation
22568 * @param obj The flip object
22569 * @param mode The mode type
22571 * Flips the front and back contents using the @p mode animation. This
22572 * efectively hides the currently visible content and shows the hidden one.
22574 * There a number of possible animations to use for the flipping:
22575 * @li ELM_FLIP_ROTATE_X_CENTER_AXIS - Rotate the currently visible content
22576 * around a horizontal axis in the middle of its height, the other content
22577 * is shown as the other side of the flip.
22578 * @li ELM_FLIP_ROTATE_Y_CENTER_AXIS - Rotate the currently visible content
22579 * around a vertical axis in the middle of its width, the other content is
22580 * shown as the other side of the flip.
22581 * @li ELM_FLIP_ROTATE_XZ_CENTER_AXIS - Rotate the currently visible content
22582 * around a diagonal axis in the middle of its width, the other content is
22583 * shown as the other side of the flip.
22584 * @li ELM_FLIP_ROTATE_YZ_CENTER_AXIS - Rotate the currently visible content
22585 * around a diagonal axis in the middle of its height, the other content is
22586 * shown as the other side of the flip.
22587 * @li ELM_FLIP_CUBE_LEFT - Rotate the currently visible content to the left
22588 * as if the flip was a cube, the other content is show as the right face of
22590 * @li ELM_FLIP_CUBE_RIGHT - Rotate the currently visible content to the
22591 * right as if the flip was a cube, the other content is show as the left
22592 * face of the cube.
22593 * @li ELM_FLIP_CUBE_UP - Rotate the currently visible content up as if the
22594 * flip was a cube, the other content is show as the bottom face of the cube.
22595 * @li ELM_FLIP_CUBE_DOWN - Rotate the currently visible content down as if
22596 * the flip was a cube, the other content is show as the upper face of the
22598 * @li ELM_FLIP_PAGE_LEFT - Move the currently visible content to the left as
22599 * if the flip was a book, the other content is shown as the page below that.
22600 * @li ELM_FLIP_PAGE_RIGHT - Move the currently visible content to the right
22601 * as if the flip was a book, the other content is shown as the page below
22603 * @li ELM_FLIP_PAGE_UP - Move the currently visible content up as if the
22604 * flip was a book, the other content is shown as the page below that.
22605 * @li ELM_FLIP_PAGE_DOWN - Move the currently visible content down as if the
22606 * flip was a book, the other content is shown as the page below that.
22608 * @image html elm_flip.png
22609 * @image latex elm_flip.eps width=\textwidth
22611 EAPI void elm_flip_go(Evas_Object *obj, Elm_Flip_Mode mode) EINA_ARG_NONNULL(1);
22613 * @brief Set the interactive flip mode
22615 * @param obj The flip object
22616 * @param mode The interactive flip mode to use
22618 * This sets if the flip should be interactive (allow user to click and
22619 * drag a side of the flip to reveal the back page and cause it to flip).
22620 * By default a flip is not interactive. You may also need to set which
22621 * sides of the flip are "active" for flipping and how much space they use
22622 * (a minimum of a finger size) with elm_flip_interacton_direction_enabled_set()
22623 * and elm_flip_interacton_direction_hitsize_set()
22625 * The four avilable mode of interaction are:
22626 * @li ELM_FLIP_INTERACTION_NONE - No interaction is allowed
22627 * @li ELM_FLIP_INTERACTION_ROTATE - Interaction will cause rotate animation
22628 * @li ELM_FLIP_INTERACTION_CUBE - Interaction will cause cube animation
22629 * @li ELM_FLIP_INTERACTION_PAGE - Interaction will cause page animation
22631 * @note ELM_FLIP_INTERACTION_ROTATE won't cause
22632 * ELM_FLIP_ROTATE_XZ_CENTER_AXIS or ELM_FLIP_ROTATE_YZ_CENTER_AXIS to
22633 * happen, those can only be acheived with elm_flip_go();
22635 EAPI void elm_flip_interaction_set(Evas_Object *obj, Elm_Flip_Interaction mode);
22637 * @brief Get the interactive flip mode
22639 * @param obj The flip object
22640 * @return The interactive flip mode
22642 * Returns the interactive flip mode set by elm_flip_interaction_set()
22644 EAPI Elm_Flip_Interaction elm_flip_interaction_get(const Evas_Object *obj);
22646 * @brief Set which directions of the flip respond to interactive flip
22648 * @param obj The flip object
22649 * @param dir The direction to change
22650 * @param enabled If that direction is enabled or not
22652 * By default all directions are disabled, so you may want to enable the
22653 * desired directions for flipping if you need interactive flipping. You must
22654 * call this function once for each direction that should be enabled.
22656 * @see elm_flip_interaction_set()
22658 EAPI void elm_flip_interacton_direction_enabled_set(Evas_Object *obj, Elm_Flip_Direction dir, Eina_Bool enabled);
22660 * @brief Get the enabled state of that flip direction
22662 * @param obj The flip object
22663 * @param dir The direction to check
22664 * @return If that direction is enabled or not
22666 * Gets the enabled state set by elm_flip_interacton_direction_enabled_set()
22668 * @see elm_flip_interaction_set()
22670 EAPI Eina_Bool elm_flip_interacton_direction_enabled_get(Evas_Object *obj, Elm_Flip_Direction dir);
22672 * @brief Set the amount of the flip that is sensitive to interactive flip
22674 * @param obj The flip object
22675 * @param dir The direction to modify
22676 * @param hitsize The amount of that dimension (0.0 to 1.0) to use
22678 * Set the amount of the flip that is sensitive to interactive flip, with 0
22679 * representing no area in the flip and 1 representing the entire flip. There
22680 * is however a consideration to be made in that the area will never be
22681 * smaller than the finger size set(as set in your Elementary configuration).
22683 * @see elm_flip_interaction_set()
22685 EAPI void elm_flip_interacton_direction_hitsize_set(Evas_Object *obj, Elm_Flip_Direction dir, double hitsize);
22687 * @brief Get the amount of the flip that is sensitive to interactive flip
22689 * @param obj The flip object
22690 * @param dir The direction to check
22691 * @return The size set for that direction
22693 * Returns the amount os sensitive area set by
22694 * elm_flip_interacton_direction_hitsize_set().
22696 EAPI double elm_flip_interacton_direction_hitsize_get(Evas_Object *obj, Elm_Flip_Direction dir);
22701 /* scrolledentry */
22702 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22703 EINA_DEPRECATED EAPI void elm_scrolled_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line) EINA_ARG_NONNULL(1);
22704 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_single_line_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22705 EINA_DEPRECATED EAPI void elm_scrolled_entry_password_set(Evas_Object *obj, Eina_Bool password) EINA_ARG_NONNULL(1);
22706 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_password_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22707 EINA_DEPRECATED EAPI void elm_scrolled_entry_entry_set(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
22708 EINA_DEPRECATED EAPI const char *elm_scrolled_entry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22709 EINA_DEPRECATED EAPI void elm_scrolled_entry_entry_append(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
22710 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_is_empty(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22711 EINA_DEPRECATED EAPI const char *elm_scrolled_entry_selection_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22712 EINA_DEPRECATED EAPI void elm_scrolled_entry_entry_insert(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
22713 EINA_DEPRECATED EAPI void elm_scrolled_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
22714 EINA_DEPRECATED EAPI void elm_scrolled_entry_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
22715 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22716 EINA_DEPRECATED EAPI void elm_scrolled_entry_select_none(Evas_Object *obj) EINA_ARG_NONNULL(1);
22717 EINA_DEPRECATED EAPI void elm_scrolled_entry_select_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
22718 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
22719 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
22720 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_up(Evas_Object *obj) EINA_ARG_NONNULL(1);
22721 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_down(Evas_Object *obj) EINA_ARG_NONNULL(1);
22722 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
22723 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
22724 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_line_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
22725 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_line_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
22726 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_selection_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
22727 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_selection_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
22728 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_is_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22729 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_is_visible_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22730 EINA_DEPRECATED EAPI const char *elm_scrolled_entry_cursor_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22731 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_pos_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
22732 EINA_DEPRECATED EAPI int elm_scrolled_entry_cursor_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22733 EINA_DEPRECATED EAPI void elm_scrolled_entry_selection_cut(Evas_Object *obj) EINA_ARG_NONNULL(1);
22734 EINA_DEPRECATED EAPI void elm_scrolled_entry_selection_copy(Evas_Object *obj) EINA_ARG_NONNULL(1);
22735 EINA_DEPRECATED EAPI void elm_scrolled_entry_selection_paste(Evas_Object *obj) EINA_ARG_NONNULL(1);
22736 EINA_DEPRECATED EAPI void elm_scrolled_entry_context_menu_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
22737 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);
22738 EINA_DEPRECATED EAPI void elm_scrolled_entry_context_menu_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
22739 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_context_menu_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22740 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);
22741 EINA_DEPRECATED EAPI void elm_scrolled_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
22742 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);
22743 EINA_DEPRECATED EAPI void elm_scrolled_entry_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1, 2);
22744 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22745 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
22746 EINA_DEPRECATED EAPI void elm_scrolled_entry_icon_visible_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
22747 EINA_DEPRECATED EAPI void elm_scrolled_entry_end_set(Evas_Object *obj, Evas_Object *end) EINA_ARG_NONNULL(1, 2);
22748 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_end_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22749 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_end_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
22750 EINA_DEPRECATED EAPI void elm_scrolled_entry_end_visible_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
22751 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);
22752 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);
22753 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);
22754 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);
22755 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);
22756 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);
22757 EINA_DEPRECATED EAPI void elm_scrolled_entry_file_set(Evas_Object *obj, const char *file, Elm_Text_Format format) EINA_ARG_NONNULL(1);
22758 EINA_DEPRECATED EAPI void elm_scrolled_entry_file_get(const Evas_Object *obj, const char **file, Elm_Text_Format *format) EINA_ARG_NONNULL(1);
22759 EINA_DEPRECATED EAPI void elm_scrolled_entry_file_save(Evas_Object *obj) EINA_ARG_NONNULL(1);
22760 EINA_DEPRECATED EAPI void elm_scrolled_entry_autosave_set(Evas_Object *obj, Eina_Bool autosave) EINA_ARG_NONNULL(1);
22761 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_autosave_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22762 EINA_DEPRECATED EAPI void elm_scrolled_entry_cnp_textonly_set(Evas_Object *obj, Eina_Bool textonly) EINA_ARG_NONNULL(1);
22763 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cnp_textonly_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
22766 * @defgroup Conformant Conformant
22767 * @ingroup Elementary
22769 * @image html img/widget/conformant/preview-00.png
22770 * @image latex img/widget/conformant/preview-00.eps width=\textwidth
22772 * @image html img/conformant.png
22773 * @image latex img/conformant.eps width=\textwidth
22775 * The aim is to provide a widget that can be used in elementary apps to
22776 * account for space taken up by the indicator, virtual keypad & softkey
22777 * windows when running the illume2 module of E17.
22779 * So conformant content will be sized and positioned considering the
22780 * space required for such stuff, and when they popup, as a keyboard
22781 * shows when an entry is selected, conformant content won't change.
22783 * Available styles for it:
22786 * See how to use this widget in this example:
22787 * @ref conformant_example
22791 * @addtogroup Conformant
22796 * Add a new conformant widget to the given parent Elementary
22797 * (container) object.
22799 * @param parent The parent object.
22800 * @return A new conformant widget handle or @c NULL, on errors.
22802 * This function inserts a new conformant widget on the canvas.
22804 * @ingroup Conformant
22806 EAPI Evas_Object *elm_conformant_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22809 * Set the content of the conformant widget.
22811 * @param obj The conformant object.
22812 * @param content The content to be displayed by the conformant.
22814 * Content will be sized and positioned considering the space required
22815 * to display a virtual keyboard. So it won't fill all the conformant
22816 * size. This way is possible to be sure that content won't resize
22817 * or be re-positioned after the keyboard is displayed.
22819 * Once the content object is set, a previously set one will be deleted.
22820 * If you want to keep that old content object, use the
22821 * elm_conformat_content_unset() function.
22823 * @see elm_conformant_content_unset()
22824 * @see elm_conformant_content_get()
22826 * @ingroup Conformant
22828 EAPI void elm_conformant_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
22831 * Get the content of the conformant widget.
22833 * @param obj The conformant object.
22834 * @return The content that is being used.
22836 * Return the content object which is set for this widget.
22837 * It won't be unparent from conformant. For that, use
22838 * elm_conformant_content_unset().
22840 * @see elm_conformant_content_set() for more details.
22841 * @see elm_conformant_content_unset()
22843 * @ingroup Conformant
22845 EAPI Evas_Object *elm_conformant_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22848 * Unset the content of the conformant widget.
22850 * @param obj The conformant object.
22851 * @return The content that was being used.
22853 * Unparent and return the content object which was set for this widget.
22855 * @see elm_conformant_content_set() for more details.
22857 * @ingroup Conformant
22859 EAPI Evas_Object *elm_conformant_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
22862 * Returns the Evas_Object that represents the content area.
22864 * @param obj The conformant object.
22865 * @return The content area of the widget.
22867 * @ingroup Conformant
22869 EAPI Evas_Object *elm_conformant_content_area_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22876 * @defgroup Mapbuf Mapbuf
22877 * @ingroup Elementary
22879 * @image html img/widget/mapbuf/preview-00.png
22880 * @image latex img/widget/mapbuf/preview-00.eps width=\textwidth
22882 * This holds one content object and uses an Evas Map of transformation
22883 * points to be later used with this content. So the content will be
22884 * moved, resized, etc as a single image. So it will improve performance
22885 * when you have a complex interafce, with a lot of elements, and will
22886 * need to resize or move it frequently (the content object and its
22889 * See how to use this widget in this example:
22890 * @ref mapbuf_example
22894 * @addtogroup Mapbuf
22899 * Add a new mapbuf widget to the given parent Elementary
22900 * (container) object.
22902 * @param parent The parent object.
22903 * @return A new mapbuf widget handle or @c NULL, on errors.
22905 * This function inserts a new mapbuf widget on the canvas.
22909 EAPI Evas_Object *elm_mapbuf_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22912 * Set the content of the mapbuf.
22914 * @param obj The mapbuf object.
22915 * @param content The content that will be filled in this mapbuf object.
22917 * Once the content object is set, a previously set one will be deleted.
22918 * If you want to keep that old content object, use the
22919 * elm_mapbuf_content_unset() function.
22921 * To enable map, elm_mapbuf_enabled_set() should be used.
22925 EAPI void elm_mapbuf_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
22928 * Get the content of the mapbuf.
22930 * @param obj The mapbuf object.
22931 * @return The content that is being used.
22933 * Return the content object which is set for this widget.
22935 * @see elm_mapbuf_content_set() for details.
22939 EAPI Evas_Object *elm_mapbuf_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22942 * Unset the content of the mapbuf.
22944 * @param obj The mapbuf object.
22945 * @return The content that was being used.
22947 * Unparent and return the content object which was set for this widget.
22949 * @see elm_mapbuf_content_set() for details.
22953 EAPI Evas_Object *elm_mapbuf_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
22956 * Enable or disable the map.
22958 * @param obj The mapbuf object.
22959 * @param enabled @c EINA_TRUE to enable map or @c EINA_FALSE to disable it.
22961 * This enables the map that is set or disables it. On enable, the object
22962 * geometry will be saved, and the new geometry will change (position and
22963 * size) to reflect the map geometry set.
22965 * Also, when enabled, alpha and smooth states will be used, so if the
22966 * content isn't solid, alpha should be enabled, for example, otherwise
22967 * a black retangle will fill the content.
22969 * When disabled, the stored map will be freed and geometry prior to
22970 * enabling the map will be restored.
22972 * It's disabled by default.
22974 * @see elm_mapbuf_alpha_set()
22975 * @see elm_mapbuf_smooth_set()
22979 EAPI void elm_mapbuf_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
22982 * Get a value whether map is enabled or not.
22984 * @param obj The mapbuf object.
22985 * @return @c EINA_TRUE means map is enabled. @c EINA_FALSE indicates
22986 * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
22988 * @see elm_mapbuf_enabled_set() for details.
22992 EAPI Eina_Bool elm_mapbuf_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22995 * Enable or disable smooth map rendering.
22997 * @param obj The mapbuf object.
22998 * @param smooth @c EINA_TRUE to enable smooth map rendering or @c EINA_FALSE
23001 * This sets smoothing for map rendering. If the object is a type that has
23002 * its own smoothing settings, then both the smooth settings for this object
23003 * and the map must be turned off.
23005 * By default smooth maps are enabled.
23009 EAPI void elm_mapbuf_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
23012 * Get a value whether smooth map rendering is enabled or not.
23014 * @param obj The mapbuf object.
23015 * @return @c EINA_TRUE means smooth map rendering is enabled. @c EINA_FALSE
23016 * indicates it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
23018 * @see elm_mapbuf_smooth_set() for details.
23022 EAPI Eina_Bool elm_mapbuf_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23025 * Set or unset alpha flag for map rendering.
23027 * @param obj The mapbuf object.
23028 * @param alpha @c EINA_TRUE to enable alpha blending or @c EINA_FALSE
23031 * This sets alpha flag for map rendering. If the object is a type that has
23032 * its own alpha settings, then this will take precedence. Only image objects
23033 * have this currently. It stops alpha blending of the map area, and is
23034 * useful if you know the object and/or all sub-objects is 100% solid.
23036 * Alpha is enabled by default.
23040 EAPI void elm_mapbuf_alpha_set(Evas_Object *obj, Eina_Bool alpha) EINA_ARG_NONNULL(1);
23043 * Get a value whether alpha blending is enabled or not.
23045 * @param obj The mapbuf object.
23046 * @return @c EINA_TRUE means alpha blending is enabled. @c EINA_FALSE
23047 * indicates it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
23049 * @see elm_mapbuf_alpha_set() for details.
23053 EAPI Eina_Bool elm_mapbuf_alpha_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23060 * @defgroup Flipselector Flip Selector
23062 * @image html img/widget/flipselector/preview-00.png
23063 * @image latex img/widget/flipselector/preview-00.eps
23065 * A flip selector is a widget to show a set of @b text items, one
23066 * at a time, with the same sheet switching style as the @ref Clock
23067 * "clock" widget, when one changes the current displaying sheet
23068 * (thus, the "flip" in the name).
23070 * User clicks to flip sheets which are @b held for some time will
23071 * make the flip selector to flip continuosly and automatically for
23072 * the user. The interval between flips will keep growing in time,
23073 * so that it helps the user to reach an item which is distant from
23074 * the current selection.
23076 * Smart callbacks one can register to:
23077 * - @c "selected" - when the widget's selected text item is changed
23078 * - @c "overflowed" - when the widget's current selection is changed
23079 * from the first item in its list to the last
23080 * - @c "underflowed" - when the widget's current selection is changed
23081 * from the last item in its list to the first
23083 * Available styles for it:
23086 * Here is an example on its usage:
23087 * @li @ref flipselector_example
23091 * @addtogroup Flipselector
23095 typedef struct _Elm_Flipselector_Item Elm_Flipselector_Item; /**< Item handle for a flip selector widget. */
23098 * Add a new flip selector widget to the given parent Elementary
23099 * (container) widget
23101 * @param parent The parent object
23102 * @return a new flip selector widget handle or @c NULL, on errors
23104 * This function inserts a new flip selector widget on the canvas.
23106 * @ingroup Flipselector
23108 EAPI Evas_Object *elm_flipselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
23111 * Programmatically select the next item of a flip selector widget
23113 * @param obj The flipselector object
23115 * @note The selection will be animated. Also, if it reaches the
23116 * end of its list of member items, it will continue with the first
23119 * @ingroup Flipselector
23121 EAPI void elm_flipselector_flip_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
23124 * Programmatically select the previous item of a flip selector
23127 * @param obj The flipselector object
23129 * @note The selection will be animated. Also, if it reaches the
23130 * beginning of its list of member items, it will continue with the
23131 * last one backwards.
23133 * @ingroup Flipselector
23135 EAPI void elm_flipselector_flip_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
23138 * Append a (text) item to a flip selector widget
23140 * @param obj The flipselector object
23141 * @param label The (text) label of the new item
23142 * @param func Convenience callback function to take place when
23144 * @param data Data passed to @p func, above
23145 * @return A handle to the item added or @c NULL, on errors
23147 * The widget's list of labels to show will be appended with the
23148 * given value. If the user wishes so, a callback function pointer
23149 * can be passed, which will get called when this same item is
23152 * @note The current selection @b won't be modified by appending an
23153 * element to the list.
23155 * @note The maximum length of the text label is going to be
23156 * determined <b>by the widget's theme</b>. Strings larger than
23157 * that value are going to be @b truncated.
23159 * @ingroup Flipselector
23161 EAPI Elm_Flipselector_Item *elm_flipselector_item_append(Evas_Object *obj, const char *label, Evas_Smart_Cb func, void *data) EINA_ARG_NONNULL(1);
23164 * Prepend a (text) item to a flip selector widget
23166 * @param obj The flipselector object
23167 * @param label The (text) label of the new item
23168 * @param func Convenience callback function to take place when
23170 * @param data Data passed to @p func, above
23171 * @return A handle to the item added or @c NULL, on errors
23173 * The widget's list of labels to show will be prepended with the
23174 * given value. If the user wishes so, a callback function pointer
23175 * can be passed, which will get called when this same item is
23178 * @note The current selection @b won't be modified by prepending
23179 * an element to the list.
23181 * @note The maximum length of the text label is going to be
23182 * determined <b>by the widget's theme</b>. Strings larger than
23183 * that value are going to be @b truncated.
23185 * @ingroup Flipselector
23187 EAPI Elm_Flipselector_Item *elm_flipselector_item_prepend(Evas_Object *obj, const char *label, Evas_Smart_Cb func, void *data) EINA_ARG_NONNULL(1);
23190 * Get the internal list of items in a given flip selector widget.
23192 * @param obj The flipselector object
23193 * @return The list of items (#Elm_Flipselector_Item as data) or
23194 * @c NULL on errors.
23196 * This list is @b not to be modified in any way and must not be
23197 * freed. Use the list members with functions like
23198 * elm_flipselector_item_label_set(),
23199 * elm_flipselector_item_label_get(),
23200 * elm_flipselector_item_del(),
23201 * elm_flipselector_item_selected_get(),
23202 * elm_flipselector_item_selected_set().
23204 * @warning This list is only valid until @p obj object's internal
23205 * items list is changed. It should be fetched again with another
23206 * call to this function when changes happen.
23208 * @ingroup Flipselector
23210 EAPI const Eina_List *elm_flipselector_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23213 * Get the first item in the given flip selector widget's list of
23216 * @param obj The flipselector object
23217 * @return The first item or @c NULL, if it has no items (and on
23220 * @see elm_flipselector_item_append()
23221 * @see elm_flipselector_last_item_get()
23223 * @ingroup Flipselector
23225 EAPI Elm_Flipselector_Item *elm_flipselector_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23228 * Get the last item in the given flip selector widget's list of
23231 * @param obj The flipselector object
23232 * @return The last item or @c NULL, if it has no items (and on
23235 * @see elm_flipselector_item_prepend()
23236 * @see elm_flipselector_first_item_get()
23238 * @ingroup Flipselector
23240 EAPI Elm_Flipselector_Item *elm_flipselector_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23243 * Get the currently selected item in a flip selector widget.
23245 * @param obj The flipselector object
23246 * @return The selected item or @c NULL, if the widget has no items
23249 * @ingroup Flipselector
23251 EAPI Elm_Flipselector_Item *elm_flipselector_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23254 * Set whether a given flip selector widget's item should be the
23255 * currently selected one.
23257 * @param item The flip selector item
23258 * @param selected @c EINA_TRUE to select it, @c EINA_FALSE to unselect.
23260 * This sets whether @p item is or not the selected (thus, under
23261 * display) one. If @p item is different than one under display,
23262 * the latter will be unselected. If the @p item is set to be
23263 * unselected, on the other hand, the @b first item in the widget's
23264 * internal members list will be the new selected one.
23266 * @see elm_flipselector_item_selected_get()
23268 * @ingroup Flipselector
23270 EAPI void elm_flipselector_item_selected_set(Elm_Flipselector_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
23273 * Get whether a given flip selector widget's item is the currently
23276 * @param item The flip selector item
23277 * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
23280 * @see elm_flipselector_item_selected_set()
23282 * @ingroup Flipselector
23284 EAPI Eina_Bool elm_flipselector_item_selected_get(const Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
23287 * Delete a given item from a flip selector widget.
23289 * @param item The item to delete
23291 * @ingroup Flipselector
23293 EAPI void elm_flipselector_item_del(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
23296 * Get the label of a given flip selector widget's item.
23298 * @param item The item to get label from
23299 * @return The text label of @p item or @c NULL, on errors
23301 * @see elm_flipselector_item_label_set()
23303 * @ingroup Flipselector
23305 EAPI const char *elm_flipselector_item_label_get(const Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
23308 * Set the label of a given flip selector widget's item.
23310 * @param item The item to set label on
23311 * @param label The text label string, in UTF-8 encoding
23313 * @see elm_flipselector_item_label_get()
23315 * @ingroup Flipselector
23317 EAPI void elm_flipselector_item_label_set(Elm_Flipselector_Item *item, const char *label) EINA_ARG_NONNULL(1);
23320 * Gets the item before @p item in a flip selector widget's
23321 * internal list of items.
23323 * @param item The item to fetch previous from
23324 * @return The item before the @p item, in its parent's list. If
23325 * there is no previous item for @p item or there's an
23326 * error, @c NULL is returned.
23328 * @see elm_flipselector_item_next_get()
23330 * @ingroup Flipselector
23332 EAPI Elm_Flipselector_Item *elm_flipselector_item_prev_get(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
23335 * Gets the item after @p item in a flip selector widget's
23336 * internal list of items.
23338 * @param item The item to fetch next from
23339 * @return The item after the @p item, in its parent's list. If
23340 * there is no next item for @p item or there's an
23341 * error, @c NULL is returned.
23343 * @see elm_flipselector_item_next_get()
23345 * @ingroup Flipselector
23347 EAPI Elm_Flipselector_Item *elm_flipselector_item_next_get(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
23350 * Set the interval on time updates for an user mouse button hold
23351 * on a flip selector widget.
23353 * @param obj The flip selector object
23354 * @param interval The (first) interval value in seconds
23356 * This interval value is @b decreased while the user holds the
23357 * mouse pointer either flipping up or flipping doww a given flip
23360 * This helps the user to get to a given item distant from the
23361 * current one easier/faster, as it will start to flip quicker and
23362 * quicker on mouse button holds.
23364 * The calculation for the next flip interval value, starting from
23365 * the one set with this call, is the previous interval divided by
23366 * 1.05, so it decreases a little bit.
23368 * The default starting interval value for automatic flips is
23371 * @see elm_flipselector_interval_get()
23373 * @ingroup Flipselector
23375 EAPI void elm_flipselector_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
23378 * Get the interval on time updates for an user mouse button hold
23379 * on a flip selector widget.
23381 * @param obj The flip selector object
23382 * @return The (first) interval value, in seconds, set on it
23384 * @see elm_flipselector_interval_set() for more details
23386 * @ingroup Flipselector
23388 EAPI double elm_flipselector_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23394 * @addtogroup Calendar
23399 * @enum _Elm_Calendar_Mark_Repeat
23400 * @typedef Elm_Calendar_Mark_Repeat
23402 * Event periodicity, used to define if a mark should be repeated
23403 * @b beyond event's day. It's set when a mark is added.
23405 * So, for a mark added to 13th May with periodicity set to WEEKLY,
23406 * there will be marks every week after this date. Marks will be displayed
23407 * at 13th, 20th, 27th, 3rd June ...
23409 * Values don't work as bitmask, only one can be choosen.
23411 * @see elm_calendar_mark_add()
23413 * @ingroup Calendar
23415 typedef enum _Elm_Calendar_Mark_Repeat
23417 ELM_CALENDAR_UNIQUE, /**< Default value. Marks will be displayed only on event day. */
23418 ELM_CALENDAR_DAILY, /**< Marks will be displayed everyday after event day (inclusive). */
23419 ELM_CALENDAR_WEEKLY, /**< Marks will be displayed every week after event day (inclusive) - i.e. each seven days. */
23420 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*/
23421 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. */
23422 } Elm_Calendar_Mark_Repeat;
23424 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(). */
23427 * Add a new calendar widget to the given parent Elementary
23428 * (container) object.
23430 * @param parent The parent object.
23431 * @return a new calendar widget handle or @c NULL, on errors.
23433 * This function inserts a new calendar widget on the canvas.
23435 * @ref calendar_example_01
23437 * @ingroup Calendar
23439 EAPI Evas_Object *elm_calendar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
23442 * Get weekdays names displayed by the calendar.
23444 * @param obj The calendar object.
23445 * @return Array of seven strings to be used as weekday names.
23447 * By default, weekdays abbreviations get from system are displayed:
23448 * E.g. for an en_US locale: "Sun, Mon, Tue, Wed, Thu, Fri, Sat"
23449 * The first string is related to Sunday, the second to Monday...
23451 * @see elm_calendar_weekdays_name_set()
23453 * @ref calendar_example_05
23455 * @ingroup Calendar
23457 EAPI const char **elm_calendar_weekdays_names_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23460 * Set weekdays names to be displayed by the calendar.
23462 * @param obj The calendar object.
23463 * @param weekdays Array of seven strings to be used as weekday names.
23464 * @warning It must have 7 elements, or it will access invalid memory.
23465 * @warning The strings must be NULL terminated ('@\0').
23467 * By default, weekdays abbreviations get from system are displayed:
23468 * E.g. for an en_US locale: "Sun, Mon, Tue, Wed, Thu, Fri, Sat"
23470 * The first string should be related to Sunday, the second to Monday...
23472 * The usage should be like this:
23474 * const char *weekdays[] =
23476 * "Sunday", "Monday", "Tuesday", "Wednesday",
23477 * "Thursday", "Friday", "Saturday"
23479 * elm_calendar_weekdays_names_set(calendar, weekdays);
23482 * @see elm_calendar_weekdays_name_get()
23484 * @ref calendar_example_02
23486 * @ingroup Calendar
23488 EAPI void elm_calendar_weekdays_names_set(Evas_Object *obj, const char *weekdays[]) EINA_ARG_NONNULL(1, 2);
23491 * Set the minimum and maximum values for the year
23493 * @param obj The calendar object
23494 * @param min The minimum year, greater than 1901;
23495 * @param max The maximum year;
23497 * Maximum must be greater than minimum, except if you don't wan't to set
23499 * Default values are 1902 and -1.
23501 * If the maximum year is a negative value, it will be limited depending
23502 * on the platform architecture (year 2037 for 32 bits);
23504 * @see elm_calendar_min_max_year_get()
23506 * @ref calendar_example_03
23508 * @ingroup Calendar
23510 EAPI void elm_calendar_min_max_year_set(Evas_Object *obj, int min, int max) EINA_ARG_NONNULL(1);
23513 * Get the minimum and maximum values for the year
23515 * @param obj The calendar object.
23516 * @param min The minimum year.
23517 * @param max The maximum year.
23519 * Default values are 1902 and -1.
23521 * @see elm_calendar_min_max_year_get() for more details.
23523 * @ref calendar_example_05
23525 * @ingroup Calendar
23527 EAPI void elm_calendar_min_max_year_get(const Evas_Object *obj, int *min, int *max) EINA_ARG_NONNULL(1);
23530 * Enable or disable day selection
23532 * @param obj The calendar object.
23533 * @param enabled @c EINA_TRUE to enable selection or @c EINA_FALSE to
23536 * Enabled by default. If disabled, the user still can select months,
23537 * but not days. Selected days are highlighted on calendar.
23538 * It should be used if you won't need such selection for the widget usage.
23540 * When a day is selected, or month is changed, smart callbacks for
23541 * signal "changed" will be called.
23543 * @see elm_calendar_day_selection_enable_get()
23545 * @ref calendar_example_04
23547 * @ingroup Calendar
23549 EAPI void elm_calendar_day_selection_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
23552 * Get a value whether day selection is enabled or not.
23554 * @see elm_calendar_day_selection_enable_set() for details.
23556 * @param obj The calendar object.
23557 * @return EINA_TRUE means day selection is enabled. EINA_FALSE indicates
23558 * it's disabled. If @p obj is NULL, EINA_FALSE is returned.
23560 * @ref calendar_example_05
23562 * @ingroup Calendar
23564 EAPI Eina_Bool elm_calendar_day_selection_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23568 * Set selected date to be highlighted on calendar.
23570 * @param obj The calendar object.
23571 * @param selected_time A @b tm struct to represent the selected date.
23573 * Set the selected date, changing the displayed month if needed.
23574 * Selected date changes when the user goes to next/previous month or
23575 * select a day pressing over it on calendar.
23577 * @see elm_calendar_selected_time_get()
23579 * @ref calendar_example_04
23581 * @ingroup Calendar
23583 EAPI void elm_calendar_selected_time_set(Evas_Object *obj, struct tm *selected_time) EINA_ARG_NONNULL(1);
23586 * Get selected date.
23588 * @param obj The calendar object
23589 * @param selected_time A @b tm struct to point to selected date
23590 * @return EINA_FALSE means an error ocurred and returned time shouldn't
23593 * Get date selected by the user or set by function
23594 * elm_calendar_selected_time_set().
23595 * Selected date changes when the user goes to next/previous month or
23596 * select a day pressing over it on calendar.
23598 * @see elm_calendar_selected_time_get()
23600 * @ref calendar_example_05
23602 * @ingroup Calendar
23604 EAPI Eina_Bool elm_calendar_selected_time_get(const Evas_Object *obj, struct tm *selected_time) EINA_ARG_NONNULL(1, 2);
23607 * Set a function to format the string that will be used to display
23610 * @param obj The calendar object
23611 * @param format_function Function to set the month-year string given
23612 * the selected date
23614 * By default it uses strftime with "%B %Y" format string.
23615 * It should allocate the memory that will be used by the string,
23616 * that will be freed by the widget after usage.
23617 * A pointer to the string and a pointer to the time struct will be provided.
23622 * _format_month_year(struct tm *selected_time)
23625 * if (!strftime(buf, sizeof(buf), "%B %Y", selected_time)) return NULL;
23626 * return strdup(buf);
23629 * elm_calendar_format_function_set(calendar, _format_month_year);
23632 * @ref calendar_example_02
23634 * @ingroup Calendar
23636 EAPI void elm_calendar_format_function_set(Evas_Object *obj, char * (*format_function) (struct tm *stime)) EINA_ARG_NONNULL(1);
23639 * Add a new mark to the calendar
23641 * @param obj The calendar object
23642 * @param mark_type A string used to define the type of mark. It will be
23643 * emitted to the theme, that should display a related modification on these
23644 * days representation.
23645 * @param mark_time A time struct to represent the date of inclusion of the
23646 * mark. For marks that repeats it will just be displayed after the inclusion
23647 * date in the calendar.
23648 * @param repeat Repeat the event following this periodicity. Can be a unique
23649 * mark (that don't repeat), daily, weekly, monthly or annually.
23650 * @return The created mark or @p NULL upon failure.
23652 * Add a mark that will be drawn in the calendar respecting the insertion
23653 * time and periodicity. It will emit the type as signal to the widget theme.
23654 * Default theme supports "holiday" and "checked", but it can be extended.
23656 * It won't immediately update the calendar, drawing the marks.
23657 * For this, call elm_calendar_marks_draw(). However, when user selects
23658 * next or previous month calendar forces marks drawn.
23660 * Marks created with this method can be deleted with
23661 * elm_calendar_mark_del().
23665 * struct tm selected_time;
23666 * time_t current_time;
23668 * current_time = time(NULL) + 5 * 84600;
23669 * localtime_r(¤t_time, &selected_time);
23670 * elm_calendar_mark_add(cal, "holiday", selected_time,
23671 * ELM_CALENDAR_ANNUALLY);
23673 * current_time = time(NULL) + 1 * 84600;
23674 * localtime_r(¤t_time, &selected_time);
23675 * elm_calendar_mark_add(cal, "checked", selected_time, ELM_CALENDAR_UNIQUE);
23677 * elm_calendar_marks_draw(cal);
23680 * @see elm_calendar_marks_draw()
23681 * @see elm_calendar_mark_del()
23683 * @ref calendar_example_06
23685 * @ingroup Calendar
23687 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);
23690 * Delete mark from the calendar.
23692 * @param mark The mark to be deleted.
23694 * If deleting all calendar marks is required, elm_calendar_marks_clear()
23695 * should be used instead of getting marks list and deleting each one.
23697 * @see elm_calendar_mark_add()
23699 * @ref calendar_example_06
23701 * @ingroup Calendar
23703 EAPI void elm_calendar_mark_del(Elm_Calendar_Mark *mark) EINA_ARG_NONNULL(1);
23706 * Remove all calendar's marks
23708 * @param obj The calendar object.
23710 * @see elm_calendar_mark_add()
23711 * @see elm_calendar_mark_del()
23713 * @ingroup Calendar
23715 EAPI void elm_calendar_marks_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
23719 * Get a list of all the calendar marks.
23721 * @param obj The calendar object.
23722 * @return An @c Eina_List of calendar marks objects, or @c NULL on failure.
23724 * @see elm_calendar_mark_add()
23725 * @see elm_calendar_mark_del()
23726 * @see elm_calendar_marks_clear()
23728 * @ingroup Calendar
23730 EAPI const Eina_List *elm_calendar_marks_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23733 * Draw calendar marks.
23735 * @param obj The calendar object.
23737 * Should be used after adding, removing or clearing marks.
23738 * It will go through the entire marks list updating the calendar.
23739 * If lots of marks will be added, add all the marks and then call
23742 * When the month is changed, i.e. user selects next or previous month,
23743 * marks will be drawed.
23745 * @see elm_calendar_mark_add()
23746 * @see elm_calendar_mark_del()
23747 * @see elm_calendar_marks_clear()
23749 * @ref calendar_example_06
23751 * @ingroup Calendar
23753 EAPI void elm_calendar_marks_draw(Evas_Object *obj) EINA_ARG_NONNULL(1);
23756 * Set a day text color to the same that represents Saturdays.
23758 * @param obj The calendar object.
23759 * @param pos The text position. Position is the cell counter, from left
23760 * to right, up to down. It starts on 0 and ends on 41.
23762 * @deprecated use elm_calendar_mark_add() instead like:
23765 * struct tm t = { 0, 0, 12, 6, 0, 0, 6, 6, -1 };
23766 * elm_calendar_mark_add(obj, "sat", &t, ELM_CALENDAR_WEEKLY);
23769 * @see elm_calendar_mark_add()
23771 * @ingroup Calendar
23773 EINA_DEPRECATED EAPI void elm_calendar_text_saturday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
23776 * Set a day text color to the same that represents Sundays.
23778 * @param obj The calendar object.
23779 * @param pos The text position. Position is the cell counter, from left
23780 * to right, up to down. It starts on 0 and ends on 41.
23782 * @deprecated use elm_calendar_mark_add() instead like:
23785 * struct tm t = { 0, 0, 12, 7, 0, 0, 0, 0, -1 };
23786 * elm_calendar_mark_add(obj, "sat", &t, ELM_CALENDAR_WEEKLY);
23789 * @see elm_calendar_mark_add()
23791 * @ingroup Calendar
23793 EINA_DEPRECATED EAPI void elm_calendar_text_sunday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
23796 * Set a day text color to the same that represents Weekdays.
23798 * @param obj The calendar object
23799 * @param pos The text position. Position is the cell counter, from left
23800 * to right, up to down. It starts on 0 and ends on 41.
23802 * @deprecated use elm_calendar_mark_add() instead like:
23805 * struct tm t = { 0, 0, 12, 1, 0, 0, 0, 0, -1 };
23807 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // monday
23808 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
23809 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // tuesday
23810 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
23811 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // wednesday
23812 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
23813 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // thursday
23814 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
23815 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // friday
23818 * @see elm_calendar_mark_add()
23820 * @ingroup Calendar
23822 EINA_DEPRECATED EAPI void elm_calendar_text_weekday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
23825 * Set the interval on time updates for an user mouse button hold
23826 * on calendar widgets' month selection.
23828 * @param obj The calendar object
23829 * @param interval The (first) interval value in seconds
23831 * This interval value is @b decreased while the user holds the
23832 * mouse pointer either selecting next or previous month.
23834 * This helps the user to get to a given month distant from the
23835 * current one easier/faster, as it will start to change quicker and
23836 * quicker on mouse button holds.
23838 * The calculation for the next change interval value, starting from
23839 * the one set with this call, is the previous interval divided by
23840 * 1.05, so it decreases a little bit.
23842 * The default starting interval value for automatic changes is
23845 * @see elm_calendar_interval_get()
23847 * @ingroup Calendar
23849 EAPI void elm_calendar_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
23852 * Get the interval on time updates for an user mouse button hold
23853 * on calendar widgets' month selection.
23855 * @param obj The calendar object
23856 * @return The (first) interval value, in seconds, set on it
23858 * @see elm_calendar_interval_set() for more details
23860 * @ingroup Calendar
23862 EAPI double elm_calendar_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23869 * @defgroup Diskselector Diskselector
23870 * @ingroup Elementary
23872 * @image html img/widget/diskselector/preview-00.png
23873 * @image latex img/widget/diskselector/preview-00.eps
23875 * A diskselector is a kind of list widget. It scrolls horizontally,
23876 * and can contain label and icon objects. Three items are displayed
23877 * with the selected one in the middle.
23879 * It can act like a circular list with round mode and labels can be
23880 * reduced for a defined length for side items.
23882 * Smart callbacks one can listen to:
23883 * - "selected" - when item is selected, i.e. scroller stops.
23885 * Available styles for it:
23888 * List of examples:
23889 * @li @ref diskselector_example_01
23890 * @li @ref diskselector_example_02
23894 * @addtogroup Diskselector
23898 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(). */
23901 * Add a new diskselector widget to the given parent Elementary
23902 * (container) object.
23904 * @param parent The parent object.
23905 * @return a new diskselector widget handle or @c NULL, on errors.
23907 * This function inserts a new diskselector widget on the canvas.
23909 * @ingroup Diskselector
23911 EAPI Evas_Object *elm_diskselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
23914 * Enable or disable round mode.
23916 * @param obj The diskselector object.
23917 * @param round @c EINA_TRUE to enable round mode or @c EINA_FALSE to
23920 * Disabled by default. If round mode is enabled the items list will
23921 * work like a circle list, so when the user reaches the last item,
23922 * the first one will popup.
23924 * @see elm_diskselector_round_get()
23926 * @ingroup Diskselector
23928 EAPI void elm_diskselector_round_set(Evas_Object *obj, Eina_Bool round) EINA_ARG_NONNULL(1);
23931 * Get a value whether round mode is enabled or not.
23933 * @see elm_diskselector_round_set() for details.
23935 * @param obj The diskselector object.
23936 * @return @c EINA_TRUE means round mode is enabled. @c EINA_FALSE indicates
23937 * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
23939 * @ingroup Diskselector
23941 EAPI Eina_Bool elm_diskselector_round_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23944 * Get the side labels max length.
23946 * @deprecated use elm_diskselector_side_label_length_get() instead:
23948 * @param obj The diskselector object.
23949 * @return The max length defined for side labels, or 0 if not a valid
23952 * @ingroup Diskselector
23954 EINA_DEPRECATED EAPI int elm_diskselector_side_label_lenght_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23957 * Set the side labels max length.
23959 * @deprecated use elm_diskselector_side_label_length_set() instead:
23961 * @param obj The diskselector object.
23962 * @param len The max length defined for side labels.
23964 * @ingroup Diskselector
23966 EINA_DEPRECATED EAPI void elm_diskselector_side_label_lenght_set(Evas_Object *obj, int len) EINA_ARG_NONNULL(1);
23969 * Get the side labels max length.
23971 * @see elm_diskselector_side_label_length_set() for details.
23973 * @param obj The diskselector object.
23974 * @return The max length defined for side labels, or 0 if not a valid
23977 * @ingroup Diskselector
23979 EAPI int elm_diskselector_side_label_length_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23982 * Set the side labels max length.
23984 * @param obj The diskselector object.
23985 * @param len The max length defined for side labels.
23987 * Length is the number of characters of items' label that will be
23988 * visible when it's set on side positions. It will just crop
23989 * the string after defined size. E.g.:
23991 * An item with label "January" would be displayed on side position as
23992 * "Jan" if max length is set to 3, or "Janu", if this property
23995 * When it's selected, the entire label will be displayed, except for
23996 * width restrictions. In this case label will be cropped and "..."
23997 * will be concatenated.
23999 * Default side label max length is 3.
24001 * This property will be applyed over all items, included before or
24002 * later this function call.
24004 * @ingroup Diskselector
24006 EAPI void elm_diskselector_side_label_length_set(Evas_Object *obj, int len) EINA_ARG_NONNULL(1);
24009 * Set the number of items to be displayed.
24011 * @param obj The diskselector object.
24012 * @param num The number of items the diskselector will display.
24014 * Default value is 3, and also it's the minimun. If @p num is less
24015 * than 3, it will be set to 3.
24017 * Also, it can be set on theme, using data item @c display_item_num
24018 * on group "elm/diskselector/item/X", where X is style set.
24021 * group { name: "elm/diskselector/item/X";
24023 * item: "display_item_num" "5";
24026 * @ingroup Diskselector
24028 EAPI void elm_diskselector_display_item_num_set(Evas_Object *obj, int num) EINA_ARG_NONNULL(1);
24031 * Set bouncing behaviour when the scrolled content reaches an edge.
24033 * Tell the internal scroller object whether it should bounce or not
24034 * when it reaches the respective edges for each axis.
24036 * @param obj The diskselector object.
24037 * @param h_bounce Whether to bounce or not in the horizontal axis.
24038 * @param v_bounce Whether to bounce or not in the vertical axis.
24040 * @see elm_scroller_bounce_set()
24042 * @ingroup Diskselector
24044 EAPI void elm_diskselector_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
24047 * Get the bouncing behaviour of the internal scroller.
24049 * Get whether the internal scroller should bounce when the edge of each
24050 * axis is reached scrolling.
24052 * @param obj The diskselector object.
24053 * @param h_bounce Pointer where to store the bounce state of the horizontal
24055 * @param v_bounce Pointer where to store the bounce state of the vertical
24058 * @see elm_scroller_bounce_get()
24059 * @see elm_diskselector_bounce_set()
24061 * @ingroup Diskselector
24063 EAPI void elm_diskselector_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
24066 * Get the scrollbar policy.
24068 * @see elm_diskselector_scroller_policy_get() for details.
24070 * @param obj The diskselector object.
24071 * @param policy_h Pointer where to store horizontal scrollbar policy.
24072 * @param policy_v Pointer where to store vertical scrollbar policy.
24074 * @ingroup Diskselector
24076 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);
24079 * Set the scrollbar policy.
24081 * @param obj The diskselector object.
24082 * @param policy_h Horizontal scrollbar policy.
24083 * @param policy_v Vertical scrollbar policy.
24085 * This sets the scrollbar visibility policy for the given scroller.
24086 * #ELM_SCROLLER_POLICY_AUTO means the scrollber is made visible if it
24087 * is needed, and otherwise kept hidden. #ELM_SCROLLER_POLICY_ON turns
24088 * it on all the time, and #ELM_SCROLLER_POLICY_OFF always keeps it off.
24089 * This applies respectively for the horizontal and vertical scrollbars.
24091 * The both are disabled by default, i.e., are set to
24092 * #ELM_SCROLLER_POLICY_OFF.
24094 * @ingroup Diskselector
24096 EAPI void elm_diskselector_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
24099 * Remove all diskselector's items.
24101 * @param obj The diskselector object.
24103 * @see elm_diskselector_item_del()
24104 * @see elm_diskselector_item_append()
24106 * @ingroup Diskselector
24108 EAPI void elm_diskselector_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
24111 * Get a list of all the diskselector items.
24113 * @param obj The diskselector object.
24114 * @return An @c Eina_List of diskselector items, #Elm_Diskselector_Item,
24115 * or @c NULL on failure.
24117 * @see elm_diskselector_item_append()
24118 * @see elm_diskselector_item_del()
24119 * @see elm_diskselector_clear()
24121 * @ingroup Diskselector
24123 EAPI const Eina_List *elm_diskselector_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24126 * Appends a new item to the diskselector object.
24128 * @param obj The diskselector object.
24129 * @param label The label of the diskselector item.
24130 * @param icon The icon object to use at left side of the item. An
24131 * icon can be any Evas object, but usually it is an icon created
24132 * with elm_icon_add().
24133 * @param func The function to call when the item is selected.
24134 * @param data The data to associate with the item for related callbacks.
24136 * @return The created item or @c NULL upon failure.
24138 * A new item will be created and appended to the diskselector, i.e., will
24139 * be set as last item. Also, if there is no selected item, it will
24140 * be selected. This will always happens for the first appended item.
24142 * If no icon is set, label will be centered on item position, otherwise
24143 * the icon will be placed at left of the label, that will be shifted
24146 * Items created with this method can be deleted with
24147 * elm_diskselector_item_del().
24149 * Associated @p data can be properly freed when item is deleted if a
24150 * callback function is set with elm_diskselector_item_del_cb_set().
24152 * If a function is passed as argument, it will be called everytime this item
24153 * is selected, i.e., the user stops the diskselector with this
24154 * item on center position. If such function isn't needed, just passing
24155 * @c NULL as @p func is enough. The same should be done for @p data.
24157 * Simple example (with no function callback or data associated):
24159 * disk = elm_diskselector_add(win);
24160 * ic = elm_icon_add(win);
24161 * elm_icon_file_set(ic, "path/to/image", NULL);
24162 * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
24163 * elm_diskselector_item_append(disk, "label", ic, NULL, NULL);
24166 * @see elm_diskselector_item_del()
24167 * @see elm_diskselector_item_del_cb_set()
24168 * @see elm_diskselector_clear()
24169 * @see elm_icon_add()
24171 * @ingroup Diskselector
24173 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);
24177 * Delete them item from the diskselector.
24179 * @param it The item of diskselector to be deleted.
24181 * If deleting all diskselector items is required, elm_diskselector_clear()
24182 * should be used instead of getting items list and deleting each one.
24184 * @see elm_diskselector_clear()
24185 * @see elm_diskselector_item_append()
24186 * @see elm_diskselector_item_del_cb_set()
24188 * @ingroup Diskselector
24190 EAPI void elm_diskselector_item_del(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24193 * Set the function called when a diskselector item is freed.
24195 * @param it The item to set the callback on
24196 * @param func The function called
24198 * If there is a @p func, then it will be called prior item's memory release.
24199 * That will be called with the following arguments:
24201 * @li item's Evas object;
24204 * This way, a data associated to a diskselector item could be properly
24207 * @ingroup Diskselector
24209 EAPI void elm_diskselector_item_del_cb_set(Elm_Diskselector_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
24212 * Get the data associated to the item.
24214 * @param it The diskselector item
24215 * @return The data associated to @p it
24217 * The return value is a pointer to data associated to @p item when it was
24218 * created, with function elm_diskselector_item_append(). If no data
24219 * was passed as argument, it will return @c NULL.
24221 * @see elm_diskselector_item_append()
24223 * @ingroup Diskselector
24225 EAPI void *elm_diskselector_item_data_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24228 * Set the icon associated to the item.
24230 * @param it The diskselector item
24231 * @param icon The icon object to associate with @p it
24233 * The icon object to use at left side of the item. An
24234 * icon can be any Evas object, but usually it is an icon created
24235 * with elm_icon_add().
24237 * Once the icon object is set, a previously set one will be deleted.
24238 * @warning Setting the same icon for two items will cause the icon to
24239 * dissapear from the first item.
24241 * If an icon was passed as argument on item creation, with function
24242 * elm_diskselector_item_append(), it will be already
24243 * associated to the item.
24245 * @see elm_diskselector_item_append()
24246 * @see elm_diskselector_item_icon_get()
24248 * @ingroup Diskselector
24250 EAPI void elm_diskselector_item_icon_set(Elm_Diskselector_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
24253 * Get the icon associated to the item.
24255 * @param it The diskselector item
24256 * @return The icon associated to @p it
24258 * The return value is a pointer to the icon associated to @p item when it was
24259 * created, with function elm_diskselector_item_append(), or later
24260 * with function elm_diskselector_item_icon_set. If no icon
24261 * was passed as argument, it will return @c NULL.
24263 * @see elm_diskselector_item_append()
24264 * @see elm_diskselector_item_icon_set()
24266 * @ingroup Diskselector
24268 EAPI Evas_Object *elm_diskselector_item_icon_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24271 * Set the label of item.
24273 * @param it The item of diskselector.
24274 * @param label The label of item.
24276 * The label to be displayed by the item.
24278 * If no icon is set, label will be centered on item position, otherwise
24279 * the icon will be placed at left of the label, that will be shifted
24282 * An item with label "January" would be displayed on side position as
24283 * "Jan" if max length is set to 3 with function
24284 * elm_diskselector_side_label_lenght_set(), or "Janu", if this property
24287 * When this @p item is selected, the entire label will be displayed,
24288 * except for width restrictions.
24289 * In this case label will be cropped and "..." will be concatenated,
24290 * but only for display purposes. It will keep the entire string, so
24291 * if diskselector is resized the remaining characters will be displayed.
24293 * If a label was passed as argument on item creation, with function
24294 * elm_diskselector_item_append(), it will be already
24295 * displayed by the item.
24297 * @see elm_diskselector_side_label_lenght_set()
24298 * @see elm_diskselector_item_label_get()
24299 * @see elm_diskselector_item_append()
24301 * @ingroup Diskselector
24303 EAPI void elm_diskselector_item_label_set(Elm_Diskselector_Item *item, const char *label) EINA_ARG_NONNULL(1);
24306 * Get the label of item.
24308 * @param it The item of diskselector.
24309 * @return The label of item.
24311 * The return value is a pointer to the label associated to @p item when it was
24312 * created, with function elm_diskselector_item_append(), or later
24313 * with function elm_diskselector_item_label_set. If no label
24314 * was passed as argument, it will return @c NULL.
24316 * @see elm_diskselector_item_label_set() for more details.
24317 * @see elm_diskselector_item_append()
24319 * @ingroup Diskselector
24321 EAPI const char *elm_diskselector_item_label_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24324 * Get the selected item.
24326 * @param obj The diskselector object.
24327 * @return The selected diskselector item.
24329 * The selected item can be unselected with function
24330 * elm_diskselector_item_selected_set(), and the first item of
24331 * diskselector will be selected.
24333 * The selected item always will be centered on diskselector, with
24334 * full label displayed, i.e., max lenght set to side labels won't
24335 * apply on the selected item. More details on
24336 * elm_diskselector_side_label_length_set().
24338 * @ingroup Diskselector
24340 EAPI Elm_Diskselector_Item *elm_diskselector_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24343 * Set the selected state of an item.
24345 * @param it The diskselector item
24346 * @param selected The selected state
24348 * This sets the selected state of the given item @p it.
24349 * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
24351 * If a new item is selected the previosly selected will be unselected.
24352 * Previoulsy selected item can be get with function
24353 * elm_diskselector_selected_item_get().
24355 * If the item @p it is unselected, the first item of diskselector will
24358 * Selected items will be visible on center position of diskselector.
24359 * So if it was on another position before selected, or was invisible,
24360 * diskselector will animate items until the selected item reaches center
24363 * @see elm_diskselector_item_selected_get()
24364 * @see elm_diskselector_selected_item_get()
24366 * @ingroup Diskselector
24368 EAPI void elm_diskselector_item_selected_set(Elm_Diskselector_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
24371 * Get whether the @p item is selected or not.
24373 * @param it The diskselector item.
24374 * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
24375 * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
24377 * @see elm_diskselector_selected_item_set() for details.
24378 * @see elm_diskselector_item_selected_get()
24380 * @ingroup Diskselector
24382 EAPI Eina_Bool elm_diskselector_item_selected_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24385 * Get the first item of the diskselector.
24387 * @param obj The diskselector object.
24388 * @return The first item, or @c NULL if none.
24390 * The list of items follows append order. So it will return the first
24391 * item appended to the widget that wasn't deleted.
24393 * @see elm_diskselector_item_append()
24394 * @see elm_diskselector_items_get()
24396 * @ingroup Diskselector
24398 EAPI Elm_Diskselector_Item *elm_diskselector_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24401 * Get the last item of the diskselector.
24403 * @param obj The diskselector object.
24404 * @return The last item, or @c NULL if none.
24406 * The list of items follows append order. So it will return last first
24407 * item appended to the widget that wasn't deleted.
24409 * @see elm_diskselector_item_append()
24410 * @see elm_diskselector_items_get()
24412 * @ingroup Diskselector
24414 EAPI Elm_Diskselector_Item *elm_diskselector_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24417 * Get the item before @p item in diskselector.
24419 * @param it The diskselector item.
24420 * @return The item before @p item, or @c NULL if none or on failure.
24422 * The list of items follows append order. So it will return item appended
24423 * just before @p item and that wasn't deleted.
24425 * If it is the first item, @c NULL will be returned.
24426 * First item can be get by elm_diskselector_first_item_get().
24428 * @see elm_diskselector_item_append()
24429 * @see elm_diskselector_items_get()
24431 * @ingroup Diskselector
24433 EAPI Elm_Diskselector_Item *elm_diskselector_item_prev_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24436 * Get the item after @p item in diskselector.
24438 * @param it The diskselector item.
24439 * @return The item after @p item, or @c NULL if none or on failure.
24441 * The list of items follows append order. So it will return item appended
24442 * just after @p item and that wasn't deleted.
24444 * If it is the last item, @c NULL will be returned.
24445 * Last item can be get by elm_diskselector_last_item_get().
24447 * @see elm_diskselector_item_append()
24448 * @see elm_diskselector_items_get()
24450 * @ingroup Diskselector
24452 EAPI Elm_Diskselector_Item *elm_diskselector_item_next_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24455 * Set the text to be shown in the diskselector item.
24457 * @param item Target item
24458 * @param text The text to set in the content
24460 * Setup the text as tooltip to object. The item can have only one tooltip,
24461 * so any previous tooltip data is removed.
24463 * @see elm_object_tooltip_text_set() for more details.
24465 * @ingroup Diskselector
24467 EAPI void elm_diskselector_item_tooltip_text_set(Elm_Diskselector_Item *item, const char *text) EINA_ARG_NONNULL(1);
24470 * Set the content to be shown in the tooltip item.
24472 * Setup the tooltip to item. The item can have only one tooltip,
24473 * so any previous tooltip data is removed. @p func(with @p data) will
24474 * be called every time that need show the tooltip and it should
24475 * return a valid Evas_Object. This object is then managed fully by
24476 * tooltip system and is deleted when the tooltip is gone.
24478 * @param item the diskselector item being attached a tooltip.
24479 * @param func the function used to create the tooltip contents.
24480 * @param data what to provide to @a func as callback data/context.
24481 * @param del_cb called when data is not needed anymore, either when
24482 * another callback replaces @p func, the tooltip is unset with
24483 * elm_diskselector_item_tooltip_unset() or the owner @a item
24484 * dies. This callback receives as the first parameter the
24485 * given @a data, and @c event_info is the item.
24487 * @see elm_object_tooltip_content_cb_set() for more details.
24489 * @ingroup Diskselector
24491 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);
24494 * Unset tooltip from item.
24496 * @param item diskselector item to remove previously set tooltip.
24498 * Remove tooltip from item. The callback provided as del_cb to
24499 * elm_diskselector_item_tooltip_content_cb_set() will be called to notify
24500 * it is not used anymore.
24502 * @see elm_object_tooltip_unset() for more details.
24503 * @see elm_diskselector_item_tooltip_content_cb_set()
24505 * @ingroup Diskselector
24507 EAPI void elm_diskselector_item_tooltip_unset(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24511 * Sets a different style for this item tooltip.
24513 * @note before you set a style you should define a tooltip with
24514 * elm_diskselector_item_tooltip_content_cb_set() or
24515 * elm_diskselector_item_tooltip_text_set()
24517 * @param item diskselector item with tooltip already set.
24518 * @param style the theme style to use (default, transparent, ...)
24520 * @see elm_object_tooltip_style_set() for more details.
24522 * @ingroup Diskselector
24524 EAPI void elm_diskselector_item_tooltip_style_set(Elm_Diskselector_Item *item, const char *style) EINA_ARG_NONNULL(1);
24527 * Get the style for this item tooltip.
24529 * @param item diskselector item with tooltip already set.
24530 * @return style the theme style in use, defaults to "default". If the
24531 * object does not have a tooltip set, then NULL is returned.
24533 * @see elm_object_tooltip_style_get() for more details.
24534 * @see elm_diskselector_item_tooltip_style_set()
24536 * @ingroup Diskselector
24538 EAPI const char *elm_diskselector_item_tooltip_style_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24541 * Set the cursor to be shown when mouse is over the diskselector item
24543 * @param item Target item
24544 * @param cursor the cursor name to be used.
24546 * @see elm_object_cursor_set() for more details.
24548 * @ingroup Diskselector
24550 EAPI void elm_diskselector_item_cursor_set(Elm_Diskselector_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
24553 * Get the cursor to be shown when mouse is over the diskselector item
24555 * @param item diskselector item with cursor already set.
24556 * @return the cursor name.
24558 * @see elm_object_cursor_get() for more details.
24559 * @see elm_diskselector_cursor_set()
24561 * @ingroup Diskselector
24563 EAPI const char *elm_diskselector_item_cursor_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24567 * Unset the cursor to be shown when mouse is over the diskselector item
24569 * @param item Target item
24571 * @see elm_object_cursor_unset() for more details.
24572 * @see elm_diskselector_cursor_set()
24574 * @ingroup Diskselector
24576 EAPI void elm_diskselector_item_cursor_unset(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24579 * Sets a different style for this item cursor.
24581 * @note before you set a style you should define a cursor with
24582 * elm_diskselector_item_cursor_set()
24584 * @param item diskselector item with cursor already set.
24585 * @param style the theme style to use (default, transparent, ...)
24587 * @see elm_object_cursor_style_set() for more details.
24589 * @ingroup Diskselector
24591 EAPI void elm_diskselector_item_cursor_style_set(Elm_Diskselector_Item *item, const char *style) EINA_ARG_NONNULL(1);
24595 * Get the style for this item cursor.
24597 * @param item diskselector item with cursor already set.
24598 * @return style the theme style in use, defaults to "default". If the
24599 * object does not have a cursor set, then @c NULL is returned.
24601 * @see elm_object_cursor_style_get() for more details.
24602 * @see elm_diskselector_item_cursor_style_set()
24604 * @ingroup Diskselector
24606 EAPI const char *elm_diskselector_item_cursor_style_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24610 * Set if the cursor set should be searched on the theme or should use
24611 * the provided by the engine, only.
24613 * @note before you set if should look on theme you should define a cursor
24614 * with elm_diskselector_item_cursor_set().
24615 * By default it will only look for cursors provided by the engine.
24617 * @param item widget item with cursor already set.
24618 * @param engine_only boolean to define if cursors set with
24619 * elm_diskselector_item_cursor_set() should be searched only
24620 * between cursors provided by the engine or searched on widget's
24623 * @see elm_object_cursor_engine_only_set() for more details.
24625 * @ingroup Diskselector
24627 EAPI void elm_diskselector_item_cursor_engine_only_set(Elm_Diskselector_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
24630 * Get the cursor engine only usage for this item cursor.
24632 * @param item widget item with cursor already set.
24633 * @return engine_only boolean to define it cursors should be looked only
24634 * between the provided by the engine or searched on widget's theme as well.
24635 * If the item does not have a cursor set, then @c EINA_FALSE is returned.
24637 * @see elm_object_cursor_engine_only_get() for more details.
24638 * @see elm_diskselector_item_cursor_engine_only_set()
24640 * @ingroup Diskselector
24642 EAPI Eina_Bool elm_diskselector_item_cursor_engine_only_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24649 * @defgroup Colorselector Colorselector
24653 * @image html img/widget/colorselector/preview-00.png
24654 * @image latex img/widget/colorselector/preview-00.eps
24656 * @brief Widget for user to select a color.
24658 * Signals that you can add callbacks for are:
24659 * "changed" - When the color value changes(event_info is NULL).
24661 * See @ref tutorial_colorselector.
24664 * @brief Add a new colorselector to the parent
24666 * @param parent The parent object
24667 * @return The new object or NULL if it cannot be created
24669 * @ingroup Colorselector
24671 EAPI Evas_Object *elm_colorselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24673 * Set a color for the colorselector
24675 * @param obj Colorselector object
24676 * @param r r-value of color
24677 * @param g g-value of color
24678 * @param b b-value of color
24679 * @param a a-value of color
24681 * @ingroup Colorselector
24683 EAPI void elm_colorselector_color_set(Evas_Object *obj, int r, int g , int b, int a) EINA_ARG_NONNULL(1);
24685 * Get a color from the colorselector
24687 * @param obj Colorselector object
24688 * @param r integer pointer for r-value of color
24689 * @param g integer pointer for g-value of color
24690 * @param b integer pointer for b-value of color
24691 * @param a integer pointer for a-value of color
24693 * @ingroup Colorselector
24695 EAPI void elm_colorselector_color_get(const Evas_Object *obj, int *r, int *g , int *b, int *a) EINA_ARG_NONNULL(1);
24701 * @defgroup Ctxpopup Ctxpopup
24703 * @image html img/widget/ctxpopup/preview-00.png
24704 * @image latex img/widget/ctxpopup/preview-00.eps
24706 * @brief Context popup widet.
24708 * A ctxpopup is a widget that, when shown, pops up a list of items.
24709 * It automatically chooses an area inside its parent object's view
24710 * (set via elm_ctxpopup_add() and elm_ctxpopup_hover_parent_set()) to
24711 * optimally fit into it. In the default theme, it will also point an
24712 * arrow to it's top left position at the time one shows it. Ctxpopup
24713 * items have a label and/or an icon. It is intended for a small
24714 * number of items (hence the use of list, not genlist).
24716 * @note Ctxpopup is a especialization of @ref Hover.
24718 * Signals that you can add callbacks for are:
24719 * "dismissed" - the ctxpopup was dismissed
24721 * @ref tutorial_ctxpopup shows the usage of a good deal of the API.
24724 typedef enum _Elm_Ctxpopup_Direction
24726 ELM_CTXPOPUP_DIRECTION_DOWN, /**< ctxpopup show appear below clicked
24728 ELM_CTXPOPUP_DIRECTION_RIGHT, /**< ctxpopup show appear to the right of
24729 the clicked area */
24730 ELM_CTXPOPUP_DIRECTION_LEFT, /**< ctxpopup show appear to the left of
24731 the clicked area */
24732 ELM_CTXPOPUP_DIRECTION_UP, /**< ctxpopup show appear above the clicked
24734 } Elm_Ctxpopup_Direction;
24737 * @brief Add a new Ctxpopup object to the parent.
24739 * @param parent Parent object
24740 * @return New object or @c NULL, if it cannot be created
24742 EAPI Evas_Object *elm_ctxpopup_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24744 * @brief Set the Ctxpopup's parent
24746 * @param obj The ctxpopup object
24747 * @param area The parent to use
24749 * Set the parent object.
24751 * @note elm_ctxpopup_add() will automatically call this function
24752 * with its @c parent argument.
24754 * @see elm_ctxpopup_add()
24755 * @see elm_hover_parent_set()
24757 EAPI void elm_ctxpopup_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1, 2);
24759 * @brief Get the Ctxpopup's parent
24761 * @param obj The ctxpopup object
24763 * @see elm_ctxpopup_hover_parent_set() for more information
24765 EAPI Evas_Object *elm_ctxpopup_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24767 * @brief Clear all items in the given ctxpopup object.
24769 * @param obj Ctxpopup object
24771 EAPI void elm_ctxpopup_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
24773 * @brief Change the ctxpopup's orientation to horizontal or vertical.
24775 * @param obj Ctxpopup object
24776 * @param horizontal @c EINA_TRUE for horizontal mode, @c EINA_FALSE for vertical
24778 EAPI void elm_ctxpopup_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
24780 * @brief Get the value of current ctxpopup object's orientation.
24782 * @param obj Ctxpopup object
24783 * @return @c EINA_TRUE for horizontal mode, @c EINA_FALSE for vertical mode (or errors)
24785 * @see elm_ctxpopup_horizontal_set()
24787 EAPI Eina_Bool elm_ctxpopup_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24789 * @brief Add a new item to a ctxpopup object.
24791 * @param obj Ctxpopup object
24792 * @param icon Icon to be set on new item
24793 * @param label The Label of the new item
24794 * @param func Convenience function called when item selected
24795 * @param data Data passed to @p func
24796 * @return A handle to the item added or @c NULL, on errors
24798 * @warning Ctxpopup can't hold both an item list and a content at the same
24799 * time. When an item is added, any previous content will be removed.
24801 * @see elm_ctxpopup_content_set()
24803 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);
24805 * @brief Delete the given item in a ctxpopup object.
24807 * @param it Ctxpopup item to be deleted
24809 * @see elm_ctxpopup_item_append()
24811 EAPI void elm_ctxpopup_item_del(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
24813 * @brief Set the ctxpopup item's state as disabled or enabled.
24815 * @param it Ctxpopup item to be enabled/disabled
24816 * @param disabled @c EINA_TRUE to disable it, @c EINA_FALSE to enable it
24818 * When disabled the item is greyed out to indicate it's state.
24820 EAPI void elm_ctxpopup_item_disabled_set(Elm_Object_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1);
24822 * @brief Get the ctxpopup item's disabled/enabled state.
24824 * @param it Ctxpopup item to be enabled/disabled
24825 * @return disabled @c EINA_TRUE, if disabled, @c EINA_FALSE otherwise
24827 * @see elm_ctxpopup_item_disabled_set()
24829 EAPI Eina_Bool elm_ctxpopup_item_disabled_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
24831 * @brief Get the icon object for the given ctxpopup item.
24833 * @param it Ctxpopup item
24834 * @return icon object or @c NULL, if the item does not have icon or an error
24837 * @see elm_ctxpopup_item_append()
24838 * @see elm_ctxpopup_item_icon_set()
24840 EAPI Evas_Object *elm_ctxpopup_item_icon_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
24842 * @brief Sets the side icon associated with the ctxpopup item
24844 * @param it Ctxpopup item
24845 * @param icon Icon object to be set
24847 * Once the icon object is set, a previously set one will be deleted.
24848 * @warning Setting the same icon for two items will cause the icon to
24849 * dissapear from the first item.
24851 * @see elm_ctxpopup_item_append()
24853 EAPI void elm_ctxpopup_item_icon_set(Elm_Object_Item *it, Evas_Object *icon) EINA_ARG_NONNULL(1);
24855 * @brief Get the label for the given ctxpopup item.
24857 * @param it Ctxpopup item
24858 * @return label string or @c NULL, if the item does not have label or an
24861 * @see elm_ctxpopup_item_append()
24862 * @see elm_ctxpopup_item_label_set()
24864 EAPI const char *elm_ctxpopup_item_label_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
24866 * @brief (Re)set the label on the given ctxpopup item.
24868 * @param it Ctxpopup item
24869 * @param label String to set as label
24871 EAPI void elm_ctxpopup_item_label_set(Elm_Object_Item *it, const char *label) EINA_ARG_NONNULL(1);
24873 * @brief Set an elm widget as the content of the ctxpopup.
24875 * @param obj Ctxpopup object
24876 * @param content Content to be swallowed
24878 * If the content object is already set, a previous one will bedeleted. If
24879 * you want to keep that old content object, use the
24880 * elm_ctxpopup_content_unset() function.
24882 * @deprecated use elm_object_content_set()
24884 * @warning Ctxpopup can't hold both a item list and a content at the same
24885 * time. When a content is set, any previous items will be removed.
24887 EINA_DEPRECATED EAPI void elm_ctxpopup_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1, 2);
24889 * @brief Unset the ctxpopup content
24891 * @param obj Ctxpopup object
24892 * @return The content that was being used
24894 * Unparent and return the content object which was set for this widget.
24896 * @deprecated use elm_object_content_unset()
24898 * @see elm_ctxpopup_content_set()
24900 EINA_DEPRECATED EAPI Evas_Object *elm_ctxpopup_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24902 * @brief Set the direction priority of a ctxpopup.
24904 * @param obj Ctxpopup object
24905 * @param first 1st priority of direction
24906 * @param second 2nd priority of direction
24907 * @param third 3th priority of direction
24908 * @param fourth 4th priority of direction
24910 * This functions gives a chance to user to set the priority of ctxpopup
24911 * showing direction. This doesn't guarantee the ctxpopup will appear in the
24912 * requested direction.
24914 * @see Elm_Ctxpopup_Direction
24916 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);
24918 * @brief Get the direction priority of a ctxpopup.
24920 * @param obj Ctxpopup object
24921 * @param first 1st priority of direction to be returned
24922 * @param second 2nd priority of direction to be returned
24923 * @param third 3th priority of direction to be returned
24924 * @param fourth 4th priority of direction to be returned
24926 * @see elm_ctxpopup_direction_priority_set() for more information.
24928 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);
24936 * @defgroup Transit Transit
24937 * @ingroup Elementary
24939 * Transit is designed to apply various animated transition effects to @c
24940 * Evas_Object, such like translation, rotation, etc. For using these
24941 * effects, create an @ref Elm_Transit and add the desired transition effects.
24943 * Once the effects are added into transit, they will be automatically
24944 * managed (their callback will be called until the duration is ended, and
24945 * they will be deleted on completion).
24949 * Elm_Transit *trans = elm_transit_add();
24950 * elm_transit_object_add(trans, obj);
24951 * elm_transit_effect_translation_add(trans, 0, 0, 280, 280
24952 * elm_transit_duration_set(transit, 1);
24953 * elm_transit_auto_reverse_set(transit, EINA_TRUE);
24954 * elm_transit_tween_mode_set(transit, ELM_TRANSIT_TWEEN_MODE_DECELERATE);
24955 * elm_transit_repeat_times_set(transit, 3);
24958 * Some transition effects are used to change the properties of objects. They
24960 * @li @ref elm_transit_effect_translation_add
24961 * @li @ref elm_transit_effect_color_add
24962 * @li @ref elm_transit_effect_rotation_add
24963 * @li @ref elm_transit_effect_wipe_add
24964 * @li @ref elm_transit_effect_zoom_add
24965 * @li @ref elm_transit_effect_resizing_add
24967 * Other transition effects are used to make one object disappear and another
24968 * object appear on its old place. These effects are:
24970 * @li @ref elm_transit_effect_flip_add
24971 * @li @ref elm_transit_effect_resizable_flip_add
24972 * @li @ref elm_transit_effect_fade_add
24973 * @li @ref elm_transit_effect_blend_add
24975 * It's also possible to make a transition chain with @ref
24976 * elm_transit_chain_transit_add.
24978 * @warning We strongly recommend to use elm_transit just when edje can not do
24979 * the trick. Edje has more advantage than Elm_Transit, it has more flexibility and
24980 * animations can be manipulated inside the theme.
24982 * List of examples:
24983 * @li @ref transit_example_01_explained
24984 * @li @ref transit_example_02_explained
24985 * @li @ref transit_example_03_c
24986 * @li @ref transit_example_04_c
24992 * @enum Elm_Transit_Tween_Mode
24994 * The type of acceleration used in the transition.
24998 ELM_TRANSIT_TWEEN_MODE_LINEAR, /**< Constant speed */
24999 ELM_TRANSIT_TWEEN_MODE_SINUSOIDAL, /**< Starts slow, increase speed
25000 over time, then decrease again
25002 ELM_TRANSIT_TWEEN_MODE_DECELERATE, /**< Starts fast and decrease
25004 ELM_TRANSIT_TWEEN_MODE_ACCELERATE /**< Starts slow and increase speed
25006 } Elm_Transit_Tween_Mode;
25009 * @enum Elm_Transit_Effect_Flip_Axis
25011 * The axis where flip effect should be applied.
25015 ELM_TRANSIT_EFFECT_FLIP_AXIS_X, /**< Flip on X axis */
25016 ELM_TRANSIT_EFFECT_FLIP_AXIS_Y /**< Flip on Y axis */
25017 } Elm_Transit_Effect_Flip_Axis;
25019 * @enum Elm_Transit_Effect_Wipe_Dir
25021 * The direction where the wipe effect should occur.
25025 ELM_TRANSIT_EFFECT_WIPE_DIR_LEFT, /**< Wipe to the left */
25026 ELM_TRANSIT_EFFECT_WIPE_DIR_RIGHT, /**< Wipe to the right */
25027 ELM_TRANSIT_EFFECT_WIPE_DIR_UP, /**< Wipe up */
25028 ELM_TRANSIT_EFFECT_WIPE_DIR_DOWN /**< Wipe down */
25029 } Elm_Transit_Effect_Wipe_Dir;
25030 /** @enum Elm_Transit_Effect_Wipe_Type
25032 * Whether the wipe effect should show or hide the object.
25036 ELM_TRANSIT_EFFECT_WIPE_TYPE_HIDE, /**< Hide the object during the
25038 ELM_TRANSIT_EFFECT_WIPE_TYPE_SHOW /**< Show the object during the
25040 } Elm_Transit_Effect_Wipe_Type;
25043 * @typedef Elm_Transit
25045 * The Transit created with elm_transit_add(). This type has the information
25046 * about the objects which the transition will be applied, and the
25047 * transition effects that will be used. It also contains info about
25048 * duration, number of repetitions, auto-reverse, etc.
25050 typedef struct _Elm_Transit Elm_Transit;
25051 typedef void Elm_Transit_Effect;
25053 * @typedef Elm_Transit_Effect_Transition_Cb
25055 * Transition callback called for this effect on each transition iteration.
25057 typedef void (*Elm_Transit_Effect_Transition_Cb) (Elm_Transit_Effect *effect, Elm_Transit *transit, double progress);
25059 * Elm_Transit_Effect_End_Cb
25061 * Transition callback called for this effect when the transition is over.
25063 typedef void (*Elm_Transit_Effect_End_Cb) (Elm_Transit_Effect *effect, Elm_Transit *transit);
25066 * Elm_Transit_Del_Cb
25068 * A callback called when the transit is deleted.
25070 typedef void (*Elm_Transit_Del_Cb) (void *data, Elm_Transit *transit);
25075 * @note Is not necessary to delete the transit object, it will be deleted at
25076 * the end of its operation.
25077 * @note The transit will start playing when the program enter in the main loop, is not
25078 * necessary to give a start to the transit.
25080 * @return The transit object.
25084 EAPI Elm_Transit *elm_transit_add(void);
25087 * Stops the animation and delete the @p transit object.
25089 * Call this function if you wants to stop the animation before the duration
25090 * time. Make sure the @p transit object is still alive with
25091 * elm_transit_del_cb_set() function.
25092 * All added effects will be deleted, calling its repective data_free_cb
25093 * functions. The function setted by elm_transit_del_cb_set() will be called.
25095 * @see elm_transit_del_cb_set()
25097 * @param transit The transit object to be deleted.
25100 * @warning Just call this function if you are sure the transit is alive.
25102 EAPI void elm_transit_del(Elm_Transit *transit) EINA_ARG_NONNULL(1);
25105 * Add a new effect to the transit.
25107 * @note The cb function and the data are the key to the effect. If you try to
25108 * add an already added effect, nothing is done.
25109 * @note After the first addition of an effect in @p transit, if its
25110 * effect list become empty again, the @p transit will be killed by
25111 * elm_transit_del(transit) function.
25115 * Elm_Transit *transit = elm_transit_add();
25116 * elm_transit_effect_add(transit,
25117 * elm_transit_effect_blend_op,
25118 * elm_transit_effect_blend_context_new(),
25119 * elm_transit_effect_blend_context_free);
25122 * @param transit The transit object.
25123 * @param transition_cb The operation function. It is called when the
25124 * animation begins, it is the function that actually performs the animation.
25125 * It is called with the @p data, @p transit and the time progression of the
25126 * animation (a double value between 0.0 and 1.0).
25127 * @param effect The context data of the effect.
25128 * @param end_cb The function to free the context data, it will be called
25129 * at the end of the effect, it must finalize the animation and free the
25133 * @warning The transit free the context data at the and of the transition with
25134 * the data_free_cb function, do not use the context data in another transit.
25136 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);
25139 * Delete an added effect.
25141 * This function will remove the effect from the @p transit, calling the
25142 * data_free_cb to free the @p data.
25144 * @see elm_transit_effect_add()
25146 * @note If the effect is not found, nothing is done.
25147 * @note If the effect list become empty, this function will call
25148 * elm_transit_del(transit), that is, it will kill the @p transit.
25150 * @param transit The transit object.
25151 * @param transition_cb The operation function.
25152 * @param effect The context data of the effect.
25156 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);
25159 * Add new object to apply the effects.
25161 * @note After the first addition of an object in @p transit, if its
25162 * object list become empty again, the @p transit will be killed by
25163 * elm_transit_del(transit) function.
25164 * @note If the @p obj belongs to another transit, the @p obj will be
25165 * removed from it and it will only belong to the @p transit. If the old
25166 * transit stays without objects, it will die.
25167 * @note When you add an object into the @p transit, its state from
25168 * evas_object_pass_events_get(obj) is saved, and it is applied when the
25169 * transit ends, if you change this state whith evas_object_pass_events_set()
25170 * after add the object, this state will change again when @p transit stops to
25173 * @param transit The transit object.
25174 * @param obj Object to be animated.
25177 * @warning It is not allowed to add a new object after transit begins to go.
25179 EAPI void elm_transit_object_add(Elm_Transit *transit, Evas_Object *obj) EINA_ARG_NONNULL(1, 2);
25182 * Removes an added object from the transit.
25184 * @note If the @p obj is not in the @p transit, nothing is done.
25185 * @note If the list become empty, this function will call
25186 * elm_transit_del(transit), that is, it will kill the @p transit.
25188 * @param transit The transit object.
25189 * @param obj Object to be removed from @p transit.
25192 * @warning It is not allowed to remove objects after transit begins to go.
25194 EAPI void elm_transit_object_remove(Elm_Transit *transit, Evas_Object *obj) EINA_ARG_NONNULL(1, 2);
25197 * Get the objects of the transit.
25199 * @param transit The transit object.
25200 * @return a Eina_List with the objects from the transit.
25204 EAPI const Eina_List *elm_transit_objects_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
25207 * Enable/disable keeping up the objects states.
25208 * If it is not kept, the objects states will be reset when transition ends.
25210 * @note @p transit can not be NULL.
25211 * @note One state includes geometry, color, map data.
25213 * @param transit The transit object.
25214 * @param state_keep Keeping or Non Keeping.
25218 EAPI void elm_transit_objects_final_state_keep_set(Elm_Transit *transit, Eina_Bool state_keep) EINA_ARG_NONNULL(1);
25221 * Get a value whether the objects states will be reset or not.
25223 * @note @p transit can not be NULL
25225 * @see elm_transit_objects_final_state_keep_set()
25227 * @param transit The transit object.
25228 * @return EINA_TRUE means the states of the objects will be reset.
25229 * If @p transit is NULL, EINA_FALSE is returned
25233 EAPI Eina_Bool elm_transit_objects_final_state_keep_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
25236 * Set the event enabled when transit is operating.
25238 * If @p enabled is EINA_TRUE, the objects of the transit will receives
25239 * events from mouse and keyboard during the animation.
25240 * @note When you add an object with elm_transit_object_add(), its state from
25241 * evas_object_pass_events_get(obj) is saved, and it is applied when the
25242 * transit ends, if you change this state with evas_object_pass_events_set()
25243 * after adding the object, this state will change again when @p transit stops
25246 * @param transit The transit object.
25247 * @param enabled Events are received when enabled is @c EINA_TRUE, and
25248 * ignored otherwise.
25252 EAPI void elm_transit_event_enabled_set(Elm_Transit *transit, Eina_Bool enabled) EINA_ARG_NONNULL(1);
25255 * Get the value of event enabled status.
25257 * @see elm_transit_event_enabled_set()
25259 * @param transit The Transit object
25260 * @return EINA_TRUE, when event is enabled. If @p transit is NULL
25261 * EINA_FALSE is returned
25265 EAPI Eina_Bool elm_transit_event_enabled_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
25268 * Set the user-callback function when the transit is deleted.
25270 * @note Using this function twice will overwrite the first function setted.
25271 * @note the @p transit object will be deleted after call @p cb function.
25273 * @param transit The transit object.
25274 * @param cb Callback function pointer. This function will be called before
25275 * the deletion of the transit.
25276 * @param data Callback funtion user data. It is the @p op parameter.
25280 EAPI void elm_transit_del_cb_set(Elm_Transit *transit, Elm_Transit_Del_Cb cb, void *data) EINA_ARG_NONNULL(1);
25283 * Set reverse effect automatically.
25285 * If auto reverse is setted, after running the effects with the progress
25286 * parameter from 0 to 1, it will call the effecs again with the progress
25287 * from 1 to 0. The transit will last for a time iqual to (2 * duration * repeat),
25288 * where the duration was setted with the function elm_transit_add and
25289 * the repeat with the function elm_transit_repeat_times_set().
25291 * @param transit The transit object.
25292 * @param reverse EINA_TRUE means the auto_reverse is on.
25296 EAPI void elm_transit_auto_reverse_set(Elm_Transit *transit, Eina_Bool reverse) EINA_ARG_NONNULL(1);
25299 * Get if the auto reverse is on.
25301 * @see elm_transit_auto_reverse_set()
25303 * @param transit The transit object.
25304 * @return EINA_TRUE means auto reverse is on. If @p transit is NULL
25305 * EINA_FALSE is returned
25309 EAPI Eina_Bool elm_transit_auto_reverse_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
25312 * Set the transit repeat count. Effect will be repeated by repeat count.
25314 * This function sets the number of repetition the transit will run after
25315 * the first one, that is, if @p repeat is 1, the transit will run 2 times.
25316 * If the @p repeat is a negative number, it will repeat infinite times.
25318 * @note If this function is called during the transit execution, the transit
25319 * will run @p repeat times, ignoring the times it already performed.
25321 * @param transit The transit object
25322 * @param repeat Repeat count
25326 EAPI void elm_transit_repeat_times_set(Elm_Transit *transit, int repeat) EINA_ARG_NONNULL(1);
25329 * Get the transit repeat count.
25331 * @see elm_transit_repeat_times_set()
25333 * @param transit The Transit object.
25334 * @return The repeat count. If @p transit is NULL
25339 EAPI int elm_transit_repeat_times_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
25342 * Set the transit animation acceleration type.
25344 * This function sets the tween mode of the transit that can be:
25345 * ELM_TRANSIT_TWEEN_MODE_LINEAR - The default mode.
25346 * ELM_TRANSIT_TWEEN_MODE_SINUSOIDAL - Starts in accelerate mode and ends decelerating.
25347 * ELM_TRANSIT_TWEEN_MODE_DECELERATE - The animation will be slowed over time.
25348 * ELM_TRANSIT_TWEEN_MODE_ACCELERATE - The animation will accelerate over time.
25350 * @param transit The transit object.
25351 * @param tween_mode The tween type.
25355 EAPI void elm_transit_tween_mode_set(Elm_Transit *transit, Elm_Transit_Tween_Mode tween_mode) EINA_ARG_NONNULL(1);
25358 * Get the transit animation acceleration type.
25360 * @note @p transit can not be NULL
25362 * @param transit The transit object.
25363 * @return The tween type. If @p transit is NULL
25364 * ELM_TRANSIT_TWEEN_MODE_LINEAR is returned.
25368 EAPI Elm_Transit_Tween_Mode elm_transit_tween_mode_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
25371 * Set the transit animation time
25373 * @note @p transit can not be NULL
25375 * @param transit The transit object.
25376 * @param duration The animation time.
25380 EAPI void elm_transit_duration_set(Elm_Transit *transit, double duration) EINA_ARG_NONNULL(1);
25383 * Get the transit animation time
25385 * @note @p transit can not be NULL
25387 * @param transit The transit object.
25389 * @return The transit animation time.
25393 EAPI double elm_transit_duration_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
25396 * Starts the transition.
25397 * Once this API is called, the transit begins to measure the time.
25399 * @note @p transit can not be NULL
25401 * @param transit The transit object.
25405 EAPI void elm_transit_go(Elm_Transit *transit) EINA_ARG_NONNULL(1);
25408 * Pause/Resume the transition.
25410 * If you call elm_transit_go again, the transit will be started from the
25411 * beginning, and will be unpaused.
25413 * @note @p transit can not be NULL
25415 * @param transit The transit object.
25416 * @param paused Whether the transition should be paused or not.
25420 EAPI void elm_transit_paused_set(Elm_Transit *transit, Eina_Bool paused) EINA_ARG_NONNULL(1);
25423 * Get the value of paused status.
25425 * @see elm_transit_paused_set()
25427 * @note @p transit can not be NULL
25429 * @param transit The transit object.
25430 * @return EINA_TRUE means transition is paused. If @p transit is NULL
25431 * EINA_FALSE is returned
25435 EAPI Eina_Bool elm_transit_paused_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
25438 * Get the time progression of the animation (a double value between 0.0 and 1.0).
25440 * The value returned is a fraction (current time / total time). It
25441 * represents the progression position relative to the total.
25443 * @note @p transit can not be NULL
25445 * @param transit The transit object.
25447 * @return The time progression value. If @p transit is NULL
25452 EAPI double elm_transit_progress_value_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
25455 * Makes the chain relationship between two transits.
25457 * @note @p transit can not be NULL. Transit would have multiple chain transits.
25458 * @note @p chain_transit can not be NULL. Chain transits could be chained to the only one transit.
25460 * @param transit The transit object.
25461 * @param chain_transit The chain transit object. This transit will be operated
25462 * after transit is done.
25464 * This function adds @p chain_transit transition to a chain after the @p
25465 * transit, and will be started as soon as @p transit ends. See @ref
25466 * transit_example_02_explained for a full example.
25470 EAPI void elm_transit_chain_transit_add(Elm_Transit *transit, Elm_Transit *chain_transit) EINA_ARG_NONNULL(1, 2);
25473 * Cut off the chain relationship between two transits.
25475 * @note @p transit can not be NULL. Transit would have the chain relationship with @p chain transit.
25476 * @note @p chain_transit can not be NULL. Chain transits should be chained to the @p transit.
25478 * @param transit The transit object.
25479 * @param chain_transit The chain transit object.
25481 * This function remove the @p chain_transit transition from the @p transit.
25485 EAPI void elm_transit_chain_transit_del(Elm_Transit *transit, Elm_Transit *chain_transit) EINA_ARG_NONNULL(1,2);
25488 * Get the current chain transit list.
25490 * @note @p transit can not be NULL.
25492 * @param transit The transit object.
25493 * @return chain transit list.
25497 EAPI Eina_List *elm_transit_chain_transits_get(const Elm_Transit *transit);
25500 * Add the Resizing Effect to Elm_Transit.
25502 * @note This API is one of the facades. It creates resizing effect context
25503 * and add it's required APIs to elm_transit_effect_add.
25505 * @see elm_transit_effect_add()
25507 * @param transit Transit object.
25508 * @param from_w Object width size when effect begins.
25509 * @param from_h Object height size when effect begins.
25510 * @param to_w Object width size when effect ends.
25511 * @param to_h Object height size when effect ends.
25512 * @return Resizing effect context data.
25516 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);
25519 * Add the Translation Effect to Elm_Transit.
25521 * @note This API is one of the facades. It creates translation effect context
25522 * and add it's required APIs to elm_transit_effect_add.
25524 * @see elm_transit_effect_add()
25526 * @param transit Transit object.
25527 * @param from_dx X Position variation when effect begins.
25528 * @param from_dy Y Position variation when effect begins.
25529 * @param to_dx X Position variation when effect ends.
25530 * @param to_dy Y Position variation when effect ends.
25531 * @return Translation effect context data.
25534 * @warning It is highly recommended just create a transit with this effect when
25535 * the window that the objects of the transit belongs has already been created.
25536 * This is because this effect needs the geometry information about the objects,
25537 * and if the window was not created yet, it can get a wrong information.
25539 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);
25542 * Add the Zoom Effect to Elm_Transit.
25544 * @note This API is one of the facades. It creates zoom effect context
25545 * and add it's required APIs to elm_transit_effect_add.
25547 * @see elm_transit_effect_add()
25549 * @param transit Transit object.
25550 * @param from_rate Scale rate when effect begins (1 is current rate).
25551 * @param to_rate Scale rate when effect ends.
25552 * @return Zoom effect context data.
25555 * @warning It is highly recommended just create a transit with this effect when
25556 * the window that the objects of the transit belongs has already been created.
25557 * This is because this effect needs the geometry information about the objects,
25558 * and if the window was not created yet, it can get a wrong information.
25560 EAPI Elm_Transit_Effect *elm_transit_effect_zoom_add(Elm_Transit *transit, float from_rate, float to_rate);
25563 * Add the Flip Effect to Elm_Transit.
25565 * @note This API is one of the facades. It creates flip effect context
25566 * and add it's required APIs to elm_transit_effect_add.
25567 * @note This effect is applied to each pair of objects in the order they are listed
25568 * in the transit list of objects. The first object in the pair will be the
25569 * "front" object and the second will be the "back" object.
25571 * @see elm_transit_effect_add()
25573 * @param transit Transit object.
25574 * @param axis Flipping Axis(X or Y).
25575 * @param cw Flipping Direction. EINA_TRUE is clock-wise.
25576 * @return Flip effect context data.
25579 * @warning It is highly recommended just create a transit with this effect when
25580 * the window that the objects of the transit belongs has already been created.
25581 * This is because this effect needs the geometry information about the objects,
25582 * and if the window was not created yet, it can get a wrong information.
25584 EAPI Elm_Transit_Effect *elm_transit_effect_flip_add(Elm_Transit *transit, Elm_Transit_Effect_Flip_Axis axis, Eina_Bool cw);
25587 * Add the Resizable Flip Effect to Elm_Transit.
25589 * @note This API is one of the facades. It creates resizable flip effect context
25590 * and add it's required APIs to elm_transit_effect_add.
25591 * @note This effect is applied to each pair of objects in the order they are listed
25592 * in the transit list of objects. The first object in the pair will be the
25593 * "front" object and the second will be the "back" object.
25595 * @see elm_transit_effect_add()
25597 * @param transit Transit object.
25598 * @param axis Flipping Axis(X or Y).
25599 * @param cw Flipping Direction. EINA_TRUE is clock-wise.
25600 * @return Resizable flip effect context data.
25603 * @warning It is highly recommended just create a transit with this effect when
25604 * the window that the objects of the transit belongs has already been created.
25605 * This is because this effect needs the geometry information about the objects,
25606 * and if the window was not created yet, it can get a wrong information.
25608 EAPI Elm_Transit_Effect *elm_transit_effect_resizable_flip_add(Elm_Transit *transit, Elm_Transit_Effect_Flip_Axis axis, Eina_Bool cw);
25611 * Add the Wipe Effect to Elm_Transit.
25613 * @note This API is one of the facades. It creates wipe effect context
25614 * and add it's required APIs to elm_transit_effect_add.
25616 * @see elm_transit_effect_add()
25618 * @param transit Transit object.
25619 * @param type Wipe type. Hide or show.
25620 * @param dir Wipe Direction.
25621 * @return Wipe effect context data.
25624 * @warning It is highly recommended just create a transit with this effect when
25625 * the window that the objects of the transit belongs has already been created.
25626 * This is because this effect needs the geometry information about the objects,
25627 * and if the window was not created yet, it can get a wrong information.
25629 EAPI Elm_Transit_Effect *elm_transit_effect_wipe_add(Elm_Transit *transit, Elm_Transit_Effect_Wipe_Type type, Elm_Transit_Effect_Wipe_Dir dir);
25632 * Add the Color Effect to Elm_Transit.
25634 * @note This API is one of the facades. It creates color effect context
25635 * and add it's required APIs to elm_transit_effect_add.
25637 * @see elm_transit_effect_add()
25639 * @param transit Transit object.
25640 * @param from_r RGB R when effect begins.
25641 * @param from_g RGB G when effect begins.
25642 * @param from_b RGB B when effect begins.
25643 * @param from_a RGB A when effect begins.
25644 * @param to_r RGB R when effect ends.
25645 * @param to_g RGB G when effect ends.
25646 * @param to_b RGB B when effect ends.
25647 * @param to_a RGB A when effect ends.
25648 * @return Color effect context data.
25652 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);
25655 * Add the Fade Effect to Elm_Transit.
25657 * @note This API is one of the facades. It creates fade effect context
25658 * and add it's required APIs to elm_transit_effect_add.
25659 * @note This effect is applied to each pair of objects in the order they are listed
25660 * in the transit list of objects. The first object in the pair will be the
25661 * "before" object and the second will be the "after" object.
25663 * @see elm_transit_effect_add()
25665 * @param transit Transit object.
25666 * @return Fade effect context data.
25669 * @warning It is highly recommended just create a transit with this effect when
25670 * the window that the objects of the transit belongs has already been created.
25671 * This is because this effect needs the color information about the objects,
25672 * and if the window was not created yet, it can get a wrong information.
25674 EAPI Elm_Transit_Effect *elm_transit_effect_fade_add(Elm_Transit *transit);
25677 * Add the Blend Effect to Elm_Transit.
25679 * @note This API is one of the facades. It creates blend effect context
25680 * and add it's required APIs to elm_transit_effect_add.
25681 * @note This effect is applied to each pair of objects in the order they are listed
25682 * in the transit list of objects. The first object in the pair will be the
25683 * "before" object and the second will be the "after" object.
25685 * @see elm_transit_effect_add()
25687 * @param transit Transit object.
25688 * @return Blend effect context data.
25691 * @warning It is highly recommended just create a transit with this effect when
25692 * the window that the objects of the transit belongs has already been created.
25693 * This is because this effect needs the color information about the objects,
25694 * and if the window was not created yet, it can get a wrong information.
25696 EAPI Elm_Transit_Effect *elm_transit_effect_blend_add(Elm_Transit *transit);
25699 * Add the Rotation Effect to Elm_Transit.
25701 * @note This API is one of the facades. It creates rotation effect context
25702 * and add it's required APIs to elm_transit_effect_add.
25704 * @see elm_transit_effect_add()
25706 * @param transit Transit object.
25707 * @param from_degree Degree when effect begins.
25708 * @param to_degree Degree when effect is ends.
25709 * @return Rotation effect context data.
25712 * @warning It is highly recommended just create a transit with this effect when
25713 * the window that the objects of the transit belongs has already been created.
25714 * This is because this effect needs the geometry information about the objects,
25715 * and if the window was not created yet, it can get a wrong information.
25717 EAPI Elm_Transit_Effect *elm_transit_effect_rotation_add(Elm_Transit *transit, float from_degree, float to_degree);
25720 * Add the ImageAnimation Effect to Elm_Transit.
25722 * @note This API is one of the facades. It creates image animation effect context
25723 * and add it's required APIs to elm_transit_effect_add.
25724 * The @p images parameter is a list images paths. This list and
25725 * its contents will be deleted at the end of the effect by
25726 * elm_transit_effect_image_animation_context_free() function.
25730 * char buf[PATH_MAX];
25731 * Eina_List *images = NULL;
25732 * Elm_Transit *transi = elm_transit_add();
25734 * snprintf(buf, sizeof(buf), "%s/images/icon_11.png", PACKAGE_DATA_DIR);
25735 * images = eina_list_append(images, eina_stringshare_add(buf));
25737 * snprintf(buf, sizeof(buf), "%s/images/logo_small.png", PACKAGE_DATA_DIR);
25738 * images = eina_list_append(images, eina_stringshare_add(buf));
25739 * elm_transit_effect_image_animation_add(transi, images);
25743 * @see elm_transit_effect_add()
25745 * @param transit Transit object.
25746 * @param images Eina_List of images file paths. This list and
25747 * its contents will be deleted at the end of the effect by
25748 * elm_transit_effect_image_animation_context_free() function.
25749 * @return Image Animation effect context data.
25753 EAPI Elm_Transit_Effect *elm_transit_effect_image_animation_add(Elm_Transit *transit, Eina_List *images);
25758 typedef struct _Elm_Store Elm_Store;
25759 typedef struct _Elm_Store_Filesystem Elm_Store_Filesystem;
25760 typedef struct _Elm_Store_Item Elm_Store_Item;
25761 typedef struct _Elm_Store_Item_Filesystem Elm_Store_Item_Filesystem;
25762 typedef struct _Elm_Store_Item_Info Elm_Store_Item_Info;
25763 typedef struct _Elm_Store_Item_Info_Filesystem Elm_Store_Item_Info_Filesystem;
25764 typedef struct _Elm_Store_Item_Mapping Elm_Store_Item_Mapping;
25765 typedef struct _Elm_Store_Item_Mapping_Empty Elm_Store_Item_Mapping_Empty;
25766 typedef struct _Elm_Store_Item_Mapping_Icon Elm_Store_Item_Mapping_Icon;
25767 typedef struct _Elm_Store_Item_Mapping_Photo Elm_Store_Item_Mapping_Photo;
25768 typedef struct _Elm_Store_Item_Mapping_Custom Elm_Store_Item_Mapping_Custom;
25770 typedef Eina_Bool (*Elm_Store_Item_List_Cb) (void *data, Elm_Store_Item_Info *info);
25771 typedef void (*Elm_Store_Item_Fetch_Cb) (void *data, Elm_Store_Item *sti);
25772 typedef void (*Elm_Store_Item_Unfetch_Cb) (void *data, Elm_Store_Item *sti);
25773 typedef void *(*Elm_Store_Item_Mapping_Cb) (void *data, Elm_Store_Item *sti, const char *part);
25777 ELM_STORE_ITEM_MAPPING_NONE = 0,
25778 ELM_STORE_ITEM_MAPPING_LABEL, // const char * -> label
25779 ELM_STORE_ITEM_MAPPING_STATE, // Eina_Bool -> state
25780 ELM_STORE_ITEM_MAPPING_ICON, // char * -> icon path
25781 ELM_STORE_ITEM_MAPPING_PHOTO, // char * -> photo path
25782 ELM_STORE_ITEM_MAPPING_CUSTOM, // item->custom(it->data, it, part) -> void * (-> any)
25783 // can add more here as needed by common apps
25784 ELM_STORE_ITEM_MAPPING_LAST
25785 } Elm_Store_Item_Mapping_Type;
25787 struct _Elm_Store_Item_Mapping_Icon
25789 // FIXME: allow edje file icons
25791 Elm_Icon_Lookup_Order lookup_order;
25792 Eina_Bool standard_name : 1;
25793 Eina_Bool no_scale : 1;
25794 Eina_Bool smooth : 1;
25795 Eina_Bool scale_up : 1;
25796 Eina_Bool scale_down : 1;
25799 struct _Elm_Store_Item_Mapping_Empty
25804 struct _Elm_Store_Item_Mapping_Photo
25809 struct _Elm_Store_Item_Mapping_Custom
25811 Elm_Store_Item_Mapping_Cb func;
25814 struct _Elm_Store_Item_Mapping
25816 Elm_Store_Item_Mapping_Type type;
25821 Elm_Store_Item_Mapping_Empty empty;
25822 Elm_Store_Item_Mapping_Icon icon;
25823 Elm_Store_Item_Mapping_Photo photo;
25824 Elm_Store_Item_Mapping_Custom custom;
25825 // add more types here
25829 struct _Elm_Store_Item_Info
25831 Elm_Genlist_Item_Class *item_class;
25832 const Elm_Store_Item_Mapping *mapping;
25837 struct _Elm_Store_Item_Info_Filesystem
25839 Elm_Store_Item_Info base;
25843 #define ELM_STORE_ITEM_MAPPING_END { ELM_STORE_ITEM_MAPPING_NONE, NULL, 0, { .empty = { EINA_TRUE } } }
25844 #define ELM_STORE_ITEM_MAPPING_OFFSET(st, it) offsetof(st, it)
25846 EAPI void elm_store_free(Elm_Store *st);
25848 EAPI Elm_Store *elm_store_filesystem_new(void);
25849 EAPI void elm_store_filesystem_directory_set(Elm_Store *st, const char *dir) EINA_ARG_NONNULL(1);
25850 EAPI const char *elm_store_filesystem_directory_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
25851 EAPI const char *elm_store_item_filesystem_path_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
25853 EAPI void elm_store_target_genlist_set(Elm_Store *st, Evas_Object *obj) EINA_ARG_NONNULL(1);
25855 EAPI void elm_store_cache_set(Elm_Store *st, int max) EINA_ARG_NONNULL(1);
25856 EAPI int elm_store_cache_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
25857 EAPI void elm_store_list_func_set(Elm_Store *st, Elm_Store_Item_List_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
25858 EAPI void elm_store_fetch_func_set(Elm_Store *st, Elm_Store_Item_Fetch_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
25859 EAPI void elm_store_fetch_thread_set(Elm_Store *st, Eina_Bool use_thread) EINA_ARG_NONNULL(1);
25860 EAPI Eina_Bool elm_store_fetch_thread_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
25862 EAPI void elm_store_unfetch_func_set(Elm_Store *st, Elm_Store_Item_Unfetch_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
25863 EAPI void elm_store_sorted_set(Elm_Store *st, Eina_Bool sorted) EINA_ARG_NONNULL(1);
25864 EAPI Eina_Bool elm_store_sorted_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
25865 EAPI void elm_store_item_data_set(Elm_Store_Item *sti, void *data) EINA_ARG_NONNULL(1);
25866 EAPI void *elm_store_item_data_get(Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
25867 EAPI const Elm_Store *elm_store_item_store_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
25868 EAPI const Elm_Genlist_Item *elm_store_item_genlist_item_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
25871 * @defgroup SegmentControl SegmentControl
25872 * @ingroup Elementary
25874 * @image html img/widget/segment_control/preview-00.png
25875 * @image latex img/widget/segment_control/preview-00.eps width=\textwidth
25877 * @image html img/segment_control.png
25878 * @image latex img/segment_control.eps width=\textwidth
25880 * Segment control widget is a horizontal control made of multiple segment
25881 * items, each segment item functioning similar to discrete two state button.
25882 * A segment control groups the items together and provides compact
25883 * single button with multiple equal size segments.
25885 * Segment item size is determined by base widget
25886 * size and the number of items added.
25887 * Only one segment item can be at selected state. A segment item can display
25888 * combination of Text and any Evas_Object like Images or other widget.
25890 * Smart callbacks one can listen to:
25891 * - "changed" - When the user clicks on a segment item which is not
25892 * previously selected and get selected. The event_info parameter is the
25893 * segment item index.
25895 * Available styles for it:
25898 * Here is an example on its usage:
25899 * @li @ref segment_control_example
25903 * @addtogroup SegmentControl
25907 typedef struct _Elm_Segment_Item Elm_Segment_Item; /**< Item handle for a segment control widget. */
25910 * Add a new segment control widget to the given parent Elementary
25911 * (container) object.
25913 * @param parent The parent object.
25914 * @return a new segment control widget handle or @c NULL, on errors.
25916 * This function inserts a new segment control widget on the canvas.
25918 * @ingroup SegmentControl
25920 EAPI Evas_Object *elm_segment_control_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
25923 * Append a new item to the segment control object.
25925 * @param obj The segment control object.
25926 * @param icon The icon object to use for the left side of the item. An
25927 * icon can be any Evas object, but usually it is an icon created
25928 * with elm_icon_add().
25929 * @param label The label of the item.
25930 * Note that, NULL is different from empty string "".
25931 * @return The created item or @c NULL upon failure.
25933 * A new item will be created and appended to the segment control, i.e., will
25934 * be set as @b last item.
25936 * If it should be inserted at another position,
25937 * elm_segment_control_item_insert_at() should be used instead.
25939 * Items created with this function can be deleted with function
25940 * elm_segment_control_item_del() or elm_segment_control_item_del_at().
25942 * @note @p label set to @c NULL is different from empty string "".
25944 * only has icon, it will be displayed bigger and centered. If it has
25945 * icon and label, even that an empty string, icon will be smaller and
25946 * positioned at left.
25950 * sc = elm_segment_control_add(win);
25951 * ic = elm_icon_add(win);
25952 * elm_icon_file_set(ic, "path/to/image", NULL);
25953 * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
25954 * elm_segment_control_item_add(sc, ic, "label");
25955 * evas_object_show(sc);
25958 * @see elm_segment_control_item_insert_at()
25959 * @see elm_segment_control_item_del()
25961 * @ingroup SegmentControl
25963 EAPI Elm_Segment_Item *elm_segment_control_item_add(Evas_Object *obj, Evas_Object *icon, const char *label) EINA_ARG_NONNULL(1);
25966 * Insert a new item to the segment control object at specified position.
25968 * @param obj The segment control object.
25969 * @param icon The icon object to use for the left side of the item. An
25970 * icon can be any Evas object, but usually it is an icon created
25971 * with elm_icon_add().
25972 * @param label The label of the item.
25973 * @param index Item position. Value should be between 0 and items count.
25974 * @return The created item or @c NULL upon failure.
25976 * Index values must be between @c 0, when item will be prepended to
25977 * segment control, and items count, that can be get with
25978 * elm_segment_control_item_count_get(), case when item will be appended
25979 * to segment control, just like elm_segment_control_item_add().
25981 * Items created with this function can be deleted with function
25982 * elm_segment_control_item_del() or elm_segment_control_item_del_at().
25984 * @note @p label set to @c NULL is different from empty string "".
25986 * only has icon, it will be displayed bigger and centered. If it has
25987 * icon and label, even that an empty string, icon will be smaller and
25988 * positioned at left.
25990 * @see elm_segment_control_item_add()
25991 * @see elm_segment_control_count_get()
25992 * @see elm_segment_control_item_del()
25994 * @ingroup SegmentControl
25996 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);
25999 * Remove a segment control item from its parent, deleting it.
26001 * @param it The item to be removed.
26003 * Items can be added with elm_segment_control_item_add() or
26004 * elm_segment_control_item_insert_at().
26006 * @ingroup SegmentControl
26008 EAPI void elm_segment_control_item_del(Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
26011 * Remove a segment control item at given index from its parent,
26014 * @param obj The segment control object.
26015 * @param index The position of the segment control item to be deleted.
26017 * Items can be added with elm_segment_control_item_add() or
26018 * elm_segment_control_item_insert_at().
26020 * @ingroup SegmentControl
26022 EAPI void elm_segment_control_item_del_at(Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
26025 * Get the Segment items count from segment control.
26027 * @param obj The segment control object.
26028 * @return Segment items count.
26030 * It will just return the number of items added to segment control @p obj.
26032 * @ingroup SegmentControl
26034 EAPI int elm_segment_control_item_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26037 * Get the item placed at specified index.
26039 * @param obj The segment control object.
26040 * @param index The index of the segment item.
26041 * @return The segment control item or @c NULL on failure.
26043 * Index is the position of an item in segment control widget. Its
26044 * range is from @c 0 to <tt> count - 1 </tt>.
26045 * Count is the number of items, that can be get with
26046 * elm_segment_control_item_count_get().
26048 * @ingroup SegmentControl
26050 EAPI Elm_Segment_Item *elm_segment_control_item_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
26053 * Get the label of item.
26055 * @param obj The segment control object.
26056 * @param index The index of the segment item.
26057 * @return The label of the item at @p index.
26059 * The return value is a pointer to the label associated to the item when
26060 * it was created, with function elm_segment_control_item_add(), or later
26061 * with function elm_segment_control_item_label_set. If no label
26062 * was passed as argument, it will return @c NULL.
26064 * @see elm_segment_control_item_label_set() for more details.
26065 * @see elm_segment_control_item_add()
26067 * @ingroup SegmentControl
26069 EAPI const char *elm_segment_control_item_label_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
26072 * Set the label of item.
26074 * @param it The item of segment control.
26075 * @param text The label of item.
26077 * The label to be displayed by the item.
26078 * Label will be at right of the icon (if set).
26080 * If a label was passed as argument on item creation, with function
26081 * elm_control_segment_item_add(), it will be already
26082 * displayed by the item.
26084 * @see elm_segment_control_item_label_get()
26085 * @see elm_segment_control_item_add()
26087 * @ingroup SegmentControl
26089 EAPI void elm_segment_control_item_label_set(Elm_Segment_Item* it, const char* label) EINA_ARG_NONNULL(1);
26092 * Get the icon associated to the item.
26094 * @param obj The segment control object.
26095 * @param index The index of the segment item.
26096 * @return The left side icon associated to the item at @p index.
26098 * The return value is a pointer to the icon associated to the item when
26099 * it was created, with function elm_segment_control_item_add(), or later
26100 * with function elm_segment_control_item_icon_set(). If no icon
26101 * was passed as argument, it will return @c NULL.
26103 * @see elm_segment_control_item_add()
26104 * @see elm_segment_control_item_icon_set()
26106 * @ingroup SegmentControl
26108 EAPI Evas_Object *elm_segment_control_item_icon_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
26111 * Set the icon associated to the item.
26113 * @param it The segment control item.
26114 * @param icon The icon object to associate with @p it.
26116 * The icon object to use at left side of the item. An
26117 * icon can be any Evas object, but usually it is an icon created
26118 * with elm_icon_add().
26120 * Once the icon object is set, a previously set one will be deleted.
26121 * @warning Setting the same icon for two items will cause the icon to
26122 * dissapear from the first item.
26124 * If an icon was passed as argument on item creation, with function
26125 * elm_segment_control_item_add(), it will be already
26126 * associated to the item.
26128 * @see elm_segment_control_item_add()
26129 * @see elm_segment_control_item_icon_get()
26131 * @ingroup SegmentControl
26133 EAPI void elm_segment_control_item_icon_set(Elm_Segment_Item *it, Evas_Object *icon) EINA_ARG_NONNULL(1);
26136 * Get the index of an item.
26138 * @param it The segment control item.
26139 * @return The position of item in segment control widget.
26141 * Index is the position of an item in segment control widget. Its
26142 * range is from @c 0 to <tt> count - 1 </tt>.
26143 * Count is the number of items, that can be get with
26144 * elm_segment_control_item_count_get().
26146 * @ingroup SegmentControl
26148 EAPI int elm_segment_control_item_index_get(const Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
26151 * Get the base object of the item.
26153 * @param it The segment control item.
26154 * @return The base object associated with @p it.
26156 * Base object is the @c Evas_Object that represents that item.
26158 * @ingroup SegmentControl
26160 EAPI Evas_Object *elm_segment_control_item_object_get(const Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
26163 * Get the selected item.
26165 * @param obj The segment control object.
26166 * @return The selected item or @c NULL if none of segment items is
26169 * The selected item can be unselected with function
26170 * elm_segment_control_item_selected_set().
26172 * The selected item always will be highlighted on segment control.
26174 * @ingroup SegmentControl
26176 EAPI Elm_Segment_Item *elm_segment_control_item_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26179 * Set the selected state of an item.
26181 * @param it The segment control item
26182 * @param select The selected state
26184 * This sets the selected state of the given item @p it.
26185 * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
26187 * If a new item is selected the previosly selected will be unselected.
26188 * Previoulsy selected item can be get with function
26189 * elm_segment_control_item_selected_get().
26191 * The selected item always will be highlighted on segment control.
26193 * @see elm_segment_control_item_selected_get()
26195 * @ingroup SegmentControl
26197 EAPI void elm_segment_control_item_selected_set(Elm_Segment_Item *it, Eina_Bool select) EINA_ARG_NONNULL(1);
26204 * @defgroup Grid Grid
26206 * The grid is a grid layout widget that lays out a series of children as a
26207 * fixed "grid" of widgets using a given percentage of the grid width and
26208 * height each using the child object.
26210 * The Grid uses a "Virtual resolution" that is stretched to fill the grid
26211 * widgets size itself. The default is 100 x 100, so that means the
26212 * position and sizes of children will effectively be percentages (0 to 100)
26213 * of the width or height of the grid widget
26219 * Add a new grid to the parent
26221 * @param parent The parent object
26222 * @return The new object or NULL if it cannot be created
26226 EAPI Evas_Object *elm_grid_add(Evas_Object *parent);
26229 * Set the virtual size of the grid
26231 * @param obj The grid object
26232 * @param w The virtual width of the grid
26233 * @param h The virtual height of the grid
26237 EAPI void elm_grid_size_set(Evas_Object *obj, int w, int h);
26240 * Get the virtual size of the grid
26242 * @param obj The grid object
26243 * @param w Pointer to integer to store the virtual width of the grid
26244 * @param h Pointer to integer to store the virtual height of the grid
26248 EAPI void elm_grid_size_get(Evas_Object *obj, int *w, int *h);
26251 * Pack child at given position and size
26253 * @param obj The grid object
26254 * @param subobj The child to pack
26255 * @param x The virtual x coord at which to pack it
26256 * @param y The virtual y coord at which to pack it
26257 * @param w The virtual width at which to pack it
26258 * @param h The virtual height at which to pack it
26262 EAPI void elm_grid_pack(Evas_Object *obj, Evas_Object *subobj, int x, int y, int w, int h);
26265 * Unpack a child from a grid object
26267 * @param obj The grid object
26268 * @param subobj The child to unpack
26272 EAPI void elm_grid_unpack(Evas_Object *obj, Evas_Object *subobj);
26275 * Faster way to remove all child objects from a grid object.
26277 * @param obj The grid object
26278 * @param clear If true, it will delete just removed children
26282 EAPI void elm_grid_clear(Evas_Object *obj, Eina_Bool clear);
26285 * Set packing of an existing child at to position and size
26287 * @param subobj The child to set packing of
26288 * @param x The virtual x coord at which to pack it
26289 * @param y The virtual y coord at which to pack it
26290 * @param w The virtual width at which to pack it
26291 * @param h The virtual height at which to pack it
26295 EAPI void elm_grid_pack_set(Evas_Object *subobj, int x, int y, int w, int h);
26298 * get packing of a child
26300 * @param subobj The child to query
26301 * @param x Pointer to integer to store the virtual x coord
26302 * @param y Pointer to integer to store the virtual y coord
26303 * @param w Pointer to integer to store the virtual width
26304 * @param h Pointer to integer to store the virtual height
26308 EAPI void elm_grid_pack_get(Evas_Object *subobj, int *x, int *y, int *w, int *h);
26314 EAPI Evas_Object *elm_factory_add(Evas_Object *parent);
26315 EAPI void elm_factory_content_set(Evas_Object *obj, Evas_Object *content);
26316 EAPI Evas_Object *elm_factory_content_get(const Evas_Object *obj);
26319 * @defgroup Video Video
26321 * This object display an player that let you control an Elm_Video
26322 * object. It take care of updating it's content according to what is
26323 * going on inside the Emotion object. It does activate the remember
26324 * function on the linked Elm_Video object.
26326 * Signals that you cann add callback for are :
26328 * "forward,clicked" - the user clicked the forward button.
26329 * "info,clicked" - the user clicked the info button.
26330 * "next,clicked" - the user clicked the next button.
26331 * "pause,clicked" - the user clicked the pause button.
26332 * "play,clicked" - the user clicked the play button.
26333 * "prev,clicked" - the user clicked the prev button.
26334 * "rewind,clicked" - the user clicked the rewind button.
26335 * "stop,clicked" - the user clicked the stop button.
26337 EAPI Evas_Object *elm_video_add(Evas_Object *parent);
26338 EAPI void elm_video_file_set(Evas_Object *video, const char *filename);
26339 EAPI void elm_video_uri_set(Evas_Object *video, const char *uri);
26340 EAPI Evas_Object *elm_video_emotion_get(Evas_Object *video);
26341 EAPI void elm_video_play(Evas_Object *video);
26342 EAPI void elm_video_pause(Evas_Object *video);
26343 EAPI void elm_video_stop(Evas_Object *video);
26344 EAPI Eina_Bool elm_video_is_playing(Evas_Object *video);
26345 EAPI Eina_Bool elm_video_is_seekable(Evas_Object *video);
26346 EAPI Eina_Bool elm_video_audio_mute_get(Evas_Object *video);
26347 EAPI void elm_video_audio_mute_set(Evas_Object *video, Eina_Bool mute);
26348 EAPI double elm_video_audio_level_get(Evas_Object *video);
26349 EAPI void elm_video_audio_level_set(Evas_Object *video, double volume);
26350 EAPI double elm_video_play_position_get(Evas_Object *video);
26351 EAPI void elm_video_play_position_set(Evas_Object *video, double position);
26352 EAPI double elm_video_play_length_get(Evas_Object *video);
26353 EAPI void elm_video_remember_position_set(Evas_Object *video, Eina_Bool remember);
26354 EAPI Eina_Bool elm_video_remember_position_get(Evas_Object *video);
26355 EAPI const char *elm_video_title_get(Evas_Object *video);
26357 EAPI Evas_Object *elm_player_add(Evas_Object *parent);
26358 EAPI void elm_player_video_set(Evas_Object *player, Evas_Object *video);
26361 EAPI Evas_Object *elm_naviframe_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
26362 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);
26363 EAPI Evas_Object *elm_naviframe_item_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
26364 EAPI void elm_naviframe_content_preserve_on_pop_set(Evas_Object *obj, Eina_Bool preserve) EINA_ARG_NONNULL(1);
26365 EAPI Eina_Bool elm_naviframe_content_preserve_on_pop_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26366 EAPI void elm_naviframe_item_title_label_set(Elm_Object_Item *it, const char *label) EINA_ARG_NONNULL(1);
26367 EAPI const char *elm_naviframe_item_title_label_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26368 EAPI void elm_naviframe_item_subtitle_label_set(Elm_Object_Item *it, const char *label) EINA_ARG_NONNULL(1);
26369 EAPI const char *elm_naviframe_item_subtitle_label_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26370 EAPI Elm_Object_Item *elm_naviframe_top_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26371 EAPI Elm_Object_Item *elm_naviframe_bottom_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26372 EAPI void elm_naviframe_item_style_set(Elm_Object_Item *it, const char *item_style) EINA_ARG_NONNULL(1);
26373 EAPI const char *elm_naviframe_item_style_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26374 EAPI void elm_naviframe_item_title_visible_set(Elm_Object_Item *it, Eina_Bool visible) EINA_ARG_NONNULL(1);
26375 EAPI Eina_Bool elm_naviframe_item_title_visible_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);