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 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);
1076 #define elm_object_item_text_get(it) elm_object_item_text_part_get((it), NULL)
1083 * @defgroup Caches Caches
1085 * These are functions which let one fine-tune some cache values for
1086 * Elementary applications, thus allowing for performance adjustments.
1092 * @brief Flush all caches.
1094 * Frees all data that was in cache and is not currently being used to reduce
1095 * memory usage. This frees Edje's, Evas' and Eet's cache. This is equivalent
1096 * to calling all of the following functions:
1097 * @li edje_file_cache_flush()
1098 * @li edje_collection_cache_flush()
1099 * @li eet_clearcache()
1100 * @li evas_image_cache_flush()
1101 * @li evas_font_cache_flush()
1102 * @li evas_render_dump()
1103 * @note Evas caches are flushed for every canvas associated with a window.
1107 EAPI void elm_all_flush(void);
1110 * Get the configured cache flush interval time
1112 * This gets the globally configured cache flush interval time, in
1115 * @return The cache flush interval time
1118 * @see elm_all_flush()
1120 EAPI int elm_cache_flush_interval_get(void);
1123 * Set the configured cache flush interval time
1125 * This sets the globally configured cache flush interval time, in ticks
1127 * @param size The cache flush interval time
1130 * @see elm_all_flush()
1132 EAPI void elm_cache_flush_interval_set(int size);
1135 * Set the configured cache flush interval time for all applications on the
1138 * This sets the globally configured cache flush interval time -- in ticks
1139 * -- for all applications on the display.
1141 * @param size The cache flush interval time
1144 EAPI void elm_cache_flush_interval_all_set(int size);
1147 * Get the configured cache flush enabled state
1149 * This gets the globally configured cache flush state - if it is enabled
1150 * or not. When cache flushing is enabled, elementary will regularly
1151 * (see elm_cache_flush_interval_get() ) flush caches and dump data out of
1152 * memory and allow usage to re-seed caches and data in memory where it
1153 * can do so. An idle application will thus minimise its memory usage as
1154 * data will be freed from memory and not be re-loaded as it is idle and
1155 * not rendering or doing anything graphically right now.
1157 * @return The cache flush state
1160 * @see elm_all_flush()
1162 EAPI Eina_Bool elm_cache_flush_enabled_get(void);
1165 * Set the configured cache flush enabled state
1167 * This sets the globally configured cache flush enabled state
1169 * @param size The cache flush enabled state
1172 * @see elm_all_flush()
1174 EAPI void elm_cache_flush_enabled_set(Eina_Bool enabled);
1177 * Set the configured cache flush enabled state for all applications on the
1180 * This sets the globally configured cache flush enabled state for all
1181 * applications on the display.
1183 * @param size The cache flush enabled state
1186 EAPI void elm_cache_flush_enabled_all_set(Eina_Bool enabled);
1189 * Get the configured font cache size
1191 * This gets the globally configured font cache size, in bytes
1193 * @return The font cache size
1196 EAPI int elm_font_cache_get(void);
1199 * Set the configured font cache size
1201 * This sets the globally configured font cache size, in bytes
1203 * @param size The font cache size
1206 EAPI void elm_font_cache_set(int size);
1209 * Set the configured font cache size for all applications on the
1212 * This sets the globally configured font cache size -- in bytes
1213 * -- for all applications on the display.
1215 * @param size The font cache size
1218 EAPI void elm_font_cache_all_set(int size);
1221 * Get the configured image cache size
1223 * This gets the globally configured image cache size, in bytes
1225 * @return The image cache size
1228 EAPI int elm_image_cache_get(void);
1231 * Set the configured image cache size
1233 * This sets the globally configured image cache size, in bytes
1235 * @param size The image cache size
1238 EAPI void elm_image_cache_set(int size);
1241 * Set the configured image cache size for all applications on the
1244 * This sets the globally configured image cache size -- in bytes
1245 * -- for all applications on the display.
1247 * @param size The image cache size
1250 EAPI void elm_image_cache_all_set(int size);
1253 * Get the configured edje file cache size.
1255 * This gets the globally configured edje file cache size, in number
1258 * @return The edje file cache size
1261 EAPI int elm_edje_file_cache_get(void);
1264 * Set the configured edje file cache size
1266 * This sets the globally configured edje file cache size, in number
1269 * @param size The edje file cache size
1272 EAPI void elm_edje_file_cache_set(int size);
1275 * Set the configured edje file cache size for all applications on the
1278 * This sets the globally configured edje file cache size -- in number
1279 * of files -- for all applications on the display.
1281 * @param size The edje file cache size
1284 EAPI void elm_edje_file_cache_all_set(int size);
1287 * Get the configured edje collections (groups) cache size.
1289 * This gets the globally configured edje collections cache size, in
1290 * number of collections.
1292 * @return The edje collections cache size
1295 EAPI int elm_edje_collection_cache_get(void);
1298 * Set the configured edje collections (groups) cache size
1300 * This sets the globally configured edje collections cache size, in
1301 * number of collections.
1303 * @param size The edje collections cache size
1306 EAPI void elm_edje_collection_cache_set(int size);
1309 * Set the configured edje collections (groups) cache size for all
1310 * applications on the display
1312 * This sets the globally configured edje collections cache size -- in
1313 * number of collections -- for all applications on the display.
1315 * @param size The edje collections cache size
1318 EAPI void elm_edje_collection_cache_all_set(int size);
1325 * @defgroup Scaling Widget Scaling
1327 * Different widgets can be scaled independently. These functions
1328 * allow you to manipulate this scaling on a per-widget basis. The
1329 * object and all its children get their scaling factors multiplied
1330 * by the scale factor set. This is multiplicative, in that if a
1331 * child also has a scale size set it is in turn multiplied by its
1332 * parent's scale size. @c 1.0 means “don't scale”, @c 2.0 is
1333 * double size, @c 0.5 is half, etc.
1335 * @ref general_functions_example_page "This" example contemplates
1336 * some of these functions.
1340 * Get the global scaling factor
1342 * This gets the globally configured scaling factor that is applied to all
1345 * @return The scaling factor
1348 EAPI double elm_scale_get(void);
1351 * Set the global scaling factor
1353 * This sets the globally configured scaling factor that is applied to all
1356 * @param scale The scaling factor to set
1359 EAPI void elm_scale_set(double scale);
1362 * Set the global scaling factor for all applications on the display
1364 * This sets the globally configured scaling factor that is applied to all
1365 * objects for all applications.
1366 * @param scale The scaling factor to set
1369 EAPI void elm_scale_all_set(double scale);
1372 * Set the scaling factor for a given Elementary object
1374 * @param obj The Elementary to operate on
1375 * @param scale Scale factor (from @c 0.0 up, with @c 1.0 meaning
1380 EAPI void elm_object_scale_set(Evas_Object *obj, double scale) EINA_ARG_NONNULL(1);
1383 * Get the scaling factor for a given Elementary object
1385 * @param obj The object
1386 * @return The scaling factor set by elm_object_scale_set()
1390 EAPI double elm_object_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1393 * @defgroup UI-Mirroring Selective Widget mirroring
1395 * These functions allow you to set ui-mirroring on specific
1396 * widgets or the whole interface. Widgets can be in one of two
1397 * modes, automatic and manual. Automatic means they'll be changed
1398 * according to the system mirroring mode and manual means only
1399 * explicit changes will matter. You are not supposed to change
1400 * mirroring state of a widget set to automatic, will mostly work,
1401 * but the behavior is not really defined.
1406 EAPI Eina_Bool elm_mirrored_get(void);
1407 EAPI void elm_mirrored_set(Eina_Bool mirrored);
1410 * Get the system mirrored mode. This determines the default mirrored mode
1413 * @return EINA_TRUE if mirrored is set, EINA_FALSE otherwise
1415 EAPI Eina_Bool elm_object_mirrored_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1418 * Set the system mirrored mode. This determines the default mirrored mode
1421 * @param mirrored EINA_TRUE to set mirrored mode, EINA_FALSE to unset it.
1423 EAPI void elm_object_mirrored_set(Evas_Object *obj, Eina_Bool mirrored) EINA_ARG_NONNULL(1);
1426 * Returns the widget's mirrored mode setting.
1428 * @param obj The widget.
1429 * @return mirrored mode setting of the object.
1432 EAPI Eina_Bool elm_object_mirrored_automatic_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1435 * Sets the widget's mirrored mode setting.
1436 * When widget in automatic mode, it follows the system mirrored mode set by
1437 * elm_mirrored_set().
1438 * @param obj The widget.
1439 * @param automatic EINA_TRUE for auto mirrored mode. EINA_FALSE for manual.
1441 EAPI void elm_object_mirrored_automatic_set(Evas_Object *obj, Eina_Bool automatic) EINA_ARG_NONNULL(1);
1448 * Set the style to use by a widget
1450 * Sets the style name that will define the appearance of a widget. Styles
1451 * vary from widget to widget and may also be defined by other themes
1452 * by means of extensions and overlays.
1454 * @param obj The Elementary widget to style
1455 * @param style The style name to use
1457 * @see elm_theme_extension_add()
1458 * @see elm_theme_extension_del()
1459 * @see elm_theme_overlay_add()
1460 * @see elm_theme_overlay_del()
1464 EAPI void elm_object_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
1466 * Get the style used by the widget
1468 * This gets the style being used for that widget. Note that the string
1469 * pointer is only valid as longas the object is valid and the style doesn't
1472 * @param obj The Elementary widget to query for its style
1473 * @return The style name used
1475 * @see elm_object_style_set()
1479 EAPI const char *elm_object_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1482 * @defgroup Styles Styles
1484 * Widgets can have different styles of look. These generic API's
1485 * set styles of widgets, if they support them (and if the theme(s)
1488 * @ref general_functions_example_page "This" example contemplates
1489 * some of these functions.
1493 * Set the disabled state of an Elementary object.
1495 * @param obj The Elementary object to operate on
1496 * @param disabled The state to put in in: @c EINA_TRUE for
1497 * disabled, @c EINA_FALSE for enabled
1499 * Elementary objects can be @b disabled, in which state they won't
1500 * receive input and, in general, will be themed differently from
1501 * their normal state, usually greyed out. Useful for contexts
1502 * where you don't want your users to interact with some of the
1503 * parts of you interface.
1505 * This sets the state for the widget, either disabling it or
1510 EAPI void elm_object_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
1513 * Get the disabled state of an Elementary object.
1515 * @param obj The Elementary object to operate on
1516 * @return @c EINA_TRUE, if the widget is disabled, @c EINA_FALSE
1517 * if it's enabled (or on errors)
1519 * This gets the state of the widget, which might be enabled or disabled.
1523 EAPI Eina_Bool elm_object_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1526 * @defgroup WidgetNavigation Widget Tree Navigation.
1528 * How to check if an Evas Object is an Elementary widget? How to
1529 * get the first elementary widget that is parent of the given
1530 * object? These are all covered in widget tree navigation.
1532 * @ref general_functions_example_page "This" example contemplates
1533 * some of these functions.
1537 * Check if the given Evas Object is an Elementary widget.
1539 * @param obj the object to query.
1540 * @return @c EINA_TRUE if it is an elementary widget variant,
1541 * @c EINA_FALSE otherwise
1542 * @ingroup WidgetNavigation
1544 EAPI Eina_Bool elm_object_widget_check(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1547 * Get the first parent of the given object that is an Elementary
1550 * @param obj the Elementary object to query parent from.
1551 * @return the parent object that is an Elementary widget, or @c
1552 * NULL, if it was not found.
1554 * Use this to query for an object's parent widget.
1556 * @note Most of Elementary users wouldn't be mixing non-Elementary
1557 * smart objects in the objects tree of an application, as this is
1558 * an advanced usage of Elementary with Evas. So, except for the
1559 * application's window, which is the root of that tree, all other
1560 * objects would have valid Elementary widget parents.
1562 * @ingroup WidgetNavigation
1564 EAPI Evas_Object *elm_object_parent_widget_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1567 * Get the top level parent of an Elementary widget.
1569 * @param obj The object to query.
1570 * @return The top level Elementary widget, or @c NULL if parent cannot be
1572 * @ingroup WidgetNavigation
1574 EAPI Evas_Object *elm_object_top_widget_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1577 * Get the string that represents this Elementary widget.
1579 * @note Elementary is weird and exposes itself as a single
1580 * Evas_Object_Smart_Class of type "elm_widget", so
1581 * evas_object_type_get() always return that, making debug and
1582 * language bindings hard. This function tries to mitigate this
1583 * problem, but the solution is to change Elementary to use
1584 * proper inheritance.
1586 * @param obj the object to query.
1587 * @return Elementary widget name, or @c NULL if not a valid widget.
1588 * @ingroup WidgetNavigation
1590 EAPI const char *elm_object_widget_type_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1593 * @defgroup Config Elementary Config
1595 * Elementary configuration is formed by a set options bounded to a
1596 * given @ref Profile profile, like @ref Theme theme, @ref Fingers
1597 * "finger size", etc. These are functions with which one syncronizes
1598 * changes made to those values to the configuration storing files, de
1599 * facto. You most probably don't want to use the functions in this
1600 * group unlees you're writing an elementary configuration manager.
1606 * Save back Elementary's configuration, so that it will persist on
1609 * @return @c EINA_TRUE, when sucessful. @c EINA_FALSE, otherwise.
1612 * This function will take effect -- thus, do I/O -- immediately. Use
1613 * it when you want to apply all configuration changes at once. The
1614 * current configuration set will get saved onto the current profile
1615 * configuration file.
1618 EAPI Eina_Bool elm_config_save(void);
1621 * Reload Elementary's configuration, bounded to current selected
1624 * @return @c EINA_TRUE, when sucessful. @c EINA_FALSE, otherwise.
1627 * Useful when you want to force reloading of configuration values for
1628 * a profile. If one removes user custom configuration directories,
1629 * for example, it will force a reload with system values insted.
1632 EAPI void elm_config_reload(void);
1639 * @defgroup Profile Elementary Profile
1641 * Profiles are pre-set options that affect the whole look-and-feel of
1642 * Elementary-based applications. There are, for example, profiles
1643 * aimed at desktop computer applications and others aimed at mobile,
1644 * touchscreen-based ones. You most probably don't want to use the
1645 * functions in this group unlees you're writing an elementary
1646 * configuration manager.
1652 * Get Elementary's profile in use.
1654 * This gets the global profile that is applied to all Elementary
1657 * @return The profile's name
1660 EAPI const char *elm_profile_current_get(void);
1663 * Get an Elementary's profile directory path in the filesystem. One
1664 * may want to fetch a system profile's dir or an user one (fetched
1667 * @param profile The profile's name
1668 * @param is_user Whether to lookup for an user profile (@c EINA_TRUE)
1669 * or a system one (@c EINA_FALSE)
1670 * @return The profile's directory path.
1673 * @note You must free it with elm_profile_dir_free().
1675 EAPI const char *elm_profile_dir_get(const char *profile, Eina_Bool is_user);
1678 * Free an Elementary's profile directory path, as returned by
1679 * elm_profile_dir_get().
1681 * @param p_dir The profile's path
1685 EAPI void elm_profile_dir_free(const char *p_dir);
1688 * Get Elementary's list of available profiles.
1690 * @return The profiles list. List node data are the profile name
1694 * @note One must free this list, after usage, with the function
1695 * elm_profile_list_free().
1697 EAPI Eina_List *elm_profile_list_get(void);
1700 * Free Elementary's list of available profiles.
1702 * @param l The profiles list, as returned by elm_profile_list_get().
1706 EAPI void elm_profile_list_free(Eina_List *l);
1709 * Set Elementary's profile.
1711 * This sets the global profile that is applied to Elementary
1712 * applications. Just the process the call comes from will be
1715 * @param profile The profile's name
1719 EAPI void elm_profile_set(const char *profile);
1722 * Set Elementary's profile.
1724 * This sets the global profile that is applied to all Elementary
1725 * applications. All running Elementary windows will be affected.
1727 * @param profile The profile's name
1731 EAPI void elm_profile_all_set(const char *profile);
1738 * @defgroup Engine Elementary Engine
1740 * These are functions setting and querying which rendering engine
1741 * Elementary will use for drawing its windows' pixels.
1743 * The following are the available engines:
1744 * @li "software_x11"
1747 * @li "software_16_x11"
1748 * @li "software_8_x11"
1751 * @li "software_gdi"
1752 * @li "software_16_wince_gdi"
1754 * @li "software_16_sdl"
1762 * @brief Get Elementary's rendering engine in use.
1764 * @return The rendering engine's name
1765 * @note there's no need to free the returned string, here.
1767 * This gets the global rendering engine that is applied to all Elementary
1770 * @see elm_engine_set()
1772 EAPI const char *elm_engine_current_get(void);
1775 * @brief Set Elementary's rendering engine for use.
1777 * @param engine The rendering engine's name
1779 * This sets global rendering engine that is applied to all Elementary
1780 * applications. Note that it will take effect only to Elementary windows
1781 * created after this is called.
1783 * @see elm_win_add()
1785 EAPI void elm_engine_set(const char *engine);
1792 * @defgroup Fonts Elementary Fonts
1794 * These are functions dealing with font rendering, selection and the
1795 * like for Elementary applications. One might fetch which system
1796 * fonts are there to use and set custom fonts for individual classes
1797 * of UI items containing text (text classes).
1802 typedef struct _Elm_Text_Class
1808 typedef struct _Elm_Font_Overlay
1810 const char *text_class;
1812 Evas_Font_Size size;
1815 typedef struct _Elm_Font_Properties
1819 } Elm_Font_Properties;
1822 * Get Elementary's list of supported text classes.
1824 * @return The text classes list, with @c Elm_Text_Class blobs as data.
1827 * Release the list with elm_text_classes_list_free().
1829 EAPI const Eina_List *elm_text_classes_list_get(void);
1832 * Free Elementary's list of supported text classes.
1836 * @see elm_text_classes_list_get().
1838 EAPI void elm_text_classes_list_free(const Eina_List *list);
1841 * Get Elementary's list of font overlays, set with
1842 * elm_font_overlay_set().
1844 * @return The font overlays list, with @c Elm_Font_Overlay blobs as
1849 * For each text class, one can set a <b>font overlay</b> for it,
1850 * overriding the default font properties for that class coming from
1851 * the theme in use. There is no need to free this list.
1853 * @see elm_font_overlay_set() and elm_font_overlay_unset().
1855 EAPI const Eina_List *elm_font_overlay_list_get(void);
1858 * Set a font overlay for a given Elementary text class.
1860 * @param text_class Text class name
1861 * @param font Font name and style string
1862 * @param size Font size
1866 * @p font has to be in the format returned by
1867 * elm_font_fontconfig_name_get(). @see elm_font_overlay_list_get()
1868 * and elm_font_overlay_unset().
1870 EAPI void elm_font_overlay_set(const char *text_class, const char *font, Evas_Font_Size size);
1873 * Unset a font overlay for a given Elementary text class.
1875 * @param text_class Text class name
1879 * This will bring back text elements belonging to text class
1880 * @p text_class back to their default font settings.
1882 EAPI void elm_font_overlay_unset(const char *text_class);
1885 * Apply the changes made with elm_font_overlay_set() and
1886 * elm_font_overlay_unset() on the current Elementary window.
1890 * This applies all font overlays set to all objects in the UI.
1892 EAPI void elm_font_overlay_apply(void);
1895 * Apply the changes made with elm_font_overlay_set() and
1896 * elm_font_overlay_unset() on all Elementary application windows.
1900 * This applies all font overlays set to all objects in the UI.
1902 EAPI void elm_font_overlay_all_apply(void);
1905 * Translate a font (family) name string in fontconfig's font names
1906 * syntax into an @c Elm_Font_Properties struct.
1908 * @param font The font name and styles string
1909 * @return the font properties struct
1913 * @note The reverse translation can be achived with
1914 * elm_font_fontconfig_name_get(), for one style only (single font
1915 * instance, not family).
1917 EAPI Elm_Font_Properties *elm_font_properties_get(const char *font) EINA_ARG_NONNULL(1);
1920 * Free font properties return by elm_font_properties_get().
1922 * @param efp the font properties struct
1926 EAPI void elm_font_properties_free(Elm_Font_Properties *efp) EINA_ARG_NONNULL(1);
1929 * Translate a font name, bound to a style, into fontconfig's font names
1932 * @param name The font (family) name
1933 * @param style The given style (may be @c NULL)
1935 * @return the font name and style string
1939 * @note The reverse translation can be achived with
1940 * elm_font_properties_get(), for one style only (single font
1941 * instance, not family).
1943 EAPI const char *elm_font_fontconfig_name_get(const char *name, const char *style) EINA_ARG_NONNULL(1);
1946 * Free the font string return by elm_font_fontconfig_name_get().
1948 * @param efp the font properties struct
1952 EAPI void elm_font_fontconfig_name_free(const char *name) EINA_ARG_NONNULL(1);
1955 * Create a font hash table of available system fonts.
1957 * One must call it with @p list being the return value of
1958 * evas_font_available_list(). The hash will be indexed by font
1959 * (family) names, being its values @c Elm_Font_Properties blobs.
1961 * @param list The list of available system fonts, as returned by
1962 * evas_font_available_list().
1963 * @return the font hash.
1967 * @note The user is supposed to get it populated at least with 3
1968 * default font families (Sans, Serif, Monospace), which should be
1969 * present on most systems.
1971 EAPI Eina_Hash *elm_font_available_hash_add(Eina_List *list);
1974 * Free the hash return by elm_font_available_hash_add().
1976 * @param hash the hash to be freed.
1980 EAPI void elm_font_available_hash_del(Eina_Hash *hash);
1987 * @defgroup Fingers Fingers
1989 * Elementary is designed to be finger-friendly for touchscreens,
1990 * and so in addition to scaling for display resolution, it can
1991 * also scale based on finger "resolution" (or size). You can then
1992 * customize the granularity of the areas meant to receive clicks
1995 * Different profiles may have pre-set values for finger sizes.
1997 * @ref general_functions_example_page "This" example contemplates
1998 * some of these functions.
2004 * Get the configured "finger size"
2006 * @return The finger size
2008 * This gets the globally configured finger size, <b>in pixels</b>
2012 EAPI Evas_Coord elm_finger_size_get(void);
2015 * Set the configured finger size
2017 * This sets the globally configured finger size in pixels
2019 * @param size The finger size
2022 EAPI void elm_finger_size_set(Evas_Coord size);
2025 * Set the configured finger size for all applications on the display
2027 * This sets the globally configured finger size in pixels for all
2028 * applications on the display
2030 * @param size The finger size
2033 EAPI void elm_finger_size_all_set(Evas_Coord size);
2040 * @defgroup Focus Focus
2042 * An Elementary application has, at all times, one (and only one)
2043 * @b focused object. This is what determines where the input
2044 * events go to within the application's window. Also, focused
2045 * objects can be decorated differently, in order to signal to the
2046 * user where the input is, at a given moment.
2048 * Elementary applications also have the concept of <b>focus
2049 * chain</b>: one can cycle through all the windows' focusable
2050 * objects by input (tab key) or programmatically. The default
2051 * focus chain for an application is the one define by the order in
2052 * which the widgets where added in code. One will cycle through
2053 * top level widgets, and, for each one containg sub-objects, cycle
2054 * through them all, before returning to the level
2055 * above. Elementary also allows one to set @b custom focus chains
2056 * for their applications.
2058 * Besides the focused decoration a widget may exhibit, when it
2059 * gets focus, Elementary has a @b global focus highlight object
2060 * that can be enabled for a window. If one chooses to do so, this
2061 * extra highlight effect will surround the current focused object,
2064 * @note Some Elementary widgets are @b unfocusable, after
2065 * creation, by their very nature: they are not meant to be
2066 * interacted with input events, but are there just for visual
2069 * @ref general_functions_example_page "This" example contemplates
2070 * some of these functions.
2074 * Get the enable status of the focus highlight
2076 * This gets whether the highlight on focused objects is enabled or not
2079 EAPI Eina_Bool elm_focus_highlight_enabled_get(void);
2082 * Set the enable status of the focus highlight
2084 * Set whether to show or not the highlight on focused objects
2085 * @param enable Enable highlight if EINA_TRUE, disable otherwise
2088 EAPI void elm_focus_highlight_enabled_set(Eina_Bool enable);
2091 * Get the enable status of the highlight animation
2093 * Get whether the focus highlight, if enabled, will animate its switch from
2094 * one object to the next
2097 EAPI Eina_Bool elm_focus_highlight_animate_get(void);
2100 * Set the enable status of the highlight animation
2102 * Set whether the focus highlight, if enabled, will animate its switch from
2103 * one object to the next
2104 * @param animate Enable animation if EINA_TRUE, disable otherwise
2107 EAPI void elm_focus_highlight_animate_set(Eina_Bool animate);
2110 * Get the whether an Elementary object has the focus or not.
2112 * @param obj The Elementary object to get the information from
2113 * @return @c EINA_TRUE, if the object is focused, @c EINA_FALSE if
2114 * not (and on errors).
2116 * @see elm_object_focus_set()
2120 EAPI Eina_Bool elm_object_focus_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2123 * Set/unset focus to a given Elementary object.
2125 * @param obj The Elementary object to operate on.
2126 * @param enable @c EINA_TRUE Set focus to a given object,
2127 * @c EINA_FALSE Unset focus to a given object.
2129 * @note When you set focus to this object, if it can handle focus, will
2130 * take the focus away from the one who had it previously and will, for
2131 * now on, be the one receiving input events. Unsetting focus will remove
2132 * the focus from @p obj, passing it back to the previous element in the
2135 * @see elm_object_focus_get(), elm_object_focus_custom_chain_get()
2139 EAPI void elm_object_focus_set(Evas_Object *obj, Eina_Bool focus) EINA_ARG_NONNULL(1);
2142 * Make a given Elementary object the focused one.
2144 * @param obj The Elementary object to make focused.
2146 * @note This object, if it can handle focus, will take the focus
2147 * away from the one who had it previously and will, for now on, be
2148 * the one receiving input events.
2150 * @see elm_object_focus_get()
2151 * @deprecated use elm_object_focus_set() instead.
2155 EINA_DEPRECATED EAPI void elm_object_focus(Evas_Object *obj) EINA_ARG_NONNULL(1);
2158 * Remove the focus from an Elementary object
2160 * @param obj The Elementary to take focus from
2162 * This removes the focus from @p obj, passing it back to the
2163 * previous element in the focus chain list.
2165 * @see elm_object_focus() and elm_object_focus_custom_chain_get()
2166 * @deprecated use elm_object_focus_set() instead.
2170 EINA_DEPRECATED EAPI void elm_object_unfocus(Evas_Object *obj) EINA_ARG_NONNULL(1);
2173 * Set the ability for an Element object to be focused
2175 * @param obj The Elementary object to operate on
2176 * @param enable @c EINA_TRUE if the object can be focused, @c
2177 * EINA_FALSE if not (and on errors)
2179 * This sets whether the object @p obj is able to take focus or
2180 * not. Unfocusable objects do nothing when programmatically
2181 * focused, being the nearest focusable parent object the one
2182 * really getting focus. Also, when they receive mouse input, they
2183 * will get the event, but not take away the focus from where it
2188 EAPI void elm_object_focus_allow_set(Evas_Object *obj, Eina_Bool enable) EINA_ARG_NONNULL(1);
2191 * Get whether an Elementary object is focusable or not
2193 * @param obj The Elementary object to operate on
2194 * @return @c EINA_TRUE if the object is allowed to be focused, @c
2195 * EINA_FALSE if not (and on errors)
2197 * @note Objects which are meant to be interacted with by input
2198 * events are created able to be focused, by default. All the
2203 EAPI Eina_Bool elm_object_focus_allow_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2206 * Set custom focus chain.
2208 * This function overwrites any previous custom focus chain within
2209 * the list of objects. The previous list will be deleted and this list
2210 * will be managed by elementary. After it is set, don't modify it.
2212 * @note On focus cycle, only will be evaluated children of this container.
2214 * @param obj The container object
2215 * @param objs Chain of objects to pass focus
2218 EAPI void elm_object_focus_custom_chain_set(Evas_Object *obj, Eina_List *objs) EINA_ARG_NONNULL(1);
2221 * Unset a custom focus chain on a given Elementary widget
2223 * @param obj The container object to remove focus chain from
2225 * Any focus chain previously set on @p obj (for its child objects)
2226 * is removed entirely after this call.
2230 EAPI void elm_object_focus_custom_chain_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
2233 * Get custom focus chain
2235 * @param obj The container object
2238 EAPI const Eina_List *elm_object_focus_custom_chain_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2241 * Append object to custom focus chain.
2243 * @note If relative_child equal to NULL or not in custom chain, the object
2244 * will be added in end.
2246 * @note On focus cycle, only will be evaluated children of this container.
2248 * @param obj The container object
2249 * @param child The child to be added in custom chain
2250 * @param relative_child The relative object to position the child
2253 EAPI void elm_object_focus_custom_chain_append(Evas_Object *obj, Evas_Object *child, Evas_Object *relative_child) EINA_ARG_NONNULL(1, 2);
2256 * Prepend object to custom focus chain.
2258 * @note If relative_child equal to NULL or not in custom chain, the object
2259 * will be added in begin.
2261 * @note On focus cycle, only will be evaluated children of this container.
2263 * @param obj The container object
2264 * @param child The child to be added in custom chain
2265 * @param relative_child The relative object to position the child
2268 EAPI void elm_object_focus_custom_chain_prepend(Evas_Object *obj, Evas_Object *child, Evas_Object *relative_child) EINA_ARG_NONNULL(1, 2);
2271 * Give focus to next object in object tree.
2273 * Give focus to next object in focus chain of one object sub-tree.
2274 * If the last object of chain already have focus, the focus will go to the
2275 * first object of chain.
2277 * @param obj The object root of sub-tree
2278 * @param dir Direction to cycle the focus
2282 EAPI void elm_object_focus_cycle(Evas_Object *obj, Elm_Focus_Direction dir) EINA_ARG_NONNULL(1);
2285 * Give focus to near object in one direction.
2287 * Give focus to near object in direction of one object.
2288 * If none focusable object in given direction, the focus will not change.
2290 * @param obj The reference object
2291 * @param x Horizontal component of direction to focus
2292 * @param y Vertical component of direction to focus
2296 EAPI void elm_object_focus_direction_go(Evas_Object *obj, int x, int y) EINA_ARG_NONNULL(1);
2299 * Make the elementary object and its children to be unfocusable
2302 * @param obj The Elementary object to operate on
2303 * @param tree_unfocusable @c EINA_TRUE for unfocusable,
2304 * @c EINA_FALSE for focusable.
2306 * This sets whether the object @p obj and its children objects
2307 * are able to take focus or not. If the tree is set as unfocusable,
2308 * newest focused object which is not in this tree will get focus.
2309 * This API can be helpful for an object to be deleted.
2310 * When an object will be deleted soon, it and its children may not
2311 * want to get focus (by focus reverting or by other focus controls).
2312 * Then, just use this API before deleting.
2314 * @see elm_object_tree_unfocusable_get()
2318 EAPI void elm_object_tree_unfocusable_set(Evas_Object *obj, Eina_Bool tree_unfocusable); EINA_ARG_NONNULL(1);
2321 * Get whether an Elementary object and its children are unfocusable or not.
2323 * @param obj The Elementary object to get the information from
2324 * @return @c EINA_TRUE, if the tree is unfocussable,
2325 * @c EINA_FALSE if not (and on errors).
2327 * @see elm_object_tree_unfocusable_set()
2331 EAPI Eina_Bool elm_object_tree_unfocusable_get(const Evas_Object *obj); EINA_ARG_NONNULL(1);
2334 * @defgroup Scrolling Scrolling
2336 * These are functions setting how scrollable views in Elementary
2337 * widgets should behave on user interaction.
2343 * Get whether scrollers should bounce when they reach their
2344 * viewport's edge during a scroll.
2346 * @return the thumb scroll bouncing state
2348 * This is the default behavior for touch screens, in general.
2349 * @ingroup Scrolling
2351 EAPI Eina_Bool elm_scroll_bounce_enabled_get(void);
2354 * Set whether scrollers should bounce when they reach their
2355 * viewport's edge during a scroll.
2357 * @param enabled the thumb scroll bouncing state
2359 * @see elm_thumbscroll_bounce_enabled_get()
2360 * @ingroup Scrolling
2362 EAPI void elm_scroll_bounce_enabled_set(Eina_Bool enabled);
2365 * Set whether scrollers should bounce when they reach their
2366 * viewport's edge during a scroll, for all Elementary application
2369 * @param enabled the thumb scroll bouncing state
2371 * @see elm_thumbscroll_bounce_enabled_get()
2372 * @ingroup Scrolling
2374 EAPI void elm_scroll_bounce_enabled_all_set(Eina_Bool enabled);
2377 * Get the amount of inertia a scroller will impose at bounce
2380 * @return the thumb scroll bounce friction
2382 * @ingroup Scrolling
2384 EAPI double elm_scroll_bounce_friction_get(void);
2387 * Set the amount of inertia a scroller will impose at bounce
2390 * @param friction the thumb scroll bounce friction
2392 * @see elm_thumbscroll_bounce_friction_get()
2393 * @ingroup Scrolling
2395 EAPI void elm_scroll_bounce_friction_set(double friction);
2398 * Set the amount of inertia a scroller will impose at bounce
2399 * animations, for all Elementary application windows.
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_all_set(double friction);
2409 * Get the amount of inertia a <b>paged</b> scroller will impose at
2410 * page fitting animations.
2412 * @return the page scroll friction
2414 * @ingroup Scrolling
2416 EAPI double elm_scroll_page_scroll_friction_get(void);
2419 * Set the amount of inertia a <b>paged</b> scroller will impose at
2420 * page fitting animations.
2422 * @param friction the page scroll friction
2424 * @see elm_thumbscroll_page_scroll_friction_get()
2425 * @ingroup Scrolling
2427 EAPI void elm_scroll_page_scroll_friction_set(double friction);
2430 * Set the amount of inertia a <b>paged</b> scroller will impose at
2431 * page fitting animations, for all Elementary application windows.
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_all_set(double friction);
2441 * Get the amount of inertia a scroller will impose at region bring
2444 * @return the bring in scroll friction
2446 * @ingroup Scrolling
2448 EAPI double elm_scroll_bring_in_scroll_friction_get(void);
2451 * Set the amount of inertia a scroller will impose at region bring
2454 * @param friction the bring in scroll friction
2456 * @see elm_thumbscroll_bring_in_scroll_friction_get()
2457 * @ingroup Scrolling
2459 EAPI void elm_scroll_bring_in_scroll_friction_set(double friction);
2462 * Set the amount of inertia a scroller will impose at region bring
2463 * animations, for all Elementary application windows.
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_all_set(double friction);
2473 * Get the amount of inertia scrollers will impose at animations
2474 * triggered by Elementary widgets' zooming API.
2476 * @return the zoom friction
2478 * @ingroup Scrolling
2480 EAPI double elm_scroll_zoom_friction_get(void);
2483 * Set the amount of inertia scrollers will impose at animations
2484 * triggered by Elementary widgets' zooming API.
2486 * @param friction the zoom friction
2488 * @see elm_thumbscroll_zoom_friction_get()
2489 * @ingroup Scrolling
2491 EAPI void elm_scroll_zoom_friction_set(double friction);
2494 * Set the amount of inertia scrollers will impose at animations
2495 * triggered by Elementary widgets' zooming API, for all Elementary
2496 * application windows.
2498 * @param friction the zoom friction
2500 * @see elm_thumbscroll_zoom_friction_get()
2501 * @ingroup Scrolling
2503 EAPI void elm_scroll_zoom_friction_all_set(double friction);
2506 * Get whether scrollers should be draggable from any point in their
2509 * @return the thumb scroll state
2511 * @note This is the default behavior for touch screens, in general.
2512 * @note All other functions namespaced with "thumbscroll" will only
2513 * have effect if this mode is enabled.
2515 * @ingroup Scrolling
2517 EAPI Eina_Bool elm_scroll_thumbscroll_enabled_get(void);
2520 * Set whether scrollers should be draggable from any point in their
2523 * @param enabled the thumb scroll state
2525 * @see elm_thumbscroll_enabled_get()
2526 * @ingroup Scrolling
2528 EAPI void elm_scroll_thumbscroll_enabled_set(Eina_Bool enabled);
2531 * Set whether scrollers should be draggable from any point in their
2532 * views, for all Elementary application windows.
2534 * @param enabled the thumb scroll state
2536 * @see elm_thumbscroll_enabled_get()
2537 * @ingroup Scrolling
2539 EAPI void elm_scroll_thumbscroll_enabled_all_set(Eina_Bool enabled);
2542 * Get the number of pixels one should travel while dragging a
2543 * scroller's view to actually trigger scrolling.
2545 * @return the thumb scroll threshould
2547 * One would use higher values for touch screens, in general, because
2548 * of their inherent imprecision.
2549 * @ingroup Scrolling
2551 EAPI unsigned int elm_scroll_thumbscroll_threshold_get(void);
2554 * Set the number of pixels one should travel while dragging a
2555 * scroller's view to actually trigger scrolling.
2557 * @param threshold the thumb scroll threshould
2559 * @see elm_thumbscroll_threshould_get()
2560 * @ingroup Scrolling
2562 EAPI void elm_scroll_thumbscroll_threshold_set(unsigned int threshold);
2565 * Set the number of pixels one should travel while dragging a
2566 * scroller's view to actually trigger scrolling, for all Elementary
2567 * application windows.
2569 * @param threshold the thumb scroll threshould
2571 * @see elm_thumbscroll_threshould_get()
2572 * @ingroup Scrolling
2574 EAPI void elm_scroll_thumbscroll_threshold_all_set(unsigned int threshold);
2577 * Get the minimum speed of mouse cursor movement which will trigger
2578 * list self scrolling animation after a mouse up event
2581 * @return the thumb scroll momentum threshould
2583 * @ingroup Scrolling
2585 EAPI double elm_scroll_thumbscroll_momentum_threshold_get(void);
2588 * Set the minimum speed of mouse cursor movement which will trigger
2589 * list self scrolling animation after a mouse up event
2592 * @param threshold the thumb scroll momentum threshould
2594 * @see elm_thumbscroll_momentum_threshould_get()
2595 * @ingroup Scrolling
2597 EAPI void elm_scroll_thumbscroll_momentum_threshold_set(double threshold);
2600 * Set the minimum speed of mouse cursor movement which will trigger
2601 * list self scrolling animation after a mouse up event
2602 * (pixels/second), for all Elementary application windows.
2604 * @param threshold the thumb scroll momentum threshould
2606 * @see elm_thumbscroll_momentum_threshould_get()
2607 * @ingroup Scrolling
2609 EAPI void elm_scroll_thumbscroll_momentum_threshold_all_set(double threshold);
2612 * Get the amount of inertia a scroller will impose at self scrolling
2615 * @return the thumb scroll friction
2617 * @ingroup Scrolling
2619 EAPI double elm_scroll_thumbscroll_friction_get(void);
2622 * Set the amount of inertia a scroller will impose at self scrolling
2625 * @param friction the thumb scroll friction
2627 * @see elm_thumbscroll_friction_get()
2628 * @ingroup Scrolling
2630 EAPI void elm_scroll_thumbscroll_friction_set(double friction);
2633 * Set the amount of inertia a scroller will impose at self scrolling
2634 * animations, for all Elementary application windows.
2636 * @param friction the thumb scroll friction
2638 * @see elm_thumbscroll_friction_get()
2639 * @ingroup Scrolling
2641 EAPI void elm_scroll_thumbscroll_friction_all_set(double friction);
2644 * Get the amount of lag between your actual mouse cursor dragging
2645 * movement and a scroller's view movement itself, while pushing it
2646 * into bounce state manually.
2648 * @return the thumb scroll border friction
2650 * @ingroup Scrolling
2652 EAPI double elm_scroll_thumbscroll_border_friction_get(void);
2655 * Set 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 * @param friction the thumb scroll border friction. @c 0.0 for
2660 * perfect synchrony between two movements, @c 1.0 for maximum
2663 * @see elm_thumbscroll_border_friction_get()
2664 * @note parameter value will get bound to 0.0 - 1.0 interval, always
2666 * @ingroup Scrolling
2668 EAPI void elm_scroll_thumbscroll_border_friction_set(double friction);
2671 * Set the amount of lag between your actual mouse cursor dragging
2672 * movement and a scroller's view movement itself, while pushing it
2673 * into bounce state manually, for all Elementary application windows.
2675 * @param friction the thumb scroll border friction. @c 0.0 for
2676 * perfect synchrony between two movements, @c 1.0 for maximum
2679 * @see elm_thumbscroll_border_friction_get()
2680 * @note parameter value will get bound to 0.0 - 1.0 interval, always
2682 * @ingroup Scrolling
2684 EAPI void elm_scroll_thumbscroll_border_friction_all_set(double friction);
2691 * @defgroup Scrollhints Scrollhints
2693 * Objects when inside a scroller can scroll, but this may not always be
2694 * desirable in certain situations. This allows an object to hint to itself
2695 * and parents to "not scroll" in one of 2 ways. If any child object of a
2696 * scroller has pushed a scroll freeze or hold then it affects all parent
2697 * scrollers until all children have released them.
2699 * 1. To hold on scrolling. This means just flicking and dragging may no
2700 * longer scroll, but pressing/dragging near an edge of the scroller will
2701 * still scroll. This is automatically used by the entry object when
2704 * 2. To totally freeze scrolling. This means it stops. until
2711 * Push the scroll hold by 1
2713 * This increments the scroll hold count by one. If it is more than 0 it will
2714 * take effect on the parents of the indicated object.
2716 * @param obj The object
2717 * @ingroup Scrollhints
2719 EAPI void elm_object_scroll_hold_push(Evas_Object *obj) EINA_ARG_NONNULL(1);
2722 * Pop the scroll hold by 1
2724 * This decrements 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_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
2733 * Push the scroll freeze by 1
2735 * This increments the scroll freeze count by one. If it is more
2736 * than 0 it will take effect on the parents of the indicated
2739 * @param obj The object
2740 * @ingroup Scrollhints
2742 EAPI void elm_object_scroll_freeze_push(Evas_Object *obj) EINA_ARG_NONNULL(1);
2745 * Pop the scroll freeze by 1
2747 * This decrements the scroll freeze count by one. If it is more
2748 * than 0 it will take effect on the parents of the indicated
2751 * @param obj The object
2752 * @ingroup Scrollhints
2754 EAPI void elm_object_scroll_freeze_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
2757 * Lock the scrolling of the given widget (and thus all parents)
2759 * This locks the given object from scrolling in the X axis (and implicitly
2760 * also locks all parent scrollers too from doing the same).
2762 * @param obj The object
2763 * @param lock The lock state (1 == locked, 0 == unlocked)
2764 * @ingroup Scrollhints
2766 EAPI void elm_object_scroll_lock_x_set(Evas_Object *obj, Eina_Bool lock) EINA_ARG_NONNULL(1);
2769 * Lock the scrolling of the given widget (and thus all parents)
2771 * This locks the given object from scrolling in the Y axis (and implicitly
2772 * also locks all parent scrollers too from doing the same).
2774 * @param obj The object
2775 * @param lock The lock state (1 == locked, 0 == unlocked)
2776 * @ingroup Scrollhints
2778 EAPI void elm_object_scroll_lock_y_set(Evas_Object *obj, Eina_Bool lock) EINA_ARG_NONNULL(1);
2781 * Get the scrolling lock of the given widget
2783 * This gets the lock for X axis scrolling.
2785 * @param obj The object
2786 * @ingroup Scrollhints
2788 EAPI Eina_Bool elm_object_scroll_lock_x_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2791 * Get the scrolling lock of the given widget
2793 * This gets the lock for X axis scrolling.
2795 * @param obj The object
2796 * @ingroup Scrollhints
2798 EAPI Eina_Bool elm_object_scroll_lock_y_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2805 * Send a signal to the widget edje object.
2807 * This function sends a signal to the edje object of the obj. An
2808 * edje program can respond to a signal by specifying matching
2809 * 'signal' and 'source' fields.
2811 * @param obj The object
2812 * @param emission The signal's name.
2813 * @param source The signal's source.
2816 EAPI void elm_object_signal_emit(Evas_Object *obj, const char *emission, const char *source) EINA_ARG_NONNULL(1);
2819 * Add a callback for a signal emitted by widget edje object.
2821 * This function connects a callback function to a signal emitted by the
2822 * edje object of the obj.
2823 * Globs can occur in either the emission or source name.
2825 * @param obj The object
2826 * @param emission The signal's name.
2827 * @param source The signal's source.
2828 * @param func The callback function to be executed when the signal is
2830 * @param data A pointer to data to pass in to the callback function.
2833 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);
2836 * Remove a signal-triggered callback from a widget edje object.
2838 * This function removes a callback, previoulsy attached to a
2839 * signal emitted by the edje object of the obj. The parameters
2840 * emission, source and func must match exactly those passed to a
2841 * previous call to elm_object_signal_callback_add(). The data
2842 * pointer that was passed to this call will be returned.
2844 * @param obj The object
2845 * @param emission The signal's name.
2846 * @param source The signal's source.
2847 * @param func The callback function to be executed when the signal is
2849 * @return The data pointer
2852 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);
2855 * Add a callback for input events (key up, key down, mouse wheel)
2856 * on a given Elementary widget
2858 * @param obj The widget to add an event callback on
2859 * @param func The callback function to be executed when the event
2861 * @param data Data to pass in to @p func
2863 * Every widget in an Elementary interface set to receive focus,
2864 * with elm_object_focus_allow_set(), will propagate @b all of its
2865 * key up, key down and mouse wheel input events up to its parent
2866 * object, and so on. All of the focusable ones in this chain which
2867 * had an event callback set, with this call, will be able to treat
2868 * those events. There are two ways of making the propagation of
2869 * these event upwards in the tree of widgets to @b cease:
2870 * - Just return @c EINA_TRUE on @p func. @c EINA_FALSE will mean
2871 * the event was @b not processed, so the propagation will go on.
2872 * - The @c event_info pointer passed to @p func will contain the
2873 * event's structure and, if you OR its @c event_flags inner
2874 * value to @c EVAS_EVENT_FLAG_ON_HOLD, you're telling Elementary
2875 * one has already handled it, thus killing the event's
2878 * @note Your event callback will be issued on those events taking
2879 * place only if no other child widget of @obj has consumed the
2882 * @note Not to be confused with @c
2883 * evas_object_event_callback_add(), which will add event callbacks
2884 * per type on general Evas objects (no event propagation
2885 * infrastructure taken in account).
2887 * @note Not to be confused with @c
2888 * elm_object_signal_callback_add(), which will add callbacks to @b
2889 * signals coming from a widget's theme, not input events.
2891 * @note Not to be confused with @c
2892 * edje_object_signal_callback_add(), which does the same as
2893 * elm_object_signal_callback_add(), but directly on an Edje
2896 * @note Not to be confused with @c
2897 * evas_object_smart_callback_add(), which adds callbacks to smart
2898 * objects' <b>smart events</b>, and not input events.
2900 * @see elm_object_event_callback_del()
2904 EAPI void elm_object_event_callback_add(Evas_Object *obj, Elm_Event_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
2907 * Remove an event callback from a widget.
2909 * This function removes a callback, previoulsy attached to event emission
2911 * The parameters func and data must match exactly those passed to
2912 * a previous call to elm_object_event_callback_add(). The data pointer that
2913 * was passed to this call will be returned.
2915 * @param obj The object
2916 * @param func The callback function to be executed when the event is
2918 * @param data Data to pass in to the callback function.
2919 * @return The data pointer
2922 EAPI void *elm_object_event_callback_del(Evas_Object *obj, Elm_Event_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
2925 * Adjust size of an element for finger usage.
2927 * @param times_w How many fingers should fit horizontally
2928 * @param w Pointer to the width size to adjust
2929 * @param times_h How many fingers should fit vertically
2930 * @param h Pointer to the height size to adjust
2932 * This takes width and height sizes (in pixels) as input and a
2933 * size multiple (which is how many fingers you want to place
2934 * within the area, being "finger" the size set by
2935 * elm_finger_size_set()), and adjusts the size to be large enough
2936 * to accommodate the resulting size -- if it doesn't already
2937 * accommodate it. On return the @p w and @p h sizes pointed to by
2938 * these parameters will be modified, on those conditions.
2940 * @note This is kind of a low level Elementary call, most useful
2941 * on size evaluation times for widgets. An external user wouldn't
2942 * be calling, most of the time.
2946 EAPI void elm_coords_finger_size_adjust(int times_w, Evas_Coord *w, int times_h, Evas_Coord *h);
2949 * Get the duration for occuring long press event.
2951 * @return Timeout for long press event
2952 * @ingroup Longpress
2954 EAPI double elm_longpress_timeout_get(void);
2957 * Set the duration for occuring long press event.
2959 * @param lonpress_timeout Timeout for long press event
2960 * @ingroup Longpress
2962 EAPI void elm_longpress_timeout_set(double longpress_timeout);
2965 * @defgroup Debug Debug
2966 * don't use it unless you are sure
2972 * Print Tree object hierarchy in stdout
2974 * @param obj The root object
2977 EAPI void elm_object_tree_dump(const Evas_Object *top);
2980 * Print Elm Objects tree hierarchy in file as dot(graphviz) syntax.
2982 * @param obj The root object
2983 * @param file The path of output file
2986 EAPI void elm_object_tree_dot_dump(const Evas_Object *top, const char *file);
2993 * @defgroup Theme Theme
2995 * Elementary uses Edje to theme its widgets, naturally. But for the most
2996 * part this is hidden behind a simpler interface that lets the user set
2997 * extensions and choose the style of widgets in a much easier way.
2999 * Instead of thinking in terms of paths to Edje files and their groups
3000 * each time you want to change the appearance of a widget, Elementary
3001 * works so you can add any theme file with extensions or replace the
3002 * main theme at one point in the application, and then just set the style
3003 * of widgets with elm_object_style_set() and related functions. Elementary
3004 * will then look in its list of themes for a matching group and apply it,
3005 * and when the theme changes midway through the application, all widgets
3006 * will be updated accordingly.
3008 * There are three concepts you need to know to understand how Elementary
3009 * theming works: default theme, extensions and overlays.
3011 * Default theme, obviously enough, is the one that provides the default
3012 * look of all widgets. End users can change the theme used by Elementary
3013 * by setting the @c ELM_THEME environment variable before running an
3014 * application, or globally for all programs using the @c elementary_config
3015 * utility. Applications can change the default theme using elm_theme_set(),
3016 * but this can go against the user wishes, so it's not an adviced practice.
3018 * Ideally, applications should find everything they need in the already
3019 * provided theme, but there may be occasions when that's not enough and
3020 * custom styles are required to correctly express the idea. For this
3021 * cases, Elementary has extensions.
3023 * Extensions allow the application developer to write styles of its own
3024 * to apply to some widgets. This requires knowledge of how each widget
3025 * is themed, as extensions will always replace the entire group used by
3026 * the widget, so important signals and parts need to be there for the
3027 * object to behave properly (see documentation of Edje for details).
3028 * Once the theme for the extension is done, the application needs to add
3029 * it to the list of themes Elementary will look into, using
3030 * elm_theme_extension_add(), and set the style of the desired widgets as
3031 * he would normally with elm_object_style_set().
3033 * Overlays, on the other hand, can replace the look of all widgets by
3034 * overriding the default style. Like extensions, it's up to the application
3035 * developer to write the theme for the widgets it wants, the difference
3036 * being that when looking for the theme, Elementary will check first the
3037 * list of overlays, then the set theme and lastly the list of extensions,
3038 * so with overlays it's possible to replace the default view and every
3039 * widget will be affected. This is very much alike to setting the whole
3040 * theme for the application and will probably clash with the end user
3041 * options, not to mention the risk of ending up with not matching styles
3042 * across the program. Unless there's a very special reason to use them,
3043 * overlays should be avoided for the resons exposed before.
3045 * All these theme lists are handled by ::Elm_Theme instances. Elementary
3046 * keeps one default internally and every function that receives one of
3047 * these can be called with NULL to refer to this default (except for
3048 * elm_theme_free()). It's possible to create a new instance of a
3049 * ::Elm_Theme to set other theme for a specific widget (and all of its
3050 * children), but this is as discouraged, if not even more so, than using
3051 * overlays. Don't use this unless you really know what you are doing.
3053 * But to be less negative about things, you can look at the following
3055 * @li @ref theme_example_01 "Using extensions"
3056 * @li @ref theme_example_02 "Using overlays"
3061 * @typedef Elm_Theme
3063 * Opaque handler for the list of themes Elementary looks for when
3064 * rendering widgets.
3066 * Stay out of this unless you really know what you are doing. For most
3067 * cases, sticking to the default is all a developer needs.
3069 typedef struct _Elm_Theme Elm_Theme;
3072 * Create a new specific theme
3074 * This creates an empty specific theme that only uses the default theme. A
3075 * specific theme has its own private set of extensions and overlays too
3076 * (which are empty by default). Specific themes do not fall back to themes
3077 * of parent objects. They are not intended for this use. Use styles, overlays
3078 * and extensions when needed, but avoid specific themes unless there is no
3079 * other way (example: you want to have a preview of a new theme you are
3080 * selecting in a "theme selector" window. The preview is inside a scroller
3081 * and should display what the theme you selected will look like, but not
3082 * actually apply it yet. The child of the scroller will have a specific
3083 * theme set to show this preview before the user decides to apply it to all
3086 EAPI Elm_Theme *elm_theme_new(void);
3088 * Free a specific theme
3090 * @param th The theme to free
3092 * This frees a theme created with elm_theme_new().
3094 EAPI void elm_theme_free(Elm_Theme *th);
3096 * Copy the theme fom the source to the destination theme
3098 * @param th The source theme to copy from
3099 * @param thdst The destination theme to copy data to
3101 * This makes a one-time static copy of all the theme config, extensions
3102 * and overlays from @p th to @p thdst. If @p th references a theme, then
3103 * @p thdst is also set to reference it, with all the theme settings,
3104 * overlays and extensions that @p th had.
3106 EAPI void elm_theme_copy(Elm_Theme *th, Elm_Theme *thdst);
3108 * Tell the source theme to reference the ref theme
3110 * @param th The theme that will do the referencing
3111 * @param thref The theme that is the reference source
3113 * This clears @p th to be empty and then sets it to refer to @p thref
3114 * so @p th acts as an override to @p thref, but where its overrides
3115 * don't apply, it will fall through to @p thref for configuration.
3117 EAPI void elm_theme_ref_set(Elm_Theme *th, Elm_Theme *thref);
3119 * Return the theme referred to
3121 * @param th The theme to get the reference from
3122 * @return The referenced theme handle
3124 * This gets the theme set as the reference theme by elm_theme_ref_set().
3125 * If no theme is set as a reference, NULL is returned.
3127 EAPI Elm_Theme *elm_theme_ref_get(Elm_Theme *th);
3129 * Return the default theme
3131 * @return The default theme handle
3133 * This returns the internal default theme setup handle that all widgets
3134 * use implicitly unless a specific theme is set. This is also often use
3135 * as a shorthand of NULL.
3137 EAPI Elm_Theme *elm_theme_default_get(void);
3139 * Prepends a theme overlay to the list of overlays
3141 * @param th The theme to add to, or if NULL, the default theme
3142 * @param item The Edje file path to be used
3144 * Use this if your application needs to provide some custom overlay theme
3145 * (An Edje file that replaces some default styles of widgets) where adding
3146 * new styles, or changing system theme configuration is not possible. Do
3147 * NOT use this instead of a proper system theme configuration. Use proper
3148 * configuration files, profiles, environment variables etc. to set a theme
3149 * so that the theme can be altered by simple confiugration by a user. Using
3150 * this call to achieve that effect is abusing the API and will create lots
3153 * @see elm_theme_extension_add()
3155 EAPI void elm_theme_overlay_add(Elm_Theme *th, const char *item);
3157 * Delete a theme overlay from the list of overlays
3159 * @param th The theme to delete from, or if NULL, the default theme
3160 * @param item The name of the theme overlay
3162 * @see elm_theme_overlay_add()
3164 EAPI void elm_theme_overlay_del(Elm_Theme *th, const char *item);
3166 * Appends a theme extension to the list of extensions.
3168 * @param th The theme to add to, or if NULL, the default theme
3169 * @param item The Edje file path to be used
3171 * This is intended when an application needs more styles of widgets or new
3172 * widget themes that the default does not provide (or may not provide). The
3173 * application has "extended" usage by coming up with new custom style names
3174 * for widgets for specific uses, but as these are not "standard", they are
3175 * not guaranteed to be provided by a default theme. This means the
3176 * application is required to provide these extra elements itself in specific
3177 * Edje files. This call adds one of those Edje files to the theme search
3178 * path to be search after the default theme. The use of this call is
3179 * encouraged when default styles do not meet the needs of the application.
3180 * Use this call instead of elm_theme_overlay_add() for almost all cases.
3182 * @see elm_object_style_set()
3184 EAPI void elm_theme_extension_add(Elm_Theme *th, const char *item);
3186 * Deletes a theme extension from the list of extensions.
3188 * @param th The theme to delete from, or if NULL, the default theme
3189 * @param item The name of the theme extension
3191 * @see elm_theme_extension_add()
3193 EAPI void elm_theme_extension_del(Elm_Theme *th, const char *item);
3195 * Set the theme search order for the given theme
3197 * @param th The theme to set the search order, or if NULL, the default theme
3198 * @param theme Theme search string
3200 * This sets the search string for the theme in path-notation from first
3201 * theme to search, to last, delimited by the : character. Example:
3203 * "shiny:/path/to/file.edj:default"
3205 * See the ELM_THEME environment variable for more information.
3207 * @see elm_theme_get()
3208 * @see elm_theme_list_get()
3210 EAPI void elm_theme_set(Elm_Theme *th, const char *theme);
3212 * Return the theme search order
3214 * @param th The theme to get the search order, or if NULL, the default theme
3215 * @return The internal search order path
3217 * This function returns a colon separated string of theme elements as
3218 * returned by elm_theme_list_get().
3220 * @see elm_theme_set()
3221 * @see elm_theme_list_get()
3223 EAPI const char *elm_theme_get(Elm_Theme *th);
3225 * Return a list of theme elements to be used in a theme.
3227 * @param th Theme to get the list of theme elements from.
3228 * @return The internal list of theme elements
3230 * This returns the internal list of theme elements (will only be valid as
3231 * long as the theme is not modified by elm_theme_set() or theme is not
3232 * freed by elm_theme_free(). This is a list of strings which must not be
3233 * altered as they are also internal. If @p th is NULL, then the default
3234 * theme element list is returned.
3236 * A theme element can consist of a full or relative path to a .edj file,
3237 * or a name, without extension, for a theme to be searched in the known
3238 * theme paths for Elemementary.
3240 * @see elm_theme_set()
3241 * @see elm_theme_get()
3243 EAPI const Eina_List *elm_theme_list_get(const Elm_Theme *th);
3245 * Return the full patrh for a theme element
3247 * @param f The theme element name
3248 * @param in_search_path Pointer to a boolean to indicate if item is in the search path or not
3249 * @return The full path to the file found.
3251 * This returns a string you should free with free() on success, NULL on
3252 * failure. This will search for the given theme element, and if it is a
3253 * full or relative path element or a simple searchable name. The returned
3254 * path is the full path to the file, if searched, and the file exists, or it
3255 * is simply the full path given in the element or a resolved path if
3256 * relative to home. The @p in_search_path boolean pointed to is set to
3257 * EINA_TRUE if the file was a searchable file andis in the search path,
3258 * and EINA_FALSE otherwise.
3260 EAPI char *elm_theme_list_item_path_get(const char *f, Eina_Bool *in_search_path);
3262 * Flush the current theme.
3264 * @param th Theme to flush
3266 * This flushes caches that let elementary know where to find theme elements
3267 * in the given theme. If @p th is NULL, then the default theme is flushed.
3268 * Call this function if source theme data has changed in such a way as to
3269 * make any caches Elementary kept invalid.
3271 EAPI void elm_theme_flush(Elm_Theme *th);
3273 * This flushes all themes (default and specific ones).
3275 * This will flush all themes in the current application context, by calling
3276 * elm_theme_flush() on each of them.
3278 EAPI void elm_theme_full_flush(void);
3280 * Set the theme for all elementary using applications on the current display
3282 * @param theme The name of the theme to use. Format same as the ELM_THEME
3283 * environment variable.
3285 EAPI void elm_theme_all_set(const char *theme);
3287 * Return a list of theme elements in the theme search path
3289 * @return A list of strings that are the theme element names.
3291 * This lists all available theme files in the standard Elementary search path
3292 * for theme elements, and returns them in alphabetical order as theme
3293 * element names in a list of strings. Free this with
3294 * elm_theme_name_available_list_free() when you are done with the list.
3296 EAPI Eina_List *elm_theme_name_available_list_new(void);
3298 * Free the list returned by elm_theme_name_available_list_new()
3300 * This frees the list of themes returned by
3301 * elm_theme_name_available_list_new(). Once freed the list should no longer
3302 * be used. a new list mys be created.
3304 EAPI void elm_theme_name_available_list_free(Eina_List *list);
3306 * Set a specific theme to be used for this object and its children
3308 * @param obj The object to set the theme on
3309 * @param th The theme to set
3311 * This sets a specific theme that will be used for the given object and any
3312 * child objects it has. If @p th is NULL then the theme to be used is
3313 * cleared and the object will inherit its theme from its parent (which
3314 * ultimately will use the default theme if no specific themes are set).
3316 * Use special themes with great care as this will annoy users and make
3317 * configuration difficult. Avoid any custom themes at all if it can be
3320 EAPI void elm_object_theme_set(Evas_Object *obj, Elm_Theme *th) EINA_ARG_NONNULL(1);
3322 * Get the specific theme to be used
3324 * @param obj The object to get the specific theme from
3325 * @return The specifc theme set.
3327 * This will return a specific theme set, or NULL if no specific theme is
3328 * set on that object. It will not return inherited themes from parents, only
3329 * the specific theme set for that specific object. See elm_object_theme_set()
3330 * for more information.
3332 EAPI Elm_Theme *elm_object_theme_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3338 /** @defgroup Win Win
3340 * @image html img/widget/win/preview-00.png
3341 * @image latex img/widget/win/preview-00.eps
3343 * The window class of Elementary. Contains functions to manipulate
3344 * windows. The Evas engine used to render the window contents is specified
3345 * in the system or user elementary config files (whichever is found last),
3346 * and can be overridden with the ELM_ENGINE environment variable for
3347 * testing. Engines that may be supported (depending on Evas and Ecore-Evas
3348 * compilation setup and modules actually installed at runtime) are (listed
3349 * in order of best supported and most likely to be complete and work to
3352 * @li "x11", "x", "software-x11", "software_x11" (Software rendering in X11)
3353 * @li "gl", "opengl", "opengl-x11", "opengl_x11" (OpenGL or OpenGL-ES2
3355 * @li "shot:..." (Virtual screenshot renderer - renders to output file and
3357 * @li "fb", "software-fb", "software_fb" (Linux framebuffer direct software
3359 * @li "sdl", "software-sdl", "software_sdl" (SDL software rendering to SDL
3361 * @li "gl-sdl", "gl_sdl", "opengl-sdl", "opengl_sdl" (OpenGL or OpenGL-ES2
3362 * rendering using SDL as the buffer)
3363 * @li "gdi", "software-gdi", "software_gdi" (Windows WIN32 rendering via
3364 * GDI with software)
3365 * @li "dfb", "directfb" (Rendering to a DirectFB window)
3366 * @li "x11-8", "x8", "software-8-x11", "software_8_x11" (Rendering in
3367 * grayscale using dedicated 8bit software engine in X11)
3368 * @li "x11-16", "x16", "software-16-x11", "software_16_x11" (Rendering in
3369 * X11 using 16bit software engine)
3370 * @li "wince-gdi", "software-16-wince-gdi", "software_16_wince_gdi"
3371 * (Windows CE rendering via GDI with 16bit software renderer)
3372 * @li "sdl-16", "software-16-sdl", "software_16_sdl" (Rendering to SDL
3373 * buffer with 16bit software renderer)
3375 * All engines use a simple string to select the engine to render, EXCEPT
3376 * the "shot" engine. This actually encodes the output of the virtual
3377 * screenshot and how long to delay in the engine string. The engine string
3378 * is encoded in the following way:
3380 * "shot:[delay=XX][:][repeat=DDD][:][file=XX]"
3382 * Where options are separated by a ":" char if more than one option is
3383 * given, with delay, if provided being the first option and file the last
3384 * (order is important). The delay specifies how long to wait after the
3385 * window is shown before doing the virtual "in memory" rendering and then
3386 * save the output to the file specified by the file option (and then exit).
3387 * If no delay is given, the default is 0.5 seconds. If no file is given the
3388 * default output file is "out.png". Repeat option is for continous
3389 * capturing screenshots. Repeat range is from 1 to 999 and filename is
3390 * fixed to "out001.png" Some examples of using the shot engine:
3392 * ELM_ENGINE="shot:delay=1.0:repeat=5:file=elm_test.png" elementary_test
3393 * ELM_ENGINE="shot:delay=1.0:file=elm_test.png" elementary_test
3394 * ELM_ENGINE="shot:file=elm_test2.png" elementary_test
3395 * ELM_ENGINE="shot:delay=2.0" elementary_test
3396 * ELM_ENGINE="shot:" elementary_test
3398 * Signals that you can add callbacks for are:
3400 * @li "delete,request": the user requested to close the window. See
3401 * elm_win_autodel_set().
3402 * @li "focus,in": window got focus
3403 * @li "focus,out": window lost focus
3404 * @li "moved": window that holds the canvas was moved
3407 * @li @ref win_example_01
3412 * Defines the types of window that can be created
3414 * These are hints set on the window so that a running Window Manager knows
3415 * how the window should be handled and/or what kind of decorations it
3418 * Currently, only the X11 backed engines use them.
3420 typedef enum _Elm_Win_Type
3422 ELM_WIN_BASIC, /**< A normal window. Indicates a normal, top-level
3423 window. Almost every window will be created with this
3425 ELM_WIN_DIALOG_BASIC, /**< Used for simple dialog windows/ */
3426 ELM_WIN_DESKTOP, /**< For special desktop windows, like a background
3427 window holding desktop icons. */
3428 ELM_WIN_DOCK, /**< The window is used as a dock or panel. Usually would
3429 be kept on top of any other window by the Window
3431 ELM_WIN_TOOLBAR, /**< The window is used to hold a floating toolbar, or
3433 ELM_WIN_MENU, /**< Similar to #ELM_WIN_TOOLBAR. */
3434 ELM_WIN_UTILITY, /**< A persistent utility window, like a toolbox or
3436 ELM_WIN_SPLASH, /**< Splash window for a starting up application. */
3437 ELM_WIN_DROPDOWN_MENU, /**< The window is a dropdown menu, as when an
3438 entry in a menubar is clicked. Typically used
3439 with elm_win_override_set(). This hint exists
3440 for completion only, as the EFL way of
3441 implementing a menu would not normally use a
3442 separate window for its contents. */
3443 ELM_WIN_POPUP_MENU, /**< Like #ELM_WIN_DROPDOWN_MENU, but for the menu
3444 triggered by right-clicking an object. */
3445 ELM_WIN_TOOLTIP, /**< The window is a tooltip. A short piece of
3446 explanatory text that typically appear after the
3447 mouse cursor hovers over an object for a while.
3448 Typically used with elm_win_override_set() and also
3449 not very commonly used in the EFL. */
3450 ELM_WIN_NOTIFICATION, /**< A notification window, like a warning about
3451 battery life or a new E-Mail received. */
3452 ELM_WIN_COMBO, /**< A window holding the contents of a combo box. Not
3453 usually used in the EFL. */
3454 ELM_WIN_DND, /**< Used to indicate the window is a representation of an
3455 object being dragged across different windows, or even
3456 applications. Typically used with
3457 elm_win_override_set(). */
3458 ELM_WIN_INLINED_IMAGE, /**< The window is rendered onto an image
3459 buffer. No actual window is created for this
3460 type, instead the window and all of its
3461 contents will be rendered to an image buffer.
3462 This allows to have children window inside a
3463 parent one just like any other object would
3464 be, and do other things like applying @c
3465 Evas_Map effects to it. This is the only type
3466 of window that requires the @c parent
3467 parameter of elm_win_add() to be a valid @c
3472 * The differents layouts that can be requested for the virtual keyboard.
3474 * When the application window is being managed by Illume, it may request
3475 * any of the following layouts for the virtual keyboard.
3477 typedef enum _Elm_Win_Keyboard_Mode
3479 ELM_WIN_KEYBOARD_UNKNOWN, /**< Unknown keyboard state */
3480 ELM_WIN_KEYBOARD_OFF, /**< Request to deactivate the keyboard */
3481 ELM_WIN_KEYBOARD_ON, /**< Enable keyboard with default layout */
3482 ELM_WIN_KEYBOARD_ALPHA, /**< Alpha (a-z) keyboard layout */
3483 ELM_WIN_KEYBOARD_NUMERIC, /**< Numeric keyboard layout */
3484 ELM_WIN_KEYBOARD_PIN, /**< PIN keyboard layout */
3485 ELM_WIN_KEYBOARD_PHONE_NUMBER, /**< Phone keyboard layout */
3486 ELM_WIN_KEYBOARD_HEX, /**< Hexadecimal numeric keyboard layout */
3487 ELM_WIN_KEYBOARD_TERMINAL, /**< Full (QUERTY) keyboard layout */
3488 ELM_WIN_KEYBOARD_PASSWORD, /**< Password keyboard layout */
3489 ELM_WIN_KEYBOARD_IP, /**< IP keyboard layout */
3490 ELM_WIN_KEYBOARD_HOST, /**< Host keyboard layout */
3491 ELM_WIN_KEYBOARD_FILE, /**< File keyboard layout */
3492 ELM_WIN_KEYBOARD_URL, /**< URL keyboard layout */
3493 ELM_WIN_KEYBOARD_KEYPAD, /**< Keypad layout */
3494 ELM_WIN_KEYBOARD_J2ME /**< J2ME keyboard layout */
3495 } Elm_Win_Keyboard_Mode;
3498 * Available commands that can be sent to the Illume manager.
3500 * When running under an Illume session, a window may send commands to the
3501 * Illume manager to perform different actions.
3503 typedef enum _Elm_Illume_Command
3505 ELM_ILLUME_COMMAND_FOCUS_BACK, /**< Reverts focus to the previous
3507 ELM_ILLUME_COMMAND_FOCUS_FORWARD, /**< Sends focus to the next window\
3509 ELM_ILLUME_COMMAND_FOCUS_HOME, /**< Hides all windows to show the Home
3511 ELM_ILLUME_COMMAND_CLOSE /**< Closes the currently active window */
3512 } Elm_Illume_Command;
3515 * Adds a window object. If this is the first window created, pass NULL as
3518 * @param parent Parent object to add the window to, or NULL
3519 * @param name The name of the window
3520 * @param type The window type, one of #Elm_Win_Type.
3522 * The @p parent paramter can be @c NULL for every window @p type except
3523 * #ELM_WIN_INLINED_IMAGE, which needs a parent to retrieve the canvas on
3524 * which the image object will be created.
3526 * @return The created object, or NULL on failure
3528 EAPI Evas_Object *elm_win_add(Evas_Object *parent, const char *name, Elm_Win_Type type);
3530 * Add @p subobj as a resize object of window @p obj.
3533 * Setting an object as a resize object of the window means that the
3534 * @p subobj child's size and position will be controlled by the window
3535 * directly. That is, the object will be resized to match the window size
3536 * and should never be moved or resized manually by the developer.
3538 * In addition, resize objects of the window control what the minimum size
3539 * of it will be, as well as whether it can or not be resized by the user.
3541 * For the end user to be able to resize a window by dragging the handles
3542 * or borders provided by the Window Manager, or using any other similar
3543 * mechanism, all of the resize objects in the window should have their
3544 * evas_object_size_hint_weight_set() set to EVAS_HINT_EXPAND.
3546 * @param obj The window object
3547 * @param subobj The resize object to add
3549 EAPI void elm_win_resize_object_add(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
3551 * Delete @p subobj as a resize object of window @p obj.
3553 * This function removes the object @p subobj from the resize objects of
3554 * the window @p obj. It will not delete the object itself, which will be
3555 * left unmanaged and should be deleted by the developer, manually handled
3556 * or set as child of some other container.
3558 * @param obj The window object
3559 * @param subobj The resize object to add
3561 EAPI void elm_win_resize_object_del(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
3563 * Set the title of the window
3565 * @param obj The window object
3566 * @param title The title to set
3568 EAPI void elm_win_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
3570 * Get the title of the window
3572 * The returned string is an internal one and should not be freed or
3573 * modified. It will also be rendered invalid if a new title is set or if
3574 * the window is destroyed.
3576 * @param obj The window object
3579 EAPI const char *elm_win_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3581 * Set the window's autodel state.
3583 * When closing the window in any way outside of the program control, like
3584 * pressing the X button in the titlebar or using a command from the
3585 * Window Manager, a "delete,request" signal is emitted to indicate that
3586 * this event occurred and the developer can take any action, which may
3587 * include, or not, destroying the window object.
3589 * When the @p autodel parameter is set, the window will be automatically
3590 * destroyed when this event occurs, after the signal is emitted.
3591 * If @p autodel is @c EINA_FALSE, then the window will not be destroyed
3592 * and is up to the program to do so when it's required.
3594 * @param obj The window object
3595 * @param autodel If true, the window will automatically delete itself when
3598 EAPI void elm_win_autodel_set(Evas_Object *obj, Eina_Bool autodel) EINA_ARG_NONNULL(1);
3600 * Get the window's autodel state.
3602 * @param obj The window object
3603 * @return If the window will automatically delete itself when closed
3605 * @see elm_win_autodel_set()
3607 EAPI Eina_Bool elm_win_autodel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3609 * Activate a window object.
3611 * This function sends a request to the Window Manager to activate the
3612 * window pointed by @p obj. If honored by the WM, the window will receive
3613 * the keyboard focus.
3615 * @note This is just a request that a Window Manager may ignore, so calling
3616 * this function does not ensure in any way that the window will be the
3617 * active one after it.
3619 * @param obj The window object
3621 EAPI void elm_win_activate(Evas_Object *obj) EINA_ARG_NONNULL(1);
3623 * Lower a window object.
3625 * Places the window pointed by @p obj at the bottom of the stack, so that
3626 * no other window is covered by it.
3628 * If elm_win_override_set() is not set, the Window Manager may ignore this
3631 * @param obj The window object
3633 EAPI void elm_win_lower(Evas_Object *obj) EINA_ARG_NONNULL(1);
3635 * Raise a window object.
3637 * Places the window pointed by @p obj at the top of the stack, so that it's
3638 * not covered by any other window.
3640 * If elm_win_override_set() is not set, the Window Manager may ignore this
3643 * @param obj The window object
3645 EAPI void elm_win_raise(Evas_Object *obj) EINA_ARG_NONNULL(1);
3647 * Set the borderless state of a window.
3649 * This function requests the Window Manager to not draw any decoration
3650 * around the window.
3652 * @param obj The window object
3653 * @param borderless If true, the window is borderless
3655 EAPI void elm_win_borderless_set(Evas_Object *obj, Eina_Bool borderless) EINA_ARG_NONNULL(1);
3657 * Get the borderless state of a window.
3659 * @param obj The window object
3660 * @return If true, the window is borderless
3662 EAPI Eina_Bool elm_win_borderless_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3664 * Set the shaped state of a window.
3666 * Shaped windows, when supported, will render the parts of the window that
3667 * has no content, transparent.
3669 * If @p shaped is EINA_FALSE, then it is strongly adviced to have some
3670 * background object or cover the entire window in any other way, or the
3671 * parts of the canvas that have no data will show framebuffer artifacts.
3673 * @param obj The window object
3674 * @param shaped If true, the window is shaped
3676 * @see elm_win_alpha_set()
3678 EAPI void elm_win_shaped_set(Evas_Object *obj, Eina_Bool shaped) EINA_ARG_NONNULL(1);
3680 * Get the shaped state of a window.
3682 * @param obj The window object
3683 * @return If true, the window is shaped
3685 * @see elm_win_shaped_set()
3687 EAPI Eina_Bool elm_win_shaped_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3689 * Set the alpha channel state of a window.
3691 * If @p alpha is EINA_TRUE, the alpha channel of the canvas will be enabled
3692 * possibly making parts of the window completely or partially transparent.
3693 * This is also subject to the underlying system supporting it, like for
3694 * example, running under a compositing manager. If no compositing is
3695 * available, enabling this option will instead fallback to using shaped
3696 * windows, with elm_win_shaped_set().
3698 * @param obj The window object
3699 * @param alpha If true, the window has an alpha channel
3701 * @see elm_win_alpha_set()
3703 EAPI void elm_win_alpha_set(Evas_Object *obj, Eina_Bool alpha) EINA_ARG_NONNULL(1);
3705 * Get the transparency state of a window.
3707 * @param obj The window object
3708 * @return If true, the window is transparent
3710 * @see elm_win_transparent_set()
3712 EAPI Eina_Bool elm_win_transparent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3714 * Set the transparency state of a window.
3716 * Use elm_win_alpha_set() instead.
3718 * @param obj The window object
3719 * @param transparent If true, the window is transparent
3721 * @see elm_win_alpha_set()
3723 EAPI void elm_win_transparent_set(Evas_Object *obj, Eina_Bool transparent) EINA_ARG_NONNULL(1);
3725 * Get the alpha channel state of a window.
3727 * @param obj The window object
3728 * @return If true, the window has an alpha channel
3730 EAPI Eina_Bool elm_win_alpha_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3732 * Set the override state of a window.
3734 * A window with @p override set to EINA_TRUE will not be managed by the
3735 * Window Manager. This means that no decorations of any kind will be shown
3736 * for it, moving and resizing must be handled by the application, as well
3737 * as the window visibility.
3739 * This should not be used for normal windows, and even for not so normal
3740 * ones, it should only be used when there's a good reason and with a lot
3741 * of care. Mishandling override windows may result situations that
3742 * disrupt the normal workflow of the end user.
3744 * @param obj The window object
3745 * @param override If true, the window is overridden
3747 EAPI void elm_win_override_set(Evas_Object *obj, Eina_Bool override) EINA_ARG_NONNULL(1);
3749 * Get the override state of a window.
3751 * @param obj The window object
3752 * @return If true, the window is overridden
3754 * @see elm_win_override_set()
3756 EAPI Eina_Bool elm_win_override_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3758 * Set the fullscreen state of a window.
3760 * @param obj The window object
3761 * @param fullscreen If true, the window is fullscreen
3763 EAPI void elm_win_fullscreen_set(Evas_Object *obj, Eina_Bool fullscreen) EINA_ARG_NONNULL(1);
3765 * Get the fullscreen state of a window.
3767 * @param obj The window object
3768 * @return If true, the window is fullscreen
3770 EAPI Eina_Bool elm_win_fullscreen_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3772 * Set the maximized state of a window.
3774 * @param obj The window object
3775 * @param maximized If true, the window is maximized
3777 EAPI void elm_win_maximized_set(Evas_Object *obj, Eina_Bool maximized) EINA_ARG_NONNULL(1);
3779 * Get the maximized state of a window.
3781 * @param obj The window object
3782 * @return If true, the window is maximized
3784 EAPI Eina_Bool elm_win_maximized_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3786 * Set the iconified state of a window.
3788 * @param obj The window object
3789 * @param iconified If true, the window is iconified
3791 EAPI void elm_win_iconified_set(Evas_Object *obj, Eina_Bool iconified) EINA_ARG_NONNULL(1);
3793 * Get the iconified state of a window.
3795 * @param obj The window object
3796 * @return If true, the window is iconified
3798 EAPI Eina_Bool elm_win_iconified_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3800 * Set the layer of the window.
3802 * What this means exactly will depend on the underlying engine used.
3804 * In the case of X11 backed engines, the value in @p layer has the
3805 * following meanings:
3806 * @li < 3: The window will be placed below all others.
3807 * @li > 5: The window will be placed above all others.
3808 * @li other: The window will be placed in the default layer.
3810 * @param obj The window object
3811 * @param layer The layer of the window
3813 EAPI void elm_win_layer_set(Evas_Object *obj, int layer) EINA_ARG_NONNULL(1);
3815 * Get the layer of the window.
3817 * @param obj The window object
3818 * @return The layer of the window
3820 * @see elm_win_layer_set()
3822 EAPI int elm_win_layer_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3824 * Set the rotation of the window.
3826 * Most engines only work with multiples of 90.
3828 * This function is used to set the orientation of the window @p obj to
3829 * match that of the screen. The window itself will be resized to adjust
3830 * to the new geometry of its contents. If you want to keep the window size,
3831 * see elm_win_rotation_with_resize_set().
3833 * @param obj The window object
3834 * @param rotation The rotation of the window, in degrees (0-360),
3835 * counter-clockwise.
3837 EAPI void elm_win_rotation_set(Evas_Object *obj, int rotation) EINA_ARG_NONNULL(1);
3839 * Rotates the window and resizes it.
3841 * Like elm_win_rotation_set(), but it also resizes the window's contents so
3842 * that they fit inside the current window geometry.
3844 * @param obj The window object
3845 * @param layer The rotation of the window in degrees (0-360),
3846 * counter-clockwise.
3848 EAPI void elm_win_rotation_with_resize_set(Evas_Object *obj, int rotation) EINA_ARG_NONNULL(1);
3850 * Get the rotation of the window.
3852 * @param obj The window object
3853 * @return The rotation of the window in degrees (0-360)
3855 * @see elm_win_rotation_set()
3856 * @see elm_win_rotation_with_resize_set()
3858 EAPI int elm_win_rotation_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3860 * Set the sticky state of the window.
3862 * Hints the Window Manager that the window in @p obj should be left fixed
3863 * at its position even when the virtual desktop it's on moves or changes.
3865 * @param obj The window object
3866 * @param sticky If true, the window's sticky state is enabled
3868 EAPI void elm_win_sticky_set(Evas_Object *obj, Eina_Bool sticky) EINA_ARG_NONNULL(1);
3870 * Get the sticky state of the window.
3872 * @param obj The window object
3873 * @return If true, the window's sticky state is enabled
3875 * @see elm_win_sticky_set()
3877 EAPI Eina_Bool elm_win_sticky_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3879 * Set if this window is an illume conformant window
3881 * @param obj The window object
3882 * @param conformant The conformant flag (1 = conformant, 0 = non-conformant)
3884 EAPI void elm_win_conformant_set(Evas_Object *obj, Eina_Bool conformant) EINA_ARG_NONNULL(1);
3886 * Get if this window is an illume conformant window
3888 * @param obj The window object
3889 * @return A boolean if this window is illume conformant or not
3891 EAPI Eina_Bool elm_win_conformant_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3893 * Set a window to be an illume quickpanel window
3895 * By default window objects are not quickpanel windows.
3897 * @param obj The window object
3898 * @param quickpanel The quickpanel flag (1 = quickpanel, 0 = normal window)
3900 EAPI void elm_win_quickpanel_set(Evas_Object *obj, Eina_Bool quickpanel) EINA_ARG_NONNULL(1);
3902 * Get if this window is a quickpanel or not
3904 * @param obj The window object
3905 * @return A boolean if this window is a quickpanel or not
3907 EAPI Eina_Bool elm_win_quickpanel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3909 * Set the major priority of a quickpanel window
3911 * @param obj The window object
3912 * @param priority The major priority for this quickpanel
3914 EAPI void elm_win_quickpanel_priority_major_set(Evas_Object *obj, int priority) EINA_ARG_NONNULL(1);
3916 * Get the major priority of a quickpanel window
3918 * @param obj The window object
3919 * @return The major priority of this quickpanel
3921 EAPI int elm_win_quickpanel_priority_major_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3923 * Set the minor priority of a quickpanel window
3925 * @param obj The window object
3926 * @param priority The minor priority for this quickpanel
3928 EAPI void elm_win_quickpanel_priority_minor_set(Evas_Object *obj, int priority) EINA_ARG_NONNULL(1);
3930 * Get the minor priority of a quickpanel window
3932 * @param obj The window object
3933 * @return The minor priority of this quickpanel
3935 EAPI int elm_win_quickpanel_priority_minor_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3937 * Set which zone this quickpanel should appear in
3939 * @param obj The window object
3940 * @param zone The requested zone for this quickpanel
3942 EAPI void elm_win_quickpanel_zone_set(Evas_Object *obj, int zone) EINA_ARG_NONNULL(1);
3944 * Get which zone this quickpanel should appear in
3946 * @param obj The window object
3947 * @return The requested zone for this quickpanel
3949 EAPI int elm_win_quickpanel_zone_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3951 * Set the window to be skipped by keyboard focus
3953 * This sets the window to be skipped by normal keyboard input. This means
3954 * a window manager will be asked to not focus this window as well as omit
3955 * it from things like the taskbar, pager, "alt-tab" list etc. etc.
3957 * Call this and enable it on a window BEFORE you show it for the first time,
3958 * otherwise it may have no effect.
3960 * Use this for windows that have only output information or might only be
3961 * interacted with by the mouse or fingers, and never for typing input.
3962 * Be careful that this may have side-effects like making the window
3963 * non-accessible in some cases unless the window is specially handled. Use
3966 * @param obj The window object
3967 * @param skip The skip flag state (EINA_TRUE if it is to be skipped)
3969 EAPI void elm_win_prop_focus_skip_set(Evas_Object *obj, Eina_Bool skip) EINA_ARG_NONNULL(1);
3971 * Send a command to the windowing environment
3973 * This is intended to work in touchscreen or small screen device
3974 * environments where there is a more simplistic window management policy in
3975 * place. This uses the window object indicated to select which part of the
3976 * environment to control (the part that this window lives in), and provides
3977 * a command and an optional parameter structure (use NULL for this if not
3980 * @param obj The window object that lives in the environment to control
3981 * @param command The command to send
3982 * @param params Optional parameters for the command
3984 EAPI void elm_win_illume_command_send(Evas_Object *obj, Elm_Illume_Command command, void *params) EINA_ARG_NONNULL(1);
3986 * Get the inlined image object handle
3988 * When you create a window with elm_win_add() of type ELM_WIN_INLINED_IMAGE,
3989 * then the window is in fact an evas image object inlined in the parent
3990 * canvas. You can get this object (be careful to not manipulate it as it
3991 * is under control of elementary), and use it to do things like get pixel
3992 * data, save the image to a file, etc.
3994 * @param obj The window object to get the inlined image from
3995 * @return The inlined image object, or NULL if none exists
3997 EAPI Evas_Object *elm_win_inlined_image_object_get(Evas_Object *obj);
3999 * Set the enabled status for the focus highlight in a window
4001 * This function will enable or disable the focus highlight only for the
4002 * given window, regardless of the global setting for it
4004 * @param obj The window where to enable the highlight
4005 * @param enabled The enabled value for the highlight
4007 EAPI void elm_win_focus_highlight_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
4009 * Get the enabled value of the focus highlight for this window
4011 * @param obj The window in which to check if the focus highlight is enabled
4013 * @return EINA_TRUE if enabled, EINA_FALSE otherwise
4015 EAPI Eina_Bool elm_win_focus_highlight_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4017 * Set the style for the focus highlight on this window
4019 * Sets the style to use for theming the highlight of focused objects on
4020 * the given window. If @p style is NULL, the default will be used.
4022 * @param obj The window where to set the style
4023 * @param style The style to set
4025 EAPI void elm_win_focus_highlight_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
4027 * Get the style set for the focus highlight object
4029 * Gets the style set for this windows highilght object, or NULL if none
4032 * @param obj The window to retrieve the highlights style from
4034 * @return The style set or NULL if none was. Default is used in that case.
4036 EAPI const char *elm_win_focus_highlight_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4038 * ecore_x_icccm_hints_set -> accepts_focus (add to ecore_evas)
4039 * ecore_x_icccm_hints_set -> window_group (add to ecore_evas)
4040 * ecore_x_icccm_size_pos_hints_set -> request_pos (add to ecore_evas)
4041 * ecore_x_icccm_client_leader_set -> l (add to ecore_evas)
4042 * ecore_x_icccm_window_role_set -> role (add to ecore_evas)
4043 * ecore_x_icccm_transient_for_set -> forwin (add to ecore_evas)
4044 * ecore_x_netwm_window_type_set -> type (add to ecore_evas)
4046 * (add to ecore_x) set netwm argb icon! (add to ecore_evas)
4047 * (blank mouse, private mouse obj, defaultmouse)
4051 * Sets the keyboard mode of the window.
4053 * @param obj The window object
4054 * @param mode The mode to set, one of #Elm_Win_Keyboard_Mode
4056 EAPI void elm_win_keyboard_mode_set(Evas_Object *obj, Elm_Win_Keyboard_Mode mode) EINA_ARG_NONNULL(1);
4058 * Gets the keyboard mode of the window.
4060 * @param obj The window object
4061 * @return The mode, one of #Elm_Win_Keyboard_Mode
4063 EAPI Elm_Win_Keyboard_Mode elm_win_keyboard_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4065 * Sets whether the window is a keyboard.
4067 * @param obj The window object
4068 * @param is_keyboard If true, the window is a virtual keyboard
4070 EAPI void elm_win_keyboard_win_set(Evas_Object *obj, Eina_Bool is_keyboard) EINA_ARG_NONNULL(1);
4072 * Gets whether the window is a keyboard.
4074 * @param obj The window object
4075 * @return If the window is a virtual keyboard
4077 EAPI Eina_Bool elm_win_keyboard_win_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4080 * Get the screen position of a window.
4082 * @param obj The window object
4083 * @param x The int to store the x coordinate to
4084 * @param y The int to store the y coordinate to
4086 EAPI void elm_win_screen_position_get(const Evas_Object *obj, int *x, int *y) EINA_ARG_NONNULL(1);
4092 * @defgroup Inwin Inwin
4094 * @image html img/widget/inwin/preview-00.png
4095 * @image latex img/widget/inwin/preview-00.eps
4096 * @image html img/widget/inwin/preview-01.png
4097 * @image latex img/widget/inwin/preview-01.eps
4098 * @image html img/widget/inwin/preview-02.png
4099 * @image latex img/widget/inwin/preview-02.eps
4101 * An inwin is a window inside a window that is useful for a quick popup.
4102 * It does not hover.
4104 * It works by creating an object that will occupy the entire window, so it
4105 * must be created using an @ref Win "elm_win" as parent only. The inwin
4106 * object can be hidden or restacked below every other object if it's
4107 * needed to show what's behind it without destroying it. If this is done,
4108 * the elm_win_inwin_activate() function can be used to bring it back to
4109 * full visibility again.
4111 * There are three styles available in the default theme. These are:
4112 * @li default: The inwin is sized to take over most of the window it's
4114 * @li minimal: The size of the inwin will be the minimum necessary to show
4116 * @li minimal_vertical: Horizontally, the inwin takes as much space as
4117 * possible, but it's sized vertically the most it needs to fit its\
4120 * Some examples of Inwin can be found in the following:
4121 * @li @ref inwin_example_01
4126 * Adds an inwin to the current window
4128 * The @p obj used as parent @b MUST be an @ref Win "Elementary Window".
4129 * Never call this function with anything other than the top-most window
4130 * as its parameter, unless you are fond of undefined behavior.
4132 * After creating the object, the widget will set itself as resize object
4133 * for the window with elm_win_resize_object_add(), so when shown it will
4134 * appear to cover almost the entire window (how much of it depends on its
4135 * content and the style used). It must not be added into other container
4136 * objects and it needs not be moved or resized manually.
4138 * @param parent The parent object
4139 * @return The new object or NULL if it cannot be created
4141 EAPI Evas_Object *elm_win_inwin_add(Evas_Object *obj) EINA_ARG_NONNULL(1);
4143 * Activates an inwin object, ensuring its visibility
4145 * This function will make sure that the inwin @p obj is completely visible
4146 * by calling evas_object_show() and evas_object_raise() on it, to bring it
4147 * to the front. It also sets the keyboard focus to it, which will be passed
4150 * The object's theme will also receive the signal "elm,action,show" with
4153 * @param obj The inwin to activate
4155 EAPI void elm_win_inwin_activate(Evas_Object *obj) EINA_ARG_NONNULL(1);
4157 * Set the content of an inwin object.
4159 * Once the content object is set, a previously set one will be deleted.
4160 * If you want to keep that old content object, use the
4161 * elm_win_inwin_content_unset() function.
4163 * @param obj The inwin object
4164 * @param content The object to set as content
4166 EAPI void elm_win_inwin_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
4168 * Get the content of an inwin object.
4170 * Return the content object which is set for this widget.
4172 * The returned object is valid as long as the inwin is still alive and no
4173 * other content is set on it. Deleting the object will notify the inwin
4174 * about it and this one will be left empty.
4176 * If you need to remove an inwin's content to be reused somewhere else,
4177 * see elm_win_inwin_content_unset().
4179 * @param obj The inwin object
4180 * @return The content that is being used
4182 EAPI Evas_Object *elm_win_inwin_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4184 * Unset the content of an inwin object.
4186 * Unparent and return the content object which was set for this widget.
4188 * @param obj The inwin object
4189 * @return The content that was being used
4191 EAPI Evas_Object *elm_win_inwin_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4195 /* X specific calls - won't work on non-x engines (return 0) */
4198 * Get the Ecore_X_Window of an Evas_Object
4200 * @param obj The object
4202 * @return The Ecore_X_Window of @p obj
4206 EAPI Ecore_X_Window elm_win_xwindow_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4208 /* smart callbacks called:
4209 * "delete,request" - the user requested to delete the window
4210 * "focus,in" - window got focus
4211 * "focus,out" - window lost focus
4212 * "moved" - window that holds the canvas was moved
4218 * @image html img/widget/bg/preview-00.png
4219 * @image latex img/widget/bg/preview-00.eps
4221 * @brief Background object, used for setting a solid color, image or Edje
4222 * group as background to a window or any container object.
4224 * The bg object is used for setting a solid background to a window or
4225 * packing into any container object. It works just like an image, but has
4226 * some properties useful to a background, like setting it to tiled,
4227 * centered, scaled or stretched.
4229 * Here is some sample code using it:
4230 * @li @ref bg_01_example_page
4231 * @li @ref bg_02_example_page
4232 * @li @ref bg_03_example_page
4236 typedef enum _Elm_Bg_Option
4238 ELM_BG_OPTION_CENTER, /**< center the background */
4239 ELM_BG_OPTION_SCALE, /**< scale the background retaining aspect ratio */
4240 ELM_BG_OPTION_STRETCH, /**< stretch the background to fill */
4241 ELM_BG_OPTION_TILE /**< tile background at its original size */
4245 * Add a new background to the parent
4247 * @param parent The parent object
4248 * @return The new object or NULL if it cannot be created
4252 EAPI Evas_Object *elm_bg_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4255 * Set the file (image or edje) used for the background
4257 * @param obj The bg object
4258 * @param file The file path
4259 * @param group Optional key (group in Edje) within the file
4261 * This sets the image file used in the background object. The image (or edje)
4262 * will be stretched (retaining aspect if its an image file) to completely fill
4263 * the bg object. This may mean some parts are not visible.
4265 * @note Once the image of @p obj is set, a previously set one will be deleted,
4266 * even if @p file is NULL.
4270 EAPI void elm_bg_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1);
4273 * Get the file (image or edje) used for the background
4275 * @param obj The bg object
4276 * @param file The file path
4277 * @param group Optional key (group in Edje) within the file
4281 EAPI void elm_bg_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
4284 * Set the option used for the background image
4286 * @param obj The bg object
4287 * @param option The desired background option (TILE, SCALE)
4289 * This sets the option used for manipulating the display of the background
4290 * image. The image can be tiled or scaled.
4294 EAPI void elm_bg_option_set(Evas_Object *obj, Elm_Bg_Option option) EINA_ARG_NONNULL(1);
4297 * Get the option used for the background image
4299 * @param obj The bg object
4300 * @return The desired background option (CENTER, SCALE, STRETCH or TILE)
4304 EAPI Elm_Bg_Option elm_bg_option_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4306 * Set the option used for the background color
4308 * @param obj The bg object
4313 * This sets the color used for the background rectangle. Its range goes
4318 EAPI void elm_bg_color_set(Evas_Object *obj, int r, int g, int b) EINA_ARG_NONNULL(1);
4320 * Get the option used for the background color
4322 * @param obj The bg object
4329 EAPI void elm_bg_color_get(const Evas_Object *obj, int *r, int *g, int *b) EINA_ARG_NONNULL(1);
4332 * Set the overlay object used for the background object.
4334 * @param obj The bg object
4335 * @param overlay The overlay object
4337 * This provides a way for elm_bg to have an 'overlay' that will be on top
4338 * of the bg. Once the over object is set, a previously set one will be
4339 * deleted, even if you set the new one to NULL. If you want to keep that
4340 * old content object, use the elm_bg_overlay_unset() function.
4345 EAPI void elm_bg_overlay_set(Evas_Object *obj, Evas_Object *overlay) EINA_ARG_NONNULL(1);
4348 * Get the overlay object used for the background object.
4350 * @param obj The bg object
4351 * @return The content that is being used
4353 * Return the content object which is set for this widget
4357 EAPI Evas_Object *elm_bg_overlay_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4360 * Get the overlay object used for the background object.
4362 * @param obj The bg object
4363 * @return The content that was being used
4365 * Unparent and return the overlay object which was set for this widget
4369 EAPI Evas_Object *elm_bg_overlay_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4372 * Set the size of the pixmap representation of the image.
4374 * This option just makes sense if an image is going to be set in the bg.
4376 * @param obj The bg object
4377 * @param w The new width of the image pixmap representation.
4378 * @param h The new height of the image pixmap representation.
4380 * This function sets a new size for pixmap representation of the given bg
4381 * image. It allows the image to be loaded already in the specified size,
4382 * reducing the memory usage and load time when loading a big image with load
4383 * size set to a smaller size.
4385 * NOTE: this is just a hint, the real size of the pixmap may differ
4386 * depending on the type of image being loaded, being bigger than requested.
4390 EAPI void elm_bg_load_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
4391 /* smart callbacks called:
4395 * @defgroup Icon Icon
4397 * @image html img/widget/icon/preview-00.png
4398 * @image latex img/widget/icon/preview-00.eps
4400 * An object that provides standard icon images (delete, edit, arrows, etc.)
4401 * or a custom file (PNG, JPG, EDJE, etc.) used for an icon.
4403 * The icon image requested can be in the elementary theme, or in the
4404 * freedesktop.org paths. It's possible to set the order of preference from
4405 * where the image will be used.
4407 * This API is very similar to @ref Image, but with ready to use images.
4409 * Default images provided by the theme are described below.
4411 * The first list contains icons that were first intended to be used in
4412 * toolbars, but can be used in many other places too:
4428 * Now some icons that were designed to be used in menus (but again, you can
4429 * use them anywhere else):
4434 * @li menu/arrow_down
4435 * @li menu/arrow_left
4436 * @li menu/arrow_right
4445 * And here we have some media player specific icons:
4446 * @li media_player/forward
4447 * @li media_player/info
4448 * @li media_player/next
4449 * @li media_player/pause
4450 * @li media_player/play
4451 * @li media_player/prev
4452 * @li media_player/rewind
4453 * @li media_player/stop
4455 * Signals that you can add callbacks for are:
4457 * "clicked" - This is called when a user has clicked the icon
4459 * An example of usage for this API follows:
4460 * @li @ref tutorial_icon
4468 typedef enum _Elm_Icon_Type
4475 * @enum _Elm_Icon_Lookup_Order
4476 * @typedef Elm_Icon_Lookup_Order
4478 * Lookup order used by elm_icon_standard_set(). Should look for icons in the
4479 * theme, FDO paths, or both?
4483 typedef enum _Elm_Icon_Lookup_Order
4485 ELM_ICON_LOOKUP_FDO_THEME, /**< icon look up order: freedesktop, theme */
4486 ELM_ICON_LOOKUP_THEME_FDO, /**< icon look up order: theme, freedesktop */
4487 ELM_ICON_LOOKUP_FDO, /**< icon look up order: freedesktop */
4488 ELM_ICON_LOOKUP_THEME /**< icon look up order: theme */
4489 } Elm_Icon_Lookup_Order;
4492 * Add a new icon object to the parent.
4494 * @param parent The parent object
4495 * @return The new object or NULL if it cannot be created
4497 * @see elm_icon_file_set()
4501 EAPI Evas_Object *elm_icon_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4503 * Set the file that will be used as icon.
4505 * @param obj The icon object
4506 * @param file The path to file that will be used as icon image
4507 * @param group The group that the icon belongs to in edje file
4509 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
4511 * @note The icon image set by this function can be changed by
4512 * elm_icon_standard_set().
4514 * @see elm_icon_file_get()
4518 EAPI Eina_Bool elm_icon_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
4520 * Set a location in memory to be used as an icon
4522 * @param obj The icon object
4523 * @param img The binary data that will be used as an image
4524 * @param size The size of binary data @p img
4525 * @param format Optional format of @p img to pass to the image loader
4526 * @param key Optional key of @p img to pass to the image loader (eg. if @p img is an edje file)
4528 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
4530 * @note The icon image set by this function can be changed by
4531 * elm_icon_standard_set().
4535 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);
4537 * Get the file that will be used as icon.
4539 * @param obj The icon object
4540 * @param file The path to file that will be used as icon icon image
4541 * @param group The group that the icon belongs to in edje file
4543 * @see elm_icon_file_set()
4547 EAPI void elm_icon_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
4548 EAPI void elm_icon_thumb_set(const Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
4550 * Set the icon by icon standards names.
4552 * @param obj The icon object
4553 * @param name The icon name
4555 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
4557 * For example, freedesktop.org defines standard icon names such as "home",
4558 * "network", etc. There can be different icon sets to match those icon
4559 * keys. The @p name given as parameter is one of these "keys", and will be
4560 * used to look in the freedesktop.org paths and elementary theme. One can
4561 * change the lookup order with elm_icon_order_lookup_set().
4563 * If name is not found in any of the expected locations and it is the
4564 * absolute path of an image file, this image will be used.
4566 * @note The icon image set by this function can be changed by
4567 * elm_icon_file_set().
4569 * @see elm_icon_standard_get()
4570 * @see elm_icon_file_set()
4574 EAPI Eina_Bool elm_icon_standard_set(Evas_Object *obj, const char *name) EINA_ARG_NONNULL(1);
4576 * Get the icon name set by icon standard names.
4578 * @param obj The icon object
4579 * @return The icon name
4581 * If the icon image was set using elm_icon_file_set() instead of
4582 * elm_icon_standard_set(), then this function will return @c NULL.
4584 * @see elm_icon_standard_set()
4588 EAPI const char *elm_icon_standard_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4590 * Set the smooth effect for an icon object.
4592 * @param obj The icon object
4593 * @param smooth @c EINA_TRUE if smooth scaling should be used, @c EINA_FALSE
4594 * otherwise. Default is @c EINA_TRUE.
4596 * Set the scaling algorithm to be used when scaling the icon image. Smooth
4597 * scaling provides a better resulting image, but is slower.
4599 * The smooth scaling should be disabled when making animations that change
4600 * the icon size, since they will be faster. Animations that don't require
4601 * resizing of the icon can keep the smooth scaling enabled (even if the icon
4602 * is already scaled, since the scaled icon image will be cached).
4604 * @see elm_icon_smooth_get()
4608 EAPI void elm_icon_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
4610 * Get the smooth effect for an icon object.
4612 * @param obj The icon object
4613 * @return @c EINA_TRUE if smooth scaling is enabled, @c EINA_FALSE otherwise.
4615 * @see elm_icon_smooth_set()
4619 EAPI Eina_Bool elm_icon_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4621 * Disable scaling of this object.
4623 * @param obj The icon object.
4624 * @param no_scale @c EINA_TRUE if the object is not scalable, @c EINA_FALSE
4625 * otherwise. Default is @c EINA_FALSE.
4627 * This function disables scaling of the icon object through the function
4628 * elm_object_scale_set(). However, this does not affect the object
4629 * size/resize in any way. For that effect, take a look at
4630 * elm_icon_scale_set().
4632 * @see elm_icon_no_scale_get()
4633 * @see elm_icon_scale_set()
4634 * @see elm_object_scale_set()
4638 EAPI void elm_icon_no_scale_set(Evas_Object *obj, Eina_Bool no_scale) EINA_ARG_NONNULL(1);
4640 * Get whether scaling is disabled on the object.
4642 * @param obj The icon object
4643 * @return @c EINA_TRUE if scaling is disabled, @c EINA_FALSE otherwise
4645 * @see elm_icon_no_scale_set()
4649 EAPI Eina_Bool elm_icon_no_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4651 * Set if the object is (up/down) resizable.
4653 * @param obj The icon object
4654 * @param scale_up A bool to set if the object is resizable up. Default is
4656 * @param scale_down A bool to set if the object is resizable down. Default
4659 * This function limits the icon object resize ability. If @p scale_up is set to
4660 * @c EINA_FALSE, the object can't have its height or width resized to a value
4661 * higher than the original icon size. Same is valid for @p scale_down.
4663 * @see elm_icon_scale_get()
4667 EAPI void elm_icon_scale_set(Evas_Object *obj, Eina_Bool scale_up, Eina_Bool scale_down) EINA_ARG_NONNULL(1);
4669 * Get if the object is (up/down) resizable.
4671 * @param obj The icon object
4672 * @param scale_up A bool to set if the object is resizable up
4673 * @param scale_down A bool to set if the object is resizable down
4675 * @see elm_icon_scale_set()
4679 EAPI void elm_icon_scale_get(const Evas_Object *obj, Eina_Bool *scale_up, Eina_Bool *scale_down) EINA_ARG_NONNULL(1);
4681 * Get the object's image size
4683 * @param obj The icon object
4684 * @param w A pointer to store the width in
4685 * @param h A pointer to store the height in
4689 EAPI void elm_icon_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
4691 * Set if the icon fill the entire object area.
4693 * @param obj The icon object
4694 * @param fill_outside @c EINA_TRUE if the object is filled outside,
4695 * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
4697 * When the icon object is resized to a different aspect ratio from the
4698 * original icon image, the icon image will still keep its aspect. This flag
4699 * tells how the image should fill the object's area. They are: keep the
4700 * entire icon inside the limits of height and width of the object (@p
4701 * fill_outside is @c EINA_FALSE) or let the extra width or height go outside
4702 * of the object, and the icon will fill the entire object (@p fill_outside
4705 * @note Unlike @ref Image, there's no option in icon to set the aspect ratio
4706 * retain property to false. Thus, the icon image will always keep its
4707 * original aspect ratio.
4709 * @see elm_icon_fill_outside_get()
4710 * @see elm_image_fill_outside_set()
4714 EAPI void elm_icon_fill_outside_set(Evas_Object *obj, Eina_Bool fill_outside) EINA_ARG_NONNULL(1);
4716 * Get if the object is filled outside.
4718 * @param obj The icon object
4719 * @return @c EINA_TRUE if the object is filled outside, @c EINA_FALSE otherwise.
4721 * @see elm_icon_fill_outside_set()
4725 EAPI Eina_Bool elm_icon_fill_outside_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4727 * Set the prescale size for the icon.
4729 * @param obj The icon object
4730 * @param size The prescale size. This value is used for both width and
4733 * This function sets a new size for pixmap representation of the given
4734 * icon. It allows the icon to be loaded already in the specified size,
4735 * reducing the memory usage and load time when loading a big icon with load
4736 * size set to a smaller size.
4738 * It's equivalent to the elm_bg_load_size_set() function for bg.
4740 * @note this is just a hint, the real size of the pixmap may differ
4741 * depending on the type of icon being loaded, being bigger than requested.
4743 * @see elm_icon_prescale_get()
4744 * @see elm_bg_load_size_set()
4748 EAPI void elm_icon_prescale_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
4750 * Get the prescale size for the icon.
4752 * @param obj The icon object
4753 * @return The prescale size
4755 * @see elm_icon_prescale_set()
4759 EAPI int elm_icon_prescale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4761 * Sets the icon lookup order used by elm_icon_standard_set().
4763 * @param obj The icon object
4764 * @param order The icon lookup order (can be one of
4765 * ELM_ICON_LOOKUP_FDO_THEME, ELM_ICON_LOOKUP_THEME_FDO, ELM_ICON_LOOKUP_FDO
4766 * or ELM_ICON_LOOKUP_THEME)
4768 * @see elm_icon_order_lookup_get()
4769 * @see Elm_Icon_Lookup_Order
4773 EAPI void elm_icon_order_lookup_set(Evas_Object *obj, Elm_Icon_Lookup_Order order) EINA_ARG_NONNULL(1);
4775 * Gets the icon lookup order.
4777 * @param obj The icon object
4778 * @return The icon lookup order
4780 * @see elm_icon_order_lookup_set()
4781 * @see Elm_Icon_Lookup_Order
4785 EAPI Elm_Icon_Lookup_Order elm_icon_order_lookup_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4787 * Get if the icon supports animation or not.
4789 * @param obj The icon object
4790 * @return @c EINA_TRUE if the icon supports animation,
4791 * @c EINA_FALSE otherwise.
4793 * Return if this elm icon's image can be animated. Currently Evas only
4794 * supports gif animation. If the return value is EINA_FALSE, other
4795 * elm_icon_animated_XXX APIs won't work.
4798 EAPI Eina_Bool elm_icon_animated_available_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4800 * Set animation mode of the icon.
4802 * @param obj The icon object
4803 * @param anim @c EINA_TRUE if the object do animation job,
4804 * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
4806 * Even though elm icon's file can be animated,
4807 * sometimes appication developer want to just first page of image.
4808 * In that time, don't call this function, because default value is EINA_FALSE
4809 * Only when you want icon support anition,
4810 * use this function and set animated to EINA_TURE
4813 EAPI void elm_icon_animated_set(Evas_Object *obj, Eina_Bool animated) EINA_ARG_NONNULL(1);
4815 * Get animation mode of the icon.
4817 * @param obj The icon object
4818 * @return The animation mode of the icon object
4819 * @see elm_icon_animated_set
4822 EAPI Eina_Bool elm_icon_animated_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4824 * Set animation play mode of the icon.
4826 * @param obj The icon object
4827 * @param play @c EINA_TRUE the object play animation images,
4828 * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
4830 * If you want to play elm icon's animation, you set play to EINA_TURE.
4831 * For example, you make gif player using this set/get API and click event.
4833 * 1. Click event occurs
4834 * 2. Check play flag using elm_icon_animaged_play_get
4835 * 3. If elm icon was playing, set play to EINA_FALSE.
4836 * Then animation will be stopped and vice versa
4839 EAPI void elm_icon_animated_play_set(Evas_Object *obj, Eina_Bool play) EINA_ARG_NONNULL(1);
4841 * Get animation play mode of the icon.
4843 * @param obj The icon object
4844 * @return The play mode of the icon object
4846 * @see elm_icon_animated_lay_get
4849 EAPI Eina_Bool elm_icon_animated_play_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4856 * @defgroup Image Image
4858 * @image html img/widget/image/preview-00.png
4859 * @image latex img/widget/image/preview-00.eps
4862 * An object that allows one to load an image file to it. It can be used
4863 * anywhere like any other elementary widget.
4865 * This widget provides most of the functionality provided from @ref Bg or @ref
4866 * Icon, but with a slightly different API (use the one that fits better your
4869 * The features not provided by those two other image widgets are:
4870 * @li allowing to get the basic @c Evas_Object with elm_image_object_get();
4871 * @li change the object orientation with elm_image_orient_set();
4872 * @li and turning the image editable with elm_image_editable_set().
4874 * Signals that you can add callbacks for are:
4876 * @li @c "clicked" - This is called when a user has clicked the image
4878 * An example of usage for this API follows:
4879 * @li @ref tutorial_image
4888 * @enum _Elm_Image_Orient
4889 * @typedef Elm_Image_Orient
4891 * Possible orientation options for elm_image_orient_set().
4893 * @image html elm_image_orient_set.png
4894 * @image latex elm_image_orient_set.eps width=\textwidth
4898 typedef enum _Elm_Image_Orient
4900 ELM_IMAGE_ORIENT_NONE, /**< no orientation change */
4901 ELM_IMAGE_ROTATE_90_CW, /**< rotate 90 degrees clockwise */
4902 ELM_IMAGE_ROTATE_180_CW, /**< rotate 180 degrees clockwise */
4903 ELM_IMAGE_ROTATE_90_CCW, /**< rotate 90 degrees counter-clockwise (i.e. 270 degrees clockwise) */
4904 ELM_IMAGE_FLIP_HORIZONTAL, /**< flip image horizontally */
4905 ELM_IMAGE_FLIP_VERTICAL, /**< flip image vertically */
4906 ELM_IMAGE_FLIP_TRANSPOSE, /**< flip the image along the y = (side - x) line*/
4907 ELM_IMAGE_FLIP_TRANSVERSE /**< flip the image along the y = x line */
4911 * Add a new image to the parent.
4913 * @param parent The parent object
4914 * @return The new object or NULL if it cannot be created
4916 * @see elm_image_file_set()
4920 EAPI Evas_Object *elm_image_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4922 * Set the file that will be used as image.
4924 * @param obj The image object
4925 * @param file The path to file that will be used as image
4926 * @param group The group that the image belongs in edje file (if it's an
4929 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
4931 * @see elm_image_file_get()
4935 EAPI Eina_Bool elm_image_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
4937 * Get the file that will be used as image.
4939 * @param obj The image object
4940 * @param file The path to file
4941 * @param group The group that the image belongs in edje file
4943 * @see elm_image_file_set()
4947 EAPI void elm_image_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
4949 * Set the smooth effect for an image.
4951 * @param obj The image object
4952 * @param smooth @c EINA_TRUE if smooth scaling should be used, @c EINA_FALSE
4953 * otherwise. Default is @c EINA_TRUE.
4955 * Set the scaling algorithm to be used when scaling the image. Smooth
4956 * scaling provides a better resulting image, but is slower.
4958 * The smooth scaling should be disabled when making animations that change
4959 * the image size, since it will be faster. Animations that don't require
4960 * resizing of the image can keep the smooth scaling enabled (even if the
4961 * image is already scaled, since the scaled image will be cached).
4963 * @see elm_image_smooth_get()
4967 EAPI void elm_image_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
4969 * Get the smooth effect for an image.
4971 * @param obj The image object
4972 * @return @c EINA_TRUE if smooth scaling is enabled, @c EINA_FALSE otherwise.
4974 * @see elm_image_smooth_get()
4978 EAPI Eina_Bool elm_image_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4980 * Gets the current size of the image.
4982 * @param obj The image object.
4983 * @param w Pointer to store width, or NULL.
4984 * @param h Pointer to store height, or NULL.
4986 * This is the real size of the image, not the size of the object.
4988 * On error, neither w or h will be written.
4992 EAPI void elm_image_object_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
4994 * Disable scaling of this object.
4996 * @param obj The image object.
4997 * @param no_scale @c EINA_TRUE if the object is not scalable, @c EINA_FALSE
4998 * otherwise. Default is @c EINA_FALSE.
5000 * This function disables scaling of the elm_image widget through the
5001 * function elm_object_scale_set(). However, this does not affect the widget
5002 * size/resize in any way. For that effect, take a look at
5003 * elm_image_scale_set().
5005 * @see elm_image_no_scale_get()
5006 * @see elm_image_scale_set()
5007 * @see elm_object_scale_set()
5011 EAPI void elm_image_no_scale_set(Evas_Object *obj, Eina_Bool no_scale) EINA_ARG_NONNULL(1);
5013 * Get whether scaling is disabled on the object.
5015 * @param obj The image object
5016 * @return @c EINA_TRUE if scaling is disabled, @c EINA_FALSE otherwise
5018 * @see elm_image_no_scale_set()
5022 EAPI Eina_Bool elm_image_no_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5024 * Set if the object is (up/down) resizable.
5026 * @param obj The image object
5027 * @param scale_up A bool to set if the object is resizable up. Default is
5029 * @param scale_down A bool to set if the object is resizable down. Default
5032 * This function limits the image resize ability. If @p scale_up is set to
5033 * @c EINA_FALSE, the object can't have its height or width resized to a value
5034 * higher than the original image size. Same is valid for @p scale_down.
5036 * @see elm_image_scale_get()
5040 EAPI void elm_image_scale_set(Evas_Object *obj, Eina_Bool scale_up, Eina_Bool scale_down) EINA_ARG_NONNULL(1);
5042 * Get if the object is (up/down) resizable.
5044 * @param obj The image object
5045 * @param scale_up A bool to set if the object is resizable up
5046 * @param scale_down A bool to set if the object is resizable down
5048 * @see elm_image_scale_set()
5052 EAPI void elm_image_scale_get(const Evas_Object *obj, Eina_Bool *scale_up, Eina_Bool *scale_down) EINA_ARG_NONNULL(1);
5054 * Set if the image fill the entire object area when keeping the aspect ratio.
5056 * @param obj The image object
5057 * @param fill_outside @c EINA_TRUE if the object is filled outside,
5058 * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
5060 * When the image should keep its aspect ratio even if resized to another
5061 * aspect ratio, there are two possibilities to resize it: keep the entire
5062 * image inside the limits of height and width of the object (@p fill_outside
5063 * is @c EINA_FALSE) or let the extra width or height go outside of the object,
5064 * and the image will fill the entire object (@p fill_outside is @c EINA_TRUE).
5066 * @note This option will have no effect if
5067 * elm_image_aspect_ratio_retained_set() is set to @c EINA_FALSE.
5069 * @see elm_image_fill_outside_get()
5070 * @see elm_image_aspect_ratio_retained_set()
5074 EAPI void elm_image_fill_outside_set(Evas_Object *obj, Eina_Bool fill_outside) EINA_ARG_NONNULL(1);
5076 * Get if the object is filled outside
5078 * @param obj The image object
5079 * @return @c EINA_TRUE if the object is filled outside, @c EINA_FALSE otherwise.
5081 * @see elm_image_fill_outside_set()
5085 EAPI Eina_Bool elm_image_fill_outside_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5087 * Set the prescale size for the image
5089 * @param obj The image object
5090 * @param size The prescale size. This value is used for both width and
5093 * This function sets a new size for pixmap representation of the given
5094 * image. It allows the image to be loaded already in the specified size,
5095 * reducing the memory usage and load time when loading a big image with load
5096 * size set to a smaller size.
5098 * It's equivalent to the elm_bg_load_size_set() function for bg.
5100 * @note this is just a hint, the real size of the pixmap may differ
5101 * depending on the type of image being loaded, being bigger than requested.
5103 * @see elm_image_prescale_get()
5104 * @see elm_bg_load_size_set()
5108 EAPI void elm_image_prescale_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
5110 * Get the prescale size for the image
5112 * @param obj The image object
5113 * @return The prescale size
5115 * @see elm_image_prescale_set()
5119 EAPI int elm_image_prescale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5121 * Set the image orientation.
5123 * @param obj The image object
5124 * @param orient The image orientation
5125 * (one of #ELM_IMAGE_ORIENT_NONE, #ELM_IMAGE_ROTATE_90_CW,
5126 * #ELM_IMAGE_ROTATE_180_CW, #ELM_IMAGE_ROTATE_90_CCW,
5127 * #ELM_IMAGE_FLIP_HORIZONTAL, #ELM_IMAGE_FLIP_VERTICAL,
5128 * #ELM_IMAGE_FLIP_TRANSPOSE, #ELM_IMAGE_FLIP_TRANSVERSE).
5129 * Default is #ELM_IMAGE_ORIENT_NONE.
5131 * This function allows to rotate or flip the given image.
5133 * @see elm_image_orient_get()
5134 * @see @ref Elm_Image_Orient
5138 EAPI void elm_image_orient_set(Evas_Object *obj, Elm_Image_Orient orient) EINA_ARG_NONNULL(1);
5140 * Get the image orientation.
5142 * @param obj The image object
5143 * @return The image orientation
5144 * (one of #ELM_IMAGE_ORIENT_NONE, #ELM_IMAGE_ROTATE_90_CW,
5145 * #ELM_IMAGE_ROTATE_180_CW, #ELM_IMAGE_ROTATE_90_CCW,
5146 * #ELM_IMAGE_FLIP_HORIZONTAL, #ELM_IMAGE_FLIP_VERTICAL,
5147 * #ELM_IMAGE_FLIP_TRANSPOSE, #ELM_IMAGE_FLIP_TRANSVERSE)
5149 * @see elm_image_orient_set()
5150 * @see @ref Elm_Image_Orient
5154 EAPI Elm_Image_Orient elm_image_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5156 * Make the image 'editable'.
5158 * @param obj Image object.
5159 * @param set Turn on or off editability. Default is @c EINA_FALSE.
5161 * This means the image is a valid drag target for drag and drop, and can be
5162 * cut or pasted too.
5166 EAPI void elm_image_editable_set(Evas_Object *obj, Eina_Bool set) EINA_ARG_NONNULL(1);
5168 * Make the image 'editable'.
5170 * @param obj Image object.
5171 * @return Editability.
5173 * This means the image is a valid drag target for drag and drop, and can be
5174 * cut or pasted too.
5178 EAPI Eina_Bool elm_image_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5180 * Get the basic Evas_Image object from this object (widget).
5182 * @param obj The image object to get the inlined image from
5183 * @return The inlined image object, or NULL if none exists
5185 * This function allows one to get the underlying @c Evas_Object of type
5186 * Image from this elementary widget. It can be useful to do things like get
5187 * the pixel data, save the image to a file, etc.
5189 * @note Be careful to not manipulate it, as it is under control of
5194 EAPI Evas_Object *elm_image_object_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5196 * Set whether the original aspect ratio of the image should be kept on resize.
5198 * @param obj The image object.
5199 * @param retained @c EINA_TRUE if the image should retain the aspect,
5200 * @c EINA_FALSE otherwise.
5202 * The original aspect ratio (width / height) of the image is usually
5203 * distorted to match the object's size. Enabling this option will retain
5204 * this original aspect, and the way that the image is fit into the object's
5205 * area depends on the option set by elm_image_fill_outside_set().
5207 * @see elm_image_aspect_ratio_retained_get()
5208 * @see elm_image_fill_outside_set()
5212 EAPI void elm_image_aspect_ratio_retained_set(Evas_Object *obj, Eina_Bool retained) EINA_ARG_NONNULL(1);
5214 * Get if the object retains the original aspect ratio.
5216 * @param obj The image object.
5217 * @return @c EINA_TRUE if the object keeps the original aspect, @c EINA_FALSE
5222 EAPI Eina_Bool elm_image_aspect_ratio_retained_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5224 /* smart callbacks called:
5225 * "clicked" - the user clicked the image
5233 typedef void (*Elm_GLView_Func_Cb)(Evas_Object *obj);
5235 typedef enum _Elm_GLView_Mode
5237 ELM_GLVIEW_ALPHA = 1,
5238 ELM_GLVIEW_DEPTH = 2,
5239 ELM_GLVIEW_STENCIL = 4
5243 * Defines a policy for the glview resizing.
5245 * @note Default is ELM_GLVIEW_RESIZE_POLICY_RECREATE
5247 typedef enum _Elm_GLView_Resize_Policy
5249 ELM_GLVIEW_RESIZE_POLICY_RECREATE = 1, /**< Resize the internal surface along with the image */
5250 ELM_GLVIEW_RESIZE_POLICY_SCALE = 2 /**< Only reize the internal image and not the surface */
5251 } Elm_GLView_Resize_Policy;
5253 typedef enum _Elm_GLView_Render_Policy
5255 ELM_GLVIEW_RENDER_POLICY_ON_DEMAND = 1, /**< Render only when there is a need for redrawing */
5256 ELM_GLVIEW_RENDER_POLICY_ALWAYS = 2 /**< Render always even when it is not visible */
5257 } Elm_GLView_Render_Policy;
5262 * A simple GLView widget that allows GL rendering.
5264 * Signals that you can add callbacks for are:
5270 * Add a new glview to the parent
5272 * @param parent The parent object
5273 * @return The new object or NULL if it cannot be created
5277 EAPI Evas_Object *elm_glview_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5280 * Sets the size of the glview
5282 * @param obj The glview object
5283 * @param width width of the glview object
5284 * @param height height of the glview object
5288 EAPI void elm_glview_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
5291 * Gets 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
5297 * Note that this function returns the actual image size of the
5298 * glview. This means that when the scale policy is set to
5299 * ELM_GLVIEW_RESIZE_POLICY_SCALE, it'll return the non-scaled
5304 EAPI void elm_glview_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
5307 * Gets the gl api struct for gl rendering
5309 * @param obj The glview object
5310 * @return The api object or NULL if it cannot be created
5314 EAPI Evas_GL_API *elm_glview_gl_api_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5317 * Set the mode of the GLView. Supports Three simple modes.
5319 * @param obj The glview object
5320 * @param mode The mode Options OR'ed enabling Alpha, Depth, Stencil.
5321 * @return True if set properly.
5325 EAPI Eina_Bool elm_glview_mode_set(Evas_Object *obj, Elm_GLView_Mode mode) EINA_ARG_NONNULL(1);
5328 * Set the resize policy for the glview object.
5330 * @param obj The glview object.
5331 * @param policy The scaling policy.
5333 * By default, the resize policy is set to
5334 * ELM_GLVIEW_RESIZE_POLICY_RECREATE. When resize is called it
5335 * destroys the previous surface and recreates the newly specified
5336 * size. If the policy is set to ELM_GLVIEW_RESIZE_POLICY_SCALE,
5337 * however, glview only scales the image object and not the underlying
5342 EAPI Eina_Bool elm_glview_resize_policy_set(Evas_Object *obj, Elm_GLView_Resize_Policy policy) EINA_ARG_NONNULL(1);
5345 * Set the render policy for the glview object.
5347 * @param obj The glview object.
5348 * @param policy The render policy.
5350 * By default, the render policy is set to
5351 * ELM_GLVIEW_RENDER_POLICY_ON_DEMAND. This policy is set such
5352 * that during the render loop, glview is only redrawn if it needs
5353 * to be redrawn. (i.e. When it is visible) If the policy is set to
5354 * ELM_GLVIEWW_RENDER_POLICY_ALWAYS, it redraws regardless of
5355 * whether it is visible/need redrawing or not.
5359 EAPI Eina_Bool elm_glview_render_policy_set(Evas_Object *obj, Elm_GLView_Render_Policy policy) EINA_ARG_NONNULL(1);
5362 * Set the init function that runs once in the main loop.
5364 * @param obj The glview object.
5365 * @param func The init function to be registered.
5367 * The registered init function gets called once during the render loop.
5371 EAPI void elm_glview_init_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
5374 * Set the render function that runs in the main loop.
5376 * @param obj The glview object.
5377 * @param func The delete function to be registered.
5379 * The registered del function gets called when GLView object is deleted.
5383 EAPI void elm_glview_del_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
5386 * Set the resize function that gets called when resize happens.
5388 * @param obj The glview object.
5389 * @param func The resize function to be registered.
5393 EAPI void elm_glview_resize_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
5396 * Set the render function that runs in the main loop.
5398 * @param obj The glview object.
5399 * @param func The render function to be registered.
5403 EAPI void elm_glview_render_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
5406 * Notifies that there has been changes in the GLView.
5408 * @param obj The glview object.
5412 EAPI void elm_glview_changed_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
5422 * @image html img/widget/box/preview-00.png
5423 * @image latex img/widget/box/preview-00.eps width=\textwidth
5425 * @image html img/box.png
5426 * @image latex img/box.eps width=\textwidth
5428 * A box arranges objects in a linear fashion, governed by a layout function
5429 * that defines the details of this arrangement.
5431 * By default, the box will use an internal function to set the layout to
5432 * a single row, either vertical or horizontal. This layout is affected
5433 * by a number of parameters, such as the homogeneous flag set by
5434 * elm_box_homogeneous_set(), the values given by elm_box_padding_set() and
5435 * elm_box_align_set() and the hints set to each object in the box.
5437 * For this default layout, it's possible to change the orientation with
5438 * elm_box_horizontal_set(). The box will start in the vertical orientation,
5439 * placing its elements ordered from top to bottom. When horizontal is set,
5440 * the order will go from left to right. If the box is set to be
5441 * homogeneous, every object in it will be assigned the same space, that
5442 * of the largest object. Padding can be used to set some spacing between
5443 * the cell given to each object. The alignment of the box, set with
5444 * elm_box_align_set(), determines how the bounding box of all the elements
5445 * will be placed within the space given to the box widget itself.
5447 * The size hints of each object also affect how they are placed and sized
5448 * within the box. evas_object_size_hint_min_set() will give the minimum
5449 * size the object can have, and the box will use it as the basis for all
5450 * latter calculations. Elementary widgets set their own minimum size as
5451 * needed, so there's rarely any need to use it manually.
5453 * evas_object_size_hint_weight_set(), when not in homogeneous mode, is
5454 * used to tell whether the object will be allocated the minimum size it
5455 * needs or if the space given to it should be expanded. It's important
5456 * to realize that expanding the size given to the object is not the same
5457 * thing as resizing the object. It could very well end being a small
5458 * widget floating in a much larger empty space. If not set, the weight
5459 * for objects will normally be 0.0 for both axis, meaning the widget will
5460 * not be expanded. To take as much space possible, set the weight to
5461 * EVAS_HINT_EXPAND (defined to 1.0) for the desired axis to expand.
5463 * Besides how much space each object is allocated, it's possible to control
5464 * how the widget will be placed within that space using
5465 * evas_object_size_hint_align_set(). By default, this value will be 0.5
5466 * for both axis, meaning the object will be centered, but any value from
5467 * 0.0 (left or top, for the @c x and @c y axis, respectively) to 1.0
5468 * (right or bottom) can be used. The special value EVAS_HINT_FILL, which
5469 * is -1.0, means the object will be resized to fill the entire space it
5472 * In addition, customized functions to define the layout can be set, which
5473 * allow the application developer to organize the objects within the box
5474 * in any number of ways.
5476 * The special elm_box_layout_transition() function can be used
5477 * to switch from one layout to another, animating the motion of the
5478 * children of the box.
5480 * @note Objects should not be added to box objects using _add() calls.
5482 * Some examples on how to use boxes follow:
5483 * @li @ref box_example_01
5484 * @li @ref box_example_02
5489 * @typedef Elm_Box_Transition
5491 * Opaque handler containing the parameters to perform an animated
5492 * transition of the layout the box uses.
5494 * @see elm_box_transition_new()
5495 * @see elm_box_layout_set()
5496 * @see elm_box_layout_transition()
5498 typedef struct _Elm_Box_Transition Elm_Box_Transition;
5501 * Add a new box to the parent
5503 * By default, the box will be in vertical mode and non-homogeneous.
5505 * @param parent The parent object
5506 * @return The new object or NULL if it cannot be created
5508 EAPI Evas_Object *elm_box_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5510 * Set the horizontal orientation
5512 * By default, box object arranges their contents vertically from top to
5514 * By calling this function with @p horizontal as EINA_TRUE, the box will
5515 * become horizontal, arranging contents from left to right.
5517 * @note This flag is ignored if a custom layout function is set.
5519 * @param obj The box object
5520 * @param horizontal The horizontal flag (EINA_TRUE = horizontal,
5521 * EINA_FALSE = vertical)
5523 EAPI void elm_box_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
5525 * Get the horizontal orientation
5527 * @param obj The box object
5528 * @return EINA_TRUE if the box is set to horizontal mode, EINA_FALSE otherwise
5530 EAPI Eina_Bool elm_box_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5532 * Set the box to arrange its children homogeneously
5534 * If enabled, homogeneous layout makes all items the same size, according
5535 * to the size of the largest of its children.
5537 * @note This flag is ignored if a custom layout function is set.
5539 * @param obj The box object
5540 * @param homogeneous The homogeneous flag
5542 EAPI void elm_box_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
5544 * Get whether the box is using homogeneous mode or not
5546 * @param obj The box object
5547 * @return EINA_TRUE if it's homogeneous, EINA_FALSE otherwise
5549 EAPI Eina_Bool elm_box_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5550 EINA_DEPRECATED EAPI void elm_box_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
5551 EINA_DEPRECATED EAPI Eina_Bool elm_box_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5553 * Add an object to the beginning of the pack list
5555 * Pack @p subobj into the box @p obj, placing it first in the list of
5556 * children objects. The actual position the object will get on screen
5557 * depends on the layout used. If no custom layout is set, it will be at
5558 * the top or left, depending if the box is vertical or horizontal,
5561 * @param obj The box object
5562 * @param subobj The object to add to the box
5564 * @see elm_box_pack_end()
5565 * @see elm_box_pack_before()
5566 * @see elm_box_pack_after()
5567 * @see elm_box_unpack()
5568 * @see elm_box_unpack_all()
5569 * @see elm_box_clear()
5571 EAPI void elm_box_pack_start(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
5573 * Add an object at the end of the pack list
5575 * Pack @p subobj into the box @p obj, placing it last in the list of
5576 * children objects. The actual position the object will get on screen
5577 * depends on the layout used. If no custom layout is set, it will be at
5578 * the bottom or right, depending if the box is vertical or horizontal,
5581 * @param obj The box object
5582 * @param subobj The object to add to the box
5584 * @see elm_box_pack_start()
5585 * @see elm_box_pack_before()
5586 * @see elm_box_pack_after()
5587 * @see elm_box_unpack()
5588 * @see elm_box_unpack_all()
5589 * @see elm_box_clear()
5591 EAPI void elm_box_pack_end(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
5593 * Adds an object to the box before the indicated object
5595 * This will add the @p subobj to the box indicated before the object
5596 * indicated with @p before. If @p before is not already in the box, results
5597 * are undefined. Before means either to the left of the indicated object or
5598 * above it depending on orientation.
5600 * @param obj The box object
5601 * @param subobj The object to add to the box
5602 * @param before The object before which to add it
5604 * @see elm_box_pack_start()
5605 * @see elm_box_pack_end()
5606 * @see elm_box_pack_after()
5607 * @see elm_box_unpack()
5608 * @see elm_box_unpack_all()
5609 * @see elm_box_clear()
5611 EAPI void elm_box_pack_before(Evas_Object *obj, Evas_Object *subobj, Evas_Object *before) EINA_ARG_NONNULL(1);
5613 * Adds an object to the box after the indicated object
5615 * This will add the @p subobj to the box indicated after the object
5616 * indicated with @p after. If @p after is not already in the box, results
5617 * are undefined. After means either to the right of the indicated object or
5618 * below it depending on orientation.
5620 * @param obj The box object
5621 * @param subobj The object to add to the box
5622 * @param after The object after which to add it
5624 * @see elm_box_pack_start()
5625 * @see elm_box_pack_end()
5626 * @see elm_box_pack_before()
5627 * @see elm_box_unpack()
5628 * @see elm_box_unpack_all()
5629 * @see elm_box_clear()
5631 EAPI void elm_box_pack_after(Evas_Object *obj, Evas_Object *subobj, Evas_Object *after) EINA_ARG_NONNULL(1);
5633 * Clear the box of all children
5635 * Remove all the elements contained by the box, deleting the respective
5638 * @param obj The box object
5640 * @see elm_box_unpack()
5641 * @see elm_box_unpack_all()
5643 EAPI void elm_box_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
5647 * Remove the object given by @p subobj from the box @p obj without
5650 * @param obj The box object
5652 * @see elm_box_unpack_all()
5653 * @see elm_box_clear()
5655 EAPI void elm_box_unpack(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
5657 * Remove all items from the box, without deleting them
5659 * Clear the box from all children, but don't delete the respective objects.
5660 * If no other references of the box children exist, the objects will never
5661 * be deleted, and thus the application will leak the memory. Make sure
5662 * when using this function that you hold a reference to all the objects
5663 * in the box @p obj.
5665 * @param obj The box object
5667 * @see elm_box_clear()
5668 * @see elm_box_unpack()
5670 EAPI void elm_box_unpack_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
5672 * Retrieve a list of the objects packed into the box
5674 * Returns a new @c Eina_List with a pointer to @c Evas_Object in its nodes.
5675 * The order of the list corresponds to the packing order the box uses.
5677 * You must free this list with eina_list_free() once you are done with it.
5679 * @param obj The box object
5681 EAPI const Eina_List *elm_box_children_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5683 * Set the space (padding) between the box's elements.
5685 * Extra space in pixels that will be added between a box child and its
5686 * neighbors after its containing cell has been calculated. This padding
5687 * is set for all elements in the box, besides any possible padding that
5688 * individual elements may have through their size hints.
5690 * @param obj The box object
5691 * @param horizontal The horizontal space between elements
5692 * @param vertical The vertical space between elements
5694 EAPI void elm_box_padding_set(Evas_Object *obj, Evas_Coord horizontal, Evas_Coord vertical) EINA_ARG_NONNULL(1);
5696 * Get the space (padding) between the box's elements.
5698 * @param obj The box object
5699 * @param horizontal The horizontal space between elements
5700 * @param vertical The vertical space between elements
5702 * @see elm_box_padding_set()
5704 EAPI void elm_box_padding_get(const Evas_Object *obj, Evas_Coord *horizontal, Evas_Coord *vertical) EINA_ARG_NONNULL(1);
5706 * Set the alignment of the whole bouding box of contents.
5708 * Sets how the bounding box containing all the elements of the box, after
5709 * their sizes and position has been calculated, will be aligned within
5710 * the space given for the whole box widget.
5712 * @param obj The box object
5713 * @param horizontal The horizontal alignment of elements
5714 * @param vertical The vertical alignment of elements
5716 EAPI void elm_box_align_set(Evas_Object *obj, double horizontal, double vertical) EINA_ARG_NONNULL(1);
5718 * Get the alignment of the whole bouding box of contents.
5720 * @param obj The box object
5721 * @param horizontal The horizontal alignment of elements
5722 * @param vertical The vertical alignment of elements
5724 * @see elm_box_align_set()
5726 EAPI void elm_box_align_get(const Evas_Object *obj, double *horizontal, double *vertical) EINA_ARG_NONNULL(1);
5729 * Set the layout defining function to be used by the box
5731 * Whenever anything changes that requires the box in @p obj to recalculate
5732 * the size and position of its elements, the function @p cb will be called
5733 * to determine what the layout of the children will be.
5735 * Once a custom function is set, everything about the children layout
5736 * is defined by it. The flags set by elm_box_horizontal_set() and
5737 * elm_box_homogeneous_set() no longer have any meaning, and the values
5738 * given by elm_box_padding_set() and elm_box_align_set() are up to this
5739 * layout function to decide if they are used and how. These last two
5740 * will be found in the @c priv parameter, of type @c Evas_Object_Box_Data,
5741 * passed to @p cb. The @c Evas_Object the function receives is not the
5742 * Elementary widget, but the internal Evas Box it uses, so none of the
5743 * functions described here can be used on it.
5745 * Any of the layout functions in @c Evas can be used here, as well as the
5746 * special elm_box_layout_transition().
5748 * The final @p data argument received by @p cb is the same @p data passed
5749 * here, and the @p free_data function will be called to free it
5750 * whenever the box is destroyed or another layout function is set.
5752 * Setting @p cb to NULL will revert back to the default layout function.
5754 * @param obj The box object
5755 * @param cb The callback function used for layout
5756 * @param data Data that will be passed to layout function
5757 * @param free_data Function called to free @p data
5759 * @see elm_box_layout_transition()
5761 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);
5763 * Special layout function that animates the transition from one layout to another
5765 * Normally, when switching the layout function for a box, this will be
5766 * reflected immediately on screen on the next render, but it's also
5767 * possible to do this through an animated transition.
5769 * This is done by creating an ::Elm_Box_Transition and setting the box
5770 * layout to this function.
5774 * Elm_Box_Transition *t = elm_box_transition_new(1.0,
5775 * evas_object_box_layout_vertical, // start
5776 * NULL, // data for initial layout
5777 * NULL, // free function for initial data
5778 * evas_object_box_layout_horizontal, // end
5779 * NULL, // data for final layout
5780 * NULL, // free function for final data
5781 * anim_end, // will be called when animation ends
5782 * NULL); // data for anim_end function\
5783 * elm_box_layout_set(box, elm_box_layout_transition, t,
5784 * elm_box_transition_free);
5787 * @note This function can only be used with elm_box_layout_set(). Calling
5788 * it directly will not have the expected results.
5790 * @see elm_box_transition_new
5791 * @see elm_box_transition_free
5792 * @see elm_box_layout_set
5794 EAPI void elm_box_layout_transition(Evas_Object *obj, Evas_Object_Box_Data *priv, void *data);
5796 * Create a new ::Elm_Box_Transition to animate the switch of layouts
5798 * If you want to animate the change from one layout to another, you need
5799 * to set the layout function of the box to elm_box_layout_transition(),
5800 * passing as user data to it an instance of ::Elm_Box_Transition with the
5801 * necessary information to perform this animation. The free function to
5802 * set for the layout is elm_box_transition_free().
5804 * The parameters to create an ::Elm_Box_Transition sum up to how long
5805 * will it be, in seconds, a layout function to describe the initial point,
5806 * another for the final position of the children and one function to be
5807 * called when the whole animation ends. This last function is useful to
5808 * set the definitive layout for the box, usually the same as the end
5809 * layout for the animation, but could be used to start another transition.
5811 * @param start_layout The layout function that will be used to start the animation
5812 * @param start_layout_data The data to be passed the @p start_layout function
5813 * @param start_layout_free_data Function to free @p start_layout_data
5814 * @param end_layout The layout function that will be used to end the animation
5815 * @param end_layout_free_data The data to be passed the @p end_layout function
5816 * @param end_layout_free_data Function to free @p end_layout_data
5817 * @param transition_end_cb Callback function called when animation ends
5818 * @param transition_end_data Data to be passed to @p transition_end_cb
5819 * @return An instance of ::Elm_Box_Transition
5821 * @see elm_box_transition_new
5822 * @see elm_box_layout_transition
5824 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);
5826 * Free a Elm_Box_Transition instance created with elm_box_transition_new().
5828 * This function is mostly useful as the @c free_data parameter in
5829 * elm_box_layout_set() when elm_box_layout_transition().
5831 * @param data The Elm_Box_Transition instance to be freed.
5833 * @see elm_box_transition_new
5834 * @see elm_box_layout_transition
5836 EAPI void elm_box_transition_free(void *data);
5843 * @defgroup Button Button
5845 * @image html img/widget/button/preview-00.png
5846 * @image latex img/widget/button/preview-00.eps
5847 * @image html img/widget/button/preview-01.png
5848 * @image latex img/widget/button/preview-01.eps
5849 * @image html img/widget/button/preview-02.png
5850 * @image latex img/widget/button/preview-02.eps
5852 * This is a push-button. Press it and run some function. It can contain
5853 * a simple label and icon object and it also has an autorepeat feature.
5855 * This widgets emits the following signals:
5856 * @li "clicked": the user clicked the button (press/release).
5857 * @li "repeated": the user pressed the button without releasing it.
5858 * @li "pressed": button was pressed.
5859 * @li "unpressed": button was released after being pressed.
5860 * In all three cases, the @c event parameter of the callback will be
5863 * Also, defined in the default theme, the button has the following styles
5865 * @li default: a normal button.
5866 * @li anchor: Like default, but the button fades away when the mouse is not
5867 * over it, leaving only the text or icon.
5868 * @li hoversel_vertical: Internally used by @ref Hoversel to give a
5869 * continuous look across its options.
5870 * @li hoversel_vertical_entry: Another internal for @ref Hoversel.
5872 * Follow through a complete example @ref button_example_01 "here".
5876 * Add a new button to the parent's canvas
5878 * @param parent The parent object
5879 * @return The new object or NULL if it cannot be created
5881 EAPI Evas_Object *elm_button_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5883 * Set the label used in the button
5885 * The passed @p label can be NULL to clean any existing text in it and
5886 * leave the button as an icon only object.
5888 * @param obj The button object
5889 * @param label The text will be written on the button
5890 * @deprecated use elm_object_text_set() instead.
5892 EINA_DEPRECATED EAPI void elm_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
5894 * Get the label set for the button
5896 * The string returned is an internal pointer and should not be freed or
5897 * altered. It will also become invalid when the button is destroyed.
5898 * The string returned, if not NULL, is a stringshare, so if you need to
5899 * keep it around even after the button is destroyed, you can use
5900 * eina_stringshare_ref().
5902 * @param obj The button object
5903 * @return The text set to the label, or NULL if nothing is set
5904 * @deprecated use elm_object_text_set() instead.
5906 EINA_DEPRECATED EAPI const char *elm_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5908 * Set the icon used for the button
5910 * Setting a new icon will delete any other that was previously set, making
5911 * any reference to them invalid. If you need to maintain the previous
5912 * object alive, unset it first with elm_button_icon_unset().
5914 * @param obj The button object
5915 * @param icon The icon object for the button
5917 EAPI void elm_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
5919 * Get the icon used for the button
5921 * Return the icon object which is set for this widget. If the button is
5922 * destroyed or another icon is set, the returned object will be deleted
5923 * and any reference to it will be invalid.
5925 * @param obj The button object
5926 * @return The icon object that is being used
5928 * @see elm_button_icon_unset()
5930 EAPI Evas_Object *elm_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5932 * Remove the icon set without deleting it and return the object
5934 * This function drops the reference the button holds of the icon object
5935 * and returns this last object. It is used in case you want to remove any
5936 * icon, or set another one, without deleting the actual object. The button
5937 * will be left without an icon set.
5939 * @param obj The button object
5940 * @return The icon object that was being used
5942 EAPI Evas_Object *elm_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
5944 * Turn on/off the autorepeat event generated when the button is kept pressed
5946 * When off, no autorepeat is performed and buttons emit a normal @c clicked
5947 * signal when they are clicked.
5949 * When on, keeping a button pressed will continuously emit a @c repeated
5950 * signal until the button is released. The time it takes until it starts
5951 * emitting the signal is given by
5952 * elm_button_autorepeat_initial_timeout_set(), and the time between each
5953 * new emission by elm_button_autorepeat_gap_timeout_set().
5955 * @param obj The button object
5956 * @param on A bool to turn on/off the event
5958 EAPI void elm_button_autorepeat_set(Evas_Object *obj, Eina_Bool on) EINA_ARG_NONNULL(1);
5960 * Get whether the autorepeat feature is enabled
5962 * @param obj The button object
5963 * @return EINA_TRUE if autorepeat is on, EINA_FALSE otherwise
5965 * @see elm_button_autorepeat_set()
5967 EAPI Eina_Bool elm_button_autorepeat_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5969 * Set the initial timeout before the autorepeat event is generated
5971 * Sets the timeout, in seconds, since the button is pressed until the
5972 * first @c repeated signal is emitted. If @p t is 0.0 or less, there
5973 * won't be any delay and the even will be fired the moment the button is
5976 * @param obj The button object
5977 * @param t Timeout in seconds
5979 * @see elm_button_autorepeat_set()
5980 * @see elm_button_autorepeat_gap_timeout_set()
5982 EAPI void elm_button_autorepeat_initial_timeout_set(Evas_Object *obj, double t) EINA_ARG_NONNULL(1);
5984 * Get the initial timeout before the autorepeat event is generated
5986 * @param obj The button object
5987 * @return Timeout in seconds
5989 * @see elm_button_autorepeat_initial_timeout_set()
5991 EAPI double elm_button_autorepeat_initial_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5993 * Set the interval between each generated autorepeat event
5995 * After the first @c repeated event is fired, all subsequent ones will
5996 * follow after a delay of @p t seconds for each.
5998 * @param obj The button object
5999 * @param t Interval in seconds
6001 * @see elm_button_autorepeat_initial_timeout_set()
6003 EAPI void elm_button_autorepeat_gap_timeout_set(Evas_Object *obj, double t) EINA_ARG_NONNULL(1);
6005 * Get the interval between each generated autorepeat event
6007 * @param obj The button object
6008 * @return Interval in seconds
6010 EAPI double elm_button_autorepeat_gap_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6016 * @defgroup File_Selector_Button File Selector Button
6018 * @image html img/widget/fileselector_button/preview-00.png
6019 * @image latex img/widget/fileselector_button/preview-00.eps
6020 * @image html img/widget/fileselector_button/preview-01.png
6021 * @image latex img/widget/fileselector_button/preview-01.eps
6022 * @image html img/widget/fileselector_button/preview-02.png
6023 * @image latex img/widget/fileselector_button/preview-02.eps
6025 * This is a button that, when clicked, creates an Elementary
6026 * window (or inner window) <b> with a @ref Fileselector "file
6027 * selector widget" within</b>. When a file is chosen, the (inner)
6028 * window is closed and the button emits a signal having the
6029 * selected file as it's @c event_info.
6031 * This widget encapsulates operations on its internal file
6032 * selector on its own API. There is less control over its file
6033 * selector than that one would have instatiating one directly.
6035 * The following styles are available for this button:
6038 * @li @c "hoversel_vertical"
6039 * @li @c "hoversel_vertical_entry"
6041 * Smart callbacks one can register to:
6042 * - @c "file,chosen" - the user has selected a path, whose string
6043 * pointer comes as the @c event_info data (a stringshared
6046 * Here is an example on its usage:
6047 * @li @ref fileselector_button_example
6049 * @see @ref File_Selector_Entry for a similar widget.
6054 * Add a new file selector button widget to the given parent
6055 * Elementary (container) object
6057 * @param parent The parent object
6058 * @return a new file selector button widget handle or @c NULL, on
6061 EAPI Evas_Object *elm_fileselector_button_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6064 * Set the label for a given file selector button widget
6066 * @param obj The file selector button widget
6067 * @param label The text label to be displayed on @p obj
6069 * @deprecated use elm_object_text_set() instead.
6071 EINA_DEPRECATED EAPI void elm_fileselector_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
6074 * Get the label set for a given file selector button widget
6076 * @param obj The file selector button widget
6077 * @return The button label
6079 * @deprecated use elm_object_text_set() instead.
6081 EINA_DEPRECATED EAPI const char *elm_fileselector_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6084 * Set the icon on a given file selector button widget
6086 * @param obj The file selector button widget
6087 * @param icon The icon object for the button
6089 * Once the icon object is set, a previously set one will be
6090 * deleted. If you want to keep the latter, use the
6091 * elm_fileselector_button_icon_unset() function.
6093 * @see elm_fileselector_button_icon_get()
6095 EAPI void elm_fileselector_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
6098 * Get the icon set for a given file selector button widget
6100 * @param obj The file selector button widget
6101 * @return The icon object currently set on @p obj or @c NULL, if
6104 * @see elm_fileselector_button_icon_set()
6106 EAPI Evas_Object *elm_fileselector_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6109 * Unset the icon used in a given file selector button widget
6111 * @param obj The file selector button widget
6112 * @return The icon object that was being used on @p obj or @c
6115 * Unparent and return the icon object which was set for this
6118 * @see elm_fileselector_button_icon_set()
6120 EAPI Evas_Object *elm_fileselector_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6123 * Set the title for a given file selector button widget's window
6125 * @param obj The file selector button widget
6126 * @param title The title string
6128 * This will change the window's title, when the file selector pops
6129 * out after a click on the button. Those windows have the default
6130 * (unlocalized) value of @c "Select a file" as titles.
6132 * @note It will only take any effect if the file selector
6133 * button widget is @b not under "inwin mode".
6135 * @see elm_fileselector_button_window_title_get()
6137 EAPI void elm_fileselector_button_window_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
6140 * Get the title set for a given file selector button widget's
6143 * @param obj The file selector button widget
6144 * @return Title of the file selector button's window
6146 * @see elm_fileselector_button_window_title_get() for more details
6148 EAPI const char *elm_fileselector_button_window_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6151 * Set the size of a given file selector button widget's window,
6152 * holding the file selector itself.
6154 * @param obj The file selector button widget
6155 * @param width The window's width
6156 * @param height The window's height
6158 * @note it will only take any effect if the file selector button
6159 * widget is @b not under "inwin mode". The default size for the
6160 * window (when applicable) is 400x400 pixels.
6162 * @see elm_fileselector_button_window_size_get()
6164 EAPI void elm_fileselector_button_window_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
6167 * Get the size of a given file selector button widget's window,
6168 * holding the file selector itself.
6170 * @param obj The file selector button widget
6171 * @param width Pointer into which to store the width value
6172 * @param height Pointer into which to store the height value
6174 * @note Use @c NULL pointers on the size values you're not
6175 * interested in: they'll be ignored by the function.
6177 * @see elm_fileselector_button_window_size_set(), for more details
6179 EAPI void elm_fileselector_button_window_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
6182 * Set the initial file system path for a given file selector
6185 * @param obj The file selector button widget
6186 * @param path The path string
6188 * It must be a <b>directory</b> path, which will have the contents
6189 * displayed initially in the file selector's view, when invoked
6190 * from @p obj. The default initial path is the @c "HOME"
6191 * environment variable's value.
6193 * @see elm_fileselector_button_path_get()
6195 EAPI void elm_fileselector_button_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
6198 * Get the initial file system path set for a given file selector
6201 * @param obj The file selector button widget
6202 * @return path The path string
6204 * @see elm_fileselector_button_path_set() for more details
6206 EAPI const char *elm_fileselector_button_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6209 * Enable/disable a tree view in the given file selector button
6210 * widget's internal file selector
6212 * @param obj The file selector button widget
6213 * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
6216 * This has the same effect as elm_fileselector_expandable_set(),
6217 * but now applied to a file selector button's internal file
6220 * @note There's no way to put a file selector button's internal
6221 * file selector in "grid mode", as one may do with "pure" file
6224 * @see elm_fileselector_expandable_get()
6226 EAPI void elm_fileselector_button_expandable_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6229 * Get whether tree view is enabled for the given file selector
6230 * button widget's internal file selector
6232 * @param obj The file selector button widget
6233 * @return @c EINA_TRUE if @p obj widget's internal file selector
6234 * is in tree view, @c EINA_FALSE otherwise (and or errors)
6236 * @see elm_fileselector_expandable_set() for more details
6238 EAPI Eina_Bool elm_fileselector_button_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6241 * Set whether a given file selector button widget's internal file
6242 * selector is to display folders only or the directory contents,
6245 * @param obj The file selector button widget
6246 * @param only @c EINA_TRUE to make @p obj widget's internal file
6247 * selector only display directories, @c EINA_FALSE to make files
6248 * to be displayed in it too
6250 * This has the same effect as elm_fileselector_folder_only_set(),
6251 * but now applied to a file selector button's internal file
6254 * @see elm_fileselector_folder_only_get()
6256 EAPI void elm_fileselector_button_folder_only_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6259 * Get whether a given file selector button widget's internal file
6260 * selector is displaying folders only or the directory contents,
6263 * @param obj The file selector button widget
6264 * @return @c EINA_TRUE if @p obj widget's internal file
6265 * selector is only displaying directories, @c EINA_FALSE if files
6266 * are being displayed in it too (and on errors)
6268 * @see elm_fileselector_button_folder_only_set() for more details
6270 EAPI Eina_Bool elm_fileselector_button_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6273 * Enable/disable the file name entry box where the user can type
6274 * in a name for a file, in a given file selector button widget's
6275 * internal file selector.
6277 * @param obj The file selector button widget
6278 * @param is_save @c EINA_TRUE to make @p obj widget's internal
6279 * file selector a "saving dialog", @c EINA_FALSE otherwise
6281 * This has the same effect as elm_fileselector_is_save_set(),
6282 * but now applied to a file selector button's internal file
6285 * @see elm_fileselector_is_save_get()
6287 EAPI void elm_fileselector_button_is_save_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6290 * Get whether the given file selector button widget's internal
6291 * file selector is in "saving dialog" mode
6293 * @param obj The file selector button widget
6294 * @return @c EINA_TRUE, if @p obj widget's internal file selector
6295 * is in "saving dialog" mode, @c EINA_FALSE otherwise (and on
6298 * @see elm_fileselector_button_is_save_set() for more details
6300 EAPI Eina_Bool elm_fileselector_button_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6303 * Set whether a given file selector button widget's internal file
6304 * selector will raise an Elementary "inner window", instead of a
6305 * dedicated Elementary window. By default, it won't.
6307 * @param obj The file selector button widget
6308 * @param value @c EINA_TRUE to make it use an inner window, @c
6309 * EINA_TRUE to make it use a dedicated window
6311 * @see elm_win_inwin_add() for more information on inner windows
6312 * @see elm_fileselector_button_inwin_mode_get()
6314 EAPI void elm_fileselector_button_inwin_mode_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6317 * Get whether a given file selector button widget's internal file
6318 * selector will raise an Elementary "inner window", instead of a
6319 * dedicated Elementary window.
6321 * @param obj The file selector button widget
6322 * @return @c EINA_TRUE if will use an inner window, @c EINA_TRUE
6323 * if it will use a dedicated window
6325 * @see elm_fileselector_button_inwin_mode_set() for more details
6327 EAPI Eina_Bool elm_fileselector_button_inwin_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6334 * @defgroup File_Selector_Entry File Selector Entry
6336 * @image html img/widget/fileselector_entry/preview-00.png
6337 * @image latex img/widget/fileselector_entry/preview-00.eps
6339 * This is an entry made to be filled with or display a <b>file
6340 * system path string</b>. Besides the entry itself, the widget has
6341 * a @ref File_Selector_Button "file selector button" on its side,
6342 * which will raise an internal @ref Fileselector "file selector widget",
6343 * when clicked, for path selection aided by file system
6346 * This file selector may appear in an Elementary window or in an
6347 * inner window. When a file is chosen from it, the (inner) window
6348 * is closed and the selected file's path string is exposed both as
6349 * an smart event and as the new text on the entry.
6351 * This widget encapsulates operations on its internal file
6352 * selector on its own API. There is less control over its file
6353 * selector than that one would have instatiating one directly.
6355 * Smart callbacks one can register to:
6356 * - @c "changed" - The text within the entry was changed
6357 * - @c "activated" - The entry has had editing finished and
6358 * changes are to be "committed"
6359 * - @c "press" - The entry has been clicked
6360 * - @c "longpressed" - The entry has been clicked (and held) for a
6362 * - @c "clicked" - The entry has been clicked
6363 * - @c "clicked,double" - The entry has been double clicked
6364 * - @c "focused" - The entry has received focus
6365 * - @c "unfocused" - The entry has lost focus
6366 * - @c "selection,paste" - A paste action has occurred on the
6368 * - @c "selection,copy" - A copy action has occurred on the entry
6369 * - @c "selection,cut" - A cut action has occurred on the entry
6370 * - @c "unpressed" - The file selector entry's button was released
6371 * after being pressed.
6372 * - @c "file,chosen" - The user has selected a path via the file
6373 * selector entry's internal file selector, whose string pointer
6374 * comes as the @c event_info data (a stringshared string)
6376 * Here is an example on its usage:
6377 * @li @ref fileselector_entry_example
6379 * @see @ref File_Selector_Button for a similar widget.
6384 * Add a new file selector entry widget to the given parent
6385 * Elementary (container) object
6387 * @param parent The parent object
6388 * @return a new file selector entry widget handle or @c NULL, on
6391 EAPI Evas_Object *elm_fileselector_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6394 * Set the label for a given file selector entry widget's button
6396 * @param obj The file selector entry widget
6397 * @param label The text label to be displayed on @p obj widget's
6400 * @deprecated use elm_object_text_set() instead.
6402 EINA_DEPRECATED EAPI void elm_fileselector_entry_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
6405 * Get the label set for a given file selector entry widget's button
6407 * @param obj The file selector entry widget
6408 * @return The widget button's label
6410 * @deprecated use elm_object_text_set() instead.
6412 EINA_DEPRECATED EAPI const char *elm_fileselector_entry_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6415 * Set the icon on a given file selector entry widget's button
6417 * @param obj The file selector entry widget
6418 * @param icon The icon object for the entry's button
6420 * Once the icon object is set, a previously set one will be
6421 * deleted. If you want to keep the latter, use the
6422 * elm_fileselector_entry_button_icon_unset() function.
6424 * @see elm_fileselector_entry_button_icon_get()
6426 EAPI void elm_fileselector_entry_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
6429 * Get the icon set for a given file selector entry widget's button
6431 * @param obj The file selector entry widget
6432 * @return The icon object currently set on @p obj widget's button
6433 * or @c NULL, if none is
6435 * @see elm_fileselector_entry_button_icon_set()
6437 EAPI Evas_Object *elm_fileselector_entry_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6440 * Unset the icon used in a given file selector entry widget's
6443 * @param obj The file selector entry widget
6444 * @return The icon object that was being used on @p obj widget's
6445 * button or @c NULL, on errors
6447 * Unparent and return the icon object which was set for this
6450 * @see elm_fileselector_entry_button_icon_set()
6452 EAPI Evas_Object *elm_fileselector_entry_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6455 * Set the title for a given file selector entry widget's window
6457 * @param obj The file selector entry widget
6458 * @param title The title string
6460 * This will change the window's title, when the file selector pops
6461 * out after a click on the entry's button. Those windows have the
6462 * default (unlocalized) value of @c "Select a file" as titles.
6464 * @note It will only take any effect if the file selector
6465 * entry widget is @b not under "inwin mode".
6467 * @see elm_fileselector_entry_window_title_get()
6469 EAPI void elm_fileselector_entry_window_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
6472 * Get the title set for a given file selector entry widget's
6475 * @param obj The file selector entry widget
6476 * @return Title of the file selector entry's window
6478 * @see elm_fileselector_entry_window_title_get() for more details
6480 EAPI const char *elm_fileselector_entry_window_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6483 * Set the size of a given file selector entry widget's window,
6484 * holding the file selector itself.
6486 * @param obj The file selector entry widget
6487 * @param width The window's width
6488 * @param height The window's height
6490 * @note it will only take any effect if the file selector entry
6491 * widget is @b not under "inwin mode". The default size for the
6492 * window (when applicable) is 400x400 pixels.
6494 * @see elm_fileselector_entry_window_size_get()
6496 EAPI void elm_fileselector_entry_window_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
6499 * Get the size of a given file selector entry widget's window,
6500 * holding the file selector itself.
6502 * @param obj The file selector entry widget
6503 * @param width Pointer into which to store the width value
6504 * @param height Pointer into which to store the height value
6506 * @note Use @c NULL pointers on the size values you're not
6507 * interested in: they'll be ignored by the function.
6509 * @see elm_fileselector_entry_window_size_set(), for more details
6511 EAPI void elm_fileselector_entry_window_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
6514 * Set the initial file system path and the entry's path string for
6515 * a given file selector entry widget
6517 * @param obj The file selector entry widget
6518 * @param path The path string
6520 * It must be a <b>directory</b> path, which will have the contents
6521 * displayed initially in the file selector's view, when invoked
6522 * from @p obj. The default initial path is the @c "HOME"
6523 * environment variable's value.
6525 * @see elm_fileselector_entry_path_get()
6527 EAPI void elm_fileselector_entry_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
6530 * Get the entry's path string for a given file selector entry
6533 * @param obj The file selector entry widget
6534 * @return path The path string
6536 * @see elm_fileselector_entry_path_set() for more details
6538 EAPI const char *elm_fileselector_entry_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6541 * Enable/disable a tree view in the given file selector entry
6542 * widget's internal file selector
6544 * @param obj The file selector entry widget
6545 * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
6548 * This has the same effect as elm_fileselector_expandable_set(),
6549 * but now applied to a file selector entry's internal file
6552 * @note There's no way to put a file selector entry's internal
6553 * file selector in "grid mode", as one may do with "pure" file
6556 * @see elm_fileselector_expandable_get()
6558 EAPI void elm_fileselector_entry_expandable_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6561 * Get whether tree view is enabled for the given file selector
6562 * entry widget's internal file selector
6564 * @param obj The file selector entry widget
6565 * @return @c EINA_TRUE if @p obj widget's internal file selector
6566 * is in tree view, @c EINA_FALSE otherwise (and or errors)
6568 * @see elm_fileselector_expandable_set() for more details
6570 EAPI Eina_Bool elm_fileselector_entry_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6573 * Set whether a given file selector entry widget's internal file
6574 * selector is to display folders only or the directory contents,
6577 * @param obj The file selector entry widget
6578 * @param only @c EINA_TRUE to make @p obj widget's internal file
6579 * selector only display directories, @c EINA_FALSE to make files
6580 * to be displayed in it too
6582 * This has the same effect as elm_fileselector_folder_only_set(),
6583 * but now applied to a file selector entry's internal file
6586 * @see elm_fileselector_folder_only_get()
6588 EAPI void elm_fileselector_entry_folder_only_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6591 * Get whether a given file selector entry widget's internal file
6592 * selector is displaying folders only or the directory contents,
6595 * @param obj The file selector entry widget
6596 * @return @c EINA_TRUE if @p obj widget's internal file
6597 * selector is only displaying directories, @c EINA_FALSE if files
6598 * are being displayed in it too (and on errors)
6600 * @see elm_fileselector_entry_folder_only_set() for more details
6602 EAPI Eina_Bool elm_fileselector_entry_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6605 * Enable/disable the file name entry box where the user can type
6606 * in a name for a file, in a given file selector entry widget's
6607 * internal file selector.
6609 * @param obj The file selector entry widget
6610 * @param is_save @c EINA_TRUE to make @p obj widget's internal
6611 * file selector a "saving dialog", @c EINA_FALSE otherwise
6613 * This has the same effect as elm_fileselector_is_save_set(),
6614 * but now applied to a file selector entry's internal file
6617 * @see elm_fileselector_is_save_get()
6619 EAPI void elm_fileselector_entry_is_save_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6622 * Get whether the given file selector entry widget's internal
6623 * file selector is in "saving dialog" mode
6625 * @param obj The file selector entry widget
6626 * @return @c EINA_TRUE, if @p obj widget's internal file selector
6627 * is in "saving dialog" mode, @c EINA_FALSE otherwise (and on
6630 * @see elm_fileselector_entry_is_save_set() for more details
6632 EAPI Eina_Bool elm_fileselector_entry_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6635 * Set whether a given file selector entry widget's internal file
6636 * selector will raise an Elementary "inner window", instead of a
6637 * dedicated Elementary window. By default, it won't.
6639 * @param obj The file selector entry widget
6640 * @param value @c EINA_TRUE to make it use an inner window, @c
6641 * EINA_TRUE to make it use a dedicated window
6643 * @see elm_win_inwin_add() for more information on inner windows
6644 * @see elm_fileselector_entry_inwin_mode_get()
6646 EAPI void elm_fileselector_entry_inwin_mode_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6649 * Get whether a given file selector entry widget's internal file
6650 * selector will raise an Elementary "inner window", instead of a
6651 * dedicated Elementary window.
6653 * @param obj The file selector entry widget
6654 * @return @c EINA_TRUE if will use an inner window, @c EINA_TRUE
6655 * if it will use a dedicated window
6657 * @see elm_fileselector_entry_inwin_mode_set() for more details
6659 EAPI Eina_Bool elm_fileselector_entry_inwin_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6662 * Set the initial file system path for a given file selector entry
6665 * @param obj The file selector entry widget
6666 * @param path The path string
6668 * It must be a <b>directory</b> path, which will have the contents
6669 * displayed initially in the file selector's view, when invoked
6670 * from @p obj. The default initial path is the @c "HOME"
6671 * environment variable's value.
6673 * @see elm_fileselector_entry_path_get()
6675 EAPI void elm_fileselector_entry_selected_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
6678 * Get the parent directory's path to the latest file selection on
6679 * a given filer selector entry widget
6681 * @param obj The file selector object
6682 * @return The (full) path of the directory of the last selection
6683 * on @p obj widget, a @b stringshared string
6685 * @see elm_fileselector_entry_path_set()
6687 EAPI const char *elm_fileselector_entry_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6694 * @defgroup Scroller Scroller
6696 * A scroller holds a single object and "scrolls it around". This means that
6697 * it allows the user to use a scrollbar (or a finger) to drag the viewable
6698 * region around, allowing to move through a much larger object that is
6699 * contained in the scroller. The scroiller will always have a small minimum
6700 * size by default as it won't be limited by the contents of the scroller.
6702 * Signals that you can add callbacks for are:
6703 * @li "edge,left" - the left edge of the content has been reached
6704 * @li "edge,right" - the right edge of the content has been reached
6705 * @li "edge,top" - the top edge of the content has been reached
6706 * @li "edge,bottom" - the bottom edge of the content has been reached
6707 * @li "scroll" - the content has been scrolled (moved)
6708 * @li "scroll,anim,start" - scrolling animation has started
6709 * @li "scroll,anim,stop" - scrolling animation has stopped
6710 * @li "scroll,drag,start" - dragging the contents around has started
6711 * @li "scroll,drag,stop" - dragging the contents around has stopped
6712 * @note The "scroll,anim,*" and "scroll,drag,*" signals are only emitted by
6715 * @note When Elemementary is in embedded mode the scrollbars will not be
6716 * dragable, they appear merely as indicators of how much has been scrolled.
6717 * @note When Elementary is in desktop mode the thumbscroll(a.k.a.
6718 * fingerscroll) won't work.
6720 * In @ref tutorial_scroller you'll find an example of how to use most of
6725 * @brief Type that controls when scrollbars should appear.
6727 * @see elm_scroller_policy_set()
6729 typedef enum _Elm_Scroller_Policy
6731 ELM_SCROLLER_POLICY_AUTO = 0, /**< Show scrollbars as needed */
6732 ELM_SCROLLER_POLICY_ON, /**< Always show scrollbars */
6733 ELM_SCROLLER_POLICY_OFF, /**< Never show scrollbars */
6734 ELM_SCROLLER_POLICY_LAST
6735 } Elm_Scroller_Policy;
6737 * @brief Add a new scroller to the parent
6739 * @param parent The parent object
6740 * @return The new object or NULL if it cannot be created
6742 EAPI Evas_Object *elm_scroller_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6744 * @brief Set the content of the scroller widget (the object to be scrolled around).
6746 * @param obj The scroller object
6747 * @param content The new content object
6749 * Once the content object is set, a previously set one will be deleted.
6750 * If you want to keep that old content object, use the
6751 * elm_scroller_content_unset() function.
6753 EAPI void elm_scroller_content_set(Evas_Object *obj, Evas_Object *child) EINA_ARG_NONNULL(1);
6755 * @brief Get the content of the scroller widget
6757 * @param obj The slider object
6758 * @return The content that is being used
6760 * Return the content object which is set for this widget
6762 * @see elm_scroller_content_set()
6764 EAPI Evas_Object *elm_scroller_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6766 * @brief Unset the content of the scroller widget
6768 * @param obj The slider object
6769 * @return The content that was being used
6771 * Unparent and return the content object which was set for this widget
6773 * @see elm_scroller_content_set()
6775 EAPI Evas_Object *elm_scroller_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6777 * @brief Set custom theme elements for the scroller
6779 * @param obj The scroller object
6780 * @param widget The widget name to use (default is "scroller")
6781 * @param base The base name to use (default is "base")
6783 EAPI void elm_scroller_custom_widget_base_theme_set(Evas_Object *obj, const char *widget, const char *base) EINA_ARG_NONNULL(1, 2, 3);
6785 * @brief Make the scroller minimum size limited to the minimum size of the content
6787 * @param obj The scroller object
6788 * @param w Enable limiting minimum size horizontally
6789 * @param h Enable limiting minimum size vertically
6791 * By default the scroller will be as small as its design allows,
6792 * irrespective of its content. This will make the scroller minimum size the
6793 * right size horizontally and/or vertically to perfectly fit its content in
6796 EAPI void elm_scroller_content_min_limit(Evas_Object *obj, Eina_Bool w, Eina_Bool h) EINA_ARG_NONNULL(1);
6798 * @brief Show a specific virtual region within the scroller content object
6800 * @param obj The scroller object
6801 * @param x X coordinate of the region
6802 * @param y Y coordinate of the region
6803 * @param w Width of the region
6804 * @param h Height of the region
6806 * This will ensure all (or part if it does not fit) of the designated
6807 * region in the virtual content object (0, 0 starting at the top-left of the
6808 * virtual content object) is shown within the scroller.
6810 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);
6812 * @brief Set the scrollbar visibility policy
6814 * @param obj The scroller object
6815 * @param policy_h Horizontal scrollbar policy
6816 * @param policy_v Vertical scrollbar policy
6818 * This sets the scrollbar visibility policy for the given scroller.
6819 * ELM_SCROLLER_POLICY_AUTO means the scrollber is made visible if it is
6820 * needed, and otherwise kept hidden. ELM_SCROLLER_POLICY_ON turns it on all
6821 * the time, and ELM_SCROLLER_POLICY_OFF always keeps it off. This applies
6822 * respectively for the horizontal and vertical scrollbars.
6824 EAPI void elm_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
6826 * @brief Gets scrollbar visibility policy
6828 * @param obj The scroller object
6829 * @param policy_h Horizontal scrollbar policy
6830 * @param policy_v Vertical scrollbar policy
6832 * @see elm_scroller_policy_set()
6834 EAPI void elm_scroller_policy_get(const Evas_Object *obj, Elm_Scroller_Policy *policy_h, Elm_Scroller_Policy *policy_v) EINA_ARG_NONNULL(1);
6836 * @brief Get the currently visible content region
6838 * @param obj The scroller object
6839 * @param x X coordinate of the region
6840 * @param y Y coordinate of the region
6841 * @param w Width of the region
6842 * @param h Height of the region
6844 * This gets the current region in the content object that is visible through
6845 * the scroller. The region co-ordinates are returned in the @p x, @p y, @p
6846 * w, @p h values pointed to.
6848 * @note All coordinates are relative to the content.
6850 * @see elm_scroller_region_show()
6852 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);
6854 * @brief Get the size of the content object
6856 * @param obj The scroller object
6857 * @param w Width return
6858 * @param h Height return
6860 * This gets the size of the content object of the scroller.
6862 EAPI void elm_scroller_child_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
6864 * @brief Set bouncing behavior
6866 * @param obj The scroller object
6867 * @param h_bounce Will the scroller bounce horizontally or not
6868 * @param v_bounce Will the scroller bounce vertically or not
6870 * When scrolling, the scroller may "bounce" when reaching an edge of the
6871 * content object. This is a visual way to indicate the end has been reached.
6872 * This is enabled by default for both axis. This will set if it is enabled
6873 * for that axis with the boolean parameters for each axis.
6875 EAPI void elm_scroller_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
6877 * @brief Get the bounce mode
6879 * @param obj The Scroller object
6880 * @param h_bounce Allow bounce horizontally
6881 * @param v_bounce Allow bounce vertically
6883 * @see elm_scroller_bounce_set()
6885 EAPI void elm_scroller_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
6887 * @brief Set scroll page size relative to viewport size.
6889 * @param obj The scroller object
6890 * @param h_pagerel The horizontal page relative size
6891 * @param v_pagerel The vertical page relative size
6893 * The scroller is capable of limiting scrolling by the user to "pages". That
6894 * is to jump by and only show a "whole page" at a time as if the continuous
6895 * area of the scroller content is split into page sized pieces. This sets
6896 * the size of a page relative to the viewport of the scroller. 1.0 is "1
6897 * viewport" is size (horizontally or vertically). 0.0 turns it off in that
6898 * axis. This is mutually exclusive with page size
6899 * (see elm_scroller_page_size_set() for more information). Likewise 0.5
6900 * is "half a viewport". Sane usable valus are normally between 0.0 and 1.0
6901 * including 1.0. If you only want 1 axis to be page "limited", use 0.0 for
6904 EAPI void elm_scroller_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel) EINA_ARG_NONNULL(1);
6906 * @brief Set scroll page size.
6908 * @param obj The scroller object
6909 * @param h_pagesize The horizontal page size
6910 * @param v_pagesize The vertical page size
6912 * This sets the page size to an absolute fixed value, with 0 turning it off
6915 * @see elm_scroller_page_relative_set()
6917 EAPI void elm_scroller_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize) EINA_ARG_NONNULL(1);
6919 * @brief Get scroll current page number.
6921 * @param obj The scroller object
6922 * @param h_pagenumber The horizoptal page number
6923 * @param v_pagenumber The vertical page number
6925 * The page number starts from 0. 0 is the first page.
6926 * Current page means the page which meet the top-left of the viewport.
6927 * If there are two or more pages in the viewport, it returns the number of page
6928 * which meet the top-left of the viewport.
6930 * @see elm_scroller_last_page_get()
6931 * @see elm_scroller_page_show()
6932 * @see elm_scroller_page_brint_in()
6934 EAPI void elm_scroller_current_page_get(Evas_Object *obj, int *h_pagenumber, int *v_pagenumber) EINA_ARG_NONNULL(1);
6936 * @brief Get scroll last page number.
6938 * @param obj The scroller object
6939 * @param h_pagenumber The horizoptal page number
6940 * @param v_pagenumber The vertical page number
6942 * The page number starts from 0. 0 is the first page.
6943 * This returns the last page number among the pages.
6945 * @see elm_scroller_current_page_get()
6946 * @see elm_scroller_page_show()
6947 * @see elm_scroller_page_brint_in()
6949 EAPI void elm_scroller_last_page_get(Evas_Object *obj, int *h_pagenumber, int *v_pagenumber) EINA_ARG_NONNULL(1);
6951 * Show a specific virtual region within the scroller content object by page number.
6953 * @param obj The scroller object
6954 * @param h_pagenumber The horizoptal page number
6955 * @param v_pagenumber The vertical page number
6957 * 0, 0 of the indicated page is located at the top-left of the viewport.
6958 * This will jump to the page directly without animation.
6963 * sc = elm_scroller_add(win);
6964 * elm_scroller_content_set(sc, content);
6965 * elm_scroller_page_relative_set(sc, 1, 0);
6966 * elm_scroller_current_page_get(sc, &h_page, &v_page);
6967 * elm_scroller_page_show(sc, h_page + 1, v_page);
6970 * @see elm_scroller_page_bring_in()
6972 EAPI void elm_scroller_page_show(Evas_Object *obj, int h_pagenumber, int v_pagenumber) EINA_ARG_NONNULL(1);
6974 * Show a specific virtual region within the scroller content object by page number.
6976 * @param obj The scroller object
6977 * @param h_pagenumber The horizoptal page number
6978 * @param v_pagenumber The vertical page number
6980 * 0, 0 of the indicated page is located at the top-left of the viewport.
6981 * This will slide to the page with animation.
6986 * sc = elm_scroller_add(win);
6987 * elm_scroller_content_set(sc, content);
6988 * elm_scroller_page_relative_set(sc, 1, 0);
6989 * elm_scroller_last_page_get(sc, &h_page, &v_page);
6990 * elm_scroller_page_bring_in(sc, h_page, v_page);
6993 * @see elm_scroller_page_show()
6995 EAPI void elm_scroller_page_bring_in(Evas_Object *obj, int h_pagenumber, int v_pagenumber) EINA_ARG_NONNULL(1);
6997 * @brief Show a specific virtual region within the scroller content object.
6999 * @param obj The scroller object
7000 * @param x X coordinate of the region
7001 * @param y Y coordinate of the region
7002 * @param w Width of the region
7003 * @param h Height of the region
7005 * This will ensure all (or part if it does not fit) of the designated
7006 * region in the virtual content object (0, 0 starting at the top-left of the
7007 * virtual content object) is shown within the scroller. Unlike
7008 * elm_scroller_region_show(), this allow the scroller to "smoothly slide"
7009 * to this location (if configuration in general calls for transitions). It
7010 * may not jump immediately to the new location and make take a while and
7011 * show other content along the way.
7013 * @see elm_scroller_region_show()
7015 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);
7017 * @brief Set event propagation on a scroller
7019 * @param obj The scroller object
7020 * @param propagation If propagation is enabled or not
7022 * This enables or disabled event propagation from the scroller content to
7023 * the scroller and its parent. By default event propagation is disabled.
7025 EAPI void elm_scroller_propagate_events_set(Evas_Object *obj, Eina_Bool propagation);
7027 * @brief Get event propagation for a scroller
7029 * @param obj The scroller object
7030 * @return The propagation state
7032 * This gets the event propagation for a scroller.
7034 * @see elm_scroller_propagate_events_set()
7036 EAPI Eina_Bool elm_scroller_propagate_events_get(const Evas_Object *obj);
7042 * @defgroup Label Label
7044 * @image html img/widget/label/preview-00.png
7045 * @image latex img/widget/label/preview-00.eps
7047 * @brief Widget to display text, with simple html-like markup.
7049 * The Label widget @b doesn't allow text to overflow its boundaries, if the
7050 * text doesn't fit the geometry of the label it will be ellipsized or be
7051 * cut. Elementary provides several themes for this widget:
7052 * @li default - No animation
7053 * @li marker - Centers the text in the label and make it bold by default
7054 * @li slide_long - The entire text appears from the right of the screen and
7055 * slides until it disappears in the left of the screen(reappering on the
7057 * @li slide_short - The text appears in the left of the label and slides to
7058 * the right to show the overflow. When all of the text has been shown the
7059 * position is reset.
7060 * @li slide_bounce - The text appears in the left of the label and slides to
7061 * the right to show the overflow. When all of the text has been shown the
7062 * animation reverses, moving the text to the left.
7064 * Custom themes can of course invent new markup tags and style them any way
7067 * See @ref tutorial_label for a demonstration of how to use a label widget.
7071 * @brief Add a new label to the parent
7073 * @param parent The parent object
7074 * @return The new object or NULL if it cannot be created
7076 EAPI Evas_Object *elm_label_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7078 * @brief Set the label on the label object
7080 * @param obj The label object
7081 * @param label The label will be used on the label object
7082 * @deprecated See elm_object_text_set()
7084 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 */
7086 * @brief Get the label used on the label object
7088 * @param obj The label object
7089 * @return The string inside the label
7090 * @deprecated See elm_object_text_get()
7092 EINA_DEPRECATED EAPI const char *elm_label_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1); /* deprecated, use elm_object_text_get instead */
7094 * @brief Set the wrapping behavior of the label
7096 * @param obj The label object
7097 * @param wrap To wrap text or not
7099 * By default no wrapping is done. Possible values for @p wrap are:
7100 * @li ELM_WRAP_NONE - No wrapping
7101 * @li ELM_WRAP_CHAR - wrap between characters
7102 * @li ELM_WRAP_WORD - wrap between words
7103 * @li ELM_WRAP_MIXED - Word wrap, and if that fails, char wrap
7105 EAPI void elm_label_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
7107 * @brief Get the wrapping behavior of the label
7109 * @param obj The label object
7112 * @see elm_label_line_wrap_set()
7114 EAPI Elm_Wrap_Type elm_label_line_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7116 * @brief Set wrap width of the label
7118 * @param obj The label object
7119 * @param w The wrap width in pixels at a minimum where words need to wrap
7121 * This function sets the maximum width size hint of the label.
7123 * @warning This is only relevant if the label is inside a container.
7125 EAPI void elm_label_wrap_width_set(Evas_Object *obj, Evas_Coord w) EINA_ARG_NONNULL(1);
7127 * @brief Get wrap width of the label
7129 * @param obj The label object
7130 * @return The wrap width in pixels at a minimum where words need to wrap
7132 * @see elm_label_wrap_width_set()
7134 EAPI Evas_Coord elm_label_wrap_width_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7136 * @brief Set wrap height of the label
7138 * @param obj The label object
7139 * @param h The wrap height in pixels at a minimum where words need to wrap
7141 * This function sets the maximum height size hint of the label.
7143 * @warning This is only relevant if the label is inside a container.
7145 EAPI void elm_label_wrap_height_set(Evas_Object *obj, Evas_Coord h) EINA_ARG_NONNULL(1);
7147 * @brief get wrap width of the label
7149 * @param obj The label object
7150 * @return The wrap height in pixels at a minimum where words need to wrap
7152 EAPI Evas_Coord elm_label_wrap_height_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7154 * @brief Set the font size on the label object.
7156 * @param obj The label object
7157 * @param size font size
7159 * @warning NEVER use this. It is for hyper-special cases only. use styles
7160 * instead. e.g. "big", "medium", "small" - or better name them by use:
7161 * "title", "footnote", "quote" etc.
7163 EAPI void elm_label_fontsize_set(Evas_Object *obj, int fontsize) EINA_ARG_NONNULL(1);
7165 * @brief Set the text color on the label object
7167 * @param obj The label object
7168 * @param r Red property background color of The label object
7169 * @param g Green property background color of The label object
7170 * @param b Blue property background color of The label object
7171 * @param a Alpha property background color of The label object
7173 * @warning NEVER use this. It is for hyper-special cases only. use styles
7174 * instead. e.g. "big", "medium", "small" - or better name them by use:
7175 * "title", "footnote", "quote" etc.
7177 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);
7179 * @brief Set the text align on the label object
7181 * @param obj The label object
7182 * @param align align mode ("left", "center", "right")
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_align_set(Evas_Object *obj, const char *alignmode) EINA_ARG_NONNULL(1);
7190 * @brief Set background color of the label
7192 * @param obj The label object
7193 * @param r Red property background color of The label object
7194 * @param g Green property background color of The label object
7195 * @param b Blue property background color of The label object
7196 * @param a Alpha property background alpha of The label object
7198 * @warning NEVER use this. It is for hyper-special cases only. use styles
7199 * instead. e.g. "big", "medium", "small" - or better name them by use:
7200 * "title", "footnote", "quote" etc.
7202 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);
7204 * @brief Set the ellipsis behavior of the label
7206 * @param obj The label object
7207 * @param ellipsis To ellipsis text or not
7209 * If set to true and the text doesn't fit in the label an ellipsis("...")
7210 * will be shown at the end of the widget.
7212 * @warning This doesn't work with slide(elm_label_slide_set()) or if the
7213 * choosen wrap method was ELM_WRAP_WORD.
7215 EAPI void elm_label_ellipsis_set(Evas_Object *obj, Eina_Bool ellipsis) EINA_ARG_NONNULL(1);
7217 * @brief Set the text slide of the label
7219 * @param obj The label object
7220 * @param slide To start slide or stop
7222 * If set to true the text of the label will slide throught the length of
7225 * @warning This only work with the themes "slide_short", "slide_long" and
7228 EAPI void elm_label_slide_set(Evas_Object *obj, Eina_Bool slide) EINA_ARG_NONNULL(1);
7230 * @brief Get the text slide mode of the label
7232 * @param obj The label object
7233 * @return slide slide mode value
7235 * @see elm_label_slide_set()
7237 EAPI Eina_Bool elm_label_slide_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
7239 * @brief Set the slide duration(speed) of the label
7241 * @param obj The label object
7242 * @return The duration in seconds in moving text from slide begin position
7243 * to slide end position
7245 EAPI void elm_label_slide_duration_set(Evas_Object *obj, double duration) EINA_ARG_NONNULL(1);
7247 * @brief Get the slide duration(speed) of the label
7249 * @param obj The label object
7250 * @return The duration time in moving text from slide begin position to slide end position
7252 * @see elm_label_slide_duration_set()
7254 EAPI double elm_label_slide_duration_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
7260 * @defgroup Toggle Toggle
7262 * @image html img/widget/toggle/preview-00.png
7263 * @image latex img/widget/toggle/preview-00.eps
7265 * @brief A toggle is a slider which can be used to toggle between
7266 * two values. It has two states: on and off.
7268 * Signals that you can add callbacks for are:
7269 * @li "changed" - Whenever the toggle value has been changed. Is not called
7270 * until the toggle is released by the cursor (assuming it
7271 * has been triggered by the cursor in the first place).
7273 * @ref tutorial_toggle show how to use a toggle.
7277 * @brief Add a toggle to @p parent.
7279 * @param parent The parent object
7281 * @return The toggle object
7283 EAPI Evas_Object *elm_toggle_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7285 * @brief Sets the label to be displayed with the toggle.
7287 * @param obj The toggle object
7288 * @param label The label to be displayed
7290 * @deprecated use elm_object_text_set() instead.
7292 EINA_DEPRECATED EAPI void elm_toggle_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
7294 * @brief Gets the label of the toggle
7296 * @param obj toggle object
7297 * @return The label of the toggle
7299 * @deprecated use elm_object_text_get() instead.
7301 EINA_DEPRECATED EAPI const char *elm_toggle_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7303 * @brief Set the icon used for the toggle
7305 * @param obj The toggle object
7306 * @param icon The icon object for the button
7308 * Once the icon object is set, a previously set one will be deleted
7309 * If you want to keep that old content object, use the
7310 * elm_toggle_icon_unset() function.
7312 EAPI void elm_toggle_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
7314 * @brief Get the icon used for the toggle
7316 * @param obj The toggle object
7317 * @return The icon object that is being used
7319 * Return the icon object which is set for this widget.
7321 * @see elm_toggle_icon_set()
7323 EAPI Evas_Object *elm_toggle_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7325 * @brief Unset the icon used for the toggle
7327 * @param obj The toggle object
7328 * @return The icon object that was being used
7330 * Unparent and return the icon object which was set for this widget.
7332 * @see elm_toggle_icon_set()
7334 EAPI Evas_Object *elm_toggle_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
7336 * @brief Sets the labels to be associated with the on and off states of the toggle.
7338 * @param obj The toggle object
7339 * @param onlabel The label displayed when the toggle is in the "on" state
7340 * @param offlabel The label displayed when the toggle is in the "off" state
7342 EAPI void elm_toggle_states_labels_set(Evas_Object *obj, const char *onlabel, const char *offlabel) EINA_ARG_NONNULL(1);
7344 * @brief Gets the labels associated with the on and off states of the toggle.
7346 * @param obj The toggle object
7347 * @param onlabel A char** to place the onlabel of @p obj into
7348 * @param offlabel A char** to place the offlabel of @p obj into
7350 EAPI void elm_toggle_states_labels_get(const Evas_Object *obj, const char **onlabel, const char **offlabel) EINA_ARG_NONNULL(1);
7352 * @brief Sets the state of the toggle to @p state.
7354 * @param obj The toggle object
7355 * @param state The state of @p obj
7357 EAPI void elm_toggle_state_set(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
7359 * @brief Gets the state of the toggle to @p state.
7361 * @param obj The toggle object
7362 * @return The state of @p obj
7364 EAPI Eina_Bool elm_toggle_state_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7366 * @brief Sets the state pointer of the toggle to @p statep.
7368 * @param obj The toggle object
7369 * @param statep The state pointer of @p obj
7371 EAPI void elm_toggle_state_pointer_set(Evas_Object *obj, Eina_Bool *statep) EINA_ARG_NONNULL(1);
7377 * @defgroup Frame Frame
7379 * @image html img/widget/frame/preview-00.png
7380 * @image latex img/widget/frame/preview-00.eps
7382 * @brief Frame is a widget that holds some content and has a title.
7384 * The default look is a frame with a title, but Frame supports multple
7392 * @li outdent_bottom
7394 * Of all this styles only default shows the title. Frame emits no signals.
7396 * For a detailed example see the @ref tutorial_frame.
7401 * @brief Add a new frame to the parent
7403 * @param parent The parent object
7404 * @return The new object or NULL if it cannot be created
7406 EAPI Evas_Object *elm_frame_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7408 * @brief Set the frame label
7410 * @param obj The frame object
7411 * @param label The label of this frame object
7413 * @deprecated use elm_object_text_set() instead.
7415 EINA_DEPRECATED EAPI void elm_frame_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
7417 * @brief Get the frame label
7419 * @param obj The frame object
7421 * @return The label of this frame objet or NULL if unable to get frame
7423 * @deprecated use elm_object_text_get() instead.
7425 EINA_DEPRECATED EAPI const char *elm_frame_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7427 * @brief Set the content of the frame widget
7429 * Once the content object is set, a previously set one will be deleted.
7430 * If you want to keep that old content object, use the
7431 * elm_frame_content_unset() function.
7433 * @param obj The frame object
7434 * @param content The content will be filled in this frame object
7436 EAPI void elm_frame_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
7438 * @brief Get the content of the frame widget
7440 * Return the content object which is set for this widget
7442 * @param obj The frame object
7443 * @return The content that is being used
7445 EAPI Evas_Object *elm_frame_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7447 * @brief Unset the content of the frame widget
7449 * Unparent and return the content object which was set for this widget
7451 * @param obj The frame object
7452 * @return The content that was being used
7454 EAPI Evas_Object *elm_frame_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
7460 * @defgroup Table Table
7462 * A container widget to arrange other widgets in a table where items can
7463 * also span multiple columns or rows - even overlap (and then be raised or
7464 * lowered accordingly to adjust stacking if they do overlap).
7466 * The followin are examples of how to use a table:
7467 * @li @ref tutorial_table_01
7468 * @li @ref tutorial_table_02
7473 * @brief Add a new table to the parent
7475 * @param parent The parent object
7476 * @return The new object or NULL if it cannot be created
7478 EAPI Evas_Object *elm_table_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7480 * @brief Set the homogeneous layout in the table
7482 * @param obj The layout object
7483 * @param homogeneous A boolean to set if the layout is homogeneous in the
7484 * table (EINA_TRUE = homogeneous, EINA_FALSE = no homogeneous)
7486 EAPI void elm_table_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
7488 * @brief Get the current table homogeneous mode.
7490 * @param obj The table object
7491 * @return A boolean to indicating if the layout is homogeneous in the table
7492 * (EINA_TRUE = homogeneous, EINA_FALSE = no homogeneous)
7494 EAPI Eina_Bool elm_table_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7496 * @warning <b>Use elm_table_homogeneous_set() instead</b>
7498 EINA_DEPRECATED EAPI void elm_table_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
7500 * @warning <b>Use elm_table_homogeneous_get() instead</b>
7502 EINA_DEPRECATED EAPI Eina_Bool elm_table_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7504 * @brief Set padding between cells.
7506 * @param obj The layout object.
7507 * @param horizontal set the horizontal padding.
7508 * @param vertical set the vertical padding.
7510 * Default value is 0.
7512 EAPI void elm_table_padding_set(Evas_Object *obj, Evas_Coord horizontal, Evas_Coord vertical) EINA_ARG_NONNULL(1);
7514 * @brief Get padding between cells.
7516 * @param obj The layout object.
7517 * @param horizontal set the horizontal padding.
7518 * @param vertical set the vertical padding.
7520 EAPI void elm_table_padding_get(const Evas_Object *obj, Evas_Coord *horizontal, Evas_Coord *vertical) EINA_ARG_NONNULL(1);
7522 * @brief Add a subobject on the table with the coordinates passed
7524 * @param obj The table object
7525 * @param subobj The subobject to be added to the table
7526 * @param x Row number
7527 * @param y Column number
7531 * @note All positioning inside the table is relative to rows and columns, so
7532 * a value of 0 for x and y, means the top left cell of the table, and a
7533 * value of 1 for w and h means @p subobj only takes that 1 cell.
7535 EAPI void elm_table_pack(Evas_Object *obj, Evas_Object *subobj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
7537 * @brief Remove child from table.
7539 * @param obj The table object
7540 * @param subobj The subobject
7542 EAPI void elm_table_unpack(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
7544 * @brief Faster way to remove all child objects from a table object.
7546 * @param obj The table object
7547 * @param clear If true, will delete children, else just remove from table.
7549 EAPI void elm_table_clear(Evas_Object *obj, Eina_Bool clear) EINA_ARG_NONNULL(1);
7551 * @brief Set the packing location of an existing child of the table
7553 * @param subobj The subobject to be modified in the table
7554 * @param x Row number
7555 * @param y Column number
7559 * Modifies the position of an object already in the table.
7561 * @note All positioning inside the table is relative to rows and columns, so
7562 * a value of 0 for x and y, means the top left cell of the table, and a
7563 * value of 1 for w and h means @p subobj only takes that 1 cell.
7565 EAPI void elm_table_pack_set(Evas_Object *subobj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
7567 * @brief Get the packing location of an existing child of the table
7569 * @param subobj The subobject to be modified in the table
7570 * @param x Row number
7571 * @param y Column number
7575 * @see elm_table_pack_set()
7577 EAPI void elm_table_pack_get(Evas_Object *subobj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
7583 * @defgroup Gengrid Gengrid (Generic grid)
7585 * This widget aims to position objects in a grid layout while
7586 * actually creating and rendering only the visible ones, using the
7587 * same idea as the @ref Genlist "genlist": the user defines a @b
7588 * class for each item, specifying functions that will be called at
7589 * object creation, deletion, etc. When those items are selected by
7590 * the user, a callback function is issued. Users may interact with
7591 * a gengrid via the mouse (by clicking on items to select them and
7592 * clicking on the grid's viewport and swiping to pan the whole
7593 * view) or via the keyboard, navigating through item with the
7596 * @section Gengrid_Layouts Gengrid layouts
7598 * Gengrids may layout its items in one of two possible layouts:
7602 * When in "horizontal mode", items will be placed in @b columns,
7603 * from top to bottom and, when the space for a column is filled,
7604 * another one is started on the right, thus expanding the grid
7605 * horizontally, making for horizontal scrolling. When in "vertical
7606 * mode" , though, items will be placed in @b rows, from left to
7607 * right and, when the space for a row is filled, another one is
7608 * started below, thus expanding the grid vertically (and making
7609 * for vertical scrolling).
7611 * @section Gengrid_Items Gengrid items
7613 * An item in a gengrid can have 0 or more text labels (they can be
7614 * regular text or textblock Evas objects - that's up to the style
7615 * to determine), 0 or more icons (which are simply objects
7616 * swallowed into the gengrid item's theming Edje object) and 0 or
7617 * more <b>boolean states</b>, which have the behavior left to the
7618 * user to define. The Edje part names for each of these properties
7619 * will be looked up, in the theme file for the gengrid, under the
7620 * Edje (string) data items named @c "labels", @c "icons" and @c
7621 * "states", respectively. For each of those properties, if more
7622 * than one part is provided, they must have names listed separated
7623 * by spaces in the data fields. For the default gengrid item
7624 * theme, we have @b one label part (@c "elm.text"), @b two icon
7625 * parts (@c "elm.swalllow.icon" and @c "elm.swallow.end") and @b
7628 * A gengrid item may be at one of several styles. Elementary
7629 * provides one by default - "default", but this can be extended by
7630 * system or application custom themes/overlays/extensions (see
7631 * @ref Theme "themes" for more details).
7633 * @section Gengrid_Item_Class Gengrid item classes
7635 * In order to have the ability to add and delete items on the fly,
7636 * gengrid implements a class (callback) system where the
7637 * application provides a structure with information about that
7638 * type of item (gengrid may contain multiple different items with
7639 * different classes, states and styles). Gengrid will call the
7640 * functions in this struct (methods) when an item is "realized"
7641 * (i.e., created dynamically, while the user is scrolling the
7642 * grid). All objects will simply be deleted when no longer needed
7643 * with evas_object_del(). The #Elm_GenGrid_Item_Class structure
7644 * contains the following members:
7645 * - @c item_style - This is a constant string and simply defines
7646 * the name of the item style. It @b must be specified and the
7647 * default should be @c "default".
7648 * - @c func.label_get - This function is called when an item
7649 * object is actually created. The @c data parameter will point to
7650 * the same data passed to elm_gengrid_item_append() and related
7651 * item creation functions. The @c obj parameter is the gengrid
7652 * object itself, while the @c part one is the name string of one
7653 * of the existing text parts in the Edje group implementing the
7654 * item's theme. This function @b must return a strdup'()ed string,
7655 * as the caller will free() it when done. See
7656 * #Elm_Gengrid_Item_Label_Get_Cb.
7657 * - @c func.icon_get - This function is called when an item object
7658 * is actually created. The @c data parameter will point to the
7659 * same data passed to elm_gengrid_item_append() and related item
7660 * creation functions. The @c obj parameter is the gengrid object
7661 * itself, while the @c part one is the name string of one of the
7662 * existing (icon) swallow parts in the Edje group implementing the
7663 * item's theme. It must return @c NULL, when no icon is desired,
7664 * or a valid object handle, otherwise. The object will be deleted
7665 * by the gengrid on its deletion or when the item is "unrealized".
7666 * See #Elm_Gengrid_Item_Icon_Get_Cb.
7667 * - @c func.state_get - This function is called when an item
7668 * object is actually created. The @c data parameter will point to
7669 * the same data passed to elm_gengrid_item_append() and related
7670 * item creation functions. The @c obj parameter is the gengrid
7671 * object itself, while the @c part one is the name string of one
7672 * of the state parts in the Edje group implementing the item's
7673 * theme. Return @c EINA_FALSE for false/off or @c EINA_TRUE for
7674 * true/on. Gengrids will emit a signal to its theming Edje object
7675 * with @c "elm,state,XXX,active" and @c "elm" as "emission" and
7676 * "source" arguments, respectively, when the state is true (the
7677 * default is false), where @c XXX is the name of the (state) part.
7678 * See #Elm_Gengrid_Item_State_Get_Cb.
7679 * - @c func.del - This is called when elm_gengrid_item_del() is
7680 * called on an item or elm_gengrid_clear() is called on the
7681 * gengrid. This is intended for use when gengrid items are
7682 * deleted, so any data attached to the item (e.g. its data
7683 * parameter on creation) can be deleted. See #Elm_Gengrid_Item_Del_Cb.
7685 * @section Gengrid_Usage_Hints Usage hints
7687 * If the user wants to have multiple items selected at the same
7688 * time, elm_gengrid_multi_select_set() will permit it. If the
7689 * gengrid is single-selection only (the default), then
7690 * elm_gengrid_select_item_get() will return the selected item or
7691 * @c NULL, if none is selected. If the gengrid is under
7692 * multi-selection, then elm_gengrid_selected_items_get() will
7693 * return a list (that is only valid as long as no items are
7694 * modified (added, deleted, selected or unselected) of child items
7697 * If an item changes (internal (boolean) state, label or icon
7698 * changes), then use elm_gengrid_item_update() to have gengrid
7699 * update the item with the new state. A gengrid will re-"realize"
7700 * the item, thus calling the functions in the
7701 * #Elm_Gengrid_Item_Class set for that item.
7703 * To programmatically (un)select an item, use
7704 * elm_gengrid_item_selected_set(). To get its selected state use
7705 * elm_gengrid_item_selected_get(). To make an item disabled
7706 * (unable to be selected and appear differently) use
7707 * elm_gengrid_item_disabled_set() to set this and
7708 * elm_gengrid_item_disabled_get() to get the disabled state.
7710 * Grid cells will only have their selection smart callbacks called
7711 * when firstly getting selected. Any further clicks will do
7712 * nothing, unless you enable the "always select mode", with
7713 * elm_gengrid_always_select_mode_set(), thus making every click to
7714 * issue selection callbacks. elm_gengrid_no_select_mode_set() will
7715 * turn off the ability to select items entirely in the widget and
7716 * they will neither appear selected nor call the selection smart
7719 * Remember that you can create new styles and add your own theme
7720 * augmentation per application with elm_theme_extension_add(). If
7721 * you absolutely must have a specific style that overrides any
7722 * theme the user or system sets up you can use
7723 * elm_theme_overlay_add() to add such a file.
7725 * @section Gengrid_Smart_Events Gengrid smart events
7727 * Smart events that you can add callbacks for are:
7728 * - @c "activated" - The user has double-clicked or pressed
7729 * (enter|return|spacebar) on an item. The @c event_info parameter
7730 * is the gengrid item that was activated.
7731 * - @c "clicked,double" - The user has double-clicked an item.
7732 * The @c event_info parameter is the gengrid item that was double-clicked.
7733 * - @c "selected" - The user has made an item selected. The
7734 * @c event_info parameter is the gengrid item that was selected.
7735 * - @c "unselected" - The user has made an item unselected. The
7736 * @c event_info parameter is the gengrid item that was unselected.
7737 * - @c "realized" - This is called when the item in the gengrid
7738 * has its implementing Evas object instantiated, de facto. @c
7739 * event_info is the gengrid item that was created. The object
7740 * may be deleted at any time, so it is highly advised to the
7741 * caller @b not to use the object pointer returned from
7742 * elm_gengrid_item_object_get(), because it may point to freed
7744 * - @c "unrealized" - This is called when the implementing Evas
7745 * object for this item is deleted. @c event_info is the gengrid
7746 * item that was deleted.
7747 * - @c "changed" - Called when an item is added, removed, resized
7748 * or moved and when the gengrid is resized or gets "horizontal"
7750 * - @c "scroll,anim,start" - This is called when scrolling animation has
7752 * - @c "scroll,anim,stop" - This is called when scrolling animation has
7754 * - @c "drag,start,up" - Called when the item in the gengrid has
7755 * been dragged (not scrolled) up.
7756 * - @c "drag,start,down" - Called when the item in the gengrid has
7757 * been dragged (not scrolled) down.
7758 * - @c "drag,start,left" - Called when the item in the gengrid has
7759 * been dragged (not scrolled) left.
7760 * - @c "drag,start,right" - Called when the item in the gengrid has
7761 * been dragged (not scrolled) right.
7762 * - @c "drag,stop" - Called when the item in the gengrid has
7763 * stopped being dragged.
7764 * - @c "drag" - Called when the item in the gengrid is being
7766 * - @c "scroll" - called when the content has been scrolled
7768 * - @c "scroll,drag,start" - called when dragging the content has
7770 * - @c "scroll,drag,stop" - called when dragging the content has
7773 * List of gendrid examples:
7774 * @li @ref gengrid_example
7778 * @addtogroup Gengrid
7782 typedef struct _Elm_Gengrid_Item_Class Elm_Gengrid_Item_Class; /**< Gengrid item class definition structs */
7783 typedef struct _Elm_Gengrid_Item_Class_Func Elm_Gengrid_Item_Class_Func; /**< Class functions for gengrid item classes. */
7784 typedef struct _Elm_Gengrid_Item Elm_Gengrid_Item; /**< Gengrid item handles */
7785 typedef char *(*Elm_Gengrid_Item_Label_Get_Cb) (void *data, Evas_Object *obj, const char *part); /**< Label fetching class function for gengrid item classes. */
7786 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. */
7787 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. */
7788 typedef void (*Elm_Gengrid_Item_Del_Cb) (void *data, Evas_Object *obj); /**< Deletion class function for gengrid item classes. */
7790 typedef char *(*GridItemLabelGetFunc) (void *data, Evas_Object *obj, const char *part) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Gengrid_Item_Label_Get_Cb. */
7791 typedef Evas_Object *(*GridItemIconGetFunc) (void *data, Evas_Object *obj, const char *part) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Gengrid_Item_Icon_Get_Cb. */
7792 typedef Eina_Bool (*GridItemStateGetFunc) (void *data, Evas_Object *obj, const char *part) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Gengrid_Item_State_Get_Cb. */
7793 typedef void (*GridItemDelFunc) (void *data, Evas_Object *obj) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Gengrid_Item_Del_Cb. */
7796 * @struct _Elm_Gengrid_Item_Class
7798 * Gengrid item class definition. See @ref Gengrid_Item_Class for
7801 struct _Elm_Gengrid_Item_Class
7803 const char *item_style;
7804 struct _Elm_Gengrid_Item_Class_Func
7806 Elm_Gengrid_Item_Label_Get_Cb label_get;
7807 Elm_Gengrid_Item_Icon_Get_Cb icon_get;
7808 Elm_Gengrid_Item_State_Get_Cb state_get;
7809 Elm_Gengrid_Item_Del_Cb del;
7811 }; /**< #Elm_Gengrid_Item_Class member definitions */
7814 * Add a new gengrid widget to the given parent Elementary
7815 * (container) object
7817 * @param parent The parent object
7818 * @return a new gengrid widget handle or @c NULL, on errors
7820 * This function inserts a new gengrid widget on the canvas.
7822 * @see elm_gengrid_item_size_set()
7823 * @see elm_gengrid_horizontal_set()
7824 * @see elm_gengrid_item_append()
7825 * @see elm_gengrid_item_del()
7826 * @see elm_gengrid_clear()
7830 EAPI Evas_Object *elm_gengrid_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7833 * Set the size for the items of a given gengrid widget
7835 * @param obj The gengrid object.
7836 * @param w The items' width.
7837 * @param h The items' height;
7839 * A gengrid, after creation, has still no information on the size
7840 * to give to each of its cells. So, you most probably will end up
7841 * with squares one @ref Fingers "finger" wide, the default
7842 * size. Use this function to force a custom size for you items,
7843 * making them as big as you wish.
7845 * @see elm_gengrid_item_size_get()
7849 EAPI void elm_gengrid_item_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
7852 * Get the size set for the items of a given gengrid widget
7854 * @param obj The gengrid object.
7855 * @param w Pointer to a variable where to store the items' width.
7856 * @param h Pointer to a variable where to store the items' height.
7858 * @note Use @c NULL pointers on the size values you're not
7859 * interested in: they'll be ignored by the function.
7861 * @see elm_gengrid_item_size_get() for more details
7865 EAPI void elm_gengrid_item_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
7868 * Set the items grid's alignment within a given gengrid widget
7870 * @param obj The gengrid object.
7871 * @param align_x Alignment in the horizontal axis (0 <= align_x <= 1).
7872 * @param align_y Alignment in the vertical axis (0 <= align_y <= 1).
7874 * This sets the alignment of the whole grid of items of a gengrid
7875 * within its given viewport. By default, those values are both
7876 * 0.5, meaning that the gengrid will have its items grid placed
7877 * exactly in the middle of its viewport.
7879 * @note If given alignment values are out of the cited ranges,
7880 * they'll be changed to the nearest boundary values on the valid
7883 * @see elm_gengrid_align_get()
7887 EAPI void elm_gengrid_align_set(Evas_Object *obj, double align_x, double align_y) EINA_ARG_NONNULL(1);
7890 * Get the items grid's alignment values within a given gengrid
7893 * @param obj The gengrid object.
7894 * @param align_x Pointer to a variable where to store the
7895 * horizontal alignment.
7896 * @param align_y Pointer to a variable where to store the vertical
7899 * @note Use @c NULL pointers on the alignment values you're not
7900 * interested in: they'll be ignored by the function.
7902 * @see elm_gengrid_align_set() for more details
7906 EAPI void elm_gengrid_align_get(const Evas_Object *obj, double *align_x, double *align_y) EINA_ARG_NONNULL(1);
7909 * Set whether a given gengrid widget is or not able have items
7912 * @param obj The gengrid object
7913 * @param reorder_mode Use @c EINA_TRUE to turn reoderding on,
7914 * @c EINA_FALSE to turn it off
7916 * If a gengrid is set to allow reordering, a click held for more
7917 * than 0.5 over a given item will highlight it specially,
7918 * signalling the gengrid has entered the reordering state. From
7919 * that time on, the user will be able to, while still holding the
7920 * mouse button down, move the item freely in the gengrid's
7921 * viewport, replacing to said item to the locations it goes to.
7922 * The replacements will be animated and, whenever the user
7923 * releases the mouse button, the item being replaced gets a new
7924 * definitive place in the grid.
7926 * @see elm_gengrid_reorder_mode_get()
7930 EAPI void elm_gengrid_reorder_mode_set(Evas_Object *obj, Eina_Bool reorder_mode) EINA_ARG_NONNULL(1);
7933 * Get whether a given gengrid widget is or not able have items
7936 * @param obj The gengrid object
7937 * @return @c EINA_TRUE, if reoderding is on, @c EINA_FALSE if it's
7940 * @see elm_gengrid_reorder_mode_set() for more details
7944 EAPI Eina_Bool elm_gengrid_reorder_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7947 * Append a new item in a given gengrid widget.
7949 * @param obj The gengrid object.
7950 * @param gic The item class for the item.
7951 * @param data The item data.
7952 * @param func Convenience function called when the item is
7954 * @param func_data Data to be passed to @p func.
7955 * @return A handle to the item added or @c NULL, on errors.
7957 * This adds an item to the beginning of the gengrid.
7959 * @see elm_gengrid_item_prepend()
7960 * @see elm_gengrid_item_insert_before()
7961 * @see elm_gengrid_item_insert_after()
7962 * @see elm_gengrid_item_del()
7966 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);
7969 * Prepend a new item in a given gengrid widget.
7971 * @param obj The gengrid object.
7972 * @param gic The item class for the item.
7973 * @param data The item data.
7974 * @param func Convenience function called when the item is
7976 * @param func_data Data to be passed to @p func.
7977 * @return A handle to the item added or @c NULL, on errors.
7979 * This adds an item to the end of the gengrid.
7981 * @see elm_gengrid_item_append()
7982 * @see elm_gengrid_item_insert_before()
7983 * @see elm_gengrid_item_insert_after()
7984 * @see elm_gengrid_item_del()
7988 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);
7991 * Insert an item before another in a gengrid widget
7993 * @param obj The gengrid object.
7994 * @param gic The item class for the item.
7995 * @param data The item data.
7996 * @param relative The item to place this new one before.
7997 * @param func Convenience function called when the item is
7999 * @param func_data Data to be passed to @p func.
8000 * @return A handle to the item added or @c NULL, on errors.
8002 * This inserts an item before another in the gengrid.
8004 * @see elm_gengrid_item_append()
8005 * @see elm_gengrid_item_prepend()
8006 * @see elm_gengrid_item_insert_after()
8007 * @see elm_gengrid_item_del()
8011 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);
8014 * Insert an item after another in a gengrid widget
8016 * @param obj The gengrid object.
8017 * @param gic The item class for the item.
8018 * @param data The item data.
8019 * @param relative The item to place this new one after.
8020 * @param func Convenience function called when the item is
8022 * @param func_data Data to be passed to @p func.
8023 * @return A handle to the item added or @c NULL, on errors.
8025 * This inserts an item after another in the gengrid.
8027 * @see elm_gengrid_item_append()
8028 * @see elm_gengrid_item_prepend()
8029 * @see elm_gengrid_item_insert_after()
8030 * @see elm_gengrid_item_del()
8034 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);
8036 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);
8038 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);
8041 * Set whether items on a given gengrid widget are to get their
8042 * selection callbacks issued for @b every subsequent selection
8043 * click on them or just for the first click.
8045 * @param obj The gengrid object
8046 * @param always_select @c EINA_TRUE to make items "always
8047 * selected", @c EINA_FALSE, otherwise
8049 * By default, grid items will only call their selection callback
8050 * function when firstly getting selected, any subsequent further
8051 * clicks will do nothing. With this call, you make those
8052 * subsequent clicks also to issue the selection callbacks.
8054 * @note <b>Double clicks</b> will @b always be reported on items.
8056 * @see elm_gengrid_always_select_mode_get()
8060 EAPI void elm_gengrid_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
8063 * Get whether items on a given gengrid widget have their selection
8064 * callbacks issued for @b every subsequent selection click on them
8065 * or just for the first click.
8067 * @param obj The gengrid object.
8068 * @return @c EINA_TRUE if the gengrid items are "always selected",
8069 * @c EINA_FALSE, otherwise
8071 * @see elm_gengrid_always_select_mode_set() for more details
8075 EAPI Eina_Bool elm_gengrid_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8078 * Set whether items on a given gengrid widget can be selected or not.
8080 * @param obj The gengrid object
8081 * @param no_select @c EINA_TRUE to make items selectable,
8082 * @c EINA_FALSE otherwise
8084 * This will make items in @p obj selectable or not. In the latter
8085 * case, any user interacion on the gendrid items will neither make
8086 * them appear selected nor them call their selection callback
8089 * @see elm_gengrid_no_select_mode_get()
8093 EAPI void elm_gengrid_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
8096 * Get whether items on a given gengrid widget can be selected or
8099 * @param obj The gengrid object
8100 * @return @c EINA_TRUE, if items are selectable, @c EINA_FALSE
8103 * @see elm_gengrid_no_select_mode_set() for more details
8107 EAPI Eina_Bool elm_gengrid_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8110 * Enable or disable multi-selection in a given gengrid widget
8112 * @param obj The gengrid object.
8113 * @param multi @c EINA_TRUE, to enable multi-selection,
8114 * @c EINA_FALSE to disable it.
8116 * Multi-selection is the ability for one to have @b more than one
8117 * item selected, on a given gengrid, simultaneously. When it is
8118 * enabled, a sequence of clicks on different items will make them
8119 * all selected, progressively. A click on an already selected item
8120 * will unselect it. If interecting via the keyboard,
8121 * multi-selection is enabled while holding the "Shift" key.
8123 * @note By default, multi-selection is @b disabled on gengrids
8125 * @see elm_gengrid_multi_select_get()
8129 EAPI void elm_gengrid_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
8132 * Get whether multi-selection is enabled or disabled for a given
8135 * @param obj The gengrid object.
8136 * @return @c EINA_TRUE, if multi-selection is enabled, @c
8137 * EINA_FALSE otherwise
8139 * @see elm_gengrid_multi_select_set() for more details
8143 EAPI Eina_Bool elm_gengrid_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8146 * Enable or disable bouncing effect for a given gengrid widget
8148 * @param obj The gengrid object
8149 * @param h_bounce @c EINA_TRUE, to enable @b horizontal bouncing,
8150 * @c EINA_FALSE to disable it
8151 * @param v_bounce @c EINA_TRUE, to enable @b vertical bouncing,
8152 * @c EINA_FALSE to disable it
8154 * The bouncing effect occurs whenever one reaches the gengrid's
8155 * edge's while panning it -- it will scroll past its limits a
8156 * little bit and return to the edge again, in a animated for,
8159 * @note By default, gengrids have bouncing enabled on both axis
8161 * @see elm_gengrid_bounce_get()
8165 EAPI void elm_gengrid_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
8168 * Get whether bouncing effects are enabled or disabled, for a
8169 * given gengrid widget, on each axis
8171 * @param obj The gengrid object
8172 * @param h_bounce Pointer to a variable where to store the
8173 * horizontal bouncing flag.
8174 * @param v_bounce Pointer to a variable where to store the
8175 * vertical bouncing flag.
8177 * @see elm_gengrid_bounce_set() for more details
8181 EAPI void elm_gengrid_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
8184 * Set a given gengrid widget's scrolling page size, relative to
8185 * its viewport size.
8187 * @param obj The gengrid object
8188 * @param h_pagerel The horizontal page (relative) size
8189 * @param v_pagerel The vertical page (relative) size
8191 * The gengrid's scroller is capable of binding scrolling by the
8192 * user to "pages". It means that, while scrolling and, specially
8193 * after releasing the mouse button, the grid will @b snap to the
8194 * nearest displaying page's area. When page sizes are set, the
8195 * grid's continuous content area is split into (equal) page sized
8198 * This function sets the size of a page <b>relatively to the
8199 * viewport dimensions</b> of the gengrid, for each axis. A value
8200 * @c 1.0 means "the exact viewport's size", in that axis, while @c
8201 * 0.0 turns paging off in that axis. Likewise, @c 0.5 means "half
8202 * a viewport". Sane usable values are, than, between @c 0.0 and @c
8203 * 1.0. Values beyond those will make it behave behave
8204 * inconsistently. If you only want one axis to snap to pages, use
8205 * the value @c 0.0 for the other one.
8207 * There is a function setting page size values in @b absolute
8208 * values, too -- elm_gengrid_page_size_set(). Naturally, its use
8209 * is mutually exclusive to this one.
8211 * @see elm_gengrid_page_relative_get()
8215 EAPI void elm_gengrid_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel) EINA_ARG_NONNULL(1);
8218 * Get a given gengrid widget's scrolling page size, relative to
8219 * its viewport size.
8221 * @param obj The gengrid object
8222 * @param h_pagerel Pointer to a variable where to store the
8223 * horizontal page (relative) size
8224 * @param v_pagerel Pointer to a variable where to store the
8225 * vertical page (relative) size
8227 * @see elm_gengrid_page_relative_set() for more details
8231 EAPI void elm_gengrid_page_relative_get(const Evas_Object *obj, double *h_pagerel, double *v_pagerel) EINA_ARG_NONNULL(1);
8234 * Set a given gengrid widget's scrolling page size
8236 * @param obj The gengrid object
8237 * @param h_pagerel The horizontal page size, in pixels
8238 * @param v_pagerel The vertical page size, in pixels
8240 * The gengrid's scroller is capable of binding scrolling by the
8241 * user to "pages". It means that, while scrolling and, specially
8242 * after releasing the mouse button, the grid will @b snap to the
8243 * nearest displaying page's area. When page sizes are set, the
8244 * grid's continuous content area is split into (equal) page sized
8247 * This function sets the size of a page of the gengrid, in pixels,
8248 * for each axis. Sane usable values are, between @c 0 and the
8249 * dimensions of @p obj, for each axis. Values beyond those will
8250 * make it behave behave inconsistently. If you only want one axis
8251 * to snap to pages, use the value @c 0 for the other one.
8253 * There is a function setting page size values in @b relative
8254 * values, too -- elm_gengrid_page_relative_set(). Naturally, its
8255 * use is mutually exclusive to this one.
8259 EAPI void elm_gengrid_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize) EINA_ARG_NONNULL(1);
8262 * Set for what direction a given gengrid widget will expand while
8263 * placing its items.
8265 * @param obj The gengrid object.
8266 * @param setting @c EINA_TRUE to make the gengrid expand
8267 * horizontally, @c EINA_FALSE to expand vertically.
8269 * When in "horizontal mode" (@c EINA_TRUE), items will be placed
8270 * in @b columns, from top to bottom and, when the space for a
8271 * column is filled, another one is started on the right, thus
8272 * expanding the grid horizontally. When in "vertical mode"
8273 * (@c EINA_FALSE), though, items will be placed in @b rows, from left
8274 * to right and, when the space for a row is filled, another one is
8275 * started below, thus expanding the grid vertically.
8277 * @see elm_gengrid_horizontal_get()
8281 EAPI void elm_gengrid_horizontal_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
8284 * Get for what direction a given gengrid widget will expand while
8285 * placing its items.
8287 * @param obj The gengrid object.
8288 * @return @c EINA_TRUE, if @p obj is set to expand horizontally,
8289 * @c EINA_FALSE if it's set to expand vertically.
8291 * @see elm_gengrid_horizontal_set() for more detais
8295 EAPI Eina_Bool elm_gengrid_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8298 * Get the first item in a given gengrid widget
8300 * @param obj The gengrid object
8301 * @return The first item's handle or @c NULL, if there are no
8302 * items in @p obj (and on errors)
8304 * This returns the first item in the @p obj's internal list of
8307 * @see elm_gengrid_last_item_get()
8311 EAPI Elm_Gengrid_Item *elm_gengrid_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8314 * Get the last item in a given gengrid widget
8316 * @param obj The gengrid object
8317 * @return The last item's handle or @c NULL, if there are no
8318 * items in @p obj (and on errors)
8320 * This returns the last item in the @p obj's internal list of
8323 * @see elm_gengrid_first_item_get()
8327 EAPI Elm_Gengrid_Item *elm_gengrid_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8330 * Get the @b next item in a gengrid widget's internal list of items,
8331 * given a handle to one of those items.
8333 * @param item The gengrid item to fetch next from
8334 * @return The item after @p item, or @c NULL if there's none (and
8337 * This returns the item placed after the @p item, on the container
8340 * @see elm_gengrid_item_prev_get()
8344 EAPI Elm_Gengrid_Item *elm_gengrid_item_next_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8347 * Get the @b previous item in a gengrid widget's internal list of items,
8348 * given a handle to one of those items.
8350 * @param item The gengrid item to fetch previous from
8351 * @return The item before @p item, or @c NULL if there's none (and
8354 * This returns the item placed before the @p item, on the container
8357 * @see elm_gengrid_item_next_get()
8361 EAPI Elm_Gengrid_Item *elm_gengrid_item_prev_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8364 * Get the gengrid object's handle which contains a given gengrid
8367 * @param item The item to fetch the container from
8368 * @return The gengrid (parent) object
8370 * This returns the gengrid object itself that an item belongs to.
8374 EAPI Evas_Object *elm_gengrid_item_gengrid_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8377 * Remove a gengrid item from the its parent, deleting it.
8379 * @param item The item to be removed.
8380 * @return @c EINA_TRUE on success or @c EINA_FALSE, otherwise.
8382 * @see elm_gengrid_clear(), to remove all items in a gengrid at
8387 EAPI void elm_gengrid_item_del(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8390 * Update the contents of a given gengrid item
8392 * @param item The gengrid item
8394 * This updates an item by calling all the item class functions
8395 * again to get the icons, labels and states. Use this when the
8396 * original item data has changed and you want thta changes to be
8401 EAPI void elm_gengrid_item_update(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8402 EAPI const Elm_Gengrid_Item_Class *elm_gengrid_item_item_class_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8403 EAPI void elm_gengrid_item_item_class_set(Elm_Gengrid_Item *item, const Elm_Gengrid_Item_Class *gic) EINA_ARG_NONNULL(1, 2);
8406 * Return the data associated to a given gengrid item
8408 * @param item The gengrid item.
8409 * @return the data associated to this item.
8411 * This returns the @c data value passed on the
8412 * elm_gengrid_item_append() and related item addition calls.
8414 * @see elm_gengrid_item_append()
8415 * @see elm_gengrid_item_data_set()
8419 EAPI void *elm_gengrid_item_data_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8422 * Set the data associated to a given gengrid item
8424 * @param item The gengrid item
8425 * @param data The new data pointer to set on it
8427 * This @b overrides the @c data value passed on the
8428 * elm_gengrid_item_append() and related item addition calls. This
8429 * function @b won't call elm_gengrid_item_update() automatically,
8430 * so you'd issue it afterwards if you want to hove the item
8431 * updated to reflect the that new data.
8433 * @see elm_gengrid_item_data_get()
8437 EAPI void elm_gengrid_item_data_set(Elm_Gengrid_Item *item, const void *data) EINA_ARG_NONNULL(1);
8440 * Get a given gengrid item's position, relative to the whole
8441 * gengrid's grid area.
8443 * @param item The Gengrid item.
8444 * @param x Pointer to variable where to store the item's <b>row
8446 * @param y Pointer to variable where to store the item's <b>column
8449 * This returns the "logical" position of the item whithin the
8450 * gengrid. For example, @c (0, 1) would stand for first row,
8455 EAPI void elm_gengrid_item_pos_get(const Elm_Gengrid_Item *item, unsigned int *x, unsigned int *y) EINA_ARG_NONNULL(1);
8458 * Set whether a given gengrid item is selected or not
8460 * @param item The gengrid item
8461 * @param selected Use @c EINA_TRUE, to make it selected, @c
8462 * EINA_FALSE to make it unselected
8464 * This sets the selected state of an item. If multi selection is
8465 * not enabled on the containing gengrid and @p selected is @c
8466 * EINA_TRUE, any other previously selected items will get
8467 * unselected in favor of this new one.
8469 * @see elm_gengrid_item_selected_get()
8473 EAPI void elm_gengrid_item_selected_set(Elm_Gengrid_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
8476 * Get whether a given gengrid item is selected or not
8478 * @param item The gengrid item
8479 * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
8481 * @see elm_gengrid_item_selected_set() for more details
8485 EAPI Eina_Bool elm_gengrid_item_selected_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8488 * Get the real Evas object created to implement the view of a
8489 * given gengrid item
8491 * @param item The gengrid item.
8492 * @return the Evas object implementing this item's view.
8494 * This returns the actual Evas object used to implement the
8495 * specified gengrid item's view. This may be @c NULL, as it may
8496 * not have been created or may have been deleted, at any time, by
8497 * the gengrid. <b>Do not modify this object</b> (move, resize,
8498 * show, hide, etc.), as the gengrid is controlling it. This
8499 * function is for querying, emitting custom signals or hooking
8500 * lower level callbacks for events on that object. Do not delete
8501 * this object under any circumstances.
8503 * @see elm_gengrid_item_data_get()
8507 EAPI const Evas_Object *elm_gengrid_item_object_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8510 * Show the portion of a gengrid's internal grid containing a given
8511 * item, @b immediately.
8513 * @param item The item to display
8515 * This causes gengrid to @b redraw its viewport's contents to the
8516 * region contining the given @p item item, if it is not fully
8519 * @see elm_gengrid_item_bring_in()
8523 EAPI void elm_gengrid_item_show(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8526 * Animatedly bring in, to the visible are of a gengrid, a given
8529 * @param item The gengrid item to display
8531 * This causes gengrig to jump to the given @p item item and show
8532 * it (by scrolling), if it is not fully visible. This will use
8533 * animation to do so and take a period of time to complete.
8535 * @see elm_gengrid_item_show()
8539 EAPI void elm_gengrid_item_bring_in(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8542 * Set whether a given gengrid item is disabled or not.
8544 * @param item The gengrid item
8545 * @param disabled Use @c EINA_TRUE, true disable it, @c EINA_FALSE
8546 * to enable it back.
8548 * A disabled item cannot be selected or unselected. It will also
8549 * change its appearance, to signal the user it's disabled.
8551 * @see elm_gengrid_item_disabled_get()
8555 EAPI void elm_gengrid_item_disabled_set(Elm_Gengrid_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
8558 * Get whether a given gengrid item is disabled or not.
8560 * @param item The gengrid item
8561 * @return @c EINA_TRUE, if it's disabled, @c EINA_FALSE otherwise
8564 * @see elm_gengrid_item_disabled_set() for more details
8568 EAPI Eina_Bool elm_gengrid_item_disabled_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8571 * Set the text to be shown in a given gengrid item's tooltips.
8573 * @param item The gengrid item
8574 * @param text The text to set in the content
8576 * This call will setup the text to be used as tooltip to that item
8577 * (analogous to elm_object_tooltip_text_set(), but being item
8578 * tooltips with higher precedence than object tooltips). It can
8579 * have only one tooltip at a time, so any previous tooltip data
8584 EAPI void elm_gengrid_item_tooltip_text_set(Elm_Gengrid_Item *item, const char *text) EINA_ARG_NONNULL(1);
8587 * Set the content to be shown in a given gengrid item's tooltips
8589 * @param item The gengrid item.
8590 * @param func The function returning the tooltip contents.
8591 * @param data What to provide to @a func as callback data/context.
8592 * @param del_cb Called when data is not needed anymore, either when
8593 * another callback replaces @p func, the tooltip is unset with
8594 * elm_gengrid_item_tooltip_unset() or the owner @p item
8595 * dies. This callback receives as its first parameter the
8596 * given @p data, being @c event_info the item handle.
8598 * This call will setup the tooltip's contents to @p item
8599 * (analogous to elm_object_tooltip_content_cb_set(), but being
8600 * item tooltips with higher precedence than object tooltips). It
8601 * can have only one tooltip at a time, so any previous tooltip
8602 * content will get removed. @p func (with @p data) will be called
8603 * every time Elementary needs to show the tooltip and it should
8604 * return a valid Evas object, which will be fully managed by the
8605 * tooltip system, getting deleted when the tooltip is gone.
8609 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);
8612 * Unset a tooltip from a given gengrid item
8614 * @param item gengrid item to remove a previously set tooltip from.
8616 * This call removes any tooltip set on @p item. The callback
8617 * provided as @c del_cb to
8618 * elm_gengrid_item_tooltip_content_cb_set() will be called to
8619 * notify it is not used anymore (and have resources cleaned, if
8622 * @see elm_gengrid_item_tooltip_content_cb_set()
8626 EAPI void elm_gengrid_item_tooltip_unset(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8629 * Set a different @b style for a given gengrid item's tooltip.
8631 * @param item gengrid item with tooltip set
8632 * @param style the <b>theme style</b> to use on tooltips (e.g. @c
8633 * "default", @c "transparent", etc)
8635 * Tooltips can have <b>alternate styles</b> to be displayed on,
8636 * which are defined by the theme set on Elementary. This function
8637 * works analogously as elm_object_tooltip_style_set(), but here
8638 * applied only to gengrid item objects. The default style for
8639 * tooltips is @c "default".
8641 * @note before you set a style you should define a tooltip with
8642 * elm_gengrid_item_tooltip_content_cb_set() or
8643 * elm_gengrid_item_tooltip_text_set()
8645 * @see elm_gengrid_item_tooltip_style_get()
8649 EAPI void elm_gengrid_item_tooltip_style_set(Elm_Gengrid_Item *item, const char *style) EINA_ARG_NONNULL(1);
8652 * Get the style set a given gengrid item's tooltip.
8654 * @param item gengrid item with tooltip already set on.
8655 * @return style the theme style in use, which defaults to
8656 * "default". If the object does not have a tooltip set,
8657 * then @c NULL is returned.
8659 * @see elm_gengrid_item_tooltip_style_set() for more details
8663 EAPI const char *elm_gengrid_item_tooltip_style_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8665 * @brief Disable size restrictions on an object's tooltip
8666 * @param item The tooltip's anchor object
8667 * @param disable If EINA_TRUE, size restrictions are disabled
8668 * @return EINA_FALSE on failure, EINA_TRUE on success
8670 * This function allows a tooltip to expand beyond its parant window's canvas.
8671 * It will instead be limited only by the size of the display.
8673 EAPI Eina_Bool elm_gengrid_item_tooltip_size_restrict_disable(Elm_Gengrid_Item *item, Eina_Bool disable);
8675 * @brief Retrieve size restriction state of an object's tooltip
8676 * @param item The tooltip's anchor object
8677 * @return If EINA_TRUE, size restrictions are disabled
8679 * This function returns whether a tooltip is allowed to expand beyond
8680 * its parant window's canvas.
8681 * It will instead be limited only by the size of the display.
8683 EAPI Eina_Bool elm_gengrid_item_tooltip_size_restrict_disabled_get(const Elm_Gengrid_Item *item);
8685 * Set the type of mouse pointer/cursor decoration to be shown,
8686 * when the mouse pointer is over the given gengrid widget item
8688 * @param item gengrid item to customize cursor on
8689 * @param cursor the cursor type's name
8691 * This function works analogously as elm_object_cursor_set(), but
8692 * here the cursor's changing area is restricted to the item's
8693 * area, and not the whole widget's. Note that that item cursors
8694 * have precedence over widget cursors, so that a mouse over @p
8695 * item will always show cursor @p type.
8697 * If this function is called twice for an object, a previously set
8698 * cursor will be unset on the second call.
8700 * @see elm_object_cursor_set()
8701 * @see elm_gengrid_item_cursor_get()
8702 * @see elm_gengrid_item_cursor_unset()
8706 EAPI void elm_gengrid_item_cursor_set(Elm_Gengrid_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
8709 * Get the type of mouse pointer/cursor decoration set to be shown,
8710 * when the mouse pointer is over the given gengrid widget item
8712 * @param item gengrid item with custom cursor set
8713 * @return the cursor type's name or @c NULL, if no custom cursors
8714 * were set to @p item (and on errors)
8716 * @see elm_object_cursor_get()
8717 * @see elm_gengrid_item_cursor_set() for more details
8718 * @see elm_gengrid_item_cursor_unset()
8722 EAPI const char *elm_gengrid_item_cursor_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8725 * Unset any custom mouse pointer/cursor decoration set to be
8726 * shown, when the mouse pointer is over the given gengrid widget
8727 * item, thus making it show the @b default cursor again.
8729 * @param item a gengrid item
8731 * Use this call to undo any custom settings on this item's cursor
8732 * decoration, bringing it back to defaults (no custom style set).
8734 * @see elm_object_cursor_unset()
8735 * @see elm_gengrid_item_cursor_set() for more details
8739 EAPI void elm_gengrid_item_cursor_unset(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8742 * Set a different @b style for a given custom cursor set for a
8745 * @param item gengrid item with custom cursor set
8746 * @param style the <b>theme style</b> to use (e.g. @c "default",
8747 * @c "transparent", etc)
8749 * This function only makes sense when one is using custom mouse
8750 * cursor decorations <b>defined in a theme file</b> , which can
8751 * have, given a cursor name/type, <b>alternate styles</b> on
8752 * it. It works analogously as elm_object_cursor_style_set(), but
8753 * here applied only to gengrid item objects.
8755 * @warning Before you set a cursor style you should have defined a
8756 * custom cursor previously on the item, with
8757 * elm_gengrid_item_cursor_set()
8759 * @see elm_gengrid_item_cursor_engine_only_set()
8760 * @see elm_gengrid_item_cursor_style_get()
8764 EAPI void elm_gengrid_item_cursor_style_set(Elm_Gengrid_Item *item, const char *style) EINA_ARG_NONNULL(1);
8767 * Get the current @b style set for a given gengrid item's custom
8770 * @param item gengrid item with custom cursor set.
8771 * @return style the cursor style in use. If the object does not
8772 * have a cursor set, then @c NULL is returned.
8774 * @see elm_gengrid_item_cursor_style_set() for more details
8778 EAPI const char *elm_gengrid_item_cursor_style_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8781 * Set if the (custom) cursor for a given gengrid item should be
8782 * searched in its theme, also, or should only rely on the
8785 * @param item item with custom (custom) cursor already set on
8786 * @param engine_only Use @c EINA_TRUE to have cursors looked for
8787 * only on those provided by the rendering engine, @c EINA_FALSE to
8788 * have them searched on the widget's theme, as well.
8790 * @note This call is of use only if you've set a custom cursor
8791 * for gengrid items, with elm_gengrid_item_cursor_set().
8793 * @note By default, cursors will only be looked for between those
8794 * provided by the rendering engine.
8798 EAPI void elm_gengrid_item_cursor_engine_only_set(Elm_Gengrid_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
8801 * Get if the (custom) cursor for a given gengrid item is being
8802 * searched in its theme, also, or is only relying on the rendering
8805 * @param item a gengrid item
8806 * @return @c EINA_TRUE, if cursors are being looked for only on
8807 * those provided by the rendering engine, @c EINA_FALSE if they
8808 * are being searched on the widget's theme, as well.
8810 * @see elm_gengrid_item_cursor_engine_only_set(), for more details
8814 EAPI Eina_Bool elm_gengrid_item_cursor_engine_only_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8817 * Remove all items from a given gengrid widget
8819 * @param obj The gengrid object.
8821 * This removes (and deletes) all items in @p obj, leaving it
8824 * @see elm_gengrid_item_del(), to remove just one item.
8828 EAPI void elm_gengrid_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
8831 * Get the selected item in a given gengrid widget
8833 * @param obj The gengrid object.
8834 * @return The selected item's handleor @c NULL, if none is
8835 * selected at the moment (and on errors)
8837 * This returns the selected item in @p obj. If multi selection is
8838 * enabled on @p obj (@see elm_gengrid_multi_select_set()), only
8839 * the first item in the list is selected, which might not be very
8840 * useful. For that case, see elm_gengrid_selected_items_get().
8844 EAPI Elm_Gengrid_Item *elm_gengrid_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8847 * Get <b>a list</b> of selected items in a given gengrid
8849 * @param obj The gengrid object.
8850 * @return The list of selected items or @c NULL, if none is
8851 * selected at the moment (and on errors)
8853 * This returns a list of the selected items, in the order that
8854 * they appear in the grid. This list is only valid as long as no
8855 * more items are selected or unselected (or unselected implictly
8856 * by deletion). The list contains #Elm_Gengrid_Item pointers as
8859 * @see elm_gengrid_selected_item_get()
8863 EAPI const Eina_List *elm_gengrid_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8870 * @defgroup Clock Clock
8872 * @image html img/widget/clock/preview-00.png
8873 * @image latex img/widget/clock/preview-00.eps
8875 * This is a @b digital clock widget. In its default theme, it has a
8876 * vintage "flipping numbers clock" appearance, which will animate
8877 * sheets of individual algarisms individually as time goes by.
8879 * A newly created clock will fetch system's time (already
8880 * considering local time adjustments) to start with, and will tick
8881 * accondingly. It may or may not show seconds.
8883 * Clocks have an @b edition mode. When in it, the sheets will
8884 * display extra arrow indications on the top and bottom and the
8885 * user may click on them to raise or lower the time values. After
8886 * it's told to exit edition mode, it will keep ticking with that
8887 * new time set (it keeps the difference from local time).
8889 * Also, when under edition mode, user clicks on the cited arrows
8890 * which are @b held for some time will make the clock to flip the
8891 * sheet, thus editing the time, continuosly and automatically for
8892 * the user. The interval between sheet flips will keep growing in
8893 * time, so that it helps the user to reach a time which is distant
8896 * The time display is, by default, in military mode (24h), but an
8897 * am/pm indicator may be optionally shown, too, when it will
8900 * Smart callbacks one can register to:
8901 * - "changed" - the clock's user changed the time
8903 * Here is an example on its usage:
8904 * @li @ref clock_example
8913 * Identifiers for which clock digits should be editable, when a
8914 * clock widget is in edition mode. Values may be ORed together to
8915 * make a mask, naturally.
8917 * @see elm_clock_edit_set()
8918 * @see elm_clock_digit_edit_set()
8920 typedef enum _Elm_Clock_Digedit
8922 ELM_CLOCK_NONE = 0, /**< Default value. Means that all digits are editable, when in edition mode. */
8923 ELM_CLOCK_HOUR_DECIMAL = 1 << 0, /**< Decimal algarism of hours value should be editable */
8924 ELM_CLOCK_HOUR_UNIT = 1 << 1, /**< Unit algarism of hours value should be editable */
8925 ELM_CLOCK_MIN_DECIMAL = 1 << 2, /**< Decimal algarism of minutes value should be editable */
8926 ELM_CLOCK_MIN_UNIT = 1 << 3, /**< Unit algarism of minutes value should be editable */
8927 ELM_CLOCK_SEC_DECIMAL = 1 << 4, /**< Decimal algarism of seconds value should be editable */
8928 ELM_CLOCK_SEC_UNIT = 1 << 5, /**< Unit algarism of seconds value should be editable */
8929 ELM_CLOCK_ALL = (1 << 6) - 1 /**< All digits should be editable */
8930 } Elm_Clock_Digedit;
8933 * Add a new clock widget to the given parent Elementary
8934 * (container) object
8936 * @param parent The parent object
8937 * @return a new clock widget handle or @c NULL, on errors
8939 * This function inserts a new clock widget on the canvas.
8943 EAPI Evas_Object *elm_clock_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
8946 * Set a clock widget's time, programmatically
8948 * @param obj The clock widget object
8949 * @param hrs The hours to set
8950 * @param min The minutes to set
8951 * @param sec The secondes to set
8953 * This function updates the time that is showed by the clock
8956 * Values @b must be set within the following ranges:
8957 * - 0 - 23, for hours
8958 * - 0 - 59, for minutes
8959 * - 0 - 59, for seconds,
8961 * even if the clock is not in "military" mode.
8963 * @warning The behavior for values set out of those ranges is @b
8968 EAPI void elm_clock_time_set(Evas_Object *obj, int hrs, int min, int sec) EINA_ARG_NONNULL(1);
8971 * Get a clock widget's time values
8973 * @param obj The clock object
8974 * @param[out] hrs Pointer to the variable to get the hours value
8975 * @param[out] min Pointer to the variable to get the minutes value
8976 * @param[out] sec Pointer to the variable to get the seconds value
8978 * This function gets the time set for @p obj, returning
8979 * it on the variables passed as the arguments to function
8981 * @note Use @c NULL pointers on the time values you're not
8982 * interested in: they'll be ignored by the function.
8986 EAPI void elm_clock_time_get(const Evas_Object *obj, int *hrs, int *min, int *sec) EINA_ARG_NONNULL(1);
8989 * Set whether a given clock widget is under <b>edition mode</b> or
8990 * under (default) displaying-only mode.
8992 * @param obj The clock object
8993 * @param edit @c EINA_TRUE to put it in edition, @c EINA_FALSE to
8994 * put it back to "displaying only" mode
8996 * This function makes a clock's time to be editable or not <b>by
8997 * user interaction</b>. When in edition mode, clocks @b stop
8998 * ticking, until one brings them back to canonical mode. The
8999 * elm_clock_digit_edit_set() function will influence which digits
9000 * of the clock will be editable. By default, all of them will be
9001 * (#ELM_CLOCK_NONE).
9003 * @note am/pm sheets, if being shown, will @b always be editable
9004 * under edition mode.
9006 * @see elm_clock_edit_get()
9010 EAPI void elm_clock_edit_set(Evas_Object *obj, Eina_Bool edit) EINA_ARG_NONNULL(1);
9013 * Retrieve whether a given clock widget is under <b>edition
9014 * mode</b> or under (default) displaying-only mode.
9016 * @param obj The clock object
9017 * @param edit @c EINA_TRUE, if it's in edition mode, @c EINA_FALSE
9020 * This function retrieves whether the clock's time can be edited
9021 * or not by user interaction.
9023 * @see elm_clock_edit_set() for more details
9027 EAPI Eina_Bool elm_clock_edit_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9030 * Set what digits of the given clock widget should be editable
9031 * when in edition mode.
9033 * @param obj The clock object
9034 * @param digedit Bit mask indicating the digits to be editable
9035 * (values in #Elm_Clock_Digedit).
9037 * If the @p digedit param is #ELM_CLOCK_NONE, editing will be
9038 * disabled on @p obj (same effect as elm_clock_edit_set(), with @c
9041 * @see elm_clock_digit_edit_get()
9045 EAPI void elm_clock_digit_edit_set(Evas_Object *obj, Elm_Clock_Digedit digedit) EINA_ARG_NONNULL(1);
9048 * Retrieve what digits of the given clock widget should be
9049 * editable when in edition mode.
9051 * @param obj The clock object
9052 * @return Bit mask indicating the digits to be editable
9053 * (values in #Elm_Clock_Digedit).
9055 * @see elm_clock_digit_edit_set() for more details
9059 EAPI Elm_Clock_Digedit elm_clock_digit_edit_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9062 * Set if the given clock widget must show hours in military or
9065 * @param obj The clock object
9066 * @param am_pm @c EINA_TRUE to put it in am/pm mode, @c EINA_FALSE
9069 * This function sets if the clock must show hours in military or
9070 * am/pm mode. In some countries like Brazil the military mode
9071 * (00-24h-format) is used, in opposition to the USA, where the
9072 * am/pm mode is more commonly used.
9074 * @see elm_clock_show_am_pm_get()
9078 EAPI void elm_clock_show_am_pm_set(Evas_Object *obj, Eina_Bool am_pm) EINA_ARG_NONNULL(1);
9081 * Get if the given clock widget shows hours in military or am/pm
9084 * @param obj The clock object
9085 * @return @c EINA_TRUE, if in am/pm mode, @c EINA_FALSE if in
9088 * This function gets if the clock shows hours in military or am/pm
9091 * @see elm_clock_show_am_pm_set() for more details
9095 EAPI Eina_Bool elm_clock_show_am_pm_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9098 * Set if the given clock widget must show time with seconds or not
9100 * @param obj The clock object
9101 * @param seconds @c EINA_TRUE to show seconds, @c EINA_FALSE otherwise
9103 * This function sets if the given clock must show or not elapsed
9104 * seconds. By default, they are @b not shown.
9106 * @see elm_clock_show_seconds_get()
9110 EAPI void elm_clock_show_seconds_set(Evas_Object *obj, Eina_Bool seconds) EINA_ARG_NONNULL(1);
9113 * Get whether the given clock widget is showing time with seconds
9116 * @param obj The clock object
9117 * @return @c EINA_TRUE if it's showing seconds, @c EINA_FALSE otherwise
9119 * This function gets whether @p obj is showing or not the elapsed
9122 * @see elm_clock_show_seconds_set()
9126 EAPI Eina_Bool elm_clock_show_seconds_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9129 * Set the interval on time updates for an user mouse button hold
9130 * on clock widgets' time edition.
9132 * @param obj The clock object
9133 * @param interval The (first) interval value in seconds
9135 * This interval value is @b decreased while the user holds the
9136 * mouse pointer either incrementing or decrementing a given the
9137 * clock digit's value.
9139 * This helps the user to get to a given time distant from the
9140 * current one easier/faster, as it will start to flip quicker and
9141 * quicker on mouse button holds.
9143 * The calculation for the next flip interval value, starting from
9144 * the one set with this call, is the previous interval divided by
9145 * 1.05, so it decreases a little bit.
9147 * The default starting interval value for automatic flips is
9150 * @see elm_clock_interval_get()
9154 EAPI void elm_clock_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
9157 * Get the interval on time updates for an user mouse button hold
9158 * on clock widgets' time edition.
9160 * @param obj The clock object
9161 * @return The (first) interval value, in seconds, set on it
9163 * @see elm_clock_interval_set() for more details
9167 EAPI double elm_clock_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9174 * @defgroup Layout Layout
9176 * @image html img/widget/layout/preview-00.png
9177 * @image latex img/widget/layout/preview-00.eps width=\textwidth
9179 * @image html img/layout-predefined.png
9180 * @image latex img/layout-predefined.eps width=\textwidth
9182 * This is a container widget that takes a standard Edje design file and
9183 * wraps it very thinly in a widget.
9185 * An Edje design (theme) file has a very wide range of possibilities to
9186 * describe the behavior of elements added to the Layout. Check out the Edje
9187 * documentation and the EDC reference to get more information about what can
9188 * be done with Edje.
9190 * Just like @ref List, @ref Box, and other container widgets, any
9191 * object added to the Layout will become its child, meaning that it will be
9192 * deleted if the Layout is deleted, move if the Layout is moved, and so on.
9194 * The Layout widget can contain as many Contents, Boxes or Tables as
9195 * described in its theme file. For instance, objects can be added to
9196 * different Tables by specifying the respective Table part names. The same
9197 * is valid for Content and Box.
9199 * The objects added as child of the Layout will behave as described in the
9200 * part description where they were added. There are 3 possible types of
9201 * parts where a child can be added:
9203 * @section secContent Content (SWALLOW part)
9205 * Only one object can be added to the @c SWALLOW part (but you still can
9206 * have many @c SWALLOW parts and one object on each of them). Use the @c
9207 * elm_layout_content_* set of functions to set, retrieve and unset objects
9208 * as content of the @c SWALLOW. After being set to this part, the object
9209 * size, position, visibility, clipping and other description properties
9210 * will be totally controled by the description of the given part (inside
9211 * the Edje theme file).
9213 * One can use @c evas_object_size_hint_* functions on the child to have some
9214 * kind of control over its behavior, but the resulting behavior will still
9215 * depend heavily on the @c SWALLOW part description.
9217 * The Edje theme also can change the part description, based on signals or
9218 * scripts running inside the theme. This change can also be animated. All of
9219 * this will affect the child object set as content accordingly. The object
9220 * size will be changed if the part size is changed, it will animate move if
9221 * the part is moving, and so on.
9223 * The following picture demonstrates a Layout widget with a child object
9224 * added to its @c SWALLOW:
9226 * @image html layout_swallow.png
9227 * @image latex layout_swallow.eps width=\textwidth
9229 * @section secBox Box (BOX part)
9231 * An Edje @c BOX part is very similar to the Elementary @ref Box widget. It
9232 * allows one to add objects to the box and have them distributed along its
9233 * area, accordingly to the specified @a layout property (now by @a layout we
9234 * mean the chosen layouting design of the Box, not the Layout widget
9237 * A similar effect for having a box with its position, size and other things
9238 * controled by the Layout theme would be to create an Elementary @ref Box
9239 * widget and add it as a Content in the @c SWALLOW part.
9241 * The main difference of using the Layout Box is that its behavior, the box
9242 * properties like layouting format, padding, align, etc. will be all
9243 * controled by the theme. This means, for example, that a signal could be
9244 * sent to the Layout theme (with elm_object_signal_emit()) and the theme
9245 * handled the signal by changing the box padding, or align, or both. Using
9246 * the Elementary @ref Box widget is not necessarily harder or easier, it
9247 * just depends on the circunstances and requirements.
9249 * The Layout Box can be used through the @c elm_layout_box_* set of
9252 * The following picture demonstrates a Layout widget with many child objects
9253 * added to its @c BOX part:
9255 * @image html layout_box.png
9256 * @image latex layout_box.eps width=\textwidth
9258 * @section secTable Table (TABLE part)
9260 * Just like the @ref secBox, the Layout Table is very similar to the
9261 * Elementary @ref Table widget. It allows one to add objects to the Table
9262 * specifying the row and column where the object should be added, and any
9263 * column or row span if necessary.
9265 * Again, we could have this design by adding a @ref Table widget to the @c
9266 * SWALLOW part using elm_layout_content_set(). The same difference happens
9267 * here when choosing to use the Layout Table (a @c TABLE part) instead of
9268 * the @ref Table plus @c SWALLOW part. It's just a matter of convenience.
9270 * The Layout Table can be used through the @c elm_layout_table_* set of
9273 * The following picture demonstrates a Layout widget with many child objects
9274 * added to its @c TABLE part:
9276 * @image html layout_table.png
9277 * @image latex layout_table.eps width=\textwidth
9279 * @section secPredef Predefined Layouts
9281 * Another interesting thing about the Layout widget is that it offers some
9282 * predefined themes that come with the default Elementary theme. These
9283 * themes can be set by the call elm_layout_theme_set(), and provide some
9284 * basic functionality depending on the theme used.
9286 * Most of them already send some signals, some already provide a toolbar or
9287 * back and next buttons.
9289 * These are available predefined theme layouts. All of them have class = @c
9290 * layout, group = @c application, and style = one of the following options:
9292 * @li @c toolbar-content - application with toolbar and main content area
9293 * @li @c toolbar-content-back - application with toolbar and main content
9294 * area with a back button and title area
9295 * @li @c toolbar-content-back-next - application with toolbar and main
9296 * content area with a back and next buttons and title area
9297 * @li @c content-back - application with a main content area with a back
9298 * button and title area
9299 * @li @c content-back-next - application with a main content area with a
9300 * back and next buttons and title area
9301 * @li @c toolbar-vbox - application with toolbar and main content area as a
9303 * @li @c toolbar-table - application with toolbar and main content area as a
9306 * @section secExamples Examples
9308 * Some examples of the Layout widget can be found here:
9309 * @li @ref layout_example_01
9310 * @li @ref layout_example_02
9311 * @li @ref layout_example_03
9312 * @li @ref layout_example_edc
9317 * Add a new layout to the parent
9319 * @param parent The parent object
9320 * @return The new object or NULL if it cannot be created
9322 * @see elm_layout_file_set()
9323 * @see elm_layout_theme_set()
9327 EAPI Evas_Object *elm_layout_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
9329 * Set the file that will be used as layout
9331 * @param obj The layout object
9332 * @param file The path to file (edj) that will be used as layout
9333 * @param group The group that the layout belongs in edje file
9335 * @return (1 = success, 0 = error)
9339 EAPI Eina_Bool elm_layout_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1);
9341 * Set the edje group from the elementary theme that will be used as layout
9343 * @param obj The layout object
9344 * @param clas the clas of the group
9345 * @param group the group
9346 * @param style the style to used
9348 * @return (1 = success, 0 = error)
9352 EAPI Eina_Bool elm_layout_theme_set(Evas_Object *obj, const char *clas, const char *group, const char *style) EINA_ARG_NONNULL(1);
9354 * Set the layout content.
9356 * @param obj The layout object
9357 * @param swallow The swallow part name in the edje file
9358 * @param content The child that will be added in this layout object
9360 * Once the content object is set, a previously set one will be deleted.
9361 * If you want to keep that old content object, use the
9362 * elm_layout_content_unset() function.
9364 * @note In an Edje theme, the part used as a content container is called @c
9365 * SWALLOW. This is why the parameter name is called @p swallow, but it is
9366 * expected to be a part name just like the second parameter of
9367 * elm_layout_box_append().
9369 * @see elm_layout_box_append()
9370 * @see elm_layout_content_get()
9371 * @see elm_layout_content_unset()
9376 EAPI void elm_layout_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content) EINA_ARG_NONNULL(1);
9378 * Get the child object in the given content part.
9380 * @param obj The layout object
9381 * @param swallow The SWALLOW part to get its content
9383 * @return The swallowed object or NULL if none or an error occurred
9385 * @see elm_layout_content_set()
9389 EAPI Evas_Object *elm_layout_content_get(const Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
9391 * Unset the layout content.
9393 * @param obj The layout object
9394 * @param swallow The swallow part name in the edje file
9395 * @return The content that was being used
9397 * Unparent and return the content object which was set for this part.
9399 * @see elm_layout_content_set()
9403 EAPI Evas_Object *elm_layout_content_unset(Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
9405 * Set the text of the given part
9407 * @param obj The layout object
9408 * @param part The TEXT part where to set the text
9409 * @param text The text to set
9412 * @deprecated use elm_object_text_* instead.
9414 EINA_DEPRECATED EAPI void elm_layout_text_set(Evas_Object *obj, const char *part, const char *text) EINA_ARG_NONNULL(1);
9416 * Get the text set in the given part
9418 * @param obj The layout object
9419 * @param part The TEXT part to retrieve the text off
9421 * @return The text set in @p part
9424 * @deprecated use elm_object_text_* instead.
9426 EINA_DEPRECATED EAPI const char *elm_layout_text_get(const Evas_Object *obj, const char *part) EINA_ARG_NONNULL(1);
9428 * Append child to layout box part.
9430 * @param obj the layout object
9431 * @param part the box part to which the object will be appended.
9432 * @param child the child object to append to box.
9434 * Once the object is appended, it will become child of the layout. Its
9435 * lifetime will be bound to the layout, whenever the layout dies the child
9436 * will be deleted automatically. One should use elm_layout_box_remove() to
9437 * make this layout forget about the object.
9439 * @see elm_layout_box_prepend()
9440 * @see elm_layout_box_insert_before()
9441 * @see elm_layout_box_insert_at()
9442 * @see elm_layout_box_remove()
9446 EAPI void elm_layout_box_append(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1);
9448 * Prepend child to layout box part.
9450 * @param obj the layout object
9451 * @param part the box part to prepend.
9452 * @param child the child object to prepend to box.
9454 * Once the object is prepended, it will become child of the layout. Its
9455 * lifetime will be bound to the layout, whenever the layout dies the child
9456 * will be deleted automatically. One should use elm_layout_box_remove() to
9457 * make this layout forget about the object.
9459 * @see elm_layout_box_append()
9460 * @see elm_layout_box_insert_before()
9461 * @see elm_layout_box_insert_at()
9462 * @see elm_layout_box_remove()
9466 EAPI void elm_layout_box_prepend(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1);
9468 * Insert child to layout box part before a reference object.
9470 * @param obj the layout object
9471 * @param part the box part to insert.
9472 * @param child the child object to insert into box.
9473 * @param reference another reference object to insert before in box.
9475 * Once the object is inserted, it will become child of the layout. Its
9476 * lifetime will be bound to the layout, whenever the layout dies the child
9477 * will be deleted automatically. One should use elm_layout_box_remove() to
9478 * make this layout forget about the object.
9480 * @see elm_layout_box_append()
9481 * @see elm_layout_box_prepend()
9482 * @see elm_layout_box_insert_before()
9483 * @see elm_layout_box_remove()
9487 EAPI void elm_layout_box_insert_before(Evas_Object *obj, const char *part, Evas_Object *child, const Evas_Object *reference) EINA_ARG_NONNULL(1);
9489 * Insert child to layout box part at a given position.
9491 * @param obj the layout object
9492 * @param part the box part to insert.
9493 * @param child the child object to insert into box.
9494 * @param pos the numeric position >=0 to insert the child.
9496 * Once the object is inserted, it will become child of the layout. Its
9497 * lifetime will be bound to the layout, whenever the layout dies the child
9498 * will be deleted automatically. One should use elm_layout_box_remove() to
9499 * make this layout forget about the object.
9501 * @see elm_layout_box_append()
9502 * @see elm_layout_box_prepend()
9503 * @see elm_layout_box_insert_before()
9504 * @see elm_layout_box_remove()
9508 EAPI void elm_layout_box_insert_at(Evas_Object *obj, const char *part, Evas_Object *child, unsigned int pos) EINA_ARG_NONNULL(1);
9510 * Remove a child of the given part box.
9512 * @param obj The layout object
9513 * @param part The box part name to remove child.
9514 * @param child The object to remove from box.
9515 * @return The object that was being used, or NULL if not found.
9517 * The object will be removed from the box part and its lifetime will
9518 * not be handled by the layout anymore. This is equivalent to
9519 * elm_layout_content_unset() for box.
9521 * @see elm_layout_box_append()
9522 * @see elm_layout_box_remove_all()
9526 EAPI Evas_Object *elm_layout_box_remove(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1, 2, 3);
9528 * Remove all child of the given part box.
9530 * @param obj The layout object
9531 * @param part The box part name to remove child.
9532 * @param clear If EINA_TRUE, then all objects will be deleted as
9533 * well, otherwise they will just be removed and will be
9534 * dangling on the canvas.
9536 * The objects will be removed from the box part and their lifetime will
9537 * not be handled by the layout anymore. This is equivalent to
9538 * elm_layout_box_remove() for all box children.
9540 * @see elm_layout_box_append()
9541 * @see elm_layout_box_remove()
9545 EAPI void elm_layout_box_remove_all(Evas_Object *obj, const char *part, Eina_Bool clear) EINA_ARG_NONNULL(1, 2);
9547 * Insert child to layout table part.
9549 * @param obj the layout object
9550 * @param part the box part to pack child.
9551 * @param child_obj the child object to pack into table.
9552 * @param col the column to which the child should be added. (>= 0)
9553 * @param row the row to which the child should be added. (>= 0)
9554 * @param colspan how many columns should be used to store this object. (>=
9556 * @param rowspan how many rows should be used to store this object. (>= 1)
9558 * Once the object is inserted, it will become child of the table. Its
9559 * lifetime will be bound to the layout, and whenever the layout dies the
9560 * child will be deleted automatically. One should use
9561 * elm_layout_table_remove() to make this layout forget about the object.
9563 * If @p colspan or @p rowspan are bigger than 1, that object will occupy
9564 * more space than a single cell. For instance, the following code:
9566 * elm_layout_table_pack(layout, "table_part", child, 0, 1, 3, 1);
9569 * Would result in an object being added like the following picture:
9571 * @image html layout_colspan.png
9572 * @image latex layout_colspan.eps width=\textwidth
9574 * @see elm_layout_table_unpack()
9575 * @see elm_layout_table_clear()
9579 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);
9581 * Unpack (remove) a child of the given part table.
9583 * @param obj The layout object
9584 * @param part The table part name to remove child.
9585 * @param child_obj The object to remove from table.
9586 * @return The object that was being used, or NULL if not found.
9588 * The object will be unpacked from the table part and its lifetime
9589 * will not be handled by the layout anymore. This is equivalent to
9590 * elm_layout_content_unset() for table.
9592 * @see elm_layout_table_pack()
9593 * @see elm_layout_table_clear()
9597 EAPI Evas_Object *elm_layout_table_unpack(Evas_Object *obj, const char *part, Evas_Object *child_obj) EINA_ARG_NONNULL(1, 2, 3);
9599 * Remove all child of the given part table.
9601 * @param obj The layout object
9602 * @param part The table part name to remove child.
9603 * @param clear If EINA_TRUE, then all objects will be deleted as
9604 * well, otherwise they will just be removed and will be
9605 * dangling on the canvas.
9607 * The objects will be removed from the table part and their lifetime will
9608 * not be handled by the layout anymore. This is equivalent to
9609 * elm_layout_table_unpack() for all table children.
9611 * @see elm_layout_table_pack()
9612 * @see elm_layout_table_unpack()
9616 EAPI void elm_layout_table_clear(Evas_Object *obj, const char *part, Eina_Bool clear) EINA_ARG_NONNULL(1, 2);
9618 * Get the edje layout
9620 * @param obj The layout object
9622 * @return A Evas_Object with the edje layout settings loaded
9623 * with function elm_layout_file_set
9625 * This returns the edje object. It is not expected to be used to then
9626 * swallow objects via edje_object_part_swallow() for example. Use
9627 * elm_layout_content_set() instead so child object handling and sizing is
9630 * @note This function should only be used if you really need to call some
9631 * low level Edje function on this edje object. All the common stuff (setting
9632 * text, emitting signals, hooking callbacks to signals, etc.) can be done
9633 * with proper elementary functions.
9635 * @see elm_object_signal_callback_add()
9636 * @see elm_object_signal_emit()
9637 * @see elm_object_text_part_set()
9638 * @see elm_layout_content_set()
9639 * @see elm_layout_box_append()
9640 * @see elm_layout_table_pack()
9641 * @see elm_layout_data_get()
9645 EAPI Evas_Object *elm_layout_edje_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9647 * Get the edje data from the given layout
9649 * @param obj The layout object
9650 * @param key The data key
9652 * @return The edje data string
9654 * This function fetches data specified inside the edje theme of this layout.
9655 * This function return NULL if data is not found.
9657 * In EDC this comes from a data block within the group block that @p
9658 * obj was loaded from. E.g.
9665 * item: "key1" "value1";
9666 * item: "key2" "value2";
9674 EAPI const char *elm_layout_data_get(const Evas_Object *obj, const char *key) EINA_ARG_NONNULL(1, 2);
9678 * @param obj The layout object
9680 * Manually forces a sizing re-evaluation. This is useful when the minimum
9681 * size required by the edje theme of this layout has changed. The change on
9682 * the minimum size required by the edje theme is not immediately reported to
9683 * the elementary layout, so one needs to call this function in order to tell
9684 * the widget (layout) that it needs to reevaluate its own size.
9686 * The minimum size of the theme is calculated based on minimum size of
9687 * parts, the size of elements inside containers like box and table, etc. All
9688 * of this can change due to state changes, and that's when this function
9691 * Also note that a standard signal of "size,eval" "elm" emitted from the
9692 * edje object will cause this to happen too.
9696 EAPI void elm_layout_sizing_eval(Evas_Object *obj) EINA_ARG_NONNULL(1);
9699 * Sets a specific cursor for an edje part.
9701 * @param obj The layout object.
9702 * @param part_name a part from loaded edje group.
9703 * @param cursor cursor name to use, see Elementary_Cursor.h
9705 * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
9706 * part not exists or it has "mouse_events: 0".
9710 EAPI Eina_Bool elm_layout_part_cursor_set(Evas_Object *obj, const char *part_name, const char *cursor) EINA_ARG_NONNULL(1, 2);
9713 * Get the cursor to be shown when mouse is over an edje part
9715 * @param obj The layout object.
9716 * @param part_name a part from loaded edje group.
9717 * @return the cursor name.
9721 EAPI const char *elm_layout_part_cursor_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
9724 * Unsets a cursor previously set with elm_layout_part_cursor_set().
9726 * @param obj The layout object.
9727 * @param part_name a part from loaded edje group, that had a cursor set
9728 * with elm_layout_part_cursor_set().
9732 EAPI void elm_layout_part_cursor_unset(Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
9735 * Sets a specific cursor style for an edje part.
9737 * @param obj The layout object.
9738 * @param part_name a part from loaded edje group.
9739 * @param style the theme style to use (default, transparent, ...)
9741 * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
9742 * part not exists or it did not had a cursor set.
9746 EAPI Eina_Bool elm_layout_part_cursor_style_set(Evas_Object *obj, const char *part_name, const char *style) EINA_ARG_NONNULL(1, 2);
9749 * Gets a specific cursor style for an edje part.
9751 * @param obj The layout object.
9752 * @param part_name a part from loaded edje group.
9754 * @return the theme style in use, defaults to "default". If the
9755 * object does not have a cursor set, then NULL is returned.
9759 EAPI const char *elm_layout_part_cursor_style_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
9762 * Sets if the cursor set should be searched on the theme or should use
9763 * the provided by the engine, only.
9765 * @note before you set if should look on theme you should define a
9766 * cursor with elm_layout_part_cursor_set(). By default it will only
9767 * look for cursors provided by the engine.
9769 * @param obj The layout object.
9770 * @param part_name a part from loaded edje group.
9771 * @param engine_only if cursors should be just provided by the engine
9772 * or should also search on widget's theme as well
9774 * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
9775 * part not exists or it did not had a cursor set.
9779 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);
9782 * Gets a specific cursor engine_only for an edje part.
9784 * @param obj The layout object.
9785 * @param part_name a part from loaded edje group.
9787 * @return whenever the cursor is just provided by engine or also from theme.
9791 EAPI Eina_Bool elm_layout_part_cursor_engine_only_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
9794 * @def elm_layout_icon_set
9795 * Convienience macro to set the icon object in a layout that follows the
9796 * Elementary naming convention for its parts.
9800 #define elm_layout_icon_set(_ly, _obj) \
9803 elm_layout_content_set((_ly), "elm.swallow.icon", (_obj)); \
9804 if ((_obj)) sig = "elm,state,icon,visible"; \
9805 else sig = "elm,state,icon,hidden"; \
9806 elm_object_signal_emit((_ly), sig, "elm"); \
9810 * @def elm_layout_icon_get
9811 * Convienience macro to get the icon object from a layout that follows the
9812 * Elementary naming convention for its parts.
9816 #define elm_layout_icon_get(_ly) \
9817 elm_layout_content_get((_ly), "elm.swallow.icon")
9820 * @def elm_layout_end_set
9821 * Convienience macro to set the end object in a layout that follows the
9822 * Elementary naming convention for its parts.
9826 #define elm_layout_end_set(_ly, _obj) \
9829 elm_layout_content_set((_ly), "elm.swallow.end", (_obj)); \
9830 if ((_obj)) sig = "elm,state,end,visible"; \
9831 else sig = "elm,state,end,hidden"; \
9832 elm_object_signal_emit((_ly), sig, "elm"); \
9836 * @def elm_layout_end_get
9837 * Convienience macro to get the end object in a layout that follows the
9838 * Elementary naming convention for its parts.
9842 #define elm_layout_end_get(_ly) \
9843 elm_layout_content_get((_ly), "elm.swallow.end")
9846 * @def elm_layout_label_set
9847 * Convienience macro to set the label in a layout that follows the
9848 * Elementary naming convention for its parts.
9851 * @deprecated use elm_object_text_* instead.
9853 #define elm_layout_label_set(_ly, _txt) \
9854 elm_layout_text_set((_ly), "elm.text", (_txt))
9857 * @def elm_layout_label_get
9858 * Convienience macro to get 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_get(_ly) \
9865 elm_layout_text_get((_ly), "elm.text")
9867 /* smart callbacks called:
9868 * "theme,changed" - when elm theme is changed.
9872 * @defgroup Notify Notify
9874 * @image html img/widget/notify/preview-00.png
9875 * @image latex img/widget/notify/preview-00.eps
9877 * Display a container in a particular region of the parent(top, bottom,
9878 * etc. A timeout can be set to automatically hide the notify. This is so
9879 * that, after an evas_object_show() on a notify object, if a timeout was set
9880 * on it, it will @b automatically get hidden after that time.
9882 * Signals that you can add callbacks for are:
9883 * @li "timeout" - when timeout happens on notify and it's hidden
9884 * @li "block,clicked" - when a click outside of the notify happens
9886 * @ref tutorial_notify show usage of the API.
9891 * @brief Possible orient values for notify.
9893 * This values should be used in conjunction to elm_notify_orient_set() to
9894 * set the position in which the notify should appear(relative to its parent)
9895 * and in conjunction with elm_notify_orient_get() to know where the notify
9898 typedef enum _Elm_Notify_Orient
9900 ELM_NOTIFY_ORIENT_TOP, /**< Notify should appear in the top of parent, default */
9901 ELM_NOTIFY_ORIENT_CENTER, /**< Notify should appear in the center of parent */
9902 ELM_NOTIFY_ORIENT_BOTTOM, /**< Notify should appear in the bottom of parent */
9903 ELM_NOTIFY_ORIENT_LEFT, /**< Notify should appear in the left of parent */
9904 ELM_NOTIFY_ORIENT_RIGHT, /**< Notify should appear in the right of parent */
9905 ELM_NOTIFY_ORIENT_TOP_LEFT, /**< Notify should appear in the top left of parent */
9906 ELM_NOTIFY_ORIENT_TOP_RIGHT, /**< Notify should appear in the top right of parent */
9907 ELM_NOTIFY_ORIENT_BOTTOM_LEFT, /**< Notify should appear in the bottom left of parent */
9908 ELM_NOTIFY_ORIENT_BOTTOM_RIGHT, /**< Notify should appear in the bottom right of parent */
9909 ELM_NOTIFY_ORIENT_LAST /**< Sentinel value, @b don't use */
9910 } Elm_Notify_Orient;
9912 * @brief Add a new notify to the parent
9914 * @param parent The parent object
9915 * @return The new object or NULL if it cannot be created
9917 EAPI Evas_Object *elm_notify_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
9919 * @brief Set the content of the notify widget
9921 * @param obj The notify object
9922 * @param content The content will be filled in this notify object
9924 * Once the content object is set, a previously set one will be deleted. If
9925 * you want to keep that old content object, use the
9926 * elm_notify_content_unset() function.
9928 EAPI void elm_notify_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
9930 * @brief Unset the content of the notify widget
9932 * @param obj The notify object
9933 * @return The content that was being used
9935 * Unparent and return the content object which was set for this widget
9937 * @see elm_notify_content_set()
9939 EAPI Evas_Object *elm_notify_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
9941 * @brief Return the content of the notify widget
9943 * @param obj The notify object
9944 * @return The content that is being used
9946 * @see elm_notify_content_set()
9948 EAPI Evas_Object *elm_notify_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9950 * @brief Set the notify parent
9952 * @param obj The notify object
9953 * @param content The new parent
9955 * Once the parent object is set, a previously set one will be disconnected
9958 EAPI void elm_notify_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
9960 * @brief Get the notify parent
9962 * @param obj The notify object
9963 * @return The parent
9965 * @see elm_notify_parent_set()
9967 EAPI Evas_Object *elm_notify_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9969 * @brief Set the orientation
9971 * @param obj The notify object
9972 * @param orient The new orientation
9974 * Sets the position in which the notify will appear in its parent.
9976 * @see @ref Elm_Notify_Orient for possible values.
9978 EAPI void elm_notify_orient_set(Evas_Object *obj, Elm_Notify_Orient orient) EINA_ARG_NONNULL(1);
9980 * @brief Return the orientation
9981 * @param obj The notify object
9982 * @return The orientation of the notification
9984 * @see elm_notify_orient_set()
9985 * @see Elm_Notify_Orient
9987 EAPI Elm_Notify_Orient elm_notify_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9989 * @brief Set the time interval after which the notify window is going to be
9992 * @param obj The notify object
9993 * @param time The timeout in seconds
9995 * This function sets a timeout and starts the timer controlling when the
9996 * notify is hidden. Since calling evas_object_show() on a notify restarts
9997 * the timer controlling when the notify is hidden, setting this before the
9998 * notify is shown will in effect mean starting the timer when the notify is
10001 * @note Set a value <= 0.0 to disable a running timer.
10003 * @note If the value > 0.0 and the notify is previously visible, the
10004 * timer will be started with this value, canceling any running timer.
10006 EAPI void elm_notify_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
10008 * @brief Return the timeout value (in seconds)
10009 * @param obj the notify object
10011 * @see elm_notify_timeout_set()
10013 EAPI double elm_notify_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10015 * @brief Sets whether events should be passed to by a click outside
10018 * @param obj The notify object
10019 * @param repeats EINA_TRUE Events are repeats, else no
10021 * When true if the user clicks outside the window the events will be caught
10022 * by the others widgets, else the events are blocked.
10024 * @note The default value is EINA_TRUE.
10026 EAPI void elm_notify_repeat_events_set(Evas_Object *obj, Eina_Bool repeat) EINA_ARG_NONNULL(1);
10028 * @brief Return true if events are repeat below the notify object
10029 * @param obj the notify object
10031 * @see elm_notify_repeat_events_set()
10033 EAPI Eina_Bool elm_notify_repeat_events_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10039 * @defgroup Hover Hover
10041 * @image html img/widget/hover/preview-00.png
10042 * @image latex img/widget/hover/preview-00.eps
10044 * A Hover object will hover over its @p parent object at the @p target
10045 * location. Anything in the background will be given a darker coloring to
10046 * indicate that the hover object is on top (at the default theme). When the
10047 * hover is clicked it is dismissed(hidden), if the contents of the hover are
10048 * clicked that @b doesn't cause the hover to be dismissed.
10050 * @note The hover object will take up the entire space of @p target
10053 * Elementary has the following styles for the hover widget:
10057 * @li hoversel_vertical
10059 * The following are the available position for content:
10071 * Signals that you can add callbacks for are:
10072 * @li "clicked" - the user clicked the empty space in the hover to dismiss
10073 * @li "smart,changed" - a content object placed under the "smart"
10074 * policy was replaced to a new slot direction.
10076 * See @ref tutorial_hover for more information.
10080 typedef enum _Elm_Hover_Axis
10082 ELM_HOVER_AXIS_NONE, /**< ELM_HOVER_AXIS_NONE -- no prefered orientation */
10083 ELM_HOVER_AXIS_HORIZONTAL, /**< ELM_HOVER_AXIS_HORIZONTAL -- horizontal */
10084 ELM_HOVER_AXIS_VERTICAL, /**< ELM_HOVER_AXIS_VERTICAL -- vertical */
10085 ELM_HOVER_AXIS_BOTH /**< ELM_HOVER_AXIS_BOTH -- both */
10088 * @brief Adds a hover object to @p parent
10090 * @param parent The parent object
10091 * @return The hover object or NULL if one could not be created
10093 EAPI Evas_Object *elm_hover_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10095 * @brief Sets the target object for the hover.
10097 * @param obj The hover object
10098 * @param target The object to center the hover onto. The hover
10100 * This function will cause the hover to be centered on the target object.
10102 EAPI void elm_hover_target_set(Evas_Object *obj, Evas_Object *target) EINA_ARG_NONNULL(1);
10104 * @brief Gets the target object for the hover.
10106 * @param obj The hover object
10107 * @param parent The object to locate the hover over.
10109 * @see elm_hover_target_set()
10111 EAPI Evas_Object *elm_hover_target_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10113 * @brief Sets the parent object for the hover.
10115 * @param obj The hover object
10116 * @param parent The object to locate the hover over.
10118 * This function will cause the hover to take up the entire space that the
10119 * parent object fills.
10121 EAPI void elm_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
10123 * @brief Gets the parent object for the hover.
10125 * @param obj The hover object
10126 * @return The parent object to locate the hover over.
10128 * @see elm_hover_parent_set()
10130 EAPI Evas_Object *elm_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10132 * @brief Sets the content of the hover object and the direction in which it
10135 * @param obj The hover object
10136 * @param swallow The direction that the object will be displayed
10137 * at. Accepted values are "left", "top-left", "top", "top-right",
10138 * "right", "bottom-right", "bottom", "bottom-left", "middle" and
10140 * @param content The content to place at @p swallow
10142 * Once the content object is set for a given direction, a previously
10143 * set one (on the same direction) will be deleted. If you want to
10144 * keep that old content object, use the elm_hover_content_unset()
10147 * All directions may have contents at the same time, except for
10148 * "smart". This is a special placement hint and its use case
10149 * independs of the calculations coming from
10150 * elm_hover_best_content_location_get(). Its use is for cases when
10151 * one desires only one hover content, but with a dinamic special
10152 * placement within the hover area. The content's geometry, whenever
10153 * it changes, will be used to decide on a best location not
10154 * extrapolating the hover's parent object view to show it in (still
10155 * being the hover's target determinant of its medium part -- move and
10156 * resize it to simulate finger sizes, for example). If one of the
10157 * directions other than "smart" are used, a previously content set
10158 * using it will be deleted, and vice-versa.
10160 EAPI void elm_hover_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content) EINA_ARG_NONNULL(1);
10162 * @brief Get the content of the hover object, in a given direction.
10164 * Return the content object which was set for this widget in the
10165 * @p swallow direction.
10167 * @param obj The hover object
10168 * @param swallow The direction that the object was display at.
10169 * @return The content that was being used
10171 * @see elm_hover_content_set()
10173 EAPI Evas_Object *elm_hover_content_get(const Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
10175 * @brief Unset the content of the hover object, in a given direction.
10177 * Unparent and return the content object set at @p swallow direction.
10179 * @param obj The hover object
10180 * @param swallow The direction that the object was display at.
10181 * @return The content that was being used.
10183 * @see elm_hover_content_set()
10185 EAPI Evas_Object *elm_hover_content_unset(Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
10187 * @brief Returns the best swallow location for content in the hover.
10189 * @param obj The hover object
10190 * @param pref_axis The preferred orientation axis for the hover object to use
10191 * @return The edje location to place content into the hover or @c
10194 * Best is defined here as the location at which there is the most available
10197 * @p pref_axis may be one of
10198 * - @c ELM_HOVER_AXIS_NONE -- no prefered orientation
10199 * - @c ELM_HOVER_AXIS_HORIZONTAL -- horizontal
10200 * - @c ELM_HOVER_AXIS_VERTICAL -- vertical
10201 * - @c ELM_HOVER_AXIS_BOTH -- both
10203 * If ELM_HOVER_AXIS_HORIZONTAL is choosen the returned position will
10204 * nescessarily be along the horizontal axis("left" or "right"). If
10205 * ELM_HOVER_AXIS_VERTICAL is choosen the returned position will nescessarily
10206 * be along the vertical axis("top" or "bottom"). Chossing
10207 * ELM_HOVER_AXIS_BOTH or ELM_HOVER_AXIS_NONE has the same effect and the
10208 * returned position may be in either axis.
10210 * @see elm_hover_content_set()
10212 EAPI const char *elm_hover_best_content_location_get(const Evas_Object *obj, Elm_Hover_Axis pref_axis) EINA_ARG_NONNULL(1);
10219 * @defgroup Entry Entry
10221 * @image html img/widget/entry/preview-00.png
10222 * @image latex img/widget/entry/preview-00.eps width=\textwidth
10223 * @image html img/widget/entry/preview-01.png
10224 * @image latex img/widget/entry/preview-01.eps width=\textwidth
10225 * @image html img/widget/entry/preview-02.png
10226 * @image latex img/widget/entry/preview-02.eps width=\textwidth
10227 * @image html img/widget/entry/preview-03.png
10228 * @image latex img/widget/entry/preview-03.eps width=\textwidth
10230 * An entry is a convenience widget which shows a box that the user can
10231 * enter text into. Entries by default don't scroll, so they grow to
10232 * accomodate the entire text, resizing the parent window as needed. This
10233 * can be changed with the elm_entry_scrollable_set() function.
10235 * They can also be single line or multi line (the default) and when set
10236 * to multi line mode they support text wrapping in any of the modes
10237 * indicated by #Elm_Wrap_Type.
10239 * Other features include password mode, filtering of inserted text with
10240 * elm_entry_text_filter_append() and related functions, inline "items" and
10241 * formatted markup text.
10243 * @section entry-markup Formatted text
10245 * The markup tags supported by the Entry are defined by the theme, but
10246 * even when writing new themes or extensions it's a good idea to stick to
10247 * a sane default, to maintain coherency and avoid application breakages.
10248 * Currently defined by the default theme are the following tags:
10249 * @li \<br\>: Inserts a line break.
10250 * @li \<ps\>: Inserts a paragraph separator. This is preferred over line
10252 * @li \<tab\>: Inserts a tab.
10253 * @li \<em\>...\</em\>: Emphasis. Sets the @em oblique style for the
10255 * @li \<b\>...\</b\>: Sets the @b bold style for the enclosed text.
10256 * @li \<link\>...\</link\>: Underlines the enclosed text.
10257 * @li \<hilight\>...\</hilight\>: Hilights the enclosed text.
10259 * @section entry-special Special markups
10261 * Besides those used to format text, entries support two special markup
10262 * tags used to insert clickable portions of text or items inlined within
10265 * @subsection entry-anchors Anchors
10267 * Anchors are similar to HTML anchors. Text can be surrounded by \<a\> and
10268 * \</a\> tags and an event will be generated when this text is clicked,
10272 * This text is outside <a href=anc-01>but this one is an anchor</a>
10275 * The @c href attribute in the opening tag gives the name that will be
10276 * used to identify the anchor and it can be any valid utf8 string.
10278 * When an anchor is clicked, an @c "anchor,clicked" signal is emitted with
10279 * an #Elm_Entry_Anchor_Info in the @c event_info parameter for the
10280 * callback function. The same applies for "anchor,in" (mouse in), "anchor,out"
10281 * (mouse out), "anchor,down" (mouse down), and "anchor,up" (mouse up) events on
10284 * @subsection entry-items Items
10286 * Inlined in the text, any other @c Evas_Object can be inserted by using
10287 * \<item\> tags this way:
10290 * <item size=16x16 vsize=full href=emoticon/haha></item>
10293 * Just like with anchors, the @c href identifies each item, but these need,
10294 * in addition, to indicate their size, which is done using any one of
10295 * @c size, @c absize or @c relsize attributes. These attributes take their
10296 * value in the WxH format, where W is the width and H the height of the
10299 * @li absize: Absolute pixel size for the item. Whatever value is set will
10300 * be the item's size regardless of any scale value the object may have
10301 * been set to. The final line height will be adjusted to fit larger items.
10302 * @li size: Similar to @c absize, but it's adjusted to the scale value set
10304 * @li relsize: Size is adjusted for the item to fit within the current
10307 * Besides their size, items are specificed a @c vsize value that affects
10308 * how their final size and position are calculated. The possible values
10310 * @li ascent: Item will be placed within the line's baseline and its
10311 * ascent. That is, the height between the line where all characters are
10312 * positioned and the highest point in the line. For @c size and @c absize
10313 * items, the descent value will be added to the total line height to make
10314 * them fit. @c relsize items will be adjusted to fit within this space.
10315 * @li full: Items will be placed between the descent and ascent, or the
10316 * lowest point in the line and its highest.
10318 * The next image shows different configurations of items and how they
10319 * are the previously mentioned options affect their sizes. In all cases,
10320 * the green line indicates the ascent, blue for the baseline and red for
10323 * @image html entry_item.png
10324 * @image latex entry_item.eps width=\textwidth
10326 * And another one to show how size differs from absize. In the first one,
10327 * the scale value is set to 1.0, while the second one is using one of 2.0.
10329 * @image html entry_item_scale.png
10330 * @image latex entry_item_scale.eps width=\textwidth
10332 * After the size for an item is calculated, the entry will request an
10333 * object to place in its space. For this, the functions set with
10334 * elm_entry_item_provider_append() and related functions will be called
10335 * in order until one of them returns a @c non-NULL value. If no providers
10336 * are available, or all of them return @c NULL, then the entry falls back
10337 * to one of the internal defaults, provided the name matches with one of
10340 * All of the following are currently supported:
10343 * - emoticon/angry-shout
10344 * - emoticon/crazy-laugh
10345 * - emoticon/evil-laugh
10347 * - emoticon/goggle-smile
10348 * - emoticon/grumpy
10349 * - emoticon/grumpy-smile
10350 * - emoticon/guilty
10351 * - emoticon/guilty-smile
10353 * - emoticon/half-smile
10354 * - emoticon/happy-panting
10356 * - emoticon/indifferent
10358 * - emoticon/knowing-grin
10360 * - emoticon/little-bit-sorry
10361 * - emoticon/love-lots
10363 * - emoticon/minimal-smile
10364 * - emoticon/not-happy
10365 * - emoticon/not-impressed
10367 * - emoticon/opensmile
10370 * - emoticon/squint-laugh
10371 * - emoticon/surprised
10372 * - emoticon/suspicious
10373 * - emoticon/tongue-dangling
10374 * - emoticon/tongue-poke
10376 * - emoticon/unhappy
10377 * - emoticon/very-sorry
10380 * - emoticon/worried
10383 * Alternatively, an item may reference an image by its path, using
10384 * the URI form @c file:///path/to/an/image.png and the entry will then
10385 * use that image for the item.
10387 * @section entry-files Loading and saving files
10389 * Entries have convinience functions to load text from a file and save
10390 * changes back to it after a short delay. The automatic saving is enabled
10391 * by default, but can be disabled with elm_entry_autosave_set() and files
10392 * can be loaded directly as plain text or have any markup in them
10393 * recognized. See elm_entry_file_set() for more details.
10395 * @section entry-signals Emitted signals
10397 * This widget emits the following signals:
10399 * @li "changed": The text within the entry was changed.
10400 * @li "changed,user": The text within the entry was changed because of user interaction.
10401 * @li "activated": The enter key was pressed on a single line entry.
10402 * @li "press": A mouse button has been pressed on the entry.
10403 * @li "longpressed": A mouse button has been pressed and held for a couple
10405 * @li "clicked": The entry has been clicked (mouse press and release).
10406 * @li "clicked,double": The entry has been double clicked.
10407 * @li "clicked,triple": The entry has been triple clicked.
10408 * @li "focused": The entry has received focus.
10409 * @li "unfocused": The entry has lost focus.
10410 * @li "selection,paste": A paste of the clipboard contents was requested.
10411 * @li "selection,copy": A copy of the selected text into the clipboard was
10413 * @li "selection,cut": A cut of the selected text into the clipboard was
10415 * @li "selection,start": A selection has begun and no previous selection
10417 * @li "selection,changed": The current selection has changed.
10418 * @li "selection,cleared": The current selection has been cleared.
10419 * @li "cursor,changed": The cursor has changed position.
10420 * @li "anchor,clicked": An anchor has been clicked. The event_info
10421 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10422 * @li "anchor,in": Mouse cursor has moved into an anchor. The event_info
10423 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10424 * @li "anchor,out": Mouse cursor has moved out of an anchor. The event_info
10425 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10426 * @li "anchor,up": Mouse button has been unpressed on an anchor. The event_info
10427 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10428 * @li "anchor,down": Mouse button has been pressed on an anchor. The event_info
10429 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10430 * @li "preedit,changed": The preedit string has changed.
10432 * @section entry-examples
10434 * An overview of the Entry API can be seen in @ref entry_example_01
10439 * @typedef Elm_Entry_Anchor_Info
10441 * The info sent in the callback for the "anchor,clicked" signals emitted
10444 typedef struct _Elm_Entry_Anchor_Info Elm_Entry_Anchor_Info;
10446 * @struct _Elm_Entry_Anchor_Info
10448 * The info sent in the callback for the "anchor,clicked" signals emitted
10451 struct _Elm_Entry_Anchor_Info
10453 const char *name; /**< The name of the anchor, as stated in its href */
10454 int button; /**< The mouse button used to click on it */
10455 Evas_Coord x, /**< Anchor geometry, relative to canvas */
10456 y, /**< Anchor geometry, relative to canvas */
10457 w, /**< Anchor geometry, relative to canvas */
10458 h; /**< Anchor geometry, relative to canvas */
10461 * @typedef Elm_Entry_Filter_Cb
10462 * This callback type is used by entry filters to modify text.
10463 * @param data The data specified as the last param when adding the filter
10464 * @param entry The entry object
10465 * @param text A pointer to the location of the text being filtered. This data can be modified,
10466 * but any additional allocations must be managed by the user.
10467 * @see elm_entry_text_filter_append
10468 * @see elm_entry_text_filter_prepend
10470 typedef void (*Elm_Entry_Filter_Cb)(void *data, Evas_Object *entry, char **text);
10473 * This adds an entry to @p parent object.
10475 * By default, entries are:
10479 * @li autosave is enabled
10481 * @param parent The parent object
10482 * @return The new object or NULL if it cannot be created
10484 EAPI Evas_Object *elm_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10486 * Sets the entry to single line mode.
10488 * In single line mode, entries don't ever wrap when the text reaches the
10489 * edge, and instead they keep growing horizontally. Pressing the @c Enter
10490 * key will generate an @c "activate" event instead of adding a new line.
10492 * When @p single_line is @c EINA_FALSE, line wrapping takes effect again
10493 * and pressing enter will break the text into a different line
10494 * without generating any events.
10496 * @param obj The entry object
10497 * @param single_line If true, the text in the entry
10498 * will be on a single line.
10500 EAPI void elm_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line) EINA_ARG_NONNULL(1);
10502 * Gets whether the entry is set to be single line.
10504 * @param obj The entry object
10505 * @return single_line If true, the text in the entry is set to display
10506 * on a single line.
10508 * @see elm_entry_single_line_set()
10510 EAPI Eina_Bool elm_entry_single_line_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10512 * Sets the entry to password mode.
10514 * In password mode, entries are implicitly single line and the display of
10515 * any text in them is replaced with asterisks (*).
10517 * @param obj The entry object
10518 * @param password If true, password mode is enabled.
10520 EAPI void elm_entry_password_set(Evas_Object *obj, Eina_Bool password) EINA_ARG_NONNULL(1);
10522 * Gets whether the entry is set to password mode.
10524 * @param obj The entry object
10525 * @return If true, the entry is set to display all characters
10526 * as asterisks (*).
10528 * @see elm_entry_password_set()
10530 EAPI Eina_Bool elm_entry_password_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10532 * This sets the text displayed within the entry to @p entry.
10534 * @param obj The entry object
10535 * @param entry The text to be displayed
10537 * @deprecated Use elm_object_text_set() instead.
10539 EAPI void elm_entry_entry_set(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
10541 * This returns the text currently shown in object @p entry.
10542 * See also elm_entry_entry_set().
10544 * @param obj The entry object
10545 * @return The currently displayed text or NULL on failure
10547 * @deprecated Use elm_object_text_get() instead.
10549 EAPI const char *elm_entry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10551 * Appends @p entry to the text of the entry.
10553 * Adds the text in @p entry to the end of any text already present in the
10556 * The appended text is subject to any filters set for the widget.
10558 * @param obj The entry object
10559 * @param entry The text to be displayed
10561 * @see elm_entry_text_filter_append()
10563 EAPI void elm_entry_entry_append(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
10565 * Gets whether the entry is empty.
10567 * Empty means no text at all. If there are any markup tags, like an item
10568 * tag for which no provider finds anything, and no text is displayed, this
10569 * function still returns EINA_FALSE.
10571 * @param obj The entry object
10572 * @return EINA_TRUE if the entry is empty, EINA_FALSE otherwise.
10574 EAPI Eina_Bool elm_entry_is_empty(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10576 * Gets any selected text within the entry.
10578 * If there's any selected text in the entry, this function returns it as
10579 * a string in markup format. NULL is returned if no selection exists or
10580 * if an error occurred.
10582 * The returned value points to an internal string and should not be freed
10583 * or modified in any way. If the @p entry object is deleted or its
10584 * contents are changed, the returned pointer should be considered invalid.
10586 * @param obj The entry object
10587 * @return The selected text within the entry or NULL on failure
10589 EAPI const char *elm_entry_selection_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10591 * Inserts the given text into the entry at the current cursor position.
10593 * This inserts text at the cursor position as if it was typed
10594 * by the user (note that this also allows markup which a user
10595 * can't just "type" as it would be converted to escaped text, so this
10596 * call can be used to insert things like emoticon items or bold push/pop
10597 * tags, other font and color change tags etc.)
10599 * If any selection exists, it will be replaced by the inserted text.
10601 * The inserted text is subject to any filters set for the widget.
10603 * @param obj The entry object
10604 * @param entry The text to insert
10606 * @see elm_entry_text_filter_append()
10608 EAPI void elm_entry_entry_insert(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
10610 * Set the line wrap type to use on multi-line entries.
10612 * Sets the wrap type used by the entry to any of the specified in
10613 * #Elm_Wrap_Type. This tells how the text will be implicitly cut into a new
10614 * line (without inserting a line break or paragraph separator) when it
10615 * reaches the far edge of the widget.
10617 * Note that this only makes sense for multi-line entries. A widget set
10618 * to be single line will never wrap.
10620 * @param obj The entry object
10621 * @param wrap The wrap mode to use. See #Elm_Wrap_Type for details on them
10623 EAPI void elm_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
10625 * Gets the wrap mode the entry was set to use.
10627 * @param obj The entry object
10628 * @return Wrap type
10630 * @see also elm_entry_line_wrap_set()
10632 EAPI Elm_Wrap_Type elm_entry_line_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10634 * Sets if the entry is to be editable or not.
10636 * By default, entries are editable and when focused, any text input by the
10637 * user will be inserted at the current cursor position. But calling this
10638 * function with @p editable as EINA_FALSE will prevent the user from
10639 * inputting text into the entry.
10641 * The only way to change the text of a non-editable entry is to use
10642 * elm_object_text_set(), elm_entry_entry_insert() and other related
10645 * @param obj The entry object
10646 * @param editable If EINA_TRUE, user input will be inserted in the entry,
10647 * if not, the entry is read-only and no user input is allowed.
10649 EAPI void elm_entry_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
10651 * Gets whether the entry is editable or not.
10653 * @param obj The entry object
10654 * @return If true, the entry is editable by the user.
10655 * If false, it is not editable by the user
10657 * @see elm_entry_editable_set()
10659 EAPI Eina_Bool elm_entry_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10661 * This drops any existing text selection within the entry.
10663 * @param obj The entry object
10665 EAPI void elm_entry_select_none(Evas_Object *obj) EINA_ARG_NONNULL(1);
10667 * This selects all text within the entry.
10669 * @param obj The entry object
10671 EAPI void elm_entry_select_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
10673 * This moves the cursor one place to the right within the entry.
10675 * @param obj The entry object
10676 * @return EINA_TRUE upon success, EINA_FALSE upon failure
10678 EAPI Eina_Bool elm_entry_cursor_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
10680 * This moves the cursor one place to the left within the entry.
10682 * @param obj The entry object
10683 * @return EINA_TRUE upon success, EINA_FALSE upon failure
10685 EAPI Eina_Bool elm_entry_cursor_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
10687 * This moves the cursor one line up within the entry.
10689 * @param obj The entry object
10690 * @return EINA_TRUE upon success, EINA_FALSE upon failure
10692 EAPI Eina_Bool elm_entry_cursor_up(Evas_Object *obj) EINA_ARG_NONNULL(1);
10694 * This moves the cursor one line down within the entry.
10696 * @param obj The entry object
10697 * @return EINA_TRUE upon success, EINA_FALSE upon failure
10699 EAPI Eina_Bool elm_entry_cursor_down(Evas_Object *obj) EINA_ARG_NONNULL(1);
10701 * This moves the cursor to the beginning of the entry.
10703 * @param obj The entry object
10705 EAPI void elm_entry_cursor_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
10707 * This moves the cursor to the end of the entry.
10709 * @param obj The entry object
10711 EAPI void elm_entry_cursor_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
10713 * This moves the cursor to the beginning of the current line.
10715 * @param obj The entry object
10717 EAPI void elm_entry_cursor_line_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
10719 * This moves the cursor to the end of the current line.
10721 * @param obj The entry object
10723 EAPI void elm_entry_cursor_line_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
10725 * This begins a selection within the entry as though
10726 * the user were holding down the mouse button to make a selection.
10728 * @param obj The entry object
10730 EAPI void elm_entry_cursor_selection_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
10732 * This ends a selection within the entry as though
10733 * the user had just released the mouse button while making a selection.
10735 * @param obj The entry object
10737 EAPI void elm_entry_cursor_selection_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
10739 * Gets whether a format node exists at the current cursor position.
10741 * A format node is anything that defines how the text is rendered. It can
10742 * be a visible format node, such as a line break or a paragraph separator,
10743 * or an invisible one, such as bold begin or end tag.
10744 * This function returns whether any format node exists at the current
10747 * @param obj The entry object
10748 * @return EINA_TRUE if the current cursor position contains a format node,
10749 * EINA_FALSE otherwise.
10751 * @see elm_entry_cursor_is_visible_format_get()
10753 EAPI Eina_Bool elm_entry_cursor_is_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10755 * Gets if the current cursor position holds a visible format node.
10757 * @param obj The entry object
10758 * @return EINA_TRUE if the current cursor is a visible format, EINA_FALSE
10759 * if it's an invisible one or no format exists.
10761 * @see elm_entry_cursor_is_format_get()
10763 EAPI Eina_Bool elm_entry_cursor_is_visible_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10765 * Gets the character pointed by the cursor at its current position.
10767 * This function returns a string with the utf8 character stored at the
10768 * current cursor position.
10769 * Only the text is returned, any format that may exist will not be part
10770 * of the return value.
10772 * @param obj The entry object
10773 * @return The text pointed by the cursors.
10775 EAPI const char *elm_entry_cursor_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10777 * This function returns the geometry of the cursor.
10779 * It's useful if you want to draw something on the cursor (or where it is),
10780 * or for example in the case of scrolled entry where you want to show the
10783 * @param obj The entry object
10784 * @param x returned geometry
10785 * @param y returned geometry
10786 * @param w returned geometry
10787 * @param h returned geometry
10788 * @return EINA_TRUE upon success, EINA_FALSE upon failure
10790 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);
10792 * Sets the cursor position in the entry to the given value
10794 * The value in @p pos is the index of the character position within the
10795 * contents of the string as returned by elm_entry_cursor_pos_get().
10797 * @param obj The entry object
10798 * @param pos The position of the cursor
10800 EAPI void elm_entry_cursor_pos_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
10802 * Retrieves the current position of the cursor in the entry
10804 * @param obj The entry object
10805 * @return The cursor position
10807 EAPI int elm_entry_cursor_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10809 * This executes a "cut" action on the selected text in the entry.
10811 * @param obj The entry object
10813 EAPI void elm_entry_selection_cut(Evas_Object *obj) EINA_ARG_NONNULL(1);
10815 * This executes a "copy" action on the selected text in the entry.
10817 * @param obj The entry object
10819 EAPI void elm_entry_selection_copy(Evas_Object *obj) EINA_ARG_NONNULL(1);
10821 * This executes a "paste" action in the entry.
10823 * @param obj The entry object
10825 EAPI void elm_entry_selection_paste(Evas_Object *obj) EINA_ARG_NONNULL(1);
10827 * This clears and frees the items in a entry's contextual (longpress)
10830 * @param obj The entry object
10832 * @see elm_entry_context_menu_item_add()
10834 EAPI void elm_entry_context_menu_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
10836 * This adds an item to the entry's contextual menu.
10838 * A longpress on an entry will make the contextual menu show up, if this
10839 * hasn't been disabled with elm_entry_context_menu_disabled_set().
10840 * By default, this menu provides a few options like enabling selection mode,
10841 * which is useful on embedded devices that need to be explicit about it,
10842 * and when a selection exists it also shows the copy and cut actions.
10844 * With this function, developers can add other options to this menu to
10845 * perform any action they deem necessary.
10847 * @param obj The entry object
10848 * @param label The item's text label
10849 * @param icon_file The item's icon file
10850 * @param icon_type The item's icon type
10851 * @param func The callback to execute when the item is clicked
10852 * @param data The data to associate with the item for related functions
10854 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);
10856 * This disables the entry's contextual (longpress) menu.
10858 * @param obj The entry object
10859 * @param disabled If true, the menu is disabled
10861 EAPI void elm_entry_context_menu_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
10863 * This returns whether the entry's contextual (longpress) menu is
10866 * @param obj The entry object
10867 * @return If true, the menu is disabled
10869 EAPI Eina_Bool elm_entry_context_menu_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10871 * This appends a custom item provider to the list for that entry
10873 * This appends the given callback. The list is walked from beginning to end
10874 * with each function called given the item href string in the text. If the
10875 * function returns an object handle other than NULL (it should create an
10876 * object to do this), then this object is used to replace that item. If
10877 * not the next provider is called until one provides an item object, or the
10878 * default provider in entry does.
10880 * @param obj The entry object
10881 * @param func The function called to provide the item object
10882 * @param data The data passed to @p func
10884 * @see @ref entry-items
10886 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);
10888 * This prepends a custom item provider to the list for that entry
10890 * This prepends the given callback. See elm_entry_item_provider_append() for
10893 * @param obj The entry object
10894 * @param func The function called to provide the item object
10895 * @param data The data passed to @p func
10897 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);
10899 * This removes a custom item provider to the list for that entry
10901 * This removes 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_remove(Evas_Object *obj, Evas_Object *(*func) (void *data, Evas_Object *entry, const char *item), void *data) EINA_ARG_NONNULL(1, 2);
10910 * Append a filter function for text inserted in the entry
10912 * Append the given callback to the list. This functions will be called
10913 * whenever any text is inserted into the entry, with the text to be inserted
10914 * as a parameter. The callback function is free to alter the text in any way
10915 * it wants, but it must remember to free the given pointer and update it.
10916 * If the new text is to be discarded, the function can free it and set its
10917 * text parameter to NULL. This will also prevent any following filters from
10920 * @param obj The entry object
10921 * @param func The function to use as text filter
10922 * @param data User data to pass to @p func
10924 EAPI void elm_entry_text_filter_append(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
10926 * Prepend a filter function for text insdrted in the entry
10928 * Prepend the given callback to the list. See elm_entry_text_filter_append()
10929 * for more information
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_prepend(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
10937 * Remove a filter from the list
10939 * Removes the given callback from the filter list. See
10940 * elm_entry_text_filter_append() for more information.
10942 * @param obj The entry object
10943 * @param func The filter function to remove
10944 * @param data The user data passed when adding the function
10946 EAPI void elm_entry_text_filter_remove(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
10948 * This converts a markup (HTML-like) string into UTF-8.
10950 * The returned string is a malloc'ed buffer and it should be freed when
10951 * not needed anymore.
10953 * @param s The string (in markup) to be converted
10954 * @return The converted string (in UTF-8). It should be freed.
10956 EAPI char *elm_entry_markup_to_utf8(const char *s) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
10958 * This converts a UTF-8 string into markup (HTML-like).
10960 * The returned string is a malloc'ed buffer and it should be freed when
10961 * not needed anymore.
10963 * @param s The string (in UTF-8) to be converted
10964 * @return The converted string (in markup). It should be freed.
10966 EAPI char *elm_entry_utf8_to_markup(const char *s) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
10968 * This sets the file (and implicitly loads it) for the text to display and
10969 * then edit. All changes are written back to the file after a short delay if
10970 * the entry object is set to autosave (which is the default).
10972 * If the entry had any other file set previously, any changes made to it
10973 * will be saved if the autosave feature is enabled, otherwise, the file
10974 * will be silently discarded and any non-saved changes will be lost.
10976 * @param obj The entry object
10977 * @param file The path to the file to load and save
10978 * @param format The file format
10980 EAPI void elm_entry_file_set(Evas_Object *obj, const char *file, Elm_Text_Format format) EINA_ARG_NONNULL(1);
10982 * Gets the file being edited by the entry.
10984 * This function can be used to retrieve any file set on the entry for
10985 * edition, along with the format used to load and save it.
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_get(const Evas_Object *obj, const char **file, Elm_Text_Format *format) EINA_ARG_NONNULL(1);
10993 * This function writes any changes made to the file set with
10994 * elm_entry_file_set()
10996 * @param obj The entry object
10998 EAPI void elm_entry_file_save(Evas_Object *obj) EINA_ARG_NONNULL(1);
11000 * This sets the entry object to 'autosave' the loaded text file or not.
11002 * @param obj The entry object
11003 * @param autosave Autosave the loaded file or not
11005 * @see elm_entry_file_set()
11007 EAPI void elm_entry_autosave_set(Evas_Object *obj, Eina_Bool autosave) EINA_ARG_NONNULL(1);
11009 * This gets the entry object's 'autosave' status.
11011 * @param obj The entry object
11012 * @return Autosave the loaded file or not
11014 * @see elm_entry_file_set()
11016 EAPI Eina_Bool elm_entry_autosave_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11018 * Control pasting of text and images for the widget.
11020 * Normally the entry allows both text and images to be pasted. By setting
11021 * textonly to be true, this prevents images from being pasted.
11023 * Note this only changes the behaviour of text.
11025 * @param obj The entry object
11026 * @param textonly paste mode - EINA_TRUE is text only, EINA_FALSE is
11027 * text+image+other.
11029 EAPI void elm_entry_cnp_textonly_set(Evas_Object *obj, Eina_Bool textonly) EINA_ARG_NONNULL(1);
11031 * Getting elm_entry text paste/drop mode.
11033 * In textonly mode, only text may be pasted or dropped into the widget.
11035 * @param obj The entry object
11036 * @return If the widget only accepts text from pastes.
11038 EAPI Eina_Bool elm_entry_cnp_textonly_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11040 * Enable or disable scrolling in entry
11042 * Normally the entry is not scrollable unless you enable it with this call.
11044 * @param obj The entry object
11045 * @param scroll EINA_TRUE if it is to be scrollable, EINA_FALSE otherwise
11047 EAPI void elm_entry_scrollable_set(Evas_Object *obj, Eina_Bool scroll);
11049 * Get the scrollable state of the entry
11051 * Normally the entry is not scrollable. This gets the scrollable state
11052 * of the entry. See elm_entry_scrollable_set() for more information.
11054 * @param obj The entry object
11055 * @return The scrollable state
11057 EAPI Eina_Bool elm_entry_scrollable_get(const Evas_Object *obj);
11059 * This sets a widget to be displayed to the left of a scrolled entry.
11061 * @param obj The scrolled entry object
11062 * @param icon The widget to display on the left side of the scrolled
11065 * @note A previously set widget will be destroyed.
11066 * @note If the object being set does not have minimum size hints set,
11067 * it won't get properly displayed.
11069 * @see elm_entry_end_set()
11071 EAPI void elm_entry_icon_set(Evas_Object *obj, Evas_Object *icon);
11073 * Gets the leftmost widget of the scrolled entry. This object is
11074 * owned by the scrolled entry and should not be modified.
11076 * @param obj The scrolled entry object
11077 * @return the left widget inside the scroller
11079 EAPI Evas_Object *elm_entry_icon_get(const Evas_Object *obj);
11081 * Unset the leftmost widget of the scrolled entry, unparenting and
11084 * @param obj The scrolled entry object
11085 * @return the previously set icon sub-object of this entry, on
11088 * @see elm_entry_icon_set()
11090 EAPI Evas_Object *elm_entry_icon_unset(Evas_Object *obj);
11092 * Sets the visibility of the left-side widget of the scrolled entry,
11093 * set by elm_entry_icon_set().
11095 * @param obj The scrolled entry object
11096 * @param setting EINA_TRUE if the object should be displayed,
11097 * EINA_FALSE if not.
11099 EAPI void elm_entry_icon_visible_set(Evas_Object *obj, Eina_Bool setting);
11101 * This sets a widget to be displayed to the end of a scrolled entry.
11103 * @param obj The scrolled entry object
11104 * @param end The widget to display on the right side of the scrolled
11107 * @note A previously set widget will be destroyed.
11108 * @note If the object being set does not have minimum size hints set,
11109 * it won't get properly displayed.
11111 * @see elm_entry_icon_set
11113 EAPI void elm_entry_end_set(Evas_Object *obj, Evas_Object *end);
11115 * Gets the endmost widget of the scrolled entry. This object is owned
11116 * by the scrolled entry and should not be modified.
11118 * @param obj The scrolled entry object
11119 * @return the right widget inside the scroller
11121 EAPI Evas_Object *elm_entry_end_get(const Evas_Object *obj);
11123 * Unset the endmost widget of the scrolled entry, unparenting and
11126 * @param obj The scrolled entry object
11127 * @return the previously set icon sub-object of this entry, on
11130 * @see elm_entry_icon_set()
11132 EAPI Evas_Object *elm_entry_end_unset(Evas_Object *obj);
11134 * Sets the visibility of the end widget of the scrolled entry, set by
11135 * elm_entry_end_set().
11137 * @param obj The scrolled entry object
11138 * @param setting EINA_TRUE if the object should be displayed,
11139 * EINA_FALSE if not.
11141 EAPI void elm_entry_end_visible_set(Evas_Object *obj, Eina_Bool setting);
11143 * This sets the scrolled entry's scrollbar policy (ie. enabling/disabling
11146 * Setting an entry to single-line mode with elm_entry_single_line_set()
11147 * will automatically disable the display of scrollbars when the entry
11148 * moves inside its scroller.
11150 * @param obj The scrolled entry object
11151 * @param h The horizontal scrollbar policy to apply
11152 * @param v The vertical scrollbar policy to apply
11154 EAPI void elm_entry_scrollbar_policy_set(Evas_Object *obj, Elm_Scroller_Policy h, Elm_Scroller_Policy v);
11156 * This enables/disables bouncing within the entry.
11158 * This function sets whether the entry will bounce when scrolling reaches
11159 * the end of the contained entry.
11161 * @param obj The scrolled entry object
11162 * @param h The horizontal bounce state
11163 * @param v The vertical bounce state
11165 EAPI void elm_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce);
11167 * Get the bounce mode
11169 * @param obj The Entry object
11170 * @param h_bounce Allow bounce horizontally
11171 * @param v_bounce Allow bounce vertically
11173 EAPI void elm_entry_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce);
11175 /* pre-made filters for entries */
11177 * @typedef Elm_Entry_Filter_Limit_Size
11179 * Data for the elm_entry_filter_limit_size() entry filter.
11181 typedef struct _Elm_Entry_Filter_Limit_Size Elm_Entry_Filter_Limit_Size;
11183 * @struct _Elm_Entry_Filter_Limit_Size
11185 * Data for the elm_entry_filter_limit_size() entry filter.
11187 struct _Elm_Entry_Filter_Limit_Size
11189 int max_char_count; /**< The maximum number of characters allowed. */
11190 int max_byte_count; /**< The maximum number of bytes allowed*/
11193 * Filter inserted text based on user defined character and byte limits
11195 * Add this filter to an entry to limit the characters that it will accept
11196 * based the the contents of the provided #Elm_Entry_Filter_Limit_Size.
11197 * The funtion works on the UTF-8 representation of the string, converting
11198 * it from the set markup, thus not accounting for any format in it.
11200 * The user must create an #Elm_Entry_Filter_Limit_Size structure and pass
11201 * it as data when setting the filter. In it, it's possible to set limits
11202 * by character count or bytes (any of them is disabled if 0), and both can
11203 * be set at the same time. In that case, it first checks for characters,
11206 * The function will cut the inserted text in order to allow only the first
11207 * number of characters that are still allowed. The cut is made in
11208 * characters, even when limiting by bytes, in order to always contain
11209 * valid ones and avoid half unicode characters making it in.
11211 * This filter, like any others, does not apply when setting the entry text
11212 * directly with elm_object_text_set() (or the deprecated
11213 * elm_entry_entry_set()).
11215 EAPI void elm_entry_filter_limit_size(void *data, Evas_Object *entry, char **text) EINA_ARG_NONNULL(1, 2, 3);
11217 * @typedef Elm_Entry_Filter_Accept_Set
11219 * Data for the elm_entry_filter_accept_set() entry filter.
11221 typedef struct _Elm_Entry_Filter_Accept_Set Elm_Entry_Filter_Accept_Set;
11223 * @struct _Elm_Entry_Filter_Accept_Set
11225 * Data for the elm_entry_filter_accept_set() entry filter.
11227 struct _Elm_Entry_Filter_Accept_Set
11229 const char *accepted; /**< Set of characters accepted in the entry. */
11230 const char *rejected; /**< Set of characters rejected from the entry. */
11233 * Filter inserted text based on accepted or rejected sets of characters
11235 * Add this filter to an entry to restrict the set of accepted characters
11236 * based on the sets in the provided #Elm_Entry_Filter_Accept_Set.
11237 * This structure contains both accepted and rejected sets, but they are
11238 * mutually exclusive.
11240 * The @c accepted set takes preference, so if it is set, the filter will
11241 * only work based on the accepted characters, ignoring anything in the
11242 * @c rejected value. If @c accepted is @c NULL, then @c rejected is used.
11244 * In both cases, the function filters by matching utf8 characters to the
11245 * raw markup text, so it can be used to remove formatting tags.
11247 * This filter, like any others, does not apply when setting the entry text
11248 * directly with elm_object_text_set() (or the deprecated
11249 * elm_entry_entry_set()).
11251 EAPI void elm_entry_filter_accept_set(void *data, Evas_Object *entry, char **text) EINA_ARG_NONNULL(1, 3);
11256 /* composite widgets - these basically put together basic widgets above
11257 * in convenient packages that do more than basic stuff */
11261 * @defgroup Anchorview Anchorview
11263 * @image html img/widget/anchorview/preview-00.png
11264 * @image latex img/widget/anchorview/preview-00.eps
11266 * Anchorview is for displaying text that contains markup with anchors
11267 * like <c>\<a href=1234\>something\</\></c> in it.
11269 * Besides being styled differently, the anchorview widget provides the
11270 * necessary functionality so that clicking on these anchors brings up a
11271 * popup with user defined content such as "call", "add to contacts" or
11272 * "open web page". This popup is provided using the @ref Hover widget.
11274 * This widget is very similar to @ref Anchorblock, so refer to that
11275 * widget for an example. The only difference Anchorview has is that the
11276 * widget is already provided with scrolling functionality, so if the
11277 * text set to it is too large to fit in the given space, it will scroll,
11278 * whereas the @ref Anchorblock widget will keep growing to ensure all the
11279 * text can be displayed.
11281 * This widget emits the following signals:
11282 * @li "anchor,clicked": will be called when an anchor is clicked. The
11283 * @p event_info parameter on the callback will be a pointer of type
11284 * ::Elm_Entry_Anchorview_Info.
11286 * See @ref Anchorblock for an example on how to use both of them.
11295 * @typedef Elm_Entry_Anchorview_Info
11297 * The info sent in the callback for "anchor,clicked" signals emitted by
11298 * the Anchorview widget.
11300 typedef struct _Elm_Entry_Anchorview_Info Elm_Entry_Anchorview_Info;
11302 * @struct _Elm_Entry_Anchorview_Info
11304 * The info sent in the callback for "anchor,clicked" signals emitted by
11305 * the Anchorview widget.
11307 struct _Elm_Entry_Anchorview_Info
11309 const char *name; /**< Name of the anchor, as indicated in its href
11311 int button; /**< The mouse button used to click on it */
11312 Evas_Object *hover; /**< The hover object to use for the popup */
11314 Evas_Coord x, y, w, h;
11315 } anchor, /**< Geometry selection of text used as anchor */
11316 hover_parent; /**< Geometry of the object used as parent by the
11318 Eina_Bool hover_left : 1; /**< Hint indicating if there's space
11319 for content on the left side of
11320 the hover. Before calling the
11321 callback, the widget will make the
11322 necessary calculations to check
11323 which sides are fit to be set with
11324 content, based on the position the
11325 hover is activated and its distance
11326 to the edges of its parent object
11328 Eina_Bool hover_right : 1; /**< Hint indicating content fits on
11329 the right side of the hover.
11330 See @ref hover_left */
11331 Eina_Bool hover_top : 1; /**< Hint indicating content fits on top
11332 of the hover. See @ref hover_left */
11333 Eina_Bool hover_bottom : 1; /**< Hint indicating content fits
11334 below the hover. See @ref
11338 * Add a new Anchorview object
11340 * @param parent The parent object
11341 * @return The new object or NULL if it cannot be created
11343 EAPI Evas_Object *elm_anchorview_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
11345 * Set the text to show in the anchorview
11347 * Sets the text of the anchorview to @p text. This text can include markup
11348 * format tags, including <c>\<a href=anchorname\></c> to begin a segment of
11349 * text that will be specially styled and react to click events, ended with
11350 * either of \</a\> or \</\>. When clicked, the anchor will emit an
11351 * "anchor,clicked" signal that you can attach a callback to with
11352 * evas_object_smart_callback_add(). The name of the anchor given in the
11353 * event info struct will be the one set in the href attribute, in this
11354 * case, anchorname.
11356 * Other markup can be used to style the text in different ways, but it's
11357 * up to the style defined in the theme which tags do what.
11358 * @deprecated use elm_object_text_set() instead.
11360 EINA_DEPRECATED EAPI void elm_anchorview_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1);
11362 * Get the markup text set for the anchorview
11364 * Retrieves the text set on the anchorview, with markup tags included.
11366 * @param obj The anchorview object
11367 * @return The markup text set or @c NULL if nothing was set or an error
11369 * @deprecated use elm_object_text_set() instead.
11371 EINA_DEPRECATED EAPI const char *elm_anchorview_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11373 * Set the parent of the hover popup
11375 * Sets the parent object to use by the hover created by the anchorview
11376 * when an anchor is clicked. See @ref Hover for more details on this.
11377 * If no parent is set, the same anchorview object will be used.
11379 * @param obj The anchorview object
11380 * @param parent The object to use as parent for the hover
11382 EAPI void elm_anchorview_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
11384 * Get the parent of the hover popup
11386 * Get the object used as parent for the hover created by the anchorview
11387 * widget. See @ref Hover for more details on this.
11389 * @param obj The anchorview object
11390 * @return The object used as parent for the hover, NULL if none is set.
11392 EAPI Evas_Object *elm_anchorview_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11394 * Set the style that the hover should use
11396 * When creating the popup hover, anchorview will request that it's
11397 * themed according to @p style.
11399 * @param obj The anchorview object
11400 * @param style The style to use for the underlying hover
11402 * @see elm_object_style_set()
11404 EAPI void elm_anchorview_hover_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
11406 * Get the style that the hover should use
11408 * Get the style the hover created by anchorview will use.
11410 * @param obj The anchorview object
11411 * @return The style to use by the hover. NULL means the default is used.
11413 * @see elm_object_style_set()
11415 EAPI const char *elm_anchorview_hover_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11417 * Ends the hover popup in the anchorview
11419 * When an anchor is clicked, the anchorview widget will create a hover
11420 * object to use as a popup with user provided content. This function
11421 * terminates this popup, returning the anchorview to its normal state.
11423 * @param obj The anchorview object
11425 EAPI void elm_anchorview_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
11427 * Set bouncing behaviour when the scrolled content reaches an edge
11429 * Tell the internal scroller object whether it should bounce or not
11430 * when it reaches the respective edges for each axis.
11432 * @param obj The anchorview object
11433 * @param h_bounce Whether to bounce or not in the horizontal axis
11434 * @param v_bounce Whether to bounce or not in the vertical axis
11436 * @see elm_scroller_bounce_set()
11438 EAPI void elm_anchorview_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
11440 * Get the set bouncing behaviour of the internal scroller
11442 * Get whether the internal scroller should bounce when the edge of each
11443 * axis is reached scrolling.
11445 * @param obj The anchorview object
11446 * @param h_bounce Pointer where to store the bounce state of the horizontal
11448 * @param v_bounce Pointer where to store the bounce state of the vertical
11451 * @see elm_scroller_bounce_get()
11453 EAPI void elm_anchorview_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
11455 * Appends a custom item provider to the given anchorview
11457 * Appends the given function to the list of items providers. This list is
11458 * called, one function at a time, with the given @p data pointer, the
11459 * anchorview object and, in the @p item parameter, the item name as
11460 * referenced in its href string. Following functions in the list will be
11461 * called in order until one of them returns something different to NULL,
11462 * which should be an Evas_Object which will be used in place of the item
11465 * Items in the markup text take the form \<item relsize=16x16 vsize=full
11466 * href=item/name\>\</item\>
11468 * @param obj The anchorview object
11469 * @param func The function to add to the list of providers
11470 * @param data User data that will be passed to the callback function
11472 * @see elm_entry_item_provider_append()
11474 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);
11476 * Prepend a custom item provider to the given anchorview
11478 * Like elm_anchorview_item_provider_append(), but it adds the function
11479 * @p func to the beginning of the list, instead of the end.
11481 * @param obj The anchorview object
11482 * @param func The function to add to the list of providers
11483 * @param data User data that will be passed to the callback function
11485 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);
11487 * Remove a custom item provider from the list of the given anchorview
11489 * Removes the function and data pairing that matches @p func and @p data.
11490 * That is, unless the same function and same user data are given, the
11491 * function will not be removed from the list. This allows us to add the
11492 * same callback several times, with different @p data pointers and be
11493 * able to remove them later without conflicts.
11495 * @param obj The anchorview object
11496 * @param func The function to remove from the list
11497 * @param data The data matching the function to remove from the list
11499 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);
11506 * @defgroup Anchorblock Anchorblock
11508 * @image html img/widget/anchorblock/preview-00.png
11509 * @image latex img/widget/anchorblock/preview-00.eps
11511 * Anchorblock is for displaying text that contains markup with anchors
11512 * like <c>\<a href=1234\>something\</\></c> in it.
11514 * Besides being styled differently, the anchorblock widget provides the
11515 * necessary functionality so that clicking on these anchors brings up a
11516 * popup with user defined content such as "call", "add to contacts" or
11517 * "open web page". This popup is provided using the @ref Hover widget.
11519 * This widget emits the following signals:
11520 * @li "anchor,clicked": will be called when an anchor is clicked. The
11521 * @p event_info parameter on the callback will be a pointer of type
11522 * ::Elm_Entry_Anchorblock_Info.
11528 * Since examples are usually better than plain words, we might as well
11529 * try @ref tutorial_anchorblock_example "one".
11532 * @addtogroup Anchorblock
11536 * @typedef Elm_Entry_Anchorblock_Info
11538 * The info sent in the callback for "anchor,clicked" signals emitted by
11539 * the Anchorblock widget.
11541 typedef struct _Elm_Entry_Anchorblock_Info Elm_Entry_Anchorblock_Info;
11543 * @struct _Elm_Entry_Anchorblock_Info
11545 * The info sent in the callback for "anchor,clicked" signals emitted by
11546 * the Anchorblock widget.
11548 struct _Elm_Entry_Anchorblock_Info
11550 const char *name; /**< Name of the anchor, as indicated in its href
11552 int button; /**< The mouse button used to click on it */
11553 Evas_Object *hover; /**< The hover object to use for the popup */
11555 Evas_Coord x, y, w, h;
11556 } anchor, /**< Geometry selection of text used as anchor */
11557 hover_parent; /**< Geometry of the object used as parent by the
11559 Eina_Bool hover_left : 1; /**< Hint indicating if there's space
11560 for content on the left side of
11561 the hover. Before calling the
11562 callback, the widget will make the
11563 necessary calculations to check
11564 which sides are fit to be set with
11565 content, based on the position the
11566 hover is activated and its distance
11567 to the edges of its parent object
11569 Eina_Bool hover_right : 1; /**< Hint indicating content fits on
11570 the right side of the hover.
11571 See @ref hover_left */
11572 Eina_Bool hover_top : 1; /**< Hint indicating content fits on top
11573 of the hover. See @ref hover_left */
11574 Eina_Bool hover_bottom : 1; /**< Hint indicating content fits
11575 below the hover. See @ref
11579 * Add a new Anchorblock object
11581 * @param parent The parent object
11582 * @return The new object or NULL if it cannot be created
11584 EAPI Evas_Object *elm_anchorblock_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
11586 * Set the text to show in the anchorblock
11588 * Sets the text of the anchorblock to @p text. This text can include markup
11589 * format tags, including <c>\<a href=anchorname\></a></c> to begin a segment
11590 * of text that will be specially styled and react to click events, ended
11591 * with either of \</a\> or \</\>. When clicked, the anchor will emit an
11592 * "anchor,clicked" signal that you can attach a callback to with
11593 * evas_object_smart_callback_add(). The name of the anchor given in the
11594 * event info struct will be the one set in the href attribute, in this
11595 * case, anchorname.
11597 * Other markup can be used to style the text in different ways, but it's
11598 * up to the style defined in the theme which tags do what.
11599 * @deprecated use elm_object_text_set() instead.
11601 EINA_DEPRECATED EAPI void elm_anchorblock_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1);
11603 * Get the markup text set for the anchorblock
11605 * Retrieves the text set on the anchorblock, with markup tags included.
11607 * @param obj The anchorblock object
11608 * @return The markup text set or @c NULL if nothing was set or an error
11610 * @deprecated use elm_object_text_set() instead.
11612 EINA_DEPRECATED EAPI const char *elm_anchorblock_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11614 * Set the parent of the hover popup
11616 * Sets the parent object to use by the hover created by the anchorblock
11617 * when an anchor is clicked. See @ref Hover for more details on this.
11619 * @param obj The anchorblock object
11620 * @param parent The object to use as parent for the hover
11622 EAPI void elm_anchorblock_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
11624 * Get the parent of the hover popup
11626 * Get the object used as parent for the hover created by the anchorblock
11627 * widget. See @ref Hover for more details on this.
11628 * If no parent is set, the same anchorblock object will be used.
11630 * @param obj The anchorblock object
11631 * @return The object used as parent for the hover, NULL if none is set.
11633 EAPI Evas_Object *elm_anchorblock_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11635 * Set the style that the hover should use
11637 * When creating the popup hover, anchorblock will request that it's
11638 * themed according to @p style.
11640 * @param obj The anchorblock object
11641 * @param style The style to use for the underlying hover
11643 * @see elm_object_style_set()
11645 EAPI void elm_anchorblock_hover_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
11647 * Get the style that the hover should use
11649 * Get the style the hover created by anchorblock will use.
11651 * @param obj The anchorblock object
11652 * @return The style to use by the hover. NULL means the default is used.
11654 * @see elm_object_style_set()
11656 EAPI const char *elm_anchorblock_hover_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11658 * Ends the hover popup in the anchorblock
11660 * When an anchor is clicked, the anchorblock widget will create a hover
11661 * object to use as a popup with user provided content. This function
11662 * terminates this popup, returning the anchorblock to its normal state.
11664 * @param obj The anchorblock object
11666 EAPI void elm_anchorblock_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
11668 * Appends a custom item provider to the given anchorblock
11670 * Appends the given function to the list of items providers. This list is
11671 * called, one function at a time, with the given @p data pointer, the
11672 * anchorblock object and, in the @p item parameter, the item name as
11673 * referenced in its href string. Following functions in the list will be
11674 * called in order until one of them returns something different to NULL,
11675 * which should be an Evas_Object which will be used in place of the item
11678 * Items in the markup text take the form \<item relsize=16x16 vsize=full
11679 * href=item/name\>\</item\>
11681 * @param obj The anchorblock object
11682 * @param func The function to add to the list of providers
11683 * @param data User data that will be passed to the callback function
11685 * @see elm_entry_item_provider_append()
11687 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);
11689 * Prepend a custom item provider to the given anchorblock
11691 * Like elm_anchorblock_item_provider_append(), but it adds the function
11692 * @p func to the beginning of the list, instead of the end.
11694 * @param obj The anchorblock object
11695 * @param func The function to add to the list of providers
11696 * @param data User data that will be passed to the callback function
11698 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);
11700 * Remove a custom item provider from the list of the given anchorblock
11702 * Removes the function and data pairing that matches @p func and @p data.
11703 * That is, unless the same function and same user data are given, the
11704 * function will not be removed from the list. This allows us to add the
11705 * same callback several times, with different @p data pointers and be
11706 * able to remove them later without conflicts.
11708 * @param obj The anchorblock object
11709 * @param func The function to remove from the list
11710 * @param data The data matching the function to remove from the list
11712 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);
11718 * @defgroup Bubble Bubble
11720 * @image html img/widget/bubble/preview-00.png
11721 * @image latex img/widget/bubble/preview-00.eps
11722 * @image html img/widget/bubble/preview-01.png
11723 * @image latex img/widget/bubble/preview-01.eps
11724 * @image html img/widget/bubble/preview-02.png
11725 * @image latex img/widget/bubble/preview-02.eps
11727 * @brief The Bubble is a widget to show text similarly to how speech is
11728 * represented in comics.
11730 * The bubble widget contains 5 important visual elements:
11731 * @li The frame is a rectangle with rounded rectangles and an "arrow".
11732 * @li The @p icon is an image to which the frame's arrow points to.
11733 * @li The @p label is a text which appears to the right of the icon if the
11734 * corner is "top_left" or "bottom_left" and is right aligned to the frame
11736 * @li The @p info is a text which appears to the right of the label. Info's
11737 * font is of a ligther color than label.
11738 * @li The @p content is an evas object that is shown inside the frame.
11740 * The position of the arrow, icon, label and info depends on which corner is
11741 * selected. The four available corners are:
11742 * @li "top_left" - Default
11744 * @li "bottom_left"
11745 * @li "bottom_right"
11747 * Signals that you can add callbacks for are:
11748 * @li "clicked" - This is called when a user has clicked the bubble.
11750 * For an example of using a buble see @ref bubble_01_example_page "this".
11755 * Add a new bubble to the parent
11757 * @param parent The parent object
11758 * @return The new object or NULL if it cannot be created
11760 * This function adds a text bubble to the given parent evas object.
11762 EAPI Evas_Object *elm_bubble_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
11764 * Set the label of the bubble
11766 * @param obj The bubble object
11767 * @param label The string to set in the label
11769 * This function sets the title of the bubble. Where this appears depends on
11770 * the selected corner.
11771 * @deprecated use elm_object_text_set() instead.
11773 EINA_DEPRECATED EAPI void elm_bubble_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
11775 * Get the label of the bubble
11777 * @param obj The bubble object
11778 * @return The string of set in the label
11780 * This function gets the title of the bubble.
11781 * @deprecated use elm_object_text_get() instead.
11783 EINA_DEPRECATED EAPI const char *elm_bubble_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11785 * Set the info of the bubble
11787 * @param obj The bubble object
11788 * @param info The given info about the bubble
11790 * This function sets the info of the bubble. Where this appears depends on
11791 * the selected corner.
11792 * @deprecated use elm_object_text_part_set() instead. (with "info" as the parameter).
11794 EINA_DEPRECATED EAPI void elm_bubble_info_set(Evas_Object *obj, const char *info) EINA_ARG_NONNULL(1);
11796 * Get the info of the bubble
11798 * @param obj The bubble object
11800 * @return The "info" string of the bubble
11802 * This function gets the info text.
11803 * @deprecated use elm_object_text_part_get() instead. (with "info" as the parameter).
11805 EINA_DEPRECATED EAPI const char *elm_bubble_info_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11807 * Set the content to be shown in the bubble
11809 * Once the content object is set, a previously set one will be deleted.
11810 * If you want to keep the old content object, use the
11811 * elm_bubble_content_unset() function.
11813 * @param obj The bubble object
11814 * @param content The given content of the bubble
11816 * This function sets the content shown on the middle of the bubble.
11818 EAPI void elm_bubble_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
11820 * Get the content shown in the bubble
11822 * Return the content object which is set for this widget.
11824 * @param obj The bubble object
11825 * @return The content that is being used
11827 EAPI Evas_Object *elm_bubble_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11829 * Unset the content shown in the bubble
11831 * Unparent and return the content object which was set for this widget.
11833 * @param obj The bubble object
11834 * @return The content that was being used
11836 EAPI Evas_Object *elm_bubble_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
11838 * Set the icon of the bubble
11840 * Once the icon object is set, a previously set one will be deleted.
11841 * If you want to keep the old content object, use the
11842 * elm_icon_content_unset() function.
11844 * @param obj The bubble object
11845 * @param icon The given icon for the bubble
11847 EAPI void elm_bubble_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
11849 * Get the icon of the bubble
11851 * @param obj The bubble object
11852 * @return The icon for the bubble
11854 * This function gets the icon shown on the top left of bubble.
11856 EAPI Evas_Object *elm_bubble_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11858 * Unset the icon of the bubble
11860 * Unparent and return the icon object which was set for this widget.
11862 * @param obj The bubble object
11863 * @return The icon that was being used
11865 EAPI Evas_Object *elm_bubble_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
11867 * Set the corner of the bubble
11869 * @param obj The bubble object.
11870 * @param corner The given corner for the bubble.
11872 * This function sets the corner of the bubble. The corner will be used to
11873 * determine where the arrow in the frame points to and where label, icon and
11876 * Possible values for corner are:
11877 * @li "top_left" - Default
11879 * @li "bottom_left"
11880 * @li "bottom_right"
11882 EAPI void elm_bubble_corner_set(Evas_Object *obj, const char *corner) EINA_ARG_NONNULL(1, 2);
11884 * Get the corner of the bubble
11886 * @param obj The bubble object.
11887 * @return The given corner for the bubble.
11889 * This function gets the selected corner of the bubble.
11891 EAPI const char *elm_bubble_corner_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11897 * @defgroup Photo Photo
11899 * For displaying the photo of a person (contact). Simple yet
11900 * with a very specific purpose.
11902 * Signals that you can add callbacks for are:
11904 * "clicked" - This is called when a user has clicked the photo
11905 * "drag,start" - Someone started dragging the image out of the object
11906 * "drag,end" - Dragged item was dropped (somewhere)
11912 * Add a new photo to the parent
11914 * @param parent The parent object
11915 * @return The new object or NULL if it cannot be created
11919 EAPI Evas_Object *elm_photo_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
11922 * Set the file that will be used as photo
11924 * @param obj The photo object
11925 * @param file The path to file that will be used as photo
11927 * @return (1 = success, 0 = error)
11931 EAPI Eina_Bool elm_photo_file_set(Evas_Object *obj, const char *file) EINA_ARG_NONNULL(1);
11934 * Set the size that will be used on the photo
11936 * @param obj The photo object
11937 * @param size The size that the photo will be
11941 EAPI void elm_photo_size_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
11944 * Set if the photo should be completely visible or not.
11946 * @param obj The photo object
11947 * @param fill if true the photo will be completely visible
11951 EAPI void elm_photo_fill_inside_set(Evas_Object *obj, Eina_Bool fill) EINA_ARG_NONNULL(1);
11954 * Set editability of the photo.
11956 * An editable photo can be dragged to or from, and can be cut or
11957 * pasted too. Note that pasting an image or dropping an item on
11958 * the image will delete the existing content.
11960 * @param obj The photo object.
11961 * @param set To set of clear editablity.
11963 EAPI void elm_photo_editable_set(Evas_Object *obj, Eina_Bool set) EINA_ARG_NONNULL(1);
11969 /* gesture layer */
11971 * @defgroup Elm_Gesture_Layer Gesture Layer
11972 * Gesture Layer Usage:
11974 * Use Gesture Layer to detect gestures.
11975 * The advantage is that you don't have to implement
11976 * gesture detection, just set callbacks of gesture state.
11977 * By using gesture layer we make standard interface.
11979 * In order to use Gesture Layer you start with @ref elm_gesture_layer_add
11980 * with a parent object parameter.
11981 * Next 'activate' gesture layer with a @ref elm_gesture_layer_attach
11982 * call. Usually with same object as target (2nd parameter).
11984 * Now you need to tell gesture layer what gestures you follow.
11985 * This is done with @ref elm_gesture_layer_cb_set call.
11986 * By setting the callback you actually saying to gesture layer:
11987 * I would like to know when the gesture @ref Elm_Gesture_Types
11988 * switches to state @ref Elm_Gesture_State.
11990 * Next, you need to implement the actual action that follows the input
11991 * in your callback.
11993 * Note that if you like to stop being reported about a gesture, just set
11994 * all callbacks referring this gesture to NULL.
11995 * (again with @ref elm_gesture_layer_cb_set)
11997 * The information reported by gesture layer to your callback is depending
11998 * on @ref Elm_Gesture_Types:
11999 * @ref Elm_Gesture_Taps_Info is the info reported for tap gestures:
12000 * @ref ELM_GESTURE_N_TAPS, @ref ELM_GESTURE_N_LONG_TAPS,
12001 * @ref ELM_GESTURE_N_DOUBLE_TAPS, @ref ELM_GESTURE_N_TRIPLE_TAPS.
12003 * @ref Elm_Gesture_Momentum_Info is info reported for momentum gestures:
12004 * @ref ELM_GESTURE_MOMENTUM.
12006 * @ref Elm_Gesture_Line_Info is the info reported for line gestures:
12007 * (this also contains @ref Elm_Gesture_Momentum_Info internal structure)
12008 * @ref ELM_GESTURE_N_LINES, @ref ELM_GESTURE_N_FLICKS.
12009 * Note that we consider a flick as a line-gesture that should be completed
12010 * in flick-time-limit as defined in @ref Config.
12012 * @ref Elm_Gesture_Zoom_Info is the info reported for @ref ELM_GESTURE_ZOOM gesture.
12014 * @ref Elm_Gesture_Rotate_Info is the info reported for @ref ELM_GESTURE_ROTATE gesture.
12018 * @enum _Elm_Gesture_Types
12019 * Enum of supported gesture types.
12020 * @ingroup Elm_Gesture_Layer
12022 enum _Elm_Gesture_Types
12024 ELM_GESTURE_FIRST = 0,
12026 ELM_GESTURE_N_TAPS, /**< N fingers single taps */
12027 ELM_GESTURE_N_LONG_TAPS, /**< N fingers single long-taps */
12028 ELM_GESTURE_N_DOUBLE_TAPS, /**< N fingers double-single taps */
12029 ELM_GESTURE_N_TRIPLE_TAPS, /**< N fingers triple-single taps */
12031 ELM_GESTURE_MOMENTUM, /**< Reports momentum in the dircetion of move */
12033 ELM_GESTURE_N_LINES, /**< N fingers line gesture */
12034 ELM_GESTURE_N_FLICKS, /**< N fingers flick gesture */
12036 ELM_GESTURE_ZOOM, /**< Zoom */
12037 ELM_GESTURE_ROTATE, /**< Rotate */
12043 * @typedef Elm_Gesture_Types
12044 * gesture types enum
12045 * @ingroup Elm_Gesture_Layer
12047 typedef enum _Elm_Gesture_Types Elm_Gesture_Types;
12050 * @enum _Elm_Gesture_State
12051 * Enum of gesture states.
12052 * @ingroup Elm_Gesture_Layer
12054 enum _Elm_Gesture_State
12056 ELM_GESTURE_STATE_UNDEFINED = -1, /**< Gesture not STARTed */
12057 ELM_GESTURE_STATE_START, /**< Gesture STARTed */
12058 ELM_GESTURE_STATE_MOVE, /**< Gesture is ongoing */
12059 ELM_GESTURE_STATE_END, /**< Gesture completed */
12060 ELM_GESTURE_STATE_ABORT /**< Onging gesture was ABORTed */
12064 * @typedef Elm_Gesture_State
12065 * gesture states enum
12066 * @ingroup Elm_Gesture_Layer
12068 typedef enum _Elm_Gesture_State Elm_Gesture_State;
12071 * @struct _Elm_Gesture_Taps_Info
12072 * Struct holds taps info for user
12073 * @ingroup Elm_Gesture_Layer
12075 struct _Elm_Gesture_Taps_Info
12077 Evas_Coord x, y; /**< Holds center point between fingers */
12078 unsigned int n; /**< Number of fingers tapped */
12079 unsigned int timestamp; /**< event timestamp */
12083 * @typedef Elm_Gesture_Taps_Info
12084 * holds taps info for user
12085 * @ingroup Elm_Gesture_Layer
12087 typedef struct _Elm_Gesture_Taps_Info Elm_Gesture_Taps_Info;
12090 * @struct _Elm_Gesture_Momentum_Info
12091 * Struct holds momentum info for user
12092 * x1 and y1 are not necessarily in sync
12093 * x1 holds x value of x direction starting point
12094 * and same holds for y1.
12095 * This is noticeable when doing V-shape movement
12096 * @ingroup Elm_Gesture_Layer
12098 struct _Elm_Gesture_Momentum_Info
12099 { /* Report line ends, timestamps, and momentum computed */
12100 Evas_Coord x1; /**< Final-swipe direction starting point on X */
12101 Evas_Coord y1; /**< Final-swipe direction starting point on Y */
12102 Evas_Coord x2; /**< Final-swipe direction ending point on X */
12103 Evas_Coord y2; /**< Final-swipe direction ending point on Y */
12105 unsigned int tx; /**< Timestamp of start of final x-swipe */
12106 unsigned int ty; /**< Timestamp of start of final y-swipe */
12108 Evas_Coord mx; /**< Momentum on X */
12109 Evas_Coord my; /**< Momentum on Y */
12113 * @typedef Elm_Gesture_Momentum_Info
12114 * holds momentum info for user
12115 * @ingroup Elm_Gesture_Layer
12117 typedef struct _Elm_Gesture_Momentum_Info Elm_Gesture_Momentum_Info;
12120 * @struct _Elm_Gesture_Line_Info
12121 * Struct holds line info for user
12122 * @ingroup Elm_Gesture_Layer
12124 struct _Elm_Gesture_Line_Info
12125 { /* Report line ends, timestamps, and momentum computed */
12126 Elm_Gesture_Momentum_Info momentum; /**< Line momentum info */
12127 unsigned int n; /**< Number of fingers (lines) */
12128 /* FIXME should be radians, bot degrees */
12129 double angle; /**< Angle (direction) of lines */
12133 * @typedef Elm_Gesture_Line_Info
12134 * Holds line info for user
12135 * @ingroup Elm_Gesture_Layer
12137 typedef struct _Elm_Gesture_Line_Info Elm_Gesture_Line_Info;
12140 * @struct _Elm_Gesture_Zoom_Info
12141 * Struct holds zoom info for user
12142 * @ingroup Elm_Gesture_Layer
12144 struct _Elm_Gesture_Zoom_Info
12146 Evas_Coord x, y; /**< Holds zoom center point reported to user */
12147 Evas_Coord radius; /**< Holds radius between fingers reported to user */
12148 double zoom; /**< Zoom value: 1.0 means no zoom */
12149 double momentum; /**< Zoom momentum: zoom growth per second (NOT YET SUPPORTED) */
12153 * @typedef Elm_Gesture_Zoom_Info
12154 * Holds zoom info for user
12155 * @ingroup Elm_Gesture_Layer
12157 typedef struct _Elm_Gesture_Zoom_Info Elm_Gesture_Zoom_Info;
12160 * @struct _Elm_Gesture_Rotate_Info
12161 * Struct holds rotation info for user
12162 * @ingroup Elm_Gesture_Layer
12164 struct _Elm_Gesture_Rotate_Info
12166 Evas_Coord x, y; /**< Holds zoom center point reported to user */
12167 Evas_Coord radius; /**< Holds radius between fingers reported to user */
12168 double base_angle; /**< Holds start-angle */
12169 double angle; /**< Rotation value: 0.0 means no rotation */
12170 double momentum; /**< Rotation momentum: rotation done per second (NOT YET SUPPORTED) */
12174 * @typedef Elm_Gesture_Rotate_Info
12175 * Holds rotation info for user
12176 * @ingroup Elm_Gesture_Layer
12178 typedef struct _Elm_Gesture_Rotate_Info Elm_Gesture_Rotate_Info;
12181 * @typedef Elm_Gesture_Event_Cb
12182 * User callback used to stream gesture info from gesture layer
12183 * @param data user data
12184 * @param event_info gesture report info
12185 * Returns a flag field to be applied on the causing event.
12186 * You should probably return EVAS_EVENT_FLAG_ON_HOLD if your widget acted
12187 * upon the event, in an irreversible way.
12189 * @ingroup Elm_Gesture_Layer
12191 typedef Evas_Event_Flags (*Elm_Gesture_Event_Cb) (void *data, void *event_info);
12194 * Use function to set callbacks to be notified about
12195 * change of state of gesture.
12196 * When a user registers a callback with this function
12197 * this means this gesture has to be tested.
12199 * When ALL callbacks for a gesture are set to NULL
12200 * it means user isn't interested in gesture-state
12201 * and it will not be tested.
12203 * @param obj Pointer to gesture-layer.
12204 * @param idx The gesture you would like to track its state.
12205 * @param cb callback function pointer.
12206 * @param cb_type what event this callback tracks: START, MOVE, END, ABORT.
12207 * @param data user info to be sent to callback (usually, Smart Data)
12209 * @ingroup Elm_Gesture_Layer
12211 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);
12214 * Call this function to get repeat-events settings.
12216 * @param obj Pointer to gesture-layer.
12218 * @return repeat events settings.
12219 * @see elm_gesture_layer_hold_events_set()
12220 * @ingroup Elm_Gesture_Layer
12222 EAPI Eina_Bool elm_gesture_layer_hold_events_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
12225 * This function called in order to make gesture-layer repeat events.
12226 * Set this of you like to get the raw events only if gestures were not detected.
12227 * Clear this if you like gesture layer to fwd events as testing gestures.
12229 * @param obj Pointer to gesture-layer.
12230 * @param r Repeat: TRUE/FALSE
12232 * @ingroup Elm_Gesture_Layer
12234 EAPI void elm_gesture_layer_hold_events_set(Evas_Object *obj, Eina_Bool r) EINA_ARG_NONNULL(1);
12237 * This function sets step-value for zoom action.
12238 * Set step to any positive value.
12239 * Cancel step setting by setting to 0.0
12241 * @param obj Pointer to gesture-layer.
12242 * @param s new zoom step value.
12244 * @ingroup Elm_Gesture_Layer
12246 EAPI void elm_gesture_layer_zoom_step_set(Evas_Object *obj, double s) EINA_ARG_NONNULL(1);
12249 * This function sets step-value for rotate action.
12250 * Set step to any positive value.
12251 * Cancel step setting by setting to 0.0
12253 * @param obj Pointer to gesture-layer.
12254 * @param s new roatate step value.
12256 * @ingroup Elm_Gesture_Layer
12258 EAPI void elm_gesture_layer_rotate_step_set(Evas_Object *obj, double s) EINA_ARG_NONNULL(1);
12261 * This function called to attach gesture-layer to an Evas_Object.
12262 * @param obj Pointer to gesture-layer.
12263 * @param t Pointer to underlying object (AKA Target)
12265 * @return TRUE, FALSE on success, failure.
12267 * @ingroup Elm_Gesture_Layer
12269 EAPI Eina_Bool elm_gesture_layer_attach(Evas_Object *obj, Evas_Object *t) EINA_ARG_NONNULL(1, 2);
12272 * Call this function to construct a new gesture-layer object.
12273 * This does not activate the gesture layer. You have to
12274 * call elm_gesture_layer_attach in order to 'activate' gesture-layer.
12276 * @param parent the parent object.
12278 * @return Pointer to new gesture-layer object.
12280 * @ingroup Elm_Gesture_Layer
12282 EAPI Evas_Object *elm_gesture_layer_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12285 * @defgroup Thumb Thumb
12287 * @image html img/widget/thumb/preview-00.png
12288 * @image latex img/widget/thumb/preview-00.eps
12290 * A thumb object is used for displaying the thumbnail of an image or video.
12291 * You must have compiled Elementary with Ethumb_Client support and the DBus
12292 * service must be present and auto-activated in order to have thumbnails to
12295 * Once the thumbnail object becomes visible, it will check if there is a
12296 * previously generated thumbnail image for the file set on it. If not, it
12297 * will start generating this thumbnail.
12299 * Different config settings will cause different thumbnails to be generated
12300 * even on the same file.
12302 * Generated thumbnails are stored under @c $HOME/.thumbnails/. Check the
12303 * Ethumb documentation to change this path, and to see other configuration
12306 * Signals that you can add callbacks for are:
12308 * - "clicked" - This is called when a user has clicked the thumb without dragging
12310 * - "clicked,double" - This is called when a user has double-clicked the thumb.
12311 * - "press" - This is called when a user has pressed down the thumb.
12312 * - "generate,start" - The thumbnail generation started.
12313 * - "generate,stop" - The generation process stopped.
12314 * - "generate,error" - The generation failed.
12315 * - "load,error" - The thumbnail image loading failed.
12317 * available styles:
12321 * An example of use of thumbnail:
12323 * - @ref thumb_example_01
12327 * @addtogroup Thumb
12332 * @enum _Elm_Thumb_Animation_Setting
12333 * @typedef Elm_Thumb_Animation_Setting
12335 * Used to set if a video thumbnail is animating or not.
12339 typedef enum _Elm_Thumb_Animation_Setting
12341 ELM_THUMB_ANIMATION_START = 0, /**< Play animation once */
12342 ELM_THUMB_ANIMATION_LOOP, /**< Keep playing animation until stop is requested */
12343 ELM_THUMB_ANIMATION_STOP, /**< Stop playing the animation */
12344 ELM_THUMB_ANIMATION_LAST
12345 } Elm_Thumb_Animation_Setting;
12348 * Add a new thumb object to the parent.
12350 * @param parent The parent object.
12351 * @return The new object or NULL if it cannot be created.
12353 * @see elm_thumb_file_set()
12354 * @see elm_thumb_ethumb_client_get()
12358 EAPI Evas_Object *elm_thumb_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12360 * Reload thumbnail if it was generated before.
12362 * @param obj The thumb object to reload
12364 * This is useful if the ethumb client configuration changed, like its
12365 * size, aspect or any other property one set in the handle returned
12366 * by elm_thumb_ethumb_client_get().
12368 * If the options didn't change, the thumbnail won't be generated again, but
12369 * the old one will still be used.
12371 * @see elm_thumb_file_set()
12375 EAPI void elm_thumb_reload(Evas_Object *obj) EINA_ARG_NONNULL(1);
12377 * Set the file that will be used as thumbnail.
12379 * @param obj The thumb object.
12380 * @param file The path to file that will be used as thumb.
12381 * @param key The key used in case of an EET file.
12383 * The file can be an image or a video (in that case, acceptable extensions are:
12384 * avi, mp4, ogv, mov, mpg and wmv). To start the video animation, use the
12385 * function elm_thumb_animate().
12387 * @see elm_thumb_file_get()
12388 * @see elm_thumb_reload()
12389 * @see elm_thumb_animate()
12393 EAPI void elm_thumb_file_set(Evas_Object *obj, const char *file, const char *key) EINA_ARG_NONNULL(1);
12395 * Get the image or video path and key used to generate the thumbnail.
12397 * @param obj The thumb object.
12398 * @param file Pointer to filename.
12399 * @param key Pointer to key.
12401 * @see elm_thumb_file_set()
12402 * @see elm_thumb_path_get()
12406 EAPI void elm_thumb_file_get(const Evas_Object *obj, const char **file, const char **key) EINA_ARG_NONNULL(1);
12408 * Get the path and key to the image or video generated by ethumb.
12410 * One just need to make sure that the thumbnail was generated before getting
12411 * its path; otherwise, the path will be NULL. One way to do that is by asking
12412 * for the path when/after the "generate,stop" smart callback is called.
12414 * @param obj The thumb object.
12415 * @param file Pointer to thumb path.
12416 * @param key Pointer to thumb key.
12418 * @see elm_thumb_file_get()
12422 EAPI void elm_thumb_path_get(const Evas_Object *obj, const char **file, const char **key) EINA_ARG_NONNULL(1);
12424 * Set the animation state for the thumb object. If its content is an animated
12425 * video, you may start/stop the animation or tell it to play continuously and
12428 * @param obj The thumb object.
12429 * @param setting The animation setting.
12431 * @see elm_thumb_file_set()
12435 EAPI void elm_thumb_animate_set(Evas_Object *obj, Elm_Thumb_Animation_Setting s) EINA_ARG_NONNULL(1);
12437 * Get the animation state for the thumb object.
12439 * @param obj The thumb object.
12440 * @return getting The animation setting or @c ELM_THUMB_ANIMATION_LAST,
12443 * @see elm_thumb_animate_set()
12447 EAPI Elm_Thumb_Animation_Setting elm_thumb_animate_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12449 * Get the ethumb_client handle so custom configuration can be made.
12451 * @return Ethumb_Client instance or NULL.
12453 * This must be called before the objects are created to be sure no object is
12454 * visible and no generation started.
12456 * Example of usage:
12459 * #include <Elementary.h>
12460 * #ifndef ELM_LIB_QUICKLAUNCH
12462 * elm_main(int argc, char **argv)
12464 * Ethumb_Client *client;
12466 * elm_need_ethumb();
12470 * client = elm_thumb_ethumb_client_get();
12473 * ERR("could not get ethumb_client");
12476 * ethumb_client_size_set(client, 100, 100);
12477 * ethumb_client_crop_align_set(client, 0.5, 0.5);
12480 * // Create elm_thumb objects here
12490 * @note There's only one client handle for Ethumb, so once a configuration
12491 * change is done to it, any other request for thumbnails (for any thumbnail
12492 * object) will use that configuration. Thus, this configuration is global.
12496 EAPI void *elm_thumb_ethumb_client_get(void);
12498 * Get the ethumb_client connection state.
12500 * @return EINA_TRUE if the client is connected to the server or EINA_FALSE
12503 EAPI Eina_Bool elm_thumb_ethumb_client_connected(void);
12505 * Make the thumbnail 'editable'.
12507 * @param obj Thumb object.
12508 * @param set Turn on or off editability. Default is @c EINA_FALSE.
12510 * This means the thumbnail is a valid drag target for drag and drop, and can be
12511 * cut or pasted too.
12513 * @see elm_thumb_editable_get()
12517 EAPI Eina_Bool elm_thumb_editable_set(Evas_Object *obj, Eina_Bool edit) EINA_ARG_NONNULL(1);
12519 * Make the thumbnail 'editable'.
12521 * @param obj Thumb object.
12522 * @return Editability.
12524 * This means the thumbnail is a valid drag target for drag and drop, and can be
12525 * cut or pasted too.
12527 * @see elm_thumb_editable_set()
12531 EAPI Eina_Bool elm_thumb_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12538 * @defgroup Hoversel Hoversel
12540 * @image html img/widget/hoversel/preview-00.png
12541 * @image latex img/widget/hoversel/preview-00.eps
12543 * A hoversel is a button that pops up a list of items (automatically
12544 * choosing the direction to display) that have a label and, optionally, an
12545 * icon to select from. It is a convenience widget to avoid the need to do
12546 * all the piecing together yourself. It is intended for a small number of
12547 * items in the hoversel menu (no more than 8), though is capable of many
12550 * Signals that you can add callbacks for are:
12551 * "clicked" - the user clicked the hoversel button and popped up the sel
12552 * "selected" - an item in the hoversel list is selected. event_info is the item
12553 * "dismissed" - the hover is dismissed
12555 * See @ref tutorial_hoversel for an example.
12558 typedef struct _Elm_Hoversel_Item Elm_Hoversel_Item; /**< Item of Elm_Hoversel. Sub-type of Elm_Widget_Item */
12560 * @brief Add a new Hoversel object
12562 * @param parent The parent object
12563 * @return The new object or NULL if it cannot be created
12565 EAPI Evas_Object *elm_hoversel_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12567 * @brief This sets the hoversel to expand horizontally.
12569 * @param obj The hoversel object
12570 * @param horizontal If true, the hover will expand horizontally to the
12573 * @note The initial button will display horizontally regardless of this
12576 EAPI void elm_hoversel_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
12578 * @brief This returns whether the hoversel is set to expand horizontally.
12580 * @param obj The hoversel object
12581 * @return If true, the hover will expand horizontally to the right.
12583 * @see elm_hoversel_horizontal_set()
12585 EAPI Eina_Bool elm_hoversel_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12587 * @brief Set the Hover parent
12589 * @param obj The hoversel object
12590 * @param parent The parent to use
12592 * Sets the hover parent object, the area that will be darkened when the
12593 * hoversel is clicked. Should probably be the window that the hoversel is
12594 * in. See @ref Hover objects for more information.
12596 EAPI void elm_hoversel_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
12598 * @brief Get the Hover parent
12600 * @param obj The hoversel object
12601 * @return The used parent
12603 * Gets the hover parent object.
12605 * @see elm_hoversel_hover_parent_set()
12607 EAPI Evas_Object *elm_hoversel_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12609 * @brief Set the hoversel button label
12611 * @param obj The hoversel object
12612 * @param label The label text.
12614 * This sets the label of the button that is always visible (before it is
12615 * clicked and expanded).
12617 * @deprecated elm_object_text_set()
12619 EINA_DEPRECATED EAPI void elm_hoversel_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
12621 * @brief Get the hoversel button label
12623 * @param obj The hoversel object
12624 * @return The label text.
12626 * @deprecated elm_object_text_get()
12628 EINA_DEPRECATED EAPI const char *elm_hoversel_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12630 * @brief Set the icon of the hoversel button
12632 * @param obj The hoversel object
12633 * @param icon The icon object
12635 * Sets the icon of the button that is always visible (before it is clicked
12636 * and expanded). Once the icon object is set, a previously set one will be
12637 * deleted, if you want to keep that old content object, use the
12638 * elm_hoversel_icon_unset() function.
12640 * @see elm_button_icon_set()
12642 EAPI void elm_hoversel_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
12644 * @brief Get the icon of the hoversel button
12646 * @param obj The hoversel object
12647 * @return The icon object
12649 * Get the icon of the button that is always visible (before it is clicked
12650 * and expanded). Also see elm_button_icon_get().
12652 * @see elm_hoversel_icon_set()
12654 EAPI Evas_Object *elm_hoversel_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12656 * @brief Get and unparent the icon of the hoversel button
12658 * @param obj The hoversel object
12659 * @return The icon object that was being used
12661 * Unparent and return the icon of the button that is always visible
12662 * (before it is clicked and expanded).
12664 * @see elm_hoversel_icon_set()
12665 * @see elm_button_icon_unset()
12667 EAPI Evas_Object *elm_hoversel_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
12669 * @brief This triggers the hoversel popup from code, the same as if the user
12670 * had clicked the button.
12672 * @param obj The hoversel object
12674 EAPI void elm_hoversel_hover_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
12676 * @brief This dismisses the hoversel popup as if the user had clicked
12677 * outside the hover.
12679 * @param obj The hoversel object
12681 EAPI void elm_hoversel_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
12683 * @brief Returns whether the hoversel is expanded.
12685 * @param obj The hoversel object
12686 * @return This will return EINA_TRUE if the hoversel is expanded or
12687 * EINA_FALSE if it is not expanded.
12689 EAPI Eina_Bool elm_hoversel_expanded_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12691 * @brief This will remove all the children items from the hoversel.
12693 * @param obj The hoversel object
12695 * @warning Should @b not be called while the hoversel is active; use
12696 * elm_hoversel_expanded_get() to check first.
12698 * @see elm_hoversel_item_del_cb_set()
12699 * @see elm_hoversel_item_del()
12701 EAPI void elm_hoversel_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
12703 * @brief Get the list of items within the given hoversel.
12705 * @param obj The hoversel object
12706 * @return Returns a list of Elm_Hoversel_Item*
12708 * @see elm_hoversel_item_add()
12710 EAPI const Eina_List *elm_hoversel_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12712 * @brief Add an item to the hoversel button
12714 * @param obj The hoversel object
12715 * @param label The text label to use for the item (NULL if not desired)
12716 * @param icon_file An image file path on disk to use for the icon or standard
12717 * icon name (NULL if not desired)
12718 * @param icon_type The icon type if relevant
12719 * @param func Convenience function to call when this item is selected
12720 * @param data Data to pass to item-related functions
12721 * @return A handle to the item added.
12723 * This adds an item to the hoversel to show when it is clicked. Note: if you
12724 * need to use an icon from an edje file then use
12725 * elm_hoversel_item_icon_set() right after the this function, and set
12726 * icon_file to NULL here.
12728 * For more information on what @p icon_file and @p icon_type are see the
12729 * @ref Icon "icon documentation".
12731 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);
12733 * @brief Delete an item from the hoversel
12735 * @param item The item to delete
12737 * This deletes the item from the hoversel (should not be called while the
12738 * hoversel is active; use elm_hoversel_expanded_get() to check first).
12740 * @see elm_hoversel_item_add()
12741 * @see elm_hoversel_item_del_cb_set()
12743 EAPI void elm_hoversel_item_del(Elm_Hoversel_Item *item) EINA_ARG_NONNULL(1);
12745 * @brief Set the function to be called when an item from the hoversel is
12748 * @param item The item to set the callback on
12749 * @param func The function called
12751 * That function will receive these parameters:
12752 * @li void *item_data
12753 * @li Evas_Object *the_item_object
12754 * @li Elm_Hoversel_Item *the_object_struct
12756 * @see elm_hoversel_item_add()
12758 EAPI void elm_hoversel_item_del_cb_set(Elm_Hoversel_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
12760 * @brief This returns the data pointer supplied with elm_hoversel_item_add()
12761 * that will be passed to associated function callbacks.
12763 * @param item The item to get the data from
12764 * @return The data pointer set with elm_hoversel_item_add()
12766 * @see elm_hoversel_item_add()
12768 EAPI void *elm_hoversel_item_data_get(const Elm_Hoversel_Item *it) EINA_ARG_NONNULL(1);
12770 * @brief This returns the label text of the given hoversel item.
12772 * @param item The item to get the label
12773 * @return The label text of the hoversel item
12775 * @see elm_hoversel_item_add()
12777 EAPI const char *elm_hoversel_item_label_get(const Elm_Hoversel_Item *it) EINA_ARG_NONNULL(1);
12779 * @brief This sets the icon for the given hoversel item.
12781 * @param item The item to set the icon
12782 * @param icon_file An image file path on disk to use for the icon or standard
12784 * @param icon_group The edje group to use if @p icon_file is an edje file. Set this
12785 * to NULL if the icon is not an edje file
12786 * @param icon_type The icon type
12788 * The icon can be loaded from the standard set, from an image file, or from
12791 * @see elm_hoversel_item_add()
12793 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);
12795 * @brief Get the icon object of the hoversel item
12797 * @param item The item to get the icon from
12798 * @param icon_file The image file path on disk used for the icon or standard
12800 * @param icon_group The edje group used if @p icon_file is an edje file. NULL
12801 * if the icon is not an edje file
12802 * @param icon_type The icon type
12804 * @see elm_hoversel_item_icon_set()
12805 * @see elm_hoversel_item_add()
12807 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);
12813 * @defgroup Toolbar Toolbar
12814 * @ingroup Elementary
12816 * @image html img/widget/toolbar/preview-00.png
12817 * @image latex img/widget/toolbar/preview-00.eps width=\textwidth
12819 * @image html img/toolbar.png
12820 * @image latex img/toolbar.eps width=\textwidth
12822 * A toolbar is a widget that displays a list of items inside
12823 * a box. It can be scrollable, show a menu with items that don't fit
12824 * to toolbar size or even crop them.
12826 * Only one item can be selected at a time.
12828 * Items can have multiple states, or show menus when selected by the user.
12830 * Smart callbacks one can listen to:
12831 * - "clicked" - when the user clicks on a toolbar item and becomes selected.
12833 * Available styles for it:
12835 * - @c "transparent" - no background or shadow, just show the content
12837 * List of examples:
12838 * @li @ref toolbar_example_01
12839 * @li @ref toolbar_example_02
12840 * @li @ref toolbar_example_03
12844 * @addtogroup Toolbar
12849 * @enum _Elm_Toolbar_Shrink_Mode
12850 * @typedef Elm_Toolbar_Shrink_Mode
12852 * Set toolbar's items display behavior, it can be scrollabel,
12853 * show a menu with exceeding items, or simply hide them.
12855 * @note Default value is #ELM_TOOLBAR_SHRINK_MENU. It reads value
12858 * Values <b> don't </b> work as bitmask, only one can be choosen.
12860 * @see elm_toolbar_mode_shrink_set()
12861 * @see elm_toolbar_mode_shrink_get()
12865 typedef enum _Elm_Toolbar_Shrink_Mode
12867 ELM_TOOLBAR_SHRINK_NONE, /**< Set toolbar minimun size to fit all the items. */
12868 ELM_TOOLBAR_SHRINK_HIDE, /**< Hide exceeding items. */
12869 ELM_TOOLBAR_SHRINK_SCROLL, /**< Allow accessing exceeding items through a scroller. */
12870 ELM_TOOLBAR_SHRINK_MENU /**< Inserts a button to pop up a menu with exceeding items. */
12871 } Elm_Toolbar_Shrink_Mode;
12873 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(). */
12875 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(). */
12878 * Add a new toolbar widget to the given parent Elementary
12879 * (container) object.
12881 * @param parent The parent object.
12882 * @return a new toolbar widget handle or @c NULL, on errors.
12884 * This function inserts a new toolbar widget on the canvas.
12888 EAPI Evas_Object *elm_toolbar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12891 * Set the icon size, in pixels, to be used by toolbar items.
12893 * @param obj The toolbar object
12894 * @param icon_size The icon size in pixels
12896 * @note Default value is @c 32. It reads value from elm config.
12898 * @see elm_toolbar_icon_size_get()
12902 EAPI void elm_toolbar_icon_size_set(Evas_Object *obj, int icon_size) EINA_ARG_NONNULL(1);
12905 * Get the icon size, in pixels, to be used by toolbar items.
12907 * @param obj The toolbar object.
12908 * @return The icon size in pixels.
12910 * @see elm_toolbar_icon_size_set() for details.
12914 EAPI int elm_toolbar_icon_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12917 * Sets icon lookup order, for toolbar items' icons.
12919 * @param obj The toolbar object.
12920 * @param order The icon lookup order.
12922 * Icons added before calling this function will not be affected.
12923 * The default lookup order is #ELM_ICON_LOOKUP_THEME_FDO.
12925 * @see elm_toolbar_icon_order_lookup_get()
12929 EAPI void elm_toolbar_icon_order_lookup_set(Evas_Object *obj, Elm_Icon_Lookup_Order order) EINA_ARG_NONNULL(1);
12932 * Gets the icon lookup order.
12934 * @param obj The toolbar object.
12935 * @return The icon lookup order.
12937 * @see elm_toolbar_icon_order_lookup_set() for details.
12941 EAPI Elm_Icon_Lookup_Order elm_toolbar_icon_order_lookup_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12944 * Set whether the toolbar items' should be selected by the user or not.
12946 * @param obj The toolbar object.
12947 * @param wrap @c EINA_TRUE to disable selection or @c EINA_FALSE to
12950 * This will turn off the ability to select items entirely and they will
12951 * neither appear selected nor emit selected signals. The clicked
12952 * callback function will still be called.
12954 * Selection is enabled by default.
12956 * @see elm_toolbar_no_select_mode_get().
12960 EAPI void elm_toolbar_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
12963 * Set whether the toolbar items' should be selected by the user or not.
12965 * @param obj The toolbar object.
12966 * @return @c EINA_TRUE means items can be selected. @c EINA_FALSE indicates
12967 * they can't. If @p obj is @c NULL, @c EINA_FALSE is returned.
12969 * @see elm_toolbar_no_select_mode_set() for details.
12973 EAPI Eina_Bool elm_toolbar_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12976 * Append item to the toolbar.
12978 * @param obj The toolbar object.
12979 * @param icon A string with icon name or the absolute path of an image file.
12980 * @param label The label of the item.
12981 * @param func The function to call when the item is clicked.
12982 * @param data The data to associate with the item for related callbacks.
12983 * @return The created item or @c NULL upon failure.
12985 * A new item will be created and appended to the toolbar, i.e., will
12986 * be set as @b last item.
12988 * Items created with this method can be deleted with
12989 * elm_toolbar_item_del().
12991 * Associated @p data can be properly freed when item is deleted if a
12992 * callback function is set with elm_toolbar_item_del_cb_set().
12994 * If a function is passed as argument, it will be called everytime this item
12995 * is selected, i.e., the user clicks over an unselected item.
12996 * If such function isn't needed, just passing
12997 * @c NULL as @p func is enough. The same should be done for @p data.
12999 * Toolbar will load icon image from fdo or current theme.
13000 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
13001 * If an absolute path is provided it will load it direct from a file.
13003 * @see elm_toolbar_item_icon_set()
13004 * @see elm_toolbar_item_del()
13005 * @see elm_toolbar_item_del_cb_set()
13009 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);
13012 * Prepend item to the toolbar.
13014 * @param obj The toolbar object.
13015 * @param icon A string with icon name or the absolute path of an image file.
13016 * @param label The label of the item.
13017 * @param func The function to call when the item is clicked.
13018 * @param data The data to associate with the item for related callbacks.
13019 * @return The created item or @c NULL upon failure.
13021 * A new item will be created and prepended to the toolbar, i.e., will
13022 * be set as @b first item.
13024 * Items created with this method can be deleted with
13025 * elm_toolbar_item_del().
13027 * Associated @p data can be properly freed when item is deleted if a
13028 * callback function is set with elm_toolbar_item_del_cb_set().
13030 * If a function is passed as argument, it will be called everytime this item
13031 * is selected, i.e., the user clicks over an unselected item.
13032 * If such function isn't needed, just passing
13033 * @c NULL as @p func is enough. The same should be done for @p data.
13035 * Toolbar will load icon image from fdo or current theme.
13036 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
13037 * If an absolute path is provided it will load it direct from a file.
13039 * @see elm_toolbar_item_icon_set()
13040 * @see elm_toolbar_item_del()
13041 * @see elm_toolbar_item_del_cb_set()
13045 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);
13048 * Insert a new item into the toolbar object before item @p before.
13050 * @param obj The toolbar object.
13051 * @param before The toolbar item to insert before.
13052 * @param icon A string with icon name or the absolute path of an image file.
13053 * @param label The label of the item.
13054 * @param func The function to call when the item is clicked.
13055 * @param data The data to associate with the item for related callbacks.
13056 * @return The created item or @c NULL upon failure.
13058 * A new item will be created and added to the toolbar. Its position in
13059 * this toolbar will be just before item @p before.
13061 * Items created with this method can be deleted with
13062 * elm_toolbar_item_del().
13064 * Associated @p data can be properly freed when item is deleted if a
13065 * callback function is set with elm_toolbar_item_del_cb_set().
13067 * If a function is passed as argument, it will be called everytime this item
13068 * is selected, i.e., the user clicks over an unselected item.
13069 * If such function isn't needed, just passing
13070 * @c NULL as @p func is enough. The same should be done for @p data.
13072 * Toolbar will load icon image from fdo or current theme.
13073 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
13074 * If an absolute path is provided it will load it direct from a file.
13076 * @see elm_toolbar_item_icon_set()
13077 * @see elm_toolbar_item_del()
13078 * @see elm_toolbar_item_del_cb_set()
13082 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);
13085 * Insert a new item into the toolbar object after item @p after.
13087 * @param obj The toolbar object.
13088 * @param before The toolbar item to insert before.
13089 * @param icon A string with icon name or the absolute path of an image file.
13090 * @param label The label of the item.
13091 * @param func The function to call when the item is clicked.
13092 * @param data The data to associate with the item for related callbacks.
13093 * @return The created item or @c NULL upon failure.
13095 * A new item will be created and added to the toolbar. Its position in
13096 * this toolbar will be just after item @p after.
13098 * Items created with this method can be deleted with
13099 * elm_toolbar_item_del().
13101 * Associated @p data can be properly freed when item is deleted if a
13102 * callback function is set with elm_toolbar_item_del_cb_set().
13104 * If a function is passed as argument, it will be called everytime this item
13105 * is selected, i.e., the user clicks over an unselected item.
13106 * If such function isn't needed, just passing
13107 * @c NULL as @p func is enough. The same should be done for @p data.
13109 * Toolbar will load icon image from fdo or current theme.
13110 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
13111 * If an absolute path is provided it will load it direct from a file.
13113 * @see elm_toolbar_item_icon_set()
13114 * @see elm_toolbar_item_del()
13115 * @see elm_toolbar_item_del_cb_set()
13119 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);
13122 * Get the first item in the given toolbar widget's list of
13125 * @param obj The toolbar object
13126 * @return The first item or @c NULL, if it has no items (and on
13129 * @see elm_toolbar_item_append()
13130 * @see elm_toolbar_last_item_get()
13134 EAPI Elm_Toolbar_Item *elm_toolbar_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13137 * Get the last item in the given toolbar widget's list of
13140 * @param obj The toolbar object
13141 * @return The last item or @c NULL, if it has no items (and on
13144 * @see elm_toolbar_item_prepend()
13145 * @see elm_toolbar_first_item_get()
13149 EAPI Elm_Toolbar_Item *elm_toolbar_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13152 * Get the item after @p item in toolbar.
13154 * @param item The toolbar item.
13155 * @return The item after @p item, or @c NULL if none or on failure.
13157 * @note If it is the last item, @c NULL will be returned.
13159 * @see elm_toolbar_item_append()
13163 EAPI Elm_Toolbar_Item *elm_toolbar_item_next_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13166 * Get the item before @p item in toolbar.
13168 * @param item The toolbar item.
13169 * @return The item before @p item, or @c NULL if none or on failure.
13171 * @note If it is the first item, @c NULL will be returned.
13173 * @see elm_toolbar_item_prepend()
13177 EAPI Elm_Toolbar_Item *elm_toolbar_item_prev_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13180 * Get the toolbar object from an item.
13182 * @param item The item.
13183 * @return The toolbar object.
13185 * This returns the toolbar object itself that an item belongs to.
13189 EAPI Evas_Object *elm_toolbar_item_toolbar_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13192 * Set the priority of a toolbar item.
13194 * @param item The toolbar item.
13195 * @param priority The item priority. The default is zero.
13197 * This is used only when the toolbar shrink mode is set to
13198 * #ELM_TOOLBAR_SHRINK_MENU or #ELM_TOOLBAR_SHRINK_HIDE.
13199 * When space is less than required, items with low priority
13200 * will be removed from the toolbar and added to a dynamically-created menu,
13201 * while items with higher priority will remain on the toolbar,
13202 * with the same order they were added.
13204 * @see elm_toolbar_item_priority_get()
13208 EAPI void elm_toolbar_item_priority_set(Elm_Toolbar_Item *item, int priority) EINA_ARG_NONNULL(1);
13211 * Get the priority of a toolbar item.
13213 * @param item The toolbar item.
13214 * @return The @p item priority, or @c 0 on failure.
13216 * @see elm_toolbar_item_priority_set() for details.
13220 EAPI int elm_toolbar_item_priority_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13223 * Get the label of item.
13225 * @param item The item of toolbar.
13226 * @return The label of item.
13228 * The return value is a pointer to the label associated to @p item when
13229 * it was created, with function elm_toolbar_item_append() or similar,
13231 * with function elm_toolbar_item_label_set. If no label
13232 * was passed as argument, it will return @c NULL.
13234 * @see elm_toolbar_item_label_set() for more details.
13235 * @see elm_toolbar_item_append()
13239 EAPI const char *elm_toolbar_item_label_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13242 * Set the label of item.
13244 * @param item The item of toolbar.
13245 * @param text The label of item.
13247 * The label to be displayed by the item.
13248 * Label will be placed at icons bottom (if set).
13250 * If a label was passed as argument on item creation, with function
13251 * elm_toolbar_item_append() or similar, it will be already
13252 * displayed by the item.
13254 * @see elm_toolbar_item_label_get()
13255 * @see elm_toolbar_item_append()
13259 EAPI void elm_toolbar_item_label_set(Elm_Toolbar_Item *item, const char *label) EINA_ARG_NONNULL(1);
13262 * Return the data associated with a given toolbar widget item.
13264 * @param item The toolbar widget item handle.
13265 * @return The data associated with @p item.
13267 * @see elm_toolbar_item_data_set()
13271 EAPI void *elm_toolbar_item_data_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13274 * Set the data associated with a given toolbar widget item.
13276 * @param item The toolbar widget item handle.
13277 * @param data The new data pointer to set to @p item.
13279 * This sets new item data on @p item.
13281 * @warning The old data pointer won't be touched by this function, so
13282 * the user had better to free that old data himself/herself.
13286 EAPI void elm_toolbar_item_data_set(Elm_Toolbar_Item *item, const void *data) EINA_ARG_NONNULL(1);
13289 * Returns a pointer to a toolbar item by its label.
13291 * @param obj The toolbar object.
13292 * @param label The label of the item to find.
13294 * @return The pointer to the toolbar item matching @p label or @c NULL
13299 EAPI Elm_Toolbar_Item *elm_toolbar_item_find_by_label(const Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
13302 * Get whether the @p item is selected or not.
13304 * @param item The toolbar item.
13305 * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
13306 * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
13308 * @see elm_toolbar_selected_item_set() for details.
13309 * @see elm_toolbar_item_selected_get()
13313 EAPI Eina_Bool elm_toolbar_item_selected_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13316 * Set the selected state of an item.
13318 * @param item The toolbar item
13319 * @param selected The selected state
13321 * This sets the selected state of the given item @p it.
13322 * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
13324 * If a new item is selected the previosly selected will be unselected.
13325 * Previoulsy selected item can be get with function
13326 * elm_toolbar_selected_item_get().
13328 * Selected items will be highlighted.
13330 * @see elm_toolbar_item_selected_get()
13331 * @see elm_toolbar_selected_item_get()
13335 EAPI void elm_toolbar_item_selected_set(Elm_Toolbar_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
13338 * Get the selected item.
13340 * @param obj The toolbar object.
13341 * @return The selected toolbar item.
13343 * The selected item can be unselected with function
13344 * elm_toolbar_item_selected_set().
13346 * The selected item always will be highlighted on toolbar.
13348 * @see elm_toolbar_selected_items_get()
13352 EAPI Elm_Toolbar_Item *elm_toolbar_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13355 * Set the icon associated with @p item.
13357 * @param obj The parent of this item.
13358 * @param item The toolbar item.
13359 * @param icon A string with icon name or the absolute path of an image file.
13361 * Toolbar will load icon image from fdo or current theme.
13362 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
13363 * If an absolute path is provided it will load it direct from a file.
13365 * @see elm_toolbar_icon_order_lookup_set()
13366 * @see elm_toolbar_icon_order_lookup_get()
13370 EAPI void elm_toolbar_item_icon_set(Elm_Toolbar_Item *item, const char *icon) EINA_ARG_NONNULL(1);
13373 * Get the string used to set the icon of @p item.
13375 * @param item The toolbar item.
13376 * @return The string associated with the icon object.
13378 * @see elm_toolbar_item_icon_set() for details.
13382 EAPI const char *elm_toolbar_item_icon_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13385 * Delete them item from the toolbar.
13387 * @param item The item of toolbar to be deleted.
13389 * @see elm_toolbar_item_append()
13390 * @see elm_toolbar_item_del_cb_set()
13394 EAPI void elm_toolbar_item_del(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13397 * Set the function called when a toolbar item is freed.
13399 * @param item The item to set the callback on.
13400 * @param func The function called.
13402 * If there is a @p func, then it will be called prior item's memory release.
13403 * That will be called with the following arguments:
13405 * @li item's Evas object;
13408 * This way, a data associated to a toolbar item could be properly freed.
13412 EAPI void elm_toolbar_item_del_cb_set(Elm_Toolbar_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
13415 * Get a value whether toolbar item is disabled or not.
13417 * @param item The item.
13418 * @return The disabled state.
13420 * @see elm_toolbar_item_disabled_set() for more details.
13424 EAPI Eina_Bool elm_toolbar_item_disabled_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13427 * Sets the disabled/enabled state of a toolbar item.
13429 * @param item The item.
13430 * @param disabled The disabled state.
13432 * A disabled item cannot be selected or unselected. It will also
13433 * change its appearance (generally greyed out). This sets the
13434 * disabled state (@c EINA_TRUE for disabled, @c EINA_FALSE for
13439 EAPI void elm_toolbar_item_disabled_set(Elm_Toolbar_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
13442 * Set or unset item as a separator.
13444 * @param item The toolbar item.
13445 * @param setting @c EINA_TRUE to set item @p item as separator or
13446 * @c EINA_FALSE to unset, i.e., item will be used as a regular item.
13448 * Items aren't set as separator by default.
13450 * If set as separator it will display separator theme, so won't display
13453 * @see elm_toolbar_item_separator_get()
13457 EAPI void elm_toolbar_item_separator_set(Elm_Toolbar_Item *item, Eina_Bool separator) EINA_ARG_NONNULL(1);
13460 * Get a value whether item is a separator or not.
13462 * @param item The toolbar item.
13463 * @return @c EINA_TRUE means item @p it is a separator. @c EINA_FALSE
13464 * indicates it's not. If @p it is @c NULL, @c EINA_FALSE is returned.
13466 * @see elm_toolbar_item_separator_set() for details.
13470 EAPI Eina_Bool elm_toolbar_item_separator_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13473 * Set the shrink state of toolbar @p obj.
13475 * @param obj The toolbar object.
13476 * @param shrink_mode Toolbar's items display behavior.
13478 * The toolbar won't scroll if #ELM_TOOLBAR_SHRINK_NONE,
13479 * but will enforce a minimun size so all the items will fit, won't scroll
13480 * and won't show the items that don't fit if #ELM_TOOLBAR_SHRINK_HIDE,
13481 * will scroll if #ELM_TOOLBAR_SHRINK_SCROLL, and will create a button to
13482 * pop up excess elements with #ELM_TOOLBAR_SHRINK_MENU.
13486 EAPI void elm_toolbar_mode_shrink_set(Evas_Object *obj, Elm_Toolbar_Shrink_Mode shrink_mode) EINA_ARG_NONNULL(1);
13489 * Get the shrink mode of toolbar @p obj.
13491 * @param obj The toolbar object.
13492 * @return Toolbar's items display behavior.
13494 * @see elm_toolbar_mode_shrink_set() for details.
13498 EAPI Elm_Toolbar_Shrink_Mode elm_toolbar_mode_shrink_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13501 * Enable/disable homogenous mode.
13503 * @param obj The toolbar object
13504 * @param homogeneous Assume the items within the toolbar are of the
13505 * same size (EINA_TRUE = on, EINA_FALSE = off). Default is @c EINA_FALSE.
13507 * This will enable the homogeneous mode where items are of the same size.
13508 * @see elm_toolbar_homogeneous_get()
13512 EAPI void elm_toolbar_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
13515 * Get whether the homogenous mode is enabled.
13517 * @param obj The toolbar object.
13518 * @return Assume the items within the toolbar are of the same height
13519 * and width (EINA_TRUE = on, EINA_FALSE = off).
13521 * @see elm_toolbar_homogeneous_set()
13525 EAPI Eina_Bool elm_toolbar_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13528 * Enable/disable homogenous mode.
13530 * @param obj The toolbar object
13531 * @param homogeneous Assume the items within the toolbar are of the
13532 * same size (EINA_TRUE = on, EINA_FALSE = off). Default is @c EINA_FALSE.
13534 * This will enable the homogeneous mode where items are of the same size.
13535 * @see elm_toolbar_homogeneous_get()
13537 * @deprecated use elm_toolbar_homogeneous_set() instead.
13541 EINA_DEPRECATED EAPI void elm_toolbar_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
13544 * Get whether the homogenous mode is enabled.
13546 * @param obj The toolbar object.
13547 * @return Assume the items within the toolbar are of the same height
13548 * and width (EINA_TRUE = on, EINA_FALSE = off).
13550 * @see elm_toolbar_homogeneous_set()
13551 * @deprecated use elm_toolbar_homogeneous_get() instead.
13555 EINA_DEPRECATED EAPI Eina_Bool elm_toolbar_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13558 * Set the parent object of the toolbar items' menus.
13560 * @param obj The toolbar object.
13561 * @param parent The parent of the menu objects.
13563 * Each item can be set as item menu, with elm_toolbar_item_menu_set().
13565 * For more details about setting the parent for toolbar menus, see
13566 * elm_menu_parent_set().
13568 * @see elm_menu_parent_set() for details.
13569 * @see elm_toolbar_item_menu_set() for details.
13573 EAPI void elm_toolbar_menu_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
13576 * Get the parent object of the toolbar items' menus.
13578 * @param obj The toolbar object.
13579 * @return The parent of the menu objects.
13581 * @see elm_toolbar_menu_parent_set() for details.
13585 EAPI Evas_Object *elm_toolbar_menu_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13588 * Set the alignment of the items.
13590 * @param obj The toolbar object.
13591 * @param align The new alignment, a float between <tt> 0.0 </tt>
13592 * and <tt> 1.0 </tt>.
13594 * Alignment of toolbar items, from <tt> 0.0 </tt> to indicates to align
13595 * left, to <tt> 1.0 </tt>, to align to right. <tt> 0.5 </tt> centralize
13598 * Centered items by default.
13600 * @see elm_toolbar_align_get()
13604 EAPI void elm_toolbar_align_set(Evas_Object *obj, double align) EINA_ARG_NONNULL(1);
13607 * Get the alignment of the items.
13609 * @param obj The toolbar object.
13610 * @return toolbar items alignment, a float between <tt> 0.0 </tt> and
13613 * @see elm_toolbar_align_set() for details.
13617 EAPI double elm_toolbar_align_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13620 * Set whether the toolbar item opens a menu.
13622 * @param item The toolbar item.
13623 * @param menu If @c EINA_TRUE, @p item will opens a menu when selected.
13625 * A toolbar item can be set to be a menu, using this function.
13627 * Once it is set to be a menu, it can be manipulated through the
13628 * menu-like function elm_toolbar_menu_parent_set() and the other
13629 * elm_menu functions, using the Evas_Object @c menu returned by
13630 * elm_toolbar_item_menu_get().
13632 * So, items to be displayed in this item's menu should be added with
13633 * elm_menu_item_add().
13635 * The following code exemplifies the most basic usage:
13637 * tb = elm_toolbar_add(win)
13638 * item = elm_toolbar_item_append(tb, "refresh", "Menu", NULL, NULL);
13639 * elm_toolbar_item_menu_set(item, EINA_TRUE);
13640 * elm_toolbar_menu_parent_set(tb, win);
13641 * menu = elm_toolbar_item_menu_get(item);
13642 * elm_menu_item_add(menu, NULL, "edit-cut", "Cut", NULL, NULL);
13643 * menu_item = elm_menu_item_add(menu, NULL, "edit-copy", "Copy", NULL,
13647 * @see elm_toolbar_item_menu_get()
13651 EAPI void elm_toolbar_item_menu_set(Elm_Toolbar_Item *item, Eina_Bool menu) EINA_ARG_NONNULL(1);
13654 * Get toolbar item's menu.
13656 * @param item The toolbar item.
13657 * @return Item's menu object or @c NULL on failure.
13659 * If @p item wasn't set as menu item with elm_toolbar_item_menu_set(),
13660 * this function will set it.
13662 * @see elm_toolbar_item_menu_set() for details.
13666 EAPI Evas_Object *elm_toolbar_item_menu_get(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13669 * Add a new state to @p item.
13671 * @param item The item.
13672 * @param icon A string with icon name or the absolute path of an image file.
13673 * @param label The label of the new state.
13674 * @param func The function to call when the item is clicked when this
13675 * state is selected.
13676 * @param data The data to associate with the state.
13677 * @return The toolbar item state, or @c NULL upon failure.
13679 * Toolbar will load icon image from fdo or current theme.
13680 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
13681 * If an absolute path is provided it will load it direct from a file.
13683 * States created with this function can be removed with
13684 * elm_toolbar_item_state_del().
13686 * @see elm_toolbar_item_state_del()
13687 * @see elm_toolbar_item_state_sel()
13688 * @see elm_toolbar_item_state_get()
13692 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);
13695 * Delete a previoulsy added state to @p item.
13697 * @param item The toolbar item.
13698 * @param state The state to be deleted.
13699 * @return @c EINA_TRUE on success or @c EINA_FALSE on failure.
13701 * @see elm_toolbar_item_state_add()
13703 EAPI Eina_Bool elm_toolbar_item_state_del(Elm_Toolbar_Item *item, Elm_Toolbar_Item_State *state) EINA_ARG_NONNULL(1);
13706 * Set @p state as the current state of @p it.
13708 * @param it The item.
13709 * @param state The state to use.
13710 * @return @c EINA_TRUE on success or @c EINA_FALSE on failure.
13712 * If @p state is @c NULL, it won't select any state and the default item's
13713 * icon and label will be used. It's the same behaviour than
13714 * elm_toolbar_item_state_unser().
13716 * @see elm_toolbar_item_state_unset()
13720 EAPI Eina_Bool elm_toolbar_item_state_set(Elm_Toolbar_Item *it, Elm_Toolbar_Item_State *state) EINA_ARG_NONNULL(1);
13723 * Unset the state of @p it.
13725 * @param it The item.
13727 * The default icon and label from this item will be displayed.
13729 * @see elm_toolbar_item_state_set() for more details.
13733 EAPI void elm_toolbar_item_state_unset(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
13736 * Get the current state of @p it.
13738 * @param item The item.
13739 * @return The selected state or @c NULL if none is selected or on failure.
13741 * @see elm_toolbar_item_state_set() for details.
13742 * @see elm_toolbar_item_state_unset()
13743 * @see elm_toolbar_item_state_add()
13747 EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_get(const Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
13750 * Get the state after selected state in toolbar's @p item.
13752 * @param it The toolbar item to change state.
13753 * @return The state after current state, or @c NULL on failure.
13755 * If last state is selected, this function will return first state.
13757 * @see elm_toolbar_item_state_set()
13758 * @see elm_toolbar_item_state_add()
13762 EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_next(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
13765 * Get the state before selected state in toolbar's @p item.
13767 * @param it The toolbar item to change state.
13768 * @return The state before current state, or @c NULL on failure.
13770 * If first state is selected, this function will return last state.
13772 * @see elm_toolbar_item_state_set()
13773 * @see elm_toolbar_item_state_add()
13777 EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_prev(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
13780 * Set the text to be shown in a given toolbar item's tooltips.
13782 * @param item Target item.
13783 * @param text The text to set in the content.
13785 * Setup the text as tooltip to object. The item can have only one tooltip,
13786 * so any previous tooltip data - set with this function or
13787 * elm_toolbar_item_tooltip_content_cb_set() - is removed.
13789 * @see elm_object_tooltip_text_set() for more details.
13793 EAPI void elm_toolbar_item_tooltip_text_set(Elm_Toolbar_Item *item, const char *text) EINA_ARG_NONNULL(1);
13796 * Set the content to be shown in the tooltip item.
13798 * Setup the tooltip to item. The item can have only one tooltip,
13799 * so any previous tooltip data is removed. @p func(with @p data) will
13800 * be called every time that need show the tooltip and it should
13801 * return a valid Evas_Object. This object is then managed fully by
13802 * tooltip system and is deleted when the tooltip is gone.
13804 * @param item the toolbar item being attached a tooltip.
13805 * @param func the function used to create the tooltip contents.
13806 * @param data what to provide to @a func as callback data/context.
13807 * @param del_cb called when data is not needed anymore, either when
13808 * another callback replaces @a func, the tooltip is unset with
13809 * elm_toolbar_item_tooltip_unset() or the owner @a item
13810 * dies. This callback receives as the first parameter the
13811 * given @a data, and @c event_info is the item.
13813 * @see elm_object_tooltip_content_cb_set() for more details.
13817 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);
13820 * Unset tooltip from item.
13822 * @param item toolbar item to remove previously set tooltip.
13824 * Remove tooltip from item. The callback provided as del_cb to
13825 * elm_toolbar_item_tooltip_content_cb_set() will be called to notify
13826 * it is not used anymore.
13828 * @see elm_object_tooltip_unset() for more details.
13829 * @see elm_toolbar_item_tooltip_content_cb_set()
13833 EAPI void elm_toolbar_item_tooltip_unset(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13836 * Sets a different style for this item tooltip.
13838 * @note before you set a style you should define a tooltip with
13839 * elm_toolbar_item_tooltip_content_cb_set() or
13840 * elm_toolbar_item_tooltip_text_set()
13842 * @param item toolbar item with tooltip already set.
13843 * @param style the theme style to use (default, transparent, ...)
13845 * @see elm_object_tooltip_style_set() for more details.
13849 EAPI void elm_toolbar_item_tooltip_style_set(Elm_Toolbar_Item *item, const char *style) EINA_ARG_NONNULL(1);
13852 * Get the style for this item tooltip.
13854 * @param item toolbar item with tooltip already set.
13855 * @return style the theme style in use, defaults to "default". If the
13856 * object does not have a tooltip set, then NULL is returned.
13858 * @see elm_object_tooltip_style_get() for more details.
13859 * @see elm_toolbar_item_tooltip_style_set()
13863 EAPI const char *elm_toolbar_item_tooltip_style_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13866 * Set the type of mouse pointer/cursor decoration to be shown,
13867 * when the mouse pointer is over the given toolbar widget item
13869 * @param item toolbar item to customize cursor on
13870 * @param cursor the cursor type's name
13872 * This function works analogously as elm_object_cursor_set(), but
13873 * here the cursor's changing area is restricted to the item's
13874 * area, and not the whole widget's. Note that that item cursors
13875 * have precedence over widget cursors, so that a mouse over an
13876 * item with custom cursor set will always show @b that cursor.
13878 * If this function is called twice for an object, a previously set
13879 * cursor will be unset on the second call.
13881 * @see elm_object_cursor_set()
13882 * @see elm_toolbar_item_cursor_get()
13883 * @see elm_toolbar_item_cursor_unset()
13887 EAPI void elm_toolbar_item_cursor_set(Elm_Toolbar_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
13890 * Get the type of mouse pointer/cursor decoration set to be shown,
13891 * when the mouse pointer is over the given toolbar widget item
13893 * @param item toolbar item with custom cursor set
13894 * @return the cursor type's name or @c NULL, if no custom cursors
13895 * were set to @p item (and on errors)
13897 * @see elm_object_cursor_get()
13898 * @see elm_toolbar_item_cursor_set()
13899 * @see elm_toolbar_item_cursor_unset()
13903 EAPI const char *elm_toolbar_item_cursor_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13906 * Unset any custom mouse pointer/cursor decoration set to be
13907 * shown, when the mouse pointer is over the given toolbar widget
13908 * item, thus making it show the @b default cursor again.
13910 * @param item a toolbar item
13912 * Use this call to undo any custom settings on this item's cursor
13913 * decoration, bringing it back to defaults (no custom style set).
13915 * @see elm_object_cursor_unset()
13916 * @see elm_toolbar_item_cursor_set()
13920 EAPI void elm_toolbar_item_cursor_unset(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13923 * Set a different @b style for a given custom cursor set for a
13926 * @param item toolbar item with custom cursor set
13927 * @param style the <b>theme style</b> to use (e.g. @c "default",
13928 * @c "transparent", etc)
13930 * This function only makes sense when one is using custom mouse
13931 * cursor decorations <b>defined in a theme file</b>, which can have,
13932 * given a cursor name/type, <b>alternate styles</b> on it. It
13933 * works analogously as elm_object_cursor_style_set(), but here
13934 * applyed only to toolbar item objects.
13936 * @warning Before you set a cursor style you should have definen a
13937 * custom cursor previously on the item, with
13938 * elm_toolbar_item_cursor_set()
13940 * @see elm_toolbar_item_cursor_engine_only_set()
13941 * @see elm_toolbar_item_cursor_style_get()
13945 EAPI void elm_toolbar_item_cursor_style_set(Elm_Toolbar_Item *item, const char *style) EINA_ARG_NONNULL(1);
13948 * Get the current @b style set for a given toolbar item's custom
13951 * @param item toolbar item with custom cursor set.
13952 * @return style the cursor style in use. If the object does not
13953 * have a cursor set, then @c NULL is returned.
13955 * @see elm_toolbar_item_cursor_style_set() for more details
13959 EAPI const char *elm_toolbar_item_cursor_style_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13962 * Set if the (custom)cursor for a given toolbar item should be
13963 * searched in its theme, also, or should only rely on the
13964 * rendering engine.
13966 * @param item item with custom (custom) cursor already set on
13967 * @param engine_only Use @c EINA_TRUE to have cursors looked for
13968 * only on those provided by the rendering engine, @c EINA_FALSE to
13969 * have them searched on the widget's theme, as well.
13971 * @note This call is of use only if you've set a custom cursor
13972 * for toolbar items, with elm_toolbar_item_cursor_set().
13974 * @note By default, cursors will only be looked for between those
13975 * provided by the rendering engine.
13979 EAPI void elm_toolbar_item_cursor_engine_only_set(Elm_Toolbar_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
13982 * Get if the (custom) cursor for a given toolbar item is being
13983 * searched in its theme, also, or is only relying on the rendering
13986 * @param item a toolbar item
13987 * @return @c EINA_TRUE, if cursors are being looked for only on
13988 * those provided by the rendering engine, @c EINA_FALSE if they
13989 * are being searched on the widget's theme, as well.
13991 * @see elm_toolbar_item_cursor_engine_only_set(), for more details
13995 EAPI Eina_Bool elm_toolbar_item_cursor_engine_only_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13998 * Change a toolbar's orientation
13999 * @param obj The toolbar object
14000 * @param vertical If @c EINA_TRUE, the toolbar is vertical
14001 * By default, a toolbar will be horizontal. Use this function to create a vertical toolbar.
14004 EAPI void elm_toolbar_orientation_set(Evas_Object *obj, Eina_Bool vertical) EINA_ARG_NONNULL(1);
14007 * Get a toolbar's orientation
14008 * @param obj The toolbar object
14009 * @return If @c EINA_TRUE, the toolbar is vertical
14010 * By default, a toolbar will be horizontal. Use this function to determine whether a toolbar is vertical.
14013 EAPI Eina_Bool elm_toolbar_orientation_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
14020 * @defgroup Tooltips Tooltips
14022 * The Tooltip is an (internal, for now) smart object used to show a
14023 * content in a frame on mouse hover of objects(or widgets), with
14024 * tips/information about them.
14029 EAPI double elm_tooltip_delay_get(void);
14030 EAPI Eina_Bool elm_tooltip_delay_set(double delay);
14031 EAPI void elm_object_tooltip_show(Evas_Object *obj) EINA_ARG_NONNULL(1);
14032 EAPI void elm_object_tooltip_hide(Evas_Object *obj) EINA_ARG_NONNULL(1);
14033 EAPI void elm_object_tooltip_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1, 2);
14034 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);
14035 EAPI void elm_object_tooltip_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
14036 EAPI void elm_object_tooltip_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
14037 EAPI const char *elm_object_tooltip_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14038 EAPI Eina_Bool elm_tooltip_size_restrict_disable(Evas_Object *obj, Eina_Bool disable); EINA_ARG_NONNULL(1);
14039 EAPI Eina_Bool elm_tooltip_size_restrict_disabled_get(const Evas_Object *obj); EINA_ARG_NONNULL(1);
14046 * @defgroup Cursors Cursors
14048 * The Elementary cursor is an internal smart object used to
14049 * customize the mouse cursor displayed over objects (or
14050 * widgets). In the most common scenario, the cursor decoration
14051 * comes from the graphical @b engine Elementary is running
14052 * on. Those engines may provide different decorations for cursors,
14053 * and Elementary provides functions to choose them (think of X11
14054 * cursors, as an example).
14056 * There's also the possibility of, besides using engine provided
14057 * cursors, also use ones coming from Edje theming files. Both
14058 * globally and per widget, Elementary makes it possible for one to
14059 * make the cursors lookup to be held on engines only or on
14060 * Elementary's theme file, too.
14066 * Set the cursor to be shown when mouse is over the object
14068 * Set the cursor that will be displayed when mouse is over the
14069 * object. The object can have only one cursor set to it, so if
14070 * this function is called twice for an object, the previous set
14072 * If using X cursors, a definition of all the valid cursor names
14073 * is listed on Elementary_Cursors.h. If an invalid name is set
14074 * the default cursor will be used.
14076 * @param obj the object being set a cursor.
14077 * @param cursor the cursor name to be used.
14081 EAPI void elm_object_cursor_set(Evas_Object *obj, const char *cursor) EINA_ARG_NONNULL(1);
14084 * Get the cursor to be shown when mouse is over the object
14086 * @param obj an object with cursor already set.
14087 * @return the cursor name.
14091 EAPI const char *elm_object_cursor_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14094 * Unset cursor for object
14096 * Unset cursor for object, and set the cursor to default if the mouse
14097 * was over this object.
14099 * @param obj Target object
14100 * @see elm_object_cursor_set()
14104 EAPI void elm_object_cursor_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
14107 * Sets a different style for this object cursor.
14109 * @note before you set a style you should define a cursor with
14110 * elm_object_cursor_set()
14112 * @param obj an object with cursor already set.
14113 * @param style the theme style to use (default, transparent, ...)
14117 EAPI void elm_object_cursor_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
14120 * Get the style for this object cursor.
14122 * @param obj an object with cursor already set.
14123 * @return style the theme style in use, defaults to "default". If the
14124 * object does not have a cursor set, then NULL is returned.
14128 EAPI const char *elm_object_cursor_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14131 * Set if the cursor set should be searched on the theme or should use
14132 * the provided by the engine, only.
14134 * @note before you set if should look on theme you should define a cursor
14135 * with elm_object_cursor_set(). By default it will only look for cursors
14136 * provided by the engine.
14138 * @param obj an object with cursor already set.
14139 * @param engine_only boolean to define it cursors should be looked only
14140 * between the provided by the engine or searched on widget's theme as well.
14144 EAPI void elm_object_cursor_engine_only_set(Evas_Object *obj, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
14147 * Get the cursor engine only usage for this object cursor.
14149 * @param obj an object with cursor already set.
14150 * @return engine_only boolean to define it cursors should be
14151 * looked only between the provided by the engine or searched on
14152 * widget's theme as well. If the object does not have a cursor
14153 * set, then EINA_FALSE is returned.
14157 EAPI Eina_Bool elm_object_cursor_engine_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14160 * Get the configured cursor engine only usage
14162 * This gets the globally configured exclusive usage of engine cursors.
14164 * @return 1 if only engine cursors should be used
14167 EAPI int elm_cursor_engine_only_get(void);
14170 * Set the configured cursor engine only usage
14172 * This sets the globally configured exclusive usage of engine cursors.
14173 * It won't affect cursors set before changing this value.
14175 * @param engine_only If 1 only engine cursors will be enabled, if 0 will
14176 * look for them on theme before.
14177 * @return EINA_TRUE if value is valid and setted (0 or 1)
14180 EAPI Eina_Bool elm_cursor_engine_only_set(int engine_only);
14187 * @defgroup Menu Menu
14189 * @image html img/widget/menu/preview-00.png
14190 * @image latex img/widget/menu/preview-00.eps
14192 * A menu is a list of items displayed above its parent. When the menu is
14193 * showing its parent is darkened. Each item can have a sub-menu. The menu
14194 * object can be used to display a menu on a right click event, in a toolbar,
14197 * Signals that you can add callbacks for are:
14198 * @li "clicked" - the user clicked the empty space in the menu to dismiss.
14199 * event_info is NULL.
14201 * @see @ref tutorial_menu
14204 typedef struct _Elm_Menu_Item Elm_Menu_Item; /**< Item of Elm_Menu. Sub-type of Elm_Widget_Item */
14206 * @brief Add a new menu to the parent
14208 * @param parent The parent object.
14209 * @return The new object or NULL if it cannot be created.
14211 EAPI Evas_Object *elm_menu_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
14213 * @brief Set the parent for the given menu widget
14215 * @param obj The menu object.
14216 * @param parent The new parent.
14218 EAPI void elm_menu_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
14220 * @brief Get the parent for the given menu widget
14222 * @param obj The menu object.
14223 * @return The parent.
14225 * @see elm_menu_parent_set()
14227 EAPI Evas_Object *elm_menu_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14229 * @brief Move the menu to a new position
14231 * @param obj The menu object.
14232 * @param x The new position.
14233 * @param y The new position.
14235 * Sets the top-left position of the menu to (@p x,@p y).
14237 * @note @p x and @p y coordinates are relative to parent.
14239 EAPI void elm_menu_move(Evas_Object *obj, Evas_Coord x, Evas_Coord y) EINA_ARG_NONNULL(1);
14241 * @brief Close a opened menu
14243 * @param obj the menu object
14246 * Hides the menu and all it's sub-menus.
14248 EAPI void elm_menu_close(Evas_Object *obj) EINA_ARG_NONNULL(1);
14250 * @brief Returns a list of @p item's items.
14252 * @param obj The menu object
14253 * @return An Eina_List* of @p item's items
14255 EAPI const Eina_List *elm_menu_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14257 * @brief Get the Evas_Object of an Elm_Menu_Item
14259 * @param item The menu item object.
14260 * @return The edje object containing the swallowed content
14262 * @warning Don't manipulate this object!
14264 EAPI Evas_Object *elm_menu_item_object_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
14266 * @brief Add an item at the end of the given menu widget
14268 * @param obj The menu object.
14269 * @param parent The parent menu item (optional)
14270 * @param icon A icon display on the item. The icon will be destryed by the menu.
14271 * @param label The label of the item.
14272 * @param func Function called when the user select the item.
14273 * @param data Data sent by the callback.
14274 * @return Returns the new item.
14276 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);
14278 * @brief Add an object swallowed in an item at the end of the given menu
14281 * @param obj The menu object.
14282 * @param parent The parent menu item (optional)
14283 * @param subobj The object to swallow
14284 * @param func Function called when the user select the item.
14285 * @param data Data sent by the callback.
14286 * @return Returns the new item.
14288 * Add an evas object as an item to the menu.
14290 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);
14292 * @brief Set the label of a menu item
14294 * @param item The menu item object.
14295 * @param label The label to set for @p item
14297 * @warning Don't use this funcion on items created with
14298 * elm_menu_item_add_object() or elm_menu_item_separator_add().
14300 EAPI void elm_menu_item_label_set(Elm_Menu_Item *item, const char *label) EINA_ARG_NONNULL(1);
14302 * @brief Get the label of a menu item
14304 * @param item The menu item object.
14305 * @return The label of @p item
14307 EAPI const char *elm_menu_item_label_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
14309 * @brief Set the icon of a menu item to the standard icon with name @p icon
14311 * @param item The menu item object.
14312 * @param icon The icon object to set for the content of @p item
14314 * Once this icon is set, any previously set icon will be deleted.
14316 EAPI void elm_menu_item_object_icon_name_set(Elm_Menu_Item *item, const char *icon) EINA_ARG_NONNULL(1, 2);
14318 * @brief Get the string representation from the icon of a menu item
14320 * @param item The menu item object.
14321 * @return The string representation of @p item's icon or NULL
14323 * @see elm_menu_item_object_icon_name_set()
14325 EAPI const char *elm_menu_item_object_icon_name_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
14327 * @brief Set the content object of a menu item
14329 * @param item The menu item object
14330 * @param The content object or NULL
14331 * @return EINA_TRUE on success, else EINA_FALSE
14333 * Use this function to change the object swallowed by a menu item, deleting
14334 * any previously swallowed object.
14336 EAPI Eina_Bool elm_menu_item_object_content_set(Elm_Menu_Item *item, Evas_Object *obj) EINA_ARG_NONNULL(1);
14338 * @brief Get the content object of a menu item
14340 * @param item The menu item object
14341 * @return The content object or NULL
14342 * @note If @p item was added with elm_menu_item_add_object, this
14343 * function will return the object passed, else it will return the
14346 * @see elm_menu_item_object_content_set()
14348 EAPI Evas_Object *elm_menu_item_object_content_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
14350 * @brief Set the selected state of @p item.
14352 * @param item The menu item object.
14353 * @param selected The selected/unselected state of the item
14355 EAPI void elm_menu_item_selected_set(Elm_Menu_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
14357 * @brief Get the selected state of @p item.
14359 * @param item The menu item object.
14360 * @return The selected/unselected state of the item
14362 * @see elm_menu_item_selected_set()
14364 EAPI Eina_Bool elm_menu_item_selected_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
14366 * @brief Set the disabled state of @p item.
14368 * @param item The menu item object.
14369 * @param disabled The enabled/disabled state of the item
14371 EAPI void elm_menu_item_disabled_set(Elm_Menu_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
14373 * @brief Get the disabled state of @p item.
14375 * @param item The menu item object.
14376 * @return The enabled/disabled state of the item
14378 * @see elm_menu_item_disabled_set()
14380 EAPI Eina_Bool elm_menu_item_disabled_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
14382 * @brief Add a separator item to menu @p obj under @p parent.
14384 * @param obj The menu object
14385 * @param parent The item to add the separator under
14386 * @return The created item or NULL on failure
14388 * This is item is a @ref Separator.
14390 EAPI Elm_Menu_Item *elm_menu_item_separator_add(Evas_Object *obj, Elm_Menu_Item *parent) EINA_ARG_NONNULL(1);
14392 * @brief Returns whether @p item is a separator.
14394 * @param item The item to check
14395 * @return If true, @p item is a separator
14397 * @see elm_menu_item_separator_add()
14399 EAPI Eina_Bool elm_menu_item_is_separator(Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
14401 * @brief Deletes an item from the menu.
14403 * @param item The item to delete.
14405 * @see elm_menu_item_add()
14407 EAPI void elm_menu_item_del(Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
14409 * @brief Set the function called when a menu item is deleted.
14411 * @param item The item to set the callback on
14412 * @param func The function called
14414 * @see elm_menu_item_add()
14415 * @see elm_menu_item_del()
14417 EAPI void elm_menu_item_del_cb_set(Elm_Menu_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
14419 * @brief Returns the data associated with menu item @p item.
14421 * @param item The item
14422 * @return The data associated with @p item or NULL if none was set.
14424 * This is the data set with elm_menu_add() or elm_menu_item_data_set().
14426 EAPI void *elm_menu_item_data_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
14428 * @brief Sets the data to be associated with menu item @p item.
14430 * @param item The item
14431 * @param data The data to be associated with @p item
14433 EAPI void elm_menu_item_data_set(Elm_Menu_Item *item, const void *data) EINA_ARG_NONNULL(1);
14435 * @brief Returns a list of @p item's subitems.
14437 * @param item The item
14438 * @return An Eina_List* of @p item's subitems
14440 * @see elm_menu_add()
14442 EAPI const Eina_List *elm_menu_item_subitems_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
14444 * @brief Get the position of a menu item
14446 * @param item The menu item
14447 * @return The item's index
14449 * This function returns the index position of a menu item in a menu.
14450 * For a sub-menu, this number is relative to the first item in the sub-menu.
14452 * @note Index values begin with 0
14454 EAPI unsigned int elm_menu_item_index_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1) EINA_PURE;
14456 * @brief @brief Return a menu item's owner menu
14458 * @param item The menu item
14459 * @return The menu object owning @p item, or NULL on failure
14461 * Use this function to get the menu object owning an item.
14463 EAPI Evas_Object *elm_menu_item_menu_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1) EINA_PURE;
14465 * @brief Get the selected item in the menu
14467 * @param obj The menu object
14468 * @return The selected item, or NULL if none
14470 * @see elm_menu_item_selected_get()
14471 * @see elm_menu_item_selected_set()
14473 EAPI Elm_Menu_Item *elm_menu_selected_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
14475 * @brief Get the last item in the menu
14477 * @param obj The menu object
14478 * @return The last item, or NULL if none
14480 EAPI Elm_Menu_Item *elm_menu_last_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
14482 * @brief Get the first item in the menu
14484 * @param obj The menu object
14485 * @return The first item, or NULL if none
14487 EAPI Elm_Menu_Item *elm_menu_first_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
14489 * @brief Get the next item in the menu.
14491 * @param item The menu item object.
14492 * @return The item after it, or NULL if none
14494 EAPI Elm_Menu_Item *elm_menu_item_next_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
14496 * @brief Get the previous item in the menu.
14498 * @param item The menu item object.
14499 * @return The item before it, or NULL if none
14501 EAPI Elm_Menu_Item *elm_menu_item_prev_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
14507 * @defgroup List List
14508 * @ingroup Elementary
14510 * @image html img/widget/list/preview-00.png
14511 * @image latex img/widget/list/preview-00.eps width=\textwidth
14513 * @image html img/list.png
14514 * @image latex img/list.eps width=\textwidth
14516 * A list widget is a container whose children are displayed vertically or
14517 * horizontally, in order, and can be selected.
14518 * The list can accept only one or multiple items selection. Also has many
14519 * modes of items displaying.
14521 * A list is a very simple type of list widget. For more robust
14522 * lists, @ref Genlist should probably be used.
14524 * Smart callbacks one can listen to:
14525 * - @c "activated" - The user has double-clicked or pressed
14526 * (enter|return|spacebar) on an item. The @c event_info parameter
14527 * is the item that was activated.
14528 * - @c "clicked,double" - The user has double-clicked an item.
14529 * The @c event_info parameter is the item that was double-clicked.
14530 * - "selected" - when the user selected an item
14531 * - "unselected" - when the user unselected an item
14532 * - "longpressed" - an item in the list is long-pressed
14533 * - "scroll,edge,top" - the list is scrolled until the top edge
14534 * - "scroll,edge,bottom" - the list is scrolled until the bottom edge
14535 * - "scroll,edge,left" - the list is scrolled until the left edge
14536 * - "scroll,edge,right" - the list is scrolled until the right edge
14538 * Available styles for it:
14541 * List of examples:
14542 * @li @ref list_example_01
14543 * @li @ref list_example_02
14544 * @li @ref list_example_03
14553 * @enum _Elm_List_Mode
14554 * @typedef Elm_List_Mode
14556 * Set list's resize behavior, transverse axis scroll and
14557 * items cropping. See each mode's description for more details.
14559 * @note Default value is #ELM_LIST_SCROLL.
14561 * Values <b> don't </b> work as bitmask, only one can be choosen.
14563 * @see elm_list_mode_set()
14564 * @see elm_list_mode_get()
14568 typedef enum _Elm_List_Mode
14570 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. */
14571 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). */
14572 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. */
14573 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. */
14574 ELM_LIST_LAST /**< Indicates error if returned by elm_list_mode_get() */
14577 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(). */
14580 * Add a new list widget to the given parent Elementary
14581 * (container) object.
14583 * @param parent The parent object.
14584 * @return a new list widget handle or @c NULL, on errors.
14586 * This function inserts a new list widget on the canvas.
14590 EAPI Evas_Object *elm_list_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
14595 * @param obj The list object
14597 * @note Call before running show() on the list object.
14598 * @warning If not called, it won't display the list properly.
14601 * li = elm_list_add(win);
14602 * elm_list_item_append(li, "First", NULL, NULL, NULL, NULL);
14603 * elm_list_item_append(li, "Second", NULL, NULL, NULL, NULL);
14605 * evas_object_show(li);
14610 EAPI void elm_list_go(Evas_Object *obj) EINA_ARG_NONNULL(1);
14613 * Enable or disable multiple items selection on the list object.
14615 * @param obj The list object
14616 * @param multi @c EINA_TRUE to enable multi selection or @c EINA_FALSE to
14619 * Disabled by default. If disabled, the user can select a single item of
14620 * the list each time. Selected items are highlighted on list.
14621 * If enabled, many items can be selected.
14623 * If a selected item is selected again, it will be unselected.
14625 * @see elm_list_multi_select_get()
14629 EAPI void elm_list_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
14632 * Get a value whether multiple items selection is enabled or not.
14634 * @see elm_list_multi_select_set() for details.
14636 * @param obj The list object.
14637 * @return @c EINA_TRUE means multiple items selection is enabled.
14638 * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
14639 * @c EINA_FALSE is returned.
14643 EAPI Eina_Bool elm_list_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14646 * Set which mode to use for the list object.
14648 * @param obj The list object
14649 * @param mode One of #Elm_List_Mode: #ELM_LIST_COMPRESS, #ELM_LIST_SCROLL,
14650 * #ELM_LIST_LIMIT or #ELM_LIST_EXPAND.
14652 * Set list's resize behavior, transverse axis scroll and
14653 * items cropping. See each mode's description for more details.
14655 * @note Default value is #ELM_LIST_SCROLL.
14657 * Only one can be set, if a previous one was set, it will be changed
14658 * by the new mode set. Bitmask won't work as well.
14660 * @see elm_list_mode_get()
14664 EAPI void elm_list_mode_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
14667 * Get the mode the list is at.
14669 * @param obj The list object
14670 * @return One of #Elm_List_Mode: #ELM_LIST_COMPRESS, #ELM_LIST_SCROLL,
14671 * #ELM_LIST_LIMIT, #ELM_LIST_EXPAND or #ELM_LIST_LAST on errors.
14673 * @note see elm_list_mode_set() for more information.
14677 EAPI Elm_List_Mode elm_list_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14680 * Enable or disable horizontal mode on the list object.
14682 * @param obj The list object.
14683 * @param horizontal @c EINA_TRUE to enable horizontal or @c EINA_FALSE to
14684 * disable it, i.e., to enable vertical mode.
14686 * @note Vertical mode is set by default.
14688 * On horizontal mode items are displayed on list from left to right,
14689 * instead of from top to bottom. Also, the list will scroll horizontally.
14690 * Each item will presents left icon on top and right icon, or end, at
14693 * @see elm_list_horizontal_get()
14697 EAPI void elm_list_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
14700 * Get a value whether horizontal mode is enabled or not.
14702 * @param obj The list object.
14703 * @return @c EINA_TRUE means horizontal mode selection is enabled.
14704 * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
14705 * @c EINA_FALSE is returned.
14707 * @see elm_list_horizontal_set() for details.
14711 EAPI Eina_Bool elm_list_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14714 * Enable or disable always select mode on the list object.
14716 * @param obj The list object
14717 * @param always_select @c EINA_TRUE to enable always select mode or
14718 * @c EINA_FALSE to disable it.
14720 * @note Always select mode is disabled by default.
14722 * Default behavior of list items is to only call its callback function
14723 * the first time it's pressed, i.e., when it is selected. If a selected
14724 * item is pressed again, and multi-select is disabled, it won't call
14725 * this function (if multi-select is enabled it will unselect the item).
14727 * If always select is enabled, it will call the callback function
14728 * everytime a item is pressed, so it will call when the item is selected,
14729 * and again when a selected item is pressed.
14731 * @see elm_list_always_select_mode_get()
14732 * @see elm_list_multi_select_set()
14736 EAPI void elm_list_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
14739 * Get a value whether always select mode is enabled or not, meaning that
14740 * an item will always call its callback function, even if already selected.
14742 * @param obj The list object
14743 * @return @c EINA_TRUE means horizontal mode selection is enabled.
14744 * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
14745 * @c EINA_FALSE is returned.
14747 * @see elm_list_always_select_mode_set() for details.
14751 EAPI Eina_Bool elm_list_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14754 * Set bouncing behaviour when the scrolled content reaches an edge.
14756 * Tell the internal scroller object whether it should bounce or not
14757 * when it reaches the respective edges for each axis.
14759 * @param obj The list object
14760 * @param h_bounce Whether to bounce or not in the horizontal axis.
14761 * @param v_bounce Whether to bounce or not in the vertical axis.
14763 * @see elm_scroller_bounce_set()
14767 EAPI void elm_list_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
14770 * Get the bouncing behaviour of the internal scroller.
14772 * Get whether the internal scroller should bounce when the edge of each
14773 * axis is reached scrolling.
14775 * @param obj The list object.
14776 * @param h_bounce Pointer where to store the bounce state of the horizontal
14778 * @param v_bounce Pointer where to store the bounce state of the vertical
14781 * @see elm_scroller_bounce_get()
14782 * @see elm_list_bounce_set()
14786 EAPI void elm_list_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
14789 * Set the scrollbar policy.
14791 * @param obj The list object
14792 * @param policy_h Horizontal scrollbar policy.
14793 * @param policy_v Vertical scrollbar policy.
14795 * This sets the scrollbar visibility policy for the given scroller.
14796 * #ELM_SCROLLER_POLICY_AUTO means the scrollber is made visible if it
14797 * is needed, and otherwise kept hidden. #ELM_SCROLLER_POLICY_ON turns
14798 * it on all the time, and #ELM_SCROLLER_POLICY_OFF always keeps it off.
14799 * This applies respectively for the horizontal and vertical scrollbars.
14801 * The both are disabled by default, i.e., are set to
14802 * #ELM_SCROLLER_POLICY_OFF.
14806 EAPI void elm_list_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
14809 * Get the scrollbar policy.
14811 * @see elm_list_scroller_policy_get() for details.
14813 * @param obj The list object.
14814 * @param policy_h Pointer where to store horizontal scrollbar policy.
14815 * @param policy_v Pointer where to store vertical scrollbar policy.
14819 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);
14822 * Append a new item to the list object.
14824 * @param obj The list object.
14825 * @param label The label of the list item.
14826 * @param icon The icon object to use for the left side of the item. An
14827 * icon can be any Evas object, but usually it is an icon created
14828 * with elm_icon_add().
14829 * @param end The icon object to use for the right side of the item. An
14830 * icon can be any Evas object.
14831 * @param func The function to call when the item is clicked.
14832 * @param data The data to associate with the item for related callbacks.
14834 * @return The created item or @c NULL upon failure.
14836 * A new item will be created and appended to the list, i.e., will
14837 * be set as @b last item.
14839 * Items created with this method can be deleted with
14840 * elm_list_item_del().
14842 * Associated @p data can be properly freed when item is deleted if a
14843 * callback function is set with elm_list_item_del_cb_set().
14845 * If a function is passed as argument, it will be called everytime this item
14846 * is selected, i.e., the user clicks over an unselected item.
14847 * If always select is enabled it will call this function every time
14848 * user clicks over an item (already selected or not).
14849 * If such function isn't needed, just passing
14850 * @c NULL as @p func is enough. The same should be done for @p data.
14852 * Simple example (with no function callback or data associated):
14854 * li = elm_list_add(win);
14855 * ic = elm_icon_add(win);
14856 * elm_icon_file_set(ic, "path/to/image", NULL);
14857 * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
14858 * elm_list_item_append(li, "label", ic, NULL, NULL, NULL);
14860 * evas_object_show(li);
14863 * @see elm_list_always_select_mode_set()
14864 * @see elm_list_item_del()
14865 * @see elm_list_item_del_cb_set()
14866 * @see elm_list_clear()
14867 * @see elm_icon_add()
14871 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);
14874 * Prepend a new item to the list object.
14876 * @param obj The list object.
14877 * @param label The label of the list item.
14878 * @param icon The icon object to use for the left side of the item. An
14879 * icon can be any Evas object, but usually it is an icon created
14880 * with elm_icon_add().
14881 * @param end The icon object to use for the right side of the item. An
14882 * icon can be any Evas object.
14883 * @param func The function to call when the item is clicked.
14884 * @param data The data to associate with the item for related callbacks.
14886 * @return The created item or @c NULL upon failure.
14888 * A new item will be created and prepended to the list, i.e., will
14889 * be set as @b first item.
14891 * Items created with this method can be deleted with
14892 * elm_list_item_del().
14894 * Associated @p data can be properly freed when item is deleted if a
14895 * callback function is set with elm_list_item_del_cb_set().
14897 * If a function is passed as argument, it will be called everytime this item
14898 * is selected, i.e., the user clicks over an unselected item.
14899 * If always select is enabled it will call this function every time
14900 * user clicks over an item (already selected or not).
14901 * If such function isn't needed, just passing
14902 * @c NULL as @p func is enough. The same should be done for @p data.
14904 * @see elm_list_item_append() for a simple code example.
14905 * @see elm_list_always_select_mode_set()
14906 * @see elm_list_item_del()
14907 * @see elm_list_item_del_cb_set()
14908 * @see elm_list_clear()
14909 * @see elm_icon_add()
14913 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);
14916 * Insert a new item into the list object before item @p before.
14918 * @param obj The list object.
14919 * @param before The list item to insert before.
14920 * @param label The label of the list item.
14921 * @param icon The icon object to use for the left side of the item. An
14922 * icon can be any Evas object, but usually it is an icon created
14923 * with elm_icon_add().
14924 * @param end The icon object to use for the right side of the item. An
14925 * icon can be any Evas object.
14926 * @param func The function to call when the item is clicked.
14927 * @param data The data to associate with the item for related callbacks.
14929 * @return The created item or @c NULL upon failure.
14931 * A new item will be created and added to the list. Its position in
14932 * this list will be just before item @p before.
14934 * Items created with this method can be deleted with
14935 * elm_list_item_del().
14937 * Associated @p data can be properly freed when item is deleted if a
14938 * callback function is set with elm_list_item_del_cb_set().
14940 * If a function is passed as argument, it will be called everytime this item
14941 * is selected, i.e., the user clicks over an unselected item.
14942 * If always select is enabled it will call this function every time
14943 * user clicks over an item (already selected or not).
14944 * If such function isn't needed, just passing
14945 * @c NULL as @p func is enough. The same should be done for @p data.
14947 * @see elm_list_item_append() for a simple code example.
14948 * @see elm_list_always_select_mode_set()
14949 * @see elm_list_item_del()
14950 * @see elm_list_item_del_cb_set()
14951 * @see elm_list_clear()
14952 * @see elm_icon_add()
14956 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);
14959 * Insert a new item into the list object after item @p after.
14961 * @param obj The list object.
14962 * @param after The list item to insert after.
14963 * @param label The label of the list item.
14964 * @param icon The icon object to use for the left side of the item. An
14965 * icon can be any Evas object, but usually it is an icon created
14966 * with elm_icon_add().
14967 * @param end The icon object to use for the right side of the item. An
14968 * icon can be any Evas object.
14969 * @param func The function to call when the item is clicked.
14970 * @param data The data to associate with the item for related callbacks.
14972 * @return The created item or @c NULL upon failure.
14974 * A new item will be created and added to the list. Its position in
14975 * this list will be just after item @p after.
14977 * Items created with this method can be deleted with
14978 * elm_list_item_del().
14980 * Associated @p data can be properly freed when item is deleted if a
14981 * callback function is set with elm_list_item_del_cb_set().
14983 * If a function is passed as argument, it will be called everytime this item
14984 * is selected, i.e., the user clicks over an unselected item.
14985 * If always select is enabled it will call this function every time
14986 * user clicks over an item (already selected or not).
14987 * If such function isn't needed, just passing
14988 * @c NULL as @p func is enough. The same should be done for @p data.
14990 * @see elm_list_item_append() for a simple code example.
14991 * @see elm_list_always_select_mode_set()
14992 * @see elm_list_item_del()
14993 * @see elm_list_item_del_cb_set()
14994 * @see elm_list_clear()
14995 * @see elm_icon_add()
14999 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);
15002 * Insert a new item into the sorted list object.
15004 * @param obj The list object.
15005 * @param label The label of the list item.
15006 * @param icon The icon object to use for the left side of the item. An
15007 * icon can be any Evas object, but usually it is an icon created
15008 * with elm_icon_add().
15009 * @param end The icon object to use for the right side of the item. An
15010 * icon can be any Evas object.
15011 * @param func The function to call when the item is clicked.
15012 * @param data The data to associate with the item for related callbacks.
15013 * @param cmp_func The comparing function to be used to sort list
15014 * items <b>by #Elm_List_Item item handles</b>. This function will
15015 * receive two items and compare them, returning a non-negative integer
15016 * if the second item should be place after the first, or negative value
15017 * if should be placed before.
15019 * @return The created item or @c NULL upon failure.
15021 * @note This function inserts values into a list object assuming it was
15022 * sorted and the result will be sorted.
15024 * A new item will be created and added to the list. Its position in
15025 * this list will be found comparing the new item with previously inserted
15026 * items using function @p cmp_func.
15028 * Items created with this method can be deleted with
15029 * elm_list_item_del().
15031 * Associated @p data can be properly freed when item is deleted if a
15032 * callback function is set with elm_list_item_del_cb_set().
15034 * If a function is passed as argument, it will be called everytime this item
15035 * is selected, i.e., the user clicks over an unselected item.
15036 * If always select is enabled it will call this function every time
15037 * user clicks over an item (already selected or not).
15038 * If such function isn't needed, just passing
15039 * @c NULL as @p func is enough. The same should be done for @p data.
15041 * @see elm_list_item_append() for a simple code example.
15042 * @see elm_list_always_select_mode_set()
15043 * @see elm_list_item_del()
15044 * @see elm_list_item_del_cb_set()
15045 * @see elm_list_clear()
15046 * @see elm_icon_add()
15050 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);
15053 * Remove all list's items.
15055 * @param obj The list object
15057 * @see elm_list_item_del()
15058 * @see elm_list_item_append()
15062 EAPI void elm_list_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
15065 * Get a list of all the list items.
15067 * @param obj The list object
15068 * @return An @c Eina_List of list items, #Elm_List_Item,
15069 * or @c NULL on failure.
15071 * @see elm_list_item_append()
15072 * @see elm_list_item_del()
15073 * @see elm_list_clear()
15077 EAPI const Eina_List *elm_list_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15080 * Get the selected item.
15082 * @param obj The list object.
15083 * @return The selected list item.
15085 * The selected item can be unselected with function
15086 * elm_list_item_selected_set().
15088 * The selected item always will be highlighted on list.
15090 * @see elm_list_selected_items_get()
15094 EAPI Elm_List_Item *elm_list_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15097 * Return a list of the currently selected list items.
15099 * @param obj The list object.
15100 * @return An @c Eina_List of list items, #Elm_List_Item,
15101 * or @c NULL on failure.
15103 * Multiple items can be selected if multi select is enabled. It can be
15104 * done with elm_list_multi_select_set().
15106 * @see elm_list_selected_item_get()
15107 * @see elm_list_multi_select_set()
15111 EAPI const Eina_List *elm_list_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15114 * Set the selected state of an item.
15116 * @param item The list item
15117 * @param selected The selected state
15119 * This sets the selected state of the given item @p it.
15120 * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
15122 * If a new item is selected the previosly selected will be unselected,
15123 * unless multiple selection is enabled with elm_list_multi_select_set().
15124 * Previoulsy selected item can be get with function
15125 * elm_list_selected_item_get().
15127 * Selected items will be highlighted.
15129 * @see elm_list_item_selected_get()
15130 * @see elm_list_selected_item_get()
15131 * @see elm_list_multi_select_set()
15135 EAPI void elm_list_item_selected_set(Elm_List_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
15138 * Get whether the @p item is selected or not.
15140 * @param item The list item.
15141 * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
15142 * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
15144 * @see elm_list_selected_item_set() for details.
15145 * @see elm_list_item_selected_get()
15149 EAPI Eina_Bool elm_list_item_selected_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15152 * Set or unset item as a separator.
15154 * @param it The list item.
15155 * @param setting @c EINA_TRUE to set item @p it as separator or
15156 * @c EINA_FALSE to unset, i.e., item will be used as a regular item.
15158 * Items aren't set as separator by default.
15160 * If set as separator it will display separator theme, so won't display
15163 * @see elm_list_item_separator_get()
15167 EAPI void elm_list_item_separator_set(Elm_List_Item *it, Eina_Bool setting) EINA_ARG_NONNULL(1);
15170 * Get a value whether item is a separator or not.
15172 * @see elm_list_item_separator_set() for details.
15174 * @param it The list item.
15175 * @return @c EINA_TRUE means item @p it is a separator. @c EINA_FALSE
15176 * indicates it's not. If @p it is @c NULL, @c EINA_FALSE is returned.
15180 EAPI Eina_Bool elm_list_item_separator_get(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
15183 * Show @p item in the list view.
15185 * @param item The list item to be shown.
15187 * It won't animate list until item is visible. If such behavior is wanted,
15188 * use elm_list_bring_in() intead.
15192 EAPI void elm_list_item_show(Elm_List_Item *item) EINA_ARG_NONNULL(1);
15195 * Bring in the given item to list view.
15197 * @param item The item.
15199 * This causes list to jump to the given item @p item and show it
15200 * (by scrolling), if it is not fully visible.
15202 * This may use animation to do so and take a period of time.
15204 * If animation isn't wanted, elm_list_item_show() can be used.
15208 EAPI void elm_list_item_bring_in(Elm_List_Item *item) EINA_ARG_NONNULL(1);
15211 * Delete them item from the list.
15213 * @param item The item of list to be deleted.
15215 * If deleting all list items is required, elm_list_clear()
15216 * should be used instead of getting items list and deleting each one.
15218 * @see elm_list_clear()
15219 * @see elm_list_item_append()
15220 * @see elm_list_item_del_cb_set()
15224 EAPI void elm_list_item_del(Elm_List_Item *item) EINA_ARG_NONNULL(1);
15227 * Set the function called when a list item is freed.
15229 * @param item The item to set the callback on
15230 * @param func The function called
15232 * If there is a @p func, then it will be called prior item's memory release.
15233 * That will be called with the following arguments:
15235 * @li item's Evas object;
15238 * This way, a data associated to a list item could be properly freed.
15242 EAPI void elm_list_item_del_cb_set(Elm_List_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
15245 * Get the data associated to the item.
15247 * @param item The list item
15248 * @return The data associated to @p item
15250 * The return value is a pointer to data associated to @p item when it was
15251 * created, with function elm_list_item_append() or similar. If no data
15252 * was passed as argument, it will return @c NULL.
15254 * @see elm_list_item_append()
15258 EAPI void *elm_list_item_data_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15261 * Get the left side icon associated to the item.
15263 * @param item The list item
15264 * @return The left side icon associated to @p item
15266 * The return value is a pointer to the icon associated to @p item when
15268 * created, with function elm_list_item_append() or similar, or later
15269 * with function elm_list_item_icon_set(). If no icon
15270 * was passed as argument, it will return @c NULL.
15272 * @see elm_list_item_append()
15273 * @see elm_list_item_icon_set()
15277 EAPI Evas_Object *elm_list_item_icon_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15280 * Set the left side icon associated to the item.
15282 * @param item The list item
15283 * @param icon The left side icon object to associate with @p item
15285 * The icon object to use at left side of the item. An
15286 * icon can be any Evas object, but usually it is an icon created
15287 * with elm_icon_add().
15289 * Once the icon object is set, a previously set one will be deleted.
15290 * @warning Setting the same icon for two items will cause the icon to
15291 * dissapear from the first item.
15293 * If an icon was passed as argument on item creation, with function
15294 * elm_list_item_append() or similar, it will be already
15295 * associated to the item.
15297 * @see elm_list_item_append()
15298 * @see elm_list_item_icon_get()
15302 EAPI void elm_list_item_icon_set(Elm_List_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
15305 * Get the right side icon associated to the item.
15307 * @param item The list item
15308 * @return The right side icon associated to @p item
15310 * The return value is a pointer to the icon associated to @p item when
15312 * created, with function elm_list_item_append() or similar, or later
15313 * with function elm_list_item_icon_set(). If no icon
15314 * was passed as argument, it will return @c NULL.
15316 * @see elm_list_item_append()
15317 * @see elm_list_item_icon_set()
15321 EAPI Evas_Object *elm_list_item_end_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15324 * Set the right side icon associated to the item.
15326 * @param item The list item
15327 * @param end The right side icon object to associate with @p item
15329 * The icon object to use at right side of the item. An
15330 * icon can be any Evas object, but usually it is an icon created
15331 * with elm_icon_add().
15333 * Once the icon object is set, a previously set one will be deleted.
15334 * @warning Setting the same icon for two items will cause the icon to
15335 * dissapear from the first item.
15337 * If an icon was passed as argument on item creation, with function
15338 * elm_list_item_append() or similar, it will be already
15339 * associated to the item.
15341 * @see elm_list_item_append()
15342 * @see elm_list_item_end_get()
15346 EAPI void elm_list_item_end_set(Elm_List_Item *item, Evas_Object *end) EINA_ARG_NONNULL(1);
15349 * Gets the base object of the item.
15351 * @param item The list item
15352 * @return The base object associated with @p item
15354 * Base object is the @c Evas_Object that represents that item.
15358 EAPI Evas_Object *elm_list_item_base_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15361 * Get the label of item.
15363 * @param item The item of list.
15364 * @return The label of item.
15366 * The return value is a pointer to the label associated to @p item when
15367 * it was created, with function elm_list_item_append(), or later
15368 * with function elm_list_item_label_set. If no label
15369 * was passed as argument, it will return @c NULL.
15371 * @see elm_list_item_label_set() for more details.
15372 * @see elm_list_item_append()
15376 EAPI const char *elm_list_item_label_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15379 * Set the label of item.
15381 * @param item The item of list.
15382 * @param text The label of item.
15384 * The label to be displayed by the item.
15385 * Label will be placed between left and right side icons (if set).
15387 * If a label was passed as argument on item creation, with function
15388 * elm_list_item_append() or similar, it will be already
15389 * displayed by the item.
15391 * @see elm_list_item_label_get()
15392 * @see elm_list_item_append()
15396 EAPI void elm_list_item_label_set(Elm_List_Item *item, const char *text) EINA_ARG_NONNULL(1);
15400 * Get the item before @p it in list.
15402 * @param it The list item.
15403 * @return The item before @p it, or @c NULL if none or on failure.
15405 * @note If it is the first item, @c NULL will be returned.
15407 * @see elm_list_item_append()
15408 * @see elm_list_items_get()
15412 EAPI Elm_List_Item *elm_list_item_prev(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
15415 * Get the item after @p it in list.
15417 * @param it The list item.
15418 * @return The item after @p it, or @c NULL if none or on failure.
15420 * @note If it is the last item, @c NULL will be returned.
15422 * @see elm_list_item_append()
15423 * @see elm_list_items_get()
15427 EAPI Elm_List_Item *elm_list_item_next(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
15430 * Sets the disabled/enabled state of a list item.
15432 * @param it The item.
15433 * @param disabled The disabled state.
15435 * A disabled item cannot be selected or unselected. It will also
15436 * change its appearance (generally greyed out). This sets the
15437 * disabled state (@c EINA_TRUE for disabled, @c EINA_FALSE for
15442 EAPI void elm_list_item_disabled_set(Elm_List_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1);
15445 * Get a value whether list item is disabled or not.
15447 * @param it The item.
15448 * @return The disabled state.
15450 * @see elm_list_item_disabled_set() for more details.
15454 EAPI Eina_Bool elm_list_item_disabled_get(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
15457 * Set the text to be shown in a given list item's tooltips.
15459 * @param item Target item.
15460 * @param text The text to set in the content.
15462 * Setup the text as tooltip to object. The item can have only one tooltip,
15463 * so any previous tooltip data - set with this function or
15464 * elm_list_item_tooltip_content_cb_set() - is removed.
15466 * @see elm_object_tooltip_text_set() for more details.
15470 EAPI void elm_list_item_tooltip_text_set(Elm_List_Item *item, const char *text) EINA_ARG_NONNULL(1);
15474 * @brief Disable size restrictions on an object's tooltip
15475 * @param item The tooltip's anchor object
15476 * @param disable If EINA_TRUE, size restrictions are disabled
15477 * @return EINA_FALSE on failure, EINA_TRUE on success
15479 * This function allows a tooltip to expand beyond its parant window's canvas.
15480 * It will instead be limited only by the size of the display.
15482 EAPI Eina_Bool elm_list_item_tooltip_size_restrict_disable(Elm_List_Item *item, Eina_Bool disable) EINA_ARG_NONNULL(1);
15484 * @brief Retrieve size restriction state of an object's tooltip
15485 * @param obj The tooltip's anchor object
15486 * @return If EINA_TRUE, size restrictions are disabled
15488 * This function returns whether a tooltip is allowed to expand beyond
15489 * its parant window's canvas.
15490 * It will instead be limited only by the size of the display.
15492 EAPI Eina_Bool elm_list_item_tooltip_size_restrict_disabled_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15495 * Set the content to be shown in the tooltip item.
15497 * Setup the tooltip to item. The item can have only one tooltip,
15498 * so any previous tooltip data is removed. @p func(with @p data) will
15499 * be called every time that need show the tooltip and it should
15500 * return a valid Evas_Object. This object is then managed fully by
15501 * tooltip system and is deleted when the tooltip is gone.
15503 * @param item the list item being attached a tooltip.
15504 * @param func the function used to create the tooltip contents.
15505 * @param data what to provide to @a func as callback data/context.
15506 * @param del_cb called when data is not needed anymore, either when
15507 * another callback replaces @a func, the tooltip is unset with
15508 * elm_list_item_tooltip_unset() or the owner @a item
15509 * dies. This callback receives as the first parameter the
15510 * given @a data, and @c event_info is the item.
15512 * @see elm_object_tooltip_content_cb_set() for more details.
15516 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);
15519 * Unset tooltip from item.
15521 * @param item list item to remove previously set tooltip.
15523 * Remove tooltip from item. The callback provided as del_cb to
15524 * elm_list_item_tooltip_content_cb_set() will be called to notify
15525 * it is not used anymore.
15527 * @see elm_object_tooltip_unset() for more details.
15528 * @see elm_list_item_tooltip_content_cb_set()
15532 EAPI void elm_list_item_tooltip_unset(Elm_List_Item *item) EINA_ARG_NONNULL(1);
15535 * Sets a different style for this item tooltip.
15537 * @note before you set a style you should define a tooltip with
15538 * elm_list_item_tooltip_content_cb_set() or
15539 * elm_list_item_tooltip_text_set()
15541 * @param item list item with tooltip already set.
15542 * @param style the theme style to use (default, transparent, ...)
15544 * @see elm_object_tooltip_style_set() for more details.
15548 EAPI void elm_list_item_tooltip_style_set(Elm_List_Item *item, const char *style) EINA_ARG_NONNULL(1);
15551 * Get the style for this item tooltip.
15553 * @param item list item with tooltip already set.
15554 * @return style the theme style in use, defaults to "default". If the
15555 * object does not have a tooltip set, then NULL is returned.
15557 * @see elm_object_tooltip_style_get() for more details.
15558 * @see elm_list_item_tooltip_style_set()
15562 EAPI const char *elm_list_item_tooltip_style_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15565 * Set the type of mouse pointer/cursor decoration to be shown,
15566 * when the mouse pointer is over the given list widget item
15568 * @param item list item to customize cursor on
15569 * @param cursor the cursor type's name
15571 * This function works analogously as elm_object_cursor_set(), but
15572 * here the cursor's changing area is restricted to the item's
15573 * area, and not the whole widget's. Note that that item cursors
15574 * have precedence over widget cursors, so that a mouse over an
15575 * item with custom cursor set will always show @b that cursor.
15577 * If this function is called twice for an object, a previously set
15578 * cursor will be unset on the second call.
15580 * @see elm_object_cursor_set()
15581 * @see elm_list_item_cursor_get()
15582 * @see elm_list_item_cursor_unset()
15586 EAPI void elm_list_item_cursor_set(Elm_List_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
15589 * Get the type of mouse pointer/cursor decoration set to be shown,
15590 * when the mouse pointer is over the given list widget item
15592 * @param item list item with custom cursor set
15593 * @return the cursor type's name or @c NULL, if no custom cursors
15594 * were set to @p item (and on errors)
15596 * @see elm_object_cursor_get()
15597 * @see elm_list_item_cursor_set()
15598 * @see elm_list_item_cursor_unset()
15602 EAPI const char *elm_list_item_cursor_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15605 * Unset any custom mouse pointer/cursor decoration set to be
15606 * shown, when the mouse pointer is over the given list widget
15607 * item, thus making it show the @b default cursor again.
15609 * @param item a list item
15611 * Use this call to undo any custom settings on this item's cursor
15612 * decoration, bringing it back to defaults (no custom style set).
15614 * @see elm_object_cursor_unset()
15615 * @see elm_list_item_cursor_set()
15619 EAPI void elm_list_item_cursor_unset(Elm_List_Item *item) EINA_ARG_NONNULL(1);
15622 * Set a different @b style for a given custom cursor set for a
15625 * @param item list item with custom cursor set
15626 * @param style the <b>theme style</b> to use (e.g. @c "default",
15627 * @c "transparent", etc)
15629 * This function only makes sense when one is using custom mouse
15630 * cursor decorations <b>defined in a theme file</b>, which can have,
15631 * given a cursor name/type, <b>alternate styles</b> on it. It
15632 * works analogously as elm_object_cursor_style_set(), but here
15633 * applyed only to list item objects.
15635 * @warning Before you set a cursor style you should have definen a
15636 * custom cursor previously on the item, with
15637 * elm_list_item_cursor_set()
15639 * @see elm_list_item_cursor_engine_only_set()
15640 * @see elm_list_item_cursor_style_get()
15644 EAPI void elm_list_item_cursor_style_set(Elm_List_Item *item, const char *style) EINA_ARG_NONNULL(1);
15647 * Get the current @b style set for a given list item's custom
15650 * @param item list item with custom cursor set.
15651 * @return style the cursor style in use. If the object does not
15652 * have a cursor set, then @c NULL is returned.
15654 * @see elm_list_item_cursor_style_set() for more details
15658 EAPI const char *elm_list_item_cursor_style_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15661 * Set if the (custom)cursor for a given list item should be
15662 * searched in its theme, also, or should only rely on the
15663 * rendering engine.
15665 * @param item item with custom (custom) cursor already set on
15666 * @param engine_only Use @c EINA_TRUE to have cursors looked for
15667 * only on those provided by the rendering engine, @c EINA_FALSE to
15668 * have them searched on the widget's theme, as well.
15670 * @note This call is of use only if you've set a custom cursor
15671 * for list items, with elm_list_item_cursor_set().
15673 * @note By default, cursors will only be looked for between those
15674 * provided by the rendering engine.
15678 EAPI void elm_list_item_cursor_engine_only_set(Elm_List_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
15681 * Get if the (custom) cursor for a given list item is being
15682 * searched in its theme, also, or is only relying on the rendering
15685 * @param item a list item
15686 * @return @c EINA_TRUE, if cursors are being looked for only on
15687 * those provided by the rendering engine, @c EINA_FALSE if they
15688 * are being searched on the widget's theme, as well.
15690 * @see elm_list_item_cursor_engine_only_set(), for more details
15694 EAPI Eina_Bool elm_list_item_cursor_engine_only_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15701 * @defgroup Slider Slider
15702 * @ingroup Elementary
15704 * @image html img/widget/slider/preview-00.png
15705 * @image latex img/widget/slider/preview-00.eps width=\textwidth
15707 * The slider adds a dragable “slider” widget for selecting the value of
15708 * something within a range.
15710 * A slider can be horizontal or vertical. It can contain an Icon and has a
15711 * primary label as well as a units label (that is formatted with floating
15712 * point values and thus accepts a printf-style format string, like
15713 * “%1.2f units”. There is also an indicator string that may be somewhere
15714 * else (like on the slider itself) that also accepts a format string like
15715 * units. Label, Icon Unit and Indicator strings/objects are optional.
15717 * A slider may be inverted which means values invert, with high vales being
15718 * on the left or top and low values on the right or bottom (as opposed to
15719 * normally being low on the left or top and high on the bottom and right).
15721 * The slider should have its minimum and maximum values set by the
15722 * application with elm_slider_min_max_set() and value should also be set by
15723 * the application before use with elm_slider_value_set(). The span of the
15724 * slider is its length (horizontally or vertically). This will be scaled by
15725 * the object or applications scaling factor. At any point code can query the
15726 * slider for its value with elm_slider_value_get().
15728 * Smart callbacks one can listen to:
15729 * - "changed" - Whenever the slider value is changed by the user.
15730 * - "slider,drag,start" - dragging the slider indicator around has started.
15731 * - "slider,drag,stop" - dragging the slider indicator around has stopped.
15732 * - "delay,changed" - A short time after the value is changed by the user.
15733 * This will be called only when the user stops dragging for
15734 * a very short period or when they release their
15735 * finger/mouse, so it avoids possibly expensive reactions to
15736 * the value change.
15738 * Available styles for it:
15741 * Here is an example on its usage:
15742 * @li @ref slider_example
15746 * @addtogroup Slider
15751 * Add a new slider widget to the given parent Elementary
15752 * (container) object.
15754 * @param parent The parent object.
15755 * @return a new slider widget handle or @c NULL, on errors.
15757 * This function inserts a new slider widget on the canvas.
15761 EAPI Evas_Object *elm_slider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
15764 * Set the label of a given slider widget
15766 * @param obj The progress bar object
15767 * @param label The text label string, in UTF-8
15770 * @deprecated use elm_object_text_set() instead.
15772 EINA_DEPRECATED EAPI void elm_slider_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
15775 * Get the label of a given slider widget
15777 * @param obj The progressbar object
15778 * @return The text label string, in UTF-8
15781 * @deprecated use elm_object_text_get() instead.
15783 EINA_DEPRECATED EAPI const char *elm_slider_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15786 * Set the icon object of the slider object.
15788 * @param obj The slider object.
15789 * @param icon The icon object.
15791 * On horizontal mode, icon is placed at left, and on vertical mode,
15794 * @note Once the icon object is set, a previously set one will be deleted.
15795 * If you want to keep that old content object, use the
15796 * elm_slider_icon_unset() function.
15798 * @warning If the object being set does not have minimum size hints set,
15799 * it won't get properly displayed.
15803 EAPI void elm_slider_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
15806 * Unset an icon set on a given slider widget.
15808 * @param obj The slider object.
15809 * @return The icon object that was being used, if any was set, or
15810 * @c NULL, otherwise (and on errors).
15812 * On horizontal mode, icon is placed at left, and on vertical mode,
15815 * This call will unparent and return the icon object which was set
15816 * for this widget, previously, on success.
15818 * @see elm_slider_icon_set() for more details
15819 * @see elm_slider_icon_get()
15823 EAPI Evas_Object *elm_slider_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
15826 * Retrieve the icon object set for a given slider widget.
15828 * @param obj The slider object.
15829 * @return The icon object's handle, if @p obj had one set, or @c NULL,
15830 * otherwise (and on errors).
15832 * On horizontal mode, icon is placed at left, and on vertical mode,
15835 * @see elm_slider_icon_set() for more details
15836 * @see elm_slider_icon_unset()
15840 EAPI Evas_Object *elm_slider_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15843 * Set the end object of the slider object.
15845 * @param obj The slider object.
15846 * @param end The end object.
15848 * On horizontal mode, end is placed at left, and on vertical mode,
15849 * placed at bottom.
15851 * @note Once the icon object is set, a previously set one will be deleted.
15852 * If you want to keep that old content object, use the
15853 * elm_slider_end_unset() function.
15855 * @warning If the object being set does not have minimum size hints set,
15856 * it won't get properly displayed.
15860 EAPI void elm_slider_end_set(Evas_Object *obj, Evas_Object *end) EINA_ARG_NONNULL(1);
15863 * Unset an end object set on a given slider widget.
15865 * @param obj The slider object.
15866 * @return The end object that was being used, if any was set, or
15867 * @c NULL, otherwise (and on errors).
15869 * On horizontal mode, end is placed at left, and on vertical mode,
15870 * placed at bottom.
15872 * This call will unparent and return the icon object which was set
15873 * for this widget, previously, on success.
15875 * @see elm_slider_end_set() for more details.
15876 * @see elm_slider_end_get()
15880 EAPI Evas_Object *elm_slider_end_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
15883 * Retrieve the end object set for a given slider widget.
15885 * @param obj The slider object.
15886 * @return The end object's handle, if @p obj had one set, or @c NULL,
15887 * otherwise (and on errors).
15889 * On horizontal mode, icon is placed at right, and on vertical mode,
15890 * placed at bottom.
15892 * @see elm_slider_end_set() for more details.
15893 * @see elm_slider_end_unset()
15897 EAPI Evas_Object *elm_slider_end_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15900 * Set the (exact) length of the bar region of a given slider widget.
15902 * @param obj The slider object.
15903 * @param size The length of the slider's bar region.
15905 * This sets the minimum width (when in horizontal mode) or height
15906 * (when in vertical mode) of the actual bar area of the slider
15907 * @p obj. This in turn affects the object's minimum size. Use
15908 * this when you're not setting other size hints expanding on the
15909 * given direction (like weight and alignment hints) and you would
15910 * like it to have a specific size.
15912 * @note Icon, end, label, indicator and unit text around @p obj
15913 * will require their
15914 * own space, which will make @p obj to require more the @p size,
15917 * @see elm_slider_span_size_get()
15921 EAPI void elm_slider_span_size_set(Evas_Object *obj, Evas_Coord size) EINA_ARG_NONNULL(1);
15924 * Get the length set for the bar region of a given slider widget
15926 * @param obj The slider object.
15927 * @return The length of the slider's bar region.
15929 * If that size was not set previously, with
15930 * elm_slider_span_size_set(), this call will return @c 0.
15934 EAPI Evas_Coord elm_slider_span_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15937 * Set the format string for the unit label.
15939 * @param obj The slider object.
15940 * @param format The format string for the unit display.
15942 * Unit label is displayed all the time, if set, after slider's bar.
15943 * In horizontal mode, at right and in vertical mode, at bottom.
15945 * If @c NULL, unit label won't be visible. If not it sets the format
15946 * string for the label text. To the label text is provided a floating point
15947 * value, so the label text can display up to 1 floating point value.
15948 * Note that this is optional.
15950 * Use a format string such as "%1.2f meters" for example, and it will
15951 * display values like: "3.14 meters" for a value equal to 3.14159.
15953 * Default is unit label disabled.
15955 * @see elm_slider_indicator_format_get()
15959 EAPI void elm_slider_unit_format_set(Evas_Object *obj, const char *format) EINA_ARG_NONNULL(1);
15962 * Get the unit label format of the slider.
15964 * @param obj The slider object.
15965 * @return The unit label format string in UTF-8.
15967 * Unit label is displayed all the time, if set, after slider's bar.
15968 * In horizontal mode, at right and in vertical mode, at bottom.
15970 * @see elm_slider_unit_format_set() for more
15971 * information on how this works.
15975 EAPI const char *elm_slider_unit_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15978 * Set the format string for the indicator label.
15980 * @param obj The slider object.
15981 * @param indicator The format string for the indicator display.
15983 * The slider may display its value somewhere else then unit label,
15984 * for example, above the slider knob that is dragged around. This function
15985 * sets the format string used for this.
15987 * If @c NULL, indicator label won't be visible. If not it sets the format
15988 * string for the label text. To the label text is provided a floating point
15989 * value, so the label text can display up to 1 floating point value.
15990 * Note that this is optional.
15992 * Use a format string such as "%1.2f meters" for example, and it will
15993 * display values like: "3.14 meters" for a value equal to 3.14159.
15995 * Default is indicator label disabled.
15997 * @see elm_slider_indicator_format_get()
16001 EAPI void elm_slider_indicator_format_set(Evas_Object *obj, const char *indicator) EINA_ARG_NONNULL(1);
16004 * Get the indicator label format of the slider.
16006 * @param obj The slider object.
16007 * @return The indicator label format string in UTF-8.
16009 * The slider may display its value somewhere else then unit label,
16010 * for example, above the slider knob that is dragged around. This function
16011 * gets the format string used for this.
16013 * @see elm_slider_indicator_format_set() for more
16014 * information on how this works.
16018 EAPI const char *elm_slider_indicator_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16021 * Set the format function pointer for the indicator label
16023 * @param obj The slider object.
16024 * @param func The indicator format function.
16025 * @param free_func The freeing function for the format string.
16027 * Set the callback function to format the indicator string.
16029 * @see elm_slider_indicator_format_set() for more info on how this works.
16033 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);
16036 * Set the format function pointer for the units label
16038 * @param obj The slider object.
16039 * @param func The units format function.
16040 * @param free_func The freeing function for the format string.
16042 * Set the callback function to format the indicator string.
16044 * @see elm_slider_units_format_set() for more info on how this works.
16048 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);
16051 * Set the orientation of a given slider widget.
16053 * @param obj The slider object.
16054 * @param horizontal Use @c EINA_TRUE to make @p obj to be
16055 * @b horizontal, @c EINA_FALSE to make it @b vertical.
16057 * Use this function to change how your slider is to be
16058 * disposed: vertically or horizontally.
16060 * By default it's displayed horizontally.
16062 * @see elm_slider_horizontal_get()
16066 EAPI void elm_slider_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
16069 * Retrieve the orientation of a given slider widget
16071 * @param obj The slider object.
16072 * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
16073 * @c EINA_FALSE if it's @b vertical (and on errors).
16075 * @see elm_slider_horizontal_set() for more details.
16079 EAPI Eina_Bool elm_slider_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16082 * Set the minimum and maximum values for the slider.
16084 * @param obj The slider object.
16085 * @param min The minimum value.
16086 * @param max The maximum value.
16088 * Define the allowed range of values to be selected by the user.
16090 * If actual value is less than @p min, it will be updated to @p min. If it
16091 * is bigger then @p max, will be updated to @p max. Actual value can be
16092 * get with elm_slider_value_get().
16094 * By default, min is equal to 0.0, and max is equal to 1.0.
16096 * @warning Maximum must be greater than minimum, otherwise behavior
16099 * @see elm_slider_min_max_get()
16103 EAPI void elm_slider_min_max_set(Evas_Object *obj, double min, double max) EINA_ARG_NONNULL(1);
16106 * Get the minimum and maximum values of the slider.
16108 * @param obj The slider object.
16109 * @param min Pointer where to store the minimum value.
16110 * @param max Pointer where to store the maximum value.
16112 * @note If only one value is needed, the other pointer can be passed
16115 * @see elm_slider_min_max_set() for details.
16119 EAPI void elm_slider_min_max_get(const Evas_Object *obj, double *min, double *max) EINA_ARG_NONNULL(1);
16122 * Set the value the slider displays.
16124 * @param obj The slider object.
16125 * @param val The value to be displayed.
16127 * Value will be presented on the unit label following format specified with
16128 * elm_slider_unit_format_set() and on indicator with
16129 * elm_slider_indicator_format_set().
16131 * @warning The value must to be between min and max values. This values
16132 * are set by elm_slider_min_max_set().
16134 * @see elm_slider_value_get()
16135 * @see elm_slider_unit_format_set()
16136 * @see elm_slider_indicator_format_set()
16137 * @see elm_slider_min_max_set()
16141 EAPI void elm_slider_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
16144 * Get the value displayed by the spinner.
16146 * @param obj The spinner object.
16147 * @return The value displayed.
16149 * @see elm_spinner_value_set() for details.
16153 EAPI double elm_slider_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16156 * Invert a given slider widget's displaying values order
16158 * @param obj The slider object.
16159 * @param inverted Use @c EINA_TRUE to make @p obj inverted,
16160 * @c EINA_FALSE to bring it back to default, non-inverted values.
16162 * A slider may be @b inverted, in which state it gets its
16163 * values inverted, with high vales being on the left or top and
16164 * low values on the right or bottom, as opposed to normally have
16165 * the low values on the former and high values on the latter,
16166 * respectively, for horizontal and vertical modes.
16168 * @see elm_slider_inverted_get()
16172 EAPI void elm_slider_inverted_set(Evas_Object *obj, Eina_Bool inverted) EINA_ARG_NONNULL(1);
16175 * Get whether a given slider widget's displaying values are
16178 * @param obj The slider object.
16179 * @return @c EINA_TRUE, if @p obj has inverted values,
16180 * @c EINA_FALSE otherwise (and on errors).
16182 * @see elm_slider_inverted_set() for more details.
16186 EAPI Eina_Bool elm_slider_inverted_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16189 * Set whether to enlarge slider indicator (augmented knob) or not.
16191 * @param obj The slider object.
16192 * @param show @c EINA_TRUE will make it enlarge, @c EINA_FALSE will
16193 * let the knob always at default size.
16195 * By default, indicator will be bigger while dragged by the user.
16197 * @warning It won't display values set with
16198 * elm_slider_indicator_format_set() if you disable indicator.
16202 EAPI void elm_slider_indicator_show_set(Evas_Object *obj, Eina_Bool show) EINA_ARG_NONNULL(1);
16205 * Get whether a given slider widget's enlarging indicator or not.
16207 * @param obj The slider object.
16208 * @return @c EINA_TRUE, if @p obj is enlarging indicator, or
16209 * @c EINA_FALSE otherwise (and on errors).
16211 * @see elm_slider_indicator_show_set() for details.
16215 EAPI Eina_Bool elm_slider_indicator_show_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16222 * @addtogroup Actionslider Actionslider
16224 * @image html img/widget/actionslider/preview-00.png
16225 * @image latex img/widget/actionslider/preview-00.eps
16227 * A actionslider is a switcher for 2 or 3 labels with customizable magnet
16228 * properties. The indicator is the element the user drags to choose a label.
16229 * When the position is set with magnet, when released the indicator will be
16230 * moved to it if it's nearest the magnetized position.
16232 * @note By default all positions are set as enabled.
16234 * Signals that you can add callbacks for are:
16236 * "selected" - when user selects an enabled position (the label is passed
16239 * "pos_changed" - when the indicator reaches any of the positions("left",
16240 * "right" or "center").
16242 * See an example of actionslider usage @ref actionslider_example_page "here"
16245 typedef enum _Elm_Actionslider_Pos
16247 ELM_ACTIONSLIDER_NONE = 0,
16248 ELM_ACTIONSLIDER_LEFT = 1 << 0,
16249 ELM_ACTIONSLIDER_CENTER = 1 << 1,
16250 ELM_ACTIONSLIDER_RIGHT = 1 << 2,
16251 ELM_ACTIONSLIDER_ALL = (1 << 3) -1
16252 } Elm_Actionslider_Pos;
16255 * Add a new actionslider to the parent.
16257 * @param parent The parent object
16258 * @return The new actionslider object or NULL if it cannot be created
16260 EAPI Evas_Object *elm_actionslider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
16262 * Set actionslider labels.
16264 * @param obj The actionslider object
16265 * @param left_label The label to be set on the left.
16266 * @param center_label The label to be set on the center.
16267 * @param right_label The label to be set on the right.
16268 * @deprecated use elm_object_text_set() instead.
16270 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);
16272 * Get actionslider labels.
16274 * @param obj The actionslider object
16275 * @param left_label A char** to place the left_label of @p obj into.
16276 * @param center_label A char** to place the center_label of @p obj into.
16277 * @param right_label A char** to place the right_label of @p obj into.
16278 * @deprecated use elm_object_text_set() instead.
16280 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);
16282 * Get actionslider selected label.
16284 * @param obj The actionslider object
16285 * @return The selected label
16287 EAPI const char *elm_actionslider_selected_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16289 * Set actionslider indicator position.
16291 * @param obj The actionslider object.
16292 * @param pos The position of the indicator.
16294 EAPI void elm_actionslider_indicator_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
16296 * Get actionslider indicator position.
16298 * @param obj The actionslider object.
16299 * @return The position of the indicator.
16301 EAPI Elm_Actionslider_Pos elm_actionslider_indicator_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16303 * Set actionslider magnet position. To make multiple positions magnets @c or
16304 * them together(e.g.: ELM_ACTIONSLIDER_LEFT | ELM_ACTIONSLIDER_RIGHT)
16306 * @param obj The actionslider object.
16307 * @param pos Bit mask indicating the magnet positions.
16309 EAPI void elm_actionslider_magnet_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
16311 * Get actionslider magnet position.
16313 * @param obj The actionslider object.
16314 * @return The positions with magnet property.
16316 EAPI Elm_Actionslider_Pos elm_actionslider_magnet_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16318 * Set actionslider enabled position. To set multiple positions as enabled @c or
16319 * them together(e.g.: ELM_ACTIONSLIDER_LEFT | ELM_ACTIONSLIDER_RIGHT).
16321 * @note All the positions are enabled by default.
16323 * @param obj The actionslider object.
16324 * @param pos Bit mask indicating the enabled positions.
16326 EAPI void elm_actionslider_enabled_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
16328 * Get actionslider enabled position.
16330 * @param obj The actionslider object.
16331 * @return The enabled positions.
16333 EAPI Elm_Actionslider_Pos elm_actionslider_enabled_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16335 * Set the label used on the indicator.
16337 * @param obj The actionslider object
16338 * @param label The label to be set on the indicator.
16339 * @deprecated use elm_object_text_set() instead.
16341 EINA_DEPRECATED EAPI void elm_actionslider_indicator_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
16343 * Get the label used on the indicator object.
16345 * @param obj The actionslider object
16346 * @return The indicator label
16347 * @deprecated use elm_object_text_get() instead.
16349 EINA_DEPRECATED EAPI const char *elm_actionslider_indicator_label_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
16355 * @defgroup Genlist Genlist
16357 * @image html img/widget/genlist/preview-00.png
16358 * @image latex img/widget/genlist/preview-00.eps
16359 * @image html img/genlist.png
16360 * @image latex img/genlist.eps
16362 * This widget aims to have more expansive list than the simple list in
16363 * Elementary that could have more flexible items and allow many more entries
16364 * while still being fast and low on memory usage. At the same time it was
16365 * also made to be able to do tree structures. But the price to pay is more
16366 * complexity when it comes to usage. If all you want is a simple list with
16367 * icons and a single label, use the normal @ref List object.
16369 * Genlist has a fairly large API, mostly because it's relatively complex,
16370 * trying to be both expansive, powerful and efficient. First we will begin
16371 * an overview on the theory behind genlist.
16373 * @section Genlist_Item_Class Genlist item classes - creating items
16375 * In order to have the ability to add and delete items on the fly, genlist
16376 * implements a class (callback) system where the application provides a
16377 * structure with information about that type of item (genlist may contain
16378 * multiple different items with different classes, states and styles).
16379 * Genlist will call the functions in this struct (methods) when an item is
16380 * "realized" (i.e., created dynamically, while the user is scrolling the
16381 * grid). All objects will simply be deleted when no longer needed with
16382 * evas_object_del(). The #Elm_Genlist_Item_Class structure contains the
16383 * following members:
16384 * - @c item_style - This is a constant string and simply defines the name
16385 * of the item style. It @b must be specified and the default should be @c
16387 * - @c mode_item_style - This is a constant string and simply defines the
16388 * name of the style that will be used for mode animations. It can be left
16389 * as @c NULL if you don't plan to use Genlist mode. See
16390 * elm_genlist_item_mode_set() for more info.
16392 * - @c func - A struct with pointers to functions that will be called when
16393 * an item is going to be actually created. All of them receive a @c data
16394 * parameter that will point to the same data passed to
16395 * elm_genlist_item_append() and related item creation functions, and a @c
16396 * obj parameter that points to the genlist object itself.
16398 * The function pointers inside @c func are @c label_get, @c icon_get, @c
16399 * state_get and @c del. The 3 first functions also receive a @c part
16400 * parameter described below. A brief description of these functions follows:
16402 * - @c label_get - The @c part parameter is the name string of one of the
16403 * existing text parts in the Edje group implementing the item's theme.
16404 * This function @b must return a strdup'()ed string, as the caller will
16405 * free() it when done. See #Elm_Genlist_Item_Label_Get_Cb.
16406 * - @c icon_get - The @c part parameter is the name string of one of the
16407 * existing (icon) swallow parts in the Edje group implementing the item's
16408 * theme. It must return @c NULL, when no icon is desired, or a valid
16409 * object handle, otherwise. The object will be deleted by the genlist on
16410 * its deletion or when the item is "unrealized". See
16411 * #Elm_Genlist_Item_Icon_Get_Cb.
16412 * - @c func.state_get - The @c part parameter is the name string of one of
16413 * the state parts in the Edje group implementing the item's theme. Return
16414 * @c EINA_FALSE for false/off or @c EINA_TRUE for true/on. Genlists will
16415 * emit a signal to its theming Edje object with @c "elm,state,XXX,active"
16416 * and @c "elm" as "emission" and "source" arguments, respectively, when
16417 * the state is true (the default is false), where @c XXX is the name of
16418 * the (state) part. See #Elm_Genlist_Item_State_Get_Cb.
16419 * - @c func.del - This is intended for use when genlist items are deleted,
16420 * so any data attached to the item (e.g. its data parameter on creation)
16421 * can be deleted. See #Elm_Genlist_Item_Del_Cb.
16423 * available item styles:
16425 * - default_style - The text part is a textblock
16427 * @image html img/widget/genlist/preview-04.png
16428 * @image latex img/widget/genlist/preview-04.eps
16432 * @image html img/widget/genlist/preview-01.png
16433 * @image latex img/widget/genlist/preview-01.eps
16435 * - icon_top_text_bottom
16437 * @image html img/widget/genlist/preview-02.png
16438 * @image latex img/widget/genlist/preview-02.eps
16442 * @image html img/widget/genlist/preview-03.png
16443 * @image latex img/widget/genlist/preview-03.eps
16445 * @section Genlist_Items Structure of items
16447 * An item in a genlist can have 0 or more text labels (they can be regular
16448 * text or textblock Evas objects - that's up to the style to determine), 0
16449 * or more icons (which are simply objects swallowed into the genlist item's
16450 * theming Edje object) and 0 or more <b>boolean states</b>, which have the
16451 * behavior left to the user to define. The Edje part names for each of
16452 * these properties will be looked up, in the theme file for the genlist,
16453 * under the Edje (string) data items named @c "labels", @c "icons" and @c
16454 * "states", respectively. For each of those properties, if more than one
16455 * part is provided, they must have names listed separated by spaces in the
16456 * data fields. For the default genlist item theme, we have @b one label
16457 * part (@c "elm.text"), @b two icon parts (@c "elm.swalllow.icon" and @c
16458 * "elm.swallow.end") and @b no state parts.
16460 * A genlist item may be at one of several styles. Elementary provides one
16461 * by default - "default", but this can be extended by system or application
16462 * custom themes/overlays/extensions (see @ref Theme "themes" for more
16465 * @section Genlist_Manipulation Editing and Navigating
16467 * Items can be added by several calls. All of them return a @ref
16468 * Elm_Genlist_Item handle that is an internal member inside the genlist.
16469 * They all take a data parameter that is meant to be used for a handle to
16470 * the applications internal data (eg the struct with the original item
16471 * data). The parent parameter is the parent genlist item this belongs to if
16472 * it is a tree or an indexed group, and NULL if there is no parent. The
16473 * flags can be a bitmask of #ELM_GENLIST_ITEM_NONE,
16474 * #ELM_GENLIST_ITEM_SUBITEMS and #ELM_GENLIST_ITEM_GROUP. If
16475 * #ELM_GENLIST_ITEM_SUBITEMS is set then this item is displayed as an item
16476 * that is able to expand and have child items. If ELM_GENLIST_ITEM_GROUP
16477 * is set then this item is group index item that is displayed at the top
16478 * until the next group comes. The func parameter is a convenience callback
16479 * that is called when the item is selected and the data parameter will be
16480 * the func_data parameter, obj be the genlist object and event_info will be
16481 * the genlist item.
16483 * elm_genlist_item_append() adds an item to the end of the list, or if
16484 * there is a parent, to the end of all the child items of the parent.
16485 * elm_genlist_item_prepend() is the same but adds to the beginning of
16486 * the list or children list. elm_genlist_item_insert_before() inserts at
16487 * item before another item and elm_genlist_item_insert_after() inserts after
16488 * the indicated item.
16490 * The application can clear the list with elm_genlist_clear() which deletes
16491 * all the items in the list and elm_genlist_item_del() will delete a specific
16492 * item. elm_genlist_item_subitems_clear() will clear all items that are
16493 * children of the indicated parent item.
16495 * To help inspect list items you can jump to the item at the top of the list
16496 * with elm_genlist_first_item_get() which will return the item pointer, and
16497 * similarly elm_genlist_last_item_get() gets the item at the end of the list.
16498 * elm_genlist_item_next_get() and elm_genlist_item_prev_get() get the next
16499 * and previous items respectively relative to the indicated item. Using
16500 * these calls you can walk the entire item list/tree. Note that as a tree
16501 * the items are flattened in the list, so elm_genlist_item_parent_get() will
16502 * let you know which item is the parent (and thus know how to skip them if
16505 * @section Genlist_Muti_Selection Multi-selection
16507 * If the application wants multiple items to be able to be selected,
16508 * elm_genlist_multi_select_set() can enable this. If the list is
16509 * single-selection only (the default), then elm_genlist_selected_item_get()
16510 * will return the selected item, if any, or NULL I none is selected. If the
16511 * list is multi-select then elm_genlist_selected_items_get() will return a
16512 * list (that is only valid as long as no items are modified (added, deleted,
16513 * selected or unselected)).
16515 * @section Genlist_Usage_Hints Usage hints
16517 * There are also convenience functions. elm_genlist_item_genlist_get() will
16518 * return the genlist object the item belongs to. elm_genlist_item_show()
16519 * will make the scroller scroll to show that specific item so its visible.
16520 * elm_genlist_item_data_get() returns the data pointer set by the item
16521 * creation functions.
16523 * If an item changes (state of boolean changes, label or icons change),
16524 * then use elm_genlist_item_update() to have genlist update the item with
16525 * the new state. Genlist will re-realize the item thus call the functions
16526 * in the _Elm_Genlist_Item_Class for that item.
16528 * To programmatically (un)select an item use elm_genlist_item_selected_set().
16529 * To get its selected state use elm_genlist_item_selected_get(). Similarly
16530 * to expand/contract an item and get its expanded state, use
16531 * elm_genlist_item_expanded_set() and elm_genlist_item_expanded_get(). And
16532 * again to make an item disabled (unable to be selected and appear
16533 * differently) use elm_genlist_item_disabled_set() to set this and
16534 * elm_genlist_item_disabled_get() to get the disabled state.
16536 * In general to indicate how the genlist should expand items horizontally to
16537 * fill the list area, use elm_genlist_horizontal_set(). Valid modes are
16538 * ELM_LIST_LIMIT and ELM_LIST_SCROLL . The default is ELM_LIST_SCROLL. This
16539 * mode means that if items are too wide to fit, the scroller will scroll
16540 * horizontally. Otherwise items are expanded to fill the width of the
16541 * viewport of the scroller. If it is ELM_LIST_LIMIT, items will be expanded
16542 * to the viewport width and limited to that size. This can be combined with
16543 * a different style that uses edjes' ellipsis feature (cutting text off like
16546 * Items will only call their selection func and callback when first becoming
16547 * selected. Any further clicks will do nothing, unless you enable always
16548 * select with elm_genlist_always_select_mode_set(). This means even if
16549 * selected, every click will make the selected callbacks be called.
16550 * elm_genlist_no_select_mode_set() will turn off the ability to select
16551 * items entirely and they will neither appear selected nor call selected
16552 * callback functions.
16554 * Remember that you can create new styles and add your own theme augmentation
16555 * per application with elm_theme_extension_add(). If you absolutely must
16556 * have a specific style that overrides any theme the user or system sets up
16557 * you can use elm_theme_overlay_add() to add such a file.
16559 * @section Genlist_Implementation Implementation
16561 * Evas tracks every object you create. Every time it processes an event
16562 * (mouse move, down, up etc.) it needs to walk through objects and find out
16563 * what event that affects. Even worse every time it renders display updates,
16564 * in order to just calculate what to re-draw, it needs to walk through many
16565 * many many objects. Thus, the more objects you keep active, the more
16566 * overhead Evas has in just doing its work. It is advisable to keep your
16567 * active objects to the minimum working set you need. Also remember that
16568 * object creation and deletion carries an overhead, so there is a
16569 * middle-ground, which is not easily determined. But don't keep massive lists
16570 * of objects you can't see or use. Genlist does this with list objects. It
16571 * creates and destroys them dynamically as you scroll around. It groups them
16572 * into blocks so it can determine the visibility etc. of a whole block at
16573 * once as opposed to having to walk the whole list. This 2-level list allows
16574 * for very large numbers of items to be in the list (tests have used up to
16575 * 2,000,000 items). Also genlist employs a queue for adding items. As items
16576 * may be different sizes, every item added needs to be calculated as to its
16577 * size and thus this presents a lot of overhead on populating the list, this
16578 * genlist employs a queue. Any item added is queued and spooled off over
16579 * time, actually appearing some time later, so if your list has many members
16580 * you may find it takes a while for them to all appear, with your process
16581 * consuming a lot of CPU while it is busy spooling.
16583 * Genlist also implements a tree structure, but it does so with callbacks to
16584 * the application, with the application filling in tree structures when
16585 * requested (allowing for efficient building of a very deep tree that could
16586 * even be used for file-management). See the above smart signal callbacks for
16589 * @section Genlist_Smart_Events Genlist smart events
16591 * Signals that you can add callbacks for are:
16592 * - @c "activated" - The user has double-clicked or pressed
16593 * (enter|return|spacebar) on an item. The @c event_info parameter is the
16594 * item that was activated.
16595 * - @c "clicked,double" - The user has double-clicked an item. The @c
16596 * event_info parameter is the item that was double-clicked.
16597 * - @c "selected" - This is called when a user has made an item selected.
16598 * The event_info parameter is the genlist item that was selected.
16599 * - @c "unselected" - This is called when a user has made an item
16600 * unselected. The event_info parameter is the genlist item that was
16602 * - @c "expanded" - This is called when elm_genlist_item_expanded_set() is
16603 * called and the item is now meant to be expanded. The event_info
16604 * parameter is the genlist item that was indicated to expand. It is the
16605 * job of this callback to then fill in the child items.
16606 * - @c "contracted" - This is called when elm_genlist_item_expanded_set() is
16607 * called and the item is now meant to be contracted. The event_info
16608 * parameter is the genlist item that was indicated to contract. It is the
16609 * job of this callback to then delete the child items.
16610 * - @c "expand,request" - This is called when a user has indicated they want
16611 * to expand a tree branch item. The callback should decide if the item can
16612 * expand (has any children) and then call elm_genlist_item_expanded_set()
16613 * appropriately to set the state. The event_info parameter is the genlist
16614 * item that was indicated to expand.
16615 * - @c "contract,request" - This is called when a user has indicated they
16616 * want to contract a tree branch item. The callback should decide if the
16617 * item can contract (has any children) and then call
16618 * elm_genlist_item_expanded_set() appropriately to set the state. The
16619 * event_info parameter is the genlist item that was indicated to contract.
16620 * - @c "realized" - This is called when the item in the list is created as a
16621 * real evas object. event_info parameter is the genlist item that was
16622 * created. The object may be deleted at any time, so it is up to the
16623 * caller to not use the object pointer from elm_genlist_item_object_get()
16624 * in a way where it may point to freed objects.
16625 * - @c "unrealized" - This is called just before an item is unrealized.
16626 * After this call icon objects provided will be deleted and the item
16627 * object itself delete or be put into a floating cache.
16628 * - @c "drag,start,up" - This is called when the item in the list has been
16629 * dragged (not scrolled) up.
16630 * - @c "drag,start,down" - This is called when the item in the list has been
16631 * dragged (not scrolled) down.
16632 * - @c "drag,start,left" - This is called when the item in the list has been
16633 * dragged (not scrolled) left.
16634 * - @c "drag,start,right" - This is called when the item in the list has
16635 * been dragged (not scrolled) right.
16636 * - @c "drag,stop" - This is called when the item in the list has stopped
16638 * - @c "drag" - This is called when the item in the list is being dragged.
16639 * - @c "longpressed" - This is called when the item is pressed for a certain
16640 * amount of time. By default it's 1 second.
16641 * - @c "scroll,anim,start" - This is called when scrolling animation has
16643 * - @c "scroll,anim,stop" - This is called when scrolling animation has
16645 * - @c "scroll,drag,start" - This is called when dragging the content has
16647 * - @c "scroll,drag,stop" - This is called when dragging the content has
16649 * - @c "scroll,edge,top" - This is called when the genlist is scrolled until
16651 * - @c "scroll,edge,bottom" - This is called when the genlist is scrolled
16652 * until the bottom edge.
16653 * - @c "scroll,edge,left" - This is called when the genlist is scrolled
16654 * until the left edge.
16655 * - @c "scroll,edge,right" - This is called when the genlist is scrolled
16656 * until the right edge.
16657 * - @c "multi,swipe,left" - This is called when the genlist is multi-touch
16659 * - @c "multi,swipe,right" - This is called when the genlist is multi-touch
16661 * - @c "multi,swipe,up" - This is called when the genlist is multi-touch
16663 * - @c "multi,swipe,down" - This is called when the genlist is multi-touch
16665 * - @c "multi,pinch,out" - This is called when the genlist is multi-touch
16666 * pinched out. "- @c multi,pinch,in" - This is called when the genlist is
16667 * multi-touch pinched in.
16668 * - @c "swipe" - This is called when the genlist is swiped.
16670 * @section Genlist_Examples Examples
16672 * Here is a list of examples that use the genlist, trying to show some of
16673 * its capabilities:
16674 * - @ref genlist_example_01
16675 * - @ref genlist_example_02
16676 * - @ref genlist_example_03
16677 * - @ref genlist_example_04
16678 * - @ref genlist_example_05
16682 * @addtogroup Genlist
16687 * @enum _Elm_Genlist_Item_Flags
16688 * @typedef Elm_Genlist_Item_Flags
16690 * Defines if the item is of any special type (has subitems or it's the
16691 * index of a group), or is just a simple item.
16695 typedef enum _Elm_Genlist_Item_Flags
16697 ELM_GENLIST_ITEM_NONE = 0, /**< simple item */
16698 ELM_GENLIST_ITEM_SUBITEMS = (1 << 0), /**< may expand and have child items */
16699 ELM_GENLIST_ITEM_GROUP = (1 << 1) /**< index of a group of items */
16700 } Elm_Genlist_Item_Flags;
16701 typedef struct _Elm_Genlist_Item_Class Elm_Genlist_Item_Class; /**< Genlist item class definition structs */
16702 typedef struct _Elm_Genlist_Item Elm_Genlist_Item; /**< Item of Elm_Genlist. Sub-type of Elm_Widget_Item */
16703 typedef struct _Elm_Genlist_Item_Class_Func Elm_Genlist_Item_Class_Func; /**< Class functions for genlist item class */
16704 typedef char *(*Elm_Genlist_Item_Label_Get_Cb) (void *data, Evas_Object *obj, const char *part); /**< Label fetching class function for genlist item classes. */
16705 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. */
16706 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. */
16707 typedef void (*Elm_Genlist_Item_Del_Cb) (void *data, Evas_Object *obj); /**< Deletion class function for genlist item classes. */
16708 typedef void (*GenlistItemMovedFunc) (Evas_Object *obj, Elm_Genlist_Item *item, Elm_Genlist_Item *rel_item, Eina_Bool move_after); /** TODO: remove this by SeoZ **/
16710 typedef char *(*GenlistItemLabelGetFunc) (void *data, Evas_Object *obj, const char *part) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Genlist_Item_Label_Get_Cb instead. */
16711 typedef Evas_Object *(*GenlistItemIconGetFunc) (void *data, Evas_Object *obj, const char *part) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Genlist_Item_Icon_Get_Cb instead. */
16712 typedef Eina_Bool (*GenlistItemStateGetFunc) (void *data, Evas_Object *obj, const char *part) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Genlist_Item_State_Get_Cb instead. */
16713 typedef void (*GenlistItemDelFunc) (void *data, Evas_Object *obj) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Genlist_Item_Del_Cb instead. */
16716 * @struct _Elm_Genlist_Item_Class
16718 * Genlist item class definition structs.
16720 * This struct contains the style and fetching functions that will define the
16721 * contents of each item.
16723 * @see @ref Genlist_Item_Class
16725 struct _Elm_Genlist_Item_Class
16727 const char *item_style; /**< style of this class. */
16730 Elm_Genlist_Item_Label_Get_Cb label_get; /**< Label fetching class function for genlist item classes.*/
16731 Elm_Genlist_Item_Icon_Get_Cb icon_get; /**< Icon fetching class function for genlist item classes. */
16732 Elm_Genlist_Item_State_Get_Cb state_get; /**< State fetching class function for genlist item classes. */
16733 Elm_Genlist_Item_Del_Cb del; /**< Deletion class function for genlist item classes. */
16734 GenlistItemMovedFunc moved; // TODO: do not use this. change this to smart callback.
16736 const char *mode_item_style;
16740 * Add a new genlist widget to the given parent Elementary
16741 * (container) object
16743 * @param parent The parent object
16744 * @return a new genlist widget handle or @c NULL, on errors
16746 * This function inserts a new genlist widget on the canvas.
16748 * @see elm_genlist_item_append()
16749 * @see elm_genlist_item_del()
16750 * @see elm_genlist_clear()
16754 EAPI Evas_Object *elm_genlist_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
16756 * Remove all items from a given genlist widget.
16758 * @param obj The genlist object
16760 * This removes (and deletes) all items in @p obj, leaving it empty.
16762 * @see elm_genlist_item_del(), to remove just one item.
16766 EAPI void elm_genlist_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
16768 * Enable or disable multi-selection in the genlist
16770 * @param obj The genlist object
16771 * @param multi Multi-select enable/disable. Default is disabled.
16773 * This enables (@c EINA_TRUE) or disables (@c EINA_FALSE) multi-selection in
16774 * the list. This allows more than 1 item to be selected. To retrieve the list
16775 * of selected items, use elm_genlist_selected_items_get().
16777 * @see elm_genlist_selected_items_get()
16778 * @see elm_genlist_multi_select_get()
16782 EAPI void elm_genlist_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
16784 * Gets if multi-selection in genlist is enabled or disabled.
16786 * @param obj The genlist object
16787 * @return Multi-select enabled/disabled
16788 * (@c EINA_TRUE = enabled/@c EINA_FALSE = disabled). Default is @c EINA_FALSE.
16790 * @see elm_genlist_multi_select_set()
16794 EAPI Eina_Bool elm_genlist_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16796 * This sets the horizontal stretching mode.
16798 * @param obj The genlist object
16799 * @param mode The mode to use (one of #ELM_LIST_SCROLL or #ELM_LIST_LIMIT).
16801 * This sets the mode used for sizing items horizontally. Valid modes
16802 * are #ELM_LIST_LIMIT and #ELM_LIST_SCROLL. The default is
16803 * ELM_LIST_SCROLL. This mode means that if items are too wide to fit,
16804 * the scroller will scroll horizontally. Otherwise items are expanded
16805 * to fill the width of the viewport of the scroller. If it is
16806 * ELM_LIST_LIMIT, items will be expanded to the viewport width and
16807 * limited to that size.
16809 * @see elm_genlist_horizontal_get()
16813 EAPI void elm_genlist_horizontal_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
16814 EINA_DEPRECATED EAPI void elm_genlist_horizontal_mode_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
16816 * Gets the horizontal stretching mode.
16818 * @param obj The genlist object
16819 * @return The mode to use
16820 * (#ELM_LIST_LIMIT, #ELM_LIST_SCROLL)
16822 * @see elm_genlist_horizontal_set()
16826 EAPI Elm_List_Mode elm_genlist_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16827 EINA_DEPRECATED EAPI Elm_List_Mode elm_genlist_horizontal_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16829 * Set the always select mode.
16831 * @param obj The genlist object
16832 * @param always_select The always select mode (@c EINA_TRUE = on, @c
16833 * EINA_FALSE = off). Default is @c EINA_FALSE.
16835 * Items will only call their selection func and callback when first
16836 * becoming selected. Any further clicks will do nothing, unless you
16837 * enable always select with elm_genlist_always_select_mode_set().
16838 * This means that, even if selected, every click will make the selected
16839 * callbacks be called.
16841 * @see elm_genlist_always_select_mode_get()
16845 EAPI void elm_genlist_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
16847 * Get the always select mode.
16849 * @param obj The genlist object
16850 * @return The always select mode
16851 * (@c EINA_TRUE = on, @c EINA_FALSE = off)
16853 * @see elm_genlist_always_select_mode_set()
16857 EAPI Eina_Bool elm_genlist_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16859 * Enable/disable the no select mode.
16861 * @param obj The genlist object
16862 * @param no_select The no select mode
16863 * (EINA_TRUE = on, EINA_FALSE = off)
16865 * This will turn off the ability to select items entirely and they
16866 * will neither appear selected nor call selected callback functions.
16868 * @see elm_genlist_no_select_mode_get()
16872 EAPI void elm_genlist_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
16874 * Gets whether the no select mode is enabled.
16876 * @param obj The genlist object
16877 * @return The no select mode
16878 * (@c EINA_TRUE = on, @c EINA_FALSE = off)
16880 * @see elm_genlist_no_select_mode_set()
16884 EAPI Eina_Bool elm_genlist_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16886 * Enable/disable compress mode.
16888 * @param obj The genlist object
16889 * @param compress The compress mode
16890 * (@c EINA_TRUE = on, @c EINA_FALSE = off). Default is @c EINA_FALSE.
16892 * This will enable the compress mode where items are "compressed"
16893 * horizontally to fit the genlist scrollable viewport width. This is
16894 * special for genlist. Do not rely on
16895 * elm_genlist_horizontal_set() being set to @c ELM_LIST_COMPRESS to
16896 * work as genlist needs to handle it specially.
16898 * @see elm_genlist_compress_mode_get()
16902 EAPI void elm_genlist_compress_mode_set(Evas_Object *obj, Eina_Bool compress) EINA_ARG_NONNULL(1);
16904 * Get whether the compress mode is enabled.
16906 * @param obj The genlist object
16907 * @return The compress mode
16908 * (@c EINA_TRUE = on, @c EINA_FALSE = off)
16910 * @see elm_genlist_compress_mode_set()
16914 EAPI Eina_Bool elm_genlist_compress_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16916 * Enable/disable height-for-width mode.
16918 * @param obj The genlist object
16919 * @param setting The height-for-width mode (@c EINA_TRUE = on,
16920 * @c EINA_FALSE = off). Default is @c EINA_FALSE.
16922 * With height-for-width mode the item width will be fixed (restricted
16923 * to a minimum of) to the list width when calculating its size in
16924 * order to allow the height to be calculated based on it. This allows,
16925 * for instance, text block to wrap lines if the Edje part is
16926 * configured with "text.min: 0 1".
16928 * @note This mode will make list resize slower as it will have to
16929 * recalculate every item height again whenever the list width
16932 * @note When height-for-width mode is enabled, it also enables
16933 * compress mode (see elm_genlist_compress_mode_set()) and
16934 * disables homogeneous (see elm_genlist_homogeneous_set()).
16938 EAPI void elm_genlist_height_for_width_mode_set(Evas_Object *obj, Eina_Bool height_for_width) EINA_ARG_NONNULL(1);
16940 * Get whether the height-for-width mode is enabled.
16942 * @param obj The genlist object
16943 * @return The height-for-width mode (@c EINA_TRUE = on, @c EINA_FALSE =
16948 EAPI Eina_Bool elm_genlist_height_for_width_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16950 * Enable/disable horizontal and vertical bouncing effect.
16952 * @param obj The genlist object
16953 * @param h_bounce Allow bounce horizontally (@c EINA_TRUE = on, @c
16954 * EINA_FALSE = off). Default is @c EINA_FALSE.
16955 * @param v_bounce Allow bounce vertically (@c EINA_TRUE = on, @c
16956 * EINA_FALSE = off). Default is @c EINA_TRUE.
16958 * This will enable or disable the scroller bouncing effect for the
16959 * genlist. See elm_scroller_bounce_set() for details.
16961 * @see elm_scroller_bounce_set()
16962 * @see elm_genlist_bounce_get()
16966 EAPI void elm_genlist_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
16968 * Get whether the horizontal and vertical bouncing effect is enabled.
16970 * @param obj The genlist object
16971 * @param h_bounce Pointer to a bool to receive if the bounce horizontally
16973 * @param v_bounce Pointer to a bool to receive if the bounce vertically
16976 * @see elm_genlist_bounce_set()
16980 EAPI void elm_genlist_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
16982 * Enable/disable homogenous mode.
16984 * @param obj The genlist object
16985 * @param homogeneous Assume the items within the genlist are of the
16986 * same height and width (EINA_TRUE = on, EINA_FALSE = off). Default is @c
16989 * This will enable the homogeneous mode where items are of the same
16990 * height and width so that genlist may do the lazy-loading at its
16991 * maximum (which increases the performance for scrolling the list). This
16992 * implies 'compressed' mode.
16994 * @see elm_genlist_compress_mode_set()
16995 * @see elm_genlist_homogeneous_get()
16999 EAPI void elm_genlist_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
17001 * Get whether the homogenous mode is enabled.
17003 * @param obj The genlist object
17004 * @return Assume the items within the genlist are of the same height
17005 * and width (EINA_TRUE = on, EINA_FALSE = off)
17007 * @see elm_genlist_homogeneous_set()
17011 EAPI Eina_Bool elm_genlist_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17013 * Set the maximum number of items within an item block
17015 * @param obj The genlist object
17016 * @param n Maximum number of items within an item block. Default is 32.
17018 * This will configure the block count to tune to the target with
17019 * particular performance matrix.
17021 * A block of objects will be used to reduce the number of operations due to
17022 * many objects in the screen. It can determine the visibility, or if the
17023 * object has changed, it theme needs to be updated, etc. doing this kind of
17024 * calculation to the entire block, instead of per object.
17026 * The default value for the block count is enough for most lists, so unless
17027 * you know you will have a lot of objects visible in the screen at the same
17028 * time, don't try to change this.
17030 * @see elm_genlist_block_count_get()
17031 * @see @ref Genlist_Implementation
17035 EAPI void elm_genlist_block_count_set(Evas_Object *obj, int n) EINA_ARG_NONNULL(1);
17037 * Get the maximum number of items within an item block
17039 * @param obj The genlist object
17040 * @return Maximum number of items within an item block
17042 * @see elm_genlist_block_count_set()
17046 EAPI int elm_genlist_block_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17048 * Set the timeout in seconds for the longpress event.
17050 * @param obj The genlist object
17051 * @param timeout timeout in seconds. Default is 1.
17053 * This option will change how long it takes to send an event "longpressed"
17054 * after the mouse down signal is sent to the list. If this event occurs, no
17055 * "clicked" event will be sent.
17057 * @see elm_genlist_longpress_timeout_set()
17061 EAPI void elm_genlist_longpress_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
17063 * Get the timeout in seconds for the longpress event.
17065 * @param obj The genlist object
17066 * @return timeout in seconds
17068 * @see elm_genlist_longpress_timeout_get()
17072 EAPI double elm_genlist_longpress_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17074 * Append a new item in a given genlist widget.
17076 * @param obj The genlist object
17077 * @param itc The item class for the item
17078 * @param data The item data
17079 * @param parent The parent item, or NULL if none
17080 * @param flags Item flags
17081 * @param func Convenience function called when the item is selected
17082 * @param func_data Data passed to @p func above.
17083 * @return A handle to the item added or @c NULL if not possible
17085 * This adds the given item to the end of the list or the end of
17086 * the children list if the @p parent is given.
17088 * @see elm_genlist_item_prepend()
17089 * @see elm_genlist_item_insert_before()
17090 * @see elm_genlist_item_insert_after()
17091 * @see elm_genlist_item_del()
17095 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);
17097 * Prepend a new item in a given genlist widget.
17099 * @param obj The genlist object
17100 * @param itc The item class for the item
17101 * @param data The item data
17102 * @param parent The parent item, or NULL if none
17103 * @param flags Item flags
17104 * @param func Convenience function called when the item is selected
17105 * @param func_data Data passed to @p func above.
17106 * @return A handle to the item added or NULL if not possible
17108 * This adds an item to the beginning of the list or beginning of the
17109 * children of the parent if given.
17111 * @see elm_genlist_item_append()
17112 * @see elm_genlist_item_insert_before()
17113 * @see elm_genlist_item_insert_after()
17114 * @see elm_genlist_item_del()
17118 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);
17120 * Insert an item before another in a genlist widget
17122 * @param obj The genlist object
17123 * @param itc The item class for the item
17124 * @param data The item data
17125 * @param before The item to place this new one before.
17126 * @param flags Item flags
17127 * @param func Convenience function called when the item is selected
17128 * @param func_data Data passed to @p func above.
17129 * @return A handle to the item added or @c NULL if not possible
17131 * This inserts an item before another in the list. It will be in the
17132 * same tree level or group as the item it is inserted before.
17134 * @see elm_genlist_item_append()
17135 * @see elm_genlist_item_prepend()
17136 * @see elm_genlist_item_insert_after()
17137 * @see elm_genlist_item_del()
17141 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);
17143 * Insert an item after another in a genlist widget
17145 * @param obj The genlist object
17146 * @param itc The item class for the item
17147 * @param data The item data
17148 * @param after The item to place this new one after.
17149 * @param flags Item flags
17150 * @param func Convenience function called when the item is selected
17151 * @param func_data Data passed to @p func above.
17152 * @return A handle to the item added or @c NULL if not possible
17154 * This inserts an item after another in the list. It will be in the
17155 * same tree level or group as the item it is inserted after.
17157 * @see elm_genlist_item_append()
17158 * @see elm_genlist_item_prepend()
17159 * @see elm_genlist_item_insert_before()
17160 * @see elm_genlist_item_del()
17164 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);
17166 * Insert a new item into the sorted genlist object
17168 * @param obj The genlist object
17169 * @param itc The item class for the item
17170 * @param data The item data
17171 * @param parent The parent item, or NULL if none
17172 * @param flags Item flags
17173 * @param comp The function called for the sort
17174 * @param func Convenience function called when item selected
17175 * @param func_data Data passed to @p func above.
17176 * @return A handle to the item added or NULL if not possible
17180 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);
17181 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);
17182 /* operations to retrieve existing items */
17184 * Get the selectd item in the genlist.
17186 * @param obj The genlist object
17187 * @return The selected item, or NULL if none is selected.
17189 * This gets the selected item in the list (if multi-selection is enabled, only
17190 * the item that was first selected in the list is returned - which is not very
17191 * useful, so see elm_genlist_selected_items_get() for when multi-selection is
17194 * If no item is selected, NULL is returned.
17196 * @see elm_genlist_selected_items_get()
17200 EAPI Elm_Genlist_Item *elm_genlist_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17202 * Get a list of selected items in the genlist.
17204 * @param obj The genlist object
17205 * @return The list of selected items, or NULL if none are selected.
17207 * It returns a list of the selected items. This list pointer is only valid so
17208 * long as the selection doesn't change (no items are selected or unselected, or
17209 * unselected implicitly by deletion). The list contains Elm_Genlist_Item
17210 * pointers. The order of the items in this list is the order which they were
17211 * selected, i.e. the first item in this list is the first item that was
17212 * selected, and so on.
17214 * @note If not in multi-select mode, consider using function
17215 * elm_genlist_selected_item_get() instead.
17217 * @see elm_genlist_multi_select_set()
17218 * @see elm_genlist_selected_item_get()
17222 EAPI const Eina_List *elm_genlist_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17224 * Get a list of realized items in genlist
17226 * @param obj The genlist object
17227 * @return The list of realized items, nor NULL if none are realized.
17229 * This returns a list of the realized items in the genlist. The list
17230 * contains Elm_Genlist_Item pointers. The list must be freed by the
17231 * caller when done with eina_list_free(). The item pointers in the
17232 * list are only valid so long as those items are not deleted or the
17233 * genlist is not deleted.
17235 * @see elm_genlist_realized_items_update()
17239 EAPI Eina_List *elm_genlist_realized_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17241 * Get the item that is at the x, y canvas coords.
17243 * @param obj The gelinst object.
17244 * @param x The input x coordinate
17245 * @param y The input y coordinate
17246 * @param posret The position relative to the item returned here
17247 * @return The item at the coordinates or NULL if none
17249 * This returns the item at the given coordinates (which are canvas
17250 * relative, not object-relative). If an item is at that coordinate,
17251 * that item handle is returned, and if @p posret is not NULL, the
17252 * integer pointed to is set to a value of -1, 0 or 1, depending if
17253 * the coordinate is on the upper portion of that item (-1), on the
17254 * middle section (0) or on the lower part (1). If NULL is returned as
17255 * an item (no item found there), then posret may indicate -1 or 1
17256 * based if the coordinate is above or below all items respectively in
17261 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);
17263 * Get the first item in the genlist
17265 * This returns the first item in the list.
17267 * @param obj The genlist object
17268 * @return The first item, or NULL if none
17272 EAPI Elm_Genlist_Item *elm_genlist_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17274 * Get the last item in the genlist
17276 * This returns the last item in the list.
17278 * @return The last item, or NULL if none
17282 EAPI Elm_Genlist_Item *elm_genlist_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17284 * Set the scrollbar policy
17286 * @param obj The genlist object
17287 * @param policy_h Horizontal scrollbar policy.
17288 * @param policy_v Vertical scrollbar policy.
17290 * This sets the scrollbar visibility policy for the given genlist
17291 * scroller. #ELM_SMART_SCROLLER_POLICY_AUTO means the scrollbar is
17292 * made visible if it is needed, and otherwise kept hidden.
17293 * #ELM_SMART_SCROLLER_POLICY_ON turns it on all the time, and
17294 * #ELM_SMART_SCROLLER_POLICY_OFF always keeps it off. This applies
17295 * respectively for the horizontal and vertical scrollbars. Default is
17296 * #ELM_SMART_SCROLLER_POLICY_AUTO
17298 * @see elm_genlist_scroller_policy_get()
17302 EAPI void elm_genlist_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
17304 * Get the scrollbar policy
17306 * @param obj The genlist object
17307 * @param policy_h Pointer to store the horizontal scrollbar policy.
17308 * @param policy_v Pointer to store the vertical scrollbar policy.
17310 * @see elm_genlist_scroller_policy_set()
17314 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);
17316 * Get the @b next item in a genlist widget's internal list of items,
17317 * given a handle to one of those items.
17319 * @param item The genlist item to fetch next from
17320 * @return The item after @p item, or @c NULL if there's none (and
17323 * This returns the item placed after the @p item, on the container
17326 * @see elm_genlist_item_prev_get()
17330 EAPI Elm_Genlist_Item *elm_genlist_item_next_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17332 * Get the @b previous item in a genlist widget's internal list of items,
17333 * given a handle to one of those items.
17335 * @param item The genlist item to fetch previous from
17336 * @return The item before @p item, or @c NULL if there's none (and
17339 * This returns the item placed before the @p item, on the container
17342 * @see elm_genlist_item_next_get()
17346 EAPI Elm_Genlist_Item *elm_genlist_item_prev_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17348 * Get the genlist object's handle which contains a given genlist
17351 * @param item The item to fetch the container from
17352 * @return The genlist (parent) object
17354 * This returns the genlist object itself that an item belongs to.
17358 EAPI Evas_Object *elm_genlist_item_genlist_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17360 * Get the parent item of the given item
17362 * @param it The item
17363 * @return The parent of the item or @c NULL if it has no parent.
17365 * This returns the item that was specified as parent of the item @p it on
17366 * elm_genlist_item_append() and insertion related functions.
17370 EAPI Elm_Genlist_Item *elm_genlist_item_parent_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
17372 * Remove all sub-items (children) of the given item
17374 * @param it The item
17376 * This removes all items that are children (and their descendants) of the
17377 * given item @p it.
17379 * @see elm_genlist_clear()
17380 * @see elm_genlist_item_del()
17384 EAPI void elm_genlist_item_subitems_clear(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17386 * Set whether a given genlist item is selected or not
17388 * @param it The item
17389 * @param selected Use @c EINA_TRUE, to make it selected, @c
17390 * EINA_FALSE to make it unselected
17392 * This sets the selected state of an item. If multi selection is
17393 * not enabled on the containing genlist and @p selected is @c
17394 * EINA_TRUE, any other previously selected items will get
17395 * unselected in favor of this new one.
17397 * @see elm_genlist_item_selected_get()
17401 EAPI void elm_genlist_item_selected_set(Elm_Genlist_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
17403 * Get whether a given genlist item is selected or not
17405 * @param it The item
17406 * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
17408 * @see elm_genlist_item_selected_set() for more details
17412 EAPI Eina_Bool elm_genlist_item_selected_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17414 * Sets the expanded state of an item.
17416 * @param it The item
17417 * @param expanded The expanded state (@c EINA_TRUE expanded, @c EINA_FALSE not expanded).
17419 * This function flags the item of type #ELM_GENLIST_ITEM_SUBITEMS as
17422 * The theme will respond to this change visually, and a signal "expanded" or
17423 * "contracted" will be sent from the genlist with a pointer to the item that
17424 * has been expanded/contracted.
17426 * Calling this function won't show or hide any child of this item (if it is
17427 * a parent). You must manually delete and create them on the callbacks fo
17428 * the "expanded" or "contracted" signals.
17430 * @see elm_genlist_item_expanded_get()
17434 EAPI void elm_genlist_item_expanded_set(Elm_Genlist_Item *item, Eina_Bool expanded) EINA_ARG_NONNULL(1);
17436 * Get the expanded state of an item
17438 * @param it The item
17439 * @return The expanded state
17441 * This gets the expanded state of an item.
17443 * @see elm_genlist_item_expanded_set()
17447 EAPI Eina_Bool elm_genlist_item_expanded_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17449 * Get the depth of expanded item
17451 * @param it The genlist item object
17452 * @return The depth of expanded item
17456 EAPI int elm_genlist_item_expanded_depth_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
17458 * Set whether a given genlist item is disabled or not.
17460 * @param it The item
17461 * @param disabled Use @c EINA_TRUE, true disable it, @c EINA_FALSE
17462 * to enable it back.
17464 * A disabled item cannot be selected or unselected. It will also
17465 * change its appearance, to signal the user it's disabled.
17467 * @see elm_genlist_item_disabled_get()
17471 EAPI void elm_genlist_item_disabled_set(Elm_Genlist_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
17473 * Get whether a given genlist item is disabled or not.
17475 * @param it The item
17476 * @return @c EINA_TRUE, if it's disabled, @c EINA_FALSE otherwise
17479 * @see elm_genlist_item_disabled_set() for more details
17483 EAPI Eina_Bool elm_genlist_item_disabled_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17485 * Sets the display only state of an item.
17487 * @param it The item
17488 * @param display_only @c EINA_TRUE if the item is display only, @c
17489 * EINA_FALSE otherwise.
17491 * A display only item cannot be selected or unselected. It is for
17492 * display only and not selecting or otherwise clicking, dragging
17493 * etc. by the user, thus finger size rules will not be applied to
17496 * It's good to set group index items to display only state.
17498 * @see elm_genlist_item_display_only_get()
17502 EAPI void elm_genlist_item_display_only_set(Elm_Genlist_Item *it, Eina_Bool display_only) EINA_ARG_NONNULL(1);
17504 * Get the display only state of an item
17506 * @param it The item
17507 * @return @c EINA_TRUE if the item is display only, @c
17508 * EINA_FALSE otherwise.
17510 * @see elm_genlist_item_display_only_set()
17514 EAPI Eina_Bool elm_genlist_item_display_only_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
17516 * Show the portion of a genlist's internal list containing a given
17517 * item, immediately.
17519 * @param it The item to display
17521 * This causes genlist to jump to the given item @p it and show it (by
17522 * immediately scrolling to that position), if it is not fully visible.
17524 * @see elm_genlist_item_bring_in()
17525 * @see elm_genlist_item_top_show()
17526 * @see elm_genlist_item_middle_show()
17530 EAPI void elm_genlist_item_show(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17532 * Animatedly bring in, to the visible are of a genlist, a given
17535 * @param it The item to display
17537 * This causes genlist to jump to the given item @p it and show it (by
17538 * animatedly scrolling), if it is not fully visible. This may use animation
17539 * to do so and take a period of time
17541 * @see elm_genlist_item_show()
17542 * @see elm_genlist_item_top_bring_in()
17543 * @see elm_genlist_item_middle_bring_in()
17547 EAPI void elm_genlist_item_bring_in(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17549 * Show the portion of a genlist's internal list containing a given
17550 * item, immediately.
17552 * @param it The item to display
17554 * This causes genlist to jump to the given item @p it and show it (by
17555 * immediately scrolling to that position), if it is not fully visible.
17557 * The item will be positioned at the top of the genlist viewport.
17559 * @see elm_genlist_item_show()
17560 * @see elm_genlist_item_top_bring_in()
17564 EAPI void elm_genlist_item_top_show(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17566 * Animatedly bring in, to the visible are of a genlist, a given
17569 * @param it The item
17571 * This causes genlist to jump to the given item @p it and show it (by
17572 * animatedly scrolling), if it is not fully visible. This may use animation
17573 * to do so and take a period of time
17575 * The item will be positioned at the top of the genlist viewport.
17577 * @see elm_genlist_item_bring_in()
17578 * @see elm_genlist_item_top_show()
17582 EAPI void elm_genlist_item_top_bring_in(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17584 * Show the portion of a genlist's internal list containing a given
17585 * item, immediately.
17587 * @param it The item to display
17589 * This causes genlist to jump to the given item @p it and show it (by
17590 * immediately scrolling to that position), if it is not fully visible.
17592 * The item will be positioned at the middle of the genlist viewport.
17594 * @see elm_genlist_item_show()
17595 * @see elm_genlist_item_middle_bring_in()
17599 EAPI void elm_genlist_item_middle_show(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
17601 * Animatedly bring in, to the visible are of a genlist, a given
17604 * @param it The item
17606 * This causes genlist to jump to the given item @p it and show it (by
17607 * animatedly scrolling), if it is not fully visible. This may use animation
17608 * to do so and take a period of time
17610 * The item will be positioned at the middle of the genlist viewport.
17612 * @see elm_genlist_item_bring_in()
17613 * @see elm_genlist_item_middle_show()
17617 EAPI void elm_genlist_item_middle_bring_in(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
17619 * Remove a genlist item from the its parent, deleting it.
17621 * @param item The item to be removed.
17622 * @return @c EINA_TRUE on success or @c EINA_FALSE, otherwise.
17624 * @see elm_genlist_clear(), to remove all items in a genlist at
17629 EAPI void elm_genlist_item_del(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17631 * Return the data associated to a given genlist item
17633 * @param item The genlist item.
17634 * @return the data associated to this item.
17636 * This returns the @c data value passed on the
17637 * elm_genlist_item_append() and related item addition calls.
17639 * @see elm_genlist_item_append()
17640 * @see elm_genlist_item_data_set()
17644 EAPI void *elm_genlist_item_data_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17646 * Set the data associated to a given genlist item
17648 * @param item The genlist item
17649 * @param data The new data pointer to set on it
17651 * This @b overrides the @c data value passed on the
17652 * elm_genlist_item_append() and related item addition calls. This
17653 * function @b won't call elm_genlist_item_update() automatically,
17654 * so you'd issue it afterwards if you want to hove the item
17655 * updated to reflect the that new data.
17657 * @see elm_genlist_item_data_get()
17661 EAPI void elm_genlist_item_data_set(Elm_Genlist_Item *it, const void *data) EINA_ARG_NONNULL(1);
17663 * Tells genlist to "orphan" icons fetchs by the item class
17665 * @param it The item
17667 * This instructs genlist to release references to icons in the item,
17668 * meaning that they will no longer be managed by genlist and are
17669 * floating "orphans" that can be re-used elsewhere if the user wants
17674 EAPI void elm_genlist_item_icons_orphan(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
17676 * Get the real Evas object created to implement the view of a
17677 * given genlist item
17679 * @param item The genlist item.
17680 * @return the Evas object implementing this item's view.
17682 * This returns the actual Evas object used to implement the
17683 * specified genlist item's view. This may be @c NULL, as it may
17684 * not have been created or may have been deleted, at any time, by
17685 * the genlist. <b>Do not modify this object</b> (move, resize,
17686 * show, hide, etc.), as the genlist is controlling it. This
17687 * function is for querying, emitting custom signals or hooking
17688 * lower level callbacks for events on that object. Do not delete
17689 * this object under any circumstances.
17691 * @see elm_genlist_item_data_get()
17695 EAPI const Evas_Object *elm_genlist_item_object_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
17697 * Update the contents of an item
17699 * @param it The item
17701 * This updates an item by calling all the item class functions again
17702 * to get the icons, labels and states. Use this when the original
17703 * item data has changed and the changes are desired to be reflected.
17705 * Use elm_genlist_realized_items_update() to update all already realized
17708 * @see elm_genlist_realized_items_update()
17712 EAPI void elm_genlist_item_update(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17714 * Update the item class of an item
17716 * @param it The item
17717 * @param itc The item class for the item
17719 * This sets another class fo the item, changing the way that it is
17720 * displayed. After changing the item class, elm_genlist_item_update() is
17721 * called on the item @p it.
17725 EAPI void elm_genlist_item_item_class_update(Elm_Genlist_Item *it, const Elm_Genlist_Item_Class *itc) EINA_ARG_NONNULL(1, 2);
17726 EAPI const Elm_Genlist_Item_Class *elm_genlist_item_item_class_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
17728 * Set the text to be shown in a given genlist item's tooltips.
17730 * @param item The genlist item
17731 * @param text The text to set in the content
17733 * This call will setup the text to be used as tooltip to that item
17734 * (analogous to elm_object_tooltip_text_set(), but being item
17735 * tooltips with higher precedence than object tooltips). It can
17736 * have only one tooltip at a time, so any previous tooltip data
17737 * will get removed.
17739 * In order to set an icon or something else as a tooltip, look at
17740 * elm_genlist_item_tooltip_content_cb_set().
17744 EAPI void elm_genlist_item_tooltip_text_set(Elm_Genlist_Item *item, const char *text) EINA_ARG_NONNULL(1);
17746 * Set the content to be shown in a given genlist item's tooltips
17748 * @param item The genlist item.
17749 * @param func The function returning the tooltip contents.
17750 * @param data What to provide to @a func as callback data/context.
17751 * @param del_cb Called when data is not needed anymore, either when
17752 * another callback replaces @p func, the tooltip is unset with
17753 * elm_genlist_item_tooltip_unset() or the owner @p item
17754 * dies. This callback receives as its first parameter the
17755 * given @p data, being @c event_info the item handle.
17757 * This call will setup the tooltip's contents to @p item
17758 * (analogous to elm_object_tooltip_content_cb_set(), but being
17759 * item tooltips with higher precedence than object tooltips). It
17760 * can have only one tooltip at a time, so any previous tooltip
17761 * content will get removed. @p func (with @p data) will be called
17762 * every time Elementary needs to show the tooltip and it should
17763 * return a valid Evas object, which will be fully managed by the
17764 * tooltip system, getting deleted when the tooltip is gone.
17766 * In order to set just a text as a tooltip, look at
17767 * elm_genlist_item_tooltip_text_set().
17771 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);
17773 * Unset a tooltip from a given genlist item
17775 * @param item genlist item to remove a previously set tooltip from.
17777 * This call removes any tooltip set on @p item. The callback
17778 * provided as @c del_cb to
17779 * elm_genlist_item_tooltip_content_cb_set() will be called to
17780 * notify it is not used anymore (and have resources cleaned, if
17783 * @see elm_genlist_item_tooltip_content_cb_set()
17787 EAPI void elm_genlist_item_tooltip_unset(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17789 * Set a different @b style for a given genlist item's tooltip.
17791 * @param item genlist item with tooltip set
17792 * @param style the <b>theme style</b> to use on tooltips (e.g. @c
17793 * "default", @c "transparent", etc)
17795 * Tooltips can have <b>alternate styles</b> to be displayed on,
17796 * which are defined by the theme set on Elementary. This function
17797 * works analogously as elm_object_tooltip_style_set(), but here
17798 * applied only to genlist item objects. The default style for
17799 * tooltips is @c "default".
17801 * @note before you set a style you should define a tooltip with
17802 * elm_genlist_item_tooltip_content_cb_set() or
17803 * elm_genlist_item_tooltip_text_set()
17805 * @see elm_genlist_item_tooltip_style_get()
17809 EAPI void elm_genlist_item_tooltip_style_set(Elm_Genlist_Item *item, const char *style) EINA_ARG_NONNULL(1);
17811 * Get the style set a given genlist item's tooltip.
17813 * @param item genlist item with tooltip already set on.
17814 * @return style the theme style in use, which defaults to
17815 * "default". If the object does not have a tooltip set,
17816 * then @c NULL is returned.
17818 * @see elm_genlist_item_tooltip_style_set() for more details
17822 EAPI const char *elm_genlist_item_tooltip_style_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17824 * @brief Disable size restrictions on an object's tooltip
17825 * @param item The tooltip's anchor object
17826 * @param disable If EINA_TRUE, size restrictions are disabled
17827 * @return EINA_FALSE on failure, EINA_TRUE on success
17829 * This function allows a tooltip to expand beyond its parant window's canvas.
17830 * It will instead be limited only by the size of the display.
17832 EAPI Eina_Bool elm_genlist_item_tooltip_size_restrict_disable(Elm_Genlist_Item *item, Eina_Bool disable);
17834 * @brief Retrieve size restriction state of an object's tooltip
17835 * @param item The tooltip's anchor object
17836 * @return If EINA_TRUE, size restrictions are disabled
17838 * This function returns whether a tooltip is allowed to expand beyond
17839 * its parant window's canvas.
17840 * It will instead be limited only by the size of the display.
17842 EAPI Eina_Bool elm_genlist_item_tooltip_size_restrict_disabled_get(const Elm_Genlist_Item *item);
17844 * Set the type of mouse pointer/cursor decoration to be shown,
17845 * when the mouse pointer is over the given genlist widget item
17847 * @param item genlist item to customize cursor on
17848 * @param cursor the cursor type's name
17850 * This function works analogously as elm_object_cursor_set(), but
17851 * here the cursor's changing area is restricted to the item's
17852 * area, and not the whole widget's. Note that that item cursors
17853 * have precedence over widget cursors, so that a mouse over @p
17854 * item will always show cursor @p type.
17856 * If this function is called twice for an object, a previously set
17857 * cursor will be unset on the second call.
17859 * @see elm_object_cursor_set()
17860 * @see elm_genlist_item_cursor_get()
17861 * @see elm_genlist_item_cursor_unset()
17865 EAPI void elm_genlist_item_cursor_set(Elm_Genlist_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
17867 * Get the type of mouse pointer/cursor decoration set to be shown,
17868 * when the mouse pointer is over the given genlist widget item
17870 * @param item genlist item with custom cursor set
17871 * @return the cursor type's name or @c NULL, if no custom cursors
17872 * were set to @p item (and on errors)
17874 * @see elm_object_cursor_get()
17875 * @see elm_genlist_item_cursor_set() for more details
17876 * @see elm_genlist_item_cursor_unset()
17880 EAPI const char *elm_genlist_item_cursor_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17882 * Unset any custom mouse pointer/cursor decoration set to be
17883 * shown, when the mouse pointer is over the given genlist widget
17884 * item, thus making it show the @b default cursor again.
17886 * @param item a genlist item
17888 * Use this call to undo any custom settings on this item's cursor
17889 * decoration, bringing it back to defaults (no custom style set).
17891 * @see elm_object_cursor_unset()
17892 * @see elm_genlist_item_cursor_set() for more details
17896 EAPI void elm_genlist_item_cursor_unset(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17898 * Set a different @b style for a given custom cursor set for a
17901 * @param item genlist item with custom cursor set
17902 * @param style the <b>theme style</b> to use (e.g. @c "default",
17903 * @c "transparent", etc)
17905 * This function only makes sense when one is using custom mouse
17906 * cursor decorations <b>defined in a theme file</b> , which can
17907 * have, given a cursor name/type, <b>alternate styles</b> on
17908 * it. It works analogously as elm_object_cursor_style_set(), but
17909 * here applied only to genlist item objects.
17911 * @warning Before you set a cursor style you should have defined a
17912 * custom cursor previously on the item, with
17913 * elm_genlist_item_cursor_set()
17915 * @see elm_genlist_item_cursor_engine_only_set()
17916 * @see elm_genlist_item_cursor_style_get()
17920 EAPI void elm_genlist_item_cursor_style_set(Elm_Genlist_Item *item, const char *style) EINA_ARG_NONNULL(1);
17922 * Get the current @b style set for a given genlist item's custom
17925 * @param item genlist item with custom cursor set.
17926 * @return style the cursor style in use. If the object does not
17927 * have a cursor set, then @c NULL is returned.
17929 * @see elm_genlist_item_cursor_style_set() for more details
17933 EAPI const char *elm_genlist_item_cursor_style_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17935 * Set if the (custom) cursor for a given genlist item should be
17936 * searched in its theme, also, or should only rely on the
17937 * rendering engine.
17939 * @param item item with custom (custom) cursor already set on
17940 * @param engine_only Use @c EINA_TRUE to have cursors looked for
17941 * only on those provided by the rendering engine, @c EINA_FALSE to
17942 * have them searched on the widget's theme, as well.
17944 * @note This call is of use only if you've set a custom cursor
17945 * for genlist items, with elm_genlist_item_cursor_set().
17947 * @note By default, cursors will only be looked for between those
17948 * provided by the rendering engine.
17952 EAPI void elm_genlist_item_cursor_engine_only_set(Elm_Genlist_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
17954 * Get if the (custom) cursor for a given genlist item is being
17955 * searched in its theme, also, or is only relying on the rendering
17958 * @param item a genlist item
17959 * @return @c EINA_TRUE, if cursors are being looked for only on
17960 * those provided by the rendering engine, @c EINA_FALSE if they
17961 * are being searched on the widget's theme, as well.
17963 * @see elm_genlist_item_cursor_engine_only_set(), for more details
17967 EAPI Eina_Bool elm_genlist_item_cursor_engine_only_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17969 * Update the contents of all realized items.
17971 * @param obj The genlist object.
17973 * This updates all realized items by calling all the item class functions again
17974 * to get the icons, labels and states. Use this when the original
17975 * item data has changed and the changes are desired to be reflected.
17977 * To update just one item, use elm_genlist_item_update().
17979 * @see elm_genlist_realized_items_get()
17980 * @see elm_genlist_item_update()
17984 EAPI void elm_genlist_realized_items_update(Evas_Object *obj) EINA_ARG_NONNULL(1);
17986 * Activate a genlist mode on an item
17988 * @param item The genlist item
17989 * @param mode Mode name
17990 * @param mode_set Boolean to define set or unset mode.
17992 * A genlist mode is a different way of selecting an item. Once a mode is
17993 * activated on an item, any other selected item is immediately unselected.
17994 * This feature provides an easy way of implementing a new kind of animation
17995 * for selecting an item, without having to entirely rewrite the item style
17996 * theme. However, the elm_genlist_selected_* API can't be used to get what
17997 * item is activate for a mode.
17999 * The current item style will still be used, but applying a genlist mode to
18000 * an item will select it using a different kind of animation.
18002 * The current active item for a mode can be found by
18003 * elm_genlist_mode_item_get().
18005 * The characteristics of genlist mode are:
18006 * - Only one mode can be active at any time, and for only one item.
18007 * - Genlist handles deactivating other items when one item is activated.
18008 * - A mode is defined in the genlist theme (edc), and more modes can easily
18010 * - A mode style and the genlist item style are different things. They
18011 * can be combined to provide a default style to the item, with some kind
18012 * of animation for that item when the mode is activated.
18014 * When a mode is activated on an item, a new view for that item is created.
18015 * The theme of this mode defines the animation that will be used to transit
18016 * the item from the old view to the new view. This second (new) view will be
18017 * active for that item while the mode is active on the item, and will be
18018 * destroyed after the mode is totally deactivated from that item.
18020 * @see elm_genlist_mode_get()
18021 * @see elm_genlist_mode_item_get()
18025 EAPI void elm_genlist_item_mode_set(Elm_Genlist_Item *it, const char *mode_type, Eina_Bool mode_set) EINA_ARG_NONNULL(1, 2);
18027 * Get the last (or current) genlist mode used.
18029 * @param obj The genlist object
18031 * This function just returns the name of the last used genlist mode. It will
18032 * be the current mode if it's still active.
18034 * @see elm_genlist_item_mode_set()
18035 * @see elm_genlist_mode_item_get()
18039 EAPI const char *elm_genlist_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18041 * Get active genlist mode item
18043 * @param obj The genlist object
18044 * @return The active item for that current mode. Or @c NULL if no item is
18045 * activated with any mode.
18047 * This function returns the item that was activated with a mode, by the
18048 * function elm_genlist_item_mode_set().
18050 * @see elm_genlist_item_mode_set()
18051 * @see elm_genlist_mode_get()
18055 EAPI const Elm_Genlist_Item *elm_genlist_mode_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18060 * @param obj The genlist object
18061 * @param reorder_mode The reorder mode
18062 * (EINA_TRUE = on, EINA_FALSE = off)
18066 EAPI void elm_genlist_reorder_mode_set(Evas_Object *obj, Eina_Bool reorder_mode) EINA_ARG_NONNULL(1);
18069 * Get the reorder mode
18071 * @param obj The genlist object
18072 * @return The reorder mode
18073 * (EINA_TRUE = on, EINA_FALSE = off)
18077 EAPI Eina_Bool elm_genlist_reorder_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18084 * @defgroup Check Check
18086 * @image html img/widget/check/preview-00.png
18087 * @image latex img/widget/check/preview-00.eps
18088 * @image html img/widget/check/preview-01.png
18089 * @image latex img/widget/check/preview-01.eps
18090 * @image html img/widget/check/preview-02.png
18091 * @image latex img/widget/check/preview-02.eps
18093 * @brief The check widget allows for toggling a value between true and
18096 * Check objects are a lot like radio objects in layout and functionality
18097 * except they do not work as a group, but independently and only toggle the
18098 * value of a boolean from false to true (0 or 1). elm_check_state_set() sets
18099 * the boolean state (1 for true, 0 for false), and elm_check_state_get()
18100 * returns the current state. For convenience, like the radio objects, you
18101 * can set a pointer to a boolean directly with elm_check_state_pointer_set()
18102 * for it to modify.
18104 * Signals that you can add callbacks for are:
18105 * "changed" - This is called whenever the user changes the state of one of
18106 * the check object(event_info is NULL).
18108 * @ref tutorial_check should give you a firm grasp of how to use this widget.
18112 * @brief Add a new Check object
18114 * @param parent The parent object
18115 * @return The new object or NULL if it cannot be created
18117 EAPI Evas_Object *elm_check_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
18119 * @brief Set the text label of the check object
18121 * @param obj The check object
18122 * @param label The text label string in UTF-8
18124 * @deprecated use elm_object_text_set() instead.
18126 EINA_DEPRECATED EAPI void elm_check_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
18128 * @brief Get the text label of the check object
18130 * @param obj The check object
18131 * @return The text label string in UTF-8
18133 * @deprecated use elm_object_text_get() instead.
18135 EINA_DEPRECATED EAPI const char *elm_check_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18137 * @brief Set the icon object of the check object
18139 * @param obj The check object
18140 * @param icon The icon object
18142 * Once the icon object is set, a previously set one will be deleted.
18143 * If you want to keep that old content object, use the
18144 * elm_check_icon_unset() function.
18146 EAPI void elm_check_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
18148 * @brief Get the icon object of the check object
18150 * @param obj The check object
18151 * @return The icon object
18153 EAPI Evas_Object *elm_check_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18155 * @brief Unset the icon used for the check object
18157 * @param obj The check object
18158 * @return The icon object that was being used
18160 * Unparent and return the icon object which was set for this widget.
18162 EAPI Evas_Object *elm_check_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
18164 * @brief Set the on/off state of the check object
18166 * @param obj The check object
18167 * @param state The state to use (1 == on, 0 == off)
18169 * This sets the state of the check. If set
18170 * with elm_check_state_pointer_set() the state of that variable is also
18171 * changed. Calling this @b doesn't cause the "changed" signal to be emited.
18173 EAPI void elm_check_state_set(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
18175 * @brief Get the state of the check object
18177 * @param obj The check object
18178 * @return The boolean state
18180 EAPI Eina_Bool elm_check_state_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18182 * @brief Set a convenience pointer to a boolean to change
18184 * @param obj The check object
18185 * @param statep Pointer to the boolean to modify
18187 * This sets a pointer to a boolean, that, in addition to the check objects
18188 * state will also be modified directly. To stop setting the object pointed
18189 * to simply use NULL as the @p statep parameter. If @p statep is not NULL,
18190 * then when this is called, the check objects state will also be modified to
18191 * reflect the value of the boolean @p statep points to, just like calling
18192 * elm_check_state_set().
18194 EAPI void elm_check_state_pointer_set(Evas_Object *obj, Eina_Bool *statep) EINA_ARG_NONNULL(1);
18200 * @defgroup Radio Radio
18202 * @image html img/widget/radio/preview-00.png
18203 * @image latex img/widget/radio/preview-00.eps
18205 * @brief Radio is a widget that allows for 1 or more options to be displayed
18206 * and have the user choose only 1 of them.
18208 * A radio object contains an indicator, an optional Label and an optional
18209 * icon object. While it's possible to have a group of only one radio they,
18210 * are normally used in groups of 2 or more. To add a radio to a group use
18211 * elm_radio_group_add(). The radio object(s) will select from one of a set
18212 * of integer values, so any value they are configuring needs to be mapped to
18213 * a set of integers. To configure what value that radio object represents,
18214 * use elm_radio_state_value_set() to set the integer it represents. To set
18215 * the value the whole group(which one is currently selected) is to indicate
18216 * use elm_radio_value_set() on any group member, and to get the groups value
18217 * use elm_radio_value_get(). For convenience the radio objects are also able
18218 * to directly set an integer(int) to the value that is selected. To specify
18219 * the pointer to this integer to modify, use elm_radio_value_pointer_set().
18220 * The radio objects will modify this directly. That implies the pointer must
18221 * point to valid memory for as long as the radio objects exist.
18223 * Signals that you can add callbacks for are:
18224 * @li changed - This is called whenever the user changes the state of one of
18225 * the radio objects within the group of radio objects that work together.
18227 * @ref tutorial_radio show most of this API in action.
18231 * @brief Add a new radio to the parent
18233 * @param parent The parent object
18234 * @return The new object or NULL if it cannot be created
18236 EAPI Evas_Object *elm_radio_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
18238 * @brief Set the text label of the radio object
18240 * @param obj The radio object
18241 * @param label The text label string in UTF-8
18243 * @deprecated use elm_object_text_set() instead.
18245 EINA_DEPRECATED EAPI void elm_radio_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
18247 * @brief Get the text label of the radio object
18249 * @param obj The radio object
18250 * @return The text label string in UTF-8
18252 * @deprecated use elm_object_text_set() instead.
18254 EINA_DEPRECATED EAPI const char *elm_radio_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18256 * @brief Set the icon object of the radio object
18258 * @param obj The radio object
18259 * @param icon The icon object
18261 * Once the icon object is set, a previously set one will be deleted. If you
18262 * want to keep that old content object, use the elm_radio_icon_unset()
18265 EAPI void elm_radio_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
18267 * @brief Get the icon object of the radio object
18269 * @param obj The radio object
18270 * @return The icon object
18272 * @see elm_radio_icon_set()
18274 EAPI Evas_Object *elm_radio_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18276 * @brief Unset the icon used for the radio object
18278 * @param obj The radio object
18279 * @return The icon object that was being used
18281 * Unparent and return the icon object which was set for this widget.
18283 * @see elm_radio_icon_set()
18285 EAPI Evas_Object *elm_radio_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
18287 * @brief Add this radio to a group of other radio objects
18289 * @param obj The radio object
18290 * @param group Any object whose group the @p obj is to join.
18292 * Radio objects work in groups. Each member should have a different integer
18293 * value assigned. In order to have them work as a group, they need to know
18294 * about each other. This adds the given radio object to the group of which
18295 * the group object indicated is a member.
18297 EAPI void elm_radio_group_add(Evas_Object *obj, Evas_Object *group) EINA_ARG_NONNULL(1);
18299 * @brief Set the integer value that this radio object represents
18301 * @param obj The radio object
18302 * @param value The value to use if this radio object is selected
18304 * This sets the value of the radio.
18306 EAPI void elm_radio_state_value_set(Evas_Object *obj, int value) EINA_ARG_NONNULL(1);
18308 * @brief Get the integer value that this radio object represents
18310 * @param obj The radio object
18311 * @return The value used if this radio object is selected
18313 * This gets the value of the radio.
18315 * @see elm_radio_value_set()
18317 EAPI int elm_radio_state_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18319 * @brief Set the value of the radio.
18321 * @param obj The radio object
18322 * @param value The value to use for the group
18324 * This sets the value of the radio group and will also set the value if
18325 * pointed to, to the value supplied, but will not call any callbacks.
18327 EAPI void elm_radio_value_set(Evas_Object *obj, int value) EINA_ARG_NONNULL(1);
18329 * @brief Get the state of the radio object
18331 * @param obj The radio object
18332 * @return The integer state
18334 EAPI int elm_radio_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18336 * @brief Set a convenience pointer to a integer to change
18338 * @param obj The radio object
18339 * @param valuep Pointer to the integer to modify
18341 * This sets a pointer to a integer, that, in addition to the radio objects
18342 * state will also be modified directly. To stop setting the object pointed
18343 * to simply use NULL as the @p valuep argument. If valuep is not NULL, then
18344 * when this is called, the radio objects state will also be modified to
18345 * reflect the value of the integer valuep points to, just like calling
18346 * elm_radio_value_set().
18348 EAPI void elm_radio_value_pointer_set(Evas_Object *obj, int *valuep) EINA_ARG_NONNULL(1);
18354 * @defgroup Pager Pager
18356 * @image html img/widget/pager/preview-00.png
18357 * @image latex img/widget/pager/preview-00.eps
18359 * @brief Widget that allows flipping between 1 or more “pages” of objects.
18361 * The flipping between “pages” of objects is animated. All content in pager
18362 * is kept in a stack, the last content to be added will be on the top of the
18363 * stack(be visible).
18365 * Objects can be pushed or popped from the stack or deleted as normal.
18366 * Pushes and pops will animate (and a pop will delete the object once the
18367 * animation is finished). Any object already in the pager can be promoted to
18368 * the top(from its current stacking position) through the use of
18369 * elm_pager_content_promote(). Objects are pushed to the top with
18370 * elm_pager_content_push() and when the top item is no longer wanted, simply
18371 * pop it with elm_pager_content_pop() and it will also be deleted. If an
18372 * object is no longer needed and is not the top item, just delete it as
18373 * normal. You can query which objects are the top and bottom with
18374 * elm_pager_content_bottom_get() and elm_pager_content_top_get().
18376 * Signals that you can add callbacks for are:
18377 * "hide,finished" - when the previous page is hided
18379 * This widget has the following styles available:
18382 * @li fade_translucide
18383 * @li fade_invisible
18384 * @note This styles affect only the flipping animations, the appearance when
18385 * not animating is unaffected by styles.
18387 * @ref tutorial_pager gives a good overview of the usage of the API.
18391 * Add a new pager to the parent
18393 * @param parent The parent object
18394 * @return The new object or NULL if it cannot be created
18398 EAPI Evas_Object *elm_pager_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
18400 * @brief Push an object to the top of the pager stack (and show it).
18402 * @param obj The pager object
18403 * @param content The object to push
18405 * The object pushed becomes a child of the pager, it will be controlled and
18406 * deleted when the pager is deleted.
18408 * @note If the content is already in the stack use
18409 * elm_pager_content_promote().
18410 * @warning Using this function on @p content already in the stack results in
18411 * undefined behavior.
18413 EAPI void elm_pager_content_push(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
18415 * @brief Pop the object that is on top of the stack
18417 * @param obj The pager object
18419 * This pops the object that is on the top(visible) of the pager, makes it
18420 * disappear, then deletes the object. The object that was underneath it on
18421 * the stack will become visible.
18423 EAPI void elm_pager_content_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
18425 * @brief Moves an object already in the pager stack to the top of the stack.
18427 * @param obj The pager object
18428 * @param content The object to promote
18430 * This will take the @p content and move it to the top of the stack as
18431 * if it had been pushed there.
18433 * @note If the content isn't already in the stack use
18434 * elm_pager_content_push().
18435 * @warning Using this function on @p content not already in the stack
18436 * results in undefined behavior.
18438 EAPI void elm_pager_content_promote(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
18440 * @brief Return the object at the bottom of the pager stack
18442 * @param obj The pager object
18443 * @return The bottom object or NULL if none
18445 EAPI Evas_Object *elm_pager_content_bottom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18447 * @brief Return the object at the top of the pager stack
18449 * @param obj The pager object
18450 * @return The top object or NULL if none
18452 EAPI Evas_Object *elm_pager_content_top_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18458 * @defgroup Slideshow Slideshow
18460 * @image html img/widget/slideshow/preview-00.png
18461 * @image latex img/widget/slideshow/preview-00.eps
18463 * This widget, as the name indicates, is a pre-made image
18464 * slideshow panel, with API functions acting on (child) image
18465 * items presentation. Between those actions, are:
18466 * - advance to next/previous image
18467 * - select the style of image transition animation
18468 * - set the exhibition time for each image
18469 * - start/stop the slideshow
18471 * The transition animations are defined in the widget's theme,
18472 * consequently new animations can be added without having to
18473 * update the widget's code.
18475 * @section Slideshow_Items Slideshow items
18477 * For slideshow items, just like for @ref Genlist "genlist" ones,
18478 * the user defines a @b classes, specifying functions that will be
18479 * called on the item's creation and deletion times.
18481 * The #Elm_Slideshow_Item_Class structure contains the following
18484 * - @c func.get - When an item is displayed, this function is
18485 * called, and it's where one should create the item object, de
18486 * facto. For example, the object can be a pure Evas image object
18487 * or an Elementary @ref Photocam "photocam" widget. See
18488 * #SlideshowItemGetFunc.
18489 * - @c func.del - When an item is no more displayed, this function
18490 * is called, where the user must delete any data associated to
18491 * the item. See #SlideshowItemDelFunc.
18493 * @section Slideshow_Caching Slideshow caching
18495 * The slideshow provides facilities to have items adjacent to the
18496 * one being displayed <b>already "realized"</b> (i.e. loaded) for
18497 * you, so that the system does not have to decode image data
18498 * anymore at the time it has to actually switch images on its
18499 * viewport. The user is able to set the numbers of items to be
18500 * cached @b before and @b after the current item, in the widget's
18503 * Smart events one can add callbacks for are:
18505 * - @c "changed" - when the slideshow switches its view to a new
18508 * List of examples for the slideshow widget:
18509 * @li @ref slideshow_example
18513 * @addtogroup Slideshow
18517 typedef struct _Elm_Slideshow_Item_Class Elm_Slideshow_Item_Class; /**< Slideshow item class definition struct */
18518 typedef struct _Elm_Slideshow_Item_Class_Func Elm_Slideshow_Item_Class_Func; /**< Class functions for slideshow item classes. */
18519 typedef struct _Elm_Slideshow_Item Elm_Slideshow_Item; /**< Slideshow item handle */
18520 typedef Evas_Object *(*SlideshowItemGetFunc) (void *data, Evas_Object *obj); /**< Image fetching class function for slideshow item classes. */
18521 typedef void (*SlideshowItemDelFunc) (void *data, Evas_Object *obj); /**< Deletion class function for slideshow item classes. */
18524 * @struct _Elm_Slideshow_Item_Class
18526 * Slideshow item class definition. See @ref Slideshow_Items for
18529 struct _Elm_Slideshow_Item_Class
18531 struct _Elm_Slideshow_Item_Class_Func
18533 SlideshowItemGetFunc get;
18534 SlideshowItemDelFunc del;
18536 }; /**< #Elm_Slideshow_Item_Class member definitions */
18539 * Add a new slideshow widget to the given parent Elementary
18540 * (container) object
18542 * @param parent The parent object
18543 * @return A new slideshow widget handle or @c NULL, on errors
18545 * This function inserts a new slideshow widget on the canvas.
18547 * @ingroup Slideshow
18549 EAPI Evas_Object *elm_slideshow_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
18552 * Add (append) a new item in a given slideshow widget.
18554 * @param obj The slideshow object
18555 * @param itc The item class for the item
18556 * @param data The item's data
18557 * @return A handle to the item added or @c NULL, on errors
18559 * Add a new item to @p obj's internal list of items, appending it.
18560 * The item's class must contain the function really fetching the
18561 * image object to show for this item, which could be an Evas image
18562 * object or an Elementary photo, for example. The @p data
18563 * parameter is going to be passed to both class functions of the
18566 * @see #Elm_Slideshow_Item_Class
18567 * @see elm_slideshow_item_sorted_insert()
18569 * @ingroup Slideshow
18571 EAPI Elm_Slideshow_Item *elm_slideshow_item_add(Evas_Object *obj, const Elm_Slideshow_Item_Class *itc, const void *data) EINA_ARG_NONNULL(1);
18574 * Insert a new item into the given slideshow widget, using the @p func
18575 * function to sort items (by item handles).
18577 * @param obj The slideshow object
18578 * @param itc The item class for the item
18579 * @param data The item's data
18580 * @param func The comparing function to be used to sort slideshow
18581 * items <b>by #Elm_Slideshow_Item item handles</b>
18582 * @return Returns The slideshow item handle, on success, or
18583 * @c NULL, on errors
18585 * Add a new item to @p obj's internal list of items, in a position
18586 * determined by the @p func comparing function. The item's class
18587 * must contain the function really fetching the image object to
18588 * show for this item, which could be an Evas image object or an
18589 * Elementary photo, for example. The @p data parameter is going to
18590 * be passed to both class functions of the item.
18592 * @see #Elm_Slideshow_Item_Class
18593 * @see elm_slideshow_item_add()
18595 * @ingroup Slideshow
18597 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);
18600 * Display a given slideshow widget's item, programmatically.
18602 * @param obj The slideshow object
18603 * @param item The item to display on @p obj's viewport
18605 * The change between the current item and @p item will use the
18606 * transition @p obj is set to use (@see
18607 * elm_slideshow_transition_set()).
18609 * @ingroup Slideshow
18611 EAPI void elm_slideshow_show(Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
18614 * Slide to the @b next item, in a given slideshow widget
18616 * @param obj The slideshow object
18618 * The sliding animation @p obj is set to use will be the
18619 * transition effect used, after this call is issued.
18621 * @note If the end of the slideshow's internal list of items is
18622 * reached, it'll wrap around to the list's beginning, again.
18624 * @ingroup Slideshow
18626 EAPI void elm_slideshow_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
18629 * Slide to the @b previous item, in a given slideshow widget
18631 * @param obj The slideshow object
18633 * The sliding animation @p obj is set to use will be the
18634 * transition effect used, after this call is issued.
18636 * @note If the beginning of the slideshow's internal list of items
18637 * is reached, it'll wrap around to the list's end, again.
18639 * @ingroup Slideshow
18641 EAPI void elm_slideshow_previous(Evas_Object *obj) EINA_ARG_NONNULL(1);
18644 * Returns the list of sliding transition/effect names available, for a
18645 * given slideshow widget.
18647 * @param obj The slideshow object
18648 * @return The list of transitions (list of @b stringshared strings
18651 * The transitions, which come from @p obj's theme, must be an EDC
18652 * data item named @c "transitions" on the theme file, with (prefix)
18653 * names of EDC programs actually implementing them.
18655 * The available transitions for slideshows on the default theme are:
18656 * - @c "fade" - the current item fades out, while the new one
18657 * fades in to the slideshow's viewport.
18658 * - @c "black_fade" - the current item fades to black, and just
18659 * then, the new item will fade in.
18660 * - @c "horizontal" - the current item slides horizontally, until
18661 * it gets out of the slideshow's viewport, while the new item
18662 * comes from the left to take its place.
18663 * - @c "vertical" - the current item slides vertically, until it
18664 * gets out of the slideshow's viewport, while the new item comes
18665 * from the bottom to take its place.
18666 * - @c "square" - the new item starts to appear from the middle of
18667 * the current one, but with a tiny size, growing until its
18668 * target (full) size and covering the old one.
18670 * @warning The stringshared strings get no new references
18671 * exclusive to the user grabbing the list, here, so if you'd like
18672 * to use them out of this call's context, you'd better @c
18673 * eina_stringshare_ref() them.
18675 * @see elm_slideshow_transition_set()
18677 * @ingroup Slideshow
18679 EAPI const Eina_List *elm_slideshow_transitions_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18682 * Set the current slide transition/effect in use for a given
18685 * @param obj The slideshow object
18686 * @param transition The new transition's name string
18688 * If @p transition is implemented in @p obj's theme (i.e., is
18689 * contained in the list returned by
18690 * elm_slideshow_transitions_get()), this new sliding effect will
18691 * be used on the widget.
18693 * @see elm_slideshow_transitions_get() for more details
18695 * @ingroup Slideshow
18697 EAPI void elm_slideshow_transition_set(Evas_Object *obj, const char *transition) EINA_ARG_NONNULL(1);
18700 * Get the current slide transition/effect in use for a given
18703 * @param obj The slideshow object
18704 * @return The current transition's name
18706 * @see elm_slideshow_transition_set() for more details
18708 * @ingroup Slideshow
18710 EAPI const char *elm_slideshow_transition_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18713 * Set the interval between each image transition on a given
18714 * slideshow widget, <b>and start the slideshow, itself</b>
18716 * @param obj The slideshow object
18717 * @param timeout The new displaying timeout for images
18719 * After this call, the slideshow widget will start cycling its
18720 * view, sequentially and automatically, with the images of the
18721 * items it has. The time between each new image displayed is going
18722 * to be @p timeout, in @b seconds. If a different timeout was set
18723 * previously and an slideshow was in progress, it will continue
18724 * with the new time between transitions, after this call.
18726 * @note A value less than or equal to 0 on @p timeout will disable
18727 * the widget's internal timer, thus halting any slideshow which
18728 * could be happening on @p obj.
18730 * @see elm_slideshow_timeout_get()
18732 * @ingroup Slideshow
18734 EAPI void elm_slideshow_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
18737 * Get the interval set for image transitions on a given slideshow
18740 * @param obj The slideshow object
18741 * @return Returns the timeout set on it
18743 * @see elm_slideshow_timeout_set() for more details
18745 * @ingroup Slideshow
18747 EAPI double elm_slideshow_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18750 * Set if, after a slideshow is started, for a given slideshow
18751 * widget, its items should be displayed cyclically or not.
18753 * @param obj The slideshow object
18754 * @param loop Use @c EINA_TRUE to make it cycle through items or
18755 * @c EINA_FALSE for it to stop at the end of @p obj's internal
18758 * @note elm_slideshow_next() and elm_slideshow_previous() will @b
18759 * ignore what is set by this functions, i.e., they'll @b always
18760 * cycle through items. This affects only the "automatic"
18761 * slideshow, as set by elm_slideshow_timeout_set().
18763 * @see elm_slideshow_loop_get()
18765 * @ingroup Slideshow
18767 EAPI void elm_slideshow_loop_set(Evas_Object *obj, Eina_Bool loop) EINA_ARG_NONNULL(1);
18770 * Get if, after a slideshow is started, for a given slideshow
18771 * widget, its items are to be displayed cyclically or not.
18773 * @param obj The slideshow object
18774 * @return @c EINA_TRUE, if the items in @p obj will be cycled
18775 * through or @c EINA_FALSE, otherwise
18777 * @see elm_slideshow_loop_set() for more details
18779 * @ingroup Slideshow
18781 EAPI Eina_Bool elm_slideshow_loop_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18784 * Remove all items from a given slideshow widget
18786 * @param obj The slideshow object
18788 * This removes (and deletes) all items in @p obj, leaving it
18791 * @see elm_slideshow_item_del(), to remove just one item.
18793 * @ingroup Slideshow
18795 EAPI void elm_slideshow_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
18798 * Get the internal list of items in a given slideshow widget.
18800 * @param obj The slideshow object
18801 * @return The list of items (#Elm_Slideshow_Item as data) or
18802 * @c NULL on errors.
18804 * This list is @b not to be modified in any way and must not be
18805 * freed. Use the list members with functions like
18806 * elm_slideshow_item_del(), elm_slideshow_item_data_get().
18808 * @warning This list is only valid until @p obj object's internal
18809 * items list is changed. It should be fetched again with another
18810 * call to this function when changes happen.
18812 * @ingroup Slideshow
18814 EAPI const Eina_List *elm_slideshow_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18817 * Delete a given item from a slideshow widget.
18819 * @param item The slideshow item
18821 * @ingroup Slideshow
18823 EAPI void elm_slideshow_item_del(Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
18826 * Return the data associated with a given slideshow item
18828 * @param item The slideshow item
18829 * @return Returns the data associated to this item
18831 * @ingroup Slideshow
18833 EAPI void *elm_slideshow_item_data_get(const Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
18836 * Returns the currently displayed item, in a given slideshow widget
18838 * @param obj The slideshow object
18839 * @return A handle to the item being displayed in @p obj or
18840 * @c NULL, if none is (and on errors)
18842 * @ingroup Slideshow
18844 EAPI Elm_Slideshow_Item *elm_slideshow_item_current_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18847 * Get the real Evas object created to implement the view of a
18848 * given slideshow item
18850 * @param item The slideshow item.
18851 * @return the Evas object implementing this item's view.
18853 * This returns the actual Evas object used to implement the
18854 * specified slideshow item's view. This may be @c NULL, as it may
18855 * not have been created or may have been deleted, at any time, by
18856 * the slideshow. <b>Do not modify this object</b> (move, resize,
18857 * show, hide, etc.), as the slideshow is controlling it. This
18858 * function is for querying, emitting custom signals or hooking
18859 * lower level callbacks for events on that object. Do not delete
18860 * this object under any circumstances.
18862 * @see elm_slideshow_item_data_get()
18864 * @ingroup Slideshow
18866 EAPI Evas_Object* elm_slideshow_item_object_get(const Elm_Slideshow_Item* item) EINA_ARG_NONNULL(1);
18869 * Get the the item, in a given slideshow widget, placed at
18870 * position @p nth, in its internal items list
18872 * @param obj The slideshow object
18873 * @param nth The number of the item to grab a handle to (0 being
18875 * @return The item stored in @p obj at position @p nth or @c NULL,
18876 * if there's no item with that index (and on errors)
18878 * @ingroup Slideshow
18880 EAPI Elm_Slideshow_Item *elm_slideshow_item_nth_get(const Evas_Object *obj, unsigned int nth) EINA_ARG_NONNULL(1);
18883 * Set the current slide layout in use for a given slideshow widget
18885 * @param obj The slideshow object
18886 * @param layout The new layout's name string
18888 * If @p layout is implemented in @p obj's theme (i.e., is contained
18889 * in the list returned by elm_slideshow_layouts_get()), this new
18890 * images layout will be used on the widget.
18892 * @see elm_slideshow_layouts_get() for more details
18894 * @ingroup Slideshow
18896 EAPI void elm_slideshow_layout_set(Evas_Object *obj, const char *layout) EINA_ARG_NONNULL(1);
18899 * Get the current slide layout in use for a given slideshow widget
18901 * @param obj The slideshow object
18902 * @return The current layout's name
18904 * @see elm_slideshow_layout_set() for more details
18906 * @ingroup Slideshow
18908 EAPI const char *elm_slideshow_layout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18911 * Returns the list of @b layout names available, for a given
18912 * slideshow widget.
18914 * @param obj The slideshow object
18915 * @return The list of layouts (list of @b stringshared strings
18918 * Slideshow layouts will change how the widget is to dispose each
18919 * image item in its viewport, with regard to cropping, scaling,
18922 * The layouts, which come from @p obj's theme, must be an EDC
18923 * data item name @c "layouts" on the theme file, with (prefix)
18924 * names of EDC programs actually implementing them.
18926 * The available layouts for slideshows on the default theme are:
18927 * - @c "fullscreen" - item images with original aspect, scaled to
18928 * touch top and down slideshow borders or, if the image's heigh
18929 * is not enough, left and right slideshow borders.
18930 * - @c "not_fullscreen" - the same behavior as the @c "fullscreen"
18931 * one, but always leaving 10% of the slideshow's dimensions of
18932 * distance between the item image's borders and the slideshow
18933 * borders, for each axis.
18935 * @warning The stringshared strings get no new references
18936 * exclusive to the user grabbing the list, here, so if you'd like
18937 * to use them out of this call's context, you'd better @c
18938 * eina_stringshare_ref() them.
18940 * @see elm_slideshow_layout_set()
18942 * @ingroup Slideshow
18944 EAPI const Eina_List *elm_slideshow_layouts_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18947 * Set the number of items to cache, on a given slideshow widget,
18948 * <b>before the current item</b>
18950 * @param obj The slideshow object
18951 * @param count Number of items to cache before the current one
18953 * The default value for this property is @c 2. See
18954 * @ref Slideshow_Caching "slideshow caching" for more details.
18956 * @see elm_slideshow_cache_before_get()
18958 * @ingroup Slideshow
18960 EAPI void elm_slideshow_cache_before_set(Evas_Object *obj, int count) EINA_ARG_NONNULL(1);
18963 * Retrieve the number of items to cache, on a given slideshow widget,
18964 * <b>before the current item</b>
18966 * @param obj The slideshow object
18967 * @return The number of items set to be cached before the current one
18969 * @see elm_slideshow_cache_before_set() for more details
18971 * @ingroup Slideshow
18973 EAPI int elm_slideshow_cache_before_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18976 * Set the number of items to cache, on a given slideshow widget,
18977 * <b>after the current item</b>
18979 * @param obj The slideshow object
18980 * @param count Number of items to cache after the current one
18982 * The default value for this property is @c 2. See
18983 * @ref Slideshow_Caching "slideshow caching" for more details.
18985 * @see elm_slideshow_cache_after_get()
18987 * @ingroup Slideshow
18989 EAPI void elm_slideshow_cache_after_set(Evas_Object *obj, int count) EINA_ARG_NONNULL(1);
18992 * Retrieve the number of items to cache, on a given slideshow widget,
18993 * <b>after the current item</b>
18995 * @param obj The slideshow object
18996 * @return The number of items set to be cached after the current one
18998 * @see elm_slideshow_cache_after_set() for more details
19000 * @ingroup Slideshow
19002 EAPI int elm_slideshow_cache_after_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19005 * Get the number of items stored in a given slideshow widget
19007 * @param obj The slideshow object
19008 * @return The number of items on @p obj, at the moment of this call
19010 * @ingroup Slideshow
19012 EAPI unsigned int elm_slideshow_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19019 * @defgroup Fileselector File Selector
19021 * @image html img/widget/fileselector/preview-00.png
19022 * @image latex img/widget/fileselector/preview-00.eps
19024 * A file selector is a widget that allows a user to navigate
19025 * through a file system, reporting file selections back via its
19028 * It contains shortcut buttons for home directory (@c ~) and to
19029 * jump one directory upwards (..), as well as cancel/ok buttons to
19030 * confirm/cancel a given selection. After either one of those two
19031 * former actions, the file selector will issue its @c "done" smart
19034 * There's a text entry on it, too, showing the name of the current
19035 * selection. There's the possibility of making it editable, so it
19036 * is useful on file saving dialogs on applications, where one
19037 * gives a file name to save contents to, in a given directory in
19038 * the system. This custom file name will be reported on the @c
19039 * "done" smart callback (explained in sequence).
19041 * Finally, it has a view to display file system items into in two
19046 * If Elementary is built with support of the Ethumb thumbnailing
19047 * library, the second form of view will display preview thumbnails
19048 * of files which it supports.
19050 * Smart callbacks one can register to:
19052 * - @c "selected" - the user has clicked on a file (when not in
19053 * folders-only mode) or directory (when in folders-only mode)
19054 * - @c "directory,open" - the list has been populated with new
19055 * content (@c event_info is a pointer to the directory's
19056 * path, a @b stringshared string)
19057 * - @c "done" - the user has clicked on the "ok" or "cancel"
19058 * buttons (@c event_info is a pointer to the selection's
19059 * path, a @b stringshared string)
19061 * Here is an example on its usage:
19062 * @li @ref fileselector_example
19066 * @addtogroup Fileselector
19071 * Defines how a file selector widget is to layout its contents
19072 * (file system entries).
19074 typedef enum _Elm_Fileselector_Mode
19076 ELM_FILESELECTOR_LIST = 0, /**< layout as a list */
19077 ELM_FILESELECTOR_GRID, /**< layout as a grid */
19078 ELM_FILESELECTOR_LAST /**< sentinel (helper) value, not used */
19079 } Elm_Fileselector_Mode;
19082 * Add a new file selector widget to the given parent Elementary
19083 * (container) object
19085 * @param parent The parent object
19086 * @return a new file selector widget handle or @c NULL, on errors
19088 * This function inserts a new file selector widget on the canvas.
19090 * @ingroup Fileselector
19092 EAPI Evas_Object *elm_fileselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
19095 * Enable/disable the file name entry box where the user can type
19096 * in a name for a file, in a given file selector widget
19098 * @param obj The file selector object
19099 * @param is_save @c EINA_TRUE to make the file selector a "saving
19100 * dialog", @c EINA_FALSE otherwise
19102 * Having the entry editable is useful on file saving dialogs on
19103 * applications, where one gives a file name to save contents to,
19104 * in a given directory in the system. This custom file name will
19105 * be reported on the @c "done" smart callback.
19107 * @see elm_fileselector_is_save_get()
19109 * @ingroup Fileselector
19111 EAPI void elm_fileselector_is_save_set(Evas_Object *obj, Eina_Bool is_save) EINA_ARG_NONNULL(1);
19114 * Get whether the given file selector is in "saving dialog" mode
19116 * @param obj The file selector object
19117 * @return @c EINA_TRUE, if the file selector is in "saving dialog"
19118 * mode, @c EINA_FALSE otherwise (and on errors)
19120 * @see elm_fileselector_is_save_set() for more details
19122 * @ingroup Fileselector
19124 EAPI Eina_Bool elm_fileselector_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19127 * Enable/disable folder-only view for a given file selector widget
19129 * @param obj The file selector object
19130 * @param only @c EINA_TRUE to make @p obj only display
19131 * directories, @c EINA_FALSE to make files to be displayed in it
19134 * If enabled, the widget's view will only display folder items,
19137 * @see elm_fileselector_folder_only_get()
19139 * @ingroup Fileselector
19141 EAPI void elm_fileselector_folder_only_set(Evas_Object *obj, Eina_Bool only) EINA_ARG_NONNULL(1);
19144 * Get whether folder-only view is set for a given file selector
19147 * @param obj The file selector object
19148 * @return only @c EINA_TRUE if @p obj is only displaying
19149 * directories, @c EINA_FALSE if files are being displayed in it
19150 * too (and on errors)
19152 * @see elm_fileselector_folder_only_get()
19154 * @ingroup Fileselector
19156 EAPI Eina_Bool elm_fileselector_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19159 * Enable/disable the "ok" and "cancel" buttons on a given file
19162 * @param obj The file selector object
19163 * @param only @c EINA_TRUE to show them, @c EINA_FALSE to hide.
19165 * @note A file selector without those buttons will never emit the
19166 * @c "done" smart event, and is only usable if one is just hooking
19167 * to the other two events.
19169 * @see elm_fileselector_buttons_ok_cancel_get()
19171 * @ingroup Fileselector
19173 EAPI void elm_fileselector_buttons_ok_cancel_set(Evas_Object *obj, Eina_Bool buttons) EINA_ARG_NONNULL(1);
19176 * Get whether the "ok" and "cancel" buttons on a given file
19177 * selector widget are being shown.
19179 * @param obj The file selector object
19180 * @return @c EINA_TRUE if they are being shown, @c EINA_FALSE
19181 * otherwise (and on errors)
19183 * @see elm_fileselector_buttons_ok_cancel_set() for more details
19185 * @ingroup Fileselector
19187 EAPI Eina_Bool elm_fileselector_buttons_ok_cancel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19190 * Enable/disable a tree view in the given file selector widget,
19191 * <b>if it's in @c #ELM_FILESELECTOR_LIST mode</b>
19193 * @param obj The file selector object
19194 * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
19197 * In a tree view, arrows are created on the sides of directories,
19198 * allowing them to expand in place.
19200 * @note If it's in other mode, the changes made by this function
19201 * will only be visible when one switches back to "list" mode.
19203 * @see elm_fileselector_expandable_get()
19205 * @ingroup Fileselector
19207 EAPI void elm_fileselector_expandable_set(Evas_Object *obj, Eina_Bool expand) EINA_ARG_NONNULL(1);
19210 * Get whether tree view is enabled for the given file selector
19213 * @param obj The file selector object
19214 * @return @c EINA_TRUE if @p obj is in tree view, @c EINA_FALSE
19215 * otherwise (and or errors)
19217 * @see elm_fileselector_expandable_set() for more details
19219 * @ingroup Fileselector
19221 EAPI Eina_Bool elm_fileselector_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19224 * Set, programmatically, the @b directory that a given file
19225 * selector widget will display contents from
19227 * @param obj The file selector object
19228 * @param path The path to display in @p obj
19230 * This will change the @b directory that @p obj is displaying. It
19231 * will also clear the text entry area on the @p obj object, which
19232 * displays select files' names.
19234 * @see elm_fileselector_path_get()
19236 * @ingroup Fileselector
19238 EAPI void elm_fileselector_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
19241 * Get the parent directory's path that a given file selector
19242 * widget is displaying
19244 * @param obj The file selector object
19245 * @return The (full) path of the directory the file selector is
19246 * displaying, a @b stringshared string
19248 * @see elm_fileselector_path_set()
19250 * @ingroup Fileselector
19252 EAPI const char *elm_fileselector_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19255 * Set, programmatically, the currently selected file/directory in
19256 * the given file selector widget
19258 * @param obj The file selector object
19259 * @param path The (full) path to a file or directory
19260 * @return @c EINA_TRUE on success, @c EINA_FALSE on failure. The
19261 * latter case occurs if the directory or file pointed to do not
19264 * @see elm_fileselector_selected_get()
19266 * @ingroup Fileselector
19268 EAPI Eina_Bool elm_fileselector_selected_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
19271 * Get the currently selected item's (full) path, in the given file
19274 * @param obj The file selector object
19275 * @return The absolute path of the selected item, a @b
19276 * stringshared string
19278 * @note Custom editions on @p obj object's text entry, if made,
19279 * will appear on the return string of this function, naturally.
19281 * @see elm_fileselector_selected_set() for more details
19283 * @ingroup Fileselector
19285 EAPI const char *elm_fileselector_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19288 * Set the mode in which a given file selector widget will display
19289 * (layout) file system entries in its view
19291 * @param obj The file selector object
19292 * @param mode The mode of the fileselector, being it one of
19293 * #ELM_FILESELECTOR_LIST (default) or #ELM_FILESELECTOR_GRID. The
19294 * first one, naturally, will display the files in a list. The
19295 * latter will make the widget to display its entries in a grid
19298 * @note By using elm_fileselector_expandable_set(), the user may
19299 * trigger a tree view for that list.
19301 * @note If Elementary is built with support of the Ethumb
19302 * thumbnailing library, the second form of view will display
19303 * preview thumbnails of files which it supports. You must have
19304 * elm_need_ethumb() called in your Elementary for thumbnailing to
19307 * @see elm_fileselector_expandable_set().
19308 * @see elm_fileselector_mode_get().
19310 * @ingroup Fileselector
19312 EAPI void elm_fileselector_mode_set(Evas_Object *obj, Elm_Fileselector_Mode mode) EINA_ARG_NONNULL(1);
19315 * Get the mode in which a given file selector widget is displaying
19316 * (layouting) file system entries in its view
19318 * @param obj The fileselector object
19319 * @return The mode in which the fileselector is at
19321 * @see elm_fileselector_mode_set() for more details
19323 * @ingroup Fileselector
19325 EAPI Elm_Fileselector_Mode elm_fileselector_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19332 * @defgroup Progressbar Progress bar
19334 * The progress bar is a widget for visually representing the
19335 * progress status of a given job/task.
19337 * A progress bar may be horizontal or vertical. It may display an
19338 * icon besides it, as well as primary and @b units labels. The
19339 * former is meant to label the widget as a whole, while the
19340 * latter, which is formatted with floating point values (and thus
19341 * accepts a <c>printf</c>-style format string, like <c>"%1.2f
19342 * units"</c>), is meant to label the widget's <b>progress
19343 * value</b>. Label, icon and unit strings/objects are @b optional
19344 * for progress bars.
19346 * A progress bar may be @b inverted, in which state it gets its
19347 * values inverted, with high values being on the left or top and
19348 * low values on the right or bottom, as opposed to normally have
19349 * the low values on the former and high values on the latter,
19350 * respectively, for horizontal and vertical modes.
19352 * The @b span of the progress, as set by
19353 * elm_progressbar_span_size_set(), is its length (horizontally or
19354 * vertically), unless one puts size hints on the widget to expand
19355 * on desired directions, by any container. That length will be
19356 * scaled by the object or applications scaling factor. At any
19357 * point code can query the progress bar for its value with
19358 * elm_progressbar_value_get().
19360 * Available widget styles for progress bars:
19362 * - @c "wheel" (simple style, no text, no progression, only
19363 * "pulse" effect is available)
19365 * Here is an example on its usage:
19366 * @li @ref progressbar_example
19370 * Add a new progress bar widget to the given parent Elementary
19371 * (container) object
19373 * @param parent The parent object
19374 * @return a new progress bar widget handle or @c NULL, on errors
19376 * This function inserts a new progress bar widget on the canvas.
19378 * @ingroup Progressbar
19380 EAPI Evas_Object *elm_progressbar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
19383 * Set whether a given progress bar widget is at "pulsing mode" or
19386 * @param obj The progress bar object
19387 * @param pulse @c EINA_TRUE to put @p obj in pulsing mode,
19388 * @c EINA_FALSE to put it back to its default one
19390 * By default, progress bars will display values from the low to
19391 * high value boundaries. There are, though, contexts in which the
19392 * state of progression of a given task is @b unknown. For those,
19393 * one can set a progress bar widget to a "pulsing state", to give
19394 * the user an idea that some computation is being held, but
19395 * without exact progress values. In the default theme it will
19396 * animate its bar with the contents filling in constantly and back
19397 * to non-filled, in a loop. To start and stop this pulsing
19398 * animation, one has to explicitly call elm_progressbar_pulse().
19400 * @see elm_progressbar_pulse_get()
19401 * @see elm_progressbar_pulse()
19403 * @ingroup Progressbar
19405 EAPI void elm_progressbar_pulse_set(Evas_Object *obj, Eina_Bool pulse) EINA_ARG_NONNULL(1);
19408 * Get whether a given progress bar widget is at "pulsing mode" or
19411 * @param obj The progress bar object
19412 * @return @c EINA_TRUE, if @p obj is in pulsing mode, @c EINA_FALSE
19413 * if it's in the default one (and on errors)
19415 * @ingroup Progressbar
19417 EAPI Eina_Bool elm_progressbar_pulse_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19420 * Start/stop a given progress bar "pulsing" animation, if its
19423 * @param obj The progress bar object
19424 * @param state @c EINA_TRUE, to @b start the pulsing animation,
19425 * @c EINA_FALSE to @b stop it
19427 * @note This call won't do anything if @p obj is not under "pulsing mode".
19429 * @see elm_progressbar_pulse_set() for more details.
19431 * @ingroup Progressbar
19433 EAPI void elm_progressbar_pulse(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
19436 * Set the progress value (in percentage) on a given progress bar
19439 * @param obj The progress bar object
19440 * @param val The progress value (@b must be between @c 0.0 and @c
19443 * Use this call to set progress bar levels.
19445 * @note If you passes a value out of the specified range for @p
19446 * val, it will be interpreted as the @b closest of the @b boundary
19447 * values in the range.
19449 * @ingroup Progressbar
19451 EAPI void elm_progressbar_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
19454 * Get the progress value (in percentage) on a given progress bar
19457 * @param obj The progress bar object
19458 * @return The value of the progressbar
19460 * @see elm_progressbar_value_set() for more details
19462 * @ingroup Progressbar
19464 EAPI double elm_progressbar_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19467 * Set the label of a given progress bar widget
19469 * @param obj The progress bar object
19470 * @param label The text label string, in UTF-8
19472 * @ingroup Progressbar
19473 * @deprecated use elm_object_text_set() instead.
19475 EINA_DEPRECATED EAPI void elm_progressbar_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
19478 * Get the label of a given progress bar widget
19480 * @param obj The progressbar object
19481 * @return The text label string, in UTF-8
19483 * @ingroup Progressbar
19484 * @deprecated use elm_object_text_set() instead.
19486 EINA_DEPRECATED EAPI const char *elm_progressbar_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19489 * Set the icon object of a given progress bar widget
19491 * @param obj The progress bar object
19492 * @param icon The icon object
19494 * Use this call to decorate @p obj with an icon next to it.
19496 * @note Once the icon object is set, a previously set one will be
19497 * deleted. If you want to keep that old content object, use the
19498 * elm_progressbar_icon_unset() function.
19500 * @see elm_progressbar_icon_get()
19502 * @ingroup Progressbar
19504 EAPI void elm_progressbar_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
19507 * Retrieve the icon object set for a given progress bar widget
19509 * @param obj The progress bar object
19510 * @return The icon object's handle, if @p obj had one set, or @c NULL,
19511 * otherwise (and on errors)
19513 * @see elm_progressbar_icon_set() for more details
19515 * @ingroup Progressbar
19517 EAPI Evas_Object *elm_progressbar_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19520 * Unset an icon set on a given progress bar widget
19522 * @param obj The progress bar object
19523 * @return The icon object that was being used, if any was set, or
19524 * @c NULL, otherwise (and on errors)
19526 * This call will unparent and return the icon object which was set
19527 * for this widget, previously, on success.
19529 * @see elm_progressbar_icon_set() for more details
19531 * @ingroup Progressbar
19533 EAPI Evas_Object *elm_progressbar_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
19536 * Set the (exact) length of the bar region of a given progress bar
19539 * @param obj The progress bar object
19540 * @param size The length of the progress bar's bar region
19542 * This sets the minimum width (when in horizontal mode) or height
19543 * (when in vertical mode) of the actual bar area of the progress
19544 * bar @p obj. This in turn affects the object's minimum size. Use
19545 * this when you're not setting other size hints expanding on the
19546 * given direction (like weight and alignment hints) and you would
19547 * like it to have a specific size.
19549 * @note Icon, label and unit text around @p obj will require their
19550 * own space, which will make @p obj to require more the @p size,
19553 * @see elm_progressbar_span_size_get()
19555 * @ingroup Progressbar
19557 EAPI void elm_progressbar_span_size_set(Evas_Object *obj, Evas_Coord size) EINA_ARG_NONNULL(1);
19560 * Get the length set for the bar region of a given progress bar
19563 * @param obj The progress bar object
19564 * @return The length of the progress bar's bar region
19566 * If that size was not set previously, with
19567 * elm_progressbar_span_size_set(), this call will return @c 0.
19569 * @ingroup Progressbar
19571 EAPI Evas_Coord elm_progressbar_span_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19574 * Set the format string for a given progress bar widget's units
19577 * @param obj The progress bar object
19578 * @param format The format string for @p obj's units label
19580 * If @c NULL is passed on @p format, it will make @p obj's units
19581 * area to be hidden completely. If not, it'll set the <b>format
19582 * string</b> for the units label's @b text. The units label is
19583 * provided a floating point value, so the units text is up display
19584 * at most one floating point falue. Note that the units label is
19585 * optional. Use a format string such as "%1.2f meters" for
19588 * @note The default format string for a progress bar is an integer
19589 * percentage, as in @c "%.0f %%".
19591 * @see elm_progressbar_unit_format_get()
19593 * @ingroup Progressbar
19595 EAPI void elm_progressbar_unit_format_set(Evas_Object *obj, const char *format) EINA_ARG_NONNULL(1);
19598 * Retrieve the format string set for a given progress bar widget's
19601 * @param obj The progress bar object
19602 * @return The format set string for @p obj's units label or
19603 * @c NULL, if none was set (and on errors)
19605 * @see elm_progressbar_unit_format_set() for more details
19607 * @ingroup Progressbar
19609 EAPI const char *elm_progressbar_unit_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19612 * Set the orientation of a given progress bar widget
19614 * @param obj The progress bar object
19615 * @param horizontal Use @c EINA_TRUE to make @p obj to be
19616 * @b horizontal, @c EINA_FALSE to make it @b vertical
19618 * Use this function to change how your progress bar is to be
19619 * disposed: vertically or horizontally.
19621 * @see elm_progressbar_horizontal_get()
19623 * @ingroup Progressbar
19625 EAPI void elm_progressbar_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
19628 * Retrieve the orientation of a given progress bar widget
19630 * @param obj The progress bar object
19631 * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
19632 * @c EINA_FALSE if it's @b vertical (and on errors)
19634 * @see elm_progressbar_horizontal_set() for more details
19636 * @ingroup Progressbar
19638 EAPI Eina_Bool elm_progressbar_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19641 * Invert a given progress bar widget's displaying values order
19643 * @param obj The progress bar object
19644 * @param inverted Use @c EINA_TRUE to make @p obj inverted,
19645 * @c EINA_FALSE to bring it back to default, non-inverted values.
19647 * A progress bar may be @b inverted, in which state it gets its
19648 * values inverted, with high values being on the left or top and
19649 * low values on the right or bottom, as opposed to normally have
19650 * the low values on the former and high values on the latter,
19651 * respectively, for horizontal and vertical modes.
19653 * @see elm_progressbar_inverted_get()
19655 * @ingroup Progressbar
19657 EAPI void elm_progressbar_inverted_set(Evas_Object *obj, Eina_Bool inverted) EINA_ARG_NONNULL(1);
19660 * Get whether a given progress bar widget's displaying values are
19663 * @param obj The progress bar object
19664 * @return @c EINA_TRUE, if @p obj has inverted values,
19665 * @c EINA_FALSE otherwise (and on errors)
19667 * @see elm_progressbar_inverted_set() for more details
19669 * @ingroup Progressbar
19671 EAPI Eina_Bool elm_progressbar_inverted_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19674 * @defgroup Separator Separator
19676 * @brief Separator is a very thin object used to separate other objects.
19678 * A separator can be vertical or horizontal.
19680 * @ref tutorial_separator is a good example of how to use a separator.
19684 * @brief Add a separator object to @p parent
19686 * @param parent The parent object
19688 * @return The separator object, or NULL upon failure
19690 EAPI Evas_Object *elm_separator_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
19692 * @brief Set the horizontal mode of a separator object
19694 * @param obj The separator object
19695 * @param horizontal If true, the separator is horizontal
19697 EAPI void elm_separator_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
19699 * @brief Get the horizontal mode of a separator object
19701 * @param obj The separator object
19702 * @return If true, the separator is horizontal
19704 * @see elm_separator_horizontal_set()
19706 EAPI Eina_Bool elm_separator_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19712 * @defgroup Spinner Spinner
19713 * @ingroup Elementary
19715 * @image html img/widget/spinner/preview-00.png
19716 * @image latex img/widget/spinner/preview-00.eps
19718 * A spinner is a widget which allows the user to increase or decrease
19719 * numeric values using arrow buttons, or edit values directly, clicking
19720 * over it and typing the new value.
19722 * By default the spinner will not wrap and has a label
19723 * of "%.0f" (just showing the integer value of the double).
19725 * A spinner has a label that is formatted with floating
19726 * point values and thus accepts a printf-style format string, like
19729 * It also allows specific values to be replaced by pre-defined labels.
19731 * Smart callbacks one can register to:
19733 * - "changed" - Whenever the spinner value is changed.
19734 * - "delay,changed" - A short time after the value is changed by the user.
19735 * This will be called only when the user stops dragging for a very short
19736 * period or when they release their finger/mouse, so it avoids possibly
19737 * expensive reactions to the value change.
19739 * Available styles for it:
19741 * - @c "vertical": up/down buttons at the right side and text left aligned.
19743 * Here is an example on its usage:
19744 * @ref spinner_example
19748 * @addtogroup Spinner
19753 * Add a new spinner widget to the given parent Elementary
19754 * (container) object.
19756 * @param parent The parent object.
19757 * @return a new spinner widget handle or @c NULL, on errors.
19759 * This function inserts a new spinner widget on the canvas.
19764 EAPI Evas_Object *elm_spinner_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
19767 * Set the format string of the displayed label.
19769 * @param obj The spinner object.
19770 * @param fmt The format string for the label display.
19772 * If @c NULL, this sets the format to "%.0f". If not it sets the format
19773 * string for the label text. The label text is provided a floating point
19774 * value, so the label text can display up to 1 floating point value.
19775 * Note that this is optional.
19777 * Use a format string such as "%1.2f meters" for example, and it will
19778 * display values like: "3.14 meters" for a value equal to 3.14159.
19780 * Default is "%0.f".
19782 * @see elm_spinner_label_format_get()
19786 EAPI void elm_spinner_label_format_set(Evas_Object *obj, const char *fmt) EINA_ARG_NONNULL(1);
19789 * Get the label format of the spinner.
19791 * @param obj The spinner object.
19792 * @return The text label format string in UTF-8.
19794 * @see elm_spinner_label_format_set() for details.
19798 EAPI const char *elm_spinner_label_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19801 * Set the minimum and maximum values for the spinner.
19803 * @param obj The spinner object.
19804 * @param min The minimum value.
19805 * @param max The maximum value.
19807 * Define the allowed range of values to be selected by the user.
19809 * If actual value is less than @p min, it will be updated to @p min. If it
19810 * is bigger then @p max, will be updated to @p max. Actual value can be
19811 * get with elm_spinner_value_get().
19813 * By default, min is equal to 0, and max is equal to 100.
19815 * @warning Maximum must be greater than minimum.
19817 * @see elm_spinner_min_max_get()
19821 EAPI void elm_spinner_min_max_set(Evas_Object *obj, double min, double max) EINA_ARG_NONNULL(1);
19824 * Get the minimum and maximum values of the spinner.
19826 * @param obj The spinner object.
19827 * @param min Pointer where to store the minimum value.
19828 * @param max Pointer where to store the maximum value.
19830 * @note If only one value is needed, the other pointer can be passed
19833 * @see elm_spinner_min_max_set() for details.
19837 EAPI void elm_spinner_min_max_get(const Evas_Object *obj, double *min, double *max) EINA_ARG_NONNULL(1);
19840 * Set the step used to increment or decrement the spinner value.
19842 * @param obj The spinner object.
19843 * @param step The step value.
19845 * This value will be incremented or decremented to the displayed value.
19846 * It will be incremented while the user keep right or top arrow pressed,
19847 * and will be decremented while the user keep left or bottom arrow pressed.
19849 * The interval to increment / decrement can be set with
19850 * elm_spinner_interval_set().
19852 * By default step value is equal to 1.
19854 * @see elm_spinner_step_get()
19858 EAPI void elm_spinner_step_set(Evas_Object *obj, double step) EINA_ARG_NONNULL(1);
19861 * Get the step used to increment or decrement the spinner value.
19863 * @param obj The spinner object.
19864 * @return The step value.
19866 * @see elm_spinner_step_get() for more details.
19870 EAPI double elm_spinner_step_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19873 * Set the value the spinner displays.
19875 * @param obj The spinner object.
19876 * @param val The value to be displayed.
19878 * Value will be presented on the label following format specified with
19879 * elm_spinner_format_set().
19881 * @warning The value must to be between min and max values. This values
19882 * are set by elm_spinner_min_max_set().
19884 * @see elm_spinner_value_get().
19885 * @see elm_spinner_format_set().
19886 * @see elm_spinner_min_max_set().
19890 EAPI void elm_spinner_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
19893 * Get the value displayed by the spinner.
19895 * @param obj The spinner object.
19896 * @return The value displayed.
19898 * @see elm_spinner_value_set() for details.
19902 EAPI double elm_spinner_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19905 * Set whether the spinner should wrap when it reaches its
19906 * minimum or maximum value.
19908 * @param obj The spinner object.
19909 * @param wrap @c EINA_TRUE to enable wrap or @c EINA_FALSE to
19912 * Disabled by default. If disabled, when the user tries to increment the
19914 * but displayed value plus step value is bigger than maximum value,
19916 * won't allow it. The same happens when the user tries to decrement it,
19917 * but the value less step is less than minimum value.
19919 * When wrap is enabled, in such situations it will allow these changes,
19920 * but will get the value that would be less than minimum and subtracts
19921 * from maximum. Or add the value that would be more than maximum to
19925 * @li min value = 10
19926 * @li max value = 50
19927 * @li step value = 20
19928 * @li displayed value = 20
19930 * When the user decrement value (using left or bottom arrow), it will
19931 * displays @c 40, because max - (min - (displayed - step)) is
19932 * @c 50 - (@c 10 - (@c 20 - @c 20)) = @c 40.
19934 * @see elm_spinner_wrap_get().
19938 EAPI void elm_spinner_wrap_set(Evas_Object *obj, Eina_Bool wrap) EINA_ARG_NONNULL(1);
19941 * Get whether the spinner should wrap when it reaches its
19942 * minimum or maximum value.
19944 * @param obj The spinner object
19945 * @return @c EINA_TRUE means wrap is enabled. @c EINA_FALSE indicates
19946 * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
19948 * @see elm_spinner_wrap_set() for details.
19952 EAPI Eina_Bool elm_spinner_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19955 * Set whether the spinner can be directly edited by the user or not.
19957 * @param obj The spinner object.
19958 * @param editable @c EINA_TRUE to allow users to edit it or @c EINA_FALSE to
19959 * don't allow users to edit it directly.
19961 * Spinner objects can have edition @b disabled, in which state they will
19962 * be changed only by arrows.
19963 * Useful for contexts
19964 * where you don't want your users to interact with it writting the value.
19966 * when using special values, the user can see real value instead
19967 * of special label on edition.
19969 * It's enabled by default.
19971 * @see elm_spinner_editable_get()
19975 EAPI void elm_spinner_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
19978 * Get whether the spinner can be directly edited by the user or not.
19980 * @param obj The spinner object.
19981 * @return @c EINA_TRUE means edition is enabled. @c EINA_FALSE indicates
19982 * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
19984 * @see elm_spinner_editable_set() for details.
19988 EAPI Eina_Bool elm_spinner_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19991 * Set a special string to display in the place of the numerical value.
19993 * @param obj The spinner object.
19994 * @param value The value to be replaced.
19995 * @param label The label to be used.
19997 * It's useful for cases when a user should select an item that is
19998 * better indicated by a label than a value. For example, weekdays or months.
20002 * sp = elm_spinner_add(win);
20003 * elm_spinner_min_max_set(sp, 1, 3);
20004 * elm_spinner_special_value_add(sp, 1, "January");
20005 * elm_spinner_special_value_add(sp, 2, "February");
20006 * elm_spinner_special_value_add(sp, 3, "March");
20007 * evas_object_show(sp);
20012 EAPI void elm_spinner_special_value_add(Evas_Object *obj, double value, const char *label) EINA_ARG_NONNULL(1);
20015 * Set the interval on time updates for an user mouse button hold
20016 * on spinner widgets' arrows.
20018 * @param obj The spinner object.
20019 * @param interval The (first) interval value in seconds.
20021 * This interval value is @b decreased while the user holds the
20022 * mouse pointer either incrementing or decrementing spinner's value.
20024 * This helps the user to get to a given value distant from the
20025 * current one easier/faster, as it will start to change quicker and
20026 * quicker on mouse button holds.
20028 * The calculation for the next change interval value, starting from
20029 * the one set with this call, is the previous interval divided by
20030 * @c 1.05, so it decreases a little bit.
20032 * The default starting interval value for automatic changes is
20035 * @see elm_spinner_interval_get()
20039 EAPI void elm_spinner_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
20042 * Get the interval on time updates for an user mouse button hold
20043 * on spinner widgets' arrows.
20045 * @param obj The spinner object.
20046 * @return The (first) interval value, in seconds, set on it.
20048 * @see elm_spinner_interval_set() for more details.
20052 EAPI double elm_spinner_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20059 * @defgroup Index Index
20061 * @image html img/widget/index/preview-00.png
20062 * @image latex img/widget/index/preview-00.eps
20064 * An index widget gives you an index for fast access to whichever
20065 * group of other UI items one might have. It's a list of text
20066 * items (usually letters, for alphabetically ordered access).
20068 * Index widgets are by default hidden and just appear when the
20069 * user clicks over it's reserved area in the canvas. In its
20070 * default theme, it's an area one @ref Fingers "finger" wide on
20071 * the right side of the index widget's container.
20073 * When items on the index are selected, smart callbacks get
20074 * called, so that its user can make other container objects to
20075 * show a given area or child object depending on the index item
20076 * selected. You'd probably be using an index together with @ref
20077 * List "lists", @ref Genlist "generic lists" or @ref Gengrid
20080 * Smart events one can add callbacks for are:
20081 * - @c "changed" - When the selected index item changes. @c
20082 * event_info is the selected item's data pointer.
20083 * - @c "delay,changed" - When the selected index item changes, but
20084 * after a small idling period. @c event_info is the selected
20085 * item's data pointer.
20086 * - @c "selected" - When the user releases a mouse button and
20087 * selects an item. @c event_info is the selected item's data
20089 * - @c "level,up" - when the user moves a finger from the first
20090 * level to the second level
20091 * - @c "level,down" - when the user moves a finger from the second
20092 * level to the first level
20094 * The @c "delay,changed" event is so that it'll wait a small time
20095 * before actually reporting those events and, moreover, just the
20096 * last event happening on those time frames will actually be
20099 * Here are some examples on its usage:
20100 * @li @ref index_example_01
20101 * @li @ref index_example_02
20105 * @addtogroup Index
20109 typedef struct _Elm_Index_Item Elm_Index_Item; /**< Opaque handle for items of Elementary index widgets */
20112 * Add a new index widget to the given parent Elementary
20113 * (container) object
20115 * @param parent The parent object
20116 * @return a new index widget handle or @c NULL, on errors
20118 * This function inserts a new index widget on the canvas.
20122 EAPI Evas_Object *elm_index_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20125 * Set whether a given index widget is or not visible,
20128 * @param obj The index object
20129 * @param active @c EINA_TRUE to show it, @c EINA_FALSE to hide it
20131 * Not to be confused with visible as in @c evas_object_show() --
20132 * visible with regard to the widget's auto hiding feature.
20134 * @see elm_index_active_get()
20138 EAPI void elm_index_active_set(Evas_Object *obj, Eina_Bool active) EINA_ARG_NONNULL(1);
20141 * Get whether a given index widget is currently visible or not.
20143 * @param obj The index object
20144 * @return @c EINA_TRUE, if it's shown, @c EINA_FALSE otherwise
20146 * @see elm_index_active_set() for more details
20150 EAPI Eina_Bool elm_index_active_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20153 * Set the items level for a given index widget.
20155 * @param obj The index object.
20156 * @param level @c 0 or @c 1, the currently implemented levels.
20158 * @see elm_index_item_level_get()
20162 EAPI void elm_index_item_level_set(Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
20165 * Get the items level set for a given index widget.
20167 * @param obj The index object.
20168 * @return @c 0 or @c 1, which are the levels @p obj might be at.
20170 * @see elm_index_item_level_set() for more information
20174 EAPI int elm_index_item_level_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20177 * Returns the last selected item's data, for a given index widget.
20179 * @param obj The index object.
20180 * @return The item @b data associated to the last selected item on
20181 * @p obj (or @c NULL, on errors).
20183 * @warning The returned value is @b not an #Elm_Index_Item item
20184 * handle, but the data associated to it (see the @c item parameter
20185 * in elm_index_item_append(), as an example).
20189 EAPI void *elm_index_item_selected_get(const Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
20192 * Append a new item on a given index widget.
20194 * @param obj The index object.
20195 * @param letter Letter under which the item should be indexed
20196 * @param item The item data to set for the index's item
20198 * Despite the most common usage of the @p letter argument is for
20199 * single char strings, one could use arbitrary strings as index
20202 * @c item will be the pointer returned back on @c "changed", @c
20203 * "delay,changed" and @c "selected" smart events.
20207 EAPI void elm_index_item_append(Evas_Object *obj, const char *letter, const void *item) EINA_ARG_NONNULL(1);
20210 * Prepend a new item on a given index widget.
20212 * @param obj The index object.
20213 * @param letter Letter under which the item should be indexed
20214 * @param item The item data to set for the index's item
20216 * Despite the most common usage of the @p letter argument is for
20217 * single char strings, one could use arbitrary strings as index
20220 * @c item will be the pointer returned back on @c "changed", @c
20221 * "delay,changed" and @c "selected" smart events.
20225 EAPI void elm_index_item_prepend(Evas_Object *obj, const char *letter, const void *item) EINA_ARG_NONNULL(1);
20228 * Append a new item, on a given index widget, <b>after the item
20229 * having @p relative as data</b>.
20231 * @param obj The index object.
20232 * @param letter Letter under which the item should be indexed
20233 * @param item The item data to set for the index's item
20234 * @param relative The item data of the index item to be the
20235 * predecessor of this new one
20237 * Despite the most common usage of the @p letter argument is for
20238 * single char strings, one could use arbitrary strings as index
20241 * @c item will be the pointer returned back on @c "changed", @c
20242 * "delay,changed" and @c "selected" smart events.
20244 * @note If @p relative is @c NULL or if it's not found to be data
20245 * set on any previous item on @p obj, this function will behave as
20246 * elm_index_item_append().
20250 EAPI void elm_index_item_append_relative(Evas_Object *obj, const char *letter, const void *item, const void *relative) EINA_ARG_NONNULL(1);
20253 * Prepend a new item, on a given index widget, <b>after the item
20254 * having @p relative as data</b>.
20256 * @param obj The index object.
20257 * @param letter Letter under which the item should be indexed
20258 * @param item The item data to set for the index's item
20259 * @param relative The item data of the index item to be the
20260 * successor of this new one
20262 * Despite the most common usage of the @p letter argument is for
20263 * single char strings, one could use arbitrary strings as index
20266 * @c item will be the pointer returned back on @c "changed", @c
20267 * "delay,changed" and @c "selected" smart events.
20269 * @note If @p relative is @c NULL or if it's not found to be data
20270 * set on any previous item on @p obj, this function will behave as
20271 * elm_index_item_prepend().
20275 EAPI void elm_index_item_prepend_relative(Evas_Object *obj, const char *letter, const void *item, const void *relative) EINA_ARG_NONNULL(1);
20278 * Insert a new item into the given index widget, using @p cmp_func
20279 * function to sort items (by item handles).
20281 * @param obj The index object.
20282 * @param letter Letter under which the item should be indexed
20283 * @param item The item data to set for the index's item
20284 * @param cmp_func The comparing function to be used to sort index
20285 * items <b>by #Elm_Index_Item item handles</b>
20286 * @param cmp_data_func A @b fallback function to be called for the
20287 * sorting of index items <b>by item data</b>). It will be used
20288 * when @p cmp_func returns @c 0 (equality), which means an index
20289 * item with provided item data already exists. To decide which
20290 * data item should be pointed to by the index item in question, @p
20291 * cmp_data_func will be used. If @p cmp_data_func returns a
20292 * non-negative value, the previous index item data will be
20293 * replaced by the given @p item pointer. If the previous data need
20294 * to be freed, it should be done by the @p cmp_data_func function,
20295 * because all references to it will be lost. If this function is
20296 * not provided (@c NULL is given), index items will be @b
20297 * duplicated, if @p cmp_func returns @c 0.
20299 * Despite the most common usage of the @p letter argument is for
20300 * single char strings, one could use arbitrary strings as index
20303 * @c item will be the pointer returned back on @c "changed", @c
20304 * "delay,changed" and @c "selected" smart events.
20308 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);
20311 * Remove an item from a given index widget, <b>to be referenced by
20312 * it's data value</b>.
20314 * @param obj The index object
20315 * @param item The item's data pointer for the item to be removed
20318 * If a deletion callback is set, via elm_index_item_del_cb_set(),
20319 * that callback function will be called by this one.
20321 * @warning The item to be removed from @p obj will be found via
20322 * its item data pointer, and not by an #Elm_Index_Item handle.
20326 EAPI void elm_index_item_del(Evas_Object *obj, const void *item) EINA_ARG_NONNULL(1);
20329 * Find a given index widget's item, <b>using item data</b>.
20331 * @param obj The index object
20332 * @param item The item data pointed to by the desired index item
20333 * @return The index item handle, if found, or @c NULL otherwise
20337 EAPI Elm_Index_Item *elm_index_item_find(Evas_Object *obj, const void *item) EINA_ARG_NONNULL(1);
20340 * Removes @b all items from a given index widget.
20342 * @param obj The index object.
20344 * If deletion callbacks are set, via elm_index_item_del_cb_set(),
20345 * that callback function will be called for each item in @p obj.
20349 EAPI void elm_index_item_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
20352 * Go to a given items level on a index widget
20354 * @param obj The index object
20355 * @param level The index level (one of @c 0 or @c 1)
20359 EAPI void elm_index_item_go(Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
20362 * Return the data associated with a given index widget item
20364 * @param it The index widget item handle
20365 * @return The data associated with @p it
20367 * @see elm_index_item_data_set()
20371 EAPI void *elm_index_item_data_get(const Elm_Index_Item *item) EINA_ARG_NONNULL(1);
20374 * Set the data associated with a given index widget item
20376 * @param it The index widget item handle
20377 * @param data The new data pointer to set to @p it
20379 * This sets new item data on @p it.
20381 * @warning The old data pointer won't be touched by this function, so
20382 * the user had better to free that old data himself/herself.
20386 EAPI void elm_index_item_data_set(Elm_Index_Item *it, const void *data) EINA_ARG_NONNULL(1);
20389 * Set the function to be called when a given index widget item is freed.
20391 * @param it The item to set the callback on
20392 * @param func The function to call on the item's deletion
20394 * When called, @p func will have both @c data and @c event_info
20395 * arguments with the @p it item's data value and, naturally, the
20396 * @c obj argument with a handle to the parent index widget.
20400 EAPI void elm_index_item_del_cb_set(Elm_Index_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
20403 * Get the letter (string) set on a given index widget item.
20405 * @param it The index item handle
20406 * @return The letter string set on @p it
20410 EAPI const char *elm_index_item_letter_get(const Elm_Index_Item *item) EINA_ARG_NONNULL(1);
20417 * @defgroup Photocam Photocam
20419 * @image html img/widget/photocam/preview-00.png
20420 * @image latex img/widget/photocam/preview-00.eps
20422 * This is a widget specifically for displaying high-resolution digital
20423 * camera photos giving speedy feedback (fast load), low memory footprint
20424 * and zooming and panning as well as fitting logic. It is entirely focused
20425 * on jpeg images, and takes advantage of properties of the jpeg format (via
20426 * evas loader features in the jpeg loader).
20428 * Signals that you can add callbacks for are:
20429 * @li "clicked" - This is called when a user has clicked the photo without
20431 * @li "press" - This is called when a user has pressed down on the photo.
20432 * @li "longpressed" - This is called when a user has pressed down on the
20433 * photo for a long time without dragging around.
20434 * @li "clicked,double" - This is called when a user has double-clicked the
20436 * @li "load" - Photo load begins.
20437 * @li "loaded" - This is called when the image file load is complete for the
20438 * first view (low resolution blurry version).
20439 * @li "load,detail" - Photo detailed data load begins.
20440 * @li "loaded,detail" - This is called when the image file load is complete
20441 * for the detailed image data (full resolution needed).
20442 * @li "zoom,start" - Zoom animation started.
20443 * @li "zoom,stop" - Zoom animation stopped.
20444 * @li "zoom,change" - Zoom changed when using an auto zoom mode.
20445 * @li "scroll" - the content has been scrolled (moved)
20446 * @li "scroll,anim,start" - scrolling animation has started
20447 * @li "scroll,anim,stop" - scrolling animation has stopped
20448 * @li "scroll,drag,start" - dragging the contents around has started
20449 * @li "scroll,drag,stop" - dragging the contents around has stopped
20451 * @ref tutorial_photocam shows the API in action.
20455 * @brief Types of zoom available.
20457 typedef enum _Elm_Photocam_Zoom_Mode
20459 ELM_PHOTOCAM_ZOOM_MODE_MANUAL = 0, /**< Zoom controled normally by elm_photocam_zoom_set */
20460 ELM_PHOTOCAM_ZOOM_MODE_AUTO_FIT, /**< Zoom until photo fits in photocam */
20461 ELM_PHOTOCAM_ZOOM_MODE_AUTO_FILL, /**< Zoom until photo fills photocam */
20462 ELM_PHOTOCAM_ZOOM_MODE_LAST
20463 } Elm_Photocam_Zoom_Mode;
20465 * @brief Add a new Photocam object
20467 * @param parent The parent object
20468 * @return The new object or NULL if it cannot be created
20470 EAPI Evas_Object *elm_photocam_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20472 * @brief Set the photo file to be shown
20474 * @param obj The photocam object
20475 * @param file The photo file
20476 * @return The return error (see EVAS_LOAD_ERROR_NONE, EVAS_LOAD_ERROR_GENERIC etc.)
20478 * This sets (and shows) the specified file (with a relative or absolute
20479 * path) and will return a load error (same error that
20480 * evas_object_image_load_error_get() will return). The image will change and
20481 * adjust its size at this point and begin a background load process for this
20482 * photo that at some time in the future will be displayed at the full
20485 EAPI Evas_Load_Error elm_photocam_file_set(Evas_Object *obj, const char *file) EINA_ARG_NONNULL(1);
20487 * @brief Returns the path of the current image file
20489 * @param obj The photocam object
20490 * @return Returns the path
20492 * @see elm_photocam_file_set()
20494 EAPI const char *elm_photocam_file_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20496 * @brief Set the zoom level of the photo
20498 * @param obj The photocam object
20499 * @param zoom The zoom level to set
20501 * This sets the zoom level. 1 will be 1:1 pixel for pixel. 2 will be 2:1
20502 * (that is 2x2 photo pixels will display as 1 on-screen pixel). 4:1 will be
20503 * 4x4 photo pixels as 1 screen pixel, and so on. The @p zoom parameter must
20504 * be greater than 0. It is usggested to stick to powers of 2. (1, 2, 4, 8,
20507 EAPI void elm_photocam_zoom_set(Evas_Object *obj, double zoom) EINA_ARG_NONNULL(1);
20509 * @brief Get the zoom level of the photo
20511 * @param obj The photocam object
20512 * @return The current zoom level
20514 * This returns the current zoom level of the photocam object. Note that if
20515 * you set the fill mode to other than ELM_PHOTOCAM_ZOOM_MODE_MANUAL
20516 * (which is the default), the zoom level may be changed at any time by the
20517 * photocam object itself to account for photo size and photocam viewpoer
20520 * @see elm_photocam_zoom_set()
20521 * @see elm_photocam_zoom_mode_set()
20523 EAPI double elm_photocam_zoom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20525 * @brief Set the zoom mode
20527 * @param obj The photocam object
20528 * @param mode The desired mode
20530 * This sets the zoom mode to manual or one of several automatic levels.
20531 * Manual (ELM_PHOTOCAM_ZOOM_MODE_MANUAL) means that zoom is set manually by
20532 * elm_photocam_zoom_set() and will stay at that level until changed by code
20533 * or until zoom mode is changed. This is the default mode. The Automatic
20534 * modes will allow the photocam object to automatically adjust zoom mode
20535 * based on properties. ELM_PHOTOCAM_ZOOM_MODE_AUTO_FIT) will adjust zoom so
20536 * the photo fits EXACTLY inside the scroll frame with no pixels outside this
20537 * area. ELM_PHOTOCAM_ZOOM_MODE_AUTO_FILL will be similar but ensure no
20538 * pixels within the frame are left unfilled.
20540 EAPI void elm_photocam_zoom_mode_set(Evas_Object *obj, Elm_Photocam_Zoom_Mode mode) EINA_ARG_NONNULL(1);
20542 * @brief Get the zoom mode
20544 * @param obj The photocam object
20545 * @return The current zoom mode
20547 * This gets the current zoom mode of the photocam object.
20549 * @see elm_photocam_zoom_mode_set()
20551 EAPI Elm_Photocam_Zoom_Mode elm_photocam_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20553 * @brief Get the current image pixel width and height
20555 * @param obj The photocam object
20556 * @param w A pointer to the width return
20557 * @param h A pointer to the height return
20559 * This gets the current photo pixel width and height (for the original).
20560 * The size will be returned in the integers @p w and @p h that are pointed
20563 EAPI void elm_photocam_image_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
20565 * @brief Get the area of the image that is currently shown
20568 * @param x A pointer to the X-coordinate of region
20569 * @param y A pointer to the Y-coordinate of region
20570 * @param w A pointer to the width
20571 * @param h A pointer to the height
20573 * @see elm_photocam_image_region_show()
20574 * @see elm_photocam_image_region_bring_in()
20576 EAPI void elm_photocam_region_get(const Evas_Object *obj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
20578 * @brief Set the viewed portion of the image
20580 * @param obj The photocam object
20581 * @param x X-coordinate of region in image original pixels
20582 * @param y Y-coordinate of region in image original pixels
20583 * @param w Width of region in image original pixels
20584 * @param h Height of region in image original pixels
20586 * This shows the region of the image without using animation.
20588 EAPI void elm_photocam_image_region_show(Evas_Object *obj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
20590 * @brief Bring in 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 using animation.
20600 EAPI void elm_photocam_image_region_bring_in(Evas_Object *obj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
20602 * @brief Set the paused state for photocam
20604 * @param obj The photocam object
20605 * @param paused The pause state to set
20607 * This sets the paused state to on(EINA_TRUE) or off (EINA_FALSE) for
20608 * photocam. The default is off. This will stop zooming using animation on
20609 * zoom levels changes and change instantly. This will stop any existing
20610 * animations that are running.
20612 EAPI void elm_photocam_paused_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
20614 * @brief Get the paused state for photocam
20616 * @param obj The photocam object
20617 * @return The current paused state
20619 * This gets the current paused state for the photocam object.
20621 * @see elm_photocam_paused_set()
20623 EAPI Eina_Bool elm_photocam_paused_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20625 * @brief Get the internal low-res image used for photocam
20627 * @param obj The photocam object
20628 * @return The internal image object handle, or NULL if none exists
20630 * This gets the internal image object inside photocam. Do not modify it. It
20631 * is for inspection only, and hooking callbacks to. Nothing else. It may be
20632 * deleted at any time as well.
20634 EAPI Evas_Object *elm_photocam_internal_image_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20636 * @brief Set the photocam scrolling bouncing.
20638 * @param obj The photocam object
20639 * @param h_bounce bouncing for horizontal
20640 * @param v_bounce bouncing for vertical
20642 EAPI void elm_photocam_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
20644 * @brief Get the photocam scrolling bouncing.
20646 * @param obj The photocam object
20647 * @param h_bounce bouncing for horizontal
20648 * @param v_bounce bouncing for vertical
20650 * @see elm_photocam_bounce_set()
20652 EAPI void elm_photocam_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
20658 * @defgroup Map Map
20659 * @ingroup Elementary
20661 * @image html img/widget/map/preview-00.png
20662 * @image latex img/widget/map/preview-00.eps
20664 * This is a widget specifically for displaying a map. It uses basically
20665 * OpenStreetMap provider http://www.openstreetmap.org/,
20666 * but custom providers can be added.
20668 * It supports some basic but yet nice features:
20669 * @li zoom and scroll
20670 * @li markers with content to be displayed when user clicks over it
20671 * @li group of markers
20674 * Smart callbacks one can listen to:
20676 * - "clicked" - This is called when a user has clicked the map without
20678 * - "press" - This is called when a user has pressed down on the map.
20679 * - "longpressed" - This is called when a user has pressed down on the map
20680 * for a long time without dragging around.
20681 * - "clicked,double" - This is called when a user has double-clicked
20683 * - "load,detail" - Map detailed data load begins.
20684 * - "loaded,detail" - This is called when all currently visible parts of
20685 * the map are loaded.
20686 * - "zoom,start" - Zoom animation started.
20687 * - "zoom,stop" - Zoom animation stopped.
20688 * - "zoom,change" - Zoom changed when using an auto zoom mode.
20689 * - "scroll" - the content has been scrolled (moved).
20690 * - "scroll,anim,start" - scrolling animation has started.
20691 * - "scroll,anim,stop" - scrolling animation has stopped.
20692 * - "scroll,drag,start" - dragging the contents around has started.
20693 * - "scroll,drag,stop" - dragging the contents around has stopped.
20694 * - "downloaded" - This is called when all currently required map images
20696 * - "route,load" - This is called when route request begins.
20697 * - "route,loaded" - This is called when route request ends.
20698 * - "name,load" - This is called when name request begins.
20699 * - "name,loaded- This is called when name request ends.
20701 * Available style for map widget:
20704 * Available style for markers:
20709 * Available style for marker bubble:
20712 * List of examples:
20713 * @li @ref map_example_01
20714 * @li @ref map_example_02
20715 * @li @ref map_example_03
20724 * @enum _Elm_Map_Zoom_Mode
20725 * @typedef Elm_Map_Zoom_Mode
20727 * Set map's zoom behavior. It can be set to manual or automatic.
20729 * Default value is #ELM_MAP_ZOOM_MODE_MANUAL.
20731 * Values <b> don't </b> work as bitmask, only one can be choosen.
20733 * @note Valid sizes are 2^zoom, consequently the map may be smaller
20734 * than the scroller view.
20736 * @see elm_map_zoom_mode_set()
20737 * @see elm_map_zoom_mode_get()
20741 typedef enum _Elm_Map_Zoom_Mode
20743 ELM_MAP_ZOOM_MODE_MANUAL, /**< Zoom controled manually by elm_map_zoom_set(). It's set by default. */
20744 ELM_MAP_ZOOM_MODE_AUTO_FIT, /**< Zoom until map fits inside the scroll frame with no pixels outside this area. */
20745 ELM_MAP_ZOOM_MODE_AUTO_FILL, /**< Zoom until map fills scroll, ensuring no pixels are left unfilled. */
20746 ELM_MAP_ZOOM_MODE_LAST
20747 } Elm_Map_Zoom_Mode;
20750 * @enum _Elm_Map_Route_Sources
20751 * @typedef Elm_Map_Route_Sources
20753 * Set route service to be used. By default used source is
20754 * #ELM_MAP_ROUTE_SOURCE_YOURS.
20756 * @see elm_map_route_source_set()
20757 * @see elm_map_route_source_get()
20761 typedef enum _Elm_Map_Route_Sources
20763 ELM_MAP_ROUTE_SOURCE_YOURS, /**< Routing service http://www.yournavigation.org/ . Set by default.*/
20764 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. */
20765 ELM_MAP_ROUTE_SOURCE_ORS, /**< Open Route Service: http://www.openrouteservice.org/ . It's not working with Map yet. */
20766 ELM_MAP_ROUTE_SOURCE_LAST
20767 } Elm_Map_Route_Sources;
20769 typedef enum _Elm_Map_Name_Sources
20771 ELM_MAP_NAME_SOURCE_NOMINATIM,
20772 ELM_MAP_NAME_SOURCE_LAST
20773 } Elm_Map_Name_Sources;
20776 * @enum _Elm_Map_Route_Type
20777 * @typedef Elm_Map_Route_Type
20779 * Set type of transport used on route.
20781 * @see elm_map_route_add()
20785 typedef enum _Elm_Map_Route_Type
20787 ELM_MAP_ROUTE_TYPE_MOTOCAR, /**< Route should consider an automobile will be used. */
20788 ELM_MAP_ROUTE_TYPE_BICYCLE, /**< Route should consider a bicycle will be used by the user. */
20789 ELM_MAP_ROUTE_TYPE_FOOT, /**< Route should consider user will be walking. */
20790 ELM_MAP_ROUTE_TYPE_LAST
20791 } Elm_Map_Route_Type;
20794 * @enum _Elm_Map_Route_Method
20795 * @typedef Elm_Map_Route_Method
20797 * Set the routing method, what should be priorized, time or distance.
20799 * @see elm_map_route_add()
20803 typedef enum _Elm_Map_Route_Method
20805 ELM_MAP_ROUTE_METHOD_FASTEST, /**< Route should priorize time. */
20806 ELM_MAP_ROUTE_METHOD_SHORTEST, /**< Route should priorize distance. */
20807 ELM_MAP_ROUTE_METHOD_LAST
20808 } Elm_Map_Route_Method;
20810 typedef enum _Elm_Map_Name_Method
20812 ELM_MAP_NAME_METHOD_SEARCH,
20813 ELM_MAP_NAME_METHOD_REVERSE,
20814 ELM_MAP_NAME_METHOD_LAST
20815 } Elm_Map_Name_Method;
20817 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(). */
20818 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(). */
20819 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(). */
20820 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(). */
20821 typedef struct _Elm_Map_Name Elm_Map_Name; /**< A handle for specific coordinates. */
20822 typedef struct _Elm_Map_Track Elm_Map_Track;
20824 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. */
20825 typedef void (*ElmMapMarkerDelFunc) (Evas_Object *obj, Elm_Map_Marker *marker, void *data, Evas_Object *o); /**< Function to delete bubble content for marker classes. */
20826 typedef Evas_Object *(*ElmMapMarkerIconGetFunc) (Evas_Object *obj, Elm_Map_Marker *marker, void *data); /**< Icon fetching class function for marker classes. */
20827 typedef Evas_Object *(*ElmMapGroupIconGetFunc) (Evas_Object *obj, void *data); /**< Icon fetching class function for markers group classes. */
20829 typedef char *(*ElmMapModuleSourceFunc) (void);
20830 typedef int (*ElmMapModuleZoomMinFunc) (void);
20831 typedef int (*ElmMapModuleZoomMaxFunc) (void);
20832 typedef char *(*ElmMapModuleUrlFunc) (Evas_Object *obj, int x, int y, int zoom);
20833 typedef int (*ElmMapModuleRouteSourceFunc) (void);
20834 typedef char *(*ElmMapModuleRouteUrlFunc) (Evas_Object *obj, char *type_name, int method, double flon, double flat, double tlon, double tlat);
20835 typedef char *(*ElmMapModuleNameUrlFunc) (Evas_Object *obj, int method, char *name, double lon, double lat);
20836 typedef Eina_Bool (*ElmMapModuleGeoIntoCoordFunc) (const Evas_Object *obj, int zoom, double lon, double lat, int size, int *x, int *y);
20837 typedef Eina_Bool (*ElmMapModuleCoordIntoGeoFunc) (const Evas_Object *obj, int zoom, int x, int y, int size, double *lon, double *lat);
20840 * Add a new map widget to the given parent Elementary (container) object.
20842 * @param parent The parent object.
20843 * @return a new map widget handle or @c NULL, on errors.
20845 * This function inserts a new map widget on the canvas.
20849 EAPI Evas_Object *elm_map_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20852 * Set the zoom level of the map.
20854 * @param obj The map object.
20855 * @param zoom The zoom level to set.
20857 * This sets the zoom level.
20859 * It will respect limits defined by elm_map_source_zoom_min_set() and
20860 * elm_map_source_zoom_max_set().
20862 * By default these values are 0 (world map) and 18 (maximum zoom).
20864 * This function should be used when zoom mode is set to
20865 * #ELM_MAP_ZOOM_MODE_MANUAL. This is the default mode, and can be set
20866 * with elm_map_zoom_mode_set().
20868 * @see elm_map_zoom_mode_set().
20869 * @see elm_map_zoom_get().
20873 EAPI void elm_map_zoom_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
20876 * Get the zoom level of the map.
20878 * @param obj The map object.
20879 * @return The current zoom level.
20881 * This returns the current zoom level of the map object.
20883 * Note that if you set the fill mode to other than #ELM_MAP_ZOOM_MODE_MANUAL
20884 * (which is the default), the zoom level may be changed at any time by the
20885 * map object itself to account for map size and map viewport size.
20887 * @see elm_map_zoom_set() for details.
20891 EAPI int elm_map_zoom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20894 * Set the zoom mode used by the map object.
20896 * @param obj The map object.
20897 * @param mode The zoom mode of the map, being it one of
20898 * #ELM_MAP_ZOOM_MODE_MANUAL (default), #ELM_MAP_ZOOM_MODE_AUTO_FIT,
20899 * or #ELM_MAP_ZOOM_MODE_AUTO_FILL.
20901 * This sets the zoom mode to manual or one of the automatic levels.
20902 * Manual (#ELM_MAP_ZOOM_MODE_MANUAL) means that zoom is set manually by
20903 * elm_map_zoom_set() and will stay at that level until changed by code
20904 * or until zoom mode is changed. This is the default mode.
20906 * The Automatic modes will allow the map object to automatically
20907 * adjust zoom mode based on properties. #ELM_MAP_ZOOM_MODE_AUTO_FIT will
20908 * adjust zoom so the map fits inside the scroll frame with no pixels
20909 * outside this area. #ELM_MAP_ZOOM_MODE_AUTO_FILL will be similar but
20910 * ensure no pixels within the frame are left unfilled. Do not forget that
20911 * the valid sizes are 2^zoom, consequently the map may be smaller than
20912 * the scroller view.
20914 * @see elm_map_zoom_set()
20918 EAPI void elm_map_zoom_mode_set(Evas_Object *obj, Elm_Map_Zoom_Mode mode) EINA_ARG_NONNULL(1);
20921 * Get the zoom mode used by the map object.
20923 * @param obj The map object.
20924 * @return The zoom mode of the map, being it one of
20925 * #ELM_MAP_ZOOM_MODE_MANUAL (default), #ELM_MAP_ZOOM_MODE_AUTO_FIT,
20926 * or #ELM_MAP_ZOOM_MODE_AUTO_FILL.
20928 * This function returns the current zoom mode used by the map object.
20930 * @see elm_map_zoom_mode_set() for more details.
20934 EAPI Elm_Map_Zoom_Mode elm_map_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20937 * Get the current coordinates of the map.
20939 * @param obj The map object.
20940 * @param lon Pointer where to store longitude.
20941 * @param lat Pointer where to store latitude.
20943 * This gets the current center coordinates of the map object. It can be
20944 * set by elm_map_geo_region_bring_in() and elm_map_geo_region_show().
20946 * @see elm_map_geo_region_bring_in()
20947 * @see elm_map_geo_region_show()
20951 EAPI void elm_map_geo_region_get(const Evas_Object *obj, double *lon, double *lat) EINA_ARG_NONNULL(1);
20954 * Animatedly bring in given coordinates to the center of the map.
20956 * @param obj The map object.
20957 * @param lon Longitude to center at.
20958 * @param lat Latitude to center at.
20960 * This causes map to jump to the given @p lat and @p lon coordinates
20961 * and show it (by scrolling) in the center of the viewport, if it is not
20962 * already centered. This will use animation to do so and take a period
20963 * of time to complete.
20965 * @see elm_map_geo_region_show() for a function to avoid animation.
20966 * @see elm_map_geo_region_get()
20970 EAPI void elm_map_geo_region_bring_in(Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
20973 * Show the given coordinates at the center of the map, @b immediately.
20975 * @param obj The map object.
20976 * @param lon Longitude to center at.
20977 * @param lat Latitude to center at.
20979 * This causes map to @b redraw its viewport's contents to the
20980 * region contining the given @p lat and @p lon, that will be moved to the
20981 * center of the map.
20983 * @see elm_map_geo_region_bring_in() for a function to move with animation.
20984 * @see elm_map_geo_region_get()
20988 EAPI void elm_map_geo_region_show(Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
20991 * Pause or unpause the map.
20993 * @param obj The map object.
20994 * @param paused Use @c EINA_TRUE to pause the map @p obj or @c EINA_FALSE
20997 * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
21000 * The default is off.
21002 * This will stop zooming using animation, changing zoom levels will
21003 * change instantly. This will stop any existing animations that are running.
21005 * @see elm_map_paused_get()
21009 EAPI void elm_map_paused_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
21012 * Get a value whether map is paused or not.
21014 * @param obj The map object.
21015 * @return @c EINA_TRUE means map is pause. @c EINA_FALSE indicates
21016 * it is not. If @p obj is @c NULL, @c EINA_FALSE is returned.
21018 * This gets the current paused state for the map object.
21020 * @see elm_map_paused_set() for details.
21024 EAPI Eina_Bool elm_map_paused_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21027 * Set to show markers during zoom level changes or not.
21029 * @param obj The map object.
21030 * @param paused Use @c EINA_TRUE to @b not show markers or @c EINA_FALSE
21033 * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
21036 * The default is off.
21038 * This will stop zooming using animation, changing zoom levels will
21039 * change instantly. This will stop any existing animations that are running.
21041 * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
21044 * The default is off.
21046 * Enabling it will force the map to stop displaying the markers during
21047 * zoom level changes. Set to on if you have a large number of markers.
21049 * @see elm_map_paused_markers_get()
21053 EAPI void elm_map_paused_markers_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
21056 * Get a value whether markers will be displayed on zoom level changes or not
21058 * @param obj The map object.
21059 * @return @c EINA_TRUE means map @b won't display markers or @c EINA_FALSE
21060 * indicates it will. If @p obj is @c NULL, @c EINA_FALSE is returned.
21062 * This gets the current markers paused state for the map object.
21064 * @see elm_map_paused_markers_set() for details.
21068 EAPI Eina_Bool elm_map_paused_markers_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21071 * Get the information of downloading status.
21073 * @param obj The map object.
21074 * @param try_num Pointer where to store number of tiles being downloaded.
21075 * @param finish_num Pointer where to store number of tiles successfully
21078 * This gets the current downloading status for the map object, the number
21079 * of tiles being downloaded and the number of tiles already downloaded.
21083 EAPI void elm_map_utils_downloading_status_get(const Evas_Object *obj, int *try_num, int *finish_num) EINA_ARG_NONNULL(1, 2, 3);
21086 * Convert a pixel coordinate (x,y) into a geographic coordinate
21087 * (longitude, latitude).
21089 * @param obj The map object.
21090 * @param x the coordinate.
21091 * @param y the coordinate.
21092 * @param size the size in pixels of the map.
21093 * The map is a square and generally his size is : pow(2.0, zoom)*256.
21094 * @param lon Pointer where to store the longitude that correspond to x.
21095 * @param lat Pointer where to store the latitude that correspond to y.
21097 * @note Origin pixel point is the top left corner of the viewport.
21098 * Map zoom and size are taken on account.
21100 * @see elm_map_utils_convert_geo_into_coord() if you need the inverse.
21104 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);
21107 * Convert a geographic coordinate (longitude, latitude) into a pixel
21108 * coordinate (x, y).
21110 * @param obj The map object.
21111 * @param lon the longitude.
21112 * @param lat the latitude.
21113 * @param size the size in pixels of the map. The map is a square
21114 * and generally his size is : pow(2.0, zoom)*256.
21115 * @param x Pointer where to store the horizontal pixel coordinate that
21116 * correspond to the longitude.
21117 * @param y Pointer where to store the vertical pixel coordinate that
21118 * correspond to the latitude.
21120 * @note Origin pixel point is the top left corner of the viewport.
21121 * Map zoom and size are taken on account.
21123 * @see elm_map_utils_convert_coord_into_geo() if you need the inverse.
21127 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);
21130 * Convert a geographic coordinate (longitude, latitude) into a name
21133 * @param obj The map object.
21134 * @param lon the longitude.
21135 * @param lat the latitude.
21136 * @return name A #Elm_Map_Name handle for this coordinate.
21138 * To get the string for this address, elm_map_name_address_get()
21141 * @see elm_map_utils_convert_name_into_coord() if you need the inverse.
21145 EAPI Elm_Map_Name *elm_map_utils_convert_coord_into_name(const Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
21148 * Convert a name (address) into a geographic coordinate
21149 * (longitude, latitude).
21151 * @param obj The map object.
21152 * @param name The address.
21153 * @return name A #Elm_Map_Name handle for this address.
21155 * To get the longitude and latitude, elm_map_name_region_get()
21158 * @see elm_map_utils_convert_coord_into_name() if you need the inverse.
21162 EAPI Elm_Map_Name *elm_map_utils_convert_name_into_coord(const Evas_Object *obj, char *address) EINA_ARG_NONNULL(1, 2);
21165 * Convert a pixel coordinate into a rotated pixel coordinate.
21167 * @param obj The map object.
21168 * @param x horizontal coordinate of the point to rotate.
21169 * @param y vertical coordinate of the point to rotate.
21170 * @param cx rotation's center horizontal position.
21171 * @param cy rotation's center vertical position.
21172 * @param degree amount of degrees from 0.0 to 360.0 to rotate arount Z axis.
21173 * @param xx Pointer where to store rotated x.
21174 * @param yy Pointer where to store rotated y.
21178 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);
21181 * Add a new marker to the map object.
21183 * @param obj The map object.
21184 * @param lon The longitude of the marker.
21185 * @param lat The latitude of the marker.
21186 * @param clas The class, to use when marker @b isn't grouped to others.
21187 * @param clas_group The class group, to use when marker is grouped to others
21188 * @param data The data passed to the callbacks.
21190 * @return The created marker or @c NULL upon failure.
21192 * A marker will be created and shown in a specific point of the map, defined
21193 * by @p lon and @p lat.
21195 * It will be displayed using style defined by @p class when this marker
21196 * is displayed alone (not grouped). A new class can be created with
21197 * elm_map_marker_class_new().
21199 * If the marker is grouped to other markers, it will be displayed with
21200 * style defined by @p class_group. Markers with the same group are grouped
21201 * if they are close. A new group class can be created with
21202 * elm_map_marker_group_class_new().
21204 * Markers created with this method can be deleted with
21205 * elm_map_marker_remove().
21207 * A marker can have associated content to be displayed by a bubble,
21208 * when a user click over it, as well as an icon. These objects will
21209 * be fetch using class' callback functions.
21211 * @see elm_map_marker_class_new()
21212 * @see elm_map_marker_group_class_new()
21213 * @see elm_map_marker_remove()
21217 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);
21220 * Set the maximum numbers of markers' content to be displayed in a group.
21222 * @param obj The map object.
21223 * @param max The maximum numbers of items displayed in a bubble.
21225 * A bubble will be displayed when the user clicks over the group,
21226 * and will place the content of markers that belong to this group
21229 * A group can have a long list of markers, consequently the creation
21230 * of the content of the bubble can be very slow.
21232 * In order to avoid this, a maximum number of items is displayed
21235 * By default this number is 30.
21237 * Marker with the same group class are grouped if they are close.
21239 * @see elm_map_marker_add()
21243 EAPI void elm_map_max_marker_per_group_set(Evas_Object *obj, int max) EINA_ARG_NONNULL(1);
21246 * Remove a marker from the map.
21248 * @param marker The marker to remove.
21250 * @see elm_map_marker_add()
21254 EAPI void elm_map_marker_remove(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
21257 * Get the current coordinates of the marker.
21259 * @param marker marker.
21260 * @param lat Pointer where to store the marker's latitude.
21261 * @param lon Pointer where to store the marker's longitude.
21263 * These values are set when adding markers, with function
21264 * elm_map_marker_add().
21266 * @see elm_map_marker_add()
21270 EAPI void elm_map_marker_region_get(const Elm_Map_Marker *marker, double *lon, double *lat) EINA_ARG_NONNULL(1);
21273 * Animatedly bring in given marker to the center of the map.
21275 * @param marker The marker to center at.
21277 * This causes map to jump to the given @p marker's coordinates
21278 * and show it (by scrolling) in the center of the viewport, if it is not
21279 * already centered. This will use animation to do so and take a period
21280 * of time to complete.
21282 * @see elm_map_marker_show() for a function to avoid animation.
21283 * @see elm_map_marker_region_get()
21287 EAPI void elm_map_marker_bring_in(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
21290 * Show the given marker at the center of the map, @b immediately.
21292 * @param marker The marker to center at.
21294 * This causes map to @b redraw its viewport's contents to the
21295 * region contining the given @p marker's coordinates, that will be
21296 * moved to the center of the map.
21298 * @see elm_map_marker_bring_in() for a function to move with animation.
21299 * @see elm_map_markers_list_show() if more than one marker need to be
21301 * @see elm_map_marker_region_get()
21305 EAPI void elm_map_marker_show(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
21308 * Move and zoom the map to display a list of markers.
21310 * @param markers A list of #Elm_Map_Marker handles.
21312 * The map will be centered on the center point of the markers in the list.
21313 * Then the map will be zoomed in order to fit the markers using the maximum
21314 * zoom which allows display of all the markers.
21316 * @warning All the markers should belong to the same map object.
21318 * @see elm_map_marker_show() to show a single marker.
21319 * @see elm_map_marker_bring_in()
21323 EAPI void elm_map_markers_list_show(Eina_List *markers) EINA_ARG_NONNULL(1);
21326 * Get the Evas object returned by the ElmMapMarkerGetFunc callback
21328 * @param marker The marker wich content should be returned.
21329 * @return Return the evas object if it exists, else @c NULL.
21331 * To set callback function #ElmMapMarkerGetFunc for the marker class,
21332 * elm_map_marker_class_get_cb_set() should be used.
21334 * This content is what will be inside the bubble that will be displayed
21335 * when an user clicks over the marker.
21337 * This returns the actual Evas object used to be placed inside
21338 * the bubble. This may be @c NULL, as it may
21339 * not have been created or may have been deleted, at any time, by
21340 * the map. <b>Do not modify this object</b> (move, resize,
21341 * show, hide, etc.), as the map is controlling it. This
21342 * function is for querying, emitting custom signals or hooking
21343 * lower level callbacks for events on that object. Do not delete
21344 * this object under any circumstances.
21348 EAPI Evas_Object *elm_map_marker_object_get(const Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
21351 * Update the marker
21353 * @param marker The marker to be updated.
21355 * If a content is set to this marker, it will call function to delete it,
21356 * #ElmMapMarkerDelFunc, and then will fetch the content again with
21357 * #ElmMapMarkerGetFunc.
21359 * These functions are set for the marker class with
21360 * elm_map_marker_class_get_cb_set() and elm_map_marker_class_del_cb_set().
21364 EAPI void elm_map_marker_update(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
21367 * Close all the bubbles opened by the user.
21369 * @param obj The map object.
21371 * A bubble is displayed with a content fetched with #ElmMapMarkerGetFunc
21372 * when the user clicks on a marker.
21374 * This functions is set for the marker class with
21375 * elm_map_marker_class_get_cb_set().
21379 EAPI void elm_map_bubbles_close(Evas_Object *obj) EINA_ARG_NONNULL(1);
21382 * Create a new group class.
21384 * @param obj The map object.
21385 * @return Returns the new group class.
21387 * Each marker must be associated to a group class. Markers in the same
21388 * group are grouped if they are close.
21390 * The group class defines the style of the marker when a marker is grouped
21391 * to others markers. When it is alone, another class will be used.
21393 * A group class will need to be provided when creating a marker with
21394 * elm_map_marker_add().
21396 * Some properties and functions can be set by class, as:
21397 * - style, with elm_map_group_class_style_set()
21398 * - data - to be associated to the group class. It can be set using
21399 * elm_map_group_class_data_set().
21400 * - min zoom to display markers, set with
21401 * elm_map_group_class_zoom_displayed_set().
21402 * - max zoom to group markers, set using
21403 * elm_map_group_class_zoom_grouped_set().
21404 * - visibility - set if markers will be visible or not, set with
21405 * elm_map_group_class_hide_set().
21406 * - #ElmMapGroupIconGetFunc - used to fetch icon for markers group classes.
21407 * It can be set using elm_map_group_class_icon_cb_set().
21409 * @see elm_map_marker_add()
21410 * @see elm_map_group_class_style_set()
21411 * @see elm_map_group_class_data_set()
21412 * @see elm_map_group_class_zoom_displayed_set()
21413 * @see elm_map_group_class_zoom_grouped_set()
21414 * @see elm_map_group_class_hide_set()
21415 * @see elm_map_group_class_icon_cb_set()
21419 EAPI Elm_Map_Group_Class *elm_map_group_class_new(Evas_Object *obj) EINA_ARG_NONNULL(1);
21422 * Set the marker's style of a group class.
21424 * @param clas The group class.
21425 * @param style The style to be used by markers.
21427 * Each marker must be associated to a group class, and will use the style
21428 * defined by such class when grouped to other markers.
21430 * The following styles are provided by default theme:
21431 * @li @c radio - blue circle
21432 * @li @c radio2 - green circle
21435 * @see elm_map_group_class_new() for more details.
21436 * @see elm_map_marker_add()
21440 EAPI void elm_map_group_class_style_set(Elm_Map_Group_Class *clas, const char *style) EINA_ARG_NONNULL(1);
21443 * Set the icon callback function of a group class.
21445 * @param clas The group class.
21446 * @param icon_get The callback function that will return the icon.
21448 * Each marker must be associated to a group class, and it can display a
21449 * custom icon. The function @p icon_get must return this icon.
21451 * @see elm_map_group_class_new() for more details.
21452 * @see elm_map_marker_add()
21456 EAPI void elm_map_group_class_icon_cb_set(Elm_Map_Group_Class *clas, ElmMapGroupIconGetFunc icon_get) EINA_ARG_NONNULL(1);
21459 * Set the data associated to the group class.
21461 * @param clas The group class.
21462 * @param data The new user data.
21464 * This data will be passed for callback functions, like icon get callback,
21465 * that can be set with elm_map_group_class_icon_cb_set().
21467 * If a data was previously set, the object will lose the pointer for it,
21468 * so if needs to be freed, you must do it yourself.
21470 * @see elm_map_group_class_new() for more details.
21471 * @see elm_map_group_class_icon_cb_set()
21472 * @see elm_map_marker_add()
21476 EAPI void elm_map_group_class_data_set(Elm_Map_Group_Class *clas, void *data) EINA_ARG_NONNULL(1);
21479 * Set the minimum zoom from where the markers are displayed.
21481 * @param clas The group class.
21482 * @param zoom The minimum zoom.
21484 * Markers only will be displayed when the map is displayed at @p zoom
21487 * @see elm_map_group_class_new() for more details.
21488 * @see elm_map_marker_add()
21492 EAPI void elm_map_group_class_zoom_displayed_set(Elm_Map_Group_Class *clas, int zoom) EINA_ARG_NONNULL(1);
21495 * Set the zoom from where the markers are no more grouped.
21497 * @param clas The group class.
21498 * @param zoom The maximum zoom.
21500 * Markers only will be grouped when the map is displayed at
21501 * less than @p zoom.
21503 * @see elm_map_group_class_new() for more details.
21504 * @see elm_map_marker_add()
21508 EAPI void elm_map_group_class_zoom_grouped_set(Elm_Map_Group_Class *clas, int zoom) EINA_ARG_NONNULL(1);
21511 * Set if the markers associated to the group class @clas are hidden or not.
21513 * @param clas The group class.
21514 * @param hide Use @c EINA_TRUE to hide markers or @c EINA_FALSE
21517 * If @p hide is @c EINA_TRUE the markers will be hidden, but default
21522 EAPI void elm_map_group_class_hide_set(Evas_Object *obj, Elm_Map_Group_Class *clas, Eina_Bool hide) EINA_ARG_NONNULL(1, 2);
21525 * Create a new marker class.
21527 * @param obj The map object.
21528 * @return Returns the new group class.
21530 * Each marker must be associated to a class.
21532 * The marker class defines the style of the marker when a marker is
21533 * displayed alone, i.e., not grouped to to others markers. When grouped
21534 * it will use group class style.
21536 * A marker class will need to be provided when creating a marker with
21537 * elm_map_marker_add().
21539 * Some properties and functions can be set by class, as:
21540 * - style, with elm_map_marker_class_style_set()
21541 * - #ElmMapMarkerIconGetFunc - used to fetch icon for markers classes.
21542 * It can be set using elm_map_marker_class_icon_cb_set().
21543 * - #ElmMapMarkerGetFunc - used to fetch bubble content for marker classes.
21544 * Set using elm_map_marker_class_get_cb_set().
21545 * - #ElmMapMarkerDelFunc - used to delete bubble content for marker classes.
21546 * Set using elm_map_marker_class_del_cb_set().
21548 * @see elm_map_marker_add()
21549 * @see elm_map_marker_class_style_set()
21550 * @see elm_map_marker_class_icon_cb_set()
21551 * @see elm_map_marker_class_get_cb_set()
21552 * @see elm_map_marker_class_del_cb_set()
21556 EAPI Elm_Map_Marker_Class *elm_map_marker_class_new(Evas_Object *obj) EINA_ARG_NONNULL(1);
21559 * Set the marker's style of a marker class.
21561 * @param clas The marker class.
21562 * @param style The style to be used by markers.
21564 * Each marker must be associated to a marker class, and will use the style
21565 * defined by such class when alone, i.e., @b not grouped to other markers.
21567 * The following styles are provided by default theme:
21572 * @see elm_map_marker_class_new() for more details.
21573 * @see elm_map_marker_add()
21577 EAPI void elm_map_marker_class_style_set(Elm_Map_Marker_Class *clas, const char *style) EINA_ARG_NONNULL(1);
21580 * Set the icon callback function of a marker class.
21582 * @param clas The marker class.
21583 * @param icon_get The callback function that will return the icon.
21585 * Each marker must be associated to a marker class, and it can display a
21586 * custom icon. The function @p icon_get must return this icon.
21588 * @see elm_map_marker_class_new() for more details.
21589 * @see elm_map_marker_add()
21593 EAPI void elm_map_marker_class_icon_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerIconGetFunc icon_get) EINA_ARG_NONNULL(1);
21596 * Set the bubble content callback function of a marker class.
21598 * @param clas The marker class.
21599 * @param get The callback function that will return the content.
21601 * Each marker must be associated to a marker class, and it can display a
21602 * a content on a bubble that opens when the user click over the marker.
21603 * The function @p get must return this content object.
21605 * If this content will need to be deleted, elm_map_marker_class_del_cb_set()
21608 * @see elm_map_marker_class_new() for more details.
21609 * @see elm_map_marker_class_del_cb_set()
21610 * @see elm_map_marker_add()
21614 EAPI void elm_map_marker_class_get_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerGetFunc get) EINA_ARG_NONNULL(1);
21617 * Set the callback function used to delete bubble content of a marker class.
21619 * @param clas The marker class.
21620 * @param del The callback function that will delete the content.
21622 * Each marker must be associated to a marker class, and it can display a
21623 * a content on a bubble that opens when the user click over the marker.
21624 * The function to return such content can be set with
21625 * elm_map_marker_class_get_cb_set().
21627 * If this content must be freed, a callback function need to be
21628 * set for that task with this function.
21630 * If this callback is defined it will have to delete (or not) the
21631 * object inside, but if the callback is not defined the object will be
21632 * destroyed with evas_object_del().
21634 * @see elm_map_marker_class_new() for more details.
21635 * @see elm_map_marker_class_get_cb_set()
21636 * @see elm_map_marker_add()
21640 EAPI void elm_map_marker_class_del_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerDelFunc del) EINA_ARG_NONNULL(1);
21643 * Get the list of available sources.
21645 * @param obj The map object.
21646 * @return The source names list.
21648 * It will provide a list with all available sources, that can be set as
21649 * current source with elm_map_source_name_set(), or get with
21650 * elm_map_source_name_get().
21652 * Available sources:
21658 * @see elm_map_source_name_set() for more details.
21659 * @see elm_map_source_name_get()
21663 EAPI const char **elm_map_source_names_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21666 * Set the source of the map.
21668 * @param obj The map object.
21669 * @param source The source to be used.
21671 * Map widget retrieves images that composes the map from a web service.
21672 * This web service can be set with this method.
21674 * A different service can return a different maps with different
21675 * information and it can use different zoom values.
21677 * The @p source_name need to match one of the names provided by
21678 * elm_map_source_names_get().
21680 * The current source can be get using elm_map_source_name_get().
21682 * @see elm_map_source_names_get()
21683 * @see elm_map_source_name_get()
21688 EAPI void elm_map_source_name_set(Evas_Object *obj, const char *source_name) EINA_ARG_NONNULL(1);
21691 * Get the name of currently used source.
21693 * @param obj The map object.
21694 * @return Returns the name of the source in use.
21696 * @see elm_map_source_name_set() for more details.
21700 EAPI const char *elm_map_source_name_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21703 * Set the source of the route service to be used by the map.
21705 * @param obj The map object.
21706 * @param source The route service to be used, being it one of
21707 * #ELM_MAP_ROUTE_SOURCE_YOURS (default), #ELM_MAP_ROUTE_SOURCE_MONAV,
21708 * and #ELM_MAP_ROUTE_SOURCE_ORS.
21710 * Each one has its own algorithm, so the route retrieved may
21711 * differ depending on the source route. Now, only the default is working.
21713 * #ELM_MAP_ROUTE_SOURCE_YOURS is the routing service provided at
21714 * http://www.yournavigation.org/.
21716 * #ELM_MAP_ROUTE_SOURCE_MONAV, offers exact routing without heuristic
21717 * assumptions. Its routing core is based on Contraction Hierarchies.
21719 * #ELM_MAP_ROUTE_SOURCE_ORS, is provided at http://www.openrouteservice.org/
21721 * @see elm_map_route_source_get().
21725 EAPI void elm_map_route_source_set(Evas_Object *obj, Elm_Map_Route_Sources source) EINA_ARG_NONNULL(1);
21728 * Get the current route source.
21730 * @param obj The map object.
21731 * @return The source of the route service used by the map.
21733 * @see elm_map_route_source_set() for details.
21737 EAPI Elm_Map_Route_Sources elm_map_route_source_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21740 * Set the minimum zoom of the source.
21742 * @param obj The map object.
21743 * @param zoom New minimum zoom value to be used.
21745 * By default, it's 0.
21749 EAPI void elm_map_source_zoom_min_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
21752 * Get the minimum zoom of the source.
21754 * @param obj The map object.
21755 * @return Returns the minimum zoom of the source.
21757 * @see elm_map_source_zoom_min_set() for details.
21761 EAPI int elm_map_source_zoom_min_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21764 * Set the maximum zoom of the source.
21766 * @param obj The map object.
21767 * @param zoom New maximum zoom value to be used.
21769 * By default, it's 18.
21773 EAPI void elm_map_source_zoom_max_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
21776 * Get the maximum zoom of the source.
21778 * @param obj The map object.
21779 * @return Returns the maximum zoom of the source.
21781 * @see elm_map_source_zoom_min_set() for details.
21785 EAPI int elm_map_source_zoom_max_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21788 * Set the user agent used by the map object to access routing services.
21790 * @param obj The map object.
21791 * @param user_agent The user agent to be used by the map.
21793 * User agent is a client application implementing a network protocol used
21794 * in communications within a client–server distributed computing system
21796 * The @p user_agent identification string will transmitted in a header
21797 * field @c User-Agent.
21799 * @see elm_map_user_agent_get()
21803 EAPI void elm_map_user_agent_set(Evas_Object *obj, const char *user_agent) EINA_ARG_NONNULL(1, 2);
21806 * Get the user agent used by the map object.
21808 * @param obj The map object.
21809 * @return The user agent identification string used by the map.
21811 * @see elm_map_user_agent_set() for details.
21815 EAPI const char *elm_map_user_agent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21818 * Add a new route to the map object.
21820 * @param obj The map object.
21821 * @param type The type of transport to be considered when tracing a route.
21822 * @param method The routing method, what should be priorized.
21823 * @param flon The start longitude.
21824 * @param flat The start latitude.
21825 * @param tlon The destination longitude.
21826 * @param tlat The destination latitude.
21828 * @return The created route or @c NULL upon failure.
21830 * A route will be traced by point on coordinates (@p flat, @p flon)
21831 * to point on coordinates (@p tlat, @p tlon), using the route service
21832 * set with elm_map_route_source_set().
21834 * It will take @p type on consideration to define the route,
21835 * depending if the user will be walking or driving, the route may vary.
21836 * One of #ELM_MAP_ROUTE_TYPE_MOTOCAR, #ELM_MAP_ROUTE_TYPE_BICYCLE, or
21837 * #ELM_MAP_ROUTE_TYPE_FOOT need to be used.
21839 * Another parameter is what the route should priorize, the minor distance
21840 * or the less time to be spend on the route. So @p method should be one
21841 * of #ELM_MAP_ROUTE_METHOD_SHORTEST or #ELM_MAP_ROUTE_METHOD_FASTEST.
21843 * Routes created with this method can be deleted with
21844 * elm_map_route_remove(), colored with elm_map_route_color_set(),
21845 * and distance can be get with elm_map_route_distance_get().
21847 * @see elm_map_route_remove()
21848 * @see elm_map_route_color_set()
21849 * @see elm_map_route_distance_get()
21850 * @see elm_map_route_source_set()
21854 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);
21857 * Remove a route from the map.
21859 * @param route The route to remove.
21861 * @see elm_map_route_add()
21865 EAPI void elm_map_route_remove(Elm_Map_Route *route) EINA_ARG_NONNULL(1);
21868 * Set the route color.
21870 * @param route The route object.
21871 * @param r Red channel value, from 0 to 255.
21872 * @param g Green channel value, from 0 to 255.
21873 * @param b Blue channel value, from 0 to 255.
21874 * @param a Alpha channel value, from 0 to 255.
21876 * It uses an additive color model, so each color channel represents
21877 * how much of each primary colors must to be used. 0 represents
21878 * ausence of this color, so if all of the three are set to 0,
21879 * the color will be black.
21881 * These component values should be integers in the range 0 to 255,
21882 * (single 8-bit byte).
21884 * This sets the color used for the route. By default, it is set to
21885 * solid red (r = 255, g = 0, b = 0, a = 255).
21887 * For alpha channel, 0 represents completely transparent, and 255, opaque.
21889 * @see elm_map_route_color_get()
21893 EAPI void elm_map_route_color_set(Elm_Map_Route *route, int r, int g , int b, int a) EINA_ARG_NONNULL(1);
21896 * Get the route color.
21898 * @param route The route object.
21899 * @param r Pointer where to store the red channel value.
21900 * @param g Pointer where to store the green channel value.
21901 * @param b Pointer where to store the blue channel value.
21902 * @param a Pointer where to store the alpha channel value.
21904 * @see elm_map_route_color_set() for details.
21908 EAPI void elm_map_route_color_get(const Elm_Map_Route *route, int *r, int *g , int *b, int *a) EINA_ARG_NONNULL(1);
21911 * Get the route distance in kilometers.
21913 * @param route The route object.
21914 * @return The distance of route (unit : km).
21918 EAPI double elm_map_route_distance_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
21921 * Get the information of route nodes.
21923 * @param route The route object.
21924 * @return Returns a string with the nodes of route.
21928 EAPI const char *elm_map_route_node_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
21931 * Get the information of route waypoint.
21933 * @param route the route object.
21934 * @return Returns a string with information about waypoint of route.
21938 EAPI const char *elm_map_route_waypoint_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
21941 * Get the address of the name.
21943 * @param name The name handle.
21944 * @return Returns the address string of @p name.
21946 * This gets the coordinates of the @p name, created with one of the
21947 * conversion functions.
21949 * @see elm_map_utils_convert_name_into_coord()
21950 * @see elm_map_utils_convert_coord_into_name()
21954 EAPI const char *elm_map_name_address_get(const Elm_Map_Name *name) EINA_ARG_NONNULL(1);
21957 * Get the current coordinates of the name.
21959 * @param name The name handle.
21960 * @param lat Pointer where to store the latitude.
21961 * @param lon Pointer where to store The longitude.
21963 * This gets the coordinates of the @p name, created with one of the
21964 * conversion functions.
21966 * @see elm_map_utils_convert_name_into_coord()
21967 * @see elm_map_utils_convert_coord_into_name()
21971 EAPI void elm_map_name_region_get(const Elm_Map_Name *name, double *lon, double *lat) EINA_ARG_NONNULL(1);
21974 * Remove a name from the map.
21976 * @param name The name to remove.
21978 * Basically the struct handled by @p name will be freed, so convertions
21979 * between address and coordinates will be lost.
21981 * @see elm_map_utils_convert_name_into_coord()
21982 * @see elm_map_utils_convert_coord_into_name()
21986 EAPI void elm_map_name_remove(Elm_Map_Name *name) EINA_ARG_NONNULL(1);
21991 * @param obj The map object.
21992 * @param degree Angle from 0.0 to 360.0 to rotate arount Z axis.
21993 * @param cx Rotation's center horizontal position.
21994 * @param cy Rotation's center vertical position.
21996 * @see elm_map_rotate_get()
22000 EAPI void elm_map_rotate_set(Evas_Object *obj, double degree, Evas_Coord cx, Evas_Coord cy) EINA_ARG_NONNULL(1);
22003 * Get the rotate degree of the map
22005 * @param obj The map object
22006 * @param degree Pointer where to store degrees from 0.0 to 360.0
22007 * to rotate arount Z axis.
22008 * @param cx Pointer where to store rotation's center horizontal position.
22009 * @param cy Pointer where to store rotation's center vertical position.
22011 * @see elm_map_rotate_set() to set map rotation.
22015 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);
22018 * Enable or disable mouse wheel to be used to zoom in / out the map.
22020 * @param obj The map object.
22021 * @param disabled Use @c EINA_TRUE to disable mouse wheel or @c EINA_FALSE
22024 * Mouse wheel can be used for the user to zoom in or zoom out the map.
22026 * It's disabled by default.
22028 * @see elm_map_wheel_disabled_get()
22032 EAPI void elm_map_wheel_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
22035 * Get a value whether mouse wheel is enabled or not.
22037 * @param obj The map object.
22038 * @return @c EINA_TRUE means map is disabled. @c EINA_FALSE indicates
22039 * it is enabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
22041 * Mouse wheel can be used for the user to zoom in or zoom out the map.
22043 * @see elm_map_wheel_disabled_set() for details.
22047 EAPI Eina_Bool elm_map_wheel_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22051 * Add a track on the map
22053 * @param obj The map object.
22054 * @param emap The emap route object.
22055 * @return The route object. This is an elm object of type Route.
22057 * @see elm_route_add() for details.
22061 EAPI Evas_Object *elm_map_track_add(Evas_Object *obj, EMap_Route *emap) EINA_ARG_NONNULL(1);
22065 * Remove a track from the map
22067 * @param obj The map object.
22068 * @param route The track to remove.
22072 EAPI void elm_map_track_remove(Evas_Object *obj, Evas_Object *route) EINA_ARG_NONNULL(1);
22079 EAPI Evas_Object *elm_route_add(Evas_Object *parent);
22081 EAPI void elm_route_emap_set(Evas_Object *obj, EMap_Route *emap);
22083 EAPI double elm_route_lon_min_get(Evas_Object *obj);
22084 EAPI double elm_route_lat_min_get(Evas_Object *obj);
22085 EAPI double elm_route_lon_max_get(Evas_Object *obj);
22086 EAPI double elm_route_lat_max_get(Evas_Object *obj);
22090 * @defgroup Panel Panel
22092 * @image html img/widget/panel/preview-00.png
22093 * @image latex img/widget/panel/preview-00.eps
22095 * @brief A panel is a type of animated container that contains subobjects.
22096 * It can be expanded or contracted by clicking the button on it's edge.
22098 * Orientations are as follows:
22099 * @li ELM_PANEL_ORIENT_TOP
22100 * @li ELM_PANEL_ORIENT_LEFT
22101 * @li ELM_PANEL_ORIENT_RIGHT
22103 * @ref tutorial_panel shows one way to use this widget.
22106 typedef enum _Elm_Panel_Orient
22108 ELM_PANEL_ORIENT_TOP, /**< Panel (dis)appears from the top */
22109 ELM_PANEL_ORIENT_BOTTOM, /**< Not implemented */
22110 ELM_PANEL_ORIENT_LEFT, /**< Panel (dis)appears from the left */
22111 ELM_PANEL_ORIENT_RIGHT, /**< Panel (dis)appears from the right */
22112 } Elm_Panel_Orient;
22114 * @brief Adds a panel object
22116 * @param parent The parent object
22118 * @return The panel object, or NULL on failure
22120 EAPI Evas_Object *elm_panel_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22122 * @brief Sets the orientation of the panel
22124 * @param parent The parent object
22125 * @param orient The panel orientation. Can be one of the following:
22126 * @li ELM_PANEL_ORIENT_TOP
22127 * @li ELM_PANEL_ORIENT_LEFT
22128 * @li ELM_PANEL_ORIENT_RIGHT
22130 * Sets from where the panel will (dis)appear.
22132 EAPI void elm_panel_orient_set(Evas_Object *obj, Elm_Panel_Orient orient) EINA_ARG_NONNULL(1);
22134 * @brief Get the orientation of the panel.
22136 * @param obj The panel object
22137 * @return The Elm_Panel_Orient, or ELM_PANEL_ORIENT_LEFT on failure.
22139 EAPI Elm_Panel_Orient elm_panel_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22141 * @brief Set the content of the panel.
22143 * @param obj The panel object
22144 * @param content The panel content
22146 * Once the content object is set, a previously set one will be deleted.
22147 * If you want to keep that old content object, use the
22148 * elm_panel_content_unset() function.
22150 EAPI void elm_panel_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
22152 * @brief Get the content of the panel.
22154 * @param obj The panel object
22155 * @return The content that is being used
22157 * Return the content object which is set for this widget.
22159 * @see elm_panel_content_set()
22161 EAPI Evas_Object *elm_panel_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22163 * @brief Unset the content of the panel.
22165 * @param obj The panel object
22166 * @return The content that was being used
22168 * Unparent and return the content object which was set for this widget.
22170 * @see elm_panel_content_set()
22172 EAPI Evas_Object *elm_panel_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
22174 * @brief Set the state of the panel.
22176 * @param obj The panel object
22177 * @param hidden If true, the panel will run the animation to contract
22179 EAPI void elm_panel_hidden_set(Evas_Object *obj, Eina_Bool hidden) EINA_ARG_NONNULL(1);
22181 * @brief Get the state of the panel.
22183 * @param obj The panel object
22184 * @param hidden If true, the panel is in the "hide" state
22186 EAPI Eina_Bool elm_panel_hidden_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22188 * @brief Toggle the hidden state of the panel from code
22190 * @param obj The panel object
22192 EAPI void elm_panel_toggle(Evas_Object *obj) EINA_ARG_NONNULL(1);
22198 * @defgroup Panes Panes
22199 * @ingroup Elementary
22201 * @image html img/widget/panes/preview-00.png
22202 * @image latex img/widget/panes/preview-00.eps width=\textwidth
22204 * @image html img/panes.png
22205 * @image latex img/panes.eps width=\textwidth
22207 * The panes adds a dragable bar between two contents. When dragged
22208 * this bar will resize contents size.
22210 * Panes can be displayed vertically or horizontally, and contents
22211 * size proportion can be customized (homogeneous by default).
22213 * Smart callbacks one can listen to:
22214 * - "press" - The panes has been pressed (button wasn't released yet).
22215 * - "unpressed" - The panes was released after being pressed.
22216 * - "clicked" - The panes has been clicked>
22217 * - "clicked,double" - The panes has been double clicked
22219 * Available styles for it:
22222 * Here is an example on its usage:
22223 * @li @ref panes_example
22227 * @addtogroup Panes
22232 * Add a new panes widget to the given parent Elementary
22233 * (container) object.
22235 * @param parent The parent object.
22236 * @return a new panes widget handle or @c NULL, on errors.
22238 * This function inserts a new panes widget on the canvas.
22242 EAPI Evas_Object *elm_panes_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22245 * Set the left content of the panes widget.
22247 * @param obj The panes object.
22248 * @param content The new left content object.
22250 * Once the content object is set, a previously set one will be deleted.
22251 * If you want to keep that old content object, use the
22252 * elm_panes_content_left_unset() function.
22254 * If panes is displayed vertically, left content will be displayed at
22257 * @see elm_panes_content_left_get()
22258 * @see elm_panes_content_right_set() to set content on the other side.
22262 EAPI void elm_panes_content_left_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
22265 * Set the right content of the panes widget.
22267 * @param obj The panes object.
22268 * @param content The new right content object.
22270 * Once the content object is set, a previously set one will be deleted.
22271 * If you want to keep that old content object, use the
22272 * elm_panes_content_right_unset() function.
22274 * If panes is displayed vertically, left content will be displayed at
22277 * @see elm_panes_content_right_get()
22278 * @see elm_panes_content_left_set() to set content on the other side.
22282 EAPI void elm_panes_content_right_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
22285 * Get the left content of the panes.
22287 * @param obj The panes object.
22288 * @return The left content object that is being used.
22290 * Return the left content object which is set for this widget.
22292 * @see elm_panes_content_left_set() for details.
22296 EAPI Evas_Object *elm_panes_content_left_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22299 * Get the right content of the panes.
22301 * @param obj The panes object
22302 * @return The right content object that is being used
22304 * Return the right content object which is set for this widget.
22306 * @see elm_panes_content_right_set() for details.
22310 EAPI Evas_Object *elm_panes_content_right_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22313 * Unset the left content used for the panes.
22315 * @param obj The panes object.
22316 * @return The left content object that was being used.
22318 * Unparent and return the left content object which was set for this widget.
22320 * @see elm_panes_content_left_set() for details.
22321 * @see elm_panes_content_left_get().
22325 EAPI Evas_Object *elm_panes_content_left_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
22328 * Unset the right content used for the panes.
22330 * @param obj The panes object.
22331 * @return The right content object that was being used.
22333 * Unparent and return the right content object which was set for this
22336 * @see elm_panes_content_right_set() for details.
22337 * @see elm_panes_content_right_get().
22341 EAPI Evas_Object *elm_panes_content_right_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
22344 * Get the size proportion of panes widget's left side.
22346 * @param obj The panes object.
22347 * @return float value between 0.0 and 1.0 representing size proportion
22350 * @see elm_panes_content_left_size_set() for more details.
22354 EAPI double elm_panes_content_left_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22357 * Set the size proportion of panes widget's left side.
22359 * @param obj The panes object.
22360 * @param size Value between 0.0 and 1.0 representing size proportion
22363 * By default it's homogeneous, i.e., both sides have the same size.
22365 * If something different is required, it can be set with this function.
22366 * For example, if the left content should be displayed over
22367 * 75% of the panes size, @p size should be passed as @c 0.75.
22368 * This way, right content will be resized to 25% of panes size.
22370 * If displayed vertically, left content is displayed at top, and
22371 * right content at bottom.
22373 * @note This proportion will change when user drags the panes bar.
22375 * @see elm_panes_content_left_size_get()
22379 EAPI void elm_panes_content_left_size_set(Evas_Object *obj, double size) EINA_ARG_NONNULL(1);
22382 * Set the orientation of a given panes widget.
22384 * @param obj The panes object.
22385 * @param horizontal Use @c EINA_TRUE to make @p obj to be
22386 * @b horizontal, @c EINA_FALSE to make it @b vertical.
22388 * Use this function to change how your panes is to be
22389 * disposed: vertically or horizontally.
22391 * By default it's displayed horizontally.
22393 * @see elm_panes_horizontal_get()
22397 EAPI void elm_panes_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
22400 * Retrieve the orientation of a given panes widget.
22402 * @param obj The panes object.
22403 * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
22404 * @c EINA_FALSE if it's @b vertical (and on errors).
22406 * @see elm_panes_horizontal_set() for more details.
22410 EAPI Eina_Bool elm_panes_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22417 * @defgroup Flip Flip
22419 * @image html img/widget/flip/preview-00.png
22420 * @image latex img/widget/flip/preview-00.eps
22422 * This widget holds 2 content objects(Evas_Object): one on the front and one
22423 * on the back. It allows you to flip from front to back and vice-versa using
22424 * various animations.
22426 * If either the front or back contents are not set the flip will treat that
22427 * as transparent. So if you wore to set the front content but not the back,
22428 * and then call elm_flip_go() you would see whatever is below the flip.
22430 * For a list of supported animations see elm_flip_go().
22432 * Signals that you can add callbacks for are:
22433 * "animate,begin" - when a flip animation was started
22434 * "animate,done" - when a flip animation is finished
22436 * @ref tutorial_flip show how to use most of the API.
22440 typedef enum _Elm_Flip_Mode
22442 ELM_FLIP_ROTATE_Y_CENTER_AXIS,
22443 ELM_FLIP_ROTATE_X_CENTER_AXIS,
22444 ELM_FLIP_ROTATE_XZ_CENTER_AXIS,
22445 ELM_FLIP_ROTATE_YZ_CENTER_AXIS,
22446 ELM_FLIP_CUBE_LEFT,
22447 ELM_FLIP_CUBE_RIGHT,
22449 ELM_FLIP_CUBE_DOWN,
22450 ELM_FLIP_PAGE_LEFT,
22451 ELM_FLIP_PAGE_RIGHT,
22455 typedef enum _Elm_Flip_Interaction
22457 ELM_FLIP_INTERACTION_NONE,
22458 ELM_FLIP_INTERACTION_ROTATE,
22459 ELM_FLIP_INTERACTION_CUBE,
22460 ELM_FLIP_INTERACTION_PAGE
22461 } Elm_Flip_Interaction;
22462 typedef enum _Elm_Flip_Direction
22464 ELM_FLIP_DIRECTION_UP, /**< Allows interaction with the top of the widget */
22465 ELM_FLIP_DIRECTION_DOWN, /**< Allows interaction with the bottom of the widget */
22466 ELM_FLIP_DIRECTION_LEFT, /**< Allows interaction with the left portion of the widget */
22467 ELM_FLIP_DIRECTION_RIGHT /**< Allows interaction with the right portion of the widget */
22468 } Elm_Flip_Direction;
22470 * @brief Add a new flip to the parent
22472 * @param parent The parent object
22473 * @return The new object or NULL if it cannot be created
22475 EAPI Evas_Object *elm_flip_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22477 * @brief Set the front content of the flip widget.
22479 * @param obj The flip object
22480 * @param content The new front content object
22482 * Once the content object is set, a previously set one will be deleted.
22483 * If you want to keep that old content object, use the
22484 * elm_flip_content_front_unset() function.
22486 EAPI void elm_flip_content_front_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
22488 * @brief Set the back content of the flip widget.
22490 * @param obj The flip object
22491 * @param content The new back content object
22493 * Once the content object is set, a previously set one will be deleted.
22494 * If you want to keep that old content object, use the
22495 * elm_flip_content_back_unset() function.
22497 EAPI void elm_flip_content_back_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
22499 * @brief Get the front content used for the flip
22501 * @param obj The flip object
22502 * @return The front content object that is being used
22504 * Return the front content object which is set for this widget.
22506 EAPI Evas_Object *elm_flip_content_front_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22508 * @brief Get the back content used for the flip
22510 * @param obj The flip object
22511 * @return The back content object that is being used
22513 * Return the back content object which is set for this widget.
22515 EAPI Evas_Object *elm_flip_content_back_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22517 * @brief Unset the front content used for the flip
22519 * @param obj The flip object
22520 * @return The front content object that was being used
22522 * Unparent and return the front content object which was set for this widget.
22524 EAPI Evas_Object *elm_flip_content_front_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
22526 * @brief Unset the back content used for the flip
22528 * @param obj The flip object
22529 * @return The back content object that was being used
22531 * Unparent and return the back content object which was set for this widget.
22533 EAPI Evas_Object *elm_flip_content_back_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
22535 * @brief Get flip front visibility state
22537 * @param obj The flip objct
22538 * @return EINA_TRUE if front front is showing, EINA_FALSE if the back is
22541 EAPI Eina_Bool elm_flip_front_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22543 * @brief Set flip perspective
22545 * @param obj The flip object
22546 * @param foc The coordinate to set the focus on
22547 * @param x The X coordinate
22548 * @param y The Y coordinate
22550 * @warning This function currently does nothing.
22552 EAPI void elm_flip_perspective_set(Evas_Object *obj, Evas_Coord foc, Evas_Coord x, Evas_Coord y) EINA_ARG_NONNULL(1);
22554 * @brief Runs the flip animation
22556 * @param obj The flip object
22557 * @param mode The mode type
22559 * Flips the front and back contents using the @p mode animation. This
22560 * efectively hides the currently visible content and shows the hidden one.
22562 * There a number of possible animations to use for the flipping:
22563 * @li ELM_FLIP_ROTATE_X_CENTER_AXIS - Rotate the currently visible content
22564 * around a horizontal axis in the middle of its height, the other content
22565 * is shown as the other side of the flip.
22566 * @li ELM_FLIP_ROTATE_Y_CENTER_AXIS - Rotate the currently visible content
22567 * around a vertical axis in the middle of its width, the other content is
22568 * shown as the other side of the flip.
22569 * @li ELM_FLIP_ROTATE_XZ_CENTER_AXIS - Rotate the currently visible content
22570 * around a diagonal axis in the middle of its width, the other content is
22571 * shown as the other side of the flip.
22572 * @li ELM_FLIP_ROTATE_YZ_CENTER_AXIS - Rotate the currently visible content
22573 * around a diagonal axis in the middle of its height, the other content is
22574 * shown as the other side of the flip.
22575 * @li ELM_FLIP_CUBE_LEFT - Rotate the currently visible content to the left
22576 * as if the flip was a cube, the other content is show as the right face of
22578 * @li ELM_FLIP_CUBE_RIGHT - Rotate the currently visible content to the
22579 * right as if the flip was a cube, the other content is show as the left
22580 * face of the cube.
22581 * @li ELM_FLIP_CUBE_UP - Rotate the currently visible content up as if the
22582 * flip was a cube, the other content is show as the bottom face of the cube.
22583 * @li ELM_FLIP_CUBE_DOWN - Rotate the currently visible content down as if
22584 * the flip was a cube, the other content is show as the upper face of the
22586 * @li ELM_FLIP_PAGE_LEFT - Move the currently visible content to the left as
22587 * if the flip was a book, the other content is shown as the page below that.
22588 * @li ELM_FLIP_PAGE_RIGHT - Move the currently visible content to the right
22589 * as if the flip was a book, the other content is shown as the page below
22591 * @li ELM_FLIP_PAGE_UP - Move the currently visible content up as if the
22592 * flip was a book, the other content is shown as the page below that.
22593 * @li ELM_FLIP_PAGE_DOWN - Move the currently visible content down as if the
22594 * flip was a book, the other content is shown as the page below that.
22596 * @image html elm_flip.png
22597 * @image latex elm_flip.eps width=\textwidth
22599 EAPI void elm_flip_go(Evas_Object *obj, Elm_Flip_Mode mode) EINA_ARG_NONNULL(1);
22601 * @brief Set the interactive flip mode
22603 * @param obj The flip object
22604 * @param mode The interactive flip mode to use
22606 * This sets if the flip should be interactive (allow user to click and
22607 * drag a side of the flip to reveal the back page and cause it to flip).
22608 * By default a flip is not interactive. You may also need to set which
22609 * sides of the flip are "active" for flipping and how much space they use
22610 * (a minimum of a finger size) with elm_flip_interacton_direction_enabled_set()
22611 * and elm_flip_interacton_direction_hitsize_set()
22613 * The four avilable mode of interaction are:
22614 * @li ELM_FLIP_INTERACTION_NONE - No interaction is allowed
22615 * @li ELM_FLIP_INTERACTION_ROTATE - Interaction will cause rotate animation
22616 * @li ELM_FLIP_INTERACTION_CUBE - Interaction will cause cube animation
22617 * @li ELM_FLIP_INTERACTION_PAGE - Interaction will cause page animation
22619 * @note ELM_FLIP_INTERACTION_ROTATE won't cause
22620 * ELM_FLIP_ROTATE_XZ_CENTER_AXIS or ELM_FLIP_ROTATE_YZ_CENTER_AXIS to
22621 * happen, those can only be acheived with elm_flip_go();
22623 EAPI void elm_flip_interaction_set(Evas_Object *obj, Elm_Flip_Interaction mode);
22625 * @brief Get the interactive flip mode
22627 * @param obj The flip object
22628 * @return The interactive flip mode
22630 * Returns the interactive flip mode set by elm_flip_interaction_set()
22632 EAPI Elm_Flip_Interaction elm_flip_interaction_get(const Evas_Object *obj);
22634 * @brief Set which directions of the flip respond to interactive flip
22636 * @param obj The flip object
22637 * @param dir The direction to change
22638 * @param enabled If that direction is enabled or not
22640 * By default all directions are disabled, so you may want to enable the
22641 * desired directions for flipping if you need interactive flipping. You must
22642 * call this function once for each direction that should be enabled.
22644 * @see elm_flip_interaction_set()
22646 EAPI void elm_flip_interacton_direction_enabled_set(Evas_Object *obj, Elm_Flip_Direction dir, Eina_Bool enabled);
22648 * @brief Get the enabled state of that flip direction
22650 * @param obj The flip object
22651 * @param dir The direction to check
22652 * @return If that direction is enabled or not
22654 * Gets the enabled state set by elm_flip_interacton_direction_enabled_set()
22656 * @see elm_flip_interaction_set()
22658 EAPI Eina_Bool elm_flip_interacton_direction_enabled_get(Evas_Object *obj, Elm_Flip_Direction dir);
22660 * @brief Set the amount of the flip that is sensitive to interactive flip
22662 * @param obj The flip object
22663 * @param dir The direction to modify
22664 * @param hitsize The amount of that dimension (0.0 to 1.0) to use
22666 * Set the amount of the flip that is sensitive to interactive flip, with 0
22667 * representing no area in the flip and 1 representing the entire flip. There
22668 * is however a consideration to be made in that the area will never be
22669 * smaller than the finger size set(as set in your Elementary configuration).
22671 * @see elm_flip_interaction_set()
22673 EAPI void elm_flip_interacton_direction_hitsize_set(Evas_Object *obj, Elm_Flip_Direction dir, double hitsize);
22675 * @brief Get the amount of the flip that is sensitive to interactive flip
22677 * @param obj The flip object
22678 * @param dir The direction to check
22679 * @return The size set for that direction
22681 * Returns the amount os sensitive area set by
22682 * elm_flip_interacton_direction_hitsize_set().
22684 EAPI double elm_flip_interacton_direction_hitsize_get(Evas_Object *obj, Elm_Flip_Direction dir);
22689 /* scrolledentry */
22690 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22691 EINA_DEPRECATED EAPI void elm_scrolled_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line) EINA_ARG_NONNULL(1);
22692 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_single_line_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22693 EINA_DEPRECATED EAPI void elm_scrolled_entry_password_set(Evas_Object *obj, Eina_Bool password) EINA_ARG_NONNULL(1);
22694 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_password_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22695 EINA_DEPRECATED EAPI void elm_scrolled_entry_entry_set(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
22696 EINA_DEPRECATED EAPI const char *elm_scrolled_entry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22697 EINA_DEPRECATED EAPI void elm_scrolled_entry_entry_append(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
22698 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_is_empty(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22699 EINA_DEPRECATED EAPI const char *elm_scrolled_entry_selection_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22700 EINA_DEPRECATED EAPI void elm_scrolled_entry_entry_insert(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
22701 EINA_DEPRECATED EAPI void elm_scrolled_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
22702 EINA_DEPRECATED EAPI void elm_scrolled_entry_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
22703 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22704 EINA_DEPRECATED EAPI void elm_scrolled_entry_select_none(Evas_Object *obj) EINA_ARG_NONNULL(1);
22705 EINA_DEPRECATED EAPI void elm_scrolled_entry_select_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
22706 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
22707 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
22708 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_up(Evas_Object *obj) EINA_ARG_NONNULL(1);
22709 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_down(Evas_Object *obj) EINA_ARG_NONNULL(1);
22710 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
22711 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
22712 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_line_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
22713 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_line_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
22714 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_selection_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
22715 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_selection_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
22716 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_is_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22717 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_is_visible_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22718 EINA_DEPRECATED EAPI const char *elm_scrolled_entry_cursor_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22719 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_pos_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
22720 EINA_DEPRECATED EAPI int elm_scrolled_entry_cursor_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22721 EINA_DEPRECATED EAPI void elm_scrolled_entry_selection_cut(Evas_Object *obj) EINA_ARG_NONNULL(1);
22722 EINA_DEPRECATED EAPI void elm_scrolled_entry_selection_copy(Evas_Object *obj) EINA_ARG_NONNULL(1);
22723 EINA_DEPRECATED EAPI void elm_scrolled_entry_selection_paste(Evas_Object *obj) EINA_ARG_NONNULL(1);
22724 EINA_DEPRECATED EAPI void elm_scrolled_entry_context_menu_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
22725 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);
22726 EINA_DEPRECATED EAPI void elm_scrolled_entry_context_menu_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
22727 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_context_menu_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22728 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);
22729 EINA_DEPRECATED EAPI void elm_scrolled_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
22730 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);
22731 EINA_DEPRECATED EAPI void elm_scrolled_entry_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1, 2);
22732 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22733 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
22734 EINA_DEPRECATED EAPI void elm_scrolled_entry_icon_visible_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
22735 EINA_DEPRECATED EAPI void elm_scrolled_entry_end_set(Evas_Object *obj, Evas_Object *end) EINA_ARG_NONNULL(1, 2);
22736 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_end_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22737 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_end_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
22738 EINA_DEPRECATED EAPI void elm_scrolled_entry_end_visible_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
22739 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);
22740 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);
22741 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);
22742 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);
22743 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);
22744 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);
22745 EINA_DEPRECATED EAPI void elm_scrolled_entry_file_set(Evas_Object *obj, const char *file, Elm_Text_Format format) EINA_ARG_NONNULL(1);
22746 EINA_DEPRECATED EAPI void elm_scrolled_entry_file_get(const Evas_Object *obj, const char **file, Elm_Text_Format *format) EINA_ARG_NONNULL(1);
22747 EINA_DEPRECATED EAPI void elm_scrolled_entry_file_save(Evas_Object *obj) EINA_ARG_NONNULL(1);
22748 EINA_DEPRECATED EAPI void elm_scrolled_entry_autosave_set(Evas_Object *obj, Eina_Bool autosave) EINA_ARG_NONNULL(1);
22749 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_autosave_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22750 EINA_DEPRECATED EAPI void elm_scrolled_entry_cnp_textonly_set(Evas_Object *obj, Eina_Bool textonly) EINA_ARG_NONNULL(1);
22751 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cnp_textonly_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
22754 * @defgroup Conformant Conformant
22755 * @ingroup Elementary
22757 * @image html img/widget/conformant/preview-00.png
22758 * @image latex img/widget/conformant/preview-00.eps width=\textwidth
22760 * @image html img/conformant.png
22761 * @image latex img/conformant.eps width=\textwidth
22763 * The aim is to provide a widget that can be used in elementary apps to
22764 * account for space taken up by the indicator, virtual keypad & softkey
22765 * windows when running the illume2 module of E17.
22767 * So conformant content will be sized and positioned considering the
22768 * space required for such stuff, and when they popup, as a keyboard
22769 * shows when an entry is selected, conformant content won't change.
22771 * Available styles for it:
22774 * See how to use this widget in this example:
22775 * @ref conformant_example
22779 * @addtogroup Conformant
22784 * Add a new conformant widget to the given parent Elementary
22785 * (container) object.
22787 * @param parent The parent object.
22788 * @return A new conformant widget handle or @c NULL, on errors.
22790 * This function inserts a new conformant widget on the canvas.
22792 * @ingroup Conformant
22794 EAPI Evas_Object *elm_conformant_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22797 * Set the content of the conformant widget.
22799 * @param obj The conformant object.
22800 * @param content The content to be displayed by the conformant.
22802 * Content will be sized and positioned considering the space required
22803 * to display a virtual keyboard. So it won't fill all the conformant
22804 * size. This way is possible to be sure that content won't resize
22805 * or be re-positioned after the keyboard is displayed.
22807 * Once the content object is set, a previously set one will be deleted.
22808 * If you want to keep that old content object, use the
22809 * elm_conformat_content_unset() function.
22811 * @see elm_conformant_content_unset()
22812 * @see elm_conformant_content_get()
22814 * @ingroup Conformant
22816 EAPI void elm_conformant_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
22819 * Get the content of the conformant widget.
22821 * @param obj The conformant object.
22822 * @return The content that is being used.
22824 * Return the content object which is set for this widget.
22825 * It won't be unparent from conformant. For that, use
22826 * elm_conformant_content_unset().
22828 * @see elm_conformant_content_set() for more details.
22829 * @see elm_conformant_content_unset()
22831 * @ingroup Conformant
22833 EAPI Evas_Object *elm_conformant_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22836 * Unset the content of the conformant widget.
22838 * @param obj The conformant object.
22839 * @return The content that was being used.
22841 * Unparent and return the content object which was set for this widget.
22843 * @see elm_conformant_content_set() for more details.
22845 * @ingroup Conformant
22847 EAPI Evas_Object *elm_conformant_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
22850 * Returns the Evas_Object that represents the content area.
22852 * @param obj The conformant object.
22853 * @return The content area of the widget.
22855 * @ingroup Conformant
22857 EAPI Evas_Object *elm_conformant_content_area_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22864 * @defgroup Mapbuf Mapbuf
22865 * @ingroup Elementary
22867 * @image html img/widget/mapbuf/preview-00.png
22868 * @image latex img/widget/mapbuf/preview-00.eps width=\textwidth
22870 * This holds one content object and uses an Evas Map of transformation
22871 * points to be later used with this content. So the content will be
22872 * moved, resized, etc as a single image. So it will improve performance
22873 * when you have a complex interafce, with a lot of elements, and will
22874 * need to resize or move it frequently (the content object and its
22877 * See how to use this widget in this example:
22878 * @ref mapbuf_example
22882 * @addtogroup Mapbuf
22887 * Add a new mapbuf widget to the given parent Elementary
22888 * (container) object.
22890 * @param parent The parent object.
22891 * @return A new mapbuf widget handle or @c NULL, on errors.
22893 * This function inserts a new mapbuf widget on the canvas.
22897 EAPI Evas_Object *elm_mapbuf_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22900 * Set the content of the mapbuf.
22902 * @param obj The mapbuf object.
22903 * @param content The content that will be filled in this mapbuf object.
22905 * Once the content object is set, a previously set one will be deleted.
22906 * If you want to keep that old content object, use the
22907 * elm_mapbuf_content_unset() function.
22909 * To enable map, elm_mapbuf_enabled_set() should be used.
22913 EAPI void elm_mapbuf_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
22916 * Get the content of the mapbuf.
22918 * @param obj The mapbuf object.
22919 * @return The content that is being used.
22921 * Return the content object which is set for this widget.
22923 * @see elm_mapbuf_content_set() for details.
22927 EAPI Evas_Object *elm_mapbuf_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22930 * Unset the content of the mapbuf.
22932 * @param obj The mapbuf object.
22933 * @return The content that was being used.
22935 * Unparent and return the content object which was set for this widget.
22937 * @see elm_mapbuf_content_set() for details.
22941 EAPI Evas_Object *elm_mapbuf_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
22944 * Enable or disable the map.
22946 * @param obj The mapbuf object.
22947 * @param enabled @c EINA_TRUE to enable map or @c EINA_FALSE to disable it.
22949 * This enables the map that is set or disables it. On enable, the object
22950 * geometry will be saved, and the new geometry will change (position and
22951 * size) to reflect the map geometry set.
22953 * Also, when enabled, alpha and smooth states will be used, so if the
22954 * content isn't solid, alpha should be enabled, for example, otherwise
22955 * a black retangle will fill the content.
22957 * When disabled, the stored map will be freed and geometry prior to
22958 * enabling the map will be restored.
22960 * It's disabled by default.
22962 * @see elm_mapbuf_alpha_set()
22963 * @see elm_mapbuf_smooth_set()
22967 EAPI void elm_mapbuf_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
22970 * Get a value whether map is enabled or not.
22972 * @param obj The mapbuf object.
22973 * @return @c EINA_TRUE means map is enabled. @c EINA_FALSE indicates
22974 * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
22976 * @see elm_mapbuf_enabled_set() for details.
22980 EAPI Eina_Bool elm_mapbuf_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22983 * Enable or disable smooth map rendering.
22985 * @param obj The mapbuf object.
22986 * @param smooth @c EINA_TRUE to enable smooth map rendering or @c EINA_FALSE
22989 * This sets smoothing for map rendering. If the object is a type that has
22990 * its own smoothing settings, then both the smooth settings for this object
22991 * and the map must be turned off.
22993 * By default smooth maps are enabled.
22997 EAPI void elm_mapbuf_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
23000 * Get a value whether smooth map rendering is enabled or not.
23002 * @param obj The mapbuf object.
23003 * @return @c EINA_TRUE means smooth map rendering is enabled. @c EINA_FALSE
23004 * indicates it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
23006 * @see elm_mapbuf_smooth_set() for details.
23010 EAPI Eina_Bool elm_mapbuf_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23013 * Set or unset alpha flag for map rendering.
23015 * @param obj The mapbuf object.
23016 * @param alpha @c EINA_TRUE to enable alpha blending or @c EINA_FALSE
23019 * This sets alpha flag for map rendering. If the object is a type that has
23020 * its own alpha settings, then this will take precedence. Only image objects
23021 * have this currently. It stops alpha blending of the map area, and is
23022 * useful if you know the object and/or all sub-objects is 100% solid.
23024 * Alpha is enabled by default.
23028 EAPI void elm_mapbuf_alpha_set(Evas_Object *obj, Eina_Bool alpha) EINA_ARG_NONNULL(1);
23031 * Get a value whether alpha blending is enabled or not.
23033 * @param obj The mapbuf object.
23034 * @return @c EINA_TRUE means alpha blending is enabled. @c EINA_FALSE
23035 * indicates it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
23037 * @see elm_mapbuf_alpha_set() for details.
23041 EAPI Eina_Bool elm_mapbuf_alpha_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23048 * @defgroup Flipselector Flip Selector
23050 * @image html img/widget/flipselector/preview-00.png
23051 * @image latex img/widget/flipselector/preview-00.eps
23053 * A flip selector is a widget to show a set of @b text items, one
23054 * at a time, with the same sheet switching style as the @ref Clock
23055 * "clock" widget, when one changes the current displaying sheet
23056 * (thus, the "flip" in the name).
23058 * User clicks to flip sheets which are @b held for some time will
23059 * make the flip selector to flip continuosly and automatically for
23060 * the user. The interval between flips will keep growing in time,
23061 * so that it helps the user to reach an item which is distant from
23062 * the current selection.
23064 * Smart callbacks one can register to:
23065 * - @c "selected" - when the widget's selected text item is changed
23066 * - @c "overflowed" - when the widget's current selection is changed
23067 * from the first item in its list to the last
23068 * - @c "underflowed" - when the widget's current selection is changed
23069 * from the last item in its list to the first
23071 * Available styles for it:
23074 * Here is an example on its usage:
23075 * @li @ref flipselector_example
23079 * @addtogroup Flipselector
23083 typedef struct _Elm_Flipselector_Item Elm_Flipselector_Item; /**< Item handle for a flip selector widget. */
23086 * Add a new flip selector widget to the given parent Elementary
23087 * (container) widget
23089 * @param parent The parent object
23090 * @return a new flip selector widget handle or @c NULL, on errors
23092 * This function inserts a new flip selector widget on the canvas.
23094 * @ingroup Flipselector
23096 EAPI Evas_Object *elm_flipselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
23099 * Programmatically select the next item of a flip selector widget
23101 * @param obj The flipselector object
23103 * @note The selection will be animated. Also, if it reaches the
23104 * end of its list of member items, it will continue with the first
23107 * @ingroup Flipselector
23109 EAPI void elm_flipselector_flip_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
23112 * Programmatically select the previous item of a flip selector
23115 * @param obj The flipselector object
23117 * @note The selection will be animated. Also, if it reaches the
23118 * beginning of its list of member items, it will continue with the
23119 * last one backwards.
23121 * @ingroup Flipselector
23123 EAPI void elm_flipselector_flip_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
23126 * Append a (text) item to a flip selector widget
23128 * @param obj The flipselector object
23129 * @param label The (text) label of the new item
23130 * @param func Convenience callback function to take place when
23132 * @param data Data passed to @p func, above
23133 * @return A handle to the item added or @c NULL, on errors
23135 * The widget's list of labels to show will be appended with the
23136 * given value. If the user wishes so, a callback function pointer
23137 * can be passed, which will get called when this same item is
23140 * @note The current selection @b won't be modified by appending an
23141 * element to the list.
23143 * @note The maximum length of the text label is going to be
23144 * determined <b>by the widget's theme</b>. Strings larger than
23145 * that value are going to be @b truncated.
23147 * @ingroup Flipselector
23149 EAPI Elm_Flipselector_Item *elm_flipselector_item_append(Evas_Object *obj, const char *label, Evas_Smart_Cb func, void *data) EINA_ARG_NONNULL(1);
23152 * Prepend a (text) item to a flip selector widget
23154 * @param obj The flipselector object
23155 * @param label The (text) label of the new item
23156 * @param func Convenience callback function to take place when
23158 * @param data Data passed to @p func, above
23159 * @return A handle to the item added or @c NULL, on errors
23161 * The widget's list of labels to show will be prepended with the
23162 * given value. If the user wishes so, a callback function pointer
23163 * can be passed, which will get called when this same item is
23166 * @note The current selection @b won't be modified by prepending
23167 * an element to the list.
23169 * @note The maximum length of the text label is going to be
23170 * determined <b>by the widget's theme</b>. Strings larger than
23171 * that value are going to be @b truncated.
23173 * @ingroup Flipselector
23175 EAPI Elm_Flipselector_Item *elm_flipselector_item_prepend(Evas_Object *obj, const char *label, Evas_Smart_Cb func, void *data) EINA_ARG_NONNULL(1);
23178 * Get the internal list of items in a given flip selector widget.
23180 * @param obj The flipselector object
23181 * @return The list of items (#Elm_Flipselector_Item as data) or
23182 * @c NULL on errors.
23184 * This list is @b not to be modified in any way and must not be
23185 * freed. Use the list members with functions like
23186 * elm_flipselector_item_label_set(),
23187 * elm_flipselector_item_label_get(),
23188 * elm_flipselector_item_del(),
23189 * elm_flipselector_item_selected_get(),
23190 * elm_flipselector_item_selected_set().
23192 * @warning This list is only valid until @p obj object's internal
23193 * items list is changed. It should be fetched again with another
23194 * call to this function when changes happen.
23196 * @ingroup Flipselector
23198 EAPI const Eina_List *elm_flipselector_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23201 * Get the first item in the given flip selector widget's list of
23204 * @param obj The flipselector object
23205 * @return The first item or @c NULL, if it has no items (and on
23208 * @see elm_flipselector_item_append()
23209 * @see elm_flipselector_last_item_get()
23211 * @ingroup Flipselector
23213 EAPI Elm_Flipselector_Item *elm_flipselector_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23216 * Get the last item in the given flip selector widget's list of
23219 * @param obj The flipselector object
23220 * @return The last item or @c NULL, if it has no items (and on
23223 * @see elm_flipselector_item_prepend()
23224 * @see elm_flipselector_first_item_get()
23226 * @ingroup Flipselector
23228 EAPI Elm_Flipselector_Item *elm_flipselector_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23231 * Get the currently selected item in a flip selector widget.
23233 * @param obj The flipselector object
23234 * @return The selected item or @c NULL, if the widget has no items
23237 * @ingroup Flipselector
23239 EAPI Elm_Flipselector_Item *elm_flipselector_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23242 * Set whether a given flip selector widget's item should be the
23243 * currently selected one.
23245 * @param item The flip selector item
23246 * @param selected @c EINA_TRUE to select it, @c EINA_FALSE to unselect.
23248 * This sets whether @p item is or not the selected (thus, under
23249 * display) one. If @p item is different than one under display,
23250 * the latter will be unselected. If the @p item is set to be
23251 * unselected, on the other hand, the @b first item in the widget's
23252 * internal members list will be the new selected one.
23254 * @see elm_flipselector_item_selected_get()
23256 * @ingroup Flipselector
23258 EAPI void elm_flipselector_item_selected_set(Elm_Flipselector_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
23261 * Get whether a given flip selector widget's item is the currently
23264 * @param item The flip selector item
23265 * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
23268 * @see elm_flipselector_item_selected_set()
23270 * @ingroup Flipselector
23272 EAPI Eina_Bool elm_flipselector_item_selected_get(const Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
23275 * Delete a given item from a flip selector widget.
23277 * @param item The item to delete
23279 * @ingroup Flipselector
23281 EAPI void elm_flipselector_item_del(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
23284 * Get the label of a given flip selector widget's item.
23286 * @param item The item to get label from
23287 * @return The text label of @p item or @c NULL, on errors
23289 * @see elm_flipselector_item_label_set()
23291 * @ingroup Flipselector
23293 EAPI const char *elm_flipselector_item_label_get(const Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
23296 * Set the label of a given flip selector widget's item.
23298 * @param item The item to set label on
23299 * @param label The text label string, in UTF-8 encoding
23301 * @see elm_flipselector_item_label_get()
23303 * @ingroup Flipselector
23305 EAPI void elm_flipselector_item_label_set(Elm_Flipselector_Item *item, const char *label) EINA_ARG_NONNULL(1);
23308 * Gets the item before @p item in a flip selector widget's
23309 * internal list of items.
23311 * @param item The item to fetch previous from
23312 * @return The item before the @p item, in its parent's list. If
23313 * there is no previous item for @p item or there's an
23314 * error, @c NULL is returned.
23316 * @see elm_flipselector_item_next_get()
23318 * @ingroup Flipselector
23320 EAPI Elm_Flipselector_Item *elm_flipselector_item_prev_get(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
23323 * Gets the item after @p item in a flip selector widget's
23324 * internal list of items.
23326 * @param item The item to fetch next from
23327 * @return The item after the @p item, in its parent's list. If
23328 * there is no next item for @p item or there's an
23329 * error, @c NULL is returned.
23331 * @see elm_flipselector_item_next_get()
23333 * @ingroup Flipselector
23335 EAPI Elm_Flipselector_Item *elm_flipselector_item_next_get(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
23338 * Set the interval on time updates for an user mouse button hold
23339 * on a flip selector widget.
23341 * @param obj The flip selector object
23342 * @param interval The (first) interval value in seconds
23344 * This interval value is @b decreased while the user holds the
23345 * mouse pointer either flipping up or flipping doww a given flip
23348 * This helps the user to get to a given item distant from the
23349 * current one easier/faster, as it will start to flip quicker and
23350 * quicker on mouse button holds.
23352 * The calculation for the next flip interval value, starting from
23353 * the one set with this call, is the previous interval divided by
23354 * 1.05, so it decreases a little bit.
23356 * The default starting interval value for automatic flips is
23359 * @see elm_flipselector_interval_get()
23361 * @ingroup Flipselector
23363 EAPI void elm_flipselector_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
23366 * Get the interval on time updates for an user mouse button hold
23367 * on a flip selector widget.
23369 * @param obj The flip selector object
23370 * @return The (first) interval value, in seconds, set on it
23372 * @see elm_flipselector_interval_set() for more details
23374 * @ingroup Flipselector
23376 EAPI double elm_flipselector_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23382 * @addtogroup Calendar
23387 * @enum _Elm_Calendar_Mark_Repeat
23388 * @typedef Elm_Calendar_Mark_Repeat
23390 * Event periodicity, used to define if a mark should be repeated
23391 * @b beyond event's day. It's set when a mark is added.
23393 * So, for a mark added to 13th May with periodicity set to WEEKLY,
23394 * there will be marks every week after this date. Marks will be displayed
23395 * at 13th, 20th, 27th, 3rd June ...
23397 * Values don't work as bitmask, only one can be choosen.
23399 * @see elm_calendar_mark_add()
23401 * @ingroup Calendar
23403 typedef enum _Elm_Calendar_Mark_Repeat
23405 ELM_CALENDAR_UNIQUE, /**< Default value. Marks will be displayed only on event day. */
23406 ELM_CALENDAR_DAILY, /**< Marks will be displayed everyday after event day (inclusive). */
23407 ELM_CALENDAR_WEEKLY, /**< Marks will be displayed every week after event day (inclusive) - i.e. each seven days. */
23408 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*/
23409 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. */
23410 } Elm_Calendar_Mark_Repeat;
23412 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(). */
23415 * Add a new calendar widget to the given parent Elementary
23416 * (container) object.
23418 * @param parent The parent object.
23419 * @return a new calendar widget handle or @c NULL, on errors.
23421 * This function inserts a new calendar widget on the canvas.
23423 * @ref calendar_example_01
23425 * @ingroup Calendar
23427 EAPI Evas_Object *elm_calendar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
23430 * Get weekdays names displayed by the calendar.
23432 * @param obj The calendar object.
23433 * @return Array of seven strings to be used as weekday names.
23435 * By default, weekdays abbreviations get from system are displayed:
23436 * E.g. for an en_US locale: "Sun, Mon, Tue, Wed, Thu, Fri, Sat"
23437 * The first string is related to Sunday, the second to Monday...
23439 * @see elm_calendar_weekdays_name_set()
23441 * @ref calendar_example_05
23443 * @ingroup Calendar
23445 EAPI const char **elm_calendar_weekdays_names_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23448 * Set weekdays names to be displayed by the calendar.
23450 * @param obj The calendar object.
23451 * @param weekdays Array of seven strings to be used as weekday names.
23452 * @warning It must have 7 elements, or it will access invalid memory.
23453 * @warning The strings must be NULL terminated ('@\0').
23455 * By default, weekdays abbreviations get from system are displayed:
23456 * E.g. for an en_US locale: "Sun, Mon, Tue, Wed, Thu, Fri, Sat"
23458 * The first string should be related to Sunday, the second to Monday...
23460 * The usage should be like this:
23462 * const char *weekdays[] =
23464 * "Sunday", "Monday", "Tuesday", "Wednesday",
23465 * "Thursday", "Friday", "Saturday"
23467 * elm_calendar_weekdays_names_set(calendar, weekdays);
23470 * @see elm_calendar_weekdays_name_get()
23472 * @ref calendar_example_02
23474 * @ingroup Calendar
23476 EAPI void elm_calendar_weekdays_names_set(Evas_Object *obj, const char *weekdays[]) EINA_ARG_NONNULL(1, 2);
23479 * Set the minimum and maximum values for the year
23481 * @param obj The calendar object
23482 * @param min The minimum year, greater than 1901;
23483 * @param max The maximum year;
23485 * Maximum must be greater than minimum, except if you don't wan't to set
23487 * Default values are 1902 and -1.
23489 * If the maximum year is a negative value, it will be limited depending
23490 * on the platform architecture (year 2037 for 32 bits);
23492 * @see elm_calendar_min_max_year_get()
23494 * @ref calendar_example_03
23496 * @ingroup Calendar
23498 EAPI void elm_calendar_min_max_year_set(Evas_Object *obj, int min, int max) EINA_ARG_NONNULL(1);
23501 * Get the minimum and maximum values for the year
23503 * @param obj The calendar object.
23504 * @param min The minimum year.
23505 * @param max The maximum year.
23507 * Default values are 1902 and -1.
23509 * @see elm_calendar_min_max_year_get() for more details.
23511 * @ref calendar_example_05
23513 * @ingroup Calendar
23515 EAPI void elm_calendar_min_max_year_get(const Evas_Object *obj, int *min, int *max) EINA_ARG_NONNULL(1);
23518 * Enable or disable day selection
23520 * @param obj The calendar object.
23521 * @param enabled @c EINA_TRUE to enable selection or @c EINA_FALSE to
23524 * Enabled by default. If disabled, the user still can select months,
23525 * but not days. Selected days are highlighted on calendar.
23526 * It should be used if you won't need such selection for the widget usage.
23528 * When a day is selected, or month is changed, smart callbacks for
23529 * signal "changed" will be called.
23531 * @see elm_calendar_day_selection_enable_get()
23533 * @ref calendar_example_04
23535 * @ingroup Calendar
23537 EAPI void elm_calendar_day_selection_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
23540 * Get a value whether day selection is enabled or not.
23542 * @see elm_calendar_day_selection_enable_set() for details.
23544 * @param obj The calendar object.
23545 * @return EINA_TRUE means day selection is enabled. EINA_FALSE indicates
23546 * it's disabled. If @p obj is NULL, EINA_FALSE is returned.
23548 * @ref calendar_example_05
23550 * @ingroup Calendar
23552 EAPI Eina_Bool elm_calendar_day_selection_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23556 * Set selected date to be highlighted on calendar.
23558 * @param obj The calendar object.
23559 * @param selected_time A @b tm struct to represent the selected date.
23561 * Set the selected date, changing the displayed month if needed.
23562 * Selected date changes when the user goes to next/previous month or
23563 * select a day pressing over it on calendar.
23565 * @see elm_calendar_selected_time_get()
23567 * @ref calendar_example_04
23569 * @ingroup Calendar
23571 EAPI void elm_calendar_selected_time_set(Evas_Object *obj, struct tm *selected_time) EINA_ARG_NONNULL(1);
23574 * Get selected date.
23576 * @param obj The calendar object
23577 * @param selected_time A @b tm struct to point to selected date
23578 * @return EINA_FALSE means an error ocurred and returned time shouldn't
23581 * Get date selected by the user or set by function
23582 * elm_calendar_selected_time_set().
23583 * Selected date changes when the user goes to next/previous month or
23584 * select a day pressing over it on calendar.
23586 * @see elm_calendar_selected_time_get()
23588 * @ref calendar_example_05
23590 * @ingroup Calendar
23592 EAPI Eina_Bool elm_calendar_selected_time_get(const Evas_Object *obj, struct tm *selected_time) EINA_ARG_NONNULL(1, 2);
23595 * Set a function to format the string that will be used to display
23598 * @param obj The calendar object
23599 * @param format_function Function to set the month-year string given
23600 * the selected date
23602 * By default it uses strftime with "%B %Y" format string.
23603 * It should allocate the memory that will be used by the string,
23604 * that will be freed by the widget after usage.
23605 * A pointer to the string and a pointer to the time struct will be provided.
23610 * _format_month_year(struct tm *selected_time)
23613 * if (!strftime(buf, sizeof(buf), "%B %Y", selected_time)) return NULL;
23614 * return strdup(buf);
23617 * elm_calendar_format_function_set(calendar, _format_month_year);
23620 * @ref calendar_example_02
23622 * @ingroup Calendar
23624 EAPI void elm_calendar_format_function_set(Evas_Object *obj, char * (*format_function) (struct tm *stime)) EINA_ARG_NONNULL(1);
23627 * Add a new mark to the calendar
23629 * @param obj The calendar object
23630 * @param mark_type A string used to define the type of mark. It will be
23631 * emitted to the theme, that should display a related modification on these
23632 * days representation.
23633 * @param mark_time A time struct to represent the date of inclusion of the
23634 * mark. For marks that repeats it will just be displayed after the inclusion
23635 * date in the calendar.
23636 * @param repeat Repeat the event following this periodicity. Can be a unique
23637 * mark (that don't repeat), daily, weekly, monthly or annually.
23638 * @return The created mark or @p NULL upon failure.
23640 * Add a mark that will be drawn in the calendar respecting the insertion
23641 * time and periodicity. It will emit the type as signal to the widget theme.
23642 * Default theme supports "holiday" and "checked", but it can be extended.
23644 * It won't immediately update the calendar, drawing the marks.
23645 * For this, call elm_calendar_marks_draw(). However, when user selects
23646 * next or previous month calendar forces marks drawn.
23648 * Marks created with this method can be deleted with
23649 * elm_calendar_mark_del().
23653 * struct tm selected_time;
23654 * time_t current_time;
23656 * current_time = time(NULL) + 5 * 84600;
23657 * localtime_r(¤t_time, &selected_time);
23658 * elm_calendar_mark_add(cal, "holiday", selected_time,
23659 * ELM_CALENDAR_ANNUALLY);
23661 * current_time = time(NULL) + 1 * 84600;
23662 * localtime_r(¤t_time, &selected_time);
23663 * elm_calendar_mark_add(cal, "checked", selected_time, ELM_CALENDAR_UNIQUE);
23665 * elm_calendar_marks_draw(cal);
23668 * @see elm_calendar_marks_draw()
23669 * @see elm_calendar_mark_del()
23671 * @ref calendar_example_06
23673 * @ingroup Calendar
23675 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);
23678 * Delete mark from the calendar.
23680 * @param mark The mark to be deleted.
23682 * If deleting all calendar marks is required, elm_calendar_marks_clear()
23683 * should be used instead of getting marks list and deleting each one.
23685 * @see elm_calendar_mark_add()
23687 * @ref calendar_example_06
23689 * @ingroup Calendar
23691 EAPI void elm_calendar_mark_del(Elm_Calendar_Mark *mark) EINA_ARG_NONNULL(1);
23694 * Remove all calendar's marks
23696 * @param obj The calendar object.
23698 * @see elm_calendar_mark_add()
23699 * @see elm_calendar_mark_del()
23701 * @ingroup Calendar
23703 EAPI void elm_calendar_marks_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
23707 * Get a list of all the calendar marks.
23709 * @param obj The calendar object.
23710 * @return An @c Eina_List of calendar marks objects, or @c NULL on failure.
23712 * @see elm_calendar_mark_add()
23713 * @see elm_calendar_mark_del()
23714 * @see elm_calendar_marks_clear()
23716 * @ingroup Calendar
23718 EAPI const Eina_List *elm_calendar_marks_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23721 * Draw calendar marks.
23723 * @param obj The calendar object.
23725 * Should be used after adding, removing or clearing marks.
23726 * It will go through the entire marks list updating the calendar.
23727 * If lots of marks will be added, add all the marks and then call
23730 * When the month is changed, i.e. user selects next or previous month,
23731 * marks will be drawed.
23733 * @see elm_calendar_mark_add()
23734 * @see elm_calendar_mark_del()
23735 * @see elm_calendar_marks_clear()
23737 * @ref calendar_example_06
23739 * @ingroup Calendar
23741 EAPI void elm_calendar_marks_draw(Evas_Object *obj) EINA_ARG_NONNULL(1);
23744 * Set a day text color to the same that represents Saturdays.
23746 * @param obj The calendar object.
23747 * @param pos The text position. Position is the cell counter, from left
23748 * to right, up to down. It starts on 0 and ends on 41.
23750 * @deprecated use elm_calendar_mark_add() instead like:
23753 * struct tm t = { 0, 0, 12, 6, 0, 0, 6, 6, -1 };
23754 * elm_calendar_mark_add(obj, "sat", &t, ELM_CALENDAR_WEEKLY);
23757 * @see elm_calendar_mark_add()
23759 * @ingroup Calendar
23761 EINA_DEPRECATED EAPI void elm_calendar_text_saturday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
23764 * Set a day text color to the same that represents Sundays.
23766 * @param obj The calendar object.
23767 * @param pos The text position. Position is the cell counter, from left
23768 * to right, up to down. It starts on 0 and ends on 41.
23770 * @deprecated use elm_calendar_mark_add() instead like:
23773 * struct tm t = { 0, 0, 12, 7, 0, 0, 0, 0, -1 };
23774 * elm_calendar_mark_add(obj, "sat", &t, ELM_CALENDAR_WEEKLY);
23777 * @see elm_calendar_mark_add()
23779 * @ingroup Calendar
23781 EINA_DEPRECATED EAPI void elm_calendar_text_sunday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
23784 * Set a day text color to the same that represents Weekdays.
23786 * @param obj The calendar object
23787 * @param pos The text position. Position is the cell counter, from left
23788 * to right, up to down. It starts on 0 and ends on 41.
23790 * @deprecated use elm_calendar_mark_add() instead like:
23793 * struct tm t = { 0, 0, 12, 1, 0, 0, 0, 0, -1 };
23795 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // monday
23796 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
23797 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // tuesday
23798 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
23799 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // wednesday
23800 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
23801 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // thursday
23802 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
23803 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // friday
23806 * @see elm_calendar_mark_add()
23808 * @ingroup Calendar
23810 EINA_DEPRECATED EAPI void elm_calendar_text_weekday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
23813 * Set the interval on time updates for an user mouse button hold
23814 * on calendar widgets' month selection.
23816 * @param obj The calendar object
23817 * @param interval The (first) interval value in seconds
23819 * This interval value is @b decreased while the user holds the
23820 * mouse pointer either selecting next or previous month.
23822 * This helps the user to get to a given month distant from the
23823 * current one easier/faster, as it will start to change quicker and
23824 * quicker on mouse button holds.
23826 * The calculation for the next change interval value, starting from
23827 * the one set with this call, is the previous interval divided by
23828 * 1.05, so it decreases a little bit.
23830 * The default starting interval value for automatic changes is
23833 * @see elm_calendar_interval_get()
23835 * @ingroup Calendar
23837 EAPI void elm_calendar_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
23840 * Get the interval on time updates for an user mouse button hold
23841 * on calendar widgets' month selection.
23843 * @param obj The calendar object
23844 * @return The (first) interval value, in seconds, set on it
23846 * @see elm_calendar_interval_set() for more details
23848 * @ingroup Calendar
23850 EAPI double elm_calendar_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23857 * @defgroup Diskselector Diskselector
23858 * @ingroup Elementary
23860 * @image html img/widget/diskselector/preview-00.png
23861 * @image latex img/widget/diskselector/preview-00.eps
23863 * A diskselector is a kind of list widget. It scrolls horizontally,
23864 * and can contain label and icon objects. Three items are displayed
23865 * with the selected one in the middle.
23867 * It can act like a circular list with round mode and labels can be
23868 * reduced for a defined length for side items.
23870 * Smart callbacks one can listen to:
23871 * - "selected" - when item is selected, i.e. scroller stops.
23873 * Available styles for it:
23876 * List of examples:
23877 * @li @ref diskselector_example_01
23878 * @li @ref diskselector_example_02
23882 * @addtogroup Diskselector
23886 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(). */
23889 * Add a new diskselector widget to the given parent Elementary
23890 * (container) object.
23892 * @param parent The parent object.
23893 * @return a new diskselector widget handle or @c NULL, on errors.
23895 * This function inserts a new diskselector widget on the canvas.
23897 * @ingroup Diskselector
23899 EAPI Evas_Object *elm_diskselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
23902 * Enable or disable round mode.
23904 * @param obj The diskselector object.
23905 * @param round @c EINA_TRUE to enable round mode or @c EINA_FALSE to
23908 * Disabled by default. If round mode is enabled the items list will
23909 * work like a circle list, so when the user reaches the last item,
23910 * the first one will popup.
23912 * @see elm_diskselector_round_get()
23914 * @ingroup Diskselector
23916 EAPI void elm_diskselector_round_set(Evas_Object *obj, Eina_Bool round) EINA_ARG_NONNULL(1);
23919 * Get a value whether round mode is enabled or not.
23921 * @see elm_diskselector_round_set() for details.
23923 * @param obj The diskselector object.
23924 * @return @c EINA_TRUE means round mode is enabled. @c EINA_FALSE indicates
23925 * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
23927 * @ingroup Diskselector
23929 EAPI Eina_Bool elm_diskselector_round_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23932 * Get the side labels max length.
23934 * @deprecated use elm_diskselector_side_label_length_get() instead:
23936 * @param obj The diskselector object.
23937 * @return The max length defined for side labels, or 0 if not a valid
23940 * @ingroup Diskselector
23942 EINA_DEPRECATED EAPI int elm_diskselector_side_label_lenght_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23945 * Set the side labels max length.
23947 * @deprecated use elm_diskselector_side_label_length_set() instead:
23949 * @param obj The diskselector object.
23950 * @param len The max length defined for side labels.
23952 * @ingroup Diskselector
23954 EINA_DEPRECATED EAPI void elm_diskselector_side_label_lenght_set(Evas_Object *obj, int len) EINA_ARG_NONNULL(1);
23957 * Get the side labels max length.
23959 * @see elm_diskselector_side_label_length_set() for details.
23961 * @param obj The diskselector object.
23962 * @return The max length defined for side labels, or 0 if not a valid
23965 * @ingroup Diskselector
23967 EAPI int elm_diskselector_side_label_length_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23970 * Set the side labels max length.
23972 * @param obj The diskselector object.
23973 * @param len The max length defined for side labels.
23975 * Length is the number of characters of items' label that will be
23976 * visible when it's set on side positions. It will just crop
23977 * the string after defined size. E.g.:
23979 * An item with label "January" would be displayed on side position as
23980 * "Jan" if max length is set to 3, or "Janu", if this property
23983 * When it's selected, the entire label will be displayed, except for
23984 * width restrictions. In this case label will be cropped and "..."
23985 * will be concatenated.
23987 * Default side label max length is 3.
23989 * This property will be applyed over all items, included before or
23990 * later this function call.
23992 * @ingroup Diskselector
23994 EAPI void elm_diskselector_side_label_length_set(Evas_Object *obj, int len) EINA_ARG_NONNULL(1);
23997 * Set the number of items to be displayed.
23999 * @param obj The diskselector object.
24000 * @param num The number of items the diskselector will display.
24002 * Default value is 3, and also it's the minimun. If @p num is less
24003 * than 3, it will be set to 3.
24005 * Also, it can be set on theme, using data item @c display_item_num
24006 * on group "elm/diskselector/item/X", where X is style set.
24009 * group { name: "elm/diskselector/item/X";
24011 * item: "display_item_num" "5";
24014 * @ingroup Diskselector
24016 EAPI void elm_diskselector_display_item_num_set(Evas_Object *obj, int num) EINA_ARG_NONNULL(1);
24019 * Set bouncing behaviour when the scrolled content reaches an edge.
24021 * Tell the internal scroller object whether it should bounce or not
24022 * when it reaches the respective edges for each axis.
24024 * @param obj The diskselector object.
24025 * @param h_bounce Whether to bounce or not in the horizontal axis.
24026 * @param v_bounce Whether to bounce or not in the vertical axis.
24028 * @see elm_scroller_bounce_set()
24030 * @ingroup Diskselector
24032 EAPI void elm_diskselector_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
24035 * Get the bouncing behaviour of the internal scroller.
24037 * Get whether the internal scroller should bounce when the edge of each
24038 * axis is reached scrolling.
24040 * @param obj The diskselector object.
24041 * @param h_bounce Pointer where to store the bounce state of the horizontal
24043 * @param v_bounce Pointer where to store the bounce state of the vertical
24046 * @see elm_scroller_bounce_get()
24047 * @see elm_diskselector_bounce_set()
24049 * @ingroup Diskselector
24051 EAPI void elm_diskselector_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
24054 * Get the scrollbar policy.
24056 * @see elm_diskselector_scroller_policy_get() for details.
24058 * @param obj The diskselector object.
24059 * @param policy_h Pointer where to store horizontal scrollbar policy.
24060 * @param policy_v Pointer where to store vertical scrollbar policy.
24062 * @ingroup Diskselector
24064 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);
24067 * Set the scrollbar policy.
24069 * @param obj The diskselector object.
24070 * @param policy_h Horizontal scrollbar policy.
24071 * @param policy_v Vertical scrollbar policy.
24073 * This sets the scrollbar visibility policy for the given scroller.
24074 * #ELM_SCROLLER_POLICY_AUTO means the scrollber is made visible if it
24075 * is needed, and otherwise kept hidden. #ELM_SCROLLER_POLICY_ON turns
24076 * it on all the time, and #ELM_SCROLLER_POLICY_OFF always keeps it off.
24077 * This applies respectively for the horizontal and vertical scrollbars.
24079 * The both are disabled by default, i.e., are set to
24080 * #ELM_SCROLLER_POLICY_OFF.
24082 * @ingroup Diskselector
24084 EAPI void elm_diskselector_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
24087 * Remove all diskselector's items.
24089 * @param obj The diskselector object.
24091 * @see elm_diskselector_item_del()
24092 * @see elm_diskselector_item_append()
24094 * @ingroup Diskselector
24096 EAPI void elm_diskselector_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
24099 * Get a list of all the diskselector items.
24101 * @param obj The diskselector object.
24102 * @return An @c Eina_List of diskselector items, #Elm_Diskselector_Item,
24103 * or @c NULL on failure.
24105 * @see elm_diskselector_item_append()
24106 * @see elm_diskselector_item_del()
24107 * @see elm_diskselector_clear()
24109 * @ingroup Diskselector
24111 EAPI const Eina_List *elm_diskselector_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24114 * Appends a new item to the diskselector object.
24116 * @param obj The diskselector object.
24117 * @param label The label of the diskselector item.
24118 * @param icon The icon object to use at left side of the item. An
24119 * icon can be any Evas object, but usually it is an icon created
24120 * with elm_icon_add().
24121 * @param func The function to call when the item is selected.
24122 * @param data The data to associate with the item for related callbacks.
24124 * @return The created item or @c NULL upon failure.
24126 * A new item will be created and appended to the diskselector, i.e., will
24127 * be set as last item. Also, if there is no selected item, it will
24128 * be selected. This will always happens for the first appended item.
24130 * If no icon is set, label will be centered on item position, otherwise
24131 * the icon will be placed at left of the label, that will be shifted
24134 * Items created with this method can be deleted with
24135 * elm_diskselector_item_del().
24137 * Associated @p data can be properly freed when item is deleted if a
24138 * callback function is set with elm_diskselector_item_del_cb_set().
24140 * If a function is passed as argument, it will be called everytime this item
24141 * is selected, i.e., the user stops the diskselector with this
24142 * item on center position. If such function isn't needed, just passing
24143 * @c NULL as @p func is enough. The same should be done for @p data.
24145 * Simple example (with no function callback or data associated):
24147 * disk = elm_diskselector_add(win);
24148 * ic = elm_icon_add(win);
24149 * elm_icon_file_set(ic, "path/to/image", NULL);
24150 * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
24151 * elm_diskselector_item_append(disk, "label", ic, NULL, NULL);
24154 * @see elm_diskselector_item_del()
24155 * @see elm_diskselector_item_del_cb_set()
24156 * @see elm_diskselector_clear()
24157 * @see elm_icon_add()
24159 * @ingroup Diskselector
24161 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);
24165 * Delete them item from the diskselector.
24167 * @param it The item of diskselector to be deleted.
24169 * If deleting all diskselector items is required, elm_diskselector_clear()
24170 * should be used instead of getting items list and deleting each one.
24172 * @see elm_diskselector_clear()
24173 * @see elm_diskselector_item_append()
24174 * @see elm_diskselector_item_del_cb_set()
24176 * @ingroup Diskselector
24178 EAPI void elm_diskselector_item_del(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24181 * Set the function called when a diskselector item is freed.
24183 * @param it The item to set the callback on
24184 * @param func The function called
24186 * If there is a @p func, then it will be called prior item's memory release.
24187 * That will be called with the following arguments:
24189 * @li item's Evas object;
24192 * This way, a data associated to a diskselector item could be properly
24195 * @ingroup Diskselector
24197 EAPI void elm_diskselector_item_del_cb_set(Elm_Diskselector_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
24200 * Get the data associated to the item.
24202 * @param it The diskselector item
24203 * @return The data associated to @p it
24205 * The return value is a pointer to data associated to @p item when it was
24206 * created, with function elm_diskselector_item_append(). If no data
24207 * was passed as argument, it will return @c NULL.
24209 * @see elm_diskselector_item_append()
24211 * @ingroup Diskselector
24213 EAPI void *elm_diskselector_item_data_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24216 * Set the icon associated to the item.
24218 * @param it The diskselector item
24219 * @param icon The icon object to associate with @p it
24221 * The icon object to use at left side of the item. An
24222 * icon can be any Evas object, but usually it is an icon created
24223 * with elm_icon_add().
24225 * Once the icon object is set, a previously set one will be deleted.
24226 * @warning Setting the same icon for two items will cause the icon to
24227 * dissapear from the first item.
24229 * If an icon was passed as argument on item creation, with function
24230 * elm_diskselector_item_append(), it will be already
24231 * associated to the item.
24233 * @see elm_diskselector_item_append()
24234 * @see elm_diskselector_item_icon_get()
24236 * @ingroup Diskselector
24238 EAPI void elm_diskselector_item_icon_set(Elm_Diskselector_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
24241 * Get the icon associated to the item.
24243 * @param it The diskselector item
24244 * @return The icon associated to @p it
24246 * The return value is a pointer to the icon associated to @p item when it was
24247 * created, with function elm_diskselector_item_append(), or later
24248 * with function elm_diskselector_item_icon_set. If no icon
24249 * was passed as argument, it will return @c NULL.
24251 * @see elm_diskselector_item_append()
24252 * @see elm_diskselector_item_icon_set()
24254 * @ingroup Diskselector
24256 EAPI Evas_Object *elm_diskselector_item_icon_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24259 * Set the label of item.
24261 * @param it The item of diskselector.
24262 * @param label The label of item.
24264 * The label to be displayed by the item.
24266 * If no icon is set, label will be centered on item position, otherwise
24267 * the icon will be placed at left of the label, that will be shifted
24270 * An item with label "January" would be displayed on side position as
24271 * "Jan" if max length is set to 3 with function
24272 * elm_diskselector_side_label_lenght_set(), or "Janu", if this property
24275 * When this @p item is selected, the entire label will be displayed,
24276 * except for width restrictions.
24277 * In this case label will be cropped and "..." will be concatenated,
24278 * but only for display purposes. It will keep the entire string, so
24279 * if diskselector is resized the remaining characters will be displayed.
24281 * If a label was passed as argument on item creation, with function
24282 * elm_diskselector_item_append(), it will be already
24283 * displayed by the item.
24285 * @see elm_diskselector_side_label_lenght_set()
24286 * @see elm_diskselector_item_label_get()
24287 * @see elm_diskselector_item_append()
24289 * @ingroup Diskselector
24291 EAPI void elm_diskselector_item_label_set(Elm_Diskselector_Item *item, const char *label) EINA_ARG_NONNULL(1);
24294 * Get the label of item.
24296 * @param it The item of diskselector.
24297 * @return The label of item.
24299 * The return value is a pointer to the label associated to @p item when it was
24300 * created, with function elm_diskselector_item_append(), or later
24301 * with function elm_diskselector_item_label_set. If no label
24302 * was passed as argument, it will return @c NULL.
24304 * @see elm_diskselector_item_label_set() for more details.
24305 * @see elm_diskselector_item_append()
24307 * @ingroup Diskselector
24309 EAPI const char *elm_diskselector_item_label_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24312 * Get the selected item.
24314 * @param obj The diskselector object.
24315 * @return The selected diskselector item.
24317 * The selected item can be unselected with function
24318 * elm_diskselector_item_selected_set(), and the first item of
24319 * diskselector will be selected.
24321 * The selected item always will be centered on diskselector, with
24322 * full label displayed, i.e., max lenght set to side labels won't
24323 * apply on the selected item. More details on
24324 * elm_diskselector_side_label_length_set().
24326 * @ingroup Diskselector
24328 EAPI Elm_Diskselector_Item *elm_diskselector_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24331 * Set the selected state of an item.
24333 * @param it The diskselector item
24334 * @param selected The selected state
24336 * This sets the selected state of the given item @p it.
24337 * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
24339 * If a new item is selected the previosly selected will be unselected.
24340 * Previoulsy selected item can be get with function
24341 * elm_diskselector_selected_item_get().
24343 * If the item @p it is unselected, the first item of diskselector will
24346 * Selected items will be visible on center position of diskselector.
24347 * So if it was on another position before selected, or was invisible,
24348 * diskselector will animate items until the selected item reaches center
24351 * @see elm_diskselector_item_selected_get()
24352 * @see elm_diskselector_selected_item_get()
24354 * @ingroup Diskselector
24356 EAPI void elm_diskselector_item_selected_set(Elm_Diskselector_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
24359 * Get whether the @p item is selected or not.
24361 * @param it The diskselector item.
24362 * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
24363 * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
24365 * @see elm_diskselector_selected_item_set() for details.
24366 * @see elm_diskselector_item_selected_get()
24368 * @ingroup Diskselector
24370 EAPI Eina_Bool elm_diskselector_item_selected_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24373 * Get the first item of the diskselector.
24375 * @param obj The diskselector object.
24376 * @return The first item, or @c NULL if none.
24378 * The list of items follows append order. So it will return the first
24379 * item appended to the widget that wasn't deleted.
24381 * @see elm_diskselector_item_append()
24382 * @see elm_diskselector_items_get()
24384 * @ingroup Diskselector
24386 EAPI Elm_Diskselector_Item *elm_diskselector_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24389 * Get the last item of the diskselector.
24391 * @param obj The diskselector object.
24392 * @return The last item, or @c NULL if none.
24394 * The list of items follows append order. So it will return last first
24395 * item appended to the widget that wasn't deleted.
24397 * @see elm_diskselector_item_append()
24398 * @see elm_diskselector_items_get()
24400 * @ingroup Diskselector
24402 EAPI Elm_Diskselector_Item *elm_diskselector_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24405 * Get the item before @p item in diskselector.
24407 * @param it The diskselector item.
24408 * @return The item before @p item, or @c NULL if none or on failure.
24410 * The list of items follows append order. So it will return item appended
24411 * just before @p item and that wasn't deleted.
24413 * If it is the first item, @c NULL will be returned.
24414 * First item can be get by elm_diskselector_first_item_get().
24416 * @see elm_diskselector_item_append()
24417 * @see elm_diskselector_items_get()
24419 * @ingroup Diskselector
24421 EAPI Elm_Diskselector_Item *elm_diskselector_item_prev_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24424 * Get the item after @p item in diskselector.
24426 * @param it The diskselector item.
24427 * @return The item after @p item, or @c NULL if none or on failure.
24429 * The list of items follows append order. So it will return item appended
24430 * just after @p item and that wasn't deleted.
24432 * If it is the last item, @c NULL will be returned.
24433 * Last item can be get by elm_diskselector_last_item_get().
24435 * @see elm_diskselector_item_append()
24436 * @see elm_diskselector_items_get()
24438 * @ingroup Diskselector
24440 EAPI Elm_Diskselector_Item *elm_diskselector_item_next_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24443 * Set the text to be shown in the diskselector item.
24445 * @param item Target item
24446 * @param text The text to set in the content
24448 * Setup the text as tooltip to object. The item can have only one tooltip,
24449 * so any previous tooltip data is removed.
24451 * @see elm_object_tooltip_text_set() for more details.
24453 * @ingroup Diskselector
24455 EAPI void elm_diskselector_item_tooltip_text_set(Elm_Diskselector_Item *item, const char *text) EINA_ARG_NONNULL(1);
24458 * Set the content to be shown in the tooltip item.
24460 * Setup the tooltip to item. The item can have only one tooltip,
24461 * so any previous tooltip data is removed. @p func(with @p data) will
24462 * be called every time that need show the tooltip and it should
24463 * return a valid Evas_Object. This object is then managed fully by
24464 * tooltip system and is deleted when the tooltip is gone.
24466 * @param item the diskselector item being attached a tooltip.
24467 * @param func the function used to create the tooltip contents.
24468 * @param data what to provide to @a func as callback data/context.
24469 * @param del_cb called when data is not needed anymore, either when
24470 * another callback replaces @p func, the tooltip is unset with
24471 * elm_diskselector_item_tooltip_unset() or the owner @a item
24472 * dies. This callback receives as the first parameter the
24473 * given @a data, and @c event_info is the item.
24475 * @see elm_object_tooltip_content_cb_set() for more details.
24477 * @ingroup Diskselector
24479 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);
24482 * Unset tooltip from item.
24484 * @param item diskselector item to remove previously set tooltip.
24486 * Remove tooltip from item. The callback provided as del_cb to
24487 * elm_diskselector_item_tooltip_content_cb_set() will be called to notify
24488 * it is not used anymore.
24490 * @see elm_object_tooltip_unset() for more details.
24491 * @see elm_diskselector_item_tooltip_content_cb_set()
24493 * @ingroup Diskselector
24495 EAPI void elm_diskselector_item_tooltip_unset(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24499 * Sets a different style for this item tooltip.
24501 * @note before you set a style you should define a tooltip with
24502 * elm_diskselector_item_tooltip_content_cb_set() or
24503 * elm_diskselector_item_tooltip_text_set()
24505 * @param item diskselector item with tooltip already set.
24506 * @param style the theme style to use (default, transparent, ...)
24508 * @see elm_object_tooltip_style_set() for more details.
24510 * @ingroup Diskselector
24512 EAPI void elm_diskselector_item_tooltip_style_set(Elm_Diskselector_Item *item, const char *style) EINA_ARG_NONNULL(1);
24515 * Get the style for this item tooltip.
24517 * @param item diskselector item with tooltip already set.
24518 * @return style the theme style in use, defaults to "default". If the
24519 * object does not have a tooltip set, then NULL is returned.
24521 * @see elm_object_tooltip_style_get() for more details.
24522 * @see elm_diskselector_item_tooltip_style_set()
24524 * @ingroup Diskselector
24526 EAPI const char *elm_diskselector_item_tooltip_style_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24529 * Set the cursor to be shown when mouse is over the diskselector item
24531 * @param item Target item
24532 * @param cursor the cursor name to be used.
24534 * @see elm_object_cursor_set() for more details.
24536 * @ingroup Diskselector
24538 EAPI void elm_diskselector_item_cursor_set(Elm_Diskselector_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
24541 * Get the cursor to be shown when mouse is over the diskselector item
24543 * @param item diskselector item with cursor already set.
24544 * @return the cursor name.
24546 * @see elm_object_cursor_get() for more details.
24547 * @see elm_diskselector_cursor_set()
24549 * @ingroup Diskselector
24551 EAPI const char *elm_diskselector_item_cursor_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24555 * Unset the cursor to be shown when mouse is over the diskselector item
24557 * @param item Target item
24559 * @see elm_object_cursor_unset() for more details.
24560 * @see elm_diskselector_cursor_set()
24562 * @ingroup Diskselector
24564 EAPI void elm_diskselector_item_cursor_unset(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24567 * Sets a different style for this item cursor.
24569 * @note before you set a style you should define a cursor with
24570 * elm_diskselector_item_cursor_set()
24572 * @param item diskselector item with cursor already set.
24573 * @param style the theme style to use (default, transparent, ...)
24575 * @see elm_object_cursor_style_set() for more details.
24577 * @ingroup Diskselector
24579 EAPI void elm_diskselector_item_cursor_style_set(Elm_Diskselector_Item *item, const char *style) EINA_ARG_NONNULL(1);
24583 * Get the style for this item cursor.
24585 * @param item diskselector item with cursor already set.
24586 * @return style the theme style in use, defaults to "default". If the
24587 * object does not have a cursor set, then @c NULL is returned.
24589 * @see elm_object_cursor_style_get() for more details.
24590 * @see elm_diskselector_item_cursor_style_set()
24592 * @ingroup Diskselector
24594 EAPI const char *elm_diskselector_item_cursor_style_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24598 * Set if the cursor set should be searched on the theme or should use
24599 * the provided by the engine, only.
24601 * @note before you set if should look on theme you should define a cursor
24602 * with elm_diskselector_item_cursor_set().
24603 * By default it will only look for cursors provided by the engine.
24605 * @param item widget item with cursor already set.
24606 * @param engine_only boolean to define if cursors set with
24607 * elm_diskselector_item_cursor_set() should be searched only
24608 * between cursors provided by the engine or searched on widget's
24611 * @see elm_object_cursor_engine_only_set() for more details.
24613 * @ingroup Diskselector
24615 EAPI void elm_diskselector_item_cursor_engine_only_set(Elm_Diskselector_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
24618 * Get the cursor engine only usage for this item cursor.
24620 * @param item widget item with cursor already set.
24621 * @return engine_only boolean to define it cursors should be looked only
24622 * between the provided by the engine or searched on widget's theme as well.
24623 * If the item does not have a cursor set, then @c EINA_FALSE is returned.
24625 * @see elm_object_cursor_engine_only_get() for more details.
24626 * @see elm_diskselector_item_cursor_engine_only_set()
24628 * @ingroup Diskselector
24630 EAPI Eina_Bool elm_diskselector_item_cursor_engine_only_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24637 * @defgroup Colorselector Colorselector
24641 * @image html img/widget/colorselector/preview-00.png
24642 * @image latex img/widget/colorselector/preview-00.eps
24644 * @brief Widget for user to select a color.
24646 * Signals that you can add callbacks for are:
24647 * "changed" - When the color value changes(event_info is NULL).
24649 * See @ref tutorial_colorselector.
24652 * @brief Add a new colorselector to the parent
24654 * @param parent The parent object
24655 * @return The new object or NULL if it cannot be created
24657 * @ingroup Colorselector
24659 EAPI Evas_Object *elm_colorselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24661 * Set a color for the colorselector
24663 * @param obj Colorselector object
24664 * @param r r-value of color
24665 * @param g g-value of color
24666 * @param b b-value of color
24667 * @param a a-value of color
24669 * @ingroup Colorselector
24671 EAPI void elm_colorselector_color_set(Evas_Object *obj, int r, int g , int b, int a) EINA_ARG_NONNULL(1);
24673 * Get a color from the colorselector
24675 * @param obj Colorselector object
24676 * @param r integer pointer for r-value of color
24677 * @param g integer pointer for g-value of color
24678 * @param b integer pointer for b-value of color
24679 * @param a integer pointer for a-value of color
24681 * @ingroup Colorselector
24683 EAPI void elm_colorselector_color_get(const Evas_Object *obj, int *r, int *g , int *b, int *a) EINA_ARG_NONNULL(1);
24689 * @defgroup Ctxpopup Ctxpopup
24691 * @image html img/widget/ctxpopup/preview-00.png
24692 * @image latex img/widget/ctxpopup/preview-00.eps
24694 * @brief Context popup widet.
24696 * A ctxpopup is a widget that, when shown, pops up a list of items.
24697 * It automatically chooses an area inside its parent object's view
24698 * (set via elm_ctxpopup_add() and elm_ctxpopup_hover_parent_set()) to
24699 * optimally fit into it. In the default theme, it will also point an
24700 * arrow to it's top left position at the time one shows it. Ctxpopup
24701 * items have a label and/or an icon. It is intended for a small
24702 * number of items (hence the use of list, not genlist).
24704 * @note Ctxpopup is a especialization of @ref Hover.
24706 * Signals that you can add callbacks for are:
24707 * "dismissed" - the ctxpopup was dismissed
24709 * @ref tutorial_ctxpopup shows the usage of a good deal of the API.
24712 typedef enum _Elm_Ctxpopup_Direction
24714 ELM_CTXPOPUP_DIRECTION_DOWN, /**< ctxpopup show appear below clicked
24716 ELM_CTXPOPUP_DIRECTION_RIGHT, /**< ctxpopup show appear to the right of
24717 the clicked area */
24718 ELM_CTXPOPUP_DIRECTION_LEFT, /**< ctxpopup show appear to the left of
24719 the clicked area */
24720 ELM_CTXPOPUP_DIRECTION_UP, /**< ctxpopup show appear above the clicked
24722 } Elm_Ctxpopup_Direction;
24725 * @brief Add a new Ctxpopup object to the parent.
24727 * @param parent Parent object
24728 * @return New object or @c NULL, if it cannot be created
24730 EAPI Evas_Object *elm_ctxpopup_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24732 * @brief Set the Ctxpopup's parent
24734 * @param obj The ctxpopup object
24735 * @param area The parent to use
24737 * Set the parent object.
24739 * @note elm_ctxpopup_add() will automatically call this function
24740 * with its @c parent argument.
24742 * @see elm_ctxpopup_add()
24743 * @see elm_hover_parent_set()
24745 EAPI void elm_ctxpopup_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1, 2);
24747 * @brief Get the Ctxpopup's parent
24749 * @param obj The ctxpopup object
24751 * @see elm_ctxpopup_hover_parent_set() for more information
24753 EAPI Evas_Object *elm_ctxpopup_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24755 * @brief Clear all items in the given ctxpopup object.
24757 * @param obj Ctxpopup object
24759 EAPI void elm_ctxpopup_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
24761 * @brief Change the ctxpopup's orientation to horizontal or vertical.
24763 * @param obj Ctxpopup object
24764 * @param horizontal @c EINA_TRUE for horizontal mode, @c EINA_FALSE for vertical
24766 EAPI void elm_ctxpopup_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
24768 * @brief Get the value of current ctxpopup object's orientation.
24770 * @param obj Ctxpopup object
24771 * @return @c EINA_TRUE for horizontal mode, @c EINA_FALSE for vertical mode (or errors)
24773 * @see elm_ctxpopup_horizontal_set()
24775 EAPI Eina_Bool elm_ctxpopup_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24777 * @brief Add a new item to a ctxpopup object.
24779 * @param obj Ctxpopup object
24780 * @param icon Icon to be set on new item
24781 * @param label The Label of the new item
24782 * @param func Convenience function called when item selected
24783 * @param data Data passed to @p func
24784 * @return A handle to the item added or @c NULL, on errors
24786 * @warning Ctxpopup can't hold both an item list and a content at the same
24787 * time. When an item is added, any previous content will be removed.
24789 * @see elm_ctxpopup_content_set()
24791 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);
24793 * @brief Delete the given item in a ctxpopup object.
24795 * @param it Ctxpopup item to be deleted
24797 * @see elm_ctxpopup_item_append()
24799 EAPI void elm_ctxpopup_item_del(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
24801 * @brief Set the ctxpopup item's state as disabled or enabled.
24803 * @param it Ctxpopup item to be enabled/disabled
24804 * @param disabled @c EINA_TRUE to disable it, @c EINA_FALSE to enable it
24806 * When disabled the item is greyed out to indicate it's state.
24808 EAPI void elm_ctxpopup_item_disabled_set(Elm_Object_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1);
24810 * @brief Get the ctxpopup item's disabled/enabled state.
24812 * @param it Ctxpopup item to be enabled/disabled
24813 * @return disabled @c EINA_TRUE, if disabled, @c EINA_FALSE otherwise
24815 * @see elm_ctxpopup_item_disabled_set()
24817 EAPI Eina_Bool elm_ctxpopup_item_disabled_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
24819 * @brief Get the icon object for the given ctxpopup item.
24821 * @param it Ctxpopup item
24822 * @return icon object or @c NULL, if the item does not have icon or an error
24825 * @see elm_ctxpopup_item_append()
24826 * @see elm_ctxpopup_item_icon_set()
24828 EAPI Evas_Object *elm_ctxpopup_item_icon_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
24830 * @brief Sets the side icon associated with the ctxpopup item
24832 * @param it Ctxpopup item
24833 * @param icon Icon object to be set
24835 * Once the icon object is set, a previously set one will be deleted.
24836 * @warning Setting the same icon for two items will cause the icon to
24837 * dissapear from the first item.
24839 * @see elm_ctxpopup_item_append()
24841 EAPI void elm_ctxpopup_item_icon_set(Elm_Object_Item *it, Evas_Object *icon) EINA_ARG_NONNULL(1);
24843 * @brief Get the label for the given ctxpopup item.
24845 * @param it Ctxpopup item
24846 * @return label string or @c NULL, if the item does not have label or an
24849 * @see elm_ctxpopup_item_append()
24850 * @see elm_ctxpopup_item_label_set()
24852 EAPI const char *elm_ctxpopup_item_label_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
24854 * @brief (Re)set the label on the given ctxpopup item.
24856 * @param it Ctxpopup item
24857 * @param label String to set as label
24859 EAPI void elm_ctxpopup_item_label_set(Elm_Object_Item *it, const char *label) EINA_ARG_NONNULL(1);
24861 * @brief Set an elm widget as the content of the ctxpopup.
24863 * @param obj Ctxpopup object
24864 * @param content Content to be swallowed
24866 * If the content object is already set, a previous one will bedeleted. If
24867 * you want to keep that old content object, use the
24868 * elm_ctxpopup_content_unset() function.
24870 * @deprecated use elm_object_content_set()
24872 * @warning Ctxpopup can't hold both a item list and a content at the same
24873 * time. When a content is set, any previous items will be removed.
24875 EINA_DEPRECATED EAPI void elm_ctxpopup_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1, 2);
24877 * @brief Unset the ctxpopup content
24879 * @param obj Ctxpopup object
24880 * @return The content that was being used
24882 * Unparent and return the content object which was set for this widget.
24884 * @deprecated use elm_object_content_unset()
24886 * @see elm_ctxpopup_content_set()
24888 EINA_DEPRECATED EAPI Evas_Object *elm_ctxpopup_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24890 * @brief Set the direction priority of a ctxpopup.
24892 * @param obj Ctxpopup object
24893 * @param first 1st priority of direction
24894 * @param second 2nd priority of direction
24895 * @param third 3th priority of direction
24896 * @param fourth 4th priority of direction
24898 * This functions gives a chance to user to set the priority of ctxpopup
24899 * showing direction. This doesn't guarantee the ctxpopup will appear in the
24900 * requested direction.
24902 * @see Elm_Ctxpopup_Direction
24904 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);
24906 * @brief Get the direction priority of a ctxpopup.
24908 * @param obj Ctxpopup object
24909 * @param first 1st priority of direction to be returned
24910 * @param second 2nd priority of direction to be returned
24911 * @param third 3th priority of direction to be returned
24912 * @param fourth 4th priority of direction to be returned
24914 * @see elm_ctxpopup_direction_priority_set() for more information.
24916 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);
24924 * @defgroup Transit Transit
24925 * @ingroup Elementary
24927 * Transit is designed to apply various animated transition effects to @c
24928 * Evas_Object, such like translation, rotation, etc. For using these
24929 * effects, create an @ref Elm_Transit and add the desired transition effects.
24931 * Once the effects are added into transit, they will be automatically
24932 * managed (their callback will be called until the duration is ended, and
24933 * they will be deleted on completion).
24937 * Elm_Transit *trans = elm_transit_add();
24938 * elm_transit_object_add(trans, obj);
24939 * elm_transit_effect_translation_add(trans, 0, 0, 280, 280
24940 * elm_transit_duration_set(transit, 1);
24941 * elm_transit_auto_reverse_set(transit, EINA_TRUE);
24942 * elm_transit_tween_mode_set(transit, ELM_TRANSIT_TWEEN_MODE_DECELERATE);
24943 * elm_transit_repeat_times_set(transit, 3);
24946 * Some transition effects are used to change the properties of objects. They
24948 * @li @ref elm_transit_effect_translation_add
24949 * @li @ref elm_transit_effect_color_add
24950 * @li @ref elm_transit_effect_rotation_add
24951 * @li @ref elm_transit_effect_wipe_add
24952 * @li @ref elm_transit_effect_zoom_add
24953 * @li @ref elm_transit_effect_resizing_add
24955 * Other transition effects are used to make one object disappear and another
24956 * object appear on its old place. These effects are:
24958 * @li @ref elm_transit_effect_flip_add
24959 * @li @ref elm_transit_effect_resizable_flip_add
24960 * @li @ref elm_transit_effect_fade_add
24961 * @li @ref elm_transit_effect_blend_add
24963 * It's also possible to make a transition chain with @ref
24964 * elm_transit_chain_transit_add.
24966 * @warning We strongly recommend to use elm_transit just when edje can not do
24967 * the trick. Edje has more advantage than Elm_Transit, it has more flexibility and
24968 * animations can be manipulated inside the theme.
24970 * List of examples:
24971 * @li @ref transit_example_01_explained
24972 * @li @ref transit_example_02_explained
24973 * @li @ref transit_example_03_c
24974 * @li @ref transit_example_04_c
24980 * @enum Elm_Transit_Tween_Mode
24982 * The type of acceleration used in the transition.
24986 ELM_TRANSIT_TWEEN_MODE_LINEAR, /**< Constant speed */
24987 ELM_TRANSIT_TWEEN_MODE_SINUSOIDAL, /**< Starts slow, increase speed
24988 over time, then decrease again
24990 ELM_TRANSIT_TWEEN_MODE_DECELERATE, /**< Starts fast and decrease
24992 ELM_TRANSIT_TWEEN_MODE_ACCELERATE /**< Starts slow and increase speed
24994 } Elm_Transit_Tween_Mode;
24997 * @enum Elm_Transit_Effect_Flip_Axis
24999 * The axis where flip effect should be applied.
25003 ELM_TRANSIT_EFFECT_FLIP_AXIS_X, /**< Flip on X axis */
25004 ELM_TRANSIT_EFFECT_FLIP_AXIS_Y /**< Flip on Y axis */
25005 } Elm_Transit_Effect_Flip_Axis;
25007 * @enum Elm_Transit_Effect_Wipe_Dir
25009 * The direction where the wipe effect should occur.
25013 ELM_TRANSIT_EFFECT_WIPE_DIR_LEFT, /**< Wipe to the left */
25014 ELM_TRANSIT_EFFECT_WIPE_DIR_RIGHT, /**< Wipe to the right */
25015 ELM_TRANSIT_EFFECT_WIPE_DIR_UP, /**< Wipe up */
25016 ELM_TRANSIT_EFFECT_WIPE_DIR_DOWN /**< Wipe down */
25017 } Elm_Transit_Effect_Wipe_Dir;
25018 /** @enum Elm_Transit_Effect_Wipe_Type
25020 * Whether the wipe effect should show or hide the object.
25024 ELM_TRANSIT_EFFECT_WIPE_TYPE_HIDE, /**< Hide the object during the
25026 ELM_TRANSIT_EFFECT_WIPE_TYPE_SHOW /**< Show the object during the
25028 } Elm_Transit_Effect_Wipe_Type;
25031 * @typedef Elm_Transit
25033 * The Transit created with elm_transit_add(). This type has the information
25034 * about the objects which the transition will be applied, and the
25035 * transition effects that will be used. It also contains info about
25036 * duration, number of repetitions, auto-reverse, etc.
25038 typedef struct _Elm_Transit Elm_Transit;
25039 typedef void Elm_Transit_Effect;
25041 * @typedef Elm_Transit_Effect_Transition_Cb
25043 * Transition callback called for this effect on each transition iteration.
25045 typedef void (*Elm_Transit_Effect_Transition_Cb) (Elm_Transit_Effect *effect, Elm_Transit *transit, double progress);
25047 * Elm_Transit_Effect_End_Cb
25049 * Transition callback called for this effect when the transition is over.
25051 typedef void (*Elm_Transit_Effect_End_Cb) (Elm_Transit_Effect *effect, Elm_Transit *transit);
25054 * Elm_Transit_Del_Cb
25056 * A callback called when the transit is deleted.
25058 typedef void (*Elm_Transit_Del_Cb) (void *data, Elm_Transit *transit);
25063 * @note Is not necessary to delete the transit object, it will be deleted at
25064 * the end of its operation.
25065 * @note The transit will start playing when the program enter in the main loop, is not
25066 * necessary to give a start to the transit.
25068 * @return The transit object.
25072 EAPI Elm_Transit *elm_transit_add(void);
25075 * Stops the animation and delete the @p transit object.
25077 * Call this function if you wants to stop the animation before the duration
25078 * time. Make sure the @p transit object is still alive with
25079 * elm_transit_del_cb_set() function.
25080 * All added effects will be deleted, calling its repective data_free_cb
25081 * functions. The function setted by elm_transit_del_cb_set() will be called.
25083 * @see elm_transit_del_cb_set()
25085 * @param transit The transit object to be deleted.
25088 * @warning Just call this function if you are sure the transit is alive.
25090 EAPI void elm_transit_del(Elm_Transit *transit) EINA_ARG_NONNULL(1);
25093 * Add a new effect to the transit.
25095 * @note The cb function and the data are the key to the effect. If you try to
25096 * add an already added effect, nothing is done.
25097 * @note After the first addition of an effect in @p transit, if its
25098 * effect list become empty again, the @p transit will be killed by
25099 * elm_transit_del(transit) function.
25103 * Elm_Transit *transit = elm_transit_add();
25104 * elm_transit_effect_add(transit,
25105 * elm_transit_effect_blend_op,
25106 * elm_transit_effect_blend_context_new(),
25107 * elm_transit_effect_blend_context_free);
25110 * @param transit The transit object.
25111 * @param transition_cb The operation function. It is called when the
25112 * animation begins, it is the function that actually performs the animation.
25113 * It is called with the @p data, @p transit and the time progression of the
25114 * animation (a double value between 0.0 and 1.0).
25115 * @param effect The context data of the effect.
25116 * @param end_cb The function to free the context data, it will be called
25117 * at the end of the effect, it must finalize the animation and free the
25121 * @warning The transit free the context data at the and of the transition with
25122 * the data_free_cb function, do not use the context data in another transit.
25124 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);
25127 * Delete an added effect.
25129 * This function will remove the effect from the @p transit, calling the
25130 * data_free_cb to free the @p data.
25132 * @see elm_transit_effect_add()
25134 * @note If the effect is not found, nothing is done.
25135 * @note If the effect list become empty, this function will call
25136 * elm_transit_del(transit), that is, it will kill the @p transit.
25138 * @param transit The transit object.
25139 * @param transition_cb The operation function.
25140 * @param effect The context data of the effect.
25144 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);
25147 * Add new object to apply the effects.
25149 * @note After the first addition of an object in @p transit, if its
25150 * object list become empty again, the @p transit will be killed by
25151 * elm_transit_del(transit) function.
25152 * @note If the @p obj belongs to another transit, the @p obj will be
25153 * removed from it and it will only belong to the @p transit. If the old
25154 * transit stays without objects, it will die.
25155 * @note When you add an object into the @p transit, its state from
25156 * evas_object_pass_events_get(obj) is saved, and it is applied when the
25157 * transit ends, if you change this state whith evas_object_pass_events_set()
25158 * after add the object, this state will change again when @p transit stops to
25161 * @param transit The transit object.
25162 * @param obj Object to be animated.
25165 * @warning It is not allowed to add a new object after transit begins to go.
25167 EAPI void elm_transit_object_add(Elm_Transit *transit, Evas_Object *obj) EINA_ARG_NONNULL(1, 2);
25170 * Removes an added object from the transit.
25172 * @note If the @p obj is not in the @p transit, nothing is done.
25173 * @note If the list become empty, this function will call
25174 * elm_transit_del(transit), that is, it will kill the @p transit.
25176 * @param transit The transit object.
25177 * @param obj Object to be removed from @p transit.
25180 * @warning It is not allowed to remove objects after transit begins to go.
25182 EAPI void elm_transit_object_remove(Elm_Transit *transit, Evas_Object *obj) EINA_ARG_NONNULL(1, 2);
25185 * Get the objects of the transit.
25187 * @param transit The transit object.
25188 * @return a Eina_List with the objects from the transit.
25192 EAPI const Eina_List *elm_transit_objects_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
25195 * Enable/disable keeping up the objects states.
25196 * If it is not kept, the objects states will be reset when transition ends.
25198 * @note @p transit can not be NULL.
25199 * @note One state includes geometry, color, map data.
25201 * @param transit The transit object.
25202 * @param state_keep Keeping or Non Keeping.
25206 EAPI void elm_transit_objects_final_state_keep_set(Elm_Transit *transit, Eina_Bool state_keep) EINA_ARG_NONNULL(1);
25209 * Get a value whether the objects states will be reset or not.
25211 * @note @p transit can not be NULL
25213 * @see elm_transit_objects_final_state_keep_set()
25215 * @param transit The transit object.
25216 * @return EINA_TRUE means the states of the objects will be reset.
25217 * If @p transit is NULL, EINA_FALSE is returned
25221 EAPI Eina_Bool elm_transit_objects_final_state_keep_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
25224 * Set the event enabled when transit is operating.
25226 * If @p enabled is EINA_TRUE, the objects of the transit will receives
25227 * events from mouse and keyboard during the animation.
25228 * @note When you add an object with elm_transit_object_add(), its state from
25229 * evas_object_pass_events_get(obj) is saved, and it is applied when the
25230 * transit ends, if you change this state with evas_object_pass_events_set()
25231 * after adding the object, this state will change again when @p transit stops
25234 * @param transit The transit object.
25235 * @param enabled Events are received when enabled is @c EINA_TRUE, and
25236 * ignored otherwise.
25240 EAPI void elm_transit_event_enabled_set(Elm_Transit *transit, Eina_Bool enabled) EINA_ARG_NONNULL(1);
25243 * Get the value of event enabled status.
25245 * @see elm_transit_event_enabled_set()
25247 * @param transit The Transit object
25248 * @return EINA_TRUE, when event is enabled. If @p transit is NULL
25249 * EINA_FALSE is returned
25253 EAPI Eina_Bool elm_transit_event_enabled_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
25256 * Set the user-callback function when the transit is deleted.
25258 * @note Using this function twice will overwrite the first function setted.
25259 * @note the @p transit object will be deleted after call @p cb function.
25261 * @param transit The transit object.
25262 * @param cb Callback function pointer. This function will be called before
25263 * the deletion of the transit.
25264 * @param data Callback funtion user data. It is the @p op parameter.
25268 EAPI void elm_transit_del_cb_set(Elm_Transit *transit, Elm_Transit_Del_Cb cb, void *data) EINA_ARG_NONNULL(1);
25271 * Set reverse effect automatically.
25273 * If auto reverse is setted, after running the effects with the progress
25274 * parameter from 0 to 1, it will call the effecs again with the progress
25275 * from 1 to 0. The transit will last for a time iqual to (2 * duration * repeat),
25276 * where the duration was setted with the function elm_transit_add and
25277 * the repeat with the function elm_transit_repeat_times_set().
25279 * @param transit The transit object.
25280 * @param reverse EINA_TRUE means the auto_reverse is on.
25284 EAPI void elm_transit_auto_reverse_set(Elm_Transit *transit, Eina_Bool reverse) EINA_ARG_NONNULL(1);
25287 * Get if the auto reverse is on.
25289 * @see elm_transit_auto_reverse_set()
25291 * @param transit The transit object.
25292 * @return EINA_TRUE means auto reverse is on. If @p transit is NULL
25293 * EINA_FALSE is returned
25297 EAPI Eina_Bool elm_transit_auto_reverse_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
25300 * Set the transit repeat count. Effect will be repeated by repeat count.
25302 * This function sets the number of repetition the transit will run after
25303 * the first one, that is, if @p repeat is 1, the transit will run 2 times.
25304 * If the @p repeat is a negative number, it will repeat infinite times.
25306 * @note If this function is called during the transit execution, the transit
25307 * will run @p repeat times, ignoring the times it already performed.
25309 * @param transit The transit object
25310 * @param repeat Repeat count
25314 EAPI void elm_transit_repeat_times_set(Elm_Transit *transit, int repeat) EINA_ARG_NONNULL(1);
25317 * Get the transit repeat count.
25319 * @see elm_transit_repeat_times_set()
25321 * @param transit The Transit object.
25322 * @return The repeat count. If @p transit is NULL
25327 EAPI int elm_transit_repeat_times_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
25330 * Set the transit animation acceleration type.
25332 * This function sets the tween mode of the transit that can be:
25333 * ELM_TRANSIT_TWEEN_MODE_LINEAR - The default mode.
25334 * ELM_TRANSIT_TWEEN_MODE_SINUSOIDAL - Starts in accelerate mode and ends decelerating.
25335 * ELM_TRANSIT_TWEEN_MODE_DECELERATE - The animation will be slowed over time.
25336 * ELM_TRANSIT_TWEEN_MODE_ACCELERATE - The animation will accelerate over time.
25338 * @param transit The transit object.
25339 * @param tween_mode The tween type.
25343 EAPI void elm_transit_tween_mode_set(Elm_Transit *transit, Elm_Transit_Tween_Mode tween_mode) EINA_ARG_NONNULL(1);
25346 * Get the transit animation acceleration type.
25348 * @note @p transit can not be NULL
25350 * @param transit The transit object.
25351 * @return The tween type. If @p transit is NULL
25352 * ELM_TRANSIT_TWEEN_MODE_LINEAR is returned.
25356 EAPI Elm_Transit_Tween_Mode elm_transit_tween_mode_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
25359 * Set the transit animation time
25361 * @note @p transit can not be NULL
25363 * @param transit The transit object.
25364 * @param duration The animation time.
25368 EAPI void elm_transit_duration_set(Elm_Transit *transit, double duration) EINA_ARG_NONNULL(1);
25371 * Get the transit animation time
25373 * @note @p transit can not be NULL
25375 * @param transit The transit object.
25377 * @return The transit animation time.
25381 EAPI double elm_transit_duration_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
25384 * Starts the transition.
25385 * Once this API is called, the transit begins to measure the time.
25387 * @note @p transit can not be NULL
25389 * @param transit The transit object.
25393 EAPI void elm_transit_go(Elm_Transit *transit) EINA_ARG_NONNULL(1);
25396 * Pause/Resume the transition.
25398 * If you call elm_transit_go again, the transit will be started from the
25399 * beginning, and will be unpaused.
25401 * @note @p transit can not be NULL
25403 * @param transit The transit object.
25404 * @param paused Whether the transition should be paused or not.
25408 EAPI void elm_transit_paused_set(Elm_Transit *transit, Eina_Bool paused) EINA_ARG_NONNULL(1);
25411 * Get the value of paused status.
25413 * @see elm_transit_paused_set()
25415 * @note @p transit can not be NULL
25417 * @param transit The transit object.
25418 * @return EINA_TRUE means transition is paused. If @p transit is NULL
25419 * EINA_FALSE is returned
25423 EAPI Eina_Bool elm_transit_paused_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
25426 * Get the time progression of the animation (a double value between 0.0 and 1.0).
25428 * The value returned is a fraction (current time / total time). It
25429 * represents the progression position relative to the total.
25431 * @note @p transit can not be NULL
25433 * @param transit The transit object.
25435 * @return The time progression value. If @p transit is NULL
25440 EAPI double elm_transit_progress_value_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
25443 * Makes the chain relationship between two transits.
25445 * @note @p transit can not be NULL. Transit would have multiple chain transits.
25446 * @note @p chain_transit can not be NULL. Chain transits could be chained to the only one transit.
25448 * @param transit The transit object.
25449 * @param chain_transit The chain transit object. This transit will be operated
25450 * after transit is done.
25452 * This function adds @p chain_transit transition to a chain after the @p
25453 * transit, and will be started as soon as @p transit ends. See @ref
25454 * transit_example_02_explained for a full example.
25458 EAPI void elm_transit_chain_transit_add(Elm_Transit *transit, Elm_Transit *chain_transit) EINA_ARG_NONNULL(1, 2);
25461 * Cut off the chain relationship between two transits.
25463 * @note @p transit can not be NULL. Transit would have the chain relationship with @p chain transit.
25464 * @note @p chain_transit can not be NULL. Chain transits should be chained to the @p transit.
25466 * @param transit The transit object.
25467 * @param chain_transit The chain transit object.
25469 * This function remove the @p chain_transit transition from the @p transit.
25473 EAPI void elm_transit_chain_transit_del(Elm_Transit *transit, Elm_Transit *chain_transit) EINA_ARG_NONNULL(1,2);
25476 * Get the current chain transit list.
25478 * @note @p transit can not be NULL.
25480 * @param transit The transit object.
25481 * @return chain transit list.
25485 EAPI Eina_List *elm_transit_chain_transits_get(const Elm_Transit *transit);
25488 * Add the Resizing Effect to Elm_Transit.
25490 * @note This API is one of the facades. It creates resizing effect context
25491 * and add it's required APIs to elm_transit_effect_add.
25493 * @see elm_transit_effect_add()
25495 * @param transit Transit object.
25496 * @param from_w Object width size when effect begins.
25497 * @param from_h Object height size when effect begins.
25498 * @param to_w Object width size when effect ends.
25499 * @param to_h Object height size when effect ends.
25500 * @return Resizing effect context data.
25504 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);
25507 * Add the Translation Effect to Elm_Transit.
25509 * @note This API is one of the facades. It creates translation effect context
25510 * and add it's required APIs to elm_transit_effect_add.
25512 * @see elm_transit_effect_add()
25514 * @param transit Transit object.
25515 * @param from_dx X Position variation when effect begins.
25516 * @param from_dy Y Position variation when effect begins.
25517 * @param to_dx X Position variation when effect ends.
25518 * @param to_dy Y Position variation when effect ends.
25519 * @return Translation effect context data.
25522 * @warning It is highly recommended just create a transit with this effect when
25523 * the window that the objects of the transit belongs has already been created.
25524 * This is because this effect needs the geometry information about the objects,
25525 * and if the window was not created yet, it can get a wrong information.
25527 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);
25530 * Add the Zoom Effect to Elm_Transit.
25532 * @note This API is one of the facades. It creates zoom effect context
25533 * and add it's required APIs to elm_transit_effect_add.
25535 * @see elm_transit_effect_add()
25537 * @param transit Transit object.
25538 * @param from_rate Scale rate when effect begins (1 is current rate).
25539 * @param to_rate Scale rate when effect ends.
25540 * @return Zoom effect context data.
25543 * @warning It is highly recommended just create a transit with this effect when
25544 * the window that the objects of the transit belongs has already been created.
25545 * This is because this effect needs the geometry information about the objects,
25546 * and if the window was not created yet, it can get a wrong information.
25548 EAPI Elm_Transit_Effect *elm_transit_effect_zoom_add(Elm_Transit *transit, float from_rate, float to_rate);
25551 * Add the Flip Effect to Elm_Transit.
25553 * @note This API is one of the facades. It creates flip effect context
25554 * and add it's required APIs to elm_transit_effect_add.
25555 * @note This effect is applied to each pair of objects in the order they are listed
25556 * in the transit list of objects. The first object in the pair will be the
25557 * "front" object and the second will be the "back" object.
25559 * @see elm_transit_effect_add()
25561 * @param transit Transit object.
25562 * @param axis Flipping Axis(X or Y).
25563 * @param cw Flipping Direction. EINA_TRUE is clock-wise.
25564 * @return Flip effect context data.
25567 * @warning It is highly recommended just create a transit with this effect when
25568 * the window that the objects of the transit belongs has already been created.
25569 * This is because this effect needs the geometry information about the objects,
25570 * and if the window was not created yet, it can get a wrong information.
25572 EAPI Elm_Transit_Effect *elm_transit_effect_flip_add(Elm_Transit *transit, Elm_Transit_Effect_Flip_Axis axis, Eina_Bool cw);
25575 * Add the Resizable Flip Effect to Elm_Transit.
25577 * @note This API is one of the facades. It creates resizable flip effect context
25578 * and add it's required APIs to elm_transit_effect_add.
25579 * @note This effect is applied to each pair of objects in the order they are listed
25580 * in the transit list of objects. The first object in the pair will be the
25581 * "front" object and the second will be the "back" object.
25583 * @see elm_transit_effect_add()
25585 * @param transit Transit object.
25586 * @param axis Flipping Axis(X or Y).
25587 * @param cw Flipping Direction. EINA_TRUE is clock-wise.
25588 * @return Resizable flip effect context data.
25591 * @warning It is highly recommended just create a transit with this effect when
25592 * the window that the objects of the transit belongs has already been created.
25593 * This is because this effect needs the geometry information about the objects,
25594 * and if the window was not created yet, it can get a wrong information.
25596 EAPI Elm_Transit_Effect *elm_transit_effect_resizable_flip_add(Elm_Transit *transit, Elm_Transit_Effect_Flip_Axis axis, Eina_Bool cw);
25599 * Add the Wipe Effect to Elm_Transit.
25601 * @note This API is one of the facades. It creates wipe effect context
25602 * and add it's required APIs to elm_transit_effect_add.
25604 * @see elm_transit_effect_add()
25606 * @param transit Transit object.
25607 * @param type Wipe type. Hide or show.
25608 * @param dir Wipe Direction.
25609 * @return Wipe effect context data.
25612 * @warning It is highly recommended just create a transit with this effect when
25613 * the window that the objects of the transit belongs has already been created.
25614 * This is because this effect needs the geometry information about the objects,
25615 * and if the window was not created yet, it can get a wrong information.
25617 EAPI Elm_Transit_Effect *elm_transit_effect_wipe_add(Elm_Transit *transit, Elm_Transit_Effect_Wipe_Type type, Elm_Transit_Effect_Wipe_Dir dir);
25620 * Add the Color Effect to Elm_Transit.
25622 * @note This API is one of the facades. It creates color effect context
25623 * and add it's required APIs to elm_transit_effect_add.
25625 * @see elm_transit_effect_add()
25627 * @param transit Transit object.
25628 * @param from_r RGB R when effect begins.
25629 * @param from_g RGB G when effect begins.
25630 * @param from_b RGB B when effect begins.
25631 * @param from_a RGB A when effect begins.
25632 * @param to_r RGB R when effect ends.
25633 * @param to_g RGB G when effect ends.
25634 * @param to_b RGB B when effect ends.
25635 * @param to_a RGB A when effect ends.
25636 * @return Color effect context data.
25640 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);
25643 * Add the Fade Effect to Elm_Transit.
25645 * @note This API is one of the facades. It creates fade effect context
25646 * and add it's required APIs to elm_transit_effect_add.
25647 * @note This effect is applied to each pair of objects in the order they are listed
25648 * in the transit list of objects. The first object in the pair will be the
25649 * "before" object and the second will be the "after" object.
25651 * @see elm_transit_effect_add()
25653 * @param transit Transit object.
25654 * @return Fade effect context data.
25657 * @warning It is highly recommended just create a transit with this effect when
25658 * the window that the objects of the transit belongs has already been created.
25659 * This is because this effect needs the color information about the objects,
25660 * and if the window was not created yet, it can get a wrong information.
25662 EAPI Elm_Transit_Effect *elm_transit_effect_fade_add(Elm_Transit *transit);
25665 * Add the Blend Effect to Elm_Transit.
25667 * @note This API is one of the facades. It creates blend effect context
25668 * and add it's required APIs to elm_transit_effect_add.
25669 * @note This effect is applied to each pair of objects in the order they are listed
25670 * in the transit list of objects. The first object in the pair will be the
25671 * "before" object and the second will be the "after" object.
25673 * @see elm_transit_effect_add()
25675 * @param transit Transit object.
25676 * @return Blend effect context data.
25679 * @warning It is highly recommended just create a transit with this effect when
25680 * the window that the objects of the transit belongs has already been created.
25681 * This is because this effect needs the color information about the objects,
25682 * and if the window was not created yet, it can get a wrong information.
25684 EAPI Elm_Transit_Effect *elm_transit_effect_blend_add(Elm_Transit *transit);
25687 * Add the Rotation Effect to Elm_Transit.
25689 * @note This API is one of the facades. It creates rotation effect context
25690 * and add it's required APIs to elm_transit_effect_add.
25692 * @see elm_transit_effect_add()
25694 * @param transit Transit object.
25695 * @param from_degree Degree when effect begins.
25696 * @param to_degree Degree when effect is ends.
25697 * @return Rotation effect context data.
25700 * @warning It is highly recommended just create a transit with this effect when
25701 * the window that the objects of the transit belongs has already been created.
25702 * This is because this effect needs the geometry information about the objects,
25703 * and if the window was not created yet, it can get a wrong information.
25705 EAPI Elm_Transit_Effect *elm_transit_effect_rotation_add(Elm_Transit *transit, float from_degree, float to_degree);
25708 * Add the ImageAnimation Effect to Elm_Transit.
25710 * @note This API is one of the facades. It creates image animation effect context
25711 * and add it's required APIs to elm_transit_effect_add.
25712 * The @p images parameter is a list images paths. This list and
25713 * its contents will be deleted at the end of the effect by
25714 * elm_transit_effect_image_animation_context_free() function.
25718 * char buf[PATH_MAX];
25719 * Eina_List *images = NULL;
25720 * Elm_Transit *transi = elm_transit_add();
25722 * snprintf(buf, sizeof(buf), "%s/images/icon_11.png", PACKAGE_DATA_DIR);
25723 * images = eina_list_append(images, eina_stringshare_add(buf));
25725 * snprintf(buf, sizeof(buf), "%s/images/logo_small.png", PACKAGE_DATA_DIR);
25726 * images = eina_list_append(images, eina_stringshare_add(buf));
25727 * elm_transit_effect_image_animation_add(transi, images);
25731 * @see elm_transit_effect_add()
25733 * @param transit Transit object.
25734 * @param images Eina_List of images file paths. This list and
25735 * its contents will be deleted at the end of the effect by
25736 * elm_transit_effect_image_animation_context_free() function.
25737 * @return Image Animation effect context data.
25741 EAPI Elm_Transit_Effect *elm_transit_effect_image_animation_add(Elm_Transit *transit, Eina_List *images);
25746 typedef struct _Elm_Store Elm_Store;
25747 typedef struct _Elm_Store_Filesystem Elm_Store_Filesystem;
25748 typedef struct _Elm_Store_Item Elm_Store_Item;
25749 typedef struct _Elm_Store_Item_Filesystem Elm_Store_Item_Filesystem;
25750 typedef struct _Elm_Store_Item_Info Elm_Store_Item_Info;
25751 typedef struct _Elm_Store_Item_Info_Filesystem Elm_Store_Item_Info_Filesystem;
25752 typedef struct _Elm_Store_Item_Mapping Elm_Store_Item_Mapping;
25753 typedef struct _Elm_Store_Item_Mapping_Empty Elm_Store_Item_Mapping_Empty;
25754 typedef struct _Elm_Store_Item_Mapping_Icon Elm_Store_Item_Mapping_Icon;
25755 typedef struct _Elm_Store_Item_Mapping_Photo Elm_Store_Item_Mapping_Photo;
25756 typedef struct _Elm_Store_Item_Mapping_Custom Elm_Store_Item_Mapping_Custom;
25758 typedef Eina_Bool (*Elm_Store_Item_List_Cb) (void *data, Elm_Store_Item_Info *info);
25759 typedef void (*Elm_Store_Item_Fetch_Cb) (void *data, Elm_Store_Item *sti);
25760 typedef void (*Elm_Store_Item_Unfetch_Cb) (void *data, Elm_Store_Item *sti);
25761 typedef void *(*Elm_Store_Item_Mapping_Cb) (void *data, Elm_Store_Item *sti, const char *part);
25765 ELM_STORE_ITEM_MAPPING_NONE = 0,
25766 ELM_STORE_ITEM_MAPPING_LABEL, // const char * -> label
25767 ELM_STORE_ITEM_MAPPING_STATE, // Eina_Bool -> state
25768 ELM_STORE_ITEM_MAPPING_ICON, // char * -> icon path
25769 ELM_STORE_ITEM_MAPPING_PHOTO, // char * -> photo path
25770 ELM_STORE_ITEM_MAPPING_CUSTOM, // item->custom(it->data, it, part) -> void * (-> any)
25771 // can add more here as needed by common apps
25772 ELM_STORE_ITEM_MAPPING_LAST
25773 } Elm_Store_Item_Mapping_Type;
25775 struct _Elm_Store_Item_Mapping_Icon
25777 // FIXME: allow edje file icons
25779 Elm_Icon_Lookup_Order lookup_order;
25780 Eina_Bool standard_name : 1;
25781 Eina_Bool no_scale : 1;
25782 Eina_Bool smooth : 1;
25783 Eina_Bool scale_up : 1;
25784 Eina_Bool scale_down : 1;
25787 struct _Elm_Store_Item_Mapping_Empty
25792 struct _Elm_Store_Item_Mapping_Photo
25797 struct _Elm_Store_Item_Mapping_Custom
25799 Elm_Store_Item_Mapping_Cb func;
25802 struct _Elm_Store_Item_Mapping
25804 Elm_Store_Item_Mapping_Type type;
25809 Elm_Store_Item_Mapping_Empty empty;
25810 Elm_Store_Item_Mapping_Icon icon;
25811 Elm_Store_Item_Mapping_Photo photo;
25812 Elm_Store_Item_Mapping_Custom custom;
25813 // add more types here
25817 struct _Elm_Store_Item_Info
25819 Elm_Genlist_Item_Class *item_class;
25820 const Elm_Store_Item_Mapping *mapping;
25825 struct _Elm_Store_Item_Info_Filesystem
25827 Elm_Store_Item_Info base;
25831 #define ELM_STORE_ITEM_MAPPING_END { ELM_STORE_ITEM_MAPPING_NONE, NULL, 0, { .empty = { EINA_TRUE } } }
25832 #define ELM_STORE_ITEM_MAPPING_OFFSET(st, it) offsetof(st, it)
25834 EAPI void elm_store_free(Elm_Store *st);
25836 EAPI Elm_Store *elm_store_filesystem_new(void);
25837 EAPI void elm_store_filesystem_directory_set(Elm_Store *st, const char *dir) EINA_ARG_NONNULL(1);
25838 EAPI const char *elm_store_filesystem_directory_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
25839 EAPI const char *elm_store_item_filesystem_path_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
25841 EAPI void elm_store_target_genlist_set(Elm_Store *st, Evas_Object *obj) EINA_ARG_NONNULL(1);
25843 EAPI void elm_store_cache_set(Elm_Store *st, int max) EINA_ARG_NONNULL(1);
25844 EAPI int elm_store_cache_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
25845 EAPI void elm_store_list_func_set(Elm_Store *st, Elm_Store_Item_List_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
25846 EAPI void elm_store_fetch_func_set(Elm_Store *st, Elm_Store_Item_Fetch_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
25847 EAPI void elm_store_fetch_thread_set(Elm_Store *st, Eina_Bool use_thread) EINA_ARG_NONNULL(1);
25848 EAPI Eina_Bool elm_store_fetch_thread_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
25850 EAPI void elm_store_unfetch_func_set(Elm_Store *st, Elm_Store_Item_Unfetch_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
25851 EAPI void elm_store_sorted_set(Elm_Store *st, Eina_Bool sorted) EINA_ARG_NONNULL(1);
25852 EAPI Eina_Bool elm_store_sorted_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
25853 EAPI void elm_store_item_data_set(Elm_Store_Item *sti, void *data) EINA_ARG_NONNULL(1);
25854 EAPI void *elm_store_item_data_get(Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
25855 EAPI const Elm_Store *elm_store_item_store_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
25856 EAPI const Elm_Genlist_Item *elm_store_item_genlist_item_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
25859 * @defgroup SegmentControl SegmentControl
25860 * @ingroup Elementary
25862 * @image html img/widget/segment_control/preview-00.png
25863 * @image latex img/widget/segment_control/preview-00.eps width=\textwidth
25865 * @image html img/segment_control.png
25866 * @image latex img/segment_control.eps width=\textwidth
25868 * Segment control widget is a horizontal control made of multiple segment
25869 * items, each segment item functioning similar to discrete two state button.
25870 * A segment control groups the items together and provides compact
25871 * single button with multiple equal size segments.
25873 * Segment item size is determined by base widget
25874 * size and the number of items added.
25875 * Only one segment item can be at selected state. A segment item can display
25876 * combination of Text and any Evas_Object like Images or other widget.
25878 * Smart callbacks one can listen to:
25879 * - "changed" - When the user clicks on a segment item which is not
25880 * previously selected and get selected. The event_info parameter is the
25881 * segment item index.
25883 * Available styles for it:
25886 * Here is an example on its usage:
25887 * @li @ref segment_control_example
25891 * @addtogroup SegmentControl
25895 typedef struct _Elm_Segment_Item Elm_Segment_Item; /**< Item handle for a segment control widget. */
25898 * Add a new segment control widget to the given parent Elementary
25899 * (container) object.
25901 * @param parent The parent object.
25902 * @return a new segment control widget handle or @c NULL, on errors.
25904 * This function inserts a new segment control widget on the canvas.
25906 * @ingroup SegmentControl
25908 EAPI Evas_Object *elm_segment_control_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
25911 * Append a new item to the segment control object.
25913 * @param obj The segment control object.
25914 * @param icon The icon object to use for the left side of the item. An
25915 * icon can be any Evas object, but usually it is an icon created
25916 * with elm_icon_add().
25917 * @param label The label of the item.
25918 * Note that, NULL is different from empty string "".
25919 * @return The created item or @c NULL upon failure.
25921 * A new item will be created and appended to the segment control, i.e., will
25922 * be set as @b last item.
25924 * If it should be inserted at another position,
25925 * elm_segment_control_item_insert_at() should be used instead.
25927 * Items created with this function can be deleted with function
25928 * elm_segment_control_item_del() or elm_segment_control_item_del_at().
25930 * @note @p label set to @c NULL is different from empty string "".
25932 * only has icon, it will be displayed bigger and centered. If it has
25933 * icon and label, even that an empty string, icon will be smaller and
25934 * positioned at left.
25938 * sc = elm_segment_control_add(win);
25939 * ic = elm_icon_add(win);
25940 * elm_icon_file_set(ic, "path/to/image", NULL);
25941 * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
25942 * elm_segment_control_item_add(sc, ic, "label");
25943 * evas_object_show(sc);
25946 * @see elm_segment_control_item_insert_at()
25947 * @see elm_segment_control_item_del()
25949 * @ingroup SegmentControl
25951 EAPI Elm_Segment_Item *elm_segment_control_item_add(Evas_Object *obj, Evas_Object *icon, const char *label) EINA_ARG_NONNULL(1);
25954 * Insert a new item to the segment control object at specified position.
25956 * @param obj The segment control object.
25957 * @param icon The icon object to use for the left side of the item. An
25958 * icon can be any Evas object, but usually it is an icon created
25959 * with elm_icon_add().
25960 * @param label The label of the item.
25961 * @param index Item position. Value should be between 0 and items count.
25962 * @return The created item or @c NULL upon failure.
25964 * Index values must be between @c 0, when item will be prepended to
25965 * segment control, and items count, that can be get with
25966 * elm_segment_control_item_count_get(), case when item will be appended
25967 * to segment control, just like elm_segment_control_item_add().
25969 * Items created with this function can be deleted with function
25970 * elm_segment_control_item_del() or elm_segment_control_item_del_at().
25972 * @note @p label set to @c NULL is different from empty string "".
25974 * only has icon, it will be displayed bigger and centered. If it has
25975 * icon and label, even that an empty string, icon will be smaller and
25976 * positioned at left.
25978 * @see elm_segment_control_item_add()
25979 * @see elm_segment_control_count_get()
25980 * @see elm_segment_control_item_del()
25982 * @ingroup SegmentControl
25984 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);
25987 * Remove a segment control item from its parent, deleting it.
25989 * @param it The item to be removed.
25991 * Items can be added with elm_segment_control_item_add() or
25992 * elm_segment_control_item_insert_at().
25994 * @ingroup SegmentControl
25996 EAPI void elm_segment_control_item_del(Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
25999 * Remove a segment control item at given index from its parent,
26002 * @param obj The segment control object.
26003 * @param index The position of the segment control item to be deleted.
26005 * Items can be added with elm_segment_control_item_add() or
26006 * elm_segment_control_item_insert_at().
26008 * @ingroup SegmentControl
26010 EAPI void elm_segment_control_item_del_at(Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
26013 * Get the Segment items count from segment control.
26015 * @param obj The segment control object.
26016 * @return Segment items count.
26018 * It will just return the number of items added to segment control @p obj.
26020 * @ingroup SegmentControl
26022 EAPI int elm_segment_control_item_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26025 * Get the item placed at specified index.
26027 * @param obj The segment control object.
26028 * @param index The index of the segment item.
26029 * @return The segment control item or @c NULL on failure.
26031 * Index is the position of an item in segment control widget. Its
26032 * range is from @c 0 to <tt> count - 1 </tt>.
26033 * Count is the number of items, that can be get with
26034 * elm_segment_control_item_count_get().
26036 * @ingroup SegmentControl
26038 EAPI Elm_Segment_Item *elm_segment_control_item_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
26041 * Get the label of item.
26043 * @param obj The segment control object.
26044 * @param index The index of the segment item.
26045 * @return The label of the item at @p index.
26047 * The return value is a pointer to the label associated to the item when
26048 * it was created, with function elm_segment_control_item_add(), or later
26049 * with function elm_segment_control_item_label_set. If no label
26050 * was passed as argument, it will return @c NULL.
26052 * @see elm_segment_control_item_label_set() for more details.
26053 * @see elm_segment_control_item_add()
26055 * @ingroup SegmentControl
26057 EAPI const char *elm_segment_control_item_label_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
26060 * Set the label of item.
26062 * @param it The item of segment control.
26063 * @param text The label of item.
26065 * The label to be displayed by the item.
26066 * Label will be at right of the icon (if set).
26068 * If a label was passed as argument on item creation, with function
26069 * elm_control_segment_item_add(), it will be already
26070 * displayed by the item.
26072 * @see elm_segment_control_item_label_get()
26073 * @see elm_segment_control_item_add()
26075 * @ingroup SegmentControl
26077 EAPI void elm_segment_control_item_label_set(Elm_Segment_Item* it, const char* label) EINA_ARG_NONNULL(1);
26080 * Get the icon associated to the item.
26082 * @param obj The segment control object.
26083 * @param index The index of the segment item.
26084 * @return The left side icon associated to the item at @p index.
26086 * The return value is a pointer to the icon associated to the item when
26087 * it was created, with function elm_segment_control_item_add(), or later
26088 * with function elm_segment_control_item_icon_set(). If no icon
26089 * was passed as argument, it will return @c NULL.
26091 * @see elm_segment_control_item_add()
26092 * @see elm_segment_control_item_icon_set()
26094 * @ingroup SegmentControl
26096 EAPI Evas_Object *elm_segment_control_item_icon_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
26099 * Set the icon associated to the item.
26101 * @param it The segment control item.
26102 * @param icon The icon object to associate with @p it.
26104 * The icon object to use at left side of the item. An
26105 * icon can be any Evas object, but usually it is an icon created
26106 * with elm_icon_add().
26108 * Once the icon object is set, a previously set one will be deleted.
26109 * @warning Setting the same icon for two items will cause the icon to
26110 * dissapear from the first item.
26112 * If an icon was passed as argument on item creation, with function
26113 * elm_segment_control_item_add(), it will be already
26114 * associated to the item.
26116 * @see elm_segment_control_item_add()
26117 * @see elm_segment_control_item_icon_get()
26119 * @ingroup SegmentControl
26121 EAPI void elm_segment_control_item_icon_set(Elm_Segment_Item *it, Evas_Object *icon) EINA_ARG_NONNULL(1);
26124 * Get the index of an item.
26126 * @param it The segment control item.
26127 * @return The position of item in segment control widget.
26129 * Index is the position of an item in segment control widget. Its
26130 * range is from @c 0 to <tt> count - 1 </tt>.
26131 * Count is the number of items, that can be get with
26132 * elm_segment_control_item_count_get().
26134 * @ingroup SegmentControl
26136 EAPI int elm_segment_control_item_index_get(const Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
26139 * Get the base object of the item.
26141 * @param it The segment control item.
26142 * @return The base object associated with @p it.
26144 * Base object is the @c Evas_Object that represents that item.
26146 * @ingroup SegmentControl
26148 EAPI Evas_Object *elm_segment_control_item_object_get(const Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
26151 * Get the selected item.
26153 * @param obj The segment control object.
26154 * @return The selected item or @c NULL if none of segment items is
26157 * The selected item can be unselected with function
26158 * elm_segment_control_item_selected_set().
26160 * The selected item always will be highlighted on segment control.
26162 * @ingroup SegmentControl
26164 EAPI Elm_Segment_Item *elm_segment_control_item_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26167 * Set the selected state of an item.
26169 * @param it The segment control item
26170 * @param select The selected state
26172 * This sets the selected state of the given item @p it.
26173 * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
26175 * If a new item is selected the previosly selected will be unselected.
26176 * Previoulsy selected item can be get with function
26177 * elm_segment_control_item_selected_get().
26179 * The selected item always will be highlighted on segment control.
26181 * @see elm_segment_control_item_selected_get()
26183 * @ingroup SegmentControl
26185 EAPI void elm_segment_control_item_selected_set(Elm_Segment_Item *it, Eina_Bool select) EINA_ARG_NONNULL(1);
26192 * @defgroup Grid Grid
26194 * The grid is a grid layout widget that lays out a series of children as a
26195 * fixed "grid" of widgets using a given percentage of the grid width and
26196 * height each using the child object.
26198 * The Grid uses a "Virtual resolution" that is stretched to fill the grid
26199 * widgets size itself. The default is 100 x 100, so that means the
26200 * position and sizes of children will effectively be percentages (0 to 100)
26201 * of the width or height of the grid widget
26207 * Add a new grid to the parent
26209 * @param parent The parent object
26210 * @return The new object or NULL if it cannot be created
26214 EAPI Evas_Object *elm_grid_add(Evas_Object *parent);
26217 * Set the virtual size of the grid
26219 * @param obj The grid object
26220 * @param w The virtual width of the grid
26221 * @param h The virtual height of the grid
26225 EAPI void elm_grid_size_set(Evas_Object *obj, int w, int h);
26228 * Get the virtual size of the grid
26230 * @param obj The grid object
26231 * @param w Pointer to integer to store the virtual width of the grid
26232 * @param h Pointer to integer to store the virtual height of the grid
26236 EAPI void elm_grid_size_get(Evas_Object *obj, int *w, int *h);
26239 * Pack child at given position and size
26241 * @param obj The grid object
26242 * @param subobj The child to pack
26243 * @param x The virtual x coord at which to pack it
26244 * @param y The virtual y coord at which to pack it
26245 * @param w The virtual width at which to pack it
26246 * @param h The virtual height at which to pack it
26250 EAPI void elm_grid_pack(Evas_Object *obj, Evas_Object *subobj, int x, int y, int w, int h);
26253 * Unpack a child from a grid object
26255 * @param obj The grid object
26256 * @param subobj The child to unpack
26260 EAPI void elm_grid_unpack(Evas_Object *obj, Evas_Object *subobj);
26263 * Faster way to remove all child objects from a grid object.
26265 * @param obj The grid object
26266 * @param clear If true, it will delete just removed children
26270 EAPI void elm_grid_clear(Evas_Object *obj, Eina_Bool clear);
26273 * Set packing of an existing child at to position and size
26275 * @param subobj The child to set packing of
26276 * @param x The virtual x coord at which to pack it
26277 * @param y The virtual y coord at which to pack it
26278 * @param w The virtual width at which to pack it
26279 * @param h The virtual height at which to pack it
26283 EAPI void elm_grid_pack_set(Evas_Object *subobj, int x, int y, int w, int h);
26286 * get packing of a child
26288 * @param subobj The child to query
26289 * @param x Pointer to integer to store the virtual x coord
26290 * @param y Pointer to integer to store the virtual y coord
26291 * @param w Pointer to integer to store the virtual width
26292 * @param h Pointer to integer to store the virtual height
26296 EAPI void elm_grid_pack_get(Evas_Object *subobj, int *x, int *y, int *w, int *h);
26302 EAPI Evas_Object *elm_factory_add(Evas_Object *parent);
26303 EAPI void elm_factory_content_set(Evas_Object *obj, Evas_Object *content);
26304 EAPI Evas_Object *elm_factory_content_get(const Evas_Object *obj);
26307 * @defgroup Video Video
26309 * This object display an player that let you control an Elm_Video
26310 * object. It take care of updating it's content according to what is
26311 * going on inside the Emotion object. It does activate the remember
26312 * function on the linked Elm_Video object.
26314 * Signals that you cann add callback for are :
26316 * "forward,clicked" - the user clicked the forward button.
26317 * "info,clicked" - the user clicked the info button.
26318 * "next,clicked" - the user clicked the next button.
26319 * "pause,clicked" - the user clicked the pause button.
26320 * "play,clicked" - the user clicked the play button.
26321 * "prev,clicked" - the user clicked the prev button.
26322 * "rewind,clicked" - the user clicked the rewind button.
26323 * "stop,clicked" - the user clicked the stop button.
26325 EAPI Evas_Object *elm_video_add(Evas_Object *parent);
26326 EAPI void elm_video_file_set(Evas_Object *video, const char *filename);
26327 EAPI void elm_video_uri_set(Evas_Object *video, const char *uri);
26328 EAPI Evas_Object *elm_video_emotion_get(Evas_Object *video);
26329 EAPI void elm_video_play(Evas_Object *video);
26330 EAPI void elm_video_pause(Evas_Object *video);
26331 EAPI void elm_video_stop(Evas_Object *video);
26332 EAPI Eina_Bool elm_video_is_playing(Evas_Object *video);
26333 EAPI Eina_Bool elm_video_is_seekable(Evas_Object *video);
26334 EAPI Eina_Bool elm_video_audio_mute_get(Evas_Object *video);
26335 EAPI void elm_video_audio_mute_set(Evas_Object *video, Eina_Bool mute);
26336 EAPI double elm_video_audio_level_get(Evas_Object *video);
26337 EAPI void elm_video_audio_level_set(Evas_Object *video, double volume);
26338 EAPI double elm_video_play_position_get(Evas_Object *video);
26339 EAPI void elm_video_play_position_set(Evas_Object *video, double position);
26340 EAPI double elm_video_play_length_get(Evas_Object *video);
26341 EAPI void elm_video_remember_position_set(Evas_Object *video, Eina_Bool remember);
26342 EAPI Eina_Bool elm_video_remember_position_get(Evas_Object *video);
26343 EAPI const char *elm_video_title_get(Evas_Object *video);
26345 EAPI Evas_Object *elm_player_add(Evas_Object *parent);
26346 EAPI void elm_player_video_set(Evas_Object *player, Evas_Object *video);
26349 EAPI Evas_Object *elm_naviframe_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
26350 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);
26351 EAPI Evas_Object *elm_naviframe_item_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
26352 EAPI void elm_naviframe_content_preserve_on_pop_set(Evas_Object *obj, Eina_Bool preserve) EINA_ARG_NONNULL(1);
26353 EAPI Eina_Bool elm_naviframe_content_preserve_on_pop_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26354 EAPI void elm_naviframe_item_title_label_set(Elm_Object_Item *it, const char *label) EINA_ARG_NONNULL(1);
26355 EAPI const char *elm_naviframe_item_title_label_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26356 EAPI void elm_naviframe_item_subtitle_label_set(Elm_Object_Item *it, const char *label) EINA_ARG_NONNULL(1);
26357 EAPI const char *elm_naviframe_item_subtitle_label_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26358 EAPI Elm_Object_Item *elm_naviframe_top_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26359 EAPI Elm_Object_Item *elm_naviframe_bottom_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26360 EAPI void elm_naviframe_item_style_set(Elm_Object_Item *it, const char *item_style) EINA_ARG_NONNULL(1);
26361 EAPI const char *elm_naviframe_item_style_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26362 EAPI void elm_naviframe_item_title_visible_set(Elm_Object_Item *it, Eina_Bool visible) EINA_ARG_NONNULL(1);
26363 EAPI Eina_Bool elm_naviframe_item_title_visible_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);